Primeros pasos
Instalación
Instala @nodecfdi/credentials y su dependencia par luxon en tu proyecto Node.js o navegador.
@nodecfdi/credentials se distribuye como un paquete ESM en npm y requiere luxon (^3.7.2) como dependencia par (peer dependency) para el manejo de fechas de vigencia.
Instalación del paquete
Instala @nodecfdi/credentials junto con luxon utilizando tu gestor de paquetes preferido:
pnpm add @nodecfdi/credentials luxon
npm install @nodecfdi/credentials luxon
yarn add @nodecfdi/credentials luxon
bun add @nodecfdi/credentials luxon
Si utilizas TypeScript, puedes instalar opcionalmente los tipos de Luxon en desarrollo:
pnpm add -D @types/luxon.Puntos de entrada disponibles
El paquete ofrece tres rutas de importación según tu entorno:
@nodecfdi/credentials: Exporta todas las clases principales (Credential,Certificate,PrivateKey,PublicKey,PfxReader,PfxExporter,SerialNumber,PemExtractor). Es agnóstico del entorno y funciona tanto en Node.js como en navegadores.@nodecfdi/credentials/node: Exporta funciones auxiliares exclusivas de Node.js para leer y escribir archivos locales directamente desde el sistema de archivos (openCredentialFiles,openCertificateFile,openPrivateKeyFile,openPublicKeyFile,readPfxFile,exportPfxToFile,localFileOpen).@nodecfdi/credentials/types: Exporta los tipos de TypeScript para algoritmos de firma y exportación PFX (Algorithm,Sha512Algorithm,AlgorithmPfx).
Verificación rápida
Puedes verificar que la instalación funciona correctamente abriendo un par de archivos .cer y .key en Node.js:
verify-install.ts
import { Buffer } from 'node:buffer';
import { openCredentialFiles } from '@nodecfdi/credentials/node';
const credential = openCredentialFiles(
'./archivos/CSD01_AAA010101AAA.cer',
'./archivos/CSD01_AAA010101AAA.key',
'12345678a',
);
console.log('RFC:', credential.rfc());
console.log('Razón social:', credential.legalName());
console.log('¿Es CSD?:', credential.isCsd());
console.log('¿Vigente hoy?:', credential.certificate().validOn());
const data = '||4.0|cadena-original-de-prueba||';
const signature = credential.sign(data);
console.log('Sello (Base64):', Buffer.from(signature, 'binary').toString('base64'));
console.log('Verificación:', credential.verify(data, signature));
¿Qué sigue?
- Aprende a trabajar con la clase principal Credential.
- Consulta cómo inspeccionar un Certificate o usar la librería en el Navegador.
- Explora la herramienta de línea de comandos CLI (
nc-credentials).
