CLI

Comandos del CLI

Referencia completa y ejemplos de los comandos data, sign, verify y pfx export de nc-credentials.

A continuación se describen todas las opciones y ejemplos de los cuatro comandos disponibles en nc-credentials.

data (alias info)

Extrae información de un certificado X.509 (.cer, .pem) o archivo .pfx.

Opciones de data

OpciónDescripción
-c, --cer <ruta>Ruta al archivo de certificado (.cer / .pem).
--pfx <ruta>Ruta al archivo .pfx / .p12 (alternativa a --cer).
-p, --password <texto>Contraseña del archivo .pfx.
--password-file <ruta>Archivo con la contraseña del .pfx (o usa NODECFDI_PASSWORD).
-f, --field <campo>Imprime únicamente el valor de un campo específico.
--jsonMuestra toda la información estructurada en formato JSON.
-h, --helpMuestra la ayuda del comando.

Campos válidos para --field: rfc, legal-name, serial-number, serial-number-hex, serial-number-decimal, type, branch-name, valid-from, valid-to, valid, issuer, version, pem, pem-one-line.

Ejemplos de data

# Resumen legible en consola
nc-credentials data --cer CSD01_AAA010101AAA.cer

# Salida completa en formato JSON
nc-credentials data --cer CSD01_AAA010101AAA.cer --json

# Obtener únicamente el RFC o el número de serie de 20 dígitos
nc-credentials data --cer CSD01_AAA010101AAA.cer --field rfc
nc-credentials data --cer CSD01_AAA010101AAA.cer --field serial-number

# Inspeccionar el certificado dentro de un archivo PFX
nc-credentials info --pfx credencial.pfx --password-file password.txt --json

sign

Firma datos provenientes de un argumento de texto, un archivo o la entrada estándar (stdin) usando una llave privada o un archivo .pfx.

Opciones de sign

OpciónDescripción
-k, --key <ruta>Ruta a la llave privada (.key / .pem).
-c, --cer <ruta>Ruta al certificado (.cer / .pem), opcional para validar que forme par con --key.
--pfx <ruta>Ruta al archivo .pfx / .p12 (alternativa a --key).
-p, --password <texto>Contraseña de la llave privada o .pfx.
--password-file <ruta>Archivo con la contraseña (o variable NODECFDI_PASSWORD).
-d, --data <texto>Texto en UTF-8 a firmar.
-f, --file <ruta>Archivo cuyo contenido se firmará byte a byte (si se omiten --data y --file, lee de stdin).
-a, --algorithm <alg>Algoritmo de firma: sha256 (por defecto), sha1, sha384, sha512, md5.
-e, --encoding <enc>Codificación de salida: base64 (por defecto), hex, binary (binary requiere --output).
-o, --output <ruta>Guarda la firma en un archivo con permisos 0600 (si se omite, imprime en stdout).
--forcePermite sobrescribir el archivo indicado en --output.
-h, --helpMuestra la ayuda del comando.

Ejemplos de sign

# Firmar una cadena original validando que el .cer y .key sean pareja (imprime Base64 en stdout)
nc-credentials sign \
  --cer CSD01_AAA010101AAA.cer \
  --key CSD01_AAA010101AAA.key \
  --password-file password.txt \
  --data "||4.0|A|1|2026-01-01T12:00:00||"

# Firmar un archivo y guardar la firma en disco
nc-credentials sign \
  --key CSD01_AAA010101AAA.key \
  --password-file password.txt \
  --file cadena-original.txt \
  --output firma.b64

# Firmar desde stdin usando un archivo PFX y algoritmo sha1 en formato hexadecimal
echo -n "texto a firmar" | nc-credentials sign \
  --pfx credencial.pfx \
  --password-file password.txt \
  --algorithm sha1 \
  --encoding hex

verify

Verifica si una firma corresponde a los datos originales y al certificado, llave pública o archivo .pfx.

Opciones de verify

OpciónDescripción
-c, --cer <ruta>Ruta al certificado (.cer / .pem).
--public-key <ruta>Ruta a la llave pública (.pem).
--pfx <ruta>Ruta al archivo .pfx / .p12.
-p, --password <texto>Contraseña del archivo .pfx.
--password-file <ruta>Archivo con la contraseña del .pfx (o NODECFDI_PASSWORD).
-d, --data <texto>Texto original que fue firmado.
-f, --file <ruta>Archivo con el contenido original (si se omiten --data y --file, lee de stdin).
-s, --signature <firma>Firma a verificar (en base64 o hex).
--signature-file <ruta>Archivo que contiene la firma a verificar.
-a, --algorithm <alg>Algoritmo de firma: sha256 (por defecto), sha1, sha384, sha512, md5.
-e, --encoding <enc>Codificación de la firma: base64 (por defecto), hex, binary (binary requiere --signature-file).
-q, --quietNo imprime mensaje en salida; solo devuelve código de salida (0 válida, 1 inválida).
-h, --helpMuestra la ayuda del comando.

Ejemplos de verify

# Verificar una firma en Base64 contra un certificado y texto directo
nc-credentials verify \
  --cer CSD01_AAA010101AAA.cer \
  --data "||4.0|A|1|2026-01-01T12:00:00||" \
  --signature "<firma-en-base64>"

# Verificar un archivo contra un archivo de firma en modo silencioso (para scripts CI/bash)
nc-credentials verify \
  --cer CSD01_AAA010101AAA.cer \
  --file cadena-original.txt \
  --signature-file firma.b64 \
  --quiet

pfx export

Exporta un certificado y su llave privada a un archivo PFX (PKCS#12) con permisos 0600.

Opciones de pfx export

OpciónDescripción
-c, --cer <ruta>Ruta al certificado (.cer / .pem) requerido.
-k, --key <ruta>Ruta a la llave privada (.key / .pem) requerido.
-p, --password <texto>Contraseña de la llave privada.
--password-file <ruta>Archivo con la contraseña de la llave privada (o NODECFDI_PASSWORD).
--pfx-password <texto>Contraseña del PFX generado (por defecto reutiliza la contraseña de la llave privada).
--pfx-password-file <ruta>Archivo con la contraseña del PFX generado (o NODECFDI_PFX_PASSWORD).
-o, --output <ruta>Ruta del archivo .pfx de salida requerido.
--forcePermite sobrescribir el archivo de salida si ya existe.
-a, --algorithm <alg>Algoritmo de cifrado PFX: aes128, aes192, aes256, 3des.
-h, --helpMuestra la ayuda del comando.

Ejemplos de pfx export

# Exportar usando la misma contraseña de la llave privada y cifrado aes256
nc-credentials pfx export \
  --cer CSD01_AAA010101AAA.cer \
  --key CSD01_AAA010101AAA.key \
  --password-file password.txt \
  --algorithm aes256 \
  --output credencial.pfx

# Exportar asignando una contraseña distinta al archivo PFX resultante
nc-credentials pfx export \
  --cer CSD01_AAA010101AAA.cer \
  --key CSD01_AAA010101AAA.key \
  --password-file key-pass.txt \
  --pfx-password-file pfx-pass.txt \
  --output credencial.pfx \
  --force