Interface Blockchain

Hierarchy

Blockchain

Methods

abn128PscMult

abn128PscMult(keyName: string, x: string | Buffer, y: string | Buffer, neg?: boolean): Promise<Buffer>
Description
Multiplica um escalar pela chave privada.

Returns
Retorna um buffer com o ponto calculado.

Throws
Caso algum parâmetro informado seja invalido.

Throws
InvalidParameterError Caso algum parâmetro informado seja invalido.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- keyName: string
  
  Nome da chave que será usada para a operação.
- x: string | Buffer
  
  Ponto X que pode ser um buffer de ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de ABN128_XY_HEX_LEN caracteres.
- y: string | Buffer
  
  Ponto Y que pode ser um buffer de ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de ABN128_XY_HEX_LEN caracteres.
- Optional neg: boolean
  
  Se a chave privada deve ser negativada.
Returns Promise<Buffer>

abn128RndCtxGetPt

abn128RndCtxGetPt(x: string | Buffer, y: string | Buffer): Promise<Buffer>
Description
Calcula um ponto a partir de outro ponto e um contexto randómico.

Returns
Retorna um buffer com o ponto calculado.

Throws
Caso algum parâmetro informado seja invalido.

Throws
InvalidParameterError Caso algum parâmetro informado seja invalido.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- x: string | Buffer
  
  Ponto X que pode ser um buffer de ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de ABN128_XY_HEX_LEN caracteres.
- y: string | Buffer
  
  Ponto Y que pode ser um buffer de ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de ABN128_XY_HEX_LEN caracteres.
Returns Promise<Buffer>

abn128RndCtxMultAdd

abn128RndCtxMultAdd(keyName: string, scalar: string | Buffer): Promise<Buffer>
Description
Multiplica um escalar pela chave privada e soma um escalar randômico.

Returns
Retorna um buffer com o resultado da operação.

Throws
Caso o nome da chave seja inválido.

Throws
InvalidParameterError Caso algum parâmetro informado seja invalido.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- keyName: string
  
  Nome da chave que será usada para a operação.
- scalar: string | Buffer
  
  Escalar que pode ser um buffer de ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de ABN128_XY_HEX_LEN caracteres.
Returns Promise<Buffer>

abn128RndCtxRefresh

abn128RndCtxRefresh(x: string | Buffer, y: string | Buffer): Promise<Buffer>
Description
Atualiza o contexto randômico.

Returns
Retorna um buffer com o ponto calculado.

Throws
Caso algum parâmetro informado seja invalido.

Throws
InvalidParameterError Caso algum parâmetro informado seja invalido.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- x: string | Buffer
  
  Ponto X que pode ser um buffer de ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de ABN128_XY_HEX_LEN caracteres.
- y: string | Buffer
  
  Ponto Y que pode ser um buffer de ABN128_XY_BUFF_LEN bytes ou uma string hexadecimal de ABN128_XY_HEX_LEN caracteres.
Returns Promise<Buffer>

abn128RndSc

abn128RndSc(): Promise<Buffer>
Description
Retrona um escalar randômico.

Returns
Retorna um buffer com o escalare randômico.

Throws
HsmError Caso ocorra algum erro na operação.

Returns Promise<Buffer>

abn128RndScs

abn128RndScs(): Promise<Buffer[]>
Description
Retrona quatro escalares randômicos.

Returns
Retorna um array de bufferes com os escalares randômicos.

Throws
HsmError Caso ocorra algum erro na operação.

Returns Promise<Buffer[]>

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, type: BLOCKCHAIN_KEYS, exportable: boolean, temporary: boolean, version?: null | VERSION_OPTIONS, seed?: null | string, passphrase?: null | string): Promise<boolean>
Description
Cria uma chave Extended Private Key (XPrv) para a blockchain no padrão BIP32.

Returns
Chave criada.

Throws
HsmError Caso não seja possível criar a chave ou ocorra algum erro na operação.
Parameters
- name: string
  
  Nome da chave no HSM.
- type: BLOCKCHAIN_KEYS
  
  Tipo de geração da chave.
- exportable: boolean
  
  Se a chave será exportável.
- temporary: boolean
  
  Se a chave será temporária.
- Optional version: null | VERSION_OPTIONS
  
  Versão da chave que deve ser passado de acordo com a opção do tipo
- Optional seed: null | string
  
  Buffer contendo os dados necessários para a geração da chave. Os dados de entrada devem ser passados de acordo com a opção do type de BLOCKCHAIN_KEYS.
- Optional passphrase: null | string
Returns Promise<boolean>

createBip32ChildKeyDerivation

createBip32ChildKeyDerivation(version: VERSION_OPTIONS, index: number, exportable: boolean, temporary: boolean, parentKeyName: string, childKeyName: string): Promise<KeyInfo>
Description
Faz uma operação de Child Key Derivation (CKD). Deriva uma chave Extended Private Key (XPrv) para a blockchain no padrão BIP32.

Returns
Informações da chave derivada.

Throws
HsmError Caso não seja possível derivar a chave ou ocorra algum erro na operação.
Parameters
- version: VERSION_OPTIONS
  
  Versão da chave.
- index: number
  
  Índice da chave que será derivada. Chaves non hardened usam índice de 0 a 2³¹-1 e chaves hardened (irrestritamente seguras) usam índices de 2³¹ a 2³²-1, como especificado no padrão BIP32. É altamente recomendado gerar chaves hardened.
- exportable: boolean
  
  Se a chave será exportável.
- temporary: boolean
  
  Se a chave será temporária.
- parentKeyName: string
  
  Nome da chave pai no HSM. Deve ser uma chave XPrv.
- childKeyName: string
  
  Nome da chave que será derivada no HSM.
Returns Promise<KeyInfo>

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>
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>

edDsaSign

edDsaSign(type: BLOCKCHAIN_EdDSA_TYPE, privKeyName: string, data: Buffer): Promise<Buffer>
Description
Gera uma assinatura EdDSA usando o módulo blockchain.

Returns
Assinatura gerada.

Throws
HsmError Caso não seja possível assinar os dados ou ocorra algum erro na operação.
Parameters
- type: BLOCKCHAIN_EdDSA_TYPE
  
  Tipo da assinatura a ser gerada.
- privKeyName: string
  
  Nome da chave privada.
- data: Buffer
  
  Dados que serão assinados.
Returns Promise<Buffer>

edDsaVerify

edDsaVerify(type: BLOCKCHAIN_EdDSA_TYPE, pubKeyType: BLOCKCHAIN_PUB_KEY_TYPE, pubKey: Buffer, signature: Buffer, data: Buffer): Promise<boolean>
Description
Verifica uma assinatura EdDSA usando o módulo blockchain.

Returns
True se a assinatura for válida, false caso contrário.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- type: BLOCKCHAIN_EdDSA_TYPE
  
  Tipo da assinatura a ser verificada.
- pubKeyType: BLOCKCHAIN_PUB_KEY_TYPE
  
  Tipo da chave pública.
- pubKey: Buffer
  
  Chave pública. Deve ser uma chave pública válida retornada pelo método Blockchain.getPubKey.
- signature: Buffer
  
  Assinatura a ser verificada. Deve ser uma assinatura válida retornada pelo método Blockchain.edDsaSign.
- data: Buffer
  
  Dados que foram assinados. Deve ser uma hash válida retornada pelo método Blockchain.hashData.
Returns Promise<boolean>

export

export(format: IMPORT_EXPORT_FORMAT, version: BLOCKCHAIN_EXPORT_VERSION, compressed: boolean, name: string): Promise<Buffer>
Description
Exporta uma chave privada usando o módulo blockchain.

Returns
Buffer com a chave privada.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- format: IMPORT_EXPORT_FORMAT
  
  Formato da chave a ser exportada.
- version: BLOCKCHAIN_EXPORT_VERSION
  
  Versão da chave.
- compressed: boolean
  
  Se a chave deve ser retornada comprimida.
- name: string
  
  Nome da chave privada.
Returns Promise<Buffer>

getAddress

getAddress(type: ADDRESS_TYPE, version: ADDRESS_VERSION, hrp: ADDRESS_HRP, pk: string): Promise<Buffer>
Description
Recupera o endereço de uma chave usando o módulo blockchain.

Returns
Retorna o endereço.

Throws
HsmError Caso não seja possível recuperar o endereço ou ocorra algum erro na operação.
Parameters
- type: ADDRESS_TYPE
  
  Tipo do endereço a ser gerado.
- version: ADDRESS_VERSION
  
  Versão do endereço.
- hrp: ADDRESS_HRP
  
  HRP (Human Readable Part) da chave.
- pk: string
  
  Chave privada da qual será gerado o endereço ou o script-hash.
Returns Promise<Buffer>

getKeyInfo

getKeyInfo(name: string): Promise<KeyInfo>
Description
Recupera as propriedades de uma chave usando o módulo blockchain.

Returns
Retorna um objeto com os dados de blockchain da chave.

Throws
HsmError Caso não seja possível recuperar o endereço ou ocorra algum erro na operação.
Parameters
- name: string
  
  Nome da chave privada.
Returns Promise<KeyInfo>

getPubKey

getPubKey(type: BLOCKCHAIN_GET_PUB_KEY_TYPE, privKeyName: string): Promise<Buffer>
Description
Recupera uma chave pública a partir de uma chave privada usando o módulo blockchain.

Returns
Chave pública.

Throws
HsmError Caso a chave privada não seja encontrada ou ocorra algum erro na operação.
Parameters
- type: BLOCKCHAIN_GET_PUB_KEY_TYPE
  
  Formato da chave pública a ser exportada.
- privKeyName: string
  
  Nome da chave privada.
Returns Promise<Buffer>

hashData

hashData(hashMode: BLOCKCHAIN_HASH_MODE, data: Buffer): Promise<Buffer>
Desscription
Calcula um hash usando o módulo blockchain.

Returns
Hash calculado.

Throws
HsmError Caso não seja possível calcular o hash ou ocorra algum erro na operação.
Parameters
- hashMode: BLOCKCHAIN_HASH_MODE
  
  Modo do hash.
- data: Buffer
  
  Dados que serão processados. Tamanho máximo de BLOCKCHAIN_MAX_DATA_LEN.
Returns Promise<Buffer>

import

import(format: IMPORT_EXPORT_FORMAT, exportable: boolean, temporary: boolean, name: string, data: string): Promise<boolean>
Description
Importa uma chave privada usando o módulo blockchain_interfaces.

Returns
True se a importação foi efetuada ou uma exceção caso o contrário.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- format: IMPORT_EXPORT_FORMAT
  
  Formato da chave a ser importada.
- exportable: boolean
  
  Se a chave será exportável.
- temporary: boolean
  
  Se a chave será temporária.
- name: string
  
  Nome da chave privada.
- data: string
  
  Chave privada no formato especificado em IMPORT_EXPORT_FORMAT.
Returns Promise<boolean>

pubKeyRecovery

pubKeyRecovery(sigType: BLOCKCHAIN_SIG_TYPE, hashMode: BLOCKCHAIN_HASH_MODE, hashData: Buffer, signature: Buffer): Promise<Buffer>
Description
Recupera uma chave pública (PBK) a partir de uma assinatura do tipo ECDSA.

Returns
Retorna um buffer com a chave pública.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- sigType: BLOCKCHAIN_SIG_TYPE
  
  Tipo da assinatura a ser gerada.
- hashMode: BLOCKCHAIN_HASH_MODE
  
  Modo do hash.
- hashData: Buffer
  
  Hash calculado conforme o informado em hashData.
- signature: Buffer
  
  Assinatura conforme o informado em sigType (BLOCKCHAIN_SIG_TYPE).
Returns Promise<Buffer>

sign

sign(type: BLOCKCHAIN_SIG_TYPE, hashMode: BLOCKCHAIN_HASH_MODE, hash: Buffer, pk: string): Promise<Buffer>
Description
Assina um hash usando o módulo blockchain.

Throws
HsmError Caso não seja possível assinar os dados ou ocorra algum erro na operação.
Parameters
- type: BLOCKCHAIN_SIG_TYPE
  
  Tipo da assinatura a ser realizada.
- hashMode: BLOCKCHAIN_HASH_MODE
  
  Modo do hash.
- hash: Buffer
  
  Hash calculado de acordo com o informado em hashMode (BLOCKCHAIN_HASH_MODE).
- pk: string
  
  Nome da chave privada.
Returns Promise<Buffer>

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>

verify

verify(sigType: BLOCKCHAIN_SIG_TYPE, hashMode: BLOCKCHAIN_HASH_MODE, hashData: Buffer, signature: Buffer, pubKeyType: BLOCKCHAIN_SIG_VERIFY_PUB_KEY_TYPE, pubSignature: Buffer): Promise<boolean>
Description
Verifica uma assinatura usando o módulo blockchain.

Returns
True se a assinatura for válida, false caso contrário.

Throws
HsmError Caso ocorra algum erro na operação.
Parameters
- sigType: BLOCKCHAIN_SIG_TYPE
  
  Tipo da assinatura que foi realizada.
- hashMode: BLOCKCHAIN_HASH_MODE
  
  Modo do hash.
- hashData: Buffer
  
  Hash calculado conforme o informado em hashData.
- signature: Buffer
  
  Assinatura conforme o informado em sigType (BLOCKCHAIN_SIG_TYPE).
- pubKeyType: BLOCKCHAIN_SIG_VERIFY_PUB_KEY_TYPE
  
  Tipo da chave pública.
- pubSignature: Buffer
  
  Chave pública conforme o informado em pubKeyType.
Returns Promise<boolean>

Interface Blockchain

Hierarchy

Index

Methods

Methods

abn128PscMult

Description

Returns

Throws

Throws

Throws

Parameters

keyName: string

x: string | Buffer

y: string | Buffer

Optional neg: boolean

Returns Promise<Buffer>

abn128RndCtxGetPt

Description

Returns

Throws

Throws

Throws

Parameters

x: string | Buffer

y: string | Buffer

Returns Promise<Buffer>

abn128RndCtxMultAdd

Description

Returns

Throws

Throws

Throws

Parameters

keyName: string

scalar: string | Buffer

Returns Promise<Buffer>

abn128RndCtxRefresh

Description

Returns

Throws

Throws

Throws

Parameters

x: string | Buffer

y: string | Buffer

Returns Promise<Buffer>

abn128RndSc

Description

Returns

Throws

Returns Promise<Buffer>

abn128RndScs

Description

Returns

Throws

Returns Promise<Buffer[]>

block

Description

Returns

Throws

Throws

Parameters

name: string

Returns Promise<boolean>

create

Description

Returns

Throws

Parameters

name: string

type: BLOCKCHAIN_KEYS

exportable: boolean

temporary: boolean

Optional version: null | VERSION_OPTIONS

Optional seed: null | string

Optional passphrase: null | string

Returns Promise<boolean>

createBip32ChildKeyDerivation

Description

`Optional` neg: boolean

`Optional` version: null | VERSION_OPTIONS

`Optional` seed: null | string

`Optional` passphrase: null | string