API di validazione OSCAL

Invia tramite POST un documento OSCAL 1.2.2 JSON e ottieni un rapporto di validazione leggibile dalla macchina, generato dallo stesso motore del validatore nel browser e progettato per pipeline CI, agenti e integrazioni. Non è richiesto alcun account.

Elaborazione temporanea, nessuna archiviazione. Il documento viene validato in memoria su server nell’UE (Francoforte) e scartato insieme alla risposta. Secani non conserva, registra né riutilizza i contenuti; la telemetria contiene soltanto dati aggregati.

curl -sS -X POST https://secani.com/api/oscal/v1/validate \
  -H "content-type: application/json" \
  --data-binary @system-security-plan.json

Gli artefatti di grandi dimensioni si comprimono molto bene. Inviali con gzip per rimanere sotto il limite di trasferimento di 4 MB:

gzip -c catalog.json | curl -sS -X POST https://secani.com/api/oscal/v1/validate \
  -H "content-type: application/json" \
  -H "content-encoding: gzip" \
  --data-binary @-

Cosa realizzano i team con l’API

Controllare i merge nella CI

Valida gli SSP, i profili e le definizioni dei componenti nel repository a ogni pull request. Dirigi il flusso in base al campo valid e passa direttamente a ogni problema tramite il relativo JSON Pointer RFC 6901.

Agenti IA autocorrettivi

Gli agenti che generano o modificano OSCAL possono validare in un ciclo: produrre un documento, leggere i problemi indicati con puntatori precisi, correggerlo e validarlo di nuovo, senza intervento umano nel ciclo di riparazione.

Strumenti nel browser senza backend

CORS è aperto, quindi gli strumenti web interni possono inviare documenti tramite POST direttamente dal browser, ad esempio per verificare la definizione dei componenti consegnata da un partner prima di accettarla.

Come funziona il contratto v1

Il documento è la richiesta

Invia direttamente OSCAL 1.2.2 JSON tramite POST, senza involucro e senza account. Tutti gli otto modelli vengono rilevati dalla chiave radice. Una validazione completata restituisce sempre HTTP 200; i documenti non validi indicano valid: false.

Sono benvenuti documenti di grandi dimensioni

Fino a 4 MB di dati grezzi trasferiti e 24 MB dopo la decompressione con corpi di richiesta gzip. Il catalogo NIST SP 800-53 completo viene validato in molto meno di 100 millisecondi.

Tutto leggibile dalla macchina

Fino a 200 problemi con totali esatti, codici di errore RFC 9457 stabili, intestazioni RateLimit e un contratto OpenAPI 3.1 per la generazione dei client.

Limiti anonimi equi

10 richieste al minuto e 300 al giorno per client, indicate negli header di risposta RateLimit. Con una chiave API il limite sale a 120 al minuto e 10.000 al giorno; il livello anonimo resta disponibile.

Per impostazione predefinita, l’API esegue una validazione rigorosa con JSON Schema per OSCAL 1.2.2 e una patch di compatibilità dei profili documentata. Con level=full aggiunge controlli di vincoli e riferimenti, e ogni risposta indica l’esatto insieme di regole applicato, così un report salvato diventa un’attestazione riproducibile.

Domande frequenti sull’API di validazione OSCAL

Valida documenti OSCAL 1.2.2 JSON tramite HTTP. Invia il documento stesso come corpo di una richiesta POST e ricevi un report leggibile dalla macchina, generato dallo stesso motore del validatore nel browser, per pipeline CI, agenti e integrazioni.

No. L’uso anonimo è gratuito e non richiede un account. Le richieste anonime sono limitate a 10 al minuto e 300 al giorno per client, indicate negli header di risposta RateLimit.

Per limiti più alti, un amministratore dell’organizzazione crea una chiave API nelle impostazioni dell’organizzazione. Inviala nell’header Authorization: Bearer per alzare i limiti a 120 richieste al minuto e 10.000 al giorno. Una chiave consente solo la validazione e non dà accesso a spazi di lavoro o prove; una chiave sconosciuta o revocata restituisce 401 invece di ripiegare sull’accesso anonimo.

OSCAL 1.2.2 JSON in tutti gli otto modelli, riconosciuti dalla chiave radice, con un documento per richiesta. Il corpo della richiesta può arrivare a 4 MB grezzi o 24 MB decompressi se inviato con gzip. XML e YAML non sono accettati.

No. Ogni documento viene validato in memoria su server UE a Francoforte ed eliminato insieme alla risposta. Secani non conserva, registra né riutilizza il contenuto; la telemetria è solo aggregata.

La documentazione dell’API descrive richieste, risposte, limiti, chiavi API e tutti i codici di errore. È disponibile anche un contratto OpenAPI 3.1 per generare client. Leggi la documentazione dell’API

Preferisci validare manualmente?

Il validatore nel browser esegue gli stessi controlli interamente in locale; il documento non lascia mai il browser.