Skip to content

README.md

Latest commit

 

History

History
145 lines (105 loc) · 4.47 KB

README.md

File metadata and controls

145 lines (105 loc) · 4.47 KB
Raw

dfva cliente para java

Este cliente permite comunicarse con DFVA para proveer servicios de firma digital para Costa Rica a institutiones.

Utiliza Maven para manejar sus dependencias, si se desea usar fuera de maven se debe usar

Modo de uso

Este cliente permite:

  • Autenticar personas y verificar estado de autenticación
  • Firmar documento xml, odf, ms office y verificar estado de firma durante el tiempo que el usuario está firmando
  • Validar un certificado emitido con la CA nacional de Costa Rica provista por el BCCR
  • Validar un documento XML firmado.
  • Revisar si un suscriptor está conectado.

Ejemplo de uso

Settings settings = new Settings();
settings.publicKey = "llave pública dada por dfva"
settings.publicCertificate  = "Certificado dado por dfva"
settings.privateKey = "Llave privada dada por dfva"
settings.institution = "Código de la institución dado por dfva"
settings.notificationURL = "url de notificación"
InstitutionClient client = new InstitutionClient(settings);

Nota: notificationURL debe estar registrado en dfva o ser N/D en clientes no web

Si se desea autenticar y revisar estado de la autenticación

JSONObject authres = client.authenticate("04-0212-0119");
System.out.println(authres.toJSONString());
/** Authenticate Show */

String code = (String) authres.get("id_transaction").toString()
JSONObject authresshow = client.authenticate_check( code);
System.out.println(authresshow.toJSONString());

/** Authenticate delete */
Boolean status = client.authenticate_delete(code);

Si se desea revisar si un suscriptor está conectado

Boolean sucres = client.suscriptor_connected("04-0212-0119");
System.out.println(sucres);

Si se desea firmar y revisar estado de la firma.

document = new ByteArrayInputStream(
    "DOCU DE EJEMPLO".getBytes("UTF-8"));
JSONObject signres = client.sign(
    "04-0212-0119", 
    document, 
    "xml_cofirma",  // xml_cofirma, xml_contrafirma, odf, msoffice 
    "Texto de resumen",
    "sha512");

System.out.println(signres.toJSONString());

/** Sign Check */
String code = (String) signres.get("id_transaction").toString();
JSONObject signresshow = client.sign_check(code);
System.out.println(signresshow.toJSONString());

/** Sign Delete */	
Boolean status = client.sign_delete(code);

En el caso de firma pdf debe utilizar

JSONObject signres = client.sign("04-0212-0119", 
    document, 
    "pdf",
    "Texto de resumen",
    "sha512",
    "Lugar de la firma",
    "Razón de la firma"	);

En caso de no ingresarse el lugar y la razón de firma se pondrá uno texto por defecto.

Nota: La revisión de estado de la autenticación/firma no es necesaria en servicios web ya que estos son notificados por en la URL de institución proporcionado.

Si se desea validar un certificado

document = new ByteArrayInputStream(
    "CERTIFICADO DE EJEMPLO".getBytes("UTF-8"));
JSONObject validateCertres = client.validate_certificate( document);
System.out.println(validateCertres.toJSONString());

Si se desea validar un documento

document = new ByteArrayInputStream(
    "DOCUMENTO DE EJEMPLO".getBytes("UTF-8"));
// opciones: cofirma, contrafirma, odf, msoffice
JSONObject validateDocres = client.validate_document(document, "cofirma");
System.out.println(validateDocres.toJSONString());

Compilando y Corriendo pruebas

Para generar el paquete con sus dependencias puede ejecutar

mvn package  dependency:copy-dependencies

Para correr las pruebas ejecute.

mvn test -DskipTests=false

Ejecute el simulador de FVA BCCR y su cliente de celery

EN FVA BCCR ejecute

python manage.py runserver 8001
celery  -A fva_bccr worker  -l info

Puede ejecutar además celery beat para mayor exactitud, ('''celery -A fva_bccr worker -BE -l info'''), aunque puede causar inestabilidad en las pruebas. También es importante acceder a http://localhost:8001/admin/constance/config/ y habilitar USE_UNITEST para que no espere el TASK_WAIT_TO_RESPONSE definido o poner un TASK_WAIT_TO_RESPONSE bajo como 1 segundo.

También se puede correr la aplicación en consola usando

java -cp "target/dfva_java-0.0.1-SNAPSHOT.jar:target/dependency/*"  dfva_java.client.App