Jerarquía

  • Clave

Métodos

  • 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

    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

    Exporta la parte privada de la clave asimétrica almacenada en el HSM.

    Devuelve

    Memoria intermedia que contiene los datos de la clave según el formato KEY_EXPORT_FORMAT.

    Lanza

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

    Lanza

    Si se produce un error al importar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    Returns Promise<Buffer>

  • Descripción

    Exporta una clave criptográfica almacenada en el HSM.

    Devuelve

    Memoria intermedia que contiene los datos de la clave según el formato KEY_EXPORT_FORMAT.

    Lanza

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

    Lanza

    Si se produce un error al importar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    • x509: booleano

      Si la clave se exportará en formato X509.

    Returns Promise<Buffer>

  • Descripción

    Exporta el certificado almacenado en el HSM en texto plano.

    Devuelve

    Buffer que contiene el certificado.

    Lanza

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

    Lanza

    Si se produce un error al importar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    Returns Promise<Buffer>

  • Descripción

    Exporta una clave cifrada por una KEK (Key Encryption Key).

    Devuelve

    Memoria intermedia que contiene los datos de la clave según el formato KEY_EXPORT_FORMAT.

    Lanza

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

    Lanza

    Si se produce un error al importar la clave.

    Parámetros

    • mode: KEK_MODE | UNUSED_MODE

      Modo de funcionamiento para importar la llave.

    • pad: KEK_WRAP_PADDING

      Opción de relleno para el funcionamiento KEK.

    • nombre: cadena

      Nombre clave.

    • kekKeyName: cadena

      Nombre de la clave de cifrado (KEK) que se utilizará para descifrar la clave importada.

    • Opcional iv: cadena

      Vector de inicialización. Necesario para el modo MODE_CBC.

    Returns Promise<Buffer>

  • Descripción

    Exporta una clave PKCS#8 desde el HSM.

    Devuelve

    Devuelve un búfer que contiene los datos de la clave.

    Lanza

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

    Lanza

    Si la contraseña clave no cumple los requisitos mínimos.

    Lanza

    Si se produce un error al importar la clave.

    Parámetros

    Returns Promise<Buffer>

  • Descripción

    Exporta la clave privada almacenada en el HSM en texto claro.

    Devuelve

    Memoria intermedia que contiene los datos de la clave según el formato KEY_EXPORT_FORMAT.

    Lanza

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

    Lanza

    Si se produce un error al importar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    Returns Promise<Buffer>

  • Descripción

    Genera una CSR (solicitud de firma de certificado).
    Se trata de una función especializada de la API de generación de CSR PKCS#10 de HSM.

    Devuelve

    Devuelve el CSR en formato DER.

    Lanza

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

    Parámetros

    • keyName: cadena

      Nombre clave.

    • dn: X500NombreDistinguido

      Datos del certificado.

    • Opcional hashAlgorith: ALGORITMO_HASH_PKCS10

      Algoritmo hash que se utilizará para generar la CSR. Si no se proporciona, se utilizará el algoritmo HSM estándar.

    Returns Promise<Buffer>

  • Descripción

    Importar una clave criptográfica en el HSM.

    Devuelve

    Devuelve true si la clave se ha importado correctamente

    Lanza

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

    Lanza

    Si se produce un error al importar la clave.

    Parámetros

    • nombre: cadena

      Nombre clave.

    • algoritmo: SYMMETRICAL_KEYS | RSA_ASYMMETRIC_KEYS | HMAC_KEYS | ALT_BN128

      Algoritmo de la clave. El mismo algoritmo utilizado para crear la clave mediante la función create.

    • fecha: Buffer

      Datos de la clave que se va a importar.

    • Opcional exportable: booleano

      Si la clave es exportable.

    • Opcional temporal: booleano

      Si la llave es temporal.

    • Opcional blockchain: booleano

      Si la clave puede utilizarse en operaciones de blockchain.

    Returns Promise<boolean>

  • Descripción

    Importar un certificado en HSM.

    Devuelve

    Devuelve true si el certificado se ha importado correctamente.

    Lanza

    Si el nombre del certificado no es válido.

    Lanza

    En caso de error al importar el certificado.

    Parámetros

    • nombre: cadena

      Nombre del certificado.

    • certData: Buffer

      Certificado a importar.

    Returns Promise<boolean>

  • Descripción

    Importe una clave PKCS#8 para el HSM.

    Devuelve

    Devuelve true si la clave se ha importado correctamente.

    Lanza

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

    Lanza

    Si la contraseña clave no cumple los requisitos mínimos.

    Lanza

    Si se produce un error al importar la clave.

    Parámetros

    Returns Promise<boolean>

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