Jerarquía

  • Blockchain

Métodos

  • Descripción

    Multiplica un escalar por la clave privada.

    Devuelve

    Devuelve un buffer con el punto calculado.

    Lanza

    Si alguno de los parámetros introducidos no es válido.

    Lanza

    InvalidParameterError Si algún parámetro introducido no es válido.

    Lanza

    HsmError Si se produce un error en la operación.

    Parámetros

    • keyName: cadena

      Nombre de la clave que se utilizará para la operación.

    • x: cadena | Buffer

      Punto X que puede ser un búfer de bytes ABN128_XY_BUFF_LEN o una cadena hexadecimal de caracteres ABN128_XY_HEX_LEN.

    • y: cadena | Buffer

      Punto Y que puede ser un búfer de bytes ABN128_XY_BUFF_LEN o una cadena hexadecimal de caracteres ABN128_XY_HEX_LEN.

    • Opcional neg: booleano

      Si la clave privada debe ser negada.

    Returns Promise<Buffer>

  • Descripción

    Calcula un punto a partir de otro punto y un contexto aleatorio.

    Devuelve

    Devuelve un buffer con el punto calculado.

    Lanza

    Si alguno de los parámetros introducidos no es válido.

    Lanza

    InvalidParameterError Si algún parámetro introducido no es válido.

    Lanza

    HsmError Si se produce un error en la operación.

    Parámetros

    Returns Promise<Buffer>

  • Descripción

    Multiplica un escalar por la clave privada y añade un escalar aleatorio.

    Devuelve

    Devuelve un buffer con el resultado de la operación.

    Lanza

    Si el nombre de la clave no es válido.

    Lanza

    InvalidParameterError Si algún parámetro introducido no es válido.

    Lanza

    HsmError Si se produce un error en la operación.

    Parámetros

    • keyName: cadena

      Nombre de la clave que se utilizará para la operación.

    • escalar: cadena | Buffer

      Escalar que puede ser un búfer de bytes ABN128_XY_BUFF_LEN o una cadena hexadecimal de caracteres ABN128_XY_HEX_LEN.

    Returns Promise<Buffer>

  • Descripción

    Actualiza el contexto aleatorio.

    Devuelve

    Devuelve un buffer con el punto calculado.

    Lanza

    Si alguno de los parámetros introducidos no es válido.

    Lanza

    InvalidParameterError Si algún parámetro introducido no es válido.

    Lanza

    HsmError Si se produce un error en la operación.

    Parámetros

    Returns Promise<Buffer>

  • Descripción

    Devuelve un escalar aleatorio.

    Devuelve

    Devuelve un buffer con el escalar aleatorio.

    Lanza

    HsmError Si se produce un error en la operación.

    Returns Promise<Buffer>

  • Descripción

    Devuelve cuatro escalares aleatorios.

    Devuelve

    Devuelve un array de buffers con escalares aleatorios.

    Lanza

    HsmError Si se produce un error en la operación.

    Returns Promise<Buffer[]>

  • Descripción

    Bloquea una llave en el HSM.

    Devuelve

    Devuelve true si la llave se ha bloqueado correctamente.

    Lanza

    Si el nombre de la clave no es válido.

    Lanza

    En caso de error al borrar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    Returns Promise<boolean>

  • Descripción

    Crea una clave privada extendida (XPrv) para el blockchain en el estándar BIP32.

    Devuelve

    Clave creada.

    Lanza

    HsmError Si no se puede crear la clave o se produce un error en la operación.

    Parámetros

    • nombre: cadena

      Nombre de la clave en el HSM.

    • tipo: BLOCKCHAIN_KEYS

      Tipo de generación de claves.

    • exportable: booleano

      Si la clave es exportable.

    • temporal: booleano

      Si la llave es temporal.

    • Opcional versión: null | OPCIONES_VERSION

      Versión de la clave que debe pasarse según la opción de tipo

    • Opcional semilla: null | cadena

      Buffer que contiene los datos necesarios para generar la clave. Los datos de entrada deben pasarse de acuerdo con la opción de tipo BLOCKCHAIN_KEYS.

    • Opcional frase de contraseña: null | cadena

    Returns Promise<boolean>

  • Descripción

    Realiza una operación de Derivación de Clave Hija (CKD). Deriva una clave privada extendida (XPrv) para la cadena de bloques en el estándar BIP32.

    Devuelve

    Información sobre la clave derivada.

    Lanza

    HsmError Si no se puede derivar la clave o se produce un error en la operación.

    Parámetros

    • versión: VERSION_OPTIONS

      Versión clave.

    • índice: número

      Índice de la clave que debe derivarse. Las claves no endurecidas utilizan un índice de 0 a231-1 y las endurecidas (sin restricciones de seguridad) utilizan índices de231 a232-1, tal y como se especifica en el estándar BIP32. Se recomienda encarecidamente generar claves endurecidas.

    • exportable: booleano

      Si la clave es exportable.

    • temporal: booleano

      Si la llave es temporal.

    • parentKeyName: cadena

      Nombre de la clave padre en el HSM. Debe ser una clave XPrv.

    • childKeyName: cadena

      Nombre de la clave que se derivará en el HSM.

    Returns Promise<KeyInfo>

  • Descripción

    Elimina una clave almacenada en el HSM.

    Devuelve

    Devuelve true si la clave se ha eliminado correctamente.

    Lanza

    Si el nombre de la clave no es válido.

    Lanza

    En caso de error al borrar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    Returns Promise<boolean>

  • Descripción

    Elimina una clave almacenada en el HSM.

    Devuelve

    Devuelve true si la clave se ha eliminado correctamente.

    Lanza

    Si el nombre de la clave no es válido.

    Lanza

    En caso de error al borrar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    Returns Promise<boolean>

  • Descripción

    Genera una firma EdDSA utilizando el módulo blockchain.

    Devuelve

    Firma generada.

    Lanza

    HsmError Si no es posible firmar los datos o se produce un error en la operación.

    Parámetros

    • tipo: BLOCKCHAIN_EdDSA_TYPE

      Tipo de firma que se va a generar.

    • privKeyName: cadena

      Nombre de la clave privada.

    • fecha: Buffer

      Datos que se firmarán.

    Returns Promise<Buffer>

  • Descripción

    Verifica una firma EdDSA utilizando el módulo blockchain.

    Devuelve

    True si la firma es válida, false en caso contrario.

    Lanza

    HsmError Si se produce un error en la operación.

    Parámetros

    Returns Promise<boolean>

  • Descripción

    Exporta una clave privada utilizando el módulo blockchain.

    Devuelve

    Buffer con la clave privada.

    Lanza

    HsmError Si se produce un error en la operación.

    Parámetros

    Returns Promise<Buffer>

  • Descripción

    Recupera la dirección de una clave utilizando el módulo blockchain.

    Devuelve

    Devuelve la dirección.

    Lanza

    HsmError Si no se puede recuperar la dirección o se produce un error en la operación.

    Parámetros

    • tipo: ADDRESS_TYPE

      Tipo de dirección a generar.

    • versión: ADDRESS_VERSION

      Versión de la dirección.

    • hrp: DIRECCIÓN_HRP

      HRP (Human Readable Part) de la clave.

    • pk: cadena

      Clave privada a partir de la cual se generará la dirección o script-hash.

    Returns Promise<Buffer>

  • Descripción

    Recupera las propiedades de una clave utilizando el módulo blockchain.

    Devuelve

    Devuelve un objeto con los datos del blockchain de la clave.

    Lanza

    HsmError Si no se puede recuperar la dirección o se produce un error en la operación.

    Parámetros

    • nombre: cadena

      Nombre de la clave privada.

    Returns Promise<KeyInfo>

  • Descripción

    Recuperar una clave pública a partir de una clave privada utilizando el módulo blockchain.

    Devuelve

    Clave pública.

    Lanza

    HsmError Si no se encuentra la clave privada o se produce un error en la operación.

    Parámetros

    Returns Promise<Buffer>

  • Descripción

    Calcula un hash utilizando el módulo blockchain.

    Devuelve

    Hachís calculado.

    Lanza

    HsmError Si no se puede calcular el hash o se produce un error en la operación.

    Parámetros

    Returns Promise<Buffer>

  • Descripción

    Importa una clave privada utilizando el módulo blockchain_interfaces.

    Devuelve

    True si la importación se ha realizado o una excepción en caso contrario.

    Lanza

    HsmError Si se produce un error en la operación.

    Parámetros

    • formato: IMPORT_EXPORT_FORMAT

      Formato de la clave a importar.

    • exportable: booleano

      Si la clave es exportable.

    • temporal: booleano

      Si la llave es temporal.

    • nombre: cadena

      Nombre de la clave privada.

    • fecha: cadena

      Clave privada en el formato especificado en IMPORT_EXPORT_FORMAT.

    Returns Promise<boolean>

  • Descripción

    Recupera una clave pública (PBK) de una firma de tipo ECDSA.

    Devuelve

    Devuelve un buffer con la clave pública.

    Lanza

    HsmError Si se produce un error en la operación.

    Parámetros

    Returns Promise<Buffer>

  • Descripción

    Desbloquea una llave en el HSM.

    Devuelve

    Devuelve true si la llave fue desbloqueada con éxito.

    Lanza

    Si el nombre de la clave no es válido.

    Lanza

    En caso de error al borrar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    Returns Promise<boolean>