Documentation

Developer Docs

Get started with KSP in minutes. Build from source, run your first connection, and explore the protocol.

New to KSP?Take our interactive step-by-step developer journey tour →

Quick Start

1. Start a KSP Serverbash

# Clone & build
git clone https://github.com/Kush2272/ksp
cd ksp
cargo build --release

# Run the server on port 9876
cargo run --bin ksp-server

2. Connect a Clientbash

# In a separate terminal
cargo run --bin ksp-client

# The client will:
# 1. TCP connect to 127.0.0.1:9876
# 2. Perform KSP handshake (X25519 + HKDF)
# 3. Open a stream and send encrypted data

3. Observe with Wiresharkbash

# Load the KSP Lua dissector in Wireshark
# Wireshark → Preferences → Protocols → Lua
# Load: wireshark/ksp_dissector.lua

# Filter KSP traffic
tcp.port == 9876

4. Run Benchmarksbash

# Run all Criterion benchmarks
cargo bench

# Run specific benchmark
cargo bench -- handshake
cargo bench -- serialization
cargo bench -- throughput

Protocol Concepts

Sessions & Streams

Understanding KSP sessions and stream multiplexing

Handshake Flow

Step-by-step: ClientHello to Secure Channel

Encryption Model

AEAD, nonce construction, and key derivation

Replay Protection

The sliding window algorithm

Implementation Guide

Sending Data

Building and sending KSP StreamData frames

Receiving & Parsing

Header parsing and payload decryption

Session Resumption

Using SessionTickets for fast reconnect

Error Handling

Error codes, graceful shutdown, and GoAway

Configuration

Server Config

Port, timeout, max streams, keepalive intervals

Cipher Selection

AES-256-GCM vs ChaCha20-Poly1305 tradeoffs

Certificate Setup

Self-signed vs CA-signed KSP certificates

Docker Deployment

Running KSP in containers

CLI Guides & Workflow

CLI Installation Guide

Install, update, uninstall, and PATH configuration

CLI Quick Start

End-to-end tutorial from ksp init to secure transfer

Practical CLI Examples

File transfer, secure chat, benchmark, and proxy workflows

All 50+ CLI Commands Hub

Comprehensive reference directory for all ksp subcommands

Package Managers & Distros

Cargo, Winget, Homebrew, Scoop, and Docker distribution

Releases & Governance

Release Notes — v0.1.0

Highlights, SHA256 checksums, and production release info

Platform Roadmap

Milestone status and future ecosystem deliverables

Security Policy

Vulnerability reporting coordinates and supported versions

Support & Troubleshooting

Frequently Asked Questions

Answers to common architectural and usage questions

Troubleshooting Guide

Resolving network, firewall, and certificate issues

Known Issues

Documented workarounds and OS-specific gotchas

Technical Reference

API Docs (docs.rs)

Crate API structure and types

RFC Specification

Access the full RFC-0001 standard

Architecture Explorer

Clickable visual layered diagrams

Threat Model Matrix

Security metrics and mitigated vectors

Wire Format Reference

Detailed 48-byte header offsets

Protocol Conformance

Interoperability check & compliance

Glossary of Terms

A-Z crypto & networking vocabulary

CLI Command Reference

ksp init

Initialize workspace configuration

ksp new

Scaffold new KSP applications

ksp doctor

Diagnose system health & network stack

ksp diag

Perform PMTUD & jitter diagnostics

ksp server

Start KSP protocol server

ksp connect

Open interactive client session

ksp ping

Measure encrypted frame RTT

ksp transfer

Transmit files over multiplexed streams

ksp capture

Record live traffic to pcapng traces

ksp benchmark

High-concurrency stress testing

ksp cert

Generate Ed25519 binary certificates

ksp security

Audit cryptographic policies

ksp gateway

Enterprise ingress bridge

ksp proxy

Local transparent forwarder

ksp dashboard

Live terminal UI monitor

ksp wireshark

Install Lua protocol dissector

Protocol Constants

Default Port9876/tcp

Header Size48 bytes

Max Payload16 MB

Auth Tag16 bytes

Handshake Timeout10 seconds

Keepalive Interval30 seconds

Session Timeout3600 seconds

Max Streams256 per session

Window Size65,535 bytes

Replay Window1024 packets

Sequence Numbers64-bit unsigned

Nonce Size12 bytes