Interface Key

Hierarchy

Index

Methods

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

Methods

block

block(name: string): Promise<boolean>
Description
Locks a key in the HSM.

Returns
Returns true if the key was successfully locked.

Throws
If the key name is invalid.

Throws
In the event of an error when deleting the key.
Parameters
- name: string
  
  Key name.
Returns Promise<boolean>

create

create(name: string, algorithm: ECC_ASYMMETRIC_SWITCHES | SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | ECX_ASYMMETRIC_SWITCHES | HMAC_KEYS | ALT_BN128, exportable?: booleantemporary?: boolean, blockchain?: boolean): Promise<boolean>
Description
Creates and stores a cryptographic key associated with an algorithm according to the parameters entered, within the HSM.

Returns
Returns true if the key was created successfully.

Throws
If the key name is invalid.

Throws
In the event of an error when creating the key.
Parameters
- name: string
  
  Key name.
- algorithm: ECC_ASYMMETRIC_SWITCHES | SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | ECX_ASYMMETRIC_SWITCHES | HMAC_KEYS | ALT_BN128
  
  Key algorithm.
- Optional exportable: boolean
  
  If the key is exportable.
- Optional temporary: boolean
  
  If the key is temporary.
- Optional blockchain: boolean
  Whether the key can be used in blockchain operations.
  
  ATTENTION: Only a few keys will be allowed if blockchain be informed:
Returns Promise<boolean>

delete

delete(name: string): Promise<boolean>
Description
Deletes a key stored in the HSM.

Returns
Returns true if the key was successfully deleted.

Throws
If the key name is invalid.

Throws
In the event of an error when deleting the key.
Parameters
- name: string
  
  Key name.
Returns Promise<boolean>

exportAsymmetricPrivate

exportAsymmetricPrivate(name: string): Promise<Buffer>
Description
Exports the private part of the asymmetric key stored in the HSM.

Returns
Buffer containing the key data according to the KEY_EXPORT_FORMAT format.

Throws
If the key name is invalid.

Throws
If an error occurs when importing the key.
Parameters
- name: string
  
  Key name.
Returns Promise<Buffer>

exportAsymmetricPub

exportAsymmetricPub(name: string, x509: boolean): Promise<Buffer>
Description
Exports a cryptographic key stored in the HSM.

Returns
Buffer containing the key data according to the KEY_EXPORT_FORMAT format.

Throws
If the key name is invalid.

Throws
If an error occurs when importing the key.
Parameters
- name: string
  
  Key name.
- x509: boolean
  
  Whether the key will be exported in X509 format.
Returns Promise<Buffer>

exportCertClearText

exportCertClearText(name: string): Promise<Buffer>
Description
Exports the certificate stored in the HSM in clear text.

Returns
Buffer containing the certificate.

Throws
If the key name is invalid.

Throws
If an error occurs when importing the key.
Parameters
- name: string
  
  Key name.
Returns Promise<Buffer>

exportKekWrap

exportKekWrap(mode: KEK_MODE | UNUSED_MODE, pad: KEK_WRAP_PADDING, name: string, kekKeyName: string, iv?: string): Promise<Buffer>
Description
Exports a key encrypted by a KEK (Key Encryption Key).

Returns
Buffer containing the key data according to the KEY_EXPORT_FORMAT format.

Throws
If the key name is invalid.

Throws
If an error occurs when importing the key.
Parameters
- mode: KEK_MODE | UNUSED_MODE
  
  Operating mode for importing the key.
- pad: KEK_WRAP_PADDING
  
  Padding option for KEK operation.
- name: string
  
  Key name.
- kekKeyName: string
  
  Name of the Key Encryption Key (KEK) that will be used to decrypt the imported key.
- Optional iv: string
  
  Initialization Vector. Required for MODE_CBC mode.
Returns Promise<Buffer>

exportPKCS8

exportPKCS8(name: string, password: string): Promise<Buffer>
Description
Exports a PKCS#8 key from the HSM.

Returns
Returns a buffer containing the key data.

Throws
If the key name is invalid.

Throws
If the key password does not meet the minimum requirements.

Throws
If an error occurs when importing the key.
Parameters
- name: string
  
  Key name. Minimum $P8_IMPORT_EXPORT_SECRET_MIN_LEN characters, maximum $P8_IMPORT_EXPORT_SECRET_MAX_LEN characters.
- password: string
  
  Key password.
Returns Promise<Buffer>

exportSymmetric

exportSymmetric(name: string): Promise<Buffer>
Description
Exports the private key stored in the HSM in clear text.

Returns
Buffer containing the key data according to the KEY_EXPORT_FORMAT format.

Throws
If the key name is invalid.

Throws
If an error occurs when importing the key.
Parameters
- name: string
  
  Key name.
Returns Promise<Buffer>

generatePKCS10

generatePKCS10(keyName: string, dn: X500DistinguishedName, hashAlgorith?: PKCS10_HASH_ALGORITHM): Promise<Buffer>
Description
Generates a CSR (Certificate Signing Request).
This is a specialized function of HSM's PKCS#10 CSR generation API.

Returns
Returns the CSR in DER format.

Throws
If the key name is invalid.
Parameters
- keyName: string
  
  Key name.
- dn: X500DistinguishedName
  
  Certificate data.
- Optional hashAlgorith: PKCS10_HASH_ALGORITHM
  
  Hash algorithm to be used to generate the CSR. If not provided, the standard HSM algorithm will be used.
Returns Promise<Buffer>

import

import(name: string, algorithm: SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | HMAC_KEYS | ALT_BN128, date: Buffer, exportable?: booleantemporary?: boolean, blockchain?: boolean): Promise<boolean>
Description
Import a cryptographic key into the HSM.

Returns
Returns true if the key was imported successfully

Throws
If the key name is invalid.

Throws
If an error occurs when importing the key.
Parameters
- name: string
  
  Key name.
- algorithm: SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | HMAC_KEYS | ALT_BN128
  
  Key algorithm. Same algorithm used to create the key using the create function
- date: Buffer
  
  Data of the key to be imported.
- Optional exportable: boolean
  
  If the key is exportable.
- Optional temporary: boolean
  
  If the key is temporary.
- Optional blockchain: boolean
  
  Whether the key can be used in blockchain operations.
Returns Promise<boolean>

importCertificate

importCertificate(name: string, certData: Buffer): Promise<boolean>
Description
Import a certificate into HSM.

Returns
Returns true if the certificate was imported successfully.

Throws
If the name of the certificate is invalid.

Throws
In the event of an error when importing the certificate.
Parameters
- name: string
  
  Name of certificate.
- certData: Buffer
  
  Certificate to be imported.
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, date: Buffer, iv?: string, exportable?: booleantemporary?: boolean, blockchain?: boolean): Promise<boolean>
Description
Import a key encrypted by a KEK (Key Encryption Key).

Returns
Returns true if the key has been imported.

Throws
If the key name is invalid.

Throws
If an error occurs when importing the key.
Parameters
- mode: KEK_MODE | UNUSED_MODE
  
  Operating mode for importing the key.
- pad: KEK_WRAP_PADDING
  
  Padding option for KEK operation.
- name: string
  
  Key name.
- kekKeyName: string
  
  Name of the Key Encryption Key (KEK) that will be used to decrypt the imported key.
- objType: ECC_ASYMMETRIC_SWITCHES | SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | ECX_ASYMMETRIC_SWITCHES
  
  Object type.
- date: Buffer
  
  Buffer containing the data of the encrypted key to be imported.
- Optional iv: string
  
  Initialization Vector. Required for MODE_CBC mode.
- Optional exportable: boolean
  
  If the key is exportable.
- Optional temporary: boolean
  
  If the key is temporary.
- Optional blockchain: boolean
  
  Whether the key can be used in blockchain operations.
Returns Promise<boolean>

importPKCS8

importPKCS8(name: string, keyType: ECC_ASYMMETRIC_SWITCHES | RSA_ASYMMETRIC_KEYS, password: string, p8: string, exportable?: booleantemporary?: boolean, blockchain?: boolean): Promise<boolean>
Description
Import a PKCS#8 key for the HSM.

Returns
Returns true if the key was imported successfully.

Throws
If the key name is invalid.

Throws
If the key password does not meet the minimum requirements.

Throws
If an error occurs when importing the key.
Parameters
- name: string
  
  Key name.
- keyType: ECC_ASYMMETRIC_SWITCHES | RSA_ASYMMETRIC_KEYS
  
  Key type.
- password: string
  
  Key password. Minimum $P8_IMPORT_EXPORT_SECRET_MIN_LEN characters, maximum $P8_IMPORT_EXPORT_SECRET_MAX_LEN characters.
- p8: string
  
  Key data in PKCS#8 format (base64).
- Optional exportable: boolean
  
  If the key is exportable.
- Optional temporary: boolean
  
  If the key is temporary.
- Optional blockchain: boolean
  Whether the key can be used in blockchain operations.
  
  ATTENTION: Only a few keys will be allowed if blockchain be informed:
Returns Promise<boolean>

unblock

unblock(name: string): Promise<boolean>
Description
Unlocks a key in the HSM.

Returns
Returns true if the key was successfully unlocked.

Throws
If the key name is invalid.

Throws
In the event of an error when deleting the key.
Parameters
- name: string
  
  Key name.
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>

exportAsymmetricPrivate

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