> For the complete documentation index, see [llms.txt](https://www.cs4066.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.cs4066.com/unit-6/creating-a-metasploit-module-to-detect-online-websites.md).

# Creating a Metasploit Module to Detect Online Websites

## **Activity**

Create a Metasploit module that takes a URL as input and checks if the corresponding website is online.

## check\_online.rb

Save the module as `check_online.rb` in the Metasploit `modules/auxiliary/scanner/http` directory.

```ruby
##
# This module requires Metasploit
##

require 'msf/core'

class MetasploitModule < Msf::Auxiliary
  include Msf::Exploit::Remote::HttpClient

  def initialize(info = {})
    super(update_info(info,
      'Name'        => 'Check if Website is Online',
      'Description' => %q{
        This module checks if a target website is online by sending an HTTP GET request.
      },
      'Author'      => ['Your Name'],
      'License'     => MSF_LICENSE,
      'References'  => []
    ))

    register_options(
      [
        OptString.new('TARGETURI', [true, 'The path to check if the website is online', '/'])
      ]
    )
  end

  def run
    begin
      res = send_request_raw({
        'uri'     => datastore['TARGETURI'],
        'method'  => 'GET'
      })

      if res && res.code == 200
        print_good("#{peer} is online.")
      else
        print_error("#{peer} is offline or unreachable.")
      end
    rescue ::Rex::ConnectionError
      print_error("#{peer} is offline or unreachable.")
    end
  end
end
```

Restart Metasploit to ensure it loads custom modules from `~/.msf4/modules`.

```
reload_all
```

Load the Module

```
use auxiliary/scanner/http/check_online
```

Run the Module

```
set RHOSTS https://www.wpunj.edu
run
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.cs4066.com/unit-6/creating-a-metasploit-module-to-detect-online-websites.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.