username/s5p
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: control API and Tor integration #1

Merged
username merged 9 commits from feat/control-api into main 2026-02-17 09:56:06 +00:00
Conversation 0 Commits 9 Files Changed 16 +1488 -7
username commented 2026-02-17 09:55:34 +00:00
Owner
Copy Link

Summary

  • Add built-in HTTP control API for runtime inspection and management (GET /status, /metrics, /pool, /config; POST /reload, /pool/test, /pool/refresh)
  • Add Tor control port client with NEWNYM support (password/cookie/bare auth, client-side rate limiting, periodic circuit rotation)
  • Add --tracemalloc [N] flag for memory profiling (orthogonal to --cprofile)

Changes

  • src/s5p/api.py -- lightweight asyncio HTTP handler, no new deps
  • src/s5p/tor.py -- async TCP client for Tor control protocol
  • src/s5p/cli.py -- --api, --tracemalloc flags
  • src/s5p/config.py -- api_host/api_port, TorConfig dataclass
  • src/s5p/server.py -- lifecycle wiring for API and Tor controller
  • 16 files changed, +1488 lines

Test plan

  • 113 tests pass (29 API + 15 Tor + existing)
  • ruff clean
  • Manual: --api flag, curl all endpoints
  • Manual: --tracemalloc output on shutdown
  • Manual: Tor NEWNYM via API
## Summary - Add built-in HTTP control API for runtime inspection and management (GET /status, /metrics, /pool, /config; POST /reload, /pool/test, /pool/refresh) - Add Tor control port client with NEWNYM support (password/cookie/bare auth, client-side rate limiting, periodic circuit rotation) - Add --tracemalloc [N] flag for memory profiling (orthogonal to --cprofile) ## Changes - `src/s5p/api.py` -- lightweight asyncio HTTP handler, no new deps - `src/s5p/tor.py` -- async TCP client for Tor control protocol - `src/s5p/cli.py` -- --api, --tracemalloc flags - `src/s5p/config.py` -- api_host/api_port, TorConfig dataclass - `src/s5p/server.py` -- lifecycle wiring for API and Tor controller - 16 files changed, +1488 lines ## Test plan - [x] 113 tests pass (29 API + 15 Tor + existing) - [x] ruff clean - [x] Manual: --api flag, curl all endpoints - [x] Manual: --tracemalloc output on shutdown - [x] Manual: Tor NEWNYM via API
username added 9 commits 2026-02-17 09:55:35 +00:00
feat: add control API module ecf9a840e4 
Lightweight asyncio HTTP handler for runtime inspection and management.
Endpoints: /status, /metrics, /pool, /pool/alive, /config (GET) and
/reload, /pool/test, /pool/refresh (POST). Raw HTTP/1.1 parsing, JSON
responses, no new dependencies.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
feat: wire control API into server and config b72d083f56 
Add api_host/api_port to Config dataclass, parse api_listen key in
load_config(), add --api [HOST:]PORT CLI flag. Start/stop API server
in serve() alongside the SOCKS5 listener.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
test: add control API tests 4ee2cf5bb0 
29 tests covering request parsing, JSON response format, all GET/POST
handlers with mock context, 404/405 error routing.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
docs: document control API c939101a73 
Add API section to README (features, CLI, config), PROJECT (architecture),
USAGE (full endpoint reference with examples), CHEATSHEET (curl one-liners).
Update TASKS and ROADMAP.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
feat: Tor control port client with NEWNYM support b07135ad44 
Async TCP client for the Tor control protocol (port 9051).
Supports password, cookie, and bare authentication. Provides
NEWNYM signaling with client-side 10s rate limiting and
optional periodic timer. Auto-reconnects on disconnect.

Adds TorConfig dataclass and YAML parsing to config module.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
feat: wire Tor controller into server and API ff217be9c8 
Start/stop TorController in serve() lifecycle when tor: config
is present. Adds GET /tor (status) and POST /tor/newnym (signal)
endpoints to the control API. Logs control address at startup.
Adds tor: section and api_listen to example config.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
test: Tor controller and API endpoint tests f0281c4069 
Covers: password/cookie/bare auth, auth failure, connect failure,
NEWNYM success/rate-limiting/reconnect, GETINFO multi-line parsing,
start/stop lifecycle, GET /tor status, POST /tor/newnym dispatch,
and TorConfig YAML parsing.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
docs: document Tor control port integration d2df32fdab 
Adds Tor control port section to USAGE.md covering config,
auth modes, rate limiting, and API endpoints. Updates README
feature line and config example, CHEATSHEET with tor snippets,
and marks the feature complete in TASKS.md and ROADMAP.md.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
feat: add --tracemalloc flag for memory profiling 6c84a144c0 
Uses Python's built-in tracemalloc module to show top N memory
allocators on exit. Orthogonal to --cprofile; both can run together.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
username merged commit e6c82ad3c0 into main 2026-02-17 09:56:06 +00:00
username deleted branch feat/control-api 2026-02-17 09:56:20 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
username
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: username/s5p#1
Delete Branch "feat/control-api"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?