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.6.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.6-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: usmp-0.2.6.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","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.6.tar.gz
Algorithm Hash digest
SHA256 680df876c6c80e8084c6215523f25bc18996e3f272070d544ed991169977291a
MD5 fecc69103f3e4701db967e7c76005305
BLAKE2b-256 b51be820274a56642279b73023cb3734a15c1079dad40a635c0b069c93953997

See more details on using hashes here.

File details

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

File metadata

  • Download URL: usmp-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 de25f3bd769520642ffdcca8a8d6db7e2f666b2436ae4cdd07ed679288d54d12
MD5 912b3e99276bfc0466240cb35e56703f
BLAKE2b-256 07bb960d1e6bf8cd9572b72782c6d1f4b4c636547d22e61ad5d195f9ea0e5f14

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