UserManual300

Manual de usuario - Sinadura 3.0.0 #



Manual de usuario de la aplicación Sinadura #

La primera vez que ejecutamos Sinadura aparece la ventana principal de la aplicación. Dicha ventana está compuesta por un menú desde donde podemos acceder a las distintas secciones de la aplicación.

Pantalla principal

En el propio contenido de la ventana hay un espacio donde se listan los documentos a firmar y varios botones con los que realizar distintas funciones.

  • Añadir Documentos
    • Seleccionar un documento a firmar.
  • Abrir Directorio
    • Seleccionar todos los documentos de un directorio para firmarlos, subdirectorios inclusive.
  • Eliminar
    • Eliminar de la lista de archivos a firmar los seleccionados.
  • Visualizar
    • Visualiza el archivo seleccionado de la lista.
  • Enviar
    • Envía el documento firmado vía correo electrónico.
  • Firmar
    • Comenzar el proceso de firma sobre todos los archivos seleccionados..
  • Validar
    • Permite verificar la validez de las firmas de un documento mostrando además el firmante y la fecha de cada una de ellas.

También existe en la barra de menú la opción de ir a la ayuda, donde las opciones nos llevan a las distintas URLs de documentación de la aplicación y nos muestran la pantalla de Acerca de

Acerca de Sinadura



Preferencias #

Desde el menú "Sinadura" > "Preferencias" se accede a la ventana desde donde configurar todas las preferencias de la aplicación. Éstas se dividen en diferentes apartados.


Generales #

Agrupa las opciones de configuración general de la aplicación.

Preferencias generales


  • Idioma: Permite elegir el idioma del aplicativo.
  • Guardar documentos. Si es seleccionado permite guardar los documentos firmados en el mismo directorio que el original sin importar el directorio destino.
  • Destino: Directorio donde se almacenarán los documentos firmados. Esta preferencia estará disponible si la preferencia 'Guardar documentos' está deshabilitada.
  • Sufijo del nombre: Sufijo para los ficheros firmados. Los ficheros firmados se llamarán igual que el correspondiente original, pero terminando su nombre con el sufijo elegido.

Por ejemplo: Documentos originales: documento.pdf factura.pdf

Proxy #

En este menú se muestran las características del servidor Proxy donde se debe rellenar los siguientes datos.

Características del servidor Proxy


  • Usuario: Usuario para autenticarse en el host especificado.
  • Contraseña: Contraseña del usuario especificado.
  • Habilitar configuración proxy del sistema: Si esta preferencia está habilitada se usará la configuración proxy del sistema

Una vez rellenado los datos se podrá habilitar el uso del servidor Proxy.



Firma#

En apartado Firma se encuentra varias opciones.

Firma


  • Habilitar sellado de tiempo: Indica si queremos incluir la fecha proporcionada por una autoridad de sellado de tiempos a la hora de firmar, de modo que la autoridad pueda respaldar la validez de dicha fecha . Es recomendable tener dicha opción habilitada.
  • Sellado de tiempo (TSA): Donde es posible seleccionar la autoridad de sellado de tiempos a utilizar.
  • Incluir validación OCSP (validación online del estado de los certificados) : Indica si queremos realizar e incluir una validación online del estado del certificado en la firma, evitando así que se firme con un certificado revocado. Se recomienda tener dicha opción habilitada.

Certificados#

En esta sección se encuentran dos campos en los que seleccionar que tipo de certificador usar en las firmas.

Certificados de software


  • Certificado software:indica si queremos firmar el documento con un certificado en Software.
  • Tarjeta criptográfica:indica si queremos firmar el documento usando una tarjeta criptográfica.

En el subapartado Certificados Software de Certificados se encuentra el gestor de certificados. En este apartado se encuentran todas las opciones relativas a la gestión de los certificados necesarios para el proceso de firma. Antes de poder firmar un documento debemos configurar un certificado válido con el que firmarlos.

Certificados de software


  • Añadir: añadir un nuevo certificado de firmas

Para ello pide un nombre para el certificado y la ruta donde se encuentra.

Añadir certificados


  • Modificar: modificar los datos del almacén de firmas seleccionado
  • Eliminar: eliminar el certificado de firmas seleccionado

En el subapartado de Tarjeta criptográfica de Certificados se encuentra el menú de selección de tarjeta. En dicho menú se puede seleccionar que tipo de tarjeta usar para firmar los documentos.

Tarjeta criptográfica



PDF#

Engloba las diferentes opciones para el proceso de firma de documentos.

Características de firma


  • Firma visible: Indica la posibilidad de que la firma se pueda visualizar en el documento.
  • Incluir imagen de fondo: Indica si queremos incluir una imagen como fondo. El campo "Firma visible" deberá estar habilitado para que la imagen pueda ser añadida al documento.
Si esta preferencia está habilitada se indicará la imagen que se desea incluir en el PDF firmado y la localización de esta: Primera página, última página o bien, indicar la página concreta donde se desea mostrar la imagen.

Una vez tengamos la imagen seleccionada, con la opción de la lupa, se nos abrirá un documento de muestra y tendremos que indicarle en que posición y con que tamaño queremos insertar nuestra imagen o logo.

Colocación de logo


  • Certificación del documento: Se permite seleccionar la certificación del documento.
  • Razón y Localización: Indican si queremos añadir datos adjuntos para que formen parte del sello visible del documento.

Validación #

Este menú gestiona todos los certificados utilizados para verificarla validez de las firmas de los documentos. Estos certificados son habitualmente llamados también certificados de confianza.

Menu de validación


  • Añadir: añadir un nuevo certificado de confianza.
  • Mostrar: mostrar datos del certificado de confianza

Muestra del certificado de confianza

  • Eliminar: eliminar el certificadode confianza


En la subcategoria "Cache" de validación se encuentra el menú que gestiona la cache de los certificados de la aplicación. Dicha cache se utiliza para la generación de la cadenas de certificados.

Menu de cache


Firmar Documentos #

Para poder firmar un documento lo primero es añadir un documento al listado. Una vez en el listado se selecciona y se pulsa la opción firmar. Acto seguido Sinadura hará una petición de contraseña, se introduce la contraseña correcta y el documento comienza a firmarse.

Petición de contraseña

Documento sin firmar

Documento firmado


Como se puede ver en el ejemplo, cuando se firma un documento el icono de tipo del fichero se convierte en otro que significa ya firmado. Otro cambio importante es el del nombre, una vez hecha la firma el documento pasa de tener el nombre ejemplo.pdf a ejemplo-signed.pdf, en el caso de firmar un fichero pdf, o bien se generará un archivo de sinadura con el nombre del fichero firmado: ejemplo.txt a ejemplo.sar. Por otra parte el documento firmado se puede enviar por correo electrónico ("Enviar"), se puede previsualizar ("Visualizar") o validar ("Validar").

Validar documentos #

Otra función de Sinadura es la opción de validar documentos. Esto sirve para comprobar que el documento este correctamente firmado, a la hora correcta. Otra información que también se obtiene es la identidad del firmante, con que versión de Sinadura lo ha firmado y el nombre del documento.

Documento sin validar

Documento validado


Firmando por consola #

Sinadura también permite la firma a través de linea de comandos de modo que no sea necesario utilizar la interfaz de usuario. Para ello es necesario disponer de la aplicación correctamente instalada. No es necesario realizar ningún tipo de instalación especial, simplemente basta seguir los pasos del manual de instalación para el sistema operativo correspondiente. Una vez instalada debemos hacer uso del ejecutable "ruta de instalación/bin/sinadura-console.sh" en el caso de que nos encontremos en entorno Unix y "ruta de instalación/bin/sinadura-console.bat" si nos encontramos en un entorno Windows.

Dicho ejecutable soporta los siguientes parámetros de entrada:

sign: Firmar

validate: Validar

pdf: El fichero de entrada es de tipo PDF

xades: El fichero de entrada realizará la acción indicada mediante Xades

input: Documento a firmar

output: Documento firmado.

preferences: Fichero con parámetros adicionales de configuración.

En primer lugar se debe indicar la acción que se va a realizar, bien sea Firmar(--sign) o Validar(--validate). En segundo lugar se indica el tipo de fichero de entrada: --pdf o --xades En tercer lugar, se indican el resto de parámetros: --input, --output y --preferences

En caso de que la acción sea --validate, no es necesario indicar el fichero de salida: --output

Algunos ejemplos de uso serían los siguientes:

Entorno Unix
./sinadura-console.sh --sign --pdf
      --input /home/zylk/pdf-temp/prueba.pdf 
      --output /home/zylk/sinadura/prueba-signed.pdf 
      --preferences /home/zylk/sinadura/resources/preferences/preferences-sinadura-console.properties 

./sinadura-console.sh --validate --xades
      --input /home/zylk/txt-temp/prueba.txt
      --preferences /home/zylk/sinadura/resources/preferences/preferences-sinadura-console.properties
Entorno Windows
sinadura-console.bat --sign --xades
      --input /home/zylk/pdf-temp/prueba.pdf 
      --output /home/zylk/sinadura/prueba-signed.pdf 
      --preferences /home/zylk/sinadura/resources/preferences/preferences-sinadura-console.properties 

sinadura-console.bat --validate --pdf
      --input /home/zylk/txt-temp/prueba.txt
      --preferences /home/zylk/sinadura/resources/preferences/preferences-sinadura-console.properties

Fichero de preferencias #

Junto a la instalación de Sinadura se proporciona un fichero de preferencias de ejemplo. Dicho archivo se encuentra en la ruta: "ruta de instalación"/resources/preferences/preferences-sinadura-console.properties.

A continuación se muestra el contenido del mismo:

preferences-sinadura-console.properties

preferencias.radioCertType.active=0

hardware.dispositive=/usr/lib/opensc/opensc-pkcs11.so
#hardware.dispositive=C:\\WINDOWS\\system32\\aetpkss1.dll
software.dispositive=/home/zylk/certs/cert_entidad_software_des.p12

certificate.alias=AA AA AA

ks.cache=/home/zylk/.sinadura/preferences/cache.jks
ks.trusted=/home/zylk/.sinadura/preferences/trusted.jks
ks.cache.pass=sinadura
ks.trusted.pass=sinadura

pdf.stamp.enable=true
pdf.stamp.height=122
pdf.stamp.path=/home/zylk/workspace/sinadura3/sinaduraDesktop/resources/images/sinadura150.png
pdf.stamp.y=17
pdf.stamp.x=17
pdf.stamp.width=122
pdf.visible=true
pdf.location=Bilbao
pdf.reason=powered by zylk.net
pdf.certified=0

sign.ts.enable=true
sign.ts.tsa=[http://ocsp.izenpe.com:8093]
sign.ocsp.enable=false

#callback.handler=net.esle.sinadura.core.password.ConsoleCallbackHandler
callback.handler=net.esle.sinadura.core.password.FileCallbackHandler
certificate.password=1111

proxy.http.user=user
proxy.http.pass=pass
proxy.http.system=true

La descripción detallada de cada uno de los posibles parámetros es la siguiente:

preferencias.radioCertType.active: Tipo de dispositivo a utilizar, 1 hardware (smartcards) y 0 software (p12).

hardware.dispositive: Librería de la tarjeta criptográfica en caso de firmar con smartcard (/usr/lib/opensc-pkcs11.so en linux).

software.dispositive: Fichero con el certificado en caso de firmar con empaquetados software (p12).

certificate.alias: Alias del certificado que queramos utilizar para firmar.

ks.cache: KeyStore complementario para completar la cadena de certificados. En ciertos casos tanto las tarjetas criptográficas como los empaquetados software no contienen la cadena de certificados completa, sino únicamente el certificado final. En dichos casos se recomienda añadir los certificados restantes al keystore seleccionado. Se recomienda el uso del keystore propio de la aplicación situado en "ruta de instalación"/resources/preferences , ya que es posible configurarlo a través de la interfaz de usuario (Menú: Sinadura/Preferencias, Sección: Validación/Cache).

ks.cache.pass: Contraseña de keystore especificado en el parámetro anterior. En caso de utilizar el keystore de la aplicación la password tiene que ser sinadura.

ks.trusted: KeyStore que contienelos certificados utilizados para verificar la validez de las firmas de los documentos. Estos certificados también son habitualmente llamados certificados de confianza. Se recomienda el uso del keystore propio de la aplicación situado en "ruta de instalación/resources/preferences" , ya que es posible configurarlo a través de la interfaz de usuario (Menú: Sinadura/Preferencias, Sección: Validación/Cache).

ks.trusted.pass: Contraseña de keystore especificado en el parámetro anterior. En caso de utilizar el keystore de la aplicación la password tiene que ser sinadura.

appearance.stamp.enable: Mostrar la imagen en la firma visible (true o false).

appearance.stamp.height: Altura de la imagen.

appearance.stamp.path: Imagen a mostrar en el documento.

appearance.stamp.y Coordenadas para el posicionamiento de la imagen.

appearance.stamp.x: Coordenadas para el posicionamiento de la imagen.

appearance.stamp.width: Anchura de la imagen.

appearance.visible: Firma visble (true o false).

appearance.location: Valor para el campo location del documento.

appearance.reason: Valor para el campo reason del documento.

validate.ts.enable: Habilitar timestamp (true o false) . Es recomendable tenerlo habilitado.

validate.ts.tsa: Url del servidor de timestamp a utilizar.

validate.ocsp.enable: Comprobación de revocación del certificado firmante (true o false). Es recomendable tenerlo habilitado.

callback.handler: La clase encargada de gestionar la petición de la password del certificado. Hay dos disponibles: net.esle.sinadura.core.password.FileCallbackHandler o net.esle.sinadura.core.password.ConsoleCallbackHandler. Con FileCallbackHandler se lee la password del fichero de preferencias (certificate.password), mientras que con ConsoleCallbackHandler hay que introducirla manualmente por consola.

certificate.password: Contraseña del dispositivo/certificado firmante.

proxy.http.system: Indica si tomamos por defecto la configuración proxy del sistema.

proxy.http.user: Usuario de la configuración proxy del sistema.

proxy.http.pass: Password de la configuración proxy del sistema.

Promedio (0 Votos)
Comentarios