net.openhft.chronicle.salt

Enum EasyBox

java.lang.Object

java.lang.Enum<EasyBox>

net.openhft.chronicle.salt.EasyBox

All Implemented Interfaces:

Serializable, Comparable<EasyBox>

public enum EasyBox
extends Enum<EasyBox>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EasyBox.KeyPair Helper class to handle KeyPair creation Explicitly named static methods are provided to help avoid mistakes from calling the wrong constructor overload Constructors in turn are made private
static class	EasyBox.Nonce Helper class to wrap Nonce creation and re-use A nonce should only be used for a single message exchange, then refreshed Refresh either by calling next() or stir() depending on the use case - next increments the nonce by 1 in a deterministic fashion (eg for ordered message exchange) - stir fully randomises the nonce again Explicitly named static methods are provided to help avoid mistakes from calling the wrong constructor overload
static class	EasyBox.PublicKey Helper class to manage the public part of a KeyPair A PublicKey is created internally as part of a KeyPair, and provides a strongly-typed wrapper over the underlying BytesStore
static class	EasyBox.SecretKey Helper class to manage the secret part of a KeyPair A SecretKey is created internally as part of a KeyPair, and provides a strongly-typed wrapper over the underlying BytesStore
static class	EasyBox.SharedKey Helper class to handle shared key corresponding to given key pair (or parts of) A shared key can be used when multiple messages are being exchanged between the same sender/receiver This avoids the same shared key being deduced from the sender/receiver key pair on every message, resulting in significantly better speeds

Method Summary

Modifier and Type	Method and Description
static net.openhft.chronicle.bytes.BytesStore	decrypt(@Nullable net.openhft.chronicle.bytes.BytesStore result, @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext, net.openhft.chronicle.bytes.BytesStore nonce, net.openhft.chronicle.bytes.BytesStore publicKey, net.openhft.chronicle.bytes.BytesStore secretKey) Underlying decrypt call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred
static net.openhft.chronicle.bytes.BytesStore	decrypt(@Nullable net.openhft.chronicle.bytes.BytesStore result, @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext, EasyBox.Nonce nonce, EasyBox.PublicKey publicKey, EasyBox.SecretKey secretKey) As above, but result BytesStore is passed in first arg
static @NotNull net.openhft.chronicle.bytes.BytesStore	decrypt(@NotNull net.openhft.chronicle.bytes.BytesStore ciphertext, EasyBox.Nonce nonce, EasyBox.PublicKey publicKey, EasyBox.SecretKey secretKey) Decrypt a message given a nonce, sender's public key, and receiver's private key
static net.openhft.chronicle.bytes.BytesStore	decryptShared(@Nullable net.openhft.chronicle.bytes.BytesStore result, @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext, net.openhft.chronicle.bytes.BytesStore nonce, net.openhft.chronicle.bytes.BytesStore sharedKey) Underlying decryptShared call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred
static net.openhft.chronicle.bytes.BytesStore	decryptShared(@Nullable net.openhft.chronicle.bytes.BytesStore result, @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext, EasyBox.Nonce nonce, EasyBox.SharedKey sharedKey) As above, but result BytesStore is passed in first arg
static net.openhft.chronicle.bytes.BytesStore	decryptShared(@NotNull net.openhft.chronicle.bytes.BytesStore ciphertext, EasyBox.Nonce nonce, EasyBox.SharedKey sharedKey) Decrypt a message given a nonce and a *shared* secret key The shared key should be precalculated using KeyPair.precalc Using a shared key can substantially improve performance when the same sender/receiver exchange many messages
static net.openhft.chronicle.bytes.BytesStore	encrypt(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore message, net.openhft.chronicle.bytes.BytesStore nonce, net.openhft.chronicle.bytes.BytesStore publicKey, net.openhft.chronicle.bytes.BytesStore secretKey) Underlying encrypt call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred
static net.openhft.chronicle.bytes.BytesStore	encrypt(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore message, EasyBox.Nonce nonce, EasyBox.PublicKey publicKey, EasyBox.SecretKey secretKey) As above, but result BytesStore is passed in first arg
static net.openhft.chronicle.bytes.BytesStore	encrypt(net.openhft.chronicle.bytes.BytesStore message, EasyBox.Nonce nonce, EasyBox.PublicKey publicKey, EasyBox.SecretKey secretKey) Encrypt a message given a nonce, receivers public key, and own private key
static net.openhft.chronicle.bytes.BytesStore	encryptShared(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore message, net.openhft.chronicle.bytes.BytesStore nonce, net.openhft.chronicle.bytes.BytesStore sharedKey) Underlying encryptShared call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred
static net.openhft.chronicle.bytes.BytesStore	encryptShared(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore message, EasyBox.Nonce nonce, EasyBox.SharedKey sharedKey) As above, but result BytesStore is passed in first arg
static net.openhft.chronicle.bytes.BytesStore	encryptShared(net.openhft.chronicle.bytes.BytesStore message, EasyBox.Nonce nonce, EasyBox.SharedKey sharedKey) Encrypt a message given a nonce and a *shared* secret key The shared key should be precalculated using KeyPair.precalc Using a shared key can substantially improve performance when the same sender/receiver exchange many messages
static EasyBox	valueOf(String name) Returns the enum constant of this type with the specified name.
static EasyBox[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static EasyBox[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EasyBox c : EasyBox.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EasyBox valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

encrypt

public static net.openhft.chronicle.bytes.BytesStore encrypt(net.openhft.chronicle.bytes.BytesStore message,
                                                             EasyBox.Nonce nonce,
                                                             EasyBox.PublicKey publicKey,
                                                             EasyBox.SecretKey secretKey)

Encrypt a message given a nonce, receivers public key, and own private key

Parameters:

message - - the cleartext message

nonce - - one-off tag associated with this message exchange. Public

publicKey - - the recipients public key

secretKey - - the sender's private key

Returns:

- the ciphertext BytesStore corresponding to the clearText message

encrypt

public static net.openhft.chronicle.bytes.BytesStore encrypt(net.openhft.chronicle.bytes.BytesStore result,
                                                             net.openhft.chronicle.bytes.BytesStore message,
                                                             EasyBox.Nonce nonce,
                                                             EasyBox.PublicKey publicKey,
                                                             EasyBox.SecretKey secretKey)

As above, but result BytesStore is passed in first arg

Parameters:

result - - the ByteStore for the ciphertext result remaining params as above

message - - the cleartext message

nonce - - one-off tag associated with this message exchange. Public

publicKey - - the recipients public key

secretKey - - the sender's private key

Returns:

- the ciphertext BytesStore (echoes arg1)

encrypt

public static net.openhft.chronicle.bytes.BytesStore encrypt(net.openhft.chronicle.bytes.BytesStore result,
                                                             net.openhft.chronicle.bytes.BytesStore message,
                                                             net.openhft.chronicle.bytes.BytesStore nonce,
                                                             net.openhft.chronicle.bytes.BytesStore publicKey,
                                                             net.openhft.chronicle.bytes.BytesStore secretKey)

Underlying encrypt call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred

Parameters:

result - - the ByteStore for the ciphertext result remaining params as above

message - - the cleartext message

nonce - - one-off tag associated with this message exchange. Public

publicKey - - the recipients public key

secretKey - - the sender's private key

Returns:

- the ciphertext BytesStore (echoes arg1)

encryptShared

public static net.openhft.chronicle.bytes.BytesStore encryptShared(net.openhft.chronicle.bytes.BytesStore message,
                                                                   EasyBox.Nonce nonce,
                                                                   EasyBox.SharedKey sharedKey)

Encrypt a message given a nonce and a *shared* secret key The shared key should be precalculated using KeyPair.precalc Using a shared key can substantially improve performance when the same sender/receiver exchange many messages

Parameters:

message - - the cleartext message

nonce - - one-off tag associated with this message exchange. Public

sharedKey - - the shared key formed from recipient's public and sender's private key

Returns:

- the ciphertext BytesStore corresponding to the clearText message

encryptShared

public static net.openhft.chronicle.bytes.BytesStore encryptShared(net.openhft.chronicle.bytes.BytesStore result,
                                                                   net.openhft.chronicle.bytes.BytesStore message,
                                                                   EasyBox.Nonce nonce,
                                                                   EasyBox.SharedKey sharedKey)

As above, but result BytesStore is passed in first arg

Parameters:

result - - the BytesStore for the ciphertext result remaining params as above

message - - the cleartext message

nonce - - one-off tag associated with this message exchange. Public

sharedKey - - the shared key formed from recipient's public and sender's private key

Returns:

- the ciphertext BytesStore (echoes arg1)

encryptShared

public static net.openhft.chronicle.bytes.BytesStore encryptShared(net.openhft.chronicle.bytes.BytesStore result,
                                                                   net.openhft.chronicle.bytes.BytesStore message,
                                                                   net.openhft.chronicle.bytes.BytesStore nonce,
                                                                   net.openhft.chronicle.bytes.BytesStore sharedKey)

Underlying encryptShared call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred

Parameters:

result - - the BytesStore for the ciphertext result remaining params as above

message - - the cleartext message

nonce - - one-off tag associated with this message exchange. Public

sharedKey - - the shared key formed from recipient's public and sender's private key

Returns:

- the ciphertext BytesStore (echoes arg1)

decrypt

@NotNull
public static @NotNull net.openhft.chronicle.bytes.BytesStore decrypt(@NotNull
                                                                               @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext,
                                                                               EasyBox.Nonce nonce,
                                                                               EasyBox.PublicKey publicKey,
                                                                               EasyBox.SecretKey secretKey)

Decrypt a message given a nonce, sender's public key, and receiver's private key

Parameters:

ciphertext - - the encrypted message

nonce - - one-off tag associated with this message exchange. Public

publicKey - - sender's public key

secretKey - - receiver's private key

Returns:

- the cleartext BytesStore

decrypt

public static net.openhft.chronicle.bytes.BytesStore decrypt(@Nullable
                                                             @Nullable net.openhft.chronicle.bytes.BytesStore result,
                                                             @NotNull
                                                             @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext,
                                                             EasyBox.Nonce nonce,
                                                             EasyBox.PublicKey publicKey,
                                                             EasyBox.SecretKey secretKey)

As above, but result BytesStore is passed in first arg

Parameters:

result - - the BytesStore for the cleartext result remaining params as above

ciphertext - - the encrypted message

nonce - - one-off tag associated with this message exchange. Public

publicKey - - sender's public key

secretKey - - receiver's private key

Returns:

- the cleartext BytesStore (echoes arg1)

decrypt

public static net.openhft.chronicle.bytes.BytesStore decrypt(@Nullable
                                                             @Nullable net.openhft.chronicle.bytes.BytesStore result,
                                                             @NotNull
                                                             @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext,
                                                             net.openhft.chronicle.bytes.BytesStore nonce,
                                                             net.openhft.chronicle.bytes.BytesStore publicKey,
                                                             net.openhft.chronicle.bytes.BytesStore secretKey)

Underlying decrypt call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred

Parameters:

result - - the BytesStore for the cleartext result remaining params as above

ciphertext - - the encrypted message

nonce - - one-off tag associated with this message exchange. Public

publicKey - - sender's public key

secretKey - - receiver's private key

Returns:

- the cleartext BytesStore (echoes arg1)

decryptShared

public static net.openhft.chronicle.bytes.BytesStore decryptShared(@NotNull
                                                                   @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext,
                                                                   EasyBox.Nonce nonce,
                                                                   EasyBox.SharedKey sharedKey)

Decrypt a message given a nonce and a *shared* secret key The shared key should be precalculated using KeyPair.precalc Using a shared key can substantially improve performance when the same sender/receiver exchange many messages

Parameters:

ciphertext - - the ciphertext message

nonce - - one-off tag associated with this message exchange. Public

sharedKey - - the shared key formed from sender's public and recipient's private key

Returns:

- the cleartext BytesStore corresponding to the cipherText message

decryptShared

public static net.openhft.chronicle.bytes.BytesStore decryptShared(@Nullable
                                                                   @Nullable net.openhft.chronicle.bytes.BytesStore result,
                                                                   @NotNull
                                                                   @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext,
                                                                   EasyBox.Nonce nonce,
                                                                   EasyBox.SharedKey sharedKey)

As above, but result BytesStore is passed in first arg

Parameters:

result - - the BytesStore for the cleartext result remaining params as above

ciphertext - - the ciphertext message

nonce - - one-off tag associated with this message exchange. Public

sharedKey - - the shared key formed from sender's public and recipient's private key

Returns:

- the cleartext BytesStore (echoes arg1)

decryptShared

public static net.openhft.chronicle.bytes.BytesStore decryptShared(@Nullable
                                                                   @Nullable net.openhft.chronicle.bytes.BytesStore result,
                                                                   @NotNull
                                                                   @NotNull net.openhft.chronicle.bytes.BytesStore ciphertext,
                                                                   net.openhft.chronicle.bytes.BytesStore nonce,
                                                                   net.openhft.chronicle.bytes.BytesStore sharedKey)

Underlying decryptShared call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred

Parameters:

result - - the BytesStore for the cleartext result remaining params as above

ciphertext - - the ciphertext message

nonce - - one-off tag associated with this message exchange. Public

sharedKey - - the shared key formed from sender's public and recipient's private key

Returns:

- the cleartext BytesStore (echoes arg1)