Skip to content

Commit d7ada21

Browse files
committed
2 parents 5ffc0f2 + ade51b1 commit d7ada21

File tree

2 files changed

+36
-93
lines changed

2 files changed

+36
-93
lines changed

.github/workflows/CICD.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- name: Setup .NET
1717
uses: actions/setup-dotnet@v3
1818
with:
19-
dotnet-version: '8.0.x'
19+
dotnet-version: '9.0.x'
2020

2121
# Restore dependencies
2222
- name: Restore dependencies

README.md

Lines changed: 35 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
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+
[![NuGet](https://img.shields.io/nuget/v/FiscalApi.svg)](https://www.nuget.org/packages/Fiscalapi.Credentials/)
4+
[![License](https://img.shields.io/github/license/FiscalAPI/fiscalapi-credentials-net)](https://github.com/FiscalAPI/fiscalapi-credentials-net/blob/main/LICENSE)
85

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.
6+
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.
107

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-
---
8+
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.
149

1510
## Tabla de Contenido
1611

17-
1. [Acerca de la Librería](#acerca-de-la-librería)
18-
2. [Instalación](#instalación)
12+
1. [Acerca de la Librería](#Características)
13+
2. [Instalación](#Instalación)
1914
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)
15+
- [Certificado (`Certificate`)](#uso-del-certificado)
16+
- [Clave Privada (`PrivateKey`)](#uso-de-la-clave-privada)
17+
- [Credencial (`Credential`)](#uso-del-objeto-credential)
2318
4. [Acerca de los Archivos CSD y FIEL](#acerca-de-los-archivos-de-certificado-y-llave-privada)
2419
5. [Compatibilidad](#compatibilidad)
2520
6. [Roadmap](#roadmap)
@@ -29,11 +24,8 @@ Lib para trabajar con archivos **CSD** y **FIEL** del SAT de manera sencilla en
2924
10. [📄 Licencia](#-licencia)
3025
11. [🔗 Enlaces Útiles](#-enlaces-útiles)
3126

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

36-
Con **`Credentials`** puedes:
28+
## 🚀 Características
3729

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

61-
---
53+
## 📦Instalación
6254

63-
## Instalación
64-
65-
Instala el paquete [**Credentials**](https://www.nuget.org/packages/Credentials/) desde **NuGet**:
55+
**NuGet Package Manager**:
6656

6757
```bash
68-
Install-Package Credentials -Version 4.0.95
58+
NuGet\Install-Package Fiscalapi.Credentials
6959
```
7060

71-
---
61+
**.NET CLI**:
7262

73-
## Uso Básico
63+
```bash
64+
dotnet add package Fiscalapi.Credentials
65+
```
7466

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

77-
### Uso Básico del Certificado
69+
### Uso del Certificado
7870

7971
```csharp
8072
// Cargar el archivo .cer
@@ -102,7 +94,7 @@ var pemCertificate = certificate.GetPemRepresentation();
10294
File.WriteAllText("MyPemCertificate.pem", pemCertificate);
10395
```
10496

105-
### Uso Básico de la Clave Privada
97+
### Uso de la Clave Privada
10698

10799
```csharp
108100
// Cargar el archivo .key
@@ -118,7 +110,7 @@ var PemPrivateKey = privateKey.GetPemRepresentation();
118110
File.WriteAllText("MyPemPrivateKey.pem", PemPrivateKey);
119111
```
120112

121-
### Uso Básico del Objeto Credential
113+
### Uso del Objeto Credential
122114

123115
```csharp
124116
// Crear instancia de Credential a partir de certificate y privateKey
@@ -149,7 +141,6 @@ Console.WriteLine($"Tipo de Credencial: {cred.CredentialType}"); // Enum: Fiel
149141
Console.WriteLine($"¿Es FIEL válida?: {cred.IsValidFiel()}");
150142
```
151143

152-
---
153144

154145
## Acerca de los Archivos de Certificado y Llave Privada
155146

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

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

166-
---
167157

168158
## Compatibilidad
169159

170-
- Compatible con **.NET 6**, **.NET 8** y versiones posteriores (incluyendo WinForms, aplicaciones de consola y web).
160+
- Compatible con **.NET 6**, **.NET 8** y **.NET 9** WinForms, WPF, Console, ASP.NET, Blazor, MVC, WebApi.
171161
- 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-
162+
- 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.
176163
## Roadmap
177164

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

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-
196-
---
197173

198174
## 🤝 Contribuir
199175

200-
1. Haz un **fork** del repositorio.
201-
2. Crea una rama para tu feature:
202-
```bash
203-
git checkout -b feature/AmazingFeature
204-
```
205-
3. Realiza *commits* de tus cambios:
206-
```bash
207-
git commit -m 'Add some AmazingFeature'
208-
```
209-
4. Sube tu rama:
210-
```bash
211-
git push origin feature/AmazingFeature
212-
```
213-
5. Abre un **Pull Request** en GitHub.
176+
1. Haz un fork del repositorio.
177+
2. Crea una rama para tu feature: `git checkout -b feature/AmazingFeature`.
178+
3. Realiza commits de tus cambios: `git commit -m 'Add some AmazingFeature'`.
179+
4. Sube tu rama: `git push origin feature/AmazingFeature`.
180+
5. Abre un Pull Request en GitHub.
214181

215-
---
216182

217183
## 🐛 Reportar Problemas
218184

219185
1. Asegúrate de usar la última versión del SDK.
220-
2. Verifica si el problema ya fue reportado en la sección de [Issues](https://github.com/FiscalAPI/fiscalapi-credentials-net/issues).
221-
3. Proporciona un ejemplo mínimo reproducible que ayude a ubicar el error fácilmente.
222-
4. Incluye todos los mensajes de error relevantes o capturas de pantalla.
186+
2. Verifica si el problema ya fue reportado.
187+
3. Proporciona un ejemplo mínimo reproducible.
188+
4. Incluye los mensajes de error completos.
223189

224-
---
225190

226191
## 📄 Licencia
227192

228-
Este proyecto está licenciado bajo la **Licencia MPL**. Consulta el archivo [LICENSE](LICENSE.txt) para más detalles.
193+
Este proyecto está licenciado bajo la Licencia **MPL**. Consulta el archivo [LICENSE](LICENSE.txt) para más detalles.
229194

230-
---
231195

232196
## 🔗 Enlaces Útiles
233197

234-
- [SDK .NET (fiscalapi-net)](https://github.com/FiscalAPI/fiscalapi-net)
235198
- [Documentación Oficial](https://docs.fiscalapi.com)
236199
- [Portal de FiscalAPI](https://fiscalapi.com)
237-
- [Ejemplos WinForms/Console](https://github.com/FiscalAPI/fiscalapi-samples-net-winforms)
238-
- [Ejemplos ASP.NET](https://github.com/FiscalAPI/fiscalapi-samples-net-aspnet)
239-
240-
---
241-
242-
¡Gracias por usar **`Credentials`**! Siéntete libre de abrir un *issue* o un *pull request* en caso de dudas o sugerencias.
243-
Equipo de **Fiscalapi**.
244-
245-
246-
247-
248-
249-
250-
251-
252-
253-
254-
## 💡 Soporte
255-
256-
257-
- [Documentación](https://docs.fiscalapi.com)
258-
- [GitHub Issues](https://github.com/FiscalAPI/fiscalapi-credentials-net/issues)
200+
- [Facturar en WinForms/Console](https://github.com/FiscalAPI/fiscalapi-samples-net-winforms)
201+
- [Facturar en ASP.NET](https://github.com/FiscalAPI/fiscalapi-samples-net-aspnet)
259202

260203
---
261204

262-
Desarrollado con ❤️ por [Fiscalapi](https://www.fiscalapi.com)
205+
Desarrollado con ❤️ por [Fiscalapi](https://www.fiscalapi.com)

0 commit comments

Comments
 (0)