weyne/wifipineapple-wiki
1
0
Fork 0
mirror of https://github.com/hak5darren/wifipineapple-wiki.git synced 2025-10-29 16:59:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update api.md

Browse Source
This commit is contained in:
Henry Pitcairn 2016-04-05 10:20:57 -04:00
parent 825618fe8f
commit 9252782bcf
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
api.md
View File

@ -112,7 +112,26 @@ Action|Description|Parameters
### PineAP
#### Description
The PineAP module provides an easy way to interface with the [PineAP suite](/#!index.md#The_PineAP_Suite). For example, one might use the following to add an SSID to PineAP's pool:
```
{
"module": "PineAP",
"action": "addSSID",
"ssid": "ACME WiFi"
}
```
Action|Description|Parameters
------|-----------|----------
`getPool`|Returns an array of the SSIDs in PineAP's pool|_none_
`clearPool`|Clears the PineAP pool|_none_
`addSSID`|Adds an SSID to the pool|<ul><li>ssid<ul><li>The SSID string to add</li></ul></li>
`removeSSID`|Removes an SSID from the pool|<ul><li>ssid<ul><li>The SSID string to add</li></ul></li>
`setPineAPSettings`|Update PineAP's settings|<ul> <li>settings <ul> <li>A dictionary with setting key/value pairs <ul> <li>allowAssociations <ul> <li>Whether clients should be allowed to associate to the pineapple</li> </ul> </li> <li>logProbes <ul> <li>Whether to log probe requests</li> </ul> </li> <li>logAssociations <ul> <li>Whether to log associations</li> </ul> </li> <li>beaconResponses <ul> <li>Whether to send beacon responses</li> </ul> </li> <li>captureSSIDs <ul> <li>Whether to add sniffed SSIDs to the pool</li> </ul> </li> <li>broadcastSSIDs <ul> <li>Whether to broadcast the SSID pool</li> </ul> </li> <li>beaconInterval <ul> <li>The beacon interval- must be one of "low", "normal" or "aggressive"</li> </ul> </li> <li>responseInterval <ul> <li>The response interval- must be one of "low", "normal" or "aggressive"</li> </ul> </li> <li>targetMAC <ul> <li>The MAC to target with responses</li> </ul> </li> <li>sourceMAC <ul> <li>The MAC PineAP should spoof</li> </ul> </li> </ul> </li> </ul> </li></ul>
`getPineAPSettings`|Returns a dictionary with all the current PineAP settings|_none_
`enable`|Enables PineAP|_none_
`disable`|Disables PineAP|_none_
`saveAsDefault`|Makes the current configuration persist after reboots|_none_
`downloadPineAPPool`|Get a download link to the SSID pool (useful for client side modules)|_none_
### Recon
#### Description
### Reporting