GitBook: [master] 40 pages and 18 assets modified

README.md

@@ -0,0 +1,8 @@
+# The WiFi Pineapple Mark VII by Hak5
+
+Description
+
+![](.gitbook/assets/image%20%2815%29.png)
+
+
+

SUMMARY.md

@@ -0,0 +1,57 @@
+# Table of contents
+
+* [The WiFi Pineapple Mark VII by Hak5](README.md)
+
+## Setup
+
+* [Connecting to the WiFi Pineapple on Linux](setup/untitled.md)
+* [Connecting to the WiFi Pineapple on Windows](setup/connecting-to-the-wifi-pineapple-on-windows.md)
+* [Connecting to the WiFi Pineapple over WiFi](setup/connecting-to-the-wifi-pineapple-over-wifi.md)
+* [Setting up your WiFi Pineapple](setup/setting-up-your-wifi-pineapple.md)
+* [USB Auto-Setup and Enrollment](setup/usb-auto-setup-and-enrollment.md)
+
+## UI Overview
+
+* [Dashboard](ui-overview/dashboard.md)
+* [Campaigns](ui-overview/campaigns.md)
+* [PineAP](ui-overview/pineap.md)
+* [Recon](ui-overview/recon.md)
+* [Modules](ui-overview/modules.md)
+* [Settings](ui-overview/settings.md)
+
+## Developer Documentation
+
+* [REST API](developer-documentation/rest-api/README.md)
+  * [Untitled](developer-documentation/rest-api/untitled.md)
+  * [REST Errors](developer-documentation/rest-api/rest-errors.md)
+  * [API Authentication](developer-documentation/rest-api/api-authentication.md)
+  * [Notifications](developer-documentation/rest-api/notifications.md)
+  * [Generic](developer-documentation/rest-api/generic.md)
+  * [Dashboard](developer-documentation/rest-api/dashboard.md)
+  * [Campaigns](developer-documentation/rest-api/campaigns.md)
+  * [PineAP](developer-documentation/rest-api/pineap.md)
+  * [Recon](developer-documentation/rest-api/recon.md)
+  * [Settings](developer-documentation/rest-api/settings.md)
+  * [Modules](developer-documentation/rest-api/modules.md)
+* [Module Development Introduction](developer-documentation/module-development-introduction.md)
+* [TypeScript API](developer-documentation/typescript-api.md)
+* [Python API](developer-documentation/python-api/README.md)
+  * [Untitled](developer-documentation/python-api/untitled.md)
+* [Contributing to the Module Repository](developer-documentation/contributing-to-the-module-repository.md)
+
+## FAQ / Troubleshooting <a id="faq"></a>
+
+* [Establishing an Internet Connection](faq/establishing-an-internet-connection/README.md)
+  * [Configuring a Client Mode Connection](faq/establishing-an-internet-connection/configuring-a-client-mode-connection.md)
+  * [Configuring ICS on Linux](faq/establishing-an-internet-connection/configuring-ics-on-linux.md)
+  * [Configuring ICS on Windows](faq/establishing-an-internet-connection/configuring-ics-on-windows.md)
+  * [Configuring a USB Ethernet Adapter](faq/establishing-an-internet-connection/configuring-a-usb-ethernet-adapter.md)
+* [Factory Reset and Recovery](faq/factory-reset-and-recovery.md)
+* [WiFi Pineapple Beta Updates](faq/untitled.md)
+* [Compatible 802.11ac Adapters](faq/compatible-802.11ac-adapters.md)
+
+## Extras
+
+* [MK7 LED Mod Installation](extras/untitled.md)
+* [MK7 Kismet Case Installation](extras/mk7-kismet-case-installation.md)
+

developer-documentation/contributing-to-the-module-repository.md

@@ -0,0 +1,2 @@
+# Contributing to the Module Repository
+

developer-documentation/module-development-introduction.md

@@ -0,0 +1,2 @@
+# Module Development Introduction
+

developer-documentation/python-api/README.md

@@ -0,0 +1,2 @@
+# Python API
+

developer-documentation/python-api/untitled.md

@@ -0,0 +1,2 @@
+# Untitled
+

developer-documentation/rest-api/README.md

@@ -0,0 +1,98 @@
+---
+description: WiFi Pineapple Mark VII REST API
+---
+
+# REST API
+
+{% api-method method="delete" host="172.16.42.1:1471" path="/api/recon/scan/:id" %}
+{% api-method-summary %}
+Delete Recon Scan
+{% endapi-method-summary %}
+
+{% api-method-description %}
+
+{% endapi-method-description %}
+
+{% api-method-spec %}
+{% api-method-request %}
+{% api-method-path-parameters %}
+{% api-method-parameter name="" type="string" required=false %}
+
+{% endapi-method-parameter %}
+{% endapi-method-path-parameters %}
+{% endapi-method-request %}
+
+{% api-method-response %}
+{% api-method-response-example httpCode=200 %}
+{% api-method-response-example-description %}
+
+{% endapi-method-response-example-description %}
+
+```
+
+```
+{% endapi-method-response-example %}
+{% endapi-method-response %}
+{% endapi-method-spec %}
+{% endapi-method %}
+
+{% api-method method="get" host="172.16.42.1:1471" path="/api/recon/scan/:id" %}
+{% api-method-summary %}
+Get Recon Scan
+{% endapi-method-summary %}
+
+{% api-method-description %}
+This endpoint returns a Recon scan.
+{% endapi-method-description %}
+
+{% api-method-spec %}
+{% api-method-request %}
+{% api-method-path-parameters %}
+{% api-method-parameter name="id" type="string" %}
+ID of the cake to get, for free of course.
+{% endapi-method-parameter %}
+{% endapi-method-path-parameters %}
+
+{% api-method-headers %}
+{% api-method-parameter name="Authentication" type="string" required=true %}
+Authentication token to track down who is emptying our stocks.
+{% endapi-method-parameter %}
+{% endapi-method-headers %}
+
+{% api-method-query-parameters %}
+{% api-method-parameter name="recipe" type="string" %}
+The API will do its best to find a cake matching the provided recipe.
+{% endapi-method-parameter %}
+
+{% api-method-parameter name="gluten" type="boolean" %}
+Whether the cake should be gluten-free or not.
+{% endapi-method-parameter %}
+{% endapi-method-query-parameters %}
+{% endapi-method-request %}
+
+{% api-method-response %}
+{% api-method-response-example httpCode=200 %}
+{% api-method-response-example-description %}
+Cake successfully retrieved.
+{% endapi-method-response-example-description %}
+
+```
+{    "name": "Cake's name",    "recipe": "Cake's recipe name",    "cake": "Binary cake"}
+```
+{% endapi-method-response-example %}
+
+{% api-method-response-example httpCode=404 %}
+{% api-method-response-example-description %}
+Could not find a cake matching this query.
+{% endapi-method-response-example-description %}
+
+```
+{    "message": "Ain't no cake like that."}
+```
+{% endapi-method-response-example %}
+{% endapi-method-response %}
+{% endapi-method-spec %}
+{% endapi-method %}
+
+
+

developer-documentation/rest-api/api-authentication.md

@@ -0,0 +1,2 @@
+# API Authentication
+

developer-documentation/rest-api/campaigns.md

@@ -0,0 +1,2 @@
+# Campaigns
+

developer-documentation/rest-api/dashboard.md

@@ -0,0 +1,2 @@
+# Dashboard
+

developer-documentation/rest-api/generic.md

@@ -0,0 +1,2 @@
+# Generic
+

developer-documentation/rest-api/modules.md

@@ -0,0 +1,2 @@
+# Modules
+

developer-documentation/rest-api/notifications.md

@@ -0,0 +1,2 @@
+# Notifications
+

developer-documentation/rest-api/pineap.md

@@ -0,0 +1,6 @@
+---
+description: PineAP
+---
+
+# PineAP
+

developer-documentation/rest-api/recon.md

@@ -0,0 +1,2 @@
+# Recon
+

developer-documentation/rest-api/rest-errors.md

@@ -0,0 +1,2 @@
+# REST Errors
+

developer-documentation/rest-api/settings.md

@@ -0,0 +1,2 @@
+# Settings
+

developer-documentation/rest-api/untitled.md

@@ -0,0 +1,2 @@
+# Untitled
+

developer-documentation/typescript-api.md

@@ -0,0 +1,2 @@
+# TypeScript API
+

extras/mk7-kismet-case-installation.md

@@ -0,0 +1,2 @@
+# MK7 Kismet Case Installation
+

extras/untitled.md

@@ -0,0 +1,2 @@
+# MK7 LED Mod Installation
+

faq/compatible-802.11ac-adapters.md

@@ -0,0 +1,2 @@
+# Compatible 802.11ac Adapters
+

faq/establishing-an-internet-connection/README.md

@@ -0,0 +1,2 @@
+# Establishing an Internet Connection
+

faq/establishing-an-internet-connection/configuring-a-client-mode-connection.md

@@ -0,0 +1,2 @@
+# Configuring a Client Mode Connection
+

faq/establishing-an-internet-connection/configuring-a-usb-ethernet-adapter.md

@@ -0,0 +1,2 @@
+# Configuring a USB Ethernet Adapter
+

faq/establishing-an-internet-connection/configuring-ics-on-linux.md

@@ -0,0 +1,2 @@
+# Configuring ICS on Linux
+

faq/establishing-an-internet-connection/configuring-ics-on-windows.md

@@ -0,0 +1,2 @@
+# Configuring ICS on Windows
+

faq/factory-reset-and-recovery.md

@@ -0,0 +1,2 @@
+# Factory Reset and Recovery
+

faq/untitled.md

@@ -0,0 +1,2 @@
+# WiFi Pineapple Beta Updates
+

setup/connecting-to-the-wifi-pineapple-on-windows.md

@@ -0,0 +1,9 @@
+---
+description: This guide teaches the basics of connecting to the WiFi Pineapple on Windows.
+---
+
+# Connecting to the WiFi Pineapple on Windows
+
+## Configuration via GUI
+
+1. 

setup/connecting-to-the-wifi-pineapple-over-wifi.md

@@ -0,0 +1,12 @@
+---
+description: >-
+  This guide instructs you on how to connect to the WiFi Pineapple's Open AP
+  during setup.
+---
+
+# Connecting to the WiFi Pineapple over WiFi
+
+The WiFi Pineapple serves an Open AP for you to connect to for the purposes of completing device setup. The SSID of the AP is `Pineapple_XXXX`, where the 'XXXX' is the last 4 characters of the devices MAC address.
+
+![](../.gitbook/assets/image%20%2813%29.png)
+

setup/setting-up-your-wifi-pineapple.md

@@ -0,0 +1,14 @@
+---
+description: >-
+  Once you've connected to the WiFi Pineapple, this guide teaches you how to
+  navigate the Setup wizard.
+---
+
+# Setting up your WiFi Pineapple
+
+Once you've connected to the WiFi Pineapple and it has fully booted, you will be able to access the stager at http://172.16.42.1, where the latest firmware will be installed.
+
+## Getting the latest firmware via Over-The-Air
+
+## Uploading the firmware manually
+

setup/untitled.md

@@ -0,0 +1,40 @@
+---
+description: >-
+  This guide teaches the basics of connecting to the WiFi Pineapple on
+  Linux-based operating systems.
+---
+
+# Connecting to the WiFi Pineapple on Linux
+
+## Configuration via GUI
+
+To configure the WiFi Pineapple's USB Ethernet interface, you can use the NetworkManager GUI commonly included in Linux distributions.
+
+1. Connect the WiFi Pineapple to your computer via the USB-C cable.
+2. Once the device has fully booted, open your computers networking settings.
+3. Find the new USB Ethernet device, and configure it to use the following IPv4 settings:
+   1. IP: 172.16.42.42
+   2. Netmask: 255.255.255.0
+   3. Gateway: Unset, or 0.0.0.0
+
+![](../.gitbook/assets/image%20%282%29.png)
+
+{% hint style="info" %}
+You may need to disconnect and reconnect the interface for your changes to take place.
+{% endhint %}
+
+## Configuration via CLI
+
+To configure the WiFi Pineapple's USB Ethernet interface via the command line, you can make use of the `ip` tools commonly included in Linux distributions.
+
+1. Connect the WiFi Pineapple to your computer via the USB-C cable.
+2. Once the device has fully booted, open the Terminal emulator and run the following:
+
+```text
+$ sudo ip link set eth0 down
+$ sudo ip addr add 172.16.42.42/255.255.255.0 dev eth0
+$ sudo ip link set eth0 up
+```
+
+
+

setup/usb-auto-setup-and-enrollment.md

@@ -0,0 +1,2 @@
+# USB Auto-Setup and Enrollment
+

ui-overview/campaigns.md

@@ -0,0 +1,20 @@
+---
+description: >-
+  Campaigns allow you to create automated tasks to ease an engagement, with the
+  ability to generate a report at the end or on an interval.
+---
+
+# Campaigns
+
+## Campaigns Listings
+
+Campaigns that have been created are listed in a table, showing the current status, name, creation date and campaign type. You can enable or disable your campaigns with the Enable/Disable toggle, and edit or remove them by clicking the "..." menu button.
+
+![](../.gitbook/assets/image%20%2811%29.png)
+
+## Manage Campaign Reports
+
+From the Reports tab, you can download and delete the reports that have been generated by your campaigns.
+
+![](../.gitbook/assets/image%20%284%29.png)
+

ui-overview/dashboard.md

@@ -0,0 +1,10 @@
+---
+description: >-
+  The Dashboard is the landing page for the WiFi Pineapple management UI, and
+  provides at a glance insights to the system and its services.
+---
+
+# Dashboard
+
+![](../.gitbook/assets/image%20%289%29.png)
+

ui-overview/modules.md

@@ -0,0 +1,2 @@
+# Modules
+

ui-overview/pineap.md

@@ -0,0 +1,50 @@
+---
+description: >-
+  PineAP is the center of the WiFi Pineapple's rogue access points, client
+  management and filtering.
+---
+
+# PineAP
+
+## PineAP Settings
+
+The main PineAP page is used to manage the PineAP Daemon settings and status. You can manage individual daemon settings by selecting the **Advanced** tab, or you may select preset settings with the Passive or Active tabs.
+
+On the right hand side, you can find the current SSID pool. These SSIDs can be automatically collected in the Passive and Active modes, or by selecting the "Capture SSIDs to Pool" option in Advanced. You can use the field below and the Add, Remove and Clear buttons to manually add or remove SSIDs.
+
+![](../.gitbook/assets/image%20%286%29.png)
+
+## Clients
+
+The clients page provides two views for clients, split into connected clients and previous clients. From the **Connected Clients** you can view information about each connected client, including MAC, IP Address and the SSID they associated to, as well as the ability to kick them from the network.
+
+![](../.gitbook/assets/image%20%2814%29.png)
+
+Switching to the **Previous Clients** tab shows you a record of all previous associations to the rogue access points hosted by the WiFi Pineapple. Clients that have not yet disconnected from the network have a disconnect time of "Unavailable".
+
+![](../.gitbook/assets/image%20%283%29.png)
+
+## Filtering
+
+The filtering page allows you to have fine control over what devices can connect to your WiFi Pineapple. You can do this by combining two filters: the **Client Filter** and the **SSID Filter**, with two modes each: **Allow** or **Deny**.
+
+With the client filter you may limit the scope of engagement by choosing what devices may connect. Allow only specific devices, or any device that isn't specifically on the deny list.
+
+With the SSID filter you may specify the spoofed networks for which the WiFi Pineapple will allow associations. Allow associations for only specifically listed SSIDs, or any SSID that isn't specifically listed.
+
+![](../.gitbook/assets/image%20%2816%29.png)
+
+## Enterprise
+
+The **Enterprise** tab allows you to configure a WPA-EAP Enterprise rogue access point. To begin, fill in the form to generate the EAP configuration and certificates.
+
+![](../.gitbook/assets/image.png)
+
+Once the certificate has been generated, you'll see easy to use options to configure the rogue enterprise access point, and view the challenge data any connected clients provide.
+
+## Access Points
+
+The **Access Points** tab allows you to configure the other access points hosted on the WiFi Pineapple: The **Management AP**, **Open AP**, and **Evil WPA/2 AP**.
+
+![](../.gitbook/assets/image%20%2817%29.png)
+

ui-overview/recon.md

@@ -0,0 +1,20 @@
+---
+description: Recon is the WiFi landscape scanning tool incorporated into PineAP.
+---
+
+# Recon
+
+On the main Recon page, you can see an at-a-glance overview of the current wireless landscape, with a list of discovered APs and their associated clients, unassociated clients, and clients that have gone out of range in table form.
+
+To change to a mobile friendly view, select the card button next to the table icon in the **Access Points & Clients** card.
+
+![](../.gitbook/assets/image%20%281%29.png)
+
+By clicking on an AP or Client in the list, a side menu will slide out from the right. From here you can select options specific to the type of device you selected, such as capturing handshakes or cloning, or adding MAC addresses to the Filters.
+
+![](../.gitbook/assets/image%20%2812%29.png)
+
+Switching to the Handshakes tab allows you to view any captured handshakes. Handshakes are captured in **PCAP** and **Hashcat's 22000** format.
+
+![](../.gitbook/assets/image%20%2810%29.png)
+

ui-overview/settings.md

@@ -0,0 +1,2 @@
+# Settings
+