README.md

📖 README.md — siglatch

Warning

2.0-dev is a development release. For stable production use, pin to the 1.0 tag.

🔒 Project Overview

Siglatch is a lightweight, configurable, encrypted UDP control bus for remote infrastructure.

It provides:

• Builtin actions for hot reloads and live reconfiguration
• Plugin-style execution via shell scripts, static objects, or dynamic objects
• Policy controls for IP allowlists, user gating, action gating, and wire validation
• Bidirectional fragmented UDP transport with user-defined protocol families and protocol demux
• Multi-packet support for larger payloads, including stream-like or batched file-style submission

---

📌 Roadmap

• This project is under active development.
• Current version: 2.0-dev.
• Stable version: see tag 1.0.
• v1: single-packet RSA-2048 encrypted transport.
• v2: stateless hybrid bidirectional fragmented transport.
• v3: (projected) DTLS-based session transport with QUIC/HTTP/3 support and commercial-grade polish.

---

🚀 Quickstart

Start the daemon:

./siglatchd

In another terminal, send a test request:

./knocker localhost root 59 --protocol v4 "some payload here"

---

🧱 Dependencies

• OpenSSL 3.x
• See Dependencies for the full build/runtime list.

---

📚 Documentation

These guides are being actively updated, check back often for updates!

• 🧱 DEPENDENCIES — Build/runtime requirements and OpenSSL 3 setup notes.
• 📦 FEATURES — Full feature specification (current and planned).
• 📝 CHANGELOG (2026-03-12) — Recent development changes since 1.0.
• 🔐 SECURITY — Security model, mitigations, and threat considerations.
• 🌎 USE CASES — Common deployment patterns and examples.
• ⚙️ Installation
  • 🛠️ COMPILING — How to build the project from source.
  • 🧾 DAEMON_CONFIGURATION — Manual for configuring the server daemon.
  • 📥 INSTALLATION — install.sh help and setup guide.
  • 📚 QUICK START — AFTER you've compiled and configured siglatch!
  • 🖥️ CLIENT_OPERATIONS — Detailed instructions for client-side use.
• 📦 Modules
  • 🌐 IP_AUTH — IP-based authentication module details
• 🧠 AI_DISCLOSURE — A short note on the use of AI within this project.
• 🚧 PLANNED_FEATURES — planned and upcoming features
• 🔒 LICENSE — SOFTWARE LICENSE
• 🧑‍💻 USE POLICY — USE POLICY

Please read the above documents carefully to understand setup procedures, operational safety, and future plans.

Siglatch is built for operators who need control, security, and minimal exposure.

---

• 🔒 This project is licensed under the MTL-10 License
• 🧑‍💻 Free for use by teams with ≤10 users
• 💼 Commercial, resale, or SaaS use requires a license
• 📩 Contact: legal@m7.org

(Updated: 2026)