Skip to content

TrustSignal-dev/TrustSignal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

126 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TrustSignal

CI License TypeScript Coverage Security Checklist

Website: https://trustsignal.dev

TrustSignal is evidence integrity infrastructure for existing workflows. It acts as an integrity layer that returns signed verification receipts, verification signals, verifiable provenance metadata, and later verification capability without replacing the upstream system of record.

Problem

High-stakes document and evidence workflows create an attack surface after collection, not just at intake. Once an artifact has been uploaded, reviewed, or approved, downstream teams still face risks such as tampered evidence, provenance loss, artifact substitution, and stale evidence that can no longer be verified later.

Those risks matter in audit, compliance, partner-review, and trust-sensitive workflows because the evidence is often challenged after collection rather than at the moment it first entered the system. TrustSignal is designed for workflows where later auditability matters because the artifact, its provenance, or the surrounding workflow record may be questioned later.

Verification Lifecycle

The canonical lifecycle diagram and trust-boundary view are documented in docs/verification-lifecycle.md.

TrustSignal accepts a verification request, returns verification signals, issues a signed verification receipt, and supports later verification against stored receipt state so downstream teams can detect artifact tampering, evidence provenance loss, or stale records during audit review.

Demo

The fastest evaluator path is the local 5-minute developer trial:

TrustSignal provides:

  • signed verification receipts
  • verification signals
  • verifiable provenance metadata
  • later verification capability
  • existing workflow integration through the public API boundary
npm install
npm run demo

It shows the full lifecycle in one run:

  1. artifact intake
  2. verification result
  3. signed receipt issuance
  4. later verification
  5. tampered artifact mismatch detection

See demo/README.md.

Integration Model

Start here if you are evaluating the public verification lifecycle:

Golden path:

  1. submit a verification request
  2. receive verification signals plus a signed verification receipt
  3. retrieve the stored receipt
  4. run later verification

Technical Details

The fastest path in this repository is the public /api/v1/* evaluator flow. It is a deliberate evaluator path, not a shortcut around production controls.

The current partner-facing lifecycle in this repository is:

  • POST /api/v1/verify
  • GET /api/v1/receipt/:receiptId
  • GET /api/v1/receipt/:receiptId/pdf
  • POST /api/v1/receipt/:receiptId/verify
  • POST /api/v1/receipt/:receiptId/revoke
  • POST /api/v1/anchor/:receiptId
  • GET /api/v1/receipts

What You Will See

The evaluator path is designed to show the core value before full production integration work:

  • artifact intake through the public API
  • signed verification receipt issuance
  • verification signals that can be stored in an existing workflow
  • later verification against the stored receipt state
  • visible handling for tampered evidence or stale evidence through the later verification lifecycle

Local API Development Setup

Prerequisites:

  • Node.js >= 18
  • npm >= 9
  • PostgreSQL >= 14 for apps/api

Minimal setup:

npm install
cp .env.example .env.local
cp apps/api/.env.example apps/api/.env
npm -w apps/api run db:generate
npm -w apps/api run db:push
npm -w apps/api run dev

In a second terminal:

npm -w apps/web run dev

Default local ports:

  • web app: http://localhost:3000
  • API: http://localhost:3001

Run The API Evaluation Flow

Once the local API is running, use the evaluator quickstart or the public examples directly:

curl -X POST "http://localhost:3001/api/v1/verify" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $TRUSTSIGNAL_API_KEY" \
  --data @examples/verification-request.json

Then retrieve the stored receipt and run later verification:

curl "http://localhost:3001/api/v1/receipt/$RECEIPT_ID" \
  -H "x-api-key: $TRUSTSIGNAL_API_KEY"

curl -X POST "http://localhost:3001/api/v1/receipt/$RECEIPT_ID/verify" \
  -H "x-api-key: $TRUSTSIGNAL_API_KEY"

What The Developer Trial Proves

The evaluator flow demonstrates that:

  • TrustSignal can fit behind an existing workflow without replacing the system of record
  • the API returns signed verification receipts and verification signals in one flow
  • later verification is explicit and separate from initial receipt issuance
  • the system is built for attack surfaces such as tampered evidence, provenance loss, and artifact substitution in later review paths

Integration Fit

TrustSignal is designed to sit behind an existing workflow such as:

  • a compliance evidence pipeline
  • a partner portal
  • an intake or case-management system
  • a deed or property-record workflow

The upstream platform remains the system of record. TrustSignal adds an integrity layer at the boundary and returns technical verification artifacts that the upstream workflow can store and use later.

Integration Boundary Notes

The local evaluator path is intentionally constrained. Local development defaults are a deliberate evaluator and development path, and they fail closed where production trust assumptions are not satisfied.

Authentication is x-api-key with scoped access. Revocation additionally requires issuer authorization headers: x-issuer-id, x-signature-timestamp, and x-issuer-signature.

The repository also still includes a legacy JWT-authenticated /v1/* surface used by the current JavaScript SDK:

  • POST /v1/verify-bundle
  • GET /v1/status/:bundleId
  • POST /v1/revoke

Production Deployment Requirements

Production deployment requires explicit authentication, signing configuration, and environment setup. Public documentation should be read as architecturally mature and bounded, not as a claim that every deployment control is satisfied automatically.

For production use, plan for at least:

  • explicit API-key and JWT configuration
  • signing configuration and key management through environment setup
  • receipt lifecycle checks before downstream reliance
  • database and network security controls appropriate for the deployment environment
  • environment-specific operational controls outside this repository

Fail-closed defaults are part of the security posture. They are meant to prevent the system from silently assuming production trust conditions that have not been configured.

Public API Contract And Examples

The public evaluation artifacts in this repo are:

These artifacts document the public verification lifecycle only. They intentionally avoid proof internals, model outputs, circuit identifiers, signing infrastructure specifics, and internal service topology.

Security Posture

Public-facing security properties for this repository are:

  • scoped API authentication for the integration-facing API
  • request validation and rate limiting at the gateway
  • signed verification receipts returned with verification responses
  • later verification of stored receipt integrity and status
  • explicit lifecycle boundaries for read, revoke, and provenance-state operations
  • fail-closed defaults where production trust assumptions are not satisfied

See docs/security-summary.md, SECURITY_CHECKLIST.md, and docs/SECURITY.md for the current public-safe security summary and repository guardrails.

What TrustSignal Does Not Claim

TrustSignal does not provide:

  • legal determinations
  • compliance certification
  • fraud adjudication
  • a replacement for the system of record
  • infrastructure claims that depend on environment-specific evidence outside this repository

Current Repository Context

DeedShield is the current application surface in this repository. The broader product framing remains TrustSignal as evidence integrity infrastructure and an integrity layer for existing workflows.

Newbie Difficulty Rating

Overall: 7 / 10 — This is a production-grade, security-critical codebase. It requires familiarity with multiple technologies and concepts. Newcomers with a general web-development background can follow the evaluator path and run the demo within minutes, but full contribution requires deeper expertise across several layers.

Area Difficulty Notes
Running the demo 2 / 10 npm install && npm run demo is all you need
API integration 3 / 10 Well-documented OpenAPI spec and Postman collections
Web app (Next.js) 4 / 10 Standard React and Next.js patterns
API server (Fastify) 5 / 10 Requires Node.js and TypeScript familiarity
Verification core 6 / 10 Cryptographic hashing and JWS signing knowledge needed
Smart contracts 8 / 10 Requires Solidity and Hardhat experience
ZKP circuits 9 / 10 Requires Rust and Halo2 zero-knowledge proof expertise

Recommended Starting Points by Background

  • Evaluator / non-engineer — Run npm run demo and read docs/partner-eval/start-here.md
  • Junior developer — Follow the local setup in this README, then explore apps/api
  • Full-stack developer — Dive into apps/api and packages/core
  • Blockchain engineer — Explore packages/contracts and the anchoring lifecycle
  • Cryptography / ZKP engineer — Explore circuits/

Validation

Relevant repository checks include:

npm run messaging:check
npm run typecheck
npm run build

Documentation Map

About

Evidence integrity infrastructure without workflow changes TrustSignal sits behind your existing evidence flow, generating signed cryptographic receipts at ingestion so you can mathematically prove compliance records remain unchanged.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors