@truthlocks/protect · Comando: truthlock-protect
Console · Aplicativo do consumidor · Documentação da API
Instalar
truthlocks também é instalado como um alias. Este pacote registra online
impressões digitais; use @truthlocks/cli para verificação offline de pacotes de prova.
Escolha o tipo da sua conta
Uma chave de API não é um token de consumidor. A CLI usa endpoints diferentes para esses dois
fluxos de trabalho. As chaves de API de teste selecionam o host sandbox. Defina
TRUTHLOCK_API_URL apenas quando
você intencionalmente precisa de uma origem de API diferente.
Início rápido do espaço de trabalho
DefinaTRUTHLOCKS_API_KEY, TRUTHLOCKS_ISSUER_ID e TRUTHLOCKS_KEY_ID em seu ambiente,
então proteja um arquivo existente:
attestation_id e payload_b64url; mantenha ambos. A opção --output salva um recibo sem sobrescrever um arquivo existente. Esta operação escreve um registro.
Você pode selecionar o emissor e a chave explicitamente, em vez disso:
document.sha256 e um
hash de documento explícito. Eles seguem as regras de acesso ao espaço de trabalho/API; a visibilidade do consumidor
flags não se aplicam a este fluxo de trabalho.
Início rápido do consumidor
DefinaTRUTHLOCK_TOKEN para um token de portador de consumidor autorizado, com chave de API do espaço de trabalho
variáveis de ambiente não definidas, então execute:
--public apenas quando quiser um público
registro do consumidor. O serviço seleciona a chave de assinatura do consumidor; --algorithm,
--issuer-id e --key-id são opções de espaço de trabalho e são rejeitadas no modo consumidor.
Verificar um registro e arquivo
Use o recibo salvo e o arquivo original. O recibo fornece os bytes exatos que foram assinados; o arquivo fornece a impressão digital para comparar:--file.
Não reconstrói reivindicações arbitrárias de espaço de trabalho ou formatos de carga histórica.
Para um registo de espaço de trabalho sem um recibo guardado, forneça o payload assinado original
bytes usando --payload-file ./signed-payload.json. Não reformate esse JSON.
O código de saída 0 requer ambos verdict: VALID e signature_verified: true.
Arquivos alterados e provas incompletas saem com valor diferente de zero. Uma pesquisa somente por ID não pode verificar
uma assinatura; ele reporta INCOMPLETE a menos que um status mais forte, como revogação, se aplique:
Comandos
O registro de desenvolvedor é uma operação separada de criação de conta. Não cria
uma sessão de consumidor ou garantir que uma chave de emissor/assinatura já esteja provisionada.
Opções e armazenamento local
protect aceita --title, --description, --category, --content-type, --json,
--api-key, --issuer-id, --key-id, --algorithm, --idempotency-key e --output.
--public e --private aplicam-se apenas a consumidores. A categoria do arquivo é detectada automaticamente, a menos que seja fornecida. Diretórios não são suportados.
A variável histórica TRUTHLOCK_API_KEY ainda é aceita. Sinalizadores explícitos de chave de API
e variáveis de ambiente têm prioridade sobre uma chave de desenvolvedor salva. Uma chave explícita
variável de ambiente consumer-token tem prioridade sobre uma chave de desenvolvedor salva quando
nenhuma variável de ambiente de chave de API é fornecida.
Um token de consumidor salvo reside em ~/.truthlock/config.json; credenciais de desenvolvedor residem
em ~/.truthlocks/credentials.json. Estes são arquivos de credenciais locais. Mantenha-os fora
de repositórios e backups destinados à publicação.
Solução de problemas
As solicitações usam um tempo limite de 30 segundos e são enviadas uma vez. Redirecionamentos são rejeitados. Limite de taxa
valores restantes não são apresentados como uma cota mensal.
Atualizando da versão 1.0
A versão 1.1.1 adiciona payloads assinados retidos e verificação criptográfica com arquivos originais. A versão 1.1 corrige cabeçalhos de chave de API, consumidorcontent_hash, assinatura de espaço de trabalho, privado
padrões do consumidor, saída JSON, aliases de comando e verificação real. Exemplos anteriores
que alegava que uma pesquisa de proteção era verificação criptográfica deve ser substituída.
Licença MIT.
