com.absio.broker.mapper

Class KeyFileMapper

java.lang.Object

com.absio.broker.mapper.AbstractMapper

com.absio.broker.mapper.KeyFileMapper

public class KeyFileMapper
extends AbstractMapper

This handles all key file operations with the Absio Broker™ application. It is used for create, delete and authentication of encrypted key files.

Constructor Summary

Constructors

Constructor and Description
KeyFileMapper(Session session) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	createOrUpdate(UUID userId, String passphrase, String reminder, byte[] encryptedKeyFile) Stores the encrypted keys file on the Absio Broker™ application and protects it with the provided passphrase.
void	delete() Deletes an encrypted key file from the Absio Broker™ application.
boolean	doesChecksumMatch(UUID userId, byte[] encryptedKeyFile) Generates a checksum of the encrypted keys file and checks if it matches the checksum of a keys file stored on the Absio Broker™ application.
byte[]	get(UUID userId, String passphrase) Retrieves an encrypted keys file stored on the Absio Broker™ application.
String	getReminder(UUID userId) Retrieves a user's keys file passphrase reminder stored on the Absio Broker™ application.

Methods inherited from class com.absio.broker.mapper.AbstractMapper

getClient, getCredentials, getServerTime, getSession, isAuthenticated, setSession

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyFileMapper

public KeyFileMapper(Session session)
              throws NoSuchPaddingException,
                     NoSuchAlgorithmException

Default constructor.

Parameters:

session - the session for the mapper

Throws:

NoSuchPaddingException - thrown if the default padding for symmetric encryption is not supported

NoSuchAlgorithmException - thrown when a cryptographic algorithm is not supported

Method Detail

createOrUpdate

public void createOrUpdate(UUID userId,
                           String passphrase,
                           String reminder,
                           byte[] encryptedKeyFile)
                    throws IOException,
                           BrokerException,
                           NoSuchAlgorithmException,
                           InvalidKeyException,
                           NoSuchPaddingException,
                           InterruptedException

Stores the encrypted keys file on the Absio Broker™ application and protects it with the provided passphrase.

Parameters:

userId - the user's ID

passphrase - the user's secret passphrase

reminder - optional reminder for the passphrase

encryptedKeyFile - the encrypted key file

Throws:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

NoSuchPaddingException - thrown if the default padding for symmetric encryption is not supported

NoSuchAlgorithmException - thrown when a cryptographic algorithm is not supported

InvalidKeyException - thrown when the secret key is improperly formatted

InterruptedException - thrown when there is an interruption during rate limiting

delete

public void delete()
            throws IOException,
                   BrokerException,
                   InterruptedException

Deletes an encrypted key file from the Absio Broker™ application.

Throws:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

InterruptedException - thrown when there is an interruption during rate limiting

doesChecksumMatch

public boolean doesChecksumMatch(UUID userId,
                                 byte[] encryptedKeyFile)
                          throws IOException,
                                 BrokerException,
                                 NoSuchAlgorithmException,
                                 InterruptedException

Generates a checksum of the encrypted keys file and checks if it matches the checksum of a keys file stored on the Absio Broker™ application.

Parameters:

userId - the user's ID

encryptedKeyFile - the encrypted key file

Returns:

true if the checksums matched

Throws:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

NoSuchAlgorithmException - thrown when a cryptographic algorithm is not supported

InterruptedException - thrown when there is an interruption during rate limiting

get

public byte[] get(UUID userId,
                  String passphrase)
           throws IOException,
                  BrokerException,
                  NoSuchPaddingException,
                  NoSuchAlgorithmException,
                  InvalidKeyException,
                  InterruptedException

Retrieves an encrypted keys file stored on the Absio Broker™ application.

Parameters:

userId - the user's ID

passphrase - the user's secret passphrase

Returns:

the encrypted keys file returned from Absio Broker™ application

Throws:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

NoSuchPaddingException - thrown if the default padding for symmetric encryption is not supported

NoSuchAlgorithmException - thrown when a cryptographic algorithm is not supported

InvalidKeyException - thrown when the secret key is improperly formatted

InterruptedException - thrown when there is an interruption during rate limiting

getReminder

public String getReminder(UUID userId)
                   throws IOException,
                          BrokerException,
                          InterruptedException

Retrieves a user's keys file passphrase reminder stored on the Absio Broker™ application.

Parameters:

userId - the user's ID

Returns:

the user's passphrase reminder or null

Throws:

BrokerException - thrown when the Absio Broker™ application has an issue with the request

IOException - thrown when there are any IO issues

InterruptedException - thrown when there is an interruption during rate limiting