net.openhft.chronicle.salt

Enum SealedBox

java.lang.Object

java.lang.Enum<SealedBox>

net.openhft.chronicle.salt.SealedBox

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SealedBox>

public enum SealedBox
extends java.lang.Enum<SealedBox>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SealedBox.KeyPair Helper class to handle KeyPair creation Explicitly named static methods are provided for consistency with EasyBox where they differentiate normal vs deterministic calls (As noted below, deterministic calls are not meaningful for sealed boxes)
static class	SealedBox.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	SealedBox.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

Method Summary

Modifier and Type	Method and Description
static net.openhft.chronicle.bytes.BytesStore	decrypt(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore ciphertext, 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(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore ciphertext, SealedBox.PublicKey publicKey, SealedBox.SecretKey secretKey) As above, but result BytesStore is passed in first arg
static net.openhft.chronicle.bytes.BytesStore	decrypt(net.openhft.chronicle.bytes.BytesStore ciphertext, SealedBox.PublicKey publicKey, SealedBox.SecretKey secretKey) Decrypt a message given own (receiver's) public and secret keys
static net.openhft.chronicle.bytes.BytesStore	encrypt(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore message, net.openhft.chronicle.bytes.BytesStore publicKey) 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, SealedBox.PublicKey publicKey) As above, but result BytesStore is passed in first arg
static net.openhft.chronicle.bytes.BytesStore	encrypt(net.openhft.chronicle.bytes.BytesStore message, SealedBox.PublicKey publicKey) Anonymously encrypt a message given a receivers public key
static SealedBox	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SealedBox[]	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 SealedBox[] 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 (SealedBox c : SealedBox.values())
    System.out.println(c);

Returns:

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

valueOf

public static SealedBox valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

encrypt

@NotNull
public static net.openhft.chronicle.bytes.BytesStore encrypt(@NotNull
                                                                      net.openhft.chronicle.bytes.BytesStore message,
                                                                      @NotNull
                                                                      SealedBox.PublicKey publicKey)

Anonymously encrypt a message given a receivers public key

Parameters:

message - - the cleartext message

publicKey - - the recipients public key

Returns:

- the ciphertext BytesStore corresponding to the clearText message

encrypt

@NotNull
public static net.openhft.chronicle.bytes.BytesStore encrypt(@Nullable
                                                                      net.openhft.chronicle.bytes.BytesStore result,
                                                                      @NotNull
                                                                      net.openhft.chronicle.bytes.BytesStore message,
                                                                      @NotNull
                                                                      SealedBox.PublicKey publicKey)

As above, but result BytesStore is passed in first arg

Parameters:

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

Returns:

- the ciphertext BytesStore (echoes arg1)

encrypt

@NotNull
public static net.openhft.chronicle.bytes.BytesStore encrypt(@Nullable
                                                                      net.openhft.chronicle.bytes.BytesStore result,
                                                                      @NotNull
                                                                      net.openhft.chronicle.bytes.BytesStore message,
                                                                      @NotNull
                                                                      net.openhft.chronicle.bytes.BytesStore publicKey)

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

decrypt

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

Decrypt a message given own (receiver's) public and secret keys

Parameters:

ciphertext - - the encrypted message

publicKey - - receiver's public key

secretKey - - receiver's private key

Returns:

- the cleartext BytesStore

decrypt

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

As above, but result BytesStore is passed in first arg

Parameters:

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

Returns:

- the cleartext BytesStore (echoes arg1)

decrypt

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

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