net.openhft.chronicle.salt

Enum Signature

java.lang.Object

java.lang.Enum<Signature>

net.openhft.chronicle.salt.Signature

All Implemented Interfaces:

Serializable, Comparable<Signature>

public enum Signature
extends Enum<Signature>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Signature.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	Signature.MultiPart Wrapper for signing multi-part messages composed of a sequence of arbitrarily-sized chunks
static class	Signature.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	Signature.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	sign(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore message, net.openhft.chronicle.bytes.BytesStore secretKey) Underlying sign call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred
static net.openhft.chronicle.bytes.BytesStore	sign(net.openhft.chronicle.bytes.BytesStore result, net.openhft.chronicle.bytes.BytesStore message, Signature.SecretKey secretKey) As above, but result BytesStore is passed in first arg
static net.openhft.chronicle.bytes.BytesStore	sign(net.openhft.chronicle.bytes.BytesStore message, Signature.SecretKey secretKey) Sign a message given a secret key
static Signature	valueOf(String name) Returns the enum constant of this type with the specified name.
static Signature[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static net.openhft.chronicle.bytes.BytesStore	verify(@Nullable net.openhft.chronicle.bytes.BytesStore result, @NotNull net.openhft.chronicle.bytes.BytesStore message, net.openhft.chronicle.bytes.BytesStore publicKey) Underlying decrypt call taking explicit BytesStores Where possible the strongly-typed versions above should be preferred
static net.openhft.chronicle.bytes.BytesStore	verify(@Nullable net.openhft.chronicle.bytes.BytesStore result, @NotNull net.openhft.chronicle.bytes.BytesStore message, Signature.PublicKey publicKey) As above, but result BytesStore is passed in first arg
static @NotNull net.openhft.chronicle.bytes.BytesStore	verify(@NotNull net.openhft.chronicle.bytes.BytesStore message, Signature.PublicKey publicKey) Verify a signed message using the signer's public key

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 Signature[] 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 (Signature c : Signature.values())
    System.out.println(c);

Returns:

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

valueOf

public static Signature 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

sign

public static net.openhft.chronicle.bytes.BytesStore sign(net.openhft.chronicle.bytes.BytesStore message,
                                                          Signature.SecretKey secretKey)

Sign a message given a secret key

Parameters:

message - - the message to sign

secretKey - - the signer's private key

Returns:

- the signed message BytesStore

sign

public static net.openhft.chronicle.bytes.BytesStore sign(net.openhft.chronicle.bytes.BytesStore result,
                                                          net.openhft.chronicle.bytes.BytesStore message,
                                                          Signature.SecretKey secretKey)

As above, but result BytesStore is passed in first arg

Parameters:

result - - the ByteStore for the signed message

message - - the message to sign

secretKey - - the signer's private key

Returns:

- the signed message BytesStore (echoes arg1)

sign

public static net.openhft.chronicle.bytes.BytesStore sign(net.openhft.chronicle.bytes.BytesStore result,
                                                          net.openhft.chronicle.bytes.BytesStore message,
                                                          net.openhft.chronicle.bytes.BytesStore secretKey)

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

Parameters:

result - - the ByteStore for the signed message

message - - the message to sign

secretKey - - the signer's private key

Returns:

- the signed message BytesStore (echoes arg1)

verify

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

Verify a signed message using the signer's public key

Parameters:

message - - the signed message

publicKey - - the signer's public key

Returns:

- the unsigned message

verify

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

As above, but result BytesStore is passed in first arg

Parameters:

result - - the BytesStore for the cleartext result

message - - the signed message

publicKey - - the signer's public key

Returns:

- the cleartext BytesStore (echoes arg1)

verify

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

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

Parameters:

result - - the BytesStore for the cleartext result

message - - the signed message

publicKey - - the signer's public key

Returns:

- the cleartext BytesStore (echoes arg1)