Method Details

• getProtocolName

  public String getProtocolName()

  Gets the name of the Noise protocol.

  Returns:

  The protocol name.

• getRole

  public int getRole()

  Gets the role for this handshake.

  Returns:

  The role, HandshakeState.INITIATOR or HandshakeState.RESPONDER.

• getLocalKeyPair

  public DHState getLocalKeyPair()

  Gets the keypair object for the local static key.

  Returns:

  The keypair, or null if a local static key is not required.

• getLocalEphemeralKeyPair

  public DHState getLocalEphemeralKeyPair()

  Gets the keypair object for the local ephemeral key. I2P

  Returns:

  The keypair, or null if a local ephemeral key is not required or has not been generated.

• needsLocalKeyPair

  public boolean needsLocalKeyPair()

  Determine if this handshake requires a local static key.

  Returns:

  true if a local static key is needed; false if not. If the local static key has already been set, then this function will return false.

• hasLocalKeyPair

  public boolean hasLocalKeyPair()

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

  Returns:

  true if the local static key has been configured; false if not.

• getRemotePublicKey

  public DHState getRemotePublicKey()

  Gets the public key object for the remote static key.

  Returns:

  The public key, or null if a remote static key is not required.

• needsRemotePublicKey

  public boolean needsRemotePublicKey()

  Determine if this handshake requires a remote static key.

  Returns:

  true if a remote static key is needed; false if not. If the remote static key has already been set, then this function will return false.

• hasRemotePublicKey

  public boolean hasRemotePublicKey()

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

  Returns:

  true if the remote static key has been configured; false if not.

• getLocalHybridKeyPair

  public DHState getLocalHybridKeyPair()

  Gets the keypair object for the local hybrid key. I2P

  Returns:

  The keypair, or null if a local hybrid key is not required or has not been generated.

• getRemoteHybridKeyPair

  public DHState getRemoteHybridKeyPair()

  Gets the keypair object for the remote hybrid key. I2P

  Returns:

  The keypair, or null if a remote hybrid key is not required or has not been generated.

• start

  public void start()

  Starts the handshake running. This function is called after all of the handshake parameters have been provided to the HandshakeState object. This function should be followed by calls to writeMessage() or readMessage() to process the handshake messages. The getAction() function indicates the action to take next.

  Throws:

  IllegalStateException - The handshake has already started, or one or more of the required parameters has not been supplied.

  UnsupportedOperationException - An attempt was made to start a fallback handshake pattern without first calling fallback() on a previous handshake.

  See Also:

  • getAction()
  • writeMessage(byte[], int, byte[], int, int)
  • see #fallback()

• getAction

  public int getAction()

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

  Returns:

  One of HandshakeState.NO_ACTION, HandshakeState.WRITE_MESSAGE, HandshakeState.READ_MESSAGE, HandshakeState.SPLIT, or HandshakeState.FAILED.

• mixDH

  private void mixDH(DHState local, DHState remote)

  Mixes the result of a Diffie-Hellman calculation into the chaining key.

  Parameters:

  local - Local private key object.

  remote - Remote public key object.

• writeMessage

  public int writeMessage(byte[] message, int messageOffset, byte[] payload, int payloadOffset, int payloadLength) throws ShortBufferException

  Writes a message payload during the handshake. Payload (plaintext) and message (encrypted) may be in the same buffer if the payload if offset enough past the message offset to leave room for the key(s) and/or MAC. For 32 byte keys and 16 byte MACs, if message == payload, payloadOffset must be at least this much greater than messageOffset: XK: Message 1: 32; message 2: 32; message 3: 48 IK: Message 1: 80; message 2: 48 N: Message 1: 32

  Parameters:

  message - The buffer that will be populated with the handshake packet to be written to the transport.

  messageOffset - First offset within the message buffer to be populated.

  payload - Buffer containing the payload to add to the handshake message; can be null if there is no payload.

  payloadOffset - Offset into the payload buffer of the first payload buffer.

  payloadLength - Length of the payload in bytes.

  Returns:

  The length of the data written to the message buffer.

  Throws:

  IllegalStateException - The action is not WRITE_MESSAGE.

  IllegalArgumentException - The payload is null, but payloadOffset or payloadLength is non-zero.

  ShortBufferException - The message buffer does not have enough space for the handshake message.

  See Also:

  • getAction()
  • readMessage(byte[], int, int, byte[], int)

• readMessage

  public int readMessage(byte[] message, int messageOffset, int messageLength, byte[] payload, int payloadOffset) throws ShortBufferException, BadPaddingException

  Reads a message payload during the handshake. Payload (plaintext) and message (encrypted) may be in the same buffer and have the same offset.

  Parameters:

  message - Buffer containing the incoming handshake that was read from the transport.

  messageOffset - Offset of the first message byte.

  messageLength - The length of the incoming message.

  payload - Buffer that will be populated with the message payload.

  payloadOffset - Offset of the first byte in the payload buffer to be populated with payload data.

  Returns:

  The length of the payload.

  Throws:

  IllegalStateException - The action is not READ_MESSAGE.

  ShortBufferException - The message buffer does not have sufficient bytes for a valid message or the payload buffer does not have enough space for the decrypted payload.

  BadPaddingException - A MAC value in the message failed to verify.

  See Also:

  • getAction()
  • writeMessage(byte[], int, byte[], int, int)

• split

  public CipherStatePair split()

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

  Returns:

  The pair of ciphers for sending and receiving.

  Throws:

  IllegalStateException - The action is not SPLIT.

• split

  public CipherStatePair split(byte[] secondaryKey, int offset, int length)

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

  Parameters:

  secondaryKey - The buffer containing the secondary key.

  offset - The offset of the first secondary key byte.

  length - The length of the secondary key in bytes, which must be either 0 or 32.

  Returns:

  The pair of ciphers for sending and receiving.

  Throws:

  IllegalStateException - The action is not SPLIT.

  IllegalArgumentException - The length is not 0 or 32.

• getHandshakeHash

  public byte[] getHandshakeHash()

  Gets the current value of the handshake hash.

  Returns:

  The handshake hash. This must not be modified by the caller.

  Throws:

  IllegalStateException - The action is not SPLIT or COMPLETE.

• destroy

  public void destroy()

  Marks this state destroyed and destroys the symmetric state and keys.

  Specified by:

  destroy in interface Destroyable

• computeRequirements

  private static int computeRequirements(short flags, String prefix, int role, boolean isFallback)

  Computes the requirements for a handshake.

  Parameters:

  flags - The flags from the handshake's pattern.

  prefix - The prefix from the protocol name; typically "Noise" or "NoisePSK".

  role - The role, HandshakeState.INITIATOR or HandshakeState.RESPONDER.

  isFallback - Set to true if we need the requirements for a fallback pattern; false for a regular pattern.

  Returns:

  The set of requirements for the handshake.

• mixHash

  public void mixHash(byte[] data, int offset, int length)

  I2P for mixing in padding in messages 1 and 2

  Parameters:

  data - the buffer holding the bytes to mix into the handshake hash

  offset - index into data of the first byte to mix in

  length - count of bytes to mix in starting at offset

• getChainingKey

  public byte[] getChainingKey()

  I2P for getting chaining key for siphash calc

  Returns:

  a copy of the current chaining key, not the internal array

• clone

  public HandshakeState clone() throws CloneNotSupportedException

  I2P Must be called before both eph. keys set.

  Overrides:

  clone in class Object

  Throws:

  CloneNotSupportedException

• toString

  public String toString()

  I2P debug

  Overrides:

  toString in class Object