Interface Key

Hierarchy

Index

Methods

block create delete exportAsymmetricPriv exportAsymmetricPub exportCertClearText exportKekWrap exportPKCS8 exportSymmetric generatePKCS10 import importCertificate importKekWrap importPKCS8 unblock

Methods

block

block(name: string): Promise<boolean>
Description
Bloqueia uma chave no HSM.

Returns
Retorna true se a chave foi bloqueada com sucesso.

Throws
Caso o nome da chave seja inválido.

Throws
Caso ocorra algum erro na deleção da chave.
Parameters
- name: string
  
  Nome da chave.
Returns Promise<boolean>

create

create(name: string, algorithm: ECC_ASYMMETRIC_SWITCHES | SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | ECX_ASYMMETRIC_SWITCHES | HMAC_KEYS | ALT_BN128, exportable?: boolean, temporary?: boolean, blockchain?: boolean): Promise<boolean>
Description
Cria e armazena uma chave criptográfica associada a um algoritmo conforme os parâmetros informados, dentro do HSM.

Returns
Retorna true se a chave foi criada com sucesso.

Throws
Caso o nome da chave seja inválido.

Throws
Caso ocorra algum erro na criação da chave.
Parameters
- name: string
  
  Nome da chave.
- algorithm: ECC_ASYMMETRIC_SWITCHES | SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | ECX_ASYMMETRIC_SWITCHES | HMAC_KEYS | ALT_BN128
  
  Algoritmo da chave.
- Optional exportable: boolean
  
  Se a chave será exportável.
- Optional temporary: boolean
  
  Se a chave será temporária.
- Optional blockchain: boolean
  Se a chave poderá ser usada em operações de blockchain.
  
  ATENÇÃO: Apenas algumas chaves serão permitadas caso blockchain sejá informado:
Returns Promise<boolean>

delete

delete(name: string): Promise<boolean>
Description
Deleta uma chave armazenada no HSM.

Returns
Retorna true se a chave foi deletada com sucesso.

Throws
Caso o nome da chave seja inválido.

Throws
Caso ocorra algum erro na deleção da chave.
Parameters
- name: string
  
  Nome da chave.
Returns Promise<boolean>

exportAsymmetricPriv

exportAsymmetricPriv(name: string): Promise<Buffer>
Description
Exporta a parte privada chave assimétrica armazenada no HSM.

Returns
Buffer contendo os dados da chave conforme o formato KEY_EXPORT_FORMAT.

Throws
Caso o nome da chave seja inválido.o.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- name: string
  
  Nome da chave.
Returns Promise<Buffer>

exportAsymmetricPub

exportAsymmetricPub(name: string, x509: boolean): Promise<Buffer>
Description
Exporta uma chave criptográfica armazenada no HSM.

Returns
Buffer contendo os dados da chave conforme o formato KEY_EXPORT_FORMAT.

Throws
Caso o nome da chave seja inválido.o.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- name: string
  
  Nome da chave.
- x509: boolean
  
  Se a chave será exportada no formato X509.
Returns Promise<Buffer>

exportCertClearText

exportCertClearText(name: string): Promise<Buffer>
Description
Exporta em texto claro o certificado armazenada no HSM.

Returns
Buffer contendo o certificado.

Throws
Caso o nome da chave seja inválido.o.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- name: string
  
  Nome da chave.
Returns Promise<Buffer>

exportKekWrap

exportKekWrap(mode: KEK_MODE | UNUSED_MODE, pad: KEK_WRAP_PADDING, name: string, kekKeyName: string, iv?: string): Promise<Buffer>
Description
Exporta uma chave encriptada por uma KEK (Key Encryption Key).

Returns
Buffer contendo os dados da chave conforme o formato KEY_EXPORT_FORMAT.

Throws
Caso o nome da chave seja inválido.o.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- mode: KEK_MODE | UNUSED_MODE
  
  Modo de operação para a importação da chave.
- pad: KEK_WRAP_PADDING
  
  Opção de padding para a operação de KEK.
- name: string
  
  Nome da chave.
- kekKeyName: string
  
  Nome da Key Encryption Key (KEK) que será usada para descriptografar a chave importada.
- Optional iv: string
  
  Vetor de inicialização (Initialization Vector). Obriatório para o modo MODE_CBC.
Returns Promise<Buffer>

exportPKCS8

exportPKCS8(name: string, password: string): Promise<Buffer>
Description
Exporta uma chave PKCS#8 do HSM.

Returns
Retorna um buffer contendo os dados da chave.

Throws
Caso o nome da chave seja inválido.

Throws
Caso a senha da chave seja não obedeçam aos requisitos mínimos.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- name: string
  
  Nome da chave. Mínimo de $P8_IMPORT_EXPORT_SECRET_MIN_LEN caracteres, máximo de $P8_IMPORT_EXPORT_SECRET_MAX_LEN caracteres.
- password: string
  
  Senha da chave.
Returns Promise<Buffer>

exportSymmetric

exportSymmetric(name: string): Promise<Buffer>
Description
Exporta em texto claro a chave privada armazenada no HSM.

Returns
Buffer contendo os dados da chave conforme o formato KEY_EXPORT_FORMAT.

Throws
Caso o nome da chave seja inválido.o.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- name: string
  
  Nome da chave.
Returns Promise<Buffer>

generatePKCS10

generatePKCS10(keyName: string, dn: X500DistinguishedName, hashAlgorith?: PKCS10_HASH_ALGORITHM): Promise<Buffer>
Description
Gera um CSR (Certificate Signing Request / Requisição de Assinatura de Certificado).
É uma função especializada da API de geração de CSR PKCS#10 do HSM.

Returns
Retorna o CSR no formato DER.

Throws
Caso o nome da chave seja inválido.
Parameters
- keyName: string
  
  Nome da chave.
- dn: X500DistinguishedName
  
  Dados do certificado.
- Optional hashAlgorith: PKCS10_HASH_ALGORITHM
  
  Algoritmo de hash a ser usado na geração do CSR. Caso não seja informado, será usado o algoritmo padrão do HSM.
Returns Promise<Buffer>

import

import(name: string, algorithm: SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | HMAC_KEYS | ALT_BN128, data: Buffer, exportable?: boolean, temporary?: boolean, blockchain?: boolean): Promise<boolean>
Description
Importa uma chave criptográfica para dentro do HSM.

Returns
Retorna true se a chave foi importada com sucess

Throws
Caso o nome da chave seja inválido.o.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- name: string
  
  Nome da chave.
- algorithm: SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | HMAC_KEYS | ALT_BN128
  
  Algoritmo da chave. Mesmo algoritmo usado na criação da chave pela função create
- data: Buffer
  
  Dados da chave a ser importada.
- Optional exportable: boolean
  
  Se a chave será exportável.
- Optional temporary: boolean
  
  Se a chave será temporária.
- Optional blockchain: boolean
  
  Se a chave poderá ser usada em operações de blockchain.
Returns Promise<boolean>

importCertificate

importCertificate(name: string, certData: Buffer): Promise<boolean>
Description
Importa um certificado para o HSM.

Returns
Retorna true se o certificado foi importado com sucesso.

Throws
Caso o nome do certificado seja inválido.

Throws
Caso ocorra algum erro na importação do certificado.
Parameters
- name: string
  
  Nome do certificado.
- certData: Buffer
  
  Certificado a ser importado.
Returns Promise<boolean>

importKekWrap

importKekWrap(mode: KEK_MODE | UNUSED_MODE, pad: KEK_WRAP_PADDING, name: string, kekKeyName: string, objType: ECC_ASYMMETRIC_SWITCHES | SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | ECX_ASYMMETRIC_SWITCHES, data: Buffer, iv?: string, exportable?: boolean, temporary?: boolean, blockchain?: boolean): Promise<boolean>
Description
Importa uma chave encriptada por uma KEK (Key Encryption Key).

Returns
Retorna true se a chave foi importada.

Throws
Caso o nome da chave seja inválido.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- mode: KEK_MODE | UNUSED_MODE
  
  Modo de operação para a importação da chave.
- pad: KEK_WRAP_PADDING
  
  Opção de padding para a operação de KEK.
- name: string
  
  Nome da chave.
- kekKeyName: string
  
  Nome da Key Encryption Key (KEK) que será usada para descriptografar a chave importada.
- objType: ECC_ASYMMETRIC_SWITCHES | SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | ECX_ASYMMETRIC_SWITCHES
  
  Tipo do objeto.
- data: Buffer
  
  Buffer que contém os dados da chave criptografada que será importada.
- Optional iv: string
  
  Vetor de inicialização (Initialization Vector). Obriatório para o modo MODE_CBC.
- Optional exportable: boolean
  
  Se a chave será exportável.
- Optional temporary: boolean
  
  Se a chave será temporária.
- Optional blockchain: boolean
  
  Se a chave poderá ser usada em operações de blockchain.
Returns Promise<boolean>

importPKCS8

importPKCS8(name: string, keyType: ECC_ASYMMETRIC_SWITCHES | RSA_ASYMMETRIC_KEYS, password: string, p8: string, exportable?: boolean, temporary?: boolean, blockchain?: boolean): Promise<boolean>
Description
Import uma chave PKCS#8 para o HSM.

Returns
Retorna true se a chave foi importada com sucesso.

Throws
Caso o nome da chave seja inválido.

Throws
Caso a senha da chave seja não obedeçam aos requisitos mínimos.

Throws
Caso ocorra algum erro na importação da chave.
Parameters
- name: string
  
  Nome da chave.
- keyType: ECC_ASYMMETRIC_SWITCHES | RSA_ASYMMETRIC_KEYS
  
  Tipo da chave.
- password: string
  
  Senha da chave. Mínimo de $P8_IMPORT_EXPORT_SECRET_MIN_LEN caracteres, máximo de $P8_IMPORT_EXPORT_SECRET_MAX_LEN caracteres.
- p8: string
  
  Dados da chave no formato PKCS#8 (base64).
- Optional exportable: boolean
  
  Se a chave será exportável.
- Optional temporary: boolean
  
  Se a chave será temporária.
- Optional blockchain: boolean
  Se a chave poderá ser usada em operações de blockchain.
  
  ATENÇÃO: Apenas algumas chaves serão permitadas caso blockchain sejá informado:
Returns Promise<boolean>

unblock

unblock(name: string): Promise<boolean>
Description
Desbloqueia uma chave no HSM.

Returns
Retorna true se a chave foi desbloqueada com sucesso.

Throws
Caso o nome da chave seja inválido.

Throws
Caso ocorra algum erro na deleção da chave.
Parameters
- name: string
  
  Nome da chave.
Returns Promise<boolean>

Interface Key

Hierarchy

Index

Methods

Methods

block

Description

Returns

Throws

Throws

Parameters

name: string

Returns Promise<boolean>

create

Description

Returns

Throws

Throws

Parameters

name: string

algorithm: ECC_ASYMMETRIC_SWITCHES | SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | ECX_ASYMMETRIC_SWITCHES | HMAC_KEYS | ALT_BN128

Optional exportable: boolean

Optional temporary: boolean

Optional blockchain: boolean

Returns Promise<boolean>

delete

Description

Returns

Throws

Throws

Parameters

name: string

Returns Promise<boolean>

exportAsymmetricPriv

Description

Returns

Throws

Throws

Parameters

name: string

Returns Promise<Buffer>

exportAsymmetricPub

Description

Returns

Throws

Throws

Parameters

name: string

x509: boolean

Returns Promise<Buffer>

exportCertClearText

Description

Returns

Throws

Throws

Parameters

name: string

Returns Promise<Buffer>

exportKekWrap

Description

Returns

Throws

Throws

Parameters

mode: KEK_MODE | UNUSED_MODE

pad: KEK_WRAP_PADDING

name: string

kekKeyName: string

Optional iv: string

Returns Promise<Buffer>

exportPKCS8

Description

Returns

Throws

Throws

Throws

Parameters

name: string

password: string

Returns Promise<Buffer>

`Optional` exportable: boolean

`Optional` temporary: boolean

`Optional` blockchain: boolean

`Optional` iv: string

`Optional` hashAlgorith: PKCS10_HASH_ALGORITHM

`Optional` exportable: boolean

`Optional` temporary: boolean

`Optional` blockchain: boolean

`Optional` iv: string

`Optional` exportable: boolean

`Optional` temporary: boolean

`Optional` blockchain: boolean

`Optional` exportable: boolean

`Optional` temporary: boolean

`Optional` blockchain: boolean