PINEAPPLE_DEVICE_FILTER_ADD - add a MAC address to a Pineapple WiFi device filter list

PINEAPPLE_DEVICE_FILTER_ADD_FILE - add a file of MAC addresses to a Pineapple WiFi device filter list

PINEAPPLE_DEVICE_FILTER_DELETE - remove a MAC address from a Pineapple WiFi device filter list

PINEAPPLE_DEVICE_FILTER_DELETE_FILE - delete a file of MAC addresses from a Pineapple WiFi device filter list

PINEAPPLE_DEVICE_FILTER_CLEAR - clear all MAC addresses from a Pineapple device filter list

PINEAPPLE_DEVICE_FILTER_LIST - print the contents of a Pineapple device filter list

PINEAPPLE_DEVICE_FILTER_MODE - Set the operational mode of the Pineapple device filter (allow or deny)

When to use them

The Pineapple filter system defines the scope of an engagement by controlling what devices are allowed to connect to a Pineapple access point.

The PINEAPPLE_DEVICE_FILTER_... commands provide a scriptable interface to manipulating the filter lists.

PINEAPPLE_DEVICE_FILTER_ADD

Syntax

PINEAPPLE_DEVICE_FILTER_ADD [list (allow or deny)] {MAC address1 ... MAC addressN}

list (allow or deny) required

Add one or more MAC addresses to the allow or deny device filter list.

MAC address required

MAC addresses to add to the filter. MAC addresses should be of the form aa:bb:cc:00:11:22.

PINEAPPLE_DEVICE_FILTER_ADD_FILE

Syntax

PINEAPPLE_DEVICE_FILTER_ADD_FILE [list (allow or deny)] [file]

list (allow or deny) required

Add one or more MAC addresses to the allow or deny device filter list.

file required

File containing MAC addresses to add to the filter, one MAC address per line. MAC addresses should be of the form aa:bb:cc:00:11:22.

PINEAPPLE_DEVICE_FILTER_DELETE

Syntax

PINEAPPLE_DEVICE_FILTER_DELETE [list (allow or deny)] {MAC address1 ... MAC addressN}

list (allow or deny) required

Remove one or more MAC addresses from the allow or deny device filter list.

MAC address required

MAC addresses to remove from the filter. MAC addresses should be of the form aa:bb:cc:00:11:22.

PINEAPPLE_DEVICE_FILTER_DELETE_FILE

Syntax

PINEAPPLE_DEVICE_FILTER_DELETE_FILE [list (allow or deny)] [file]

list (allow or deny) required

Remove one or more MAC addresses from the allow or deny device filter list.

file required

File containing MAC addresses to remove from the filter, one MAC address per line. MAC addresses should be of the form aa:bb:cc:00:11:22.

PINEAPPLE_DEVICE_FILTER_CLEAR

Syntax

PINEAPPLE_DEVICE_FILTER_CLEAR [list (allow or deny)]

list (allow or deny) required

List to clear (allow or deny)

PINEAPPLE_DEVICE_FILTER_LIST

Syntax

PINEAPPLE_DEVICE_FILTER_LIST [list (allow or deny)]

list (allow or deny) required

List to display (allow or deny)

PINEAPPLE_DEVICE_FILTER_MODE

Syntax

PINEAPPLE_DEVICE_FILTER_MODE [mode (allow or deny)]

mode (allow or deny) required

Filter mode.

allow permits only connections from devices in the allowed list of MAC addresses.

deny blocks connections from any device with a MAC address found in the denied list, and permits connections from all other devices.

Results

The PINEAPPLE_DEVICE_FILTER_... commands exit with a return code of 0 on success and non-zero on failure.

The PINEAPPLE_DEVICE_FILTER_... commands take effect immediately.

Examples

  PINEAPPLE_MIMIC_DISABLE # disable openAP mimic while changing filters
PINEAPPLE_DEVICE_FILTER_CLEAR allow
PINEAPPLE_DEVICE_FILTER_ADD allow 00:DE:AD:BE:EF:00
PINEAPPLE_DEVICE_FILTER_ADD allow 01:02:FE:ED:FA:CE
PINEAPPLE_DEVICE_FILTER_MODE allow
PINEAPPLE_MIMIC_ENABLE # re-enable mimic mode