es.accv.arangi.device

Class KeyStoreManager

java.lang.Object

es.accv.arangi.base.ArangiObject

es.accv.arangi.base.device.DeviceManager

es.accv.arangi.base.device.AbstractKeyStoreManager

es.accv.arangi.base.device.KeyStoreManager

es.accv.arangi.device.KeyStoreManager

All Implemented Interfaces:

ACCVDeviceManager

public class KeyStoreManager
extends es.accv.arangi.base.device.KeyStoreManager
implements ACCVDeviceManager

Clase para el manejo de keystores de la ACCV (Ficheros PKCS#12 que se entregan a los ciudadanos).

Ejemplo de uso:

IDocument document = new FileDocument(new File ("/documento.txt"));
KeyStoreManager manager = new KeyStoreManager (new File ("/keystores/ks.pk12"), "1234");
System.out.println ("Certificate: " + manager.getCertificate());
System.out.println ("Firma: " + manager.signDocument(document));

Author:

José M Gutiérrez

Field Summary

Fields inherited from class es.accv.arangi.base.device.AbstractKeyStoreManager

STORE_TYPE_APPLE, STORE_TYPE_CA_WINDOWS, STORE_TYPE_JKS, STORE_TYPE_MOZILLA, STORE_TYPE_PERSONAL_WINDOWS, STORE_TYPE_PKCS12

Fields inherited from class es.accv.arangi.base.device.DeviceManager

SELFSIGNED_CERTIFICATE_DN, SUN_PROVIDER_PREFIX

Fields inherited from class es.accv.arangi.base.ArangiObject

arangiTemporalFolder, CRYPTOGRAPHIC_PROVIDER, CRYPTOGRAPHIC_PROVIDER_NAME, DEFAULT_HASHING_ALGORITHM, DEFAULT_SIGNING_ALGORITHM, NUM_RETRIES

Constructor Summary

Constructors

Constructor and Description
KeyStoreManager(java.io.File ksFile, java.lang.String pin) Inicializa un gestor de KeyStore con el fichero pasado como parámetro.
KeyStoreManager(java.io.InputStream is, java.lang.String pin) Inicializa un gestor de KeyStores mediante un stream al fichero

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAuthenticationAlias() Obtiene alias para autenticar contenido en el dispositivo.
java.security.cert.X509Certificate	getAuthenticationCertificate() Obtiene el certificado para autenticar que contiene el dispositivo
java.lang.String	getCipherAlias() Obtiene alias para cifrar contenido en el dispositivo.
java.security.cert.X509Certificate	getCipherCertificate() Obtiene el certificado para cifrar que contiene el dispositivo
static KeyStoreManager	getEmptyKeyStore(java.lang.String storeType, java.lang.String pin) Crea un fichero PKCS#12 vacío
java.lang.String	getSignatureAlias() Obtiene alias para firmar contenido en el dispositivo.
java.security.cert.X509Certificate	getSignatureCertificate() Obtiene el certificado para firmar que contiene el dispositivo
byte[]	signBytesHash(byte[] hash) Firma un documento, cuyo hash se pasa como parámetro.
byte[]	signDocument(es.accv.arangi.base.document.IDocument document) Firma el documento pasado como parámetro.
byte[]	signDocument(java.io.InputStream document) Firma el documento pasado como parámetro en forma de stream de lectura.

Methods inherited from class es.accv.arangi.base.device.KeyStoreManager

changeToJks, changeToPkcs12, close, getP12Base64, importAliasFromKeystore, initialize, isAliasFree, main, save, save, saveToJks, saveToPkcs12

Methods inherited from class es.accv.arangi.base.device.AbstractKeyStoreManager

changeAlias, changePin, clear, decrypt, deleteObjects, deletePrivateKey, encrypt, generateKeyPair, generateKeyPair, generatePKCS10, getAliasNamesList, getCertificate, getCertificates, getKeyStore, getKeyStoreType, getPrivateKey, getPrivateKey, getPublicKey, importAliasFromKeystore, importCertificate, importCertificate, importFromKeystore, signBytesHash, signBytesHash, signDocument, signDocument, signDocument, signDocument

Methods inherited from class es.accv.arangi.base.device.DeviceManager

decryptWithSessionKey, encrypt, encrypt, encryptWithSessionKey, encryptWithSessionKey

Methods inherited from class es.accv.arangi.base.ArangiObject

getArangiTemporalFolder, getCryptographicProvider, saveTemporalFile, saveToArangiTemporalFolder

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStoreManager

public KeyStoreManager(java.io.File ksFile,
               java.lang.String pin)
                throws es.accv.arangi.base.exception.device.DeviceNotFoundException,
                       es.accv.arangi.base.exception.device.ClosingStreamException,
                       es.accv.arangi.base.exception.device.OpeningDeviceException,
                       es.accv.arangi.base.exception.device.IncorrectPINException

Inicializa un gestor de KeyStore con el fichero pasado como parámetro.

Parameters:

ksFile - Fichero del Keystore (PKCS#12 o JKS)

pin - PIN del dispositivo

Throws:

es.accv.arangi.base.exception.device.DeviceNotFoundException - El fichero no existe

es.accv.arangi.base.exception.device.ClosingStreamException - No se ha podido cerrar correctamente el stream de lectura del fichero

es.accv.arangi.base.exception.device.OpeningDeviceException - Error no controlado abriendo el dispositivo

es.accv.arangi.base.exception.device.IncorrectPINException - El PIN proporcionado para abrir el dispositivo no es correcto

KeyStoreManager

public KeyStoreManager(java.io.InputStream is,
               java.lang.String pin)
                throws es.accv.arangi.base.exception.device.DeviceNotFoundException,
                       es.accv.arangi.base.exception.device.ReadingStreamException,
                       es.accv.arangi.base.exception.device.OpeningDeviceException,
                       es.accv.arangi.base.exception.device.IncorrectPINException

Inicializa un gestor de KeyStores mediante un stream al fichero

Parameters:

is - Stream de lectura al fichero del Keystore (PKCS#12 o JKS)

pin - PIN del dispositivo

Throws:

es.accv.arangi.base.exception.device.DeviceNotFoundException - El stream de lectura pasado como parámetro es nulo

es.accv.arangi.base.exception.device.ReadingStreamException - Error leyendo el stream de lectura

es.accv.arangi.base.exception.device.OpeningDeviceException - Error no controlado abriendo el dispositivo

es.accv.arangi.base.exception.device.IncorrectPINException - El PIN proporcionado para abrir el dispositivo no es correcto

Method Detail

signDocument

public byte[] signDocument(es.accv.arangi.base.document.IDocument document)
                    throws es.accv.arangi.base.exception.document.HashingException,
                           es.accv.arangi.base.exception.device.LoadingObjectException,
                           es.accv.arangi.base.exception.signature.SignatureException

Description copied from interface: ACCVDeviceManager

Firma el documento pasado como parámetro.

Specified by:

signDocument in interface ACCVDeviceManager

Parameters:

document - Documento a firmar

Returns:

Array de bytes con la firma. La firma será el resultado de aplicar los algoritmos SHA-1 y RSA al documento.

Throws:

es.accv.arangi.base.exception.document.HashingException - No es posible obtener el hash del documento o su versión en formato DER durante el proceso de firma

es.accv.arangi.base.exception.device.LoadingObjectException - No ha sido posible cargar la clave privada usada para realizar la firma

es.accv.arangi.base.exception.signature.SignatureException - Error durante el proceso de firma

signDocument

public byte[] signDocument(java.io.InputStream document)
                    throws es.accv.arangi.base.exception.device.AliasNotFoundException,
                           es.accv.arangi.base.exception.document.HashingException,
                           es.accv.arangi.base.exception.device.LoadingObjectException,
                           es.accv.arangi.base.exception.signature.SignatureException

Description copied from interface: ACCVDeviceManager

Firma el documento pasado como parámetro en forma de stream de lectura.

Specified by:

signDocument in interface ACCVDeviceManager

Parameters:

document - Stream de lectura al contenido del documento a firmar

Returns:

Array de bytes con la firma. La firma será el resultado de aplicar los algoritmos SHA-1 y RSA al documento.

Throws:

es.accv.arangi.base.exception.device.AliasNotFoundException - El alias donde se encuentra la clave privada usada para realizar la firma no existe

es.accv.arangi.base.exception.document.HashingException - No es posible obtener el hash del documento o su versión en formato DER durante el proceso de firma

es.accv.arangi.base.exception.device.LoadingObjectException - No ha sido posible cargar la clave privada usada para realizar la firma

es.accv.arangi.base.exception.signature.SignatureException - Error durante el proceso de firma

signBytesHash

public byte[] signBytesHash(byte[] hash)
                     throws es.accv.arangi.base.exception.document.HashingException,
                            es.accv.arangi.base.exception.device.AliasNotFoundException,
                            es.accv.arangi.base.exception.device.LoadingObjectException,
                            es.accv.arangi.base.exception.device.CipherException

Description copied from interface: ACCVDeviceManager

Firma un documento, cuyo hash se pasa como parámetro.

Specified by:

signBytesHash in interface ACCVDeviceManager

Parameters:

hash - Hash del documento a firmar

Returns:

Array de bytes con la firma. La firma será el cifrado RSA del hash con la clave privada asociada al alias.

Throws:

es.accv.arangi.base.exception.document.HashingException - El hash pasado es nulo o no se puede obtener con él el objeto DER para la firma

es.accv.arangi.base.exception.device.AliasNotFoundException - El alias donde se encuentra la clave privada usada para realizar la firma no existe

es.accv.arangi.base.exception.device.LoadingObjectException - No ha sido posible cargar la clave privada usada para realizar la firma

es.accv.arangi.base.exception.device.CipherException - Error durante el proceso de cifrado

getSignatureAlias

public java.lang.String getSignatureAlias()
                                   throws es.accv.arangi.base.exception.device.LoadingObjectException

Description copied from interface: ACCVDeviceManager

Obtiene alias para firmar contenido en el dispositivo.

Specified by:

getSignatureAlias in interface ACCVDeviceManager

Returns:

Alias para firmar contenido en el dispositivo

Throws:

es.accv.arangi.base.exception.device.LoadingObjectException - El dispositivo está vacío o no se puede obtener el alias

getCipherAlias

public java.lang.String getCipherAlias()
                                throws es.accv.arangi.base.exception.device.LoadingObjectException

Description copied from interface: ACCVDeviceManager

Obtiene alias para cifrar contenido en el dispositivo.

Specified by:

getCipherAlias in interface ACCVDeviceManager

Returns:

Alias para cifrar contenido en el dispositivo

Throws:

es.accv.arangi.base.exception.device.LoadingObjectException - El dispositivo está vacío o no se puede obtener el alias

getAuthenticationAlias

public java.lang.String getAuthenticationAlias()
                                        throws es.accv.arangi.base.exception.device.LoadingObjectException

Description copied from interface: ACCVDeviceManager

Obtiene alias para autenticar contenido en el dispositivo.

Specified by:

getAuthenticationAlias in interface ACCVDeviceManager

Returns:

Alias para autenticar contenido en el dispositivo

Throws:

es.accv.arangi.base.exception.device.LoadingObjectException - El dispositivo está vacío o no se puede obtener el alias

getSignatureCertificate

public java.security.cert.X509Certificate getSignatureCertificate()
                                                           throws es.accv.arangi.base.exception.device.LoadingObjectException

Description copied from interface: ACCVDeviceManager

Obtiene el certificado para firmar que contiene el dispositivo

Specified by:

getSignatureCertificate in interface ACCVDeviceManager

Returns:

Certificado para firmar contenido en el dispositivo

Throws:

es.accv.arangi.base.exception.device.LoadingObjectException - El dispositivo está vacío o no se puede obtener el certificado

getCipherCertificate

public java.security.cert.X509Certificate getCipherCertificate()
                                                        throws es.accv.arangi.base.exception.device.LoadingObjectException

Description copied from interface: ACCVDeviceManager

Obtiene el certificado para cifrar que contiene el dispositivo

Specified by:

getCipherCertificate in interface ACCVDeviceManager

Returns:

Certificado para cifrar contenido en el dispositivo

Throws:

es.accv.arangi.base.exception.device.LoadingObjectException - El dispositivo está vacío o no se puede obtener el certificado

getAuthenticationCertificate

public java.security.cert.X509Certificate getAuthenticationCertificate()
                                                                throws es.accv.arangi.base.exception.device.LoadingObjectException

Description copied from interface: ACCVDeviceManager

Obtiene el certificado para autenticar que contiene el dispositivo

Specified by:

getAuthenticationCertificate in interface ACCVDeviceManager

Returns:

Certificado para autenticar contenido en el dispositivo

Throws:

es.accv.arangi.base.exception.device.LoadingObjectException - El dispositivo está vacío o no se puede obtener el certificado

getEmptyKeyStore

public static KeyStoreManager getEmptyKeyStore(java.lang.String storeType,
                               java.lang.String pin)
                                        throws es.accv.arangi.base.exception.device.OpeningDeviceException

Crea un fichero PKCS#12 vacío

Parameters:

storeType - Tipo de keystore (STORE_TYPE_JKS o STORE_TYPE_PKCS12 de la clase KeyStoreManager de Arangí Base)

pin - Contraseña del keystore

Returns:

Manager al keystore recien creado

Throws:

es.accv.arangi.base.exception.device.OpeningDeviceException - Excepciones creando y serializando el keystore