Pineapple Alert payloads are launched in response to events detected by the Pineapple Recon service.

Alert payloads are small, responsive payloads launched when events occur. An alert payload may generate a full screen alert, but can not otherwise interact with the user

Keep it small!

Remember - alerts can happen at any time. Generally, it’s important to keep an alert payload small, and perform simple actions.

Alert payloads can be launched when the user is on any screen; because they interrupt the user, they do not have a normal payload interface and can not launch dialogs or input pickers, but can use the ALERT DuckyScript comamnd to show information.

When designing an Alert payload, keep in mind that all the alert payloads for an event run whenever the event occurs. Playing a sound or setting a LED status may make sense, but if every payloads attempts to do so at the same time, it doesn’t help the user.

Alert environment

When an Alert payload is launched, it is given all the information about the event in the form of environment variables. Environment variables are accessible in a payload by name, such as ${_RECON_SELECTED_AP_CHANNEL}

deauth_flood_detected
Variable Payload Description
PAYLOAD_HOME All Directory where the payload is installed
_ALERT deauth_flood_detected Alert name (deauth_flood_detected)
_ALERT_DENIAL_MESSAGE deauth_flood_detected Human-readable description of the event
_ALERT_DENIAL_SOURCE_MAC_ADDRESS deauth_flood_detected Source of the denial flood
_ALERT_DENIAL_DESTINATION_MAC_ADDRESS deauth_flood_detected Destination of the denial flood
_ALERT_DENIAL_AP_MAC_ADDRESS deauth_flood_detected Access point targetted denial flood
_ALERT_DENIAL_CLIENT_MAC_ADDRESS deauth_flood_detected Client targetted by denial flood

handshake_captured
Variable Payload Description
PAYLOAD_HOME All Directory where the payload is installed
_ALERT handshake_captured Alert name (handshake_captured)
_ALERT_HANDSHAKE_SUMMARY handshake_captured Human-readable description of handshake
_ALERT_HANDSHAKE_AP_MAC_ADDRESS handshake_captured MAC address of the access point
_ALERT_HANDSHAKE_CLIENT_MAC_ADDRESS handshake_captured MAC address of the client
_ALERT_HANDSHAKE_TYPE handshake_captured Type of handshake (EAPOL, PMKID)
_ALERT_HANDSHAKE_COMPLETE handshake_captured Is the handshake a complete 4-way + beacon handshake? (only EAPOL)
_ALERT_HANDSHAKE_CRACKABLE handshake_captured Does the handshake contain the proper packets to be considered attackable by normal tools? (only EAPOL)
_ALERT_HANDSHAKE_PCAP_PATH handshake_captured Path to the handshake pcap logfile
_ALERT_HANDSHAKE_HASHCAT_PATH handshake_captured Path to the handshake hashcap 22000-format logfile

client_connected
Variable Payload Description
PAYLOAD_HOME All Directory where the payload is installed
_ALERT client_connected Alert name (client_connected)
_ALERT_CLIENT_CONNECTED_SUMMARY client_connected Human-readable summary of client connection
_ALERT_CLIENT_CONNECTED_CLIENT_MAC_ADDRESS client_connected Client MAC address
_ALERT_CLIENT_CONNECTED_SSID client_connected SSID client connected to
_ALERT_CLIENT_CONNECTED_SSID_LENGTH client_connected Length of SSID client connected to