io.peacemakr.crypto

Interface ICrypto

All Known Implementing Classes:

ICryptoImpl

public interface ICrypto

Created by interstellarPotato on 05/15/2019.

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.
java.lang.String	getDebugInfo() For visibility or debugging purposes, returns a string whihc identifies which client and configuration this client is running.
void	register() Registers to PeaceMakr as a client.
void	sync() Sync all available keys for this client.

Method Detail

register

void register()
              throws PeacemakrException

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.

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.

sync

void sync()
          throws PeacemakrException

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

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

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

Encrypt the plaintext, using a random available usedomain.

Parameters:

plainText - Plaintext bytes to encrypt.

Returns:

Opaquely packaged ciphertext.

Throws:

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

encryptInDomain

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

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.

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.

java.io.UnsupportedEncodingException - if unsupported encoding has been used.

decrypt

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

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

Parameters:

cipherText - CipherText to decrypt.

Returns:

original plain text.

Throws:

PeacemakrException - if an exception occurs during the decryption.

getDebugInfo

java.lang.String getDebugInfo()

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

Returns:

a debug info.