Estas funciones permiten que el usuario pueda configurar un script de firmado electrónico de documentos.


Notas:

  • Si se utiliza un archivo que ya viene codificado con PEM, favor de utilizar la función fileGetContents para obtener la llave/certificado correspondiente.

 

 

Get file contents

Obtiene la representación del contenido del archivo para manipulación de este. 

Sintaxis:

fileGetContents(<campo_documento>)

Regresa el contenido del archivo indicado en el Campo.


DER to PEM key converter

Convierte una llave con codificación DER a codificación PEM. Regresa la llave con codificación PEM.

Sintaxis:

derToPemKey(<campo_documento>)


Ejemplo:


 

Regresa la llave con codificación PEM

DER to PEM certificate converter

Convierte un certificado con codificación DER a codificación PEM. 

Recibe como parámetro un campo tipo file o una cadena de texto con codificación DER.

Sintaxis:

derToPemCertificate(<campo_document>)

Ejemplo:

Regresa el certificado con codificación PEM.

Get private key

Analiza una llave dada y la prepara para ser usada por otras funciones criptográficasRecibe como parámetros una cadena de llave privada con codificación PEM, y la contraseña del archivo de llave.

Sintaxis:

getPrivateKey(<contenido_de_llave>, <clave_secreta_de_llave >)

 Regresa valor booleano falso (false) en caso de error, identificador de llave en caso de éxito.

Generate signature

Calcula una firma para el contenido especificado generando un certificado criptográfico digital utilizando el identificador asociado que se le proporciona. 

Recibe como parámetros un texto a codificar y un identificador de recurso de llave privada, generado por la función getPrivateKey.

Sintaxis:

signData(<Contenido_a_firmar>, <identificador_de_llave>)

Regresa el sello binario correspondiente al contenido dado.

Release key resource

Libera un recurso de llave, asociado a un identificador.

Recibe como parámetro un identificador de recurso generado por la función getPublicKey o getPrivateKey.

Sintaxis:

releaseKey (<identificador_del_recurso>)


Regresa N/A, función vacía.

Base64 encode

Codifica el contenido proporcionado con codificación tipo Base64.

Sintaxis:

base64Encode(<contenido_a_codificar>)


Regresa el contenido codificado con algoritmo Base64.


Ejemplo:


Base64 decode

Codifica el contenido proporcionado con codificación tipo Base64.

Sintaxis:

base64Decode(<contenido_a_codificar>)

Regresa el contenido plano, decodificado con algoritmo Base64.

Get certificate data

Obtiene el contenido de un certificado estándar x.509 dado (codificación PEM).

Recibe como parámetro un campo file con un certificado o una cadena de texto con codificación PEM.

Sintaxis:

getCertificateData(<campo file>)

Regresa la matriz de valores del contenido del certificado proporcionado.

Get certificate identifier

Analiza un certificado (estándar x.509) y genera un identificador para el recurso.

Recibe como parámetro una cadena de texto con codificación PEM o un campo file con un certificado en la misma codificación.

Sintaxis:

getCertificate(<certificado>)

Regresa el identificador de recurso asociado al certificado.

Get public key

Extrae la llave publica de un certificado y lo prepara para su uso. El parámetro de entrada de esta función puede ser alguno de los siguientes:

Recurso como representación de un certificado (identificador).

Ruta del certificado (valor de un input file/document que contenga al certificado, con codificación PEM).

Una llave publica codificada con formato PEM

Sintaxis:

getPublicKey(<certificado>)

Regresa el valor booleano falso (false) en caso de error, identificador de recurso en caso de éxito.

Verify signature

Verifica que una firma corresponda al contenido proporcionado.

Sintaxis:

verifySignature(<contenido>, <firma_digital>, <identificador_llave_publica>)

Regresa el valor numérico, 1 (uno) en caso de que la firma y el contenido correspondan, 0 (cero) en caso de que no correspondan y -1 (1 negativo) en caso de error.

Release certificate

Libera el recurso de certificado asociado al identificador.

Sintaxis:

releaseCertificate(<identificador_de_certificado>)

Ejemplo:

Regresa N/A, función vacía.