io.peacemakr.crypto.impl.crypto

Class ICryptoImpl

java.lang.Object

io.peacemakr.crypto.impl.crypto.ICryptoImpl

All Implemented Interfaces:

ICrypto

public class ICryptoImpl
extends java.lang.Object
implements ICrypto

Constructor Summary

Constructors

Constructor and Description
ICryptoImpl(java.lang.String apiKey, java.lang.String clientName, java.lang.String peacemakrHostname, Persister persister, org.apache.log4j.Logger logger)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decrypt(byte[] cipherText) Decrypt the opaquely packaged ciphertext and return the original plain text.
byte[]	encrypt(byte[] plainText) Encrypt the plaintext, using a random available usedomain.
byte[]	encryptInDomain(byte[] plainText, java.lang.String useDomainName) Encrypt the plaintext, but restrict which keys may be used to a Use Domain of this specific name.
protected io.peacemakr.corecrypto.AsymmetricCipher	getAsymmetricCipher(java.lang.String asymmetricCipher, int bitlength)
protected ApiClient	getClient()
java.lang.String	getDebugInfo() For visibility or debugging purposes, returns a string whihc identifies which client and configuration this client is running.
void	init()
protected CryptoConfig	loadCryptoConfig(ApiClient apiClient)
void	register() Registers to PeaceMakr as a client.
void	sync() Sync all available keys for this client.

Methods inherited from class java.lang.Object

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

Constructor Detail

ICryptoImpl

public ICryptoImpl(java.lang.String apiKey,
           java.lang.String clientName,
           java.lang.String peacemakrHostname,
           Persister persister,
           org.apache.log4j.Logger logger)

Method Detail

init

public void init()
          throws PeacemakrException

Throws:

PeacemakrException

getClient

protected ApiClient getClient()
                       throws PeacemakrException

Throws:

PeacemakrException

loadCryptoConfig

protected CryptoConfig loadCryptoConfig(ApiClient apiClient)
                                 throws ServerException

Throws:

ServerException

register

public void register()
              throws PeacemakrException

Description copied from interface: ICrypto

Registers to PeaceMakr as a client. The persister is used to detect prior registrations on this client, so safe to call multiple times. Once a successful invocation of Register is executed once, subsequent calls become a noop. One successful call is required before any cryptographic use of this SDK.

Specified by:

register in interface ICrypto

Throws:

PeacemakrException - if an exception occurs during the registration. Registration may fail with invalid apiKey, missing network connectivity, or an invalid persister. On failure, take corrections action and invoke again.

getAsymmetricCipher

protected io.peacemakr.corecrypto.AsymmetricCipher getAsymmetricCipher(java.lang.String asymmetricCipher,
                                                           int bitlength)

sync

public void sync()
          throws PeacemakrException

Description copied from interface: ICrypto

Sync all available keys for this client. This invocation will help performance of subsequent encryption and decryption calls.

Specified by:

sync in interface ICrypto

Throws:

PeacemakrException - if an exception occurs during the sync. Sync may fail, if registration was not invoked, if there's network connectivity issues, or unexpected authorization issues.

encrypt

public byte[] encrypt(byte[] plainText)
               throws PeacemakrException

Description copied from interface: ICrypto

Encrypt the plaintext, using a random available usedomain.

Specified by:

encrypt in interface ICrypto

Parameters:

plainText - Plaintext bytes to encrypt.

Returns:

Opaquely packaged ciphertext.

Throws:

PeacemakrException - On any error (network connectivity issues, authN issues, etc)

encryptInDomain

public byte[] encryptInDomain(byte[] plainText,
                     java.lang.String useDomainName)
                       throws PeacemakrException

Description copied from interface: ICrypto

Encrypt the plaintext, but restrict which keys may be used to a Use Domain of this specific name. Names of Use Domains are not unique, and this non-unique property of your Organization's Use Domains allows for graceful rotation of encryption keys off of old (retiring, stale, or compromised) Use Domains, simply by creating a new Use Domain with the same name. The transitional purity, both Use Domains may be selected for encryption use by clients restricted to one particular name. Then, retiring of one of the two Use Domains is possible without disrupting your deployed application.

Specified by:

encryptInDomain in interface ICrypto

Parameters:

plainText - Plaintext to encrypt.

useDomainName - Non-unique User Domain of your organization's.

Returns:

Opaquely packaged ciphertext.

Throws:

PeacemakrException - if an exception occurs during the encryption.

decrypt

public byte[] decrypt(byte[] cipherText)
               throws PeacemakrException

Description copied from interface: ICrypto

Decrypt the opaquely packaged ciphertext and return the original plain text.

Specified by:

decrypt in interface ICrypto

Parameters:

cipherText - CipherText to decrypt.

Returns:

original plain text.

Throws:

PeacemakrException - if an exception occurs during the decryption.

getDebugInfo

public java.lang.String getDebugInfo()

Description copied from interface: ICrypto

For visibility or debugging purposes, returns a string whihc identifies which client and configuration this client is running.

Specified by:

getDebugInfo in interface ICrypto

Returns:

a debug info.