Skip to content

Commit 769acad

Browse files
authored
Update README.md
1 parent 6ddf97c commit 769acad

File tree

1 file changed

+15
-46
lines changed

1 file changed

+15
-46
lines changed

README.md

Lines changed: 15 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
1-
> **Nota:** La documentación se encuentra en español porque es el lenguaje principal de la mayoría de los usuarios.
2-
> *The documentation of this project is in Spanish as it is the main language for the intended audience.*
3-
4-
---
5-
61
# Fiscalapi Credentials
72

3+
Biblioteca para trabajar con archivos **CSD** y **FIEL** del SAT de manera sencilla en .NET. **`Credentials`** simplifica la firma (sellado), la verificación de firmas, el cálculo de hashes (por ejemplo, para servicios de descarga masiva de XML y metadatos), así como la obtención de información relevante de los certificados y llaves públicas del SAT.
84

9-
Lib para trabajar con archivos **CSD** y **FIEL** del SAT de manera sencilla en .NET. **`Credentials`** simplifica la firma (sellado), la verificación de firmas, el cálculo de hashes (por ejemplo, para servicios de descarga masiva de XML y metadatos), así como la obtención de información relevante de los certificados y llaves públicas del SAT.
10-
11-
> :bulb: **Tip:** La firma digital es un proceso criptográfico que garantiza la autenticidad, integridad y no repudio de un documento o mensaje. En México, el SAT requiere que los contribuyentes utilicen un **Certificado de Sello Digital (CSD)** para firmar (sellar) las facturas, mientras que una **Firma Electrónica Avanzada (FIEL)** se utiliza para firmar documentos de cualquier otro tipo (contratos, acuerdos, cotizaciones, correos, etc) de manera legalmente válida.
12-
13-
---
5+
La firma digital es un proceso criptográfico que garantiza la autenticidad, integridad y no repudio de un documento o mensaje. En México, el SAT requiere que los contribuyentes utilicen un **Certificado de Sello Digital (CSD)** para firmar (sellar) las facturas, mientras que una **Firma Electrónica Avanzada (FIEL)** se utiliza para firmar documentos de cualquier otro tipo (contratos, acuerdos, cotizaciones, correos, etc) de manera legalmente válida.
146

157
## Tabla de Contenido
168

17-
1. [Acerca de la Librería](#acerca-de-la-librería)
18-
2. [Instalación](#instalación)
9+
1. [Acerca de la Librería](#Características)
10+
2. [Instalación](#Instalación)
1911
3. [Uso Básico](#uso-básico)
20-
- [Certificado (`Certificate`)](#uso-básico-del-certificado)
21-
- [Clave Privada (`PrivateKey`)](#uso-básico-de-la-clave-privada)
22-
- [Credencial (`Credential`)](#uso-básico-del-objeto-credential)
12+
- [Certificado (`Certificate`)](#uso-del-certificado)
13+
- [Clave Privada (`PrivateKey`)](#uso-de-la-clave-privada)
14+
- [Credencial (`Credential`)](#uso-del-objeto-credential)
2315
4. [Acerca de los Archivos CSD y FIEL](#acerca-de-los-archivos-de-certificado-y-llave-privada)
2416
5. [Compatibilidad](#compatibilidad)
2517
6. [Roadmap](#roadmap)
@@ -29,11 +21,8 @@ Lib para trabajar con archivos **CSD** y **FIEL** del SAT de manera sencilla en
2921
10. [📄 Licencia](#-licencia)
3022
11. [🔗 Enlaces Útiles](#-enlaces-útiles)
3123

32-
---
33-
34-
## Acerca de la Librería
3524

36-
Con **`Credentials`** puedes:
25+
## 🚀 Características
3726

3827
- **Firmar (sellar) documentos**: Utilizar CSD o FIEL para generar firmas digitales que cumplen con los lineamientos del SAT.
3928
- **Verificar firmas**: Validar que la firma fue generada correctamente con la llave privada asociada.
@@ -58,23 +47,18 @@ Con **`Credentials`** puedes:
5847
- Permite firmar, validar firmas, crear archivos PFX, etc.
5948
- Identifica si es CSD o FIEL y verifica su vigencia.
6049

61-
---
62-
63-
## Instalación
50+
## 📦Instalación
6451

6552
Instala el paquete [**Credentials**](https://www.nuget.org/packages/Credentials/) desde **NuGet**:
6653

6754
```bash
6855
Install-Package Credentials -Version 4.0.95
6956
```
7057

71-
---
72-
73-
## Uso Básico
7458

75-
A continuación se muestran ejemplos simples de cómo utilizar las clases principales de la librería.
59+
## Ejemplos de uso
7660

77-
### Uso Básico del Certificado
61+
### Uso del Certificado
7862

7963
```csharp
8064
// Cargar el archivo .cer
@@ -102,7 +86,7 @@ var pemCertificate = certificate.GetPemRepresentation();
10286
File.WriteAllText("MyPemCertificate.pem", pemCertificate);
10387
```
10488

105-
### Uso Básico de la Clave Privada
89+
### Uso de la Clave Privada
10690

10791
```csharp
10892
// Cargar el archivo .key
@@ -118,7 +102,7 @@ var PemPrivateKey = privateKey.GetPemRepresentation();
118102
File.WriteAllText("MyPemPrivateKey.pem", PemPrivateKey);
119103
```
120104

121-
### Uso Básico del Objeto Credential
105+
### Uso del Objeto Credential
122106

123107
```csharp
124108
// Crear instancia de Credential a partir de certificate y privateKey
@@ -149,7 +133,6 @@ Console.WriteLine($"Tipo de Credencial: {cred.CredentialType}"); // Enum: Fiel
149133
Console.WriteLine($"¿Es FIEL válida?: {cred.IsValidFiel()}");
150134
```
151135

152-
---
153136

154137
## Acerca de los Archivos de Certificado y Llave Privada
155138

@@ -163,16 +146,12 @@ Esta conversión consiste básicamente en:
163146

164147
Por lo tanto, no necesitas realizar la conversión manual ni depender de utilerías externas para utilizar tus archivos **CSD** o **FIEL**.
165148

166-
---
167149

168150
## Compatibilidad
169151

170-
- Compatible con **.NET 6**, **.NET 8** y versiones posteriores (incluyendo WinForms, aplicaciones de consola y web).
152+
- Compatible con **.NET 6**, **.NET 8** y **.NET 9** WinForms, WPF, Console, ASP.NET, Blazor, MVC, WebApi.
171153
- Mantenemos la compatibilidad con al menos la versión LTS más reciente de .NET.
172-
- Se sigue el [**Versionado Semántico 2.0.0**](docs/SEMVER.md), por lo que puedes confiar en que las versiones nuevas no romperán tu aplicación de forma inesperada.
173-
174-
---
175-
154+
- Se sigue el [**Versionado Semántico 2.0.0**]([docs/SEMVER.md](https://learn.microsoft.com/en-us/nuget/concepts/package-versioning?tabs=semver20sort)), por lo que puedes confiar en que las versiones nuevas no romperán tu aplicación de forma inesperada.
176155
## Roadmap
177156

178157
- [x] Conversión de **X.509 DER** a **X.509 PEM** (SAT .cer).
@@ -183,16 +162,6 @@ Por lo tanto, no necesitas realizar la conversión manual ni depender de utiler
183162
- [x] Cálculo y verificación de hash para servicios SAT de descarga masiva de XML.
184163
- [ ] Persistencia de CSD y FIEL utilizando Entity Framework Core y bases de datos relacionales.
185164

186-
---
187-
188-
## Contribuciones
189-
190-
Las contribuciones son bienvenidas. Si deseas agregar nuevas funcionalidades, corregir errores o mejorar la documentación, siéntete libre de enviar [Pull Requests](https://github.com/FiscalAPI/fiscalapi-credentials-net/pulls). Antes de hacerlo, te invitamos a:
191-
192-
1. Revisar las [issues abiertas](https://github.com/FiscalAPI/fiscalapi-credentials-net/issues) para asegurarte de que tu propuesta no esté duplicada.
193-
2. Leer nuestro archivo de [CONTRIBUTING](CONTRIBUTING.md) para seguir las pautas del proyecto.
194-
3. Consultar el archivo [TODO](TODO.md) y [CHANGELOG](CHANGELOG.md) si están disponibles para conocer pendientes o cambios recientes.
195-
196165

197166
## 🤝 Contribuir
198167

0 commit comments

Comments
 (0)