---
title: "Exportaciones, Tipos y Utilidades"
description: "Referencia completa de puntos de entrada, tipos de TypeScript y clases auxiliares SerialNumber y PemExtractor."
canonical_url: "https://nodecfdi.com/packages/credentials/api-reference/exports-and-types"
---

> Index of every page on this site: [llms.txt](https://nodecfdi.com/llms.txt)

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**:

```ts
import {
  Certificate,
  Credential,
  PemExtractor,
  PfxExporter,
  PfxReader,
  PrivateKey,
  PublicKey,
  SerialNumber,
} from '@nodecfdi/credentials';
```

<table>
<thead>
  <tr>
    <th>
      Clase
    </th>
    
    <th>
      Descripción
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <a href="/packages/credentials/usage/credential">
        <code>
          Credential
        </code>
      </a>
    </td>
    
    <td>
      Par validado de <code>
        Certificate
      </code>
      
       y <code>
        PrivateKey
      </code>
      
       para firmar y verificar.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/packages/credentials/usage/certificate">
        <code>
          Certificate
        </code>
      </a>
    </td>
    
    <td>
      Lector e inspector de certificados X.509 del SAT (<code>
        .cer
      </code>
      
      , PEM, Base64).
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/packages/credentials/usage/private-and-public-keys">
        <code>
          PrivateKey
        </code>
      </a>
    </td>
    
    <td>
      Lector de llaves privadas PKCS#8 / PKCS#5 para firma y cambio de contraseña.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/packages/credentials/usage/private-and-public-keys">
        <code>
          PublicKey
        </code>
      </a>
    </td>
    
    <td>
      Lector de llaves públicas RSA para verificación de firmas.
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/packages/credentials/usage/pfx">
        <code>
          PfxReader
        </code>
      </a>
    </td>
    
    <td>
      Lector de contenedores PKCS#12 (<code>
        .pfx
      </code>
      
       / <code>
        .p12
      </code>
      
      ).
    </td>
  </tr>
  
  <tr>
    <td>
      <a href="/packages/credentials/usage/pfx">
        <code>
          PfxExporter
        </code>
      </a>
    </td>
    
    <td>
      Exportador de instancias <code>
        Credential
      </code>
      
       a formato PKCS#12 (binario o Base64).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        SerialNumber
      </code>
    </td>
    
    <td>
      Conversor de números de serie de certificados entre hexadecimal, decimal y bytes ASCII.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        PemExtractor
      </code>
    </td>
    
    <td>
      Extractor de bloques PEM (<code>
        CERTIFICATE
      </code>
      
      , <code>
        PUBLIC KEY
      </code>
      
      , <code>
        PRIVATE KEY
      </code>
      
      , <code>
        RSA PRIVATE KEY
      </code>
      
      , <code>
        ENCRYPTED PRIVATE KEY
      </code>
      
      ).
    </td>
  </tr>
</tbody>
</table>

### 2. `@nodecfdi/credentials/node` (Exclusivo Node.js)

Funciones auxiliares para interactuar directamente con archivos locales mediante `node:fs`:

```ts
import {
  exportPfxToFile,
  localFileOpen,
  openCertificateFile,
  openCredentialFiles,
  openPrivateKeyFile,
  openPublicKeyFile,
  readPfxFile,
} from '@nodecfdi/credentials/node';
```

<table>
<thead>
  <tr>
    <th>
      Función
    </th>
    
    <th>
      Firma
    </th>
    
    <th>
      Descripción
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        openCertificateFile
      </code>
    </td>
    
    <td>
      <code>
        (filename: string) => Certificate
      </code>
    </td>
    
    <td>
      Abre un archivo local <code>
        .cer
      </code>
      
       o <code>
        .pem
      </code>
      
       y devuelve un <code>
        Certificate
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        openPrivateKeyFile
      </code>
    </td>
    
    <td>
      <code>
        (filename: string, passPhrase: string) => PrivateKey
      </code>
    </td>
    
    <td>
      Abre un archivo local <code>
        .key
      </code>
      
       o <code>
        .pem
      </code>
      
       y devuelve un <code>
        PrivateKey
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        openPublicKeyFile
      </code>
    </td>
    
    <td>
      <code>
        (filename: string) => PublicKey
      </code>
    </td>
    
    <td>
      Abre un archivo local <code>
        .pem
      </code>
      
       y devuelve un <code>
        PublicKey
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        openCredentialFiles
      </code>
    </td>
    
    <td>
      <code>
        (cerFile: string, keyFile: string, passPhrase: string) => Credential
      </code>
    </td>
    
    <td>
      Abre los archivos de certificado y llave privada y devuelve un <code>
        Credential
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        readPfxFile
      </code>
    </td>
    
    <td>
      <code>
        (filename: string, passPhrase: string) => Credential
      </code>
    </td>
    
    <td>
      Abre un archivo <code>
        .pfx
      </code>
      
       local y devuelve un <code>
        Credential
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        exportPfxToFile
      </code>
    </td>
    
    <td>
      <code>
        (credentialOrExporter: Credential | PfxExporter, pfxFile: string, passPhrase: string, algorithm?: AlgorithmPfx) => void
      </code>
    </td>
    
    <td>
      Exporta y escribe un archivo <code>
        .pfx
      </code>
      
       en disco.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        localFileOpen
      </code>
    </td>
    
    <td>
      <code>
        (file: string) => string
      </code>
    </td>
    
    <td>
      Lee una ruta local (con o sin prefijo <code>
        file://
      </code>
      
      ) y devuelve su contenido como cadena binaria (<code>
        'binary'
      </code>
      
      ). Rechaza esquemas remotos (<code>
        http://
      </code>
      
      , <code>
        https://
      </code>
      
      , <code>
        ftp://
      </code>
      
      ).
    </td>
  </tr>
</tbody>
</table>

### 3. `@nodecfdi/credentials/types` (Tipos TypeScript)

```ts
import type { Algorithm, AlgorithmPfx, Sha512Algorithm } from '@nodecfdi/credentials/types';
```

<table>
<thead>
  <tr>
    <th>
      Tipo
    </th>
    
    <th>
      Definición
    </th>
    
    <th>
      Uso
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        Algorithm
      </code>
    </td>
    
    <td>
      <code>
        'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'sha512/224' | 'sha512/256'
      </code>
    </td>
    
    <td>
      Algoritmos de resumen criptográfico aceptados en <code>
        sign()
      </code>
      
       y <code>
        verify()
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        Sha512Algorithm
      </code>
    </td>
    
    <td>
      <code>
        'sha512' | 'sha384' | 'sha512/224' | 'sha512/256'
      </code>
    </td>
    
    <td>
      Subconjunto de variantes SHA-512 de <code>
        node-forge
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        AlgorithmPfx
      </code>
    </td>
    
    <td>
      <code>
        'aes128' | 'aes192' | 'aes256' | '3des'
      </code>
    </td>
    
    <td>
      Algoritmos de cifrado para exportación de archivos PFX.
    </td>
  </tr>
</tbody>
</table>

---

## 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`):

```ts [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):

```ts [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
```

## Sitemap

See the full [sitemap](https://nodecfdi.com/sitemap.md) for all pages.
