INTEGRITY Dokumentace

← Key Transparency Auditor / key-transparency / api

Jmenné prostory

Cloudflare Key Transparency API je uspořádáno do namespaces, z nichž každý reprezentuje Log sledovaný Cloudflare Auditorem. Pokud chcete zaregistrovat namespace, kontaktujte nás.

Vytvoření jmenného prostoru

Následující pole jsou povinná při vytváření POST požadavek:

log_directory pole je volitelné. Pokud je nastavené, Cloudflare ho použije k načtení auditních důkazů a jejich ověření.

Toto API je autentizováno pomocí mTLS ↗.

curl 'https://plexi.key-transparency.cloudflare.com/namespaces' \
        	--header 'Content-Type: application/json' \
        	--data '{
 	"name": "your.new.log.com",
 	"root": "1/1111111111111111111111111111111111111111111111111111111111111111",
 	"log_directory": "https://your.new.log.com/path/to/proofs",
	"signature_version": 1
  }'
{
  "name": "your.new.log.com",
  "log_directory": "https://your.new.log.com/path/to/proofs",
  "root": "1/1111111111111111111111111111111111111111111111111111111111111111",
  "status": "Initialization",
  "reports_uri": "/namespaces/your.new.log.com/reports",
  "audits_uri": "/namespaces/your.new.log.com/audits",
  "signature_version": 1
}

Po publikování první epochy status zobrazí Online. Mezi možné stavy patří:

Seznam všech namespaces

Informace o všech veřejných namespaces získáte podle příkladu níže.

curl 'https://plexi.key-transparency.cloudflare.com/namespaces'
{
   "namespaces": [
       { "name": "your.new.log.com", "root": "1/abc", "reports_uri": "/namespaces/your.new.log.com/reports", "audits_uri": "/namespaces/your.new.log.com/audits", "log_directory": "https://your.new.log.com/path/to/proofs", "status": "online" },
       { "name": "my.new.log.com", "reports_uri": "/namespaces/meta-bt-2024/reports", "audits_uri": "/namespaces/meta-bt-2024/audits", "status": "initialization" }
   ]
}

Zakázání namespace

Pokud je stav logu poškozený, ztracený nebo je potřeba ho kvůli udržovatelnosti rozdělit na části, Auditor umožňuje provozovateli Logu označit namespace jako Disabled.

Toto API je autentizováno pomocí mTLS ↗.

curl -X PATCH 'https://plexi.key-transparency.cloudflare.com/namespaces/{namespace}' \
        	-H 'Content-Type: application/json' \
        	-d '{
 	"status": "Disabled"
  }'
{
  "name": "your.new.log.com",
  "log_directory": "https://your.new.log.com/path/to/proofs",
  "root": "1/1111111111111111111111111111111111111111111111111111111111111111",
  "status": "Disabled",
  "reports_uri": "/namespaces/your.new.log.com/reports",
  "audits_uri": "/namespaces/your.new.log.com/audits",
  "signature_version": 1
}