SovereignShield
DEVELOPER HUB

Documentation

Guidance for using the local Matrix, reviewing the CI tool, and adapting implementation examples.

Quickstart Guide

The Matrix works without an account or database connection and stores control statuses in browser localStorage. Optional network features have separate boundaries.

1

Run the Assessment

Take the Free Assessment to identify your baseline compliance gaps.

2

Track in the Matrix

Use the Compliance Matrix to check off technical requirements locally.

3

Export Ledger

Export your JSON ledger with a locally computed SHA-256 integrity digest for auditor discussion.

Local-First Architecture

The Matrix does not require access to your AWS or GCP environment. Control statuses are entered and stored locally in the browser.

  • State Management: Checklists and matrix states are stored in browser localStorage.
  • Integrity: Your state is hashed with SHA-256 using the Web Crypto API to ensure tamper evidence.
  • P2P Sync: Selected local state can be sent over an encrypted WebRTC data channel; connection setup discloses metadata to a public STUN service.

Run a repeatable engineering review

  1. In the Matrix, record statuses, owners, deadlines and evidence notes. Save a full workspace backup using Export → Backup Entire Workspace.
  2. At your next review, open Review brief and select that previous version 3 JSON or encrypted .shld backup. Enter its password if needed, then compare. The file stays local and is not restored over your current work.
  3. Inspect the free preview. Pro can export a Markdown brief; evidence-note contents are excluded unless selected. Owner names and deadlines are included. Review the file before sharing.
  4. Save a fresh backup after resolving or assigning work. Retain it for the next comparison. Baselines are held only for this page visit; refresh the preview after edits or sync.

The brief compares Matrix statuses, owners, deadlines and notes. It excludes DPDP records, vendor records and scanner observations. Older partial exports cannot establish a complete baseline. Without a baseline it shows current work only. Self-reported status and note presence do not verify implementation.

CLI Scanner

Evaluate an exported JSON ledger's self-reported control statuses in a local terminal or CI pipeline. This does not scan your application code or infrastructure.

From a local repository checkout
npm install
Evaluate an exported ledger file
node src/utils/cliScanner.js --config ./my-export.json --fail-on non-compliant
# Replace my-export.json with your exported ledger path.

Code Boilerplates

PRO FEATURE

SovereignShield Pro displays implementation examples (TypeScript, Postgres SQL, Go, Python) associated with mapped controls. Review and adapt them for your systems.

/* Example: PostgreSQL RLS Policy for GDPR Art. 32 */
CREATE POLICY user_isolation_policy ON "public"."Users"
AS PERMISSIVE FOR ALL
TO authenticated
USING (auth.uid() = id)
WITH CHECK (auth.uid() = id);

Access all 34 boilerplates via the Matrix tool when authenticated with a Pro license.