The Official WiFi Pineapple Module Repository for the NANO & TETRA
 
 
 
 
 
 
Go to file
Nick 1f4f1248a7 Papers, CursedScreech, and Portal Auth Updates (#5) 2018-01-09 10:11:40 +10:00
APITokens Add modules to repository 2017-11-16 16:42:22 +11:00
Cabinet Add modules to repository 2017-11-16 16:42:22 +11:00
Commander Add modules to repository 2017-11-16 16:42:22 +11:00
ConnectedClients Add modules to repository 2017-11-16 16:42:22 +11:00
CursedScreech Papers, CursedScreech, and Portal Auth Updates (#5) 2018-01-09 10:11:40 +10:00
DNSMasqSpoof Add modules to repository 2017-11-16 16:42:22 +11:00
DNSspoof Add modules to repository 2017-11-16 16:42:22 +11:00
DWall Update DWall to work with new libpcap 2017-12-27 08:23:42 +11:00
Deauth Add modules to repository 2017-11-16 16:42:22 +11:00
EvilPortal Add modules to repository 2017-11-16 16:42:22 +11:00
HTTPProxy HTTPProxy Module (#1) 2017-11-20 07:49:08 +11:00
HackRF Add modules to repository 2017-11-16 16:42:22 +11:00
KeyManager Add modules to repository 2017-11-16 16:42:22 +11:00
LEDController Add modules to repository 2017-11-16 16:42:22 +11:00
LogManager Add modules to repository 2017-11-16 16:42:22 +11:00
MACInfo Update MacInfo version to trigger new build 2017-12-15 11:43:07 +11:00
Meterpreter Add modules to repository 2017-11-16 16:42:22 +11:00
ModemManager Add modules to repository 2017-11-16 16:42:22 +11:00
ModuleMaker Add modules to repository 2017-11-16 16:42:22 +11:00
Occupineapple Add modules to repository 2017-11-16 16:42:22 +11:00
OnlineHashCrack Bump OnlineHashCrack version 2017-12-21 07:53:54 +11:00
Papers Papers, CursedScreech, and Portal Auth Updates (#5) 2018-01-09 10:11:40 +10:00
PortalAuth Papers, CursedScreech, and Portal Auth Updates (#5) 2018-01-09 10:11:40 +10:00
RandomRoll Add modules to repository 2017-11-16 16:42:22 +11:00
Responder Add modules to repository 2017-11-16 16:42:22 +11:00
SSLsplit Add modules to repository 2017-11-16 16:42:22 +11:00
SignalStrength Add modules to repository 2017-11-16 16:42:22 +11:00
SiteSurvey Add modules to repository 2017-11-16 16:42:22 +11:00
Status Add modules to repository 2017-11-16 16:42:22 +11:00
autossh Add modules to repository 2017-11-16 16:42:22 +11:00
base64encdec Add modules to repository 2017-11-16 16:42:22 +11:00
dump1090 Add modules to repository 2017-11-16 16:42:22 +11:00
ettercap Add modules to repository 2017-11-16 16:42:22 +11:00
get Add modules to repository 2017-11-16 16:42:22 +11:00
ngrep Add modules to repository 2017-11-16 16:42:22 +11:00
nmap Add modules to repository 2017-11-16 16:42:22 +11:00
p0f Add modules to repository 2017-11-16 16:42:22 +11:00
tcpdump Add modules to repository 2017-11-16 16:42:22 +11:00
urlsnarf Add modules to repository 2017-11-16 16:42:22 +11:00
wps Add modules to repository 2017-11-16 16:42:22 +11:00
README.md Fix typo in readme (#3) 2018-01-02 05:06:40 +11:00

README.md

WiFi Pineapple Module Repository

This is the module repository for the WiFi Pineapple NANO and TETRA. All the community developed modules are stored here, and developers should create pull requests for any changes to their modules, or module additions.

Module Structure

A WiFi Pineapple Module is created with HTML, AngularJS and PHP. All HTML is done using the Bootstrap CSS framework, and AngularJS combined with our PHP API allows for asynchronus updating and easy to implement features for your module.

A basic module will request information through AngularJS to PHP, and then the PHP will provide a response to AngularJS, where it will then be displayed on the HTML page for the user to see.

+-------------------+         +--------------+         +-----------+         +------+
| AngularJS Request |   -->   | PHP Response |   -->   | AngularJS |   -->   | HTML |
+-------------------+         +--------------+         +-----------+         +------+

The structure of a module is as follows:

.
├── api
│   └── module.php
├── js
│   └── module.js
├── module.html
└── module.info

More information on creating modules can be found here while more information on the API can be found here.

module.info

The module.info file is a simple JSON array consisting of author, description, devices, title, and version. The version field will need to be updated with any pull request.

module.html

The WiFi Pineapple modules make use of Bootstrap to provide a good mobile viewing experience and a clean look. Module developers are encouraged to make use of Bootstrap components, such as responsive tables and the grid system. To learn more about Bootstrap, visit the Bootstrap Website. We also include a hook for atleast one AngularJS controller. You can learn more about AngularJS at the AngularJS Website.

<div class="row">
    <div ng-controller="ExampleController" class="col-md-12">
        {{ hello }}
    </div>
</div>

module.js

The js/module.js file will house the Javascript for your module, and will be the place for controller definitions, in this brief example it will be called ExampleController. We will also set a variable called $scope.hello with content we will receieve from our PHP.

registerController("ExampleController", ['$api', '$scope', function($api, $scope) {
    $api.request({
        module: 'ExampleModule',
        action: 'getHello'
    }, function(response) {
        $scope.hello = response.text;
    });
}])

This snippet makes use of our API to send a request to our PHP with the getHello action, and will set it a response into the $scope.hello variable.

module.php

The api/module.php file must be in the pineapple namespace, and contain a routing switch statement, for example:

<?php namespace pineapple;

class ExampleModule extends Module
{
    public function route()
    {
        switch ($this->request->action) {
            case 'getHello':
                $this->hello();
                break;
            }
    }
}

We will then need to call our function hello(), which should be private and should set a response:

private function hello()
{
    $this->response = array('text' => "Hello World");
}
```.

**Note:** You should never use the closing `?>` PHP tag in your `module.php` file.