rootsign
Health Warn
- License — License: Apache-2.0
- Description — Repository has a description
- Active repo — Last push 0 days ago
- Low visibility — Only 8 GitHub stars
Code Pass
- Code scan — Scanned 12 files during light audit, no dangerous patterns found
Permissions Pass
- Permissions — No dangerous permissions requested
No AI report is available for this listing yet.
Rootsign is an open-source tamper-evident decision and action provenance logging library for AI agents
RootSign
Tamper-evident provenance logging for production AI agents.
What is RootSign?
RootSign is a Providex AI product — the agent capture layer of the Providex AI Agent Accountability Platform.
When AI agents take actions in production — calling tools, hitting APIs, writing to databases — there is no built-in audit trail. If something goes wrong (a wrong refund, a leaked PII record, a malformed deployment), there is no way to prove what the agent did, in what order, on whose authorization, or whether the record has been tampered with after the fact.
RootSign solves this. Each agent action is captured as an Action record containing a SHA-256 hash of the previous action — a cryptographic hash chain that makes the record tamper-evident. Modify any record after the fact and rootsign verify detects it.
Compliance-grade audit trails. Zero changes to your agent code.
Status
v0.1.5. LangGraph + CrewAI integrations, a framework-agnostic MCP proxy, rootsign verify CLI, PII redaction, human-in-the-loop checkpoints, opt-in decision capture (PRD-19 / ADR-008), and opt-in SDK micro-batching are all shipping.
| Phase | Scope | Status |
|---|---|---|
| 0 | Data model + storage + ingest handler | ✅ Complete |
| 1 | Python SDK — @rootsign.trace, LangGraph + CrewAI + MCP proxy, rootsign verify CLI, redaction, HiTL checkpoint, decision capture, micro-batching |
✅ v0.1.5 |
| 2 | Hosted ingest backend + compliance dashboard | Planned |
| 3 | Policy enforcement + incident workflow | Planned |
| 4 | Cross-platform governance | Planned |
Quickstart — LangGraph
1. Install
Python 3.11 or 3.12 recommended. RootSign itself supports 3.11+, but the
[crewai]extra currently lags on 3.13/3.14 wheels. If you hitNo matching distribution found for crewai, switch to Python 3.12 and reinstall.
pip install rootsign[langgraph]
Start PostgreSQL + TimescaleDB locally and apply the schema:
rootsign-admin start-db # docker run timescale/timescaledb:latest-pg16
rootsign-admin init # alembic upgrade head
start-db wraps a single docker run so you don't need to clone the repo. If you have cloned it, docker-compose up -d db is the equivalent developer path. Both reuse the same rootsign-timescaledb container name and rootsign_pgdata volume — pick either, not both.
2. Register your agent (one-time setup)
import asyncio
from rootsign import register_agent, AgentEnvironment, AgentRiskTier, AgentFramework
agent = asyncio.run(register_agent(
name="my-invoice-agent",
owner="platform-team",
environment=AgentEnvironment.PRODUCTION,
risk_tier=AgentRiskTier.HIGH,
framework=AgentFramework.LANGGRAPH,
))
print(agent.agent_id)
3. Instrument your tools
import rootsign
from rootsign import LocalIngestClient
from rootsign.database import AsyncSessionLocal
from langchain_core.tools import tool
from langgraph.prebuilt import ToolNode
@tool
def send_invoice(customer_id: str, amount: float) -> str:
"""Send an invoice to a customer."""
return "sent"
async def run_graph(agent_id):
async with AsyncSessionLocal() as db:
client = LocalIngestClient(db=db)
async with rootsign.session(agent_id=agent_id, client=client) as ctx:
tools = rootsign.wrap_tools([send_invoice], ctx=ctx, client=client)
tool_node = ToolNode(tools)
# ...build and run your graph as normal
await db.commit()
Every tool call now produces a tamper-evident Action record on the hash chain.
4. Verify the chain
$ rootsign verify 660e8400-e29b-41d4-a716-446655440001
VALID ✓ — 3 records, chain intact
Session: 660e8400-e29b-41d4-a716-446655440001
Exit code is 0 for VALID, 1 for TAMPERED. Use --local <path.jsonl> for offline JSONL session files (no DB required).
If a record was modified, the verifier names the broken link:
$ rootsign verify 660e8400-e29b-41d4-a716-446655440001
TAMPERED ✗ — chain broken at record #2
Detail: self_hash mismatch on action <action_id>
Session: 660e8400-e29b-41d4-a716-446655440001
WARNING: This session log may have been tampered with.
See docs/framework-support.md for the version matrix and integration notes. A full runnable LangGraph example (ReAct agent, three instrumented tools, OpenAI-backed) lives in examples/langgraph-invoice-agent.
Decision capture (opt-in)
Record the why before each tool call — foundational for Phase 2 session replay. Off by default; opt in deliberately with ROOTSIGN_CAPTURE_DECISIONS=true.
import os
os.environ["ROOTSIGN_CAPTURE_DECISIONS"] = "true"
async with rootsign.session(agent_id=agent.agent_id, client=client) as ctx:
# Record what the agent decided before calling the tool.
await ctx.record_decision(
selected_action="send_invoice",
reasoning_summary="Amount within policy; recipient verified.",
confidence=0.97,
ingest_client=client,
)
tools = rootsign.wrap_tools([send_invoice], ctx=ctx, client=client)
await tools[0].ainvoke({"customer_id": "acme", "amount": 1500.0})
# The Action record now carries decision_id linking it to the reasoning above.
Depth controls how much reasoning is persisted, via ROOTSIGN_REASONING_DEPTH:
| Value | What's stored |
|---|---|
minimal |
selected_action + confidence only |
summary (default) |
+ reasoning_summary truncated to 500 chars |
full |
+ reasoning_summary truncated to 10,000 chars + alternatives_considered |
Calling ctx.record_decision() when the flag is off is a silent no-op — safe to ship in capture-on and capture-off environments without conditionals at the call site. One Decision links to one Action; the pending slot is single and cleared after the next tool call consumes it. Decisions are not in the hash chain (ADR-008) — verify_chain is unchanged.
Quickstart — CrewAI
CrewAI integration is the same shape — wrap the tool list at construction time.
pip install rootsign[crewai]
import rootsign
from crewai import Agent
from crewai.tools import tool
@tool("send_invoice")
def send_invoice(customer_id: str, amount: float) -> str:
"""Send an invoice to a customer."""
return "sent"
async def run_crew(agent_id):
async with AsyncSessionLocal() as db:
client = LocalIngestClient(db=db)
async with rootsign.session(agent_id=agent_id, client=client) as ctx:
wrapped = rootsign.wrap_crewai_tools(
[send_invoice], ctx=ctx, client=client
)
agent = Agent(
role="Invoicing assistant",
goal="Send invoices",
tools=wrapped,
)
# ...run your crew as normal
await db.commit()
Tested against CrewAI 0.28, 0.40, and 1.x (see CI matrix).
Quickstart — MCP proxy (any framework)
Instead of a per-framework adapter, RootSign can intercept at the Model Context Protocol layer. Point your agent's MCP client at the RootSign proxy and every tools/call becomes a tamper-evident ACTION_RECORD — any MCP-compatible agent is instrumented with zero framework code.
pip install rootsign[mcp]
import rootsign
import uvicorn
from rootsign.mcp.proxy import create_proxy_app
async def serve_proxy(agent_id):
async with AsyncSessionLocal() as db:
client = LocalIngestClient(db=db)
async with rootsign.session(agent_id=agent_id, client=client) as ctx:
app = create_proxy_app(
upstream_url="http://your-mcp-server:8001/mcp",
client=client,
ctx=ctx,
# require_approval=True # gate every proxied call on human approval
)
# A uvicorn-compatible ASGI app. Point the agent's MCP_SERVER_URL
# here; tools/call is recorded and forwarded, other methods
# (initialize, tools/list, …) pass through unchanged.
await uvicorn.Server(uvicorn.Config(app, host="0.0.0.0", port=8000)).serve()
require_approval=True gates every proxied tool call on a human decision — the same HiTL flow as @rootsign.trace, pausing before the call reaches the upstream server. See ADR-010.
RootSign can also run as an MCP server — exposing the audit log itself as a read-only data source so an "auditor agent" can list sessions, pull a session's hash chain, verify integrity, and read approval records in-context:
from rootsign.mcp.server import create_server_app
app = create_server_app() # ASGI app; mounts the MCP server at /mcp
# uvicorn rootsign.mcp.server:app --port 8001
Four read-only tools (list_sessions, query_session_chain, verify_session_chain, get_approval_records) over the existing store — no new tables.
Human-in-the-loop checkpoint
High-risk actions can be gated on a human decision. Pass require_approval=True to @rootsign.trace and the SDK blocks the tool from running until someone approves it via the CLI.
import rootsign
@rootsign.trace(
ingest_client=client,
session_context=ctx,
require_approval=True,
timeout_seconds=300, # 5 minutes
)
async def wire_transfer(account: str, amount: float) -> str:
# This runs ONLY after a human approves.
return execute_transfer(account, amount)
When wire_transfer(...) is called, the SDK inserts an ACTION_RECORD with authorization_status='pending' and waits. An operator approves (or rejects) from another terminal:
$ rootsign approve --list
Pending approvals (1):
<action-id> wire_transfer session=<session-id> submitted=<timestamp>
$ rootsign approve <action-id> --reason "Verified with customer"
✓ Action <action-id> approved.
The decorated function returns normally. Rejection (--reject) raises HiTLRejectedError; a 5-minute timeout raises HiTLTimeoutError and the action's authorization status becomes 'timed_out' (a terminal forensic state distinct from 'human_rejected').
See ADR-007 for the design rationale (poll loop, timeout semantics, race tolerance).
PII redaction
RedactionConfig runs before hashing, so stored input_hash / output_hash values carry no PII signal. Three ready-to-use configs:
from rootsign import StandardPIIConfig, FinancialPIIConfig, HealthcarePIIConfig
# Standard: email, phone, US SSN, credit card, UK NI number
redaction = StandardPIIConfig()
tools = rootsign.wrap_tools(
[send_invoice], ctx=ctx, client=client,
redaction_config=redaction,
)
FinancialPIIConfig adds account / routing / IBAN patterns; HealthcarePIIConfig adds MRN / NPI / DOB. Each accepts extra_rules={...} for domain-specific patterns without subclassing. See ADR-006.
Micro-batching (opt-in)
BufferedIngestClient wraps any ingest client and buffers ACTION_RECORDs in memory, flushing asynchronously — so a long, tool-heavy pipeline doesn't pay a per-call ingest round-trip. Enable it with ROOTSIGN_BUFFERED=true (the factory wraps the transport for you), or wrap explicitly:
from rootsign import BufferedIngestClient, LocalIngestClient
async with BufferedIngestClient(LocalIngestClient(db=db)) as client:
async with rootsign.session(agent_id=agent_id, client=client) as ctx:
... # session() flushes the buffer before SESSION_CLOSE
Only auto-authorized actions are buffered; HiTL, decision, and session records pass through synchronously, so approvals and hash-chain ordering are never deferred. See ADR-009.
Performance
Instrumentation overhead is designed to be negligible. The LangGraph tracer's per-call overhead is benchmarked over 1,000 instrumented tool calls against a mock ingest client — isolating interception cost from the datastore:
| Metric | Per-call overhead |
|---|---|
| p99 | ~0.3 ms |
| mean | ~0.23 ms |
| median | ~0.23 ms |
That is ~15× under the 5 ms p99 budget enforced by the regression test test_p99_overhead_under_5ms (ADR-004). Reproduce it yourself — no database required:
ROOTSIGN_SKIP_DB_BOOTSTRAP=1 python -m pytest \
tests/performance/test_langgraph_benchmarks.py -m benchmark -s
The -m benchmark marker keeps the performance suite opt-in. Run it without --cov: coverage instrumentation roughly doubles the measured overhead and would not reflect production numbers. Figures above are indicative (dev laptop, Python 3.12); your absolute numbers will vary, but the budget assertion runs in CI-representative conditions.
Architecture
@rootsign.tracewraps a tool callable and emits anACTION_RECORDenvelope per call. LangGraphBaseTooland CrewAI tools are detected automatically.- MCP proxy —
create_proxy_appintercepts MCPtools/callat the protocol layer, so any MCP-compatible agent is instrumented without a framework adapter (ADR-010). LocalIngestClientis the in-process ingest path for v0.1.x. AHttpIngestClientfor the hosted backend lands in Phase 2.BufferedIngestClientoptionally wraps either for async micro-batching (ADR-009).- Hash chain is per-session: each
Actioncarriesprev_action_hashso reconstructing the chain detects any after-the-fact modification. HiTLCheckpointis an async poll loop that opens its own DB session per cycle — see ADR-007 for the loop-binding rationale.- Storage is PostgreSQL 16 + TimescaleDB 2.14. The
actionstable is a hypertable; the chain stays intact across chunks.
What's next
- Phase 2 cloud backend —
HttpIngestClient+ hosted compliance dashboard. Drop-in replacement forLocalIngestClient;BufferedIngestClientalready removes the per-call round-trip latency it would otherwise add. - Web UI for HiTL — approve/reject pending actions from a browser instead of the CLI.
- AutoGen integration — same duck-typing shape as CrewAI.
Watch the GitHub Issues for the active roadmap.
Contributing
We welcome contributions. See CONTRIBUTING.md for development setup, coding standards, and the PR process. By submitting a contribution, you agree to the CLA.
Have a question, an idea, or feedback from using RootSign? Start a thread in GitHub Discussions — that's the best place for design feedback, use-case questions, and feature ideas. For reproducible bugs and concrete feature requests, open a GitHub Issue.
License
Apache License 2.0 — see LICENSE and NOTICE.
Security
To report a vulnerability, see SECURITY.md. Do not open a public GitHub issue.
Reviews (0)
Sign in to leave a review.
Leave a reviewNo results found