Package com.goterl.lazysodium.interfaces

Interface SecretStream.Lazy

All Known Implementing Classes:

LazySodium, LazySodiumAndroid, LazySodiumJava

Enclosing interface:

SecretStream

public static interface SecretStream.Lazy

Method Summary

Modifier and Type	Method	Description
SecretStream.State	cryptoSecretStreamInitPull(byte[] header, Key key)	Initialises decryption using a state and a key.
SecretStream.State	cryptoSecretStreamInitPush(byte[] header, Key key)	Initialise encryption.
Key	cryptoSecretStreamKeygen()	Generates a key.
String	cryptoSecretStreamPull(SecretStream.State state, String cipher, byte[] tag)	Decrypt a message without additional data.
String	cryptoSecretStreamPush(SecretStream.State state, String message, byte tag)	Encrypt a message.
void	cryptoSecretStreamRekey(SecretStream.State state)	Explicitly rekeys.

Method Details

cryptoSecretStreamKeygen

Key cryptoSecretStreamKeygen()

Generates a key.

Returns:

Returns a key that's been through Helpers.Lazy.sodiumBin2Hex(byte[]).

cryptoSecretStreamInitPush

SecretStream.State cryptoSecretStreamInitPush(byte[] header,
 Key key)
                                       throws SodiumException

Initialise encryption.

Parameters:

header - Header to supply.

key - The key as generated by cryptoSecretStreamKeygen().

Returns:

A state which can be further processed by other functions in secret stream.

Throws:

SodiumException

cryptoSecretStreamPush

String cryptoSecretStreamPush(SecretStream.State state,
 String message,
 byte tag)
                       throws SodiumException

Encrypt a message.

Parameters:

state - State as initialised in cryptoSecretStreamInitPush(byte[], Key).

message - The message to encrypt.

tag - The tag.

Returns:

The cipher string.

Throws:

SodiumException

cryptoSecretStreamInitPull

SecretStream.State cryptoSecretStreamInitPull(byte[] header,
 Key key)
                                       throws SodiumException

Initialises decryption using a state and a key.

Parameters:

header - The header of size SecretStream.HEADERBYTES.

key - The key as generated by cryptoSecretStreamKeygen()}.

Returns:

A state for further processing of decryption functions.

Throws:

SodiumException

cryptoSecretStreamPull

String cryptoSecretStreamPull(SecretStream.State state,
 String cipher,
 byte[] tag)
                       throws SodiumException

Decrypt a message without additional data.

Parameters:

state - The state as generated by cryptoSecretStreamInitPull(byte[], Key).

cipher - The resulting encrypted message.

tag - The tag.

Returns:

The decreypted cipher, i.e the message.

Throws:

SodiumException

cryptoSecretStreamRekey

void cryptoSecretStreamRekey(SecretStream.State state)

Explicitly rekeys.

Parameters:

state - The state to update.