Zum Hauptinhalt springen
Zeichnen Sie den SHA-256-Fingerabdruck einer Datei auf und verifizieren Sie ihn später mit Truthlocks. Dateien sind lokal gehasht: die CLI sendet den Fingerabdruck und die Datensatzmetadaten, nicht den Dateiinhalt. Laufzeit: Node.js 18+ · Paket: @truthlocks/protect · Befehl: truthlock-protect Console · Verbraucher-App · API-Dokumentation

Installation

Der Befehl truthlocks ist auch als Alias installiert. Dieses Paket zeichnet online auf Fingerabdrücke; verwenden Sie @truthlocks/cli für die Offline-Verifizierung von Proof-Bundles.

Kontotyp auswählen

Ein API-Schlüssel ist kein Verbraucher-Token. Die CLI verwendet unterschiedliche Endpunkte für diese beiden Workflows. Test-API-Schlüssel wählen den Sandbox-Host aus. Setzen Sie TRUTHLOCK_API_URL nur, wenn Sie absichtlich einen anderen API-Ursprung benötigen.

Arbeitsbereichs-Schnellstart

Setzen Sie TRUTHLOCKS_API_KEY, TRUTHLOCKS_ISSUER_ID und TRUTHLOCKS_KEY_ID in Ihrer Umgebung, dann eine bestehende Datei schützen:
Ersetzen Sie den Beispiel-Wiederholungsschlüssel durch einen eindeutigen Wert für diesen Vorgang. Behalten Sie ihn bei mit die Anfragedetails und verwenden Sie sie nur für die identische Anfrage. Die Ausgabe enthält attestation_id und payload_b64url; beide behalten. Die Option --output speichert eine Quittung, ohne eine vorhandene Datei zu überschreiben. Dieser Vorgang schreibt einen Datensatz. Sie können stattdessen den Aussteller und den Schlüssel explizit auswählen:
Ersetzen Sie die Großbuchstaben-Platzhalter. Der Algorithmus muss dem ausgewählten Schlüssel entsprechen. Wenn genau ein aktiver Aussteller und ein berechtigter Signierschlüssel verfügbar sind, kann die CLI wählen Sie diese automatisch aus; andernfalls werden Sie aufgefordert, diese mithilfe von Flags auszuwählen. Arbeitsbereichsdatensätze verwenden strukturierte Claims mit einem document.sha256 Fingerabdruck und einem expliziter Dokument-Hash. Sie folgen den Arbeitsbereichs-/API-Zugriffsregeln; die Sichtbarkeit des Verbrauchers Flags gelten nicht für diesen Workflow.

Consumer-Schnellstart

Setzen Sie TRUTHLOCK_TOKEN auf einen autorisierten Consumer-Bearer-Token mit Workspace-API-Schlüssel Umgebungsvariablen nicht gesetzt, dann ausführen:
Verbraucherdatensätze sind standardmäßig privat. Verwenden Sie --public nur, wenn Sie eine öffentliche Verbraucherdatensatz. Der Dienst wählt den Signierschlüssel des Verbrauchers aus; --algorithm, --issuer-id und --key-id sind Arbeitsbereichsoptionen und werden im Verbrauchermodus abgelehnt.

Einen Datensatz und eine Datei verifizieren

Verwenden Sie den gespeicherten Beleg und die Originaldatei. Der Beleg liefert die exakten Bytes die signiert wurden; die Datei liefert den zu vergleichenden Fingerabdruck:
Für einen aktuellen Verbraucherdatensatz können Sie dessen definierten personal-record-v2 rekonstruieren Payload aus der Originaldatei:
Diese Rekonstruktion erfolgt automatisch, wenn nur ein Consumer-Token mit --file verwendet wird. Es rekonstruiert keine beliebigen Workspace-Ansprüche oder historischen Payload-Formate. Für einen Workspace-Datensatz ohne gespeicherten Beleg, liefern Sie die ursprüngliche signierte Nutzlast Bytes mit --payload-file ./signed-payload.json. Formatieren Sie dieses JSON nicht neu. Exit-Code 0 erfordert sowohl verdict: VALID als auch signature_verified: true. Geänderte Dateien und unvollständige Nachweise beenden sich ungleich Null. Eine ID-basierte Suche kann nicht verifizieren eine Signatur; es meldet INCOMPLETE, es sei denn, ein stärkerer Status wie der Widerruf trifft zu:
Ein gültiger Fingerabdruckdatensatz ist ein Beweis dafür, dass Bytes mit dem aufgezeichneten Hash übereinstimmen. Er tut es beweist nicht unabhängig die Urheberschaft, das Urheberrecht oder die Wahrheit seines Titels.

Befehle

Die Entwicklerregistrierung ist ein separater Vorgang zur Kontoerstellung. Sie erstellt keine eine Verbrauchersitzung oder garantieren, dass ein Aussteller/Signierschlüssel bereits bereitgestellt ist.

Optionen und lokaler Speicher

protect akzeptiert --title, --description, --category, --content-type, --json, --api-key, --issuer-id, --key-id, --algorithm, --idempotency-key und --output. --public und --private gelten nur für Verbraucher. Die Dateikategorie wird automatisch erkannt, sofern nicht angegeben. Verzeichnisse werden nicht unterstützt. Die historische Variable TRUTHLOCK_API_KEY wird weiterhin akzeptiert. Explizite API-Schlüssel-Flags und Umgebungsvariablen haben Vorrang vor einem gespeicherten Entwicklerschlüssel. Ein expliziter Die Umgebungsvariable consumer-token hat Vorrang vor einem gespeicherten Entwicklerschlüssel, wenn keine API-Schlüssel-Umgebungsvariable angegeben wird. Ein gespeichertes Verbraucher-Token befindet sich in ~/.truthlock/config.json; Entwickler-Anmeldeinformationen befinden sich in ~/.truthlocks/credentials.json. Dies sind lokale Anmeldeinformationsdateien. Halten Sie sie fern von Repositories und Backups, die zur Veröffentlichung bestimmt sind.

Fehlerbehebung

Anfragen verwenden ein 30-Sekunden-Timeout und werden einmal gesendet. Weiterleitungen werden abgelehnt. Ratenbegrenzung verbleibende Werte werden nicht als monatliches Kontingent dargestellt.

Upgrade von 1.0

Version 1.1.1 fügt beibehaltene signierte Nutzlasten und kryptografische Verifizierung mit Originaldateien hinzu. Version 1.1 behebt API-Schlüssel-Header, Consumer content_hash, Arbeitsbereichssignierung, privat Verbraucher-Standardeinstellungen, JSON-Ausgabe, Befehlsaliase und echte Verifizierung. Vorherige Beispiele dass eine Schutzprüfung eine kryptografische Verifizierung war, sollte ersetzt werden. MIT-Lizenz.