C D E F G H I M N R S W

C

calculate(byte[], int, DHState) - Method in interface com.southernstorm.noise.protocol.DHState

Performs a Diffie-Hellman calculation with this object as the private key.

CipherState - Interface in com.southernstorm.noise.protocol

Interface to an authenticated cipher for use in the Noise protocol.

CipherStatePair - Class in com.southernstorm.noise.protocol

Class that contains a pair of CipherState objects.

CipherStatePair(CipherState, CipherState) - Constructor for class com.southernstorm.noise.protocol.CipherStatePair

Constructs a pair of CipherState objects.

clearKey() - Method in interface com.southernstorm.noise.protocol.DHState

Clears the key pair.

com.southernstorm.noise.protocol - package com.southernstorm.noise.protocol

Provides classes for communicating via the Noise protocol.

COMPLETE - Static variable in class com.southernstorm.noise.protocol.HandshakeState

The handshake is complete and the data session ciphers have been split() out successfully.

copyFrom(DHState) - Method in interface com.southernstorm.noise.protocol.DHState

Copies the key values from another DH object of the same type.

copyFrom(DHState, DHState) - Method in interface com.southernstorm.noise.protocol.DHStateHybrid

Copies the key values from another DH object of the same type.

createCipher(String) - Static method in class com.southernstorm.noise.protocol.Noise

Creates a cipher object from its Noise protocol name.

createDH(String) - Static method in class com.southernstorm.noise.protocol.Noise

Creates a Diffie-Hellman object from its Noise protocol name.

createHash(String) - Static method in class com.southernstorm.noise.protocol.Noise

Creates a hash object from its Noise protocol name.

D

decryptWithAd(byte[], byte[], int, byte[], int, int) - Method in interface com.southernstorm.noise.protocol.CipherState

Decrypts a ciphertext buffer using the cipher and a block of associated data.

destroy() - Method in class com.southernstorm.noise.protocol.CipherStatePair

destroy() - Method in interface com.southernstorm.noise.protocol.Destroyable

Destroys all sensitive state in the current object.

destroy() - Method in class com.southernstorm.noise.protocol.HandshakeState

Destroyable - Interface in com.southernstorm.noise.protocol

Interface for objects that implement destroying.

DHState - Interface in com.southernstorm.noise.protocol

Interface to a Diffie-Hellman algorithm for the Noise protocol.

DHStateHybrid - Interface in com.southernstorm.noise.protocol

Additional API for DH objects that need special handling for hybrid operations.

E

encryptWithAd(byte[], byte[], int, byte[], int, int) - Method in interface com.southernstorm.noise.protocol.CipherState

Encrypts a plaintext buffer using the cipher and a block of associated data.

F

FAILED - Static variable in class com.southernstorm.noise.protocol.HandshakeState

The handshake has failed due to some kind of error.

fallback() - Method in class com.southernstorm.noise.protocol.HandshakeState

Falls back to the "XXfallback" handshake pattern.

fallback(String) - Method in class com.southernstorm.noise.protocol.HandshakeState

Falls back to another handshake pattern.

fork(byte[], int) - Method in interface com.southernstorm.noise.protocol.CipherState

Creates a new instance of this cipher and initializes it with a key.

G

generateKeyPair() - Method in interface com.southernstorm.noise.protocol.DHState

Generates a new random keypair.

generateKeyPair(DHState) - Method in interface com.southernstorm.noise.protocol.DHStateHybrid

Generates a new random keypair relative to the parameters in another object.

getAction() - Method in class com.southernstorm.noise.protocol.HandshakeState

Gets the next action that the application should perform for the handshake part of the protocol.

getCipherName() - Method in interface com.southernstorm.noise.protocol.CipherState

Gets the Noise protocol name for this cipher.

getDHName() - Method in interface com.southernstorm.noise.protocol.DHState

Gets the Noise protocol name for this Diffie-Hellman algorithm.

getFixedEphemeralKey() - Method in class com.southernstorm.noise.protocol.HandshakeState

Gets the DHState object containing a fixed local ephemeral key value for this handshake.

getFixedHybridKey() - Method in class com.southernstorm.noise.protocol.HandshakeState

Gets the DHState object containing a fixed local hybrid key value for this handshake.

getHandshakeHash() - Method in class com.southernstorm.noise.protocol.HandshakeState

Gets the current value of the handshake hash.

getKeyLength() - Method in interface com.southernstorm.noise.protocol.CipherState

Gets the length of the key values for this cipher.

getLocalKeyPair() - Method in class com.southernstorm.noise.protocol.HandshakeState

Gets the keypair object for the local static key.

getMACLength() - Method in interface com.southernstorm.noise.protocol.CipherState

Gets the length of the MAC values for this cipher.

getPrivateKey(byte[], int) - Method in interface com.southernstorm.noise.protocol.DHState

Gets the private key associated with this object.

getPrivateKeyLength() - Method in interface com.southernstorm.noise.protocol.DHState

Gets the length of private keys for this algorithm.

getProtocolName() - Method in class com.southernstorm.noise.protocol.HandshakeState

Gets the name of the Noise protocol.

getPublicKey(byte[], int) - Method in interface com.southernstorm.noise.protocol.DHState

Gets the public key associated with this object.

getPublicKeyLength() - Method in interface com.southernstorm.noise.protocol.DHState

Gets the length of public keys for this algorithm.

getReceiver() - Method in class com.southernstorm.noise.protocol.CipherStatePair

Gets the CipherState to use to receive packets from the remote party.

getRemotePublicKey() - Method in class com.southernstorm.noise.protocol.HandshakeState

Gets the public key object for the remote static key.

getRole() - Method in class com.southernstorm.noise.protocol.HandshakeState

Gets the role for this handshake.

getSender() - Method in class com.southernstorm.noise.protocol.CipherStatePair

Gets the CipherState to use to send packets to the remote party.

getSharedKeyLength() - Method in interface com.southernstorm.noise.protocol.DHState

Gets the length of shared keys for this algorithm.

H

HandshakeState - Class in com.southernstorm.noise.protocol

Interface to a Noise handshake.

HandshakeState(String, int) - Constructor for class com.southernstorm.noise.protocol.HandshakeState

Creates a new Noise handshake.

hasKey() - Method in interface com.southernstorm.noise.protocol.CipherState

Determine if this cipher object has been configured with a key.

hasLocalKeyPair() - Method in class com.southernstorm.noise.protocol.HandshakeState

Determine if this handshake has already been configured with a local static key.

hasPreSharedKey() - Method in class com.southernstorm.noise.protocol.HandshakeState

Determine if this object has already been configured with a pre-shared key.

hasPrivateKey() - Method in interface com.southernstorm.noise.protocol.DHState

Determine if this object contains a private key.

hasPublicKey() - Method in interface com.southernstorm.noise.protocol.DHState

Determine if this object contains a public key.

hasRemotePublicKey() - Method in class com.southernstorm.noise.protocol.HandshakeState

Determine if this handshake has already been configured with a remote static key.

I

initializeKey(byte[], int) - Method in interface com.southernstorm.noise.protocol.CipherState

Initializes the key on this cipher object.

INITIATOR - Static variable in class com.southernstorm.noise.protocol.HandshakeState

Enumerated value that indicates that the handshake object is handling the initiator role.

isNullPublicKey() - Method in interface com.southernstorm.noise.protocol.DHState

Determine if the public key in this object is the special null value.

M

MAX_PACKET_LEN - Static variable in class com.southernstorm.noise.protocol.Noise

Maximum length for Noise packets.

N

needsLocalKeyPair() - Method in class com.southernstorm.noise.protocol.HandshakeState

Determine if this handshake requires a local static key.

needsPreSharedKey() - Method in class com.southernstorm.noise.protocol.HandshakeState

Determine if this handshake needs a pre-shared key value and one has not been configured yet.

needsRemotePublicKey() - Method in class com.southernstorm.noise.protocol.HandshakeState

Determine if this handshake requires a remote static key.

NO_ACTION - Static variable in class com.southernstorm.noise.protocol.HandshakeState

No action is required of the application yet because the handshake has not started.

Noise - Class in com.southernstorm.noise.protocol

Utility functions for the Noise protocol library.

Noise() - Constructor for class com.southernstorm.noise.protocol.Noise

R

random(byte[]) - Static method in class com.southernstorm.noise.protocol.Noise

Generates random data using the system random number generator.

READ_MESSAGE - Static variable in class com.southernstorm.noise.protocol.HandshakeState

The HandshakeState expects the application to read the next message payload from the handshake.

readMessage(byte[], int, int, byte[], int) - Method in class com.southernstorm.noise.protocol.HandshakeState

Reads a message payload during the handshake.

receiverOnly() - Method in class com.southernstorm.noise.protocol.CipherStatePair

Destroys the sending CipherState and retains only the receiving CipherState.

RESPONDER - Static variable in class com.southernstorm.noise.protocol.HandshakeState

Enumerated value that indicates that the handshake object is handling the responder role.

S

senderOnly() - Method in class com.southernstorm.noise.protocol.CipherStatePair

Destroys the receiving CipherState and retains only the sending CipherState.

setForceFallbacks(boolean) - Static method in class com.southernstorm.noise.protocol.Noise

Force the use of plain Java fallback crypto implementations.

setNonce(long) - Method in interface com.southernstorm.noise.protocol.CipherState

Sets the nonce value.

setPreSharedKey(byte[], int, int) - Method in class com.southernstorm.noise.protocol.HandshakeState

Sets the pre-shared key for this handshake.

setPrivateKey(byte[], int) - Method in interface com.southernstorm.noise.protocol.DHState

Sets the private key for this object.

setPrologue(byte[], int, int) - Method in class com.southernstorm.noise.protocol.HandshakeState

Sets the prologue for this handshake.

setPublicKey(byte[], int) - Method in interface com.southernstorm.noise.protocol.DHState

Sets the public key for this object.

setToNullPublicKey() - Method in interface com.southernstorm.noise.protocol.DHState

Sets this object to the null public key and clears the private key.

specifyPeer(DHState) - Method in interface com.southernstorm.noise.protocol.DHStateHybrid

Specifies the local peer object prior to setting a public key on a remote object.

SPLIT - Static variable in class com.southernstorm.noise.protocol.HandshakeState

The handshake is over and the application is expected to call split() and begin data session communications.

split() - Method in class com.southernstorm.noise.protocol.HandshakeState

Splits the transport encryption CipherState objects out of this HandshakeState object once the handshake completes.

split(byte[], int, int) - Method in class com.southernstorm.noise.protocol.HandshakeState

Splits the transport encryption CipherState objects out of this HandshakeObject after mixing in a secondary symmetric key.

start() - Method in class com.southernstorm.noise.protocol.HandshakeState

Starts the handshake running.

swap() - Method in class com.southernstorm.noise.protocol.CipherStatePair

Swaps the sender and receiver.

W

WRITE_MESSAGE - Static variable in class com.southernstorm.noise.protocol.HandshakeState

The HandshakeState expects the application to write the next message payload for the handshake.

writeMessage(byte[], int, byte[], int, int) - Method in class com.southernstorm.noise.protocol.HandshakeState

Writes a message payload during the handshake.

C D E F G H I M N R S W