Ferramenta de Linha de Comando de Nitropia#

Este tutorial demonstra como acessar o NetHMS via nitropia ferramenta de linha de comando, que você precisa baixar e instalar.

Nota

Se você usar uma instância demo do NetHSM com um certificado autoassinado, por exemplo usando a imagem Docker, você terá que usar a opção --no-verify-tls opção para nitropy para pular a verificação do certificado.

Nota

Primeiro defina o valor de $NETHSM_HOST para o endereço IP ou URL do seu NetHSM. O nosso servidor de demonstração pode ser contactado em https://nethsmdemo.nitrokey.com/

Informação e carimbo do dispositivo; Estado#

$ nitropy nethsm --host $NETHSM_HOST info

Host:    localhost:8443
Vendor:  Nitrokey GmbH
Product: NetHSM
$ nitropy nethsm --host $NETHSM_HOST state

NetHSM localhost:8443 is Unprovisioned

Provisionamento#

Um novo NetHSM precisa de ser provisionado primeiro com frases-passe e a hora actual. A senha do Administrador é a senha do Administrador, que é o superutilizador do NetHSM. A Senha Unlock Passphrase é utilizada para encriptar o armazenamento de dados confidenciais do NetHSM.

Nota

A instância de demonstração do NetHSM em nethsmdemo.nitrokey.com já está provisionada.

$ nitropy nethsm --host $NETHSM_HOST provision

NetHSM localhost:8443 provisioned

NetHSM pode ser usado no modo Attended Boot e Unattended Boot mode.

  • No modo de Botão Assistido, a Senha de Bloqueio precisa de ser introduzida durante cada início, que é utilizada para encriptar o armazenamento de dados. Por razões de segurança, este modo é recomendado.

  • No modo de inicialização desacompanhada* não é necessária uma senha de desbloqueio, portanto o NetHSM pode iniciar sem supervisão e o armazenamento de dados é armazenado sem criptografia. Use este modo se os seus requisitos de disponibilidade não puderem ser cumpridos com o modo Attended Boot.

Recuperar o modo actual:

$ nitropy nethsm --host $NETHSM_HOST get-config --unattended-boot

 Configuration for NetHSM localhost:8443:
 Unattended boot: off

Ligar o modo «Bota desacompanhada»:

$ nitropy nethsm --host $NETHSM_HOST set-unattended-boot on

 Updated the unattended boot configuration for NetHSM localhost:8443

Gestão de usuários#

Papéis#

A separação das funções pode ser implementada através da utilização de diferentes funções. Cada conta de utilizador configurada no NetHSM tem um dos seguintes Papéis atribuídos. Segue-se uma descrição de alto nível das operações permitidas por cada Função. Para detalhes específicos do ponto final, consultar a documentação REST API.

  • R-Administrador: Uma conta de utilizador com esta função tem acesso a todas as operações fornecidas pela API REST, excepto para operações de utilização de chaves, ou seja, assinatura e desencriptação de mensagens.

  • R-Operador: Uma conta de usuário com esta função tem acesso a todas as operações-chave de uso, um subconjunto de operações de gerenciamento de chaves somente leitura e operações de gerenciamento de usuários permitindo alterações somente em sua própria conta.

  • R-Metrics: Uma conta de utilizador com esta função tem acesso apenas a operações de métrica só de leitura.

  • R-Backup: Uma conta de usuário com esta função tem acesso apenas às operações necessárias para iniciar um backup do sistema.

Nota: Em futuros lançamentos, poderão ser introduzidas funções adicionais.

Criação & Eliminação de utilizadores*

Agora criar um novo utilizador com a função de Operador que pode ser utilizado para assinar e desencriptar dados. Note que o NetHSM atribui um ID de utilizador aleatório, se não o especificarmos.

$ nitropy nethsm --host $NETHSM_HOST  add-user --real-name "Jane User" --role Operator

User Operator added to NetHSM localhost:8443
$ nitropy nethsm --host $NETHSM_HOST delete-user "Jane User"

Gestão de chaves#

Gerar Chaves#

Nesta secção, queremos usar uma chave RSA para decifrar dados usando PKCS#1 e para assinar dados com PSS usando SHA256. Assim, vamos gerar uma nova chave no NetHSM. Certifique-se de usar o algoritmo RSA e de seleccionar os mecanismos de chave RSA_Signature_PSS_SHA256 e RSA_Decryption_PKCS1. Se não especificar um ID de chave, o NetHSM irá gerar um ID aleatório para a nova chave.

$ nitropy nethsm --host $NETHSM_HOST  generate-key --type RSA --mechanism RSA_Signature_PSS_SHA256 --mechanism RSA_Decryption_PKCS1 --length 2048 --key-id myFirstKey

Key myFirstKey generated on NetHSM localhost:8443

Chaves de Importação#

Em vez de gerar uma chave no NetHSM, você também pode importar chaves privadas existentes para o NetHSM:

$ nitropy nethsm --host $NETHSM_HOST  add-key --type RSA --mechanism RSA_Signature_PSS_SHA256 --mechanism RSA_Decryption_PKCS1 --key-id mySecondKey --public-exponent AQAB --prime-p "AOnWFZ+JrI/xOXJU04uYCZOiPVUWd6CSbVseEYrYQYxc7dVroePshz29tc+VEOUP5T0O8lXMEkjFAwjW6C9QTAsPyl6jwyOQluMRIkdN4/7BAg3HAMuGd7VmkGyYrnZWW54sLWp1JD6XJG33kF+9OSar9ETPoVyBgK5punfiUFEL" \
    --prime-q "ANT1kWDdP9hZoFKT49dwdM/S+3ZDnxQa7kZk9p+JKU5RaU9e8pS2GOJljHwkES1FH6CUGeIaUi81tRKe2XZhe/163sEyMcxkaaRbBbTc1v6ZDKILFKKt4eX7LAQfhL/iFlgi6pcyUM8QDrm1QeFgGz11ChM0JuQw1WwkX06lg8iv"

Key mySecondKey added to NetHSM localhost:8443

Chaves de Lista#

Para ter certeza de que a chave foi criada e tem as configurações corretas de algoritmo e mecanismo, podemos consultar todas as chaves no NetHSM:

$ nitropy nethsm --host $NETHSM_HOST list-keys
Keys on NetHSM localhost:8443:

Key ID          Algorithm       Mechanisms                                      Operations
----------      ---------       ----------------------------------------------  ----------
myFirstKey      RSA             RSA_Decryption_PKCS1, RSA_Signature_PSS_SHA256  0
mySecondKey     RSA             RSA_Decryption_PKCS1, RSA_Signature_PSS_SHA256  0

Mostrar detalhes chave#

Também podemos consultar a chave pública do par de chaves gerado:

$ nitropy nethsm --host $NETHSM_HOST get-key myFirstKey

Para poder utilizar a chave com OpenSSL, exportamo-la como ficheiro PEM e armazenamo-la como public.pem:

$ nitropy nethsm --host $NETHSM_HOST get-key myFirstKey --public-key > public.pem

Podemos inspeccionar a chave com OpenSSL e utilizá-la para encriptação ou verificação de assinatura (como descrito na secção seguinte):

$ openssl rsa -in public.pem -pubin -text

RSA Public-Key: (2048 bit)
Modulus:
          00:c3:56:f5:09:cc:a9:3e:ca:16:2e:fb:d2:8b:9d:
          a9:33:5a:87:8f:3f:7a:bb:8a:3d:62:9b:5d:56:84:
          95:97:bb:97:f0:77:e2:c8:59:f2:b5:c6:b7:f5:b3:
          76:69:a3:e8:f6:b7:35:f4:3c:52:6d:3c:a0:b6:a1:
          e4:1a:32:05:1d:51:68:21:7d:fc:53:69:ec:bc:0b:
          a0:db:63:b2:0e:47:00:03:4d:98:1f:ab:c0:7b:2e:
          3c:8f:b6:36:ff:f0:db:80:26:f0:a6:af:30:2f:7b:
          16:fd:5c:db:0f:2c:54:8a:26:2b:db:3d:78:49:4b:
          7b:d1:60:ea:a7:f0:b4:5e:fc:33:ff:57:f8:83:fd:
          12:64:8f:29:d1:94:96:9a:15:18:5d:04:ca:1c:29:
          44:ad:42:31:c5:80:38:4c:eb:3b:b8:7e:17:27:5c:
          69:a8:88:44:ea:d1:82:64:fe:51:31:47:97:a7:a9:
          87:c3:13:c9:00:7a:b9:fb:6f:cc:66:4c:07:d7:68:
          fa:78:68:9a:e7:87:1e:94:c6:27:92:5f:f2:7d:11:
          44:11:b5:39:35:59:2c:cd:f9:4f:59:e3:56:93:1f:
          94:20:fd:6b:23:0d:15:e6:4e:bb:84:a8:a5:0d:9f:
          1c:90:ab:a8:10:04:50:12:c1:80:02:94:85:78:df:
          d6:b3
Exponent: 65537 (0x10001)
writing RSA key
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw1b1CcypPsoWLvvSi52p
M1qHjz96u4o9YptdVoSVl7uX8HfiyFnytca39bN2aaPo9rc19DxSbTygtqHkGjIF
HVFoIX38U2nsvAug22OyDkcAA02YH6vAey48j7Y2//DbgCbwpq8wL3sW/VzbDyxU
iiYr2z14SUt70WDqp/C0Xvwz/1f4g/0SZI8p0ZSWmhUYXQTKHClErUIxxYA4TOs7
uH4XJ1xpqIhE6tGCZP5RMUeXp6mHwxPJAHq5+2/MZkwH12j6eGia54celMYnkl/y
fRFEEbU5NVkszflPWeNWkx+UIP1rIw0V5k67hKilDZ8ckKuoEARQEsGAApSFeN/W
swIDAQAB
-----END PUBLIC KEY-----

Principais Certificados#

É possível definir e consultar certificados para as chaves armazenadas em uma instância do NetHSM:

$ nitropy nethsm --host $NETHSM_HOST  set-certificate myFirstKey --mime-type application/x-pem-file /tmp/cert.pem

Updated the certificate for key myFirstKey on NetHSM localhost:8443
$ nitropy nethsm --host $NETHSM_HOST get-certificate myFirstKey > /tmp/cert.pem

Pedidos de Assinatura de Certificados Chave#

O NetHSM suporta a geração de Solicitações de Assinatura de Certificado (CSR) para as chaves armazenadas:

$ nitropy nethsm --host $NETHSM_HOST csr --key-id myFirstKey --country DE --state-or-province BE --locality Berlin --organization ACME --organizational-unit IT --common-name example.com --email-address it@example.com

Operações Chave#

Podemos encriptar dados para a chave armazenada no NetHSM utilizando o OpenSSL. (public.pem é o ficheiro de chave pública que criámos na secção Mostrar Detalhes da Chave).

$ echo 'NetHSM rulez!' | OpenSSL rsautl -encrypt -inkey public.pem -pubin | base64 > data.crypt
$ nitropy nethsm -h $NETHSM_HOST decrypt -k myFirstKey -d "$(cat data.crypt)" -m PKCS1 | base64 -d

NetHSM rulez!

Da mesma forma, podemos assinar os dados utilizando a chave no NetHSM. Para a RSA e ECDSA, temos de calcular primeiro uma digestão:

$ echo 'NetHSM rulez!' > data
$ openssl dgst -sha256 -binary data | base64 > data.digest

Depois podemos criar uma assinatura a partir deste resumo usando o NetHSM:

$ nitropy nethsm -h $NETHSM_HOST sign -k myFirstKey -m PSS_SHA256 -d "$(cat data.digest)" | base64 -d > data.sig

E depois utilizar o OpenSSL para verificar a assinatura:

$ openssl dgst -sha256 -verify public.pem -signature data.sig -sigopt rsa_padding_mode:pss -sigopt rsa_pss_saltlen:-1 data

Verified OK

Criação de Backups#

É possível criar uma cópia de segurança do NetHSM que captura tanto a configuração como as chaves armazenadas. Para criar uma cópia de segurança, é necessário primeiro definir uma frase-chave de cópia de segurança que é utilizada para encriptar o ficheiro de cópia de segurança:

$ nitropy nethsm -h $NETHSM_HOST -u admin set-backup-passphrase

Updated the backup passphrase for NetHSM localhost:8443

Agora tem de criar um utilizador com a função de R-Backup:

$ nitropy nethsm -h $NETHSM_HOST -u admin add-user --user-id backup --real-name "Backup User" --role backup

User backup added to NetHSM localhost:8443

Então você pode gerar o backup e escrevê-lo em um arquivo:

$ nitropy nethsm -h $NETHSM_HOST backup /tmp/nethsm-backup

Backup for localhost:8443 written to /tmp/backup

Restauração de Backups#

Este arquivo de backup pode ser restaurado em uma instância não-provisionada do NetHSM:

$ nitropy nethsm -h $NETHSM_HOST restore --backup-passphrase backup-passphrase backupencryptionkey /tmp/nethsm-backup

Backup restored on NetHSM localhost:8443

Actualização do NetHSM#

Aviso

A perda de dados pode ocorrer devido à instalação de uma actualização beta!

$ nitropy nethsm --host $NETHSM_HOST  update /tmp/nethsm-update.img.cpio

Image /tmp/nethsm-update.img.cpio uploaded to NetHSM localhost:8443

Se você quiser continuar com a instalação, você pode agora comprometer a atualização:

$ nitropy nethsm --host $NETHSM_HOST     commit-update

Update successfully committed on NetHSM localhost:8443

Alternativamente, você pode cancelar a atualização:

$ nitropy nethsm --host $NETHSM_HOST  cancel-update

Update successfully cancelled on NetHSM localhost:8443