Administração#
Este capítulo descreve tarefas administrativas para utilizadores com o papel de Administrador. Consulte o capítulo Roles para saber mais sobre o papel.
Importante
Certifique-se por favor de ler a informação no início de ` este documento <index.html>`__ antes de começar a trabalhar.
Gestão do sistema#
Informação do dispositivo#
A informação do fornecedor e do produto para um NetHSM pode ser recuperada da seguinte forma.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST info
Host: localhost:8443
Vendor: Nitrokey GmbH
Product: NetHSM
Informações sobre o parâmetro /info podem ser encontradas na documentação da API.
Modo Boot#
NetHSM pode ser usado no modo Attended Boot e Unattended Boot mode.
Modo Boot |
Descrição |
---|---|
Attended Boot |
The NetHSM boots up into a _Locked_ state. The Unlock Passphrase needs to be entered during each start, which is used to decrypt the User Data. For security reasons, this mode is recommended and it’s the default mode for a freshly provisioned system. |
Unattended Boot |
The system starts unattended without the need to enter the Unlock Passphrase into an _Operational_ state. Use this mode if your availability requirements can not be fulfilled with Attended Boot mode. |
Aviso
Regardless of the boot mode, the Unlock Passphrase retains its validity and is required for restoring backups on other hardware. Keep the Unlock Passphrase safe at any time.
O modo de arranque actual pode ser recuperado da seguinte forma.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST get-config --unattended-boot
Configuration for NetHSM localhost:8443:
Unattended boot: off
Informações sobre o parâmetro /config/unattended-boot podem ser encontradas na API documentation.
The boot mode can be changed as follows. At next boot, the NetHSM will behave accordingly.
Argumentos*
Argumento |
Descrição |
---|---|
Estado |
Activar ou desactivar * Bota desacompanhada*. Pode ter valor |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST set-unattended-boot on
Updated the unattended boot configuration for NetHSM localhost:8443
Informações sobre o parâmetro /config/unattended-boot podem ser encontradas na API documentation.
Estado#
O software NetHSM tem quatro estados: Não previsto*, Provisionado, Travado, e Fechado, e Operacional.
Estado |
Descrição |
---|---|
Não previsto |
NetHSM sem configuração (predefinição de fábrica) |
Provisionado |
NetHSM com configuração. O estado Provisionado implica um estado Operacional ou Fechado. |
Operacional |
NetHSM com configuração e pronto a executar comandos. O estado Operacional implica o estado Provisionado. |
Travado |
NetHSM with configuration but encrypted and inaccessible data stores. Typically, the next step is to unlock the system. The Locked state implies the Provisioned state. |
Estados e transições do NetHSM#
O estado actual do NetHSM pode ser recuperado da seguinte forma.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST state
NetHSM localhost:8443 is Unprovisioned
Informações sobre o parâmetro /saúde/estado podem ser encontradas na documentaçãoAPI.
Um novo NetHSM tem um estado Não previsto e após o aprovisionamento entra no estado Operacional. O aprovisionamento de um NetHSM é descrito no capítulo Provisionamento.
Um NetHSM em estado Operacional pode ser bloqueado novamente para o proteger da seguinte forma.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST lock
NetHSM localhost:8443 locked
Informações sobre o ponto final /lock podem ser encontradas na documentaçãoAPI.
A NetHSM in Locked state can be unlocked as follows. While the NetHSM is in the _Locked_ state no other operations are possible. Afterwards the NetHSM is in an _Operational_ state.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST unlock
NetHSM localhost:8443 unlocked
Informações sobre o ponto final /unlock podem ser encontradas na documentaçãoAPI.
Desbloquear frase-senha#
A Senha de Bloqueio é utilizada para obter uma * Chave de Bloqueio* se o NetHSM estiver no estado Travado. A frase-senha é inicialmente definida durante o aprovisionamento do NetHSM.
A Pasfrásica de Bloqueio pode ser definida como se segue.
Opções opcionais*
Opção |
Descrição |
---|---|
|
A nova frase-senha de desbloqueio |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST set-unlock-passphrase
Passphrase:
Repeat for confirmation:
Updated the unlock passphrase for localhost:8443
Informações sobre o ponto final /config/unlock-passphrase podem ser encontradas na API documentation.
Certificado TLS#
O certificado TLS é utilizado para o HTTPS baseado em REST API, e portanto também utilizado pela nitropia. Durante o aprovisionamento, é criado um certificado autoassinado. O certificado pode ser substituído, por exemplo, por um certificado assinado por uma autoridade certificadora (AC). Neste caso, deve ser gerado um Pedido de Assinatura de Certificado (CSR). Depois de assinado o certificado deve ser importado para o NetHSM.
Uma alteração só é necessária quando o certificado tiver de ser substituído. Tal alteração pode ser para a substituir por um certificado assinado por uma autoridade certificadora (AC).
O certificado do TLS pode ser recuperado da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
Definir o certificado para a interface NetHSM TLS |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST get-certificate --api
-----BEGIN CERTIFICATE-----
MIIBHzCBxaADAgECAgkA7AznVQK3XWkwCgYIKoZIzj0EAwIwFDESMBAGA1UEAwwJ
a2V5ZmVuZGVyMCAXDTcwMDEwMTAwMDAwMFoYDzk5OTkxMjMxMjM1OTU5WjAUMRIw
EAYDVQQDDAlrZXlmZW5kZXIwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAARbeCRl
F1ZIjK1bTfrPvtCoYDThMjdV1q8mq+B9FMDo4GIahTCUG/Ub6bCOcbip5pP92J3h
yMEcPuos72c1KcGjMAoGCCqGSM49BAMCA0kAMEYCIQC/BNrkCM5gpsVfa9EqQcM0
PCaADyZG7KKLgDv7asa5LwIhAKDXRE3Tdm9tYObO0X4p0CRQkl1+DnvGljzQe34C
JBax
-----END CERTIFICATE-----
Informações sobre o parâmetro /config/tls/cert.pem podem ser encontradas na documentação da API.
O certificado TLS pode ser gerado da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
O tipo para a chave gerada |
|
O comprimento da chave gerada |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST generate-tls-key -t Curve25519
Key for TLS interface generated on NetHSM localhost:8443
Informações sobre o parâmetro /config/tls/generate podem ser encontradas na documentação API.
O Pedido de Assinatura de Certificado (CSR) para o certificado pode ser gerado da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
Gerar um CSR para o certificado NetHSM TLS |
|
O nome do país |
|
O nome do estado ou província |
|
O nome da localidade |
|
O nome da organização |
|
O nome da unidade organizacional |
|
O nome comum |
|
O endereço de correio electrónico |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST csr --api --country="DE" --state-or-province="Berlin" --locality="Berlin" --organization="Nitrokey" --organizational-unit="" --common-name="Nitrokey" --email-address="info@nitrokey.com"
-----BEGIN CERTIFICATE REQUEST-----
MIGBMDUCAQAwAjEAMCowBQYDK2VwAyEAE+nz+nOj80SWG25UbqVcQk6Ua84zuj5B
9qCtPpDUX2qgADAFBgMrZXADQQDwk9LrYDu83a1jgBGqW0I9BVXWEhP4gZLxlVV+
c102GFi963ZPIxG7Z5+uWplz+wr/Vmr7KLr6oM01M/AZPJQO
-----END CERTIFICATE REQUEST-----
Informações sobre o parâmetro /config/tls/csr.pem podem ser encontradas na documentação da API.
O certificado pode ser substituído como se segue.
Opções requeridas*
Opção |
Descrição |
---|---|
|
Definir o certificado para a interface NetHSM TLS |
Argumentos*
Argumento |
Descrição |
---|---|
|
Ficheiro do certificado |
Exemplo*
nitropy nethsm --host $NETHSM_HOST set-certificate --api /tmp/nethsm-certificate
Informações sobre o parâmetro /config/tls/csr.pem podem ser encontradas na documentação da API.
Rede#
A configuração da rede define as definições utilizadas para a Porta de rede.
Nota
Esta configuração não configura a BMC Network Port.
A configuração da rede pode ser recuperada da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
Consultar a configuração da rede |
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST get-config --network
Configuration for NetHSM localhost:8443:
Network:
IP address: 192.168.1.1
Netmask: 255.255.255.0
Gateway: 0.0.0.0
Informações sobre o parâmetro /config/network podem ser encontradas na documentaçãoAPI.
Definir a configuração da rede da seguinte forma.
Nota
O NetHSM não suporta DHCP (Dynamic Host Configuration Protocol).
Nota
O NetHSM não suporta IPv6 (Internet Protocol versão 6).
Opções requeridas*
Opção |
Descrição |
---|---|
|
O novo endereço IP |
|
A nova máscara de rede |
|
A nova porta de entrada |
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST set-network-config -a 192.168.1.1 -n 255.255.255.0 -g 0.0.0.0
Updated the network configuration for NetHSM localhost:8443
Informações sobre o parâmetro /config/network podem ser encontradas na documentaçãoAPI.
Hora#
A configuração temporal define a hora do sistema do software NetHSM. Normalmente não é necessário definir a hora do sistema, uma vez que é definida durante o aprovisionamento.
A configuração do tempo pode ser recuperada da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
Consultar o tempo do sistema |
Exemplo*
$ nitropy nethsm -host $NETHSM_HOST get-config --time
Configuration for NetHSM localhost:8443:
Time: 2022-08-17 11:40:00+00:00
Informações sobre o parâmetro /config/time podem ser encontradas na documentação API.
Definir o tempo do NetHSM.
Importante
Certifique-se de que passa o tempo no fuso horário UTC.
Argumentos*
Argumento |
Descrição |
---|---|
|
O tempo do sistema a definir (Formato: AAAA-MM-DDTHH:MM:SSZ) |
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST set-time 2022-08-17T11:40:00Z
Updated the system time for NetHSM localhost:8443
Informações sobre o parâmetro /config/time podem ser encontradas na documentação API.
Métricas#
O NetHSM regista as métricas dos parâmetros do sistema.
Nota
Este comando requer a autenticação de um utilizador com a função Metrics. Consulte o capítulo Roles para saber mais sobre a função.
Please refer to Metrics to learn more about each metric.
A métrica pode ser recuperada da seguinte forma.
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST metrics
Metric Value
---------------------------- --------
client connections 0
established state 6
external.received bytes 989931
external.received packets 13239
external.transmitted bytes 25908953
external.transmitted packets 22037
free chunk count 322
gc compactions 0
gc major bytes 21348352
gc major collections 35
gc minor collections 2652
http response 200 28
http response 201 1
http response 204 1
http response 400 1
http response 403 1
http response 404 145
http response 412 1
http response time 0.084998
http response total 178
internal.received bytes 66541
internal.received packets 1130
internal.transmitted bytes 63802
internal.transmitted packets 1133
kv write 2
log errors 3
log warnings 3
maximum allocated space 64528384
maximum releasable bytes 1216
mmapped region count 0
new sleeper size 1
non-mmapped allocated bytes 64528384
sleep queue size 11
syn-rcvd state 0
timers 2
total allocated space 43940832
total client 1
total established 515
total free space 20587552
total sleeper size 12
total syn-rcvd 514
total timers 526
uptime 17626
Informações sobre o parâmetro /metrics podem ser encontradas na documentação da API.
Logging#
O NetHSM pode registar eventos do sistema na porta série ou num servidor syslog na rede.
Importante
For any production deployment, the NetHSM log should be monitored continuously to provide immediate notification of any potential security issues.
A consola em série funciona logo desde o início do hardware NetHSM. Ela inclui eventos do firmware NetHSM e do software NetHSM.
As configurações de ligação da consola em série são as seguintes.
Configuração |
Valor |
---|---|
Taxa de Baud |
115200 |
Bocados de dados |
8 |
Pedaços de paragem |
1 |
Paridade |
Nenhum |
Controlo de fluxo |
Nenhum |
A configuração do servidor syslog pode ser recuperada da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
Consultar a configuração do registo |
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST get-config --logging
Logging:
IP address: 0.0.0.0
Port: 514
Log level: info
Informações sobre o parâmetro /config/logging podem ser encontradas na documentaçãoAPI.
A configuração do servidor syslog pode ser definida da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
O endereço IP do novo destino de registo |
|
O porto do novo destino da exploração madeireira |
|
O novo nível de registo |
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST set-logging-config -a 192.168.0.1 -p 514 -l info
Updated the logging configuration for NetHSM localhost:8443
Informações sobre o parâmetro /config/logging podem ser encontradas na documentaçãoAPI.
Cópia de segurança#
O NetHSM User Data pode ser guardado num ficheiro de cópia de segurança. Este ficheiro de cópia de segurança contém todos os Dados do Utilizador, nomeadamente Lojas de Configuração, Lojas de Autenticação, Lojas de Chaves do Domínio e Lojas Chave.
Importante
Um software de sistema NetHSM em modo de Bot desacompanhado exigirá a Frases de Desbloqueio se restaurada num hardware NetHSM diferente. Consulte por favor o capítulo `Frasess-Frasess-Frases de Desbloqueio <administration.html#unlock-passphrase>>x id=»214»></x>__ para saber mais.
Importante
Uma NetHSM em modo Bot desacompanhada estará no mesmo modo após uma restauração.
Antes de se poder iniciar uma cópia de segurança, a Backup Passphrase deve ser definida. A Backup Passphrase é utilizada para encriptar os dados no ficheiro de cópia de segurança.
A frase-senha de reserva pode ser definida da seguinte forma.
Opções opcionais*
Opção |
Descrição |
---|---|
|
A nova frase-senha de segurança |
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST -u admin set-backup-passphrase
Passphrase:
Repeat for confirmation:
Updated the backup passphrase for NetHSM localhost:8443
Informações sobre o parâmetro /config/backup-passphrase podem ser encontradas na documentaçãoAPI.
Nota
Este comando requer a autenticação de um utilizador com a função Backup. Consulte o capítulo Roles para saber mais.
A cópia de segurança pode ser executada da seguinte forma.
Argumentos*
Argumento |
Descrição |
---|---|
|
Ficheiro de cópia de segurança |
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST backup /tmp/nethsm-backup
Backup for localhost:8443 written to /tmp/backup
Informações sobre o parâmetro /system/backup podem ser encontradas na documentação API.
Nota
Este ficheiro de cópia de segurança pode ser restaurado apenas numa instância não prevista da NetHSM.
Restaurar#
O NetHSM pode ser restaurado a partir de um ficheiro de cópia de segurança.
If the NetHSM is Unprovisioned it will restore all User Data including system configuration and reboot. Therefore the system may get different network settings, TLS certificate and Unlock Passphrase afterwards.
If the NetHSM is Provisioned it will restore users and user keys but not system configuration. In this case all previously existing users and user keys will be deleted. The NetHSM ends in an Operational state.
A restauração pode ser aplicada da seguinte forma.
Opções opcionais*
Opção |
Descrição |
---|---|
|
A Frasesa-Passe de Backup |
|
O tempo do sistema a definir (Formato: |
Importante
Certifique-se de que a hora do seu computador local está correctamente definida. Para definir uma hora diferente, por favor forneça-a manualmente.
Argumentos*
Argumento |
Descrição |
|
---|---|---|
|
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST restore /tmp/nethsm-backup
Backup passphrase:
Backup restored on NetHSM localhost:8443
Informações sobre o parâmetro /system/restore podem ser encontradas na documentaçãoAPI.
Software Update#
Software updates can be installed in a two-step process. First the update image needs to be uploaded to a Provisioned NetHSM. The NetHSM verifies image authenticity, integrity, and version number. Optionally, the NetHSM displays release notes, if any.
Aviso
Data loss may occur due to the installation of a beta update! Stable versions should not cause data loss. However, it’s recommended to create a backup before updating.
O ficheiro de actualização pode ser carregado da seguinte forma.
Argumentos*
Argumento |
Descrição |
---|---|
|
Ficheiro de actualização |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST update /tmp/nethsm-update.img.cpio
Image /tmp/nethsm-update.img.cpio uploaded to NetHSM localhost:8443
Informações sobre o parâmetro /system/update podem ser encontradas na documentação API.
Afterwards the update can be applied or aborted. Please refer to the desired option below. If the NetHSM is powered down before the «commit» operation, the update file has to be uploaded again.
The update can be applied (committed) as follows. Any data migration is only performed _after_ the NetHSM has successfully booted the new system software version.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST commit-update
Update successfully committed on NetHSM localhost:8443
Informações sobre o parâmetro /system/commit-update podem ser encontradas na documentaçãoAPI.
A actualização pode ser cancelada da seguinte forma.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST cancel-update
Update successfully cancelled on NetHSM localhost:8443
Informações sobre o parâmetro /system/cancel-update podem ser encontradas na documentaçãoAPI.
Reinício e Encerramento#
O NetHSM pode ser reiniciado e desligado, quer remotamente, quer com o botão de reiniciar e desligar na parte frontal do hardware NetHSM.
A reinicialização remota pode ser iniciada da seguinte forma.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST reboot
NetHSM localhost:8443 will be rebooted.
Do you want to continue? [y/N]: y
NetHSM localhost:8443 is about to reboot
Informações sobre o parâmetro /system/reboot podem ser encontradas na documentação API.
O desligamento remoto pode ser iniciado da seguinte forma.
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST shutdown
NetHSM localhost:8443 will be shutdown.
Do you want to continue? [y/N]: y
NetHSM localhost:8443 is about to shutdown
Informações sobre o parâmetro /system/shutdown podem ser encontradas na `documentaçãoAPI <https://nethsmdemo.nitrokey.com/api_docs/index.html#/default/POST_system-shutdown>>x id=»172»></x>__.
Repor para Padrões de Fábrica#
A Provisioned NetHSM can be reset to factory defaults. In this case all user data is securely deleted and the NetHSM boots into an Unprovisioned state. Afterwards, you may want to provision the NetHSM.
A reposição para os padrões de fábrica pode ser executada da seguinte forma.
Exemplo*
$ nitropy nethsm -h $NETHSM_HOST factory-reset
NetHSM localhost:8443 will be set to factory defaults.
All data will be lost!
Do you want to continue? [y/N]: y
NetHSM localhost:8443 is about to perform a factory reset
Informações sobre o parâmetro /system/factory-reset podem ser encontradas na documentaçãoAPI.
Gestão de usuários#
Papéis#
O NetHSM permite a separação de funções através da utilização de diferentes papéis. Cada conta de utilizador configurada no NetHSM tem uma das seguintes Roles que lhe é atribuída.
Papel |
Descrição |
---|---|
Administrador |
Uma conta de utilizador com esta função tem acesso a todas as operações fornecidas pela NetHSM, excepto para operações de utilização chave, ou seja, assinatura e desencriptação de mensagens. |
Operador |
Uma conta de utilizador com esta Função tem acesso a todas as operações-chave de utilização, um subconjunto de operações de gestão de chaves apenas de leitura e operações de gestão de utilizadores permitindo apenas alterações à sua própria conta. |
Metrics |
Uma conta de utilizador com esta Função tem acesso apenas a operações só de leitura de métricas. |
Backup |
Uma conta de utilizador com esta Função tem acesso apenas às operações necessárias para iniciar uma cópia de segurança do sistema. |
See Tags for more fine-grained access restricions.
Nota
Num lançamento futuro, poderão ser introduzidas Roles adicionais.
Adicionar Utilizador#
Acrescentar uma conta de utilizador ao NetHSM. Cada conta de utilizador tem um Role, que precisa de ser especificado. Consultar o capítulo Roles para saber mais sobre Roles.
Nota
O NetHSM atribui um ID de utilizador aleatório se nenhum for especificado.
Uma conta de utilizador pode ser adicionada da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
O verdadeiro nome do utilizador |
|
O Role do novo utilizador |
|
A frase-senha do novo utilizador |
Opções opcionais*
Opção |
Descrição |
---|---|
|
O ID de utilizador do novo utilizador |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST add-user --real-name "Nitrokey Operator" --role Operator --user-id operator1
Passphrase:
Repeat for confirmation:
User operator1 added to NetHSM localhost:8443
Informações sobre o parâmetro /user endpoint, para criar um utilizador sem especificar o ID do utilizador, podem ser encontradas na documentação da API.
Informações sobre o parâmetro /users/{UserID}, para criar um utilizador com especificação do ID de utilizador, podem ser encontradas na documentaçãoAPI.
Eliminar Utilizador#
Eliminar uma conta de utilizador do NetHSM.
Aviso
A eliminação é permanente e não pode ser revertida.
Uma conta de utilizador pode ser apagada da seguinte forma.
Argumentos*
Argumento |
Descrição |
---|---|
|
O ID de utilizador do utilizador. |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST delete-user operator1
User operator1 deleted on NetHSM localhost:8443
Informações sobre o parâmetro /users/{UserID} podem ser encontradas na documentação API.
Lista de Utilizadores#
Faça uma lista dos utilizadores no NetHSM.
A lista pode ser recuperada da seguinte forma.
Opções opcionais*
Opção |
Descrição |
---|---|
|
Consultar o verdadeiro nome e papel do utilizador |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST list-users
Users on NetHSM localhost:8843:
User ID Real name Role
--------- ----------------- -------------
operator1 Nitrokey Operator Operator
admin admin Administrator
Informações sobre o parâmetro /user endpoint podem ser encontradas na documentaçãoAPI.
Informações sobre o parâmetro /users/{UserID} podem ser encontradas na documentação API.
Palavra-passe de utilizador#
A frase-senha de uma conta de utilizador pode ser reposta. Uma frase-chave é definida inicialmente durante a adição de uma conta de utilizador.
Nota
As frases-chave devem ter >= 10 e <= 200 caracteres.
A senha de utilizador pode ser definida da seguinte forma.
Opções requeridas*
Opção |
Descrição |
---|---|
|
O ID de utilizador do utilizador |
|
A nova frase-senha do utilizador |
Exemplo*
$ nitropy nethsm --host $NETHSM_HOST set-passphrase --user-id operator1
Passphrase:
Repeat for confirmation:
Updated the passphrase for user operator1 on NetHSM localhost:8443
Informações sobre o parâmetro /users/{UserID}/passphrase podem ser encontradas na `documentaçãoAPI <https://nethsmdemo.nitrokey.com/api_docs/index.html#/default/POST_users-UserID-passphrase>>x id=»190»></x>__.