Secure Swarm Toolkit Documentation

This page introduces Secure Swarm Toolkit (SST), links to the source repository, and points readers to the right next pages depending on whether they are running SST for the first time or extending an existing setup.

SST secures distributed IoT and edge systems by putting a local authorization service, called Auth, near the entities that need to communicate. Entities authenticate to Auth, request session keys for allowed communication targets, and then use those keys to create secure channels with other entities.

The source repository is iotauth/iotauth. In these docs, “repository root” means the top-level iotauth/ directory after cloning that repository.

First-Time Setup

Use this path if you are new to SST and want to get one working local example before reading the full API surface:

1. Architecture: learn the moving parts and the message flow.
2. Quick Start: run one complete Auth plus entity example.
3. Network Configuration: understand what the .graph file generates.
4. C Guide or Node.js Guide: use the guide that matches your entity's language.
5. Troubleshooting: debug common setup, path, port, and key-generation issues.

Implementation Deep Dive

Use this path if you already know the basics and need to change topology, write entity code, or inspect APIs:

• Deployment Configuration for changing topologies.
• Entity Capabilities for comparing C and Node.js support.
• C API Reference for embedded/entity code.
• Node.js API Reference for accessor-based entities.
• Server/Client Example for a complete C entity walkthrough.
• File Block Encryption for offline block-level encryption.
• IPFS File Sharing for file encryption and access-control workflows.

What the repository contains

Directory	Purpose
auth/	Java implementation of Auth, including the Auth server, database library, properties files, and migration solver.
entity/c/	C API, secure communication helpers, IPFS helpers, tests, and example C entities.
entity/node/	Node.js accessor-style API and interactive example entities.
entity/python/	Python support for the file sharing/File System Manager path.
examples/	Scripts that generate credentials, Auth properties, Auth databases, and entity configs from .graph files.