Interface Key

interface Key {
    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>;
    delete(name: string): Promise<boolean>;
    block(name: string): Promise<boolean>;
    unblock(name: string): Promise<boolean>;
    import(name: string, algorithm:
        | SYMMETRICAL_KEYS
        | RSA_ASYMMETRIC_KEYS
        | HMAC_KEYS
        | ALT_BN128, data: Buffer, exportable?: boolean, temporary?: boolean, blockchain?: boolean): Promise<boolean>;
    importCertificate(name: string, certData: Buffer): Promise<boolean>;
    generatePKCS10(keyName: string, dn: X500DistinguishedName, hashAlgorith?: PKCS10_HASH_ALGORITHM): Promise<Buffer>;
    exportAsymmetricPub(name: string, x509: boolean): Promise<Buffer>;
    exportAsymmetricPriv(name: string): Promise<Buffer>;
    exportSymmetric(name: string): Promise<Buffer>;
    exportCertClearText(name: string): Promise<Buffer>;
    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>;
    exportKekWrap(mode: KEK_MODE | UNUSED_MODE, pad: KEK_WRAP_PADDING, name: string, kekKeyName: string, iv?: string): Promise<Buffer>;
    importPKCS8(name: string, keyType: ECC_ASYMMETRIC_SWITCHES | RSA_ASYMMETRIC_KEYS, password: string, p8: string, exportable?: boolean, temporary?: boolean, blockchain?: boolean): Promise<boolean>;
    exportPKCS8(name: string, password: string): Promise<Buffer>;
}

Index

Methods

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

Methods

create

create(name, algorithm, exportable?, temporary?, blockchain?): Promise<boolean>
Cria e armazena uma chave criptográfica associada a um algoritmo conforme os parâmetros informados, dentro do HSM.
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.
- Optionalexportable: boolean
  Se a chave será exportável.
- Optionaltemporary: boolean
  Se a chave será temporária.
- Optionalblockchain: 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>
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.

See
Código de exemplo: Criando uma chave

delete

delete(name): Promise<boolean>
Deleta uma chave armazenada no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<boolean>
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.

See
Código de exemplo: Excluindo uma chave

block

block(name): Promise<boolean>
Bloqueia uma chave no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<boolean>
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.

See
Código de exemplo: Bloqueando uma chave

unblock

unblock(name): Promise<boolean>
Desbloqueia uma chave no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<boolean>
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.

See
Código de exemplo: Desbloqueando uma chave

import

import(name, algorithm, data, exportable?, temporary?, blockchain?): Promise<boolean>
Importa uma chave criptográfica para dentro do HSM.
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.
- Optionalexportable: boolean
  Se a chave será exportável.
- Optionaltemporary: boolean
  Se a chave será temporária.
- Optionalblockchain: boolean
  Se a chave poderá ser usada em operações de blockchain.
Returns Promise<boolean>
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.

See
Código de exemplo: Importando uma chave simétrica

importCertificate

importCertificate(name, certData): Promise<boolean>
Importa um certificado para o HSM.
Parameters
- name: string
  Nome do certificado.
- certData: Buffer
  Certificado a ser importado.
Returns Promise<boolean>
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.

See
Código de exemplo: Importando um certificado

generatePKCS10

generatePKCS10(keyName, dn, hashAlgorith?): Promise<Buffer>
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.
Parameters
- keyName: string
  Nome da chave.
- dn: X500DistinguishedName
  Dados do certificado.
- OptionalhashAlgorith: 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>
Retorna o CSR no formato DER.

Throws
Caso o nome da chave seja inválido.

See
Código de exemplo: Gerando um PKCS#10

exportAsymmetricPub

exportAsymmetricPub(name, x509): Promise<Buffer>
Exporta uma chave criptográfica armazenada no HSM.
Parameters
- name: string
  Nome da chave.
- x509: boolean
  Se a chave será exportada no formato X509.
Returns Promise<Buffer>
Buffer contendo os dados da chave conforme o formato enums.KEY_EXPORT_FORMAT.

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

Throws
Caso ocorra algum erro na importação da chave.

See
Código de exemplo: Exportando chave pública assimétrica

exportAsymmetricPriv

exportAsymmetricPriv(name): Promise<Buffer>
Exporta a parte privada chave assimétrica armazenada no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<Buffer>
Buffer contendo os dados da chave conforme o formato enums.KEY_EXPORT_FORMAT.

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

Throws
Caso ocorra algum erro na importação da chave.

See
Código de exemplo: Exportando chave privada assimétrica

exportSymmetric

exportSymmetric(name): Promise<Buffer>
Exporta em texto claro a chave privada armazenada no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<Buffer>
Buffer contendo os dados da chave conforme o formato enums.KEY_EXPORT_FORMAT.

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

Throws
Caso ocorra algum erro na importação da chave.

See
Código de exemplo: Exportando chave simétrica

exportCertClearText

exportCertClearText(name): Promise<Buffer>
Exporta em texto claro o certificado armazenada no HSM.
Parameters
- name: string
  Nome da chave.
Returns Promise<Buffer>
Buffer contendo o certificado.

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

Throws
Caso ocorra algum erro na importação da chave.

See
Código de exemplo: Exportando certificado em texto claro

importKekWrap

importKekWrap(mode, pad, name, kekKeyName, objType, data, iv?, exportable?, temporary?, blockchain?): Promise<boolean>
Importa uma chave encriptada por uma KEK (Key Encryption Key).
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.
- Optionaliv: string
  Vetor de inicialização (Initialization Vector). Obriatório para o modo enums.KEK_MODE.MODE_CBC.
- Optionalexportable: boolean
  Se a chave será exportável.
- Optionaltemporary: boolean
  Se a chave será temporária.
- Optionalblockchain: boolean
  Se a chave poderá ser usada em operações de blockchain.
Returns Promise<boolean>
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.

See
Código de exemplo: Importando chave KEKed

exportKekWrap

exportKekWrap(mode, pad, name, kekKeyName, iv?): Promise<Buffer>
Exporta uma chave encriptada por uma KEK (Key Encryption Key).
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.
- Optionaliv: string
  Vetor de inicialização (Initialization Vector). Obriatório para o modo enums.KEK_MODE.MODE_CBC.
Returns Promise<Buffer>
Buffer contendo os dados da chave conforme o formato enums.KEY_EXPORT_FORMAT.

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

Throws
Caso ocorra algum erro na importação da chave.

See
Código de exemplo: Exportando chave KEKed

importPKCS8

importPKCS8(name, keyType, password, p8, exportable?, temporary?, blockchain?): Promise<boolean>
Import uma chave PKCS#8 para o HSM.
Parameters
- name: string
  Nome da chave.
- keyType: ECC_ASYMMETRIC_SWITCHES | RSA_ASYMMETRIC_KEYS
  Tipo da chave.
- password: string
  Senha da chave. Mínimo de $constants.P8_IMPORT_EXPORT_SECRET_MIN_LEN caracteres, máximo de $constants.P8_IMPORT_EXPORT_SECRET_MAX_LEN caracteres.
- p8: string
  Dados da chave no formato PKCS#8 (base64).
- Optionalexportable: boolean
  Se a chave será exportável.
- Optionaltemporary: boolean
  Se a chave será temporária.
- Optionalblockchain: 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>
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.

exportPKCS8

exportPKCS8(name, password): Promise<Buffer>
Exporta uma chave PKCS#8 do HSM.
Parameters
- name: string
  Nome da chave. Mínimo de $constants.P8_IMPORT_EXPORT_SECRET_MIN_LEN caracteres, máximo de $constants.P8_IMPORT_EXPORT_SECRET_MAX_LEN caracteres.
- password: string
  Senha da chave.
Returns Promise<Buffer>
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.

Interface Key

Index

Methods

Methods

create

Parameters

Returns Promise<boolean>

Throws

Throws

See

delete

Parameters

Returns Promise<boolean>

Throws

Throws

See

block

Parameters

Returns Promise<boolean>

Throws

Throws

See

unblock

Parameters

Returns Promise<boolean>

Throws

Throws

See

import

Parameters

Returns Promise<boolean>

Throws

Throws

See

importCertificate

Parameters

Returns Promise<boolean>

Throws

Throws

See

generatePKCS10

Parameters

Returns Promise<Buffer>

Throws

See

exportAsymmetricPub

Parameters

Returns Promise<Buffer>

Throws

Throws

See

exportAsymmetricPriv

Parameters

Returns Promise<Buffer>

Throws

Throws

See

exportSymmetric

Parameters

Returns Promise<Buffer>

Throws

Throws

See

exportCertClearText

Parameters

Returns Promise<Buffer>

Throws

Throws

See

importKekWrap

Parameters

Returns Promise<boolean>

Throws

Throws

See

exportKekWrap

Parameters

Returns Promise<Buffer>

Throws

Throws