@truthlocks/protect · Comando: truthlock-protect
Console · Aplicación para consumidores · Documentación de la API
Instalar
truthlocks también se instala como un alias. Este paquete registra en línea
huellas dactilares; use @truthlocks/cli para la verificación de paquetes de prueba fuera de línea.
Elegir su tipo de cuenta
Una clave API no es un token de consumidor. La CLI utiliza diferentes puntos finales para estos dos
flujos de trabajo. Las claves API de prueba seleccionan el host de sandbox. Establezca
TRUTHLOCK_API_URL solo cuando
necesite intencionalmente un origen de API diferente.
Inicio rápido del espacio de trabajo
EstablezcaTRUTHLOCKS_API_KEY, TRUTHLOCKS_ISSUER_ID y TRUTHLOCKS_KEY_ID en su entorno,
luego proteger un archivo existente:
attestation_id y payload_b64url; conserve ambos. La opción --output guarda un recibo sin sobrescribir un archivo existente. Esta operación escribe un registro.
Puede seleccionar el emisor y la clave explícitamente en su lugar:
document.sha256 y un
hash de documento explícito. Siguen las reglas de acceso al espacio de trabajo/API; la visibilidad del consumidor
las banderas no se aplican a este flujo de trabajo.
Inicio rápido para el consumidor
EstablezcaTRUTHLOCK_TOKEN en un token de portador de consumidor autorizado, con clave API del espacio de trabajo
variables de entorno sin establecer, luego ejecute:
--public solo cuando desee un público
registro del consumidor. El servicio selecciona la clave de firma del consumidor; --algorithm,
--issuer-id y --key-id son opciones del espacio de trabajo y se rechazan en modo consumidor.
Verificar un registro y un archivo
Utilice el recibo guardado y el archivo original. El recibo proporciona los bytes exactos que fueron firmados; el archivo proporciona la huella digital para comparar:--file.
No reconstruye reclamaciones de espacio de trabajo arbitrarias ni formatos de carga útil históricos.
Para un registro de espacio de trabajo sin un recibo guardado, proporcione la carga útil firmada original
bytes usando --payload-file ./signed-payload.json. No reformatee ese JSON.
El código de salida 0 requiere tanto verdict: VALID como signature_verified: true.
Los archivos alterados y las pruebas incompletas salen con un valor distinto de cero. Una búsqueda solo por ID no puede verificar
una firma; informa INCOMPLETE a menos que se aplique un estado más fuerte como la revocación:
Comandos
El registro de desarrollador es una operación de creación de cuenta separada. No crea
una sesión de consumidor o garantizar que una clave de emisor/firma ya esté provisionada.
Opciones y almacenamiento local
protect acepta --title, --description, --category, --content-type, --json,
--api-key, --issuer-id, --key-id, --algorithm, --idempotency-key y --output.
--public y --private se aplican solo a los consumidores. La categoría de archivo se detecta automáticamente a menos que se proporcione. Los directorios no son compatibles.
La variable histórica TRUTHLOCK_API_KEY todavía se acepta. Banderas explícitas de clave API
y las variables de entorno tienen prioridad sobre una clave de desarrollador guardada. Una clave explícita
la variable de entorno del token de consumidor tiene prioridad sobre una clave de desarrollador guardada cuando
no se proporciona ninguna variable de entorno de clave API.
Un token de consumidor guardado reside en ~/.truthlock/config.json; las credenciales de desarrollador residen
en ~/.truthlocks/credentials.json. Estos son archivos de credenciales locales. Manténgalos fuera
de repositorios y copias de seguridad destinadas a la publicación.
Solución de problemas
Las solicitudes utilizan un tiempo de espera de 30 segundos y se envían una vez. Las redirecciones son rechazadas. Límite de velocidad
los valores restantes no se presentan como una cuota mensual.
Actualización desde la versión 1.0
La versión 1.1.1 añade cargas útiles firmadas retenidas y verificación criptográfica con archivos originales. La versión 1.1 corrige los encabezados de la clave API, el consumidorcontent_hash, la firma del espacio de trabajo, privado
valores predeterminados del consumidor, salida JSON, alias de comandos y verificación real. Ejemplos anteriores
que afirmaba que una búsqueda de protección era verificación criptográfica debería ser reemplazada.
Licencia MIT.
