Skip to main content

USMP — Unified Secure Multi-transport Protocol. Secure, encrypted device communication for ESP32, Arduino and IoT.

Project description

USMP — Unified Secure Multi-transport Protocol

Secure, encrypted communication for ESP32, Arduino, and IoT devices.

USMP sits between raw TCP (no security) and full TLS (too heavy for microcontrollers) — giving any constrained device a fully encrypted, mutually authenticated session in three function calls.

pip install usmp

What it gives you

  • Mutual authentication — both device and server verify each other via HMAC-SHA256 + PSK
  • Forward secrecy — X25519 ephemeral key exchange, new keys every session
  • Encryption — AES-256-GCM, mandatory, no plaintext mode
  • Replay protection — monotonic sequence numbers

Quickstart

Server

import asyncio
from usmp import USMPServer, USMPSession, ConnectionClosedError

server = USMPServer(host="0.0.0.0", port=9000, psk=b"your-psk-here")

@server.on_session
async def handle(session: USMPSession):
    print(f"Device connected: {session.device_id}")
    try:
        while True:
            data = await session.recv()
            print(f"RX: {data}")
            await session.send(b"got it")
    except ConnectionClosedError:
        print(f"Device disconnected: {session.device_id}")

asyncio.run(server.serve())

Client (Python)

import asyncio
from usmp import USMPClient, ConnectionClosedError

async def main():
    client = USMPClient(host="127.0.0.1", port=9000, psk=b"your-psk-here")
    async with client.connect() as session:
        await session.send(b"hello")
        reply = await session.recv()
        print(f"RX: {reply}")

asyncio.run(main())

Client (ESP32 / Arduino)

#include <USMP.h>

USMPClient usmp("your-psk-here");

void setup() {
    usmp.begin(USMP::TCP("192.168.1.100").wifi("SSID", "password"));
    usmp.send("hello from esp32");
}

void loop() {
    usmp.maintain(); // keepalive + reconnect

    if (usmp.available()) {
        Serial.println(usmp.read());
    }
}

Protocol overview

Device                        Server
  |                              |
  |-- HELLO (device_id, pub_C) -->|
  |<- CHALLENGE (nonce, pub_S) ---|
  |-- HELLO_ACK (HMAC) ---------->|
  |<- SESSION_OK (session_id) ----|
  |                              |
  |== AES-256-GCM encrypted ======|

4-step handshake, then every frame is AES-256-GCM encrypted with a session key derived via X25519 + HKDF-SHA256.

Installation

pip install usmp

Requires Python 3.11+.

ESP32 / Arduino library

The Arduino library and ESP-IDF component are available at github.com/metaloomlabs/usmp.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

usmp-0.2.5.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

usmp-0.2.5-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file usmp-0.2.5.tar.gz.

File metadata

  • Download URL: usmp-0.2.5.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for usmp-0.2.5.tar.gz
Algorithm Hash digest
SHA256 a0b96ea747705458afc380cf712c6d70e99c57942a94361fb7dca7b0ef52e14b
MD5 45c697641942def7d7c3bc38eb81b449
BLAKE2b-256 52a4a3ad9f47c83c6316530778873eaecb8957dd14aca81d577cdd96c04d763d

See more details on using hashes here.

File details

Details for the file usmp-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: usmp-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for usmp-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f38309ebf00a089468ed5cbdbd6bc4e35046b3a5e8b204957122d5453b82680a
MD5 4199b9afdb1c3e945bbb9c2f3614455d
BLAKE2b-256 1b19860ad1505bf8afaed85f2a3d603d720ebe6261619e0165bd3e8612c20124

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page