GithubHelp home page GithubHelp logo

bryancalisto / ec-sri-invoice-signer Goto Github PK

View Code? Open in Web Editor NEW
4.0 1.0 2.0 395 KB

Ecuadorian's SRI invoice signer written in pure TS/JS

License: MIT License

JavaScript 0.64% TypeScript 98.61% PowerShell 0.76%
ecuador invoice sri factura firma-digital digital-signature

ec-sri-invoice-signer's Introduction

ec-sri-invoice-signer

Firmador de facturas basado en las especificaciones del Servicio de Rentas Internas (SRI) ecuatoriano. Está escrito en puro TypeScript/JavaScript, sin dependencias de binarios criptográficos como OpenSSL, DLLs con el código de firmado o similares. Por tal razón, funciona en Windows, Unix/Linux o cualquier plataforma que soporte Node.js sin configuraciones adicionales.

Guía de uso

  1. Instala el paquete.
npm i ec-sri-invoice-signer
  1. Usa la función signInvoiceXml en tu código para firmar la factura:
import fs from 'fs';
import { signInvoiceXml } from 'ec-sri-invoice-signer';
/* Puedes user require() si usas módulos commonJS. */

/* El XML de la factura a firmarse. */
const invoiceXml = '<factura id="comprobante>...</factura>';

/* El contenido del archivo pkcs12 (.p12/.pfx extension) del firmante representado como Node Buffer o string base64.
En este caso es un Node Buffer. */
const p12FileData = fs.readFileSync('signature.p12');

/* Firma la factura. Si no se pasa la opción pkcs12Password, '' será usada como contraseña. */
const signedInvoice = signInvoiceXml(invoiceXml, p12FileData, { pkcs12Password: 'thePKCS12FilePassword' });

doSomethingWithTheSignedInvoice(signedInvoice);
  1. Si este paquete te ha ayudado, considera dejar tu ⭐.

Notas importantes sobre la estructura del XML

Este paquete no implementa la especificación de canonicalización http://www.w3.org/TR/2001/REC-xml-c14n-20010315 por completo. El XML es un lenguaje con muchas características sofisticadas que, probablemente, no tienen mucha cabida en una aplicación de facturación electrónica en el marco del SRI. Por tal razón, solo se implementa las partes del estándar requeridas para soportar XML con características relativamente comunes. Esto debería cubrir la mayoría de los casos de uso.

Estas son las características requeridas del XML que se pretende firmar (ninguna de las características no soportadas es requerida para el intercambio de datos con el SRI):

  • La factura a firmarse debe consistir del nodo factura con su respectivo id 'comprobante', su versión y sus etiquetas hijas describiendo el contenido de la factura (sin otros namespaces).
<?xml version="1.0" encoding="UTF-8"?>
<factura Id="comprobante" version="1.1.0">
 <infoTributaria>...</infoTributaria>
 <infoFactura>...</infoFactura>
 <detalles>...</detalles>
<factura>
  • La declaración del documento XML es opcional.
<!-- Con declaración -->
<?xml version="1.0" encoding="UTF-8"?>
<factura Id="comprobante" version="1.1.0">
...
</factura>

o

<!-- Sin declaración -->
<factura Id="comprobante" version="1.1.0">
...
</factura>

son igual de válidos.

  • La factura debe estar en formato UTF-8.
  • No namespaces (xmlns).
<!-- En este ejemplo, el xmlns:ds="..." debe ser eliminado. Como contexto, ningún namespace es necesario
para la factura en sí. Este paquete se encarga de colocar los namespaces necesarios en la firma digital
 generada -->
<factura Id="comprobante" version="1.1.0" xmlns:ds="...">
...
</factura>
<!-- Esto es soportado -->
<factura Id="comprobante" version="1.1.0">
...
</factura>
  • No etiquetas de Document Type Definition (DOCTYPE).
<!-- Esto no es soportado -->
 <!DOCTYPE note
 [
 <!ELEMENT note (to,from,heading,body)>
 <!ELEMENT to (#PCDATA)>
 <!ELEMENT from (#PCDATA)>
 <!ELEMENT heading (#PCDATA)>
 <!ELEMENT body (#PCDATA)>
 ]>
<factura Id="comprobante" version="1.1.0">
...
<factura>
  • No atributos con prefijo xml (xml:<attr_name>).
<!-- Esto no es soportado debido a xml:foo="123"-->
<factura Id="comprobante" version="1.1.0" xml:foo="123">
...
</factura>

ec-sri-invoice-signer's People

Contributors

bryancalisto avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

xmaciasg

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.