-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the official SPARC wiki. SPARC is a Rails 8.1 application for managing NIST SP 800-53 compliance documentation — System Security Plans (SSPs), Security Assessment Results (SARs), Security Assessment Plans (SAPs), Plans of Action & Milestones (POA&Ms), Component Definitions (CDEFs), and control catalogs. It replaces spreadsheet-based workflows with a web UI and REST API, with full OSCAL v1.1.2 import/export support.
| Resource | Link |
|---|---|
| Repository | risk-sentinel/sparc |
| Releases | All releases |
| Issues | Open issues |
| Documentation index |
docs/MAP.md — full docs/ inventory |
| Current Version | v1.12.1 |
Versioning note: SPARC's public release line is v1.x (current: v1.12.1). Older
v2.x–v3.xentries in the Changelog are the project's pre-reset numbering, retained for historical traceability.
First-15-minutes setup — Docker quick start, seeding the NIST catalogs, first login, and where to go next.
29 roles aligned with NIST SP 800-37 Rev. 2 and OSCAL standards, granular permission keys, instance vs. authorization-boundary scoping, and the Instance Admin bypass flag.
How SPARC organizes and isolates data — Organization → Authorization Boundary → OSCAL artifacts — and the boundary-scoped access model (NIST AC-3).
Complete inventory of every page in the application — Controls Layer, Implementation Layer, Assessment Layer, Authorization Boundary Management, Evidence, Federation, and Admin.
OSCAL import/export/validation, the document processing pipeline, SSP/SAR wizards, control mapping, converters (CCI / AWS), KSI validations, the HDF ↔ OSCAL bridge, authoritative-source federation, and audit logging.
How SPARC maps external frameworks — DISA STIG, CIS Benchmarks, CCI, SCAP/OVAL — to NIST SP 800-53 via OSCAL, and the roadmap for expanding coverage.
Domain model hierarchy, database schema, the service layer, and background-job architecture.
Authentication providers (local, GitHub, GitLab, OIDC, LDAP), deployment patterns (Docker, AWS), the OSCAL ecosystem, and Active Storage.
REST API overview and a pointer to the full per-endpoint docs and Postman collection under docs/api/.
All SPARC_* environment variables for auth, database, OIDC, LDAP, SMTP, logging, and deployment.
OSCAL and NIST RMF terminology reference.
Common questions and fixes for setup, auth, OSCAL validation, and deployment.
How to propose changes — the mandatory issue process, branching, and compliance-artifact requirements.
Full release history — the current v1.x line plus the legacy v2.x–v3.x entries.
| Component | Technology |
|---|---|
| Framework | Ruby 3.4.4, Rails 8.1.3 |
| Database | PostgreSQL 15 |
| Background Jobs | Solid Queue (default) · Sidekiq + Redis (optional) |
| Frontend | Hotwire (Turbo + Stimulus), Bootstrap 5.3 |
| Asset Pipeline | Propshaft, importmap (no Node build step) |
| Auth | OmniAuth (GitHub, GitLab, OIDC), net-ldap, bcrypt |
| OSCAL Validation | json_schemer (NIST OSCAL v1.1.2 schemas, baked into the container) |
| File Parsing | Nokogiri (XML) |
| Containerization | Docker, Docker Compose |
# Docker (recommended)
docker compose up --build
docker compose exec web bin/rails db:seed
# Local development
bundle install
bin/rails db:create db:migrate db:seed
bin/rails serverSee Getting Started for a guided walkthrough, Configuration for all environment variables, and Integrations for auth provider setup.
This wiki is mirrored from the wiki/ directory in the main repository and
published via wiki/PUSH_TO_WIKI.sh. Edit the source under wiki/ in
risk-sentinel/sparc
through the normal issue/PR process — direct edits to the wiki git repo are
overwritten on the next sync.
All pages use GitHub-flavored Markdown. Please include cross-references to issues, PRs, and commits where relevant. See Contributing for the full process.
Getting Started
User Guides
- User Guides (index)
- Getting Oriented
- Authorization Boundaries
- Control Catalogs & Baselines
- Converters & Imports
- System Security Plans (SSP)
- Component Definitions (CDEF)
- Security Assessment Plan (SAP)
- Security Assessment Results (SAR)
- POA&M
- Evidence & Attestations
- HDF Amendment Triage
- Compliance Library
- Security Keys & Smart Cards
- Administration
Documentation
- RBAC (Role-Based Access Control)
- Data Isolation
- Screens & UI
- Core Functions & Features
- Framework Mapping
- Integrations
- Architecture
- API Reference
Reference
Links