Referencia API
Exportaciones, Tipos y Utilidades
Referencia completa de puntos de entrada, tipos de TypeScript y clases auxiliares SerialNumber y PemExtractor.
Esta página resume todos los símbolos públicos exportados por @nodecfdi/credentials, sus subrutas y las clases utilitarias complementarias.
Puntos de entrada
1. @nodecfdi/credentials (Principal / Multiplataforma)
Funciona tanto en Node.js como en navegadores:
import {
Certificate,
Credential,
PemExtractor,
PfxExporter,
PfxReader,
PrivateKey,
PublicKey,
SerialNumber,
} from '@nodecfdi/credentials';
| Clase | Descripción |
|---|---|
Credential | Par validado de Certificate y PrivateKey para firmar y verificar. |
Certificate | Lector e inspector de certificados X.509 del SAT (.cer, PEM, Base64). |
PrivateKey | Lector de llaves privadas PKCS#8 / PKCS#5 para firma y cambio de contraseña. |
PublicKey | Lector de llaves públicas RSA para verificación de firmas. |
PfxReader | Lector de contenedores PKCS#12 (.pfx / .p12). |
PfxExporter | Exportador de instancias Credential a formato PKCS#12 (binario o Base64). |
SerialNumber | Conversor de números de serie de certificados entre hexadecimal, decimal y bytes ASCII. |
PemExtractor | Extractor de bloques PEM (CERTIFICATE, PUBLIC KEY, PRIVATE KEY, RSA PRIVATE KEY, ENCRYPTED PRIVATE KEY). |
2. @nodecfdi/credentials/node (Exclusivo Node.js)
Funciones auxiliares para interactuar directamente con archivos locales mediante node:fs:
import {
exportPfxToFile,
localFileOpen,
openCertificateFile,
openCredentialFiles,
openPrivateKeyFile,
openPublicKeyFile,
readPfxFile,
} from '@nodecfdi/credentials/node';
| Función | Firma | Descripción |
|---|---|---|
openCertificateFile | (filename: string) => Certificate | Abre un archivo local .cer o .pem y devuelve un Certificate. |
openPrivateKeyFile | (filename: string, passPhrase: string) => PrivateKey | Abre un archivo local .key o .pem y devuelve un PrivateKey. |
openPublicKeyFile | (filename: string) => PublicKey | Abre un archivo local .pem y devuelve un PublicKey. |
openCredentialFiles | (cerFile: string, keyFile: string, passPhrase: string) => Credential | Abre los archivos de certificado y llave privada y devuelve un Credential. |
readPfxFile | (filename: string, passPhrase: string) => Credential | Abre un archivo .pfx local y devuelve un Credential. |
exportPfxToFile | (credentialOrExporter: Credential | PfxExporter, pfxFile: string, passPhrase: string, algorithm?: AlgorithmPfx) => void | Exporta y escribe un archivo .pfx en disco. |
localFileOpen | (file: string) => string | Lee una ruta local (con o sin prefijo file://) y devuelve su contenido como cadena binaria ('binary'). Rechaza esquemas remotos (http://, https://, ftp://). |
3. @nodecfdi/credentials/types (Tipos TypeScript)
import type { Algorithm, AlgorithmPfx, Sha512Algorithm } from '@nodecfdi/credentials/types';
| Tipo | Definición | Uso |
|---|---|---|
Algorithm | 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'sha512/224' | 'sha512/256' | Algoritmos de resumen criptográfico aceptados en sign() y verify(). |
Sha512Algorithm | 'sha512' | 'sha384' | 'sha512/224' | 'sha512/256' | Subconjunto de variantes SHA-512 de node-forge. |
AlgorithmPfx | 'aes128' | 'aes192' | 'aes256' | '3des' | Algoritmos de cifrado para exportación de archivos PFX. |
Utilidades adicionales
SerialNumber
Permite cargar y convertir números de serie de certificados entre formato hexadecimal, decimal de precisión arbitraria (vía @nodecfdi/base-converter) y cadena ASCII (bytes):
serial-number.ts
import { SerialNumber } from '@nodecfdi/credentials';
// Crear desde hexadecimal (acepta prefijo opcional 0x), decimal o bytes ASCII
const serial = SerialNumber.createFromHexadecimal('3330303031303030303030353030303033343136');
// O: SerialNumber.createFromDecimal('292233162870206001759766198425879490508935869462')
// O: SerialNumber.createFromBytes('30001000000500003416')
console.log(serial.bytes()); // "30001000000500003416"
console.log(serial.bytesArePrintable()); // true
console.log(serial.hexadecimal()); // "3330303031303030303030353030303033343136"
console.log(serial.decimal()); // "292233162870206001759766198425879490508935869462"
PemExtractor
Extrae y normaliza (convirtiendo saltos de línea \r\n a \n) bloques PEM específicos de una cadena que puede contener múltiples bloques o texto adicional (como un archivo .pem todo en uno):
pem-extractor.ts
import { PemExtractor } from '@nodecfdi/credentials';
const extractor = new PemExtractor(allInOnePemContents);
const certPem = extractor.extractCertificate(); // Bloque CERTIFICATE o ""
const pubKeyPem = extractor.extractPublicKey(); // Bloque PUBLIC KEY o ""
const privKeyPem = extractor.extractPrivateKey(); // Bloque PRIVATE KEY, RSA PRIVATE KEY o ENCRYPTED PRIVATE KEY
