es.accv.arangi.base.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

public class KeyStoreManager
extends AbstractKeyStoreManager

Clase para tratar almacenes de claves en formato software. Los tipos que se pueden tratar con esta clase son PKCS#12 y JKS.

Ejemplo de uso:

IDocument document = new FileDocument(new File ("/documento.txt"));
KeyStoreManager manager = new KeyStoreManager (new File ("/keystores/ks.pk12"), "1234");
String aliases = manager.getAliasNamesList();
for (int i=0;i System.out.println ("Certificate: " + manager.getCertificate(aliases[i]));
System.out.println ("Firma: " + manager.signDocument(document, aliases[i])); // Firma con la clave privada del alias
}

A la hora de usar los métodos hay que tener en cuenta las particularidades de cada almacén de claves. Por ejemplo, el formato PKCS#12 no permite que existan certificados solitarios en un alias, necesariamente deben ir acompañados de su correspondiente clave privada.

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 almacenes de claves software.
KeyStoreManager(java.io.InputStream is, java.lang.String pin) Inicializa un gestor de almacenes de claves software mediante un stream de lectura.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	changeToJks() Cambia el formato a JKS.
byte[]	changeToPkcs12() Cambia el formato a PKCS#12.
void	close() Si el cierre se produce en un keystore en memoria, todos los cambios se perderán a no ser que se haya persistido antes en disco.
static KeyStoreManager	getEmptyKeyStore(java.lang.String storeType, java.lang.String pin) Crea un fichero PKCS#12 vacío
static java.lang.String	getP12Base64(java.security.KeyPair rsaKeys, java.security.cert.X509Certificate certificate, java.lang.String alias, java.lang.String pin) Crea un fichero PKCS#12 que contiene en un alias el certificado y el par de claves que se pasan como parámetro.
void	importAliasFromKeystore(java.io.InputStream is, java.lang.String password, java.lang.String labelOrigen, java.lang.String labelDestino) Importa los elementos bajo el labelOrigen (certificado y/o clave privada) a la etiqueta labelDestino.
void	initialize()
boolean	isAliasFree(java.lang.String alias) Indica si existen objetos con cierto alias
static void	main(java.lang.String[] args)
void	save(java.io.File file) Guarda el keystore con el que se está trabajando en disco.
void	save(java.io.OutputStream out) Guarda el keystore con el que se está trabajando en un stream de salida.
void	saveToJks(java.io.File destination) Guarda en formato JKS el keystore que se está tratando.
void	saveToPkcs12(java.io.File destination) Guarda en formato PKCS#12 el keystore que se está tratando.

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 DeviceNotFoundException,
                       ClosingStreamException,
                       OpeningDeviceException,
                       IncorrectPINException

Inicializa un gestor de almacenes de claves software.

Parameters:

ksFile - Fichero keystore (PKCS#12 o JKS)

pin - PIN del dispositivo

Throws:

DeviceNotFoundException - El fichero no existe

ClosingStreamException - No se ha podido cerrar correctamente el stream de lectura del fichero

OpeningDeviceException - Error no controlado abriendo el dispositivo

IncorrectPINException - El PIN proporcionado para abrir el dispositivo no es correcto

KeyStoreManager

public KeyStoreManager(java.io.InputStream is,
               java.lang.String pin)
                throws DeviceNotFoundException,
                       ReadingStreamException,
                       OpeningDeviceException,
                       IncorrectPINException

Inicializa un gestor de almacenes de claves software mediante un stream de lectura.

Parameters:

is - Stream de lectura al keystore (PKCS#12 o JKS)

pin - PIN del dispositivo

Throws:

DeviceNotFoundException - El stream de lectura pasado como parámetro es nulo

ReadingStreamException - Error leyendo el stream de lectura

OpeningDeviceException - Error no controlado abriendo el dispositivo

IncorrectPINException - El PIN proporcionado para abrir el dispositivo no es correcto

Method Detail

close

public void close()

Si el cierre se produce en un keystore en memoria, todos los cambios se perderán a no ser que se haya persistido antes en disco. Si este objeto se inicializó con un fichero, en el momento de cerrar se persistirán los cambios en él.

Specified by:

close in class DeviceManager

importAliasFromKeystore

public void importAliasFromKeystore(java.io.InputStream is,
                           java.lang.String password,
                           java.lang.String labelOrigen,
                           java.lang.String labelDestino)
                             throws DeviceNotFoundException,
                                    ReadingStreamException,
                                    AliasNotFoundException,
                                    LoadingObjectException,
                                    SavingObjectException,
                                    OpeningDeviceException,
                                    IncorrectPINException

Description copied from class: DeviceManager

Importa los elementos bajo el labelOrigen (certificado y/o clave privada) a la etiqueta labelDestino. El almacén de claves origen puede ser en este caso de tipo JKS o PKCS#12.
NOTA: Sólo se importarán claves privadas RSA.

Specified by:

importAliasFromKeystore in class DeviceManager

Parameters:

is - Stream de lectura para obtener el almacén de claves (JKS o PKCS#12)

password - Contraseña del almacén de claves

labelOrigen - Etiqueta donde se encuentra la información a importar en el almacén de claves origen. Si tiene valor nulo se importan todas las etiquetas.

labelDestino - Etiqueta donde se importará la información en el almacén de claves destino. Si labelOrigen es nulo este parámetro no se utilizará. Si labelOrigen no es nulo pero este parámetro sí, la información se guardará bajo la etiqueta labelOrigen (o su nombre alternativo si la etiqueta labelOrigen ya existe en el almacén de claves destino).

Throws:

DeviceNotFoundException - El stream de lectura es nulo

ReadingStreamException - No ha sido posible leer el stream de lectura

AliasNotFoundException - El alias 'labelOrigen' no existe en el keystore origen

LoadingObjectException - Se ha producido un error al asociar una clave y un certificado en el almacen de claves destino

SavingObjectException - No se pueden guardar los objetos en el dispositivo destino

OpeningDeviceException - Error no controlado abriendo el dispositivo

IncorrectPINException - El PIN proporcionado para abrir el dispositivo no es correcto

isAliasFree

public boolean isAliasFree(java.lang.String alias)

Description copied from class: DeviceManager

Indica si existen objetos con cierto alias

Specified by:

isAliasFree in class AbstractKeyStoreManager

Returns:

True si el alias está libre. False si existe al menos un objeto indexado con ese alias

getP12Base64

public static java.lang.String getP12Base64(java.security.KeyPair rsaKeys,
                            java.security.cert.X509Certificate certificate,
                            java.lang.String alias,
                            java.lang.String pin)
                                     throws java.lang.Exception

Crea un fichero PKCS#12 que contiene en un alias el certificado y el par de claves que se pasan como parámetro. El método devuelve el fichero codificado en base64

Parameters:

rsaKeys - Par de claves o null si sólo se quiere añadir el certificado

certificate - Certificado

alias - Alias donde se guardará el certificado y el par de claves

pin - Contraseña del keystore

Returns:

Fichero keystore creado en formato base64

Throws:

java.lang.Exception - Excepciones tratando y serializando el keystore

getEmptyKeyStore

public static KeyStoreManager getEmptyKeyStore(java.lang.String storeType,
                               java.lang.String pin)
                                        throws OpeningDeviceException

Crea un fichero PKCS#12 vacío

Parameters:

storeType - Tipo de keystore (AbstractKeyStoreManager.STORE_TYPE_JKS o AbstractKeyStoreManager.STORE_TYPE_PKCS12)

pin - Contraseña del keystore

Returns:

Manager al keystore recien creado

Throws:

OpeningDeviceException - Excepciones creando y serializando el keystore

saveToPkcs12

public void saveToPkcs12(java.io.File destination)
                  throws SaveDeviceException,
                         LoadingObjectException

Guarda en formato PKCS#12 el keystore que se está tratando.

Parameters:

destination - Fichero destino

Throws:

SaveDeviceException - No es posible escribir en el fichero o no es posible guardar alguno de los elementos del dispositivo

SaveDeviceException - Error guardando el dispositivo en fichero.

LoadingObjectException - No se pueden cargar ciertos elementos del almacén de claves origen para pasarlos al destino

saveToJks

public void saveToJks(java.io.File destination)
               throws SaveDeviceException,
                      LoadingObjectException

Guarda en formato JKS el keystore que se está tratando.

Parameters:

destination - Fichero destino

Throws:

SaveDeviceException - No es posible escribir en el fichero o no es posible guardar alguno de los elementos del dispositivo

SaveDeviceException - Error guardando el dispositivo en fichero.

LoadingObjectException - No se pueden cargar ciertos elementos del almacén de claves origen para pasarlos al destino

changeToPkcs12

public byte[] changeToPkcs12()
                      throws SaveDeviceException,
                             LoadingObjectException

Cambia el formato a PKCS#12.

Returns:

Contenido del fichero PKCS#12

Throws:

SaveDeviceException - No es posible escribir en el fichero o no es posible guardar alguno de los elementos del dispositivo

SaveDeviceException - Error guardando el dispositivo en fichero.

LoadingObjectException - No se pueden cargar ciertos elementos del almacén de claves origen para pasarlos al destino

changeToJks

public byte[] changeToJks()
                   throws SaveDeviceException,
                          LoadingObjectException

Cambia el formato a JKS.

Returns:

Contenido del fichero JKS

Throws:

SaveDeviceException - No es posible escribir en el fichero o no es posible guardar alguno de los elementos del dispositivo

SaveDeviceException - Error guardando el dispositivo en fichero.

LoadingObjectException - No se pueden cargar ciertos elementos del almacén de claves origen para pasarlos al destino

save

public void save(java.io.OutputStream out)
          throws SaveDeviceException

Guarda el keystore con el que se está trabajando en un stream de salida.

Parameters:

out - Stream de salida donde se guardará el keystore

Throws:

SaveDeviceException - No es posible escribir en el stream de salida o no es posible guardar alguno de los elementos del dispositivo

save

public void save(java.io.File file)
          throws SaveDeviceException

Guarda el keystore con el que se está trabajando en disco.

Parameters:

file - Fichero donde se guardará el keystore

Throws:

SaveDeviceException - No es posible escribir en el fichero o no es posible guardar alguno de los elementos del dispositivo

initialize

public void initialize()
                throws OpeningDeviceException,
                       IncorrectPINException

Specified by:

initialize in class AbstractKeyStoreManager

Throws:

OpeningDeviceException

IncorrectPINException

main

public static void main(java.lang.String[] args)