As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Ferramenta de configuração do Client SDK 5
Use a ferramenta de configuração do Client SDK 5 para atualizar os arquivos de configuração do lado do cliente.
Cada componente no Client SDK 5 inclui uma ferramenta de configuração com um designador do componente no nome do arquivo da ferramenta de configuração. Por exemplo, a biblioteca PKCS #11 do Client SDK 5 inclui uma ferramenta de configuração chamada configure-pkcs11
no Linux ou configure-pkcs11.exe
no Windows.
Sintaxe
Configurações avançadas
Para obter uma lista de configurações avançadas específicas da ferramenta de configuração do Client SDK 5, consulte Configurações avançadas para a ferramenta de configuração do Client SDK 5.
Importante
Depois de fazer qualquer alteração na configuração, você precisará reiniciar o aplicativo para que as alterações entrem em vigor.
Exemplos
Esses exemplos mostram como usar a ferramenta de configuração para o Client SDK 5.
Este exemplo usa o parâmetro -a
para atualizar os dados HSM do Client SDK 5. Para usar o parâmetro -a
, você deve ter o endereço IP de um dos HSMs no seu cluster.
nota
você pode usar o parâmetro –-cluster-id
no lugar de -a <HSM_IP_ADDRESSES>
. Para ver os requisitos de uso de –-cluster-id
, consulte Ferramenta de configuração do Client SDK 5.
Para obter mais informações sobre o parâmetro -a
, consulte Parâmetros.
Este exemplo usa o parâmetro cluster-id
para fazer o bootstrap do Client SDK 5 fazendo uma chamada DescribeClusters
.
Você pode usar os parâmetros --region
e --endpoint
em combinação com o parâmetro cluster-id
para especificar como o sistema faz a chamada DescribeClusters
. Por exemplo, se a região do cluster for diferente daquela configurada como padrão do AWS CLI, você deve usar o parâmetro --region
para usar essa região. Além disso, você pode especificar o endpoint da AWS CloudHSM API a ser usado na chamada, o que pode ser necessário para várias configurações de rede, como usar endpoints de interface VPC que não usam o nome de host DNS padrão para. AWS CloudHSM
Para obter mais informações sobre os parâmetros --endpoint
, --cluster-id
e --region
, consulte Parâmetros.
Este exemplo mostra como usar os --server-client-key-file
parâmetros server-client-cert-file
e para reconfigurar o SSL especificando uma chave personalizada e um certificado SSL para AWS CloudHSM
Para obter mais informações sobre os parâmetros server-client-cert-file
e --server-client-key-file
, consulte Parâmetros.
Este exemplo usa o parâmetro --disable-key-availability-check
para desativar as configurações de durabilidade da chave do cliente. Para executar um cluster com um único HSM, você deve desativar as configurações de durabilidade da chave do cliente.
Para obter mais informações sobre o parâmetro --disable-key-availability-check
, consulte Parâmetros.
O Client SDK 5 usa os parâmetros log-file
, log-level
, log-rotation
e log-type
para gerenciar o logging.
nota
Para configurar seu SDK para ambientes sem servidor, como AWS Fargate ou AWS Lambda, recomendamos que você configure seu tipo de log como. AWS CloudHSM term
Os registros do cliente serão enviados stderr
e capturados no grupo de CloudWatch registros de registros configurado para esse ambiente.
Para obter mais informações sobre os parâmetros log-rotation
, log-file
, log-level
e log-type
, consulte Parâmetros.
Este exemplo usa o parâmetro --hsm-ca-cert
para atualizar a localização do certificado de emissão do Client SDK 5.
Para obter mais informações sobre o parâmetro --hsm-ca-cert
, consulte Parâmetros.
Parâmetros
- -a
<ENI IP address>
-
Adiciona o endereço IP especificado aos arquivos de configuração do SDK do cliente 5. Insira qualquer endereço IP ENI de um HSM do cluster. Para obter mais informações sobre como usar essa opção, consulte o Bootstrap o Client SDK 5.
Obrigatório: Sim
- -- hsm-ca-cert
<customerCA certificate file path>
-
Caminho para o diretório que armazena o certificado da autoridade de certificação (CA) usado para conectar instâncias do cliente EC2 ao cluster. Esse é o arquivo que você criou ao inicializar o cluster. Por padrão, o sistema procura esse arquivo no seguinte local:
Linux
/opt/cloudhsm/etc/
customerCA.crt
Windows
C:\ProgramData\Amazon\CloudHSM\
customerCA.crt
Para obter mais informações sobre como inicializar o cluster ou colocar o certificado, consulte Coloque um certificado de emissão em cada instância do EC2 e Inicializar o cluster.
Obrigatório: Não
- --cluster-id
<Cluster ID>
-
Faz uma chamada
DescribeClusters
para encontrar todos os endereços IP da interface de rede elástica (ENI) do HSM no cluster associado ao ID do cluster. O sistema adiciona os endereços IP ENI aos arquivos de AWS CloudHSM configuração.nota
Se você usar o
--cluster-id
parâmetro de uma instância do EC2 em uma VPC que não tem acesso à Internet pública, deverá criar uma interface VPC endpoint à qual se conectar. AWS CloudHSM Para obter mais informações sobre os endpoints da VPC, consulte AWS CloudHSM e VPC endpoints.Obrigatório: Não
- --endpoint
<Endpoint>
-
Especifique o endpoint AWS CloudHSM da API usado para fazer a
DescribeClusters
chamada. Você deve definir essa opção em combinação com--cluster-id
.Obrigatório: Não
- --region
<Region>
-
Especifique a região do seu cluster. Você deve definir essa opção em combinação com
--cluster-id
.Se você não fornecer o parâmetro
--region
, o sistema escolherá a região tentando ler as variáveis de ambienteAWS_DEFAULT_REGION
ouAWS_REGION
. Se essas variáveis não estiverem definidas, o sistema verificará a região associada ao seu perfil no seu arquivo de AWS Config (normalmente~/.aws/config
), a menos que você tenha especificado um arquivo diferente na variável de ambienteAWS_CONFIG_FILE
. Se nenhuma das opções acima for definida, o sistema usará a regiãous-east-1
como padrão.Obrigatório: Não
- -- server-client-cert-file
<client certificate file path>
-
Caminho para o certificado de cliente usado para autenticação mútua entre cliente e servidor TLS.
Use essa opção somente se não quiser usar a chave padrão e o certificado SSL/TLS que incluímos no Client SDK 5. Você deve definir essa opção em combinação com
--server-client-key-file
.Obrigatório: Não
- -- server-client-key-file
<client key file path>
-
Caminho para a chave do cliente usada para autenticação mútua entre cliente e servidor TLS.
Use essa opção somente se não quiser usar a chave padrão e o certificado SSL/TLS que incluímos no Client SDK 5. Você deve definir essa opção em combinação com
--server-client-cert-file
.Obrigatório: Não
- --log-level
<error | warn | info | debug | trace>
-
Especifica o nível mínimo de registro que o sistema deve gravar no arquivo de log. Cada nível inclui os níveis anteriores, com erro como nível mínimo e rastreie o nível máximo. Isso significa que, se você especificar erros, o sistema só gravará erros no log. Se você especificar rastreamento, o sistema gravará mensagens de erros, avisos, informações (info) e de depuração no log. Para obter mais informações, consulte Atualização do Client SDK 5.
Obrigatório: Não
- --log-rotation
<daily | weekly>
-
Especifica a frequência com que o sistema gira os logs. Para obter mais informações, consulte Atualização do Client SDK 5.
Obrigatório: Não
- --log-file
<file name with path>
-
Especifica onde o sistema gravará o arquivo de log. Para obter mais informações, consulte Atualização do Client SDK 5.
Obrigatório: Não
- --log-type
<term | file>
-
Especifica se o sistema gravará o log em um arquivo ou terminal. Para obter mais informações, consulte Atualização do Client SDK 5.
Obrigatório: Não
- -h | --help
-
Exibe ajuda.
Obrigatório: Não
- -v, --version
-
Exibe a versão do .
Obrigatório: Não
- --disable-key-availability-check
-
Sinalize para desativar o quórum de disponibilidade de chaves. Use esse sinalizador para indicar se AWS CloudHSM deve desativar o quórum de disponibilidade de chaves e você pode usar chaves que existem em apenas um HSM no cluster. Para obter mais informações sobre como usar esse sinalizador para definir o quórum de disponibilidade de chaves, consulte Gerenciando as configurações de durabilidade de chave do cliente.
Obrigatório: Não
- --enable-key-availability-check
-
Sinalize para ativar o quórum de disponibilidade de chaves. Use esse sinalizador para indicar que você AWS CloudHSM deve usar o quorum de disponibilidade de chaves e não permitir que você use chaves até que essas chaves existam em dois HSMs no cluster. Para obter mais informações sobre como usar esse sinalizador para definir o quórum de disponibilidade de chaves, consulte Gerenciando as configurações de durabilidade de chave do cliente.
Habilitada por padrão.
Obrigatório: Não
- -- disable-validate-key-at -init
-
Melhora o desempenho especificando que você pode pular uma chamada de inicialização para verificar as permissões em uma chave para chamadas subsequentes. Use com cautela.
Antecedentes: Alguns mecanismos na biblioteca PKCS #11 oferecem suporte a operações de várias partes em que uma chamada de inicialização verifica se você pode usar a chave para chamadas subsequentes. Isso requer uma chamada de verificação para o HSM, o que adiciona latência à operação geral. Essa opção permite que você desative a chamada subseqüente e potencialmente melhore o desempenho.
Obrigatório: Não
- -- enable-validate-key-at -init
-
Especifica que você deve usar uma chamada de inicialização para verificar as permissões em uma chave para chamadas subsequentes. Esta é a opção padrão. Use
enable-validate-key-at-init
para retomar essas chamadas de inicialização depois de usardisable-validate-key-at-init
para suspendê-las.Obrigatório: Não