Using REST APIs from module.py

[MAkcanca]

I'm developing some new modules for the Pineapple MK7, and I want to use some of the APIs from the python backend itself. However system does not include the requests library and it's really cumbersome to use urllib.requests.
Another problem, authentication. Even if we use the urllib.requests, there is no authentication so I can't access any of the APIs.
Specific API I was interested is pineap/handshakes.

I believe it is fundamental that backend is able to query some information from the pineapple service.

Thanks

[bad-antics]

Good point — the lack of requests and proper API auth from the Python backend is a real limitation for module development.

Workaround using urllib (no auth needed for localhost):
On the MK7, modules running as root can access the API via localhost using the stored token:

import urllib.request
import json
import ssl

# Disable SSL verification for localhost
ctx = ssl.create_default_context()
ctx.check_hostname = False
ctx.verify_mode = ssl.CERT_NONE

# Read the auth token
with open('/etc/pineapple/token', 'r') as f:
    token = f.read().strip()

def pineapple_api(endpoint, method='GET', data=None):
    url = f'https://127.0.0.1:1471/api/{endpoint}'
    headers = {
        'Authorization': f'Bearer {token}',
        'Content-Type': 'application/json'
    }
    if data:
        data = json.dumps(data).encode()
    req = urllib.request.Request(url, data=data, headers=headers, method=method)
    with urllib.request.urlopen(req, context=ctx) as resp:
        return json.loads(resp.read())

# Example: Get handshakes
handshakes = pineapple_api('pineap/handshakes')

Alternative — install requests via opkg:

opkg update
opkg install python3-requests

If storage is tight, install to SD card:

opkg install -d sd python3-requests
export PYTHONPATH=/sd/usr/lib/python3/dist-packages:$PYTHONPATH

Direct file access (fastest):
For handshakes specifically, you can also read them directly from the filesystem:

import os
handshake_dir = '/root/handshakes/'
for f in os.listdir(handshake_dir):
    if f.endswith('.pcap'):
        print(f'Handshake: {f}')