@evomatik/evk-firma
v1.0.23-beta.2
Published
Downloads
33
Readme
Evomatik Firma Digital Angular Library
Evomatik Librería de componentes de JS y Angular con los servicios de firma digital para su uso en los flujos/procesos de negocio de Evomatik Seaged.
Instalación de componentes Firma Digital
Instalar el componente con el comando:
npm install @evomatik/evk-firma
Como usuarlo
La librería de evk-firma tiene como módulo principal EvkFirmaModule
el cual permite tener acceso a la funcionalaidad de firma-digital la cual se implementa como una directiva ( de angular) enviando los parametros requeridos.
@NgModule({
declarations: [FirmaDigitalComponent],
imports: [
EvkFirmaModule
]
})
Directiva
<evk-firma-digital
[datosFirma]="datos"
(fileEventEmitter)="guardarFirma($event)"
></evk-firma-digital>
Los atributos de configuración de la directiva son:
@Input()
datosFirma: EvkFirmaDigitalModel - Modelo para llenar los datos de la firma en el componente
@Output()
fileEventEmitter- Regresa el modelo de EvkFirmaDigitalModel con los datos faltantes (file)
Models
EvkFirmaDigitalModel {
id?: string;
nombreInterviniente: string;
leyendaTitulo: string;
leyendaCuerpo: string;
documentoNombre: string;
file?: any;
minWidth?: number;
persona?: any;
}
Los atributos del modelo de EvkFirmaDigitalModel:
id- id de la diligencia que se va a firmar
nombreInterviniente- Nombre del interviniente que va a firmar
leyendaTitulo- Titulo de la leyenda legar a mostrar en el componente
leyendaCuerpo- Leyenda legal a mostrar en el componente
documentoNombre- Nombre del documento que se firma
file- Archivo final de la firma esta en Base64 y debe ir de un inicio como null o no ir el componente lo agrega una vez que se da salvar a la firma
minWidth- El grosor del trazo para firmar puede o no ir por defecto esta en 0.5
persona- Modelo de datos de la persona que va a firmar se usa solo para regresarlo en el save no se usa dentro del cmponente de firma
Firma electronica avanzada
El componente de firma electronica avanzada provee un formulario y funcionalidad capaces de leer el conjunto de caracteres y datos de la FIEL o e-firma emitida por el SAT para pode firmar una cadena.
Directiva
<evk-firma-electronica
[hash]="hash"
[message]="message"
[signedMessageEncode]="encode"
(errorMessage)="errorMessage($event)"
(signedMessage)="signedMessage($event)"
(valid)="valid($event)"
(loading)="loading($event)"
></evk-firma-electronica>
Los atributos de configuración de la directiva son:
@Input()
- hash: string - Hash del algoritmo para firmar.
- message: string - Mensaje a firmar.
- signedMessageEncode: string - Codificación en la que se devolverá el mensaje firmado.
@Output()
- errorMessage: - Devuelve el objeto EvkMessage con el error ocurrido.
- signedMessage: - Devuelve una cadena en la codificación elegida como input del mensaje firmado.
- valid: - Devuelve un booleano con el resultado de validar el mensaje firmado y el mensaje original con el certificado.
- loading: - Devuelve un booleano con el estatus del proceso; es decir, cuando inicia y cuando termina el proceso.
Librerías adicionales:
- jsrsasign - Es una librería criptográfica de JavaScript de código abierto utilizada para firmar, validar manejar llaves privadas y certificados entre otras cosas mas.
- pkijs - Es una librería de JavaScript basada en WebCrypto usada para firmar, desencriptar y provee la infraestructura suficiente para solucionar situaciones que involucren criptografía desde el cliente.
- ngx-material-file-input - Esta librería provee un componente util como file-input para usar dentro de Angular Material mat-form-field.
Funcionamiento:
sequenceDiagram
Cliente ->> Formulario: Cargar certificado
Cliente ->> Formulario: Cargar llave privada
Cliente ->> Formulario: Ingresar contraseña
Cliente -->> FirmaElectronicaService: Enviado parametros(inputs)
Note right of FirmaElectronicaService: El cliente que use el <br/> componente debe de<br/> enviar los <br/>atributosnecesarios <br/>para su correcto <br/>funcionamiento.
Formulario ->> FirmaElectronicaService: Leer certificado
FirmaElectronicaService ->> FirmaElectronicaService: Paso 1 Validar vigencia de certificado
FirmaElectronicaService --x Cliente: Error de vigencia del certificado
FirmaElectronicaService ->> FirmaElectronicaService: Paso 2 Validar contraseña de la llave pública
FirmaElectronicaService --x Cliente: Error de la contraseña no valida
FirmaElectronicaService ->> FirmaElectronicaService: Paso 3 Validar contenido de atributo RFC ( Corresponda al usuario en sesión)
FirmaElectronicaService ->> FirmaElectronicaService: Paso 4 Obtener número de serie del certificado
FirmaElectronicaService ->> OCSP SAT: Validar: Paso 5 Validar certificado en listas de verificación (OCSP)
OCSP SAT --x FirmaElectronicaService: Resultado de la validación
FirmaElectronicaService ->> FirmaElectronicaService: Paso 6 Realizar firma/cifrado de la cadena original
FirmaElectronicaService -->> Cliente: Retorna el mensaje firmado
Note right of FirmaElectronicaService: En caso de no haber<br/> ningun error en el <br/>proceso se emitira <br/>al cliente el <br/>mensaje firmado
Configuración Gateway OCSP
Para la validación del certificado digital en las listas de verificación se deberá invocar al servicio de OCSP del SAT para lo cual se debera realizar la siguiente configuración de red:
En los archivos de configuración de environment
de la aplicación se dedera agregar lo siguiente:
ocspConfig: {
url: '/api-ocsp/edofiel',
enable: false
}
El valor de la url
debe de corresponder con la regla de configuración creada en el gateway de exposición de los servicios. Ej. de configuración de gateway:
location /api-ocsp/ {
proxy_pass https://cfdit.sat.gob.mx/;
proxy_ssl_protocols TLSv1;
proxy_ssl_ciphers HIGH:!DH;
}
Build
Run ng build evk-firma
to build the project. The build artifacts will be stored in the dist/
directory.
Publishing
After building your library with ng build evk-firma
, go to the dist folder cd dist/evk-firma
and run npm publish
.
Running unit tests
Run ng test evk-firma
to execute the unit tests via Karma.
Further help
To get more help on the Angular CLI use ng help
or go check out the Angular CLI README.