Passer au contenu principal
Enregistrez l’empreinte SHA-256 d’un fichier et vérifiez-la plus tard avec Truthlocks. Les fichiers sont haché localement : la CLI envoie l’empreinte digitale et les métadonnées de l’enregistrement, pas le contenu du fichier. Exécution : Node.js 18+ · Paquet : @truthlocks/protect · Commande : truthlock-protect Console · Application consommateur · Documentation API

Installer

La commande truthlocks est également installée comme alias. Ce paquet enregistre en ligne empreintes digitales ; utilisez @truthlocks/cli pour la vérification hors ligne des paquets de preuves.

Choisir votre type de compte

Une clé API n’est pas un jeton consommateur. La CLI utilise des points de terminaison différents pour ces deux workflows. Les clés API de test sélectionnent l’hôte sandbox. Définissez TRUTHLOCK_API_URL uniquement lorsque vous avez intentionnellement besoin d’une origine API différente.

Démarrage rapide de l’espace de travail

Définissez TRUTHLOCKS_API_KEY, TRUTHLOCKS_ISSUER_ID et TRUTHLOCKS_KEY_ID dans votre environnement, puis protéger un fichier existant :
Remplacez la clé de nouvelle tentative d’exemple par une valeur unique pour cette opération. Conservez-la avec les détails de la requête et ne la réutiliser que pour la requête identique. La sortie contient attestation_id et payload_b64url ; conservez les deux. L’option --output enregistre un reçu sans écraser un fichier existant. Cette opération écrit un enregistrement. Vous pouvez sélectionner explicitement l’émetteur et la clé à la place :
Remplacez les espaces réservés en majuscules. L’algorithme doit correspondre à la clé sélectionnée. Si exactement un émetteur actif et une clé de signature éligible sont disponibles, la CLI peut les sélectionner automatiquement ; sinon, il vous demande de choisir à l’aide de drapeaux. Les enregistrements de l’espace de travail utilisent des revendications structurées avec une empreinte document.sha256 et un hachage de document explicite. Ils suivent les règles d’accès à l’espace de travail/API ; la visibilité du consommateur les drapeaux ne s’appliquent pas à ce flux de travail.

Démarrage rapide du consommateur

Définissez TRUTHLOCK_TOKEN sur un jeton de porteur consommateur autorisé, avec une clé API d’espace de travail variables d’environnement non définies, puis exécutez :
Les enregistrements des consommateurs sont privés par défaut. Utilisez --public uniquement si vous souhaitez un public enregistrement du consommateur. Le service sélectionne la clé de signature du consommateur ; --algorithm, --issuer-id et --key-id sont des options d’espace de travail et sont rejetées en mode consommateur.

Vérifier un enregistrement et un fichier

Utilisez le reçu enregistré et le fichier original. Le reçu fournit les octets exacts qui ont été signés ; le fichier fournit l’empreinte digitale à comparer :
Pour un enregistrement de consommateur actuel, vous pouvez reconstruire son personal-record-v2 défini charge utile du fichier original :
Cette reconstruction est automatique lors de l’utilisation d’un jeton consommateur uniquement avec --file. Il ne reconstruit pas les revendications d’espace de travail arbitraires ou les formats de charge utile historiques. Pour un enregistrement d’espace de travail sans reçu enregistré, fournissez la charge utile signée originale octets en utilisant --payload-file ./signed-payload.json. Ne reformatez pas ce JSON. Le code de sortie 0 nécessite à la fois verdict: VALID et signature_verified: true. Les fichiers altérés et les preuves incomplètes sortent avec un code non nul. Une recherche par ID seul ne peut pas vérifier une signature ; il rapporte INCOMPLETE à moins qu’un statut plus fort tel que la révocation ne s’applique :
Un enregistrement d’empreinte valide est la preuve que les octets correspondent au hachage enregistré. Il ne ne prouve pas indépendamment la paternité, la propriété du droit d’auteur ou la véracité de son titre.

Commandes

L’enregistrement du développeur est une opération de création de compte distincte. Il ne crée pas une session consommateur ou garantir qu’une clé d’émetteur/de signature est déjà provisionnée.

Options et stockage local

protect accepte --title, --description, --category, --content-type, --json, --api-key, --issuer-id, --key-id, --algorithm, --idempotency-key et --output. --public et --private s’appliquent uniquement aux consommateurs. La catégorie de fichier est détectée automatiquement, sauf si elle est fournie. Les répertoires ne sont pas pris en charge. La variable historique TRUTHLOCK_API_KEY est toujours acceptée. Indicateurs explicites de clé API et les variables d’environnement ont la priorité sur une clé de développeur enregistrée. Une la variable d’environnement consumer-token prend la priorité sur une clé de développeur enregistrée lorsque aucune variable d’environnement de clé API n’est fournie. Un jeton consommateur enregistré se trouve dans ~/.truthlock/config.json ; les identifiants de développeur se trouvent dans ~/.truthlocks/credentials.json. Ce sont des fichiers d’informations d’identification locaux. Gardez-les hors de des dépôts et des sauvegardes destinés à la publication.

Dépannage

Les requêtes utilisent un délai d’attente de 30 secondes et sont envoyées une seule fois. Les redirections sont rejetées. Limite de débit les valeurs restantes ne sont pas présentées comme un quota mensuel.

Mise à niveau depuis la version 1.0

La version 1.1.1 ajoute des charges utiles signées conservées et une vérification cryptographique avec les fichiers originaux. La version 1.1 corrige les en-têtes de clé API, le consommateur content_hash, la signature de l’espace de travail, privé valeurs par défaut du consommateur, sortie JSON, alias de commande et vérification réelle. Exemples précédents qui affirmait qu’une recherche de protection était une vérification cryptographique devrait être remplacée. Licence MIT.