SessionKeyAndNonce

net.i2p.router.crypto.ratchet.SessionKeyAndNonce

All Implemented Interfaces:: DataStructure

class SessionKeyAndNonceextends SessionKey

Session key with nonce and optional handshake state for ratchet message encryption and decryption operations, supporting nonces up to 65535

This is what is returned from RatchetTagSet.consume(RatchetSessionTag). RatchetSKM puts it in a RatchetEntry and returns it to ECIESAEADEngine.

Field Summary
Fields
Modifier and Type
Field
Description
private final int
_id
The session's id.
private final int
_nonce
The nonce for the session's next message.
private final PublicKey
_remoteKey
The remote peer's key, for a reply.
private final HandshakeState
_state
The handshake state the keys came from.
Fields inherited from class SessionKey
INVALID_KEY, KEYSIZE_BYTES
Modifier and Type
Field
Description
static final SessionKey
INVALID_KEY
A key with all zeroes in the data.
static final int
KEYSIZE_BYTES
Key size in bytes (32).
Fields inherited from class SimpleDataStructure
_data
Modifier and Type
Field
Description
protected byte[]
_data
The byte array data for this structure.
Constructor Summary
Constructors
Constructor
Description
SessionKeyAndNonce(byte[] data, int nonce)
For outbound Existing Session.
SessionKeyAndNonce(byte[] data, int id, int nonce, PublicKey remoteKey)
For inbound Existing Session.
SessionKeyAndNonce(HandshakeState state)
For New Session Replies.
Method Summary
All Methods
Modifier and Type
Method
Description
HandshakeState
getHandshakeState()
For inbound NSR only, else null.
int
getID()
For inbound ES, else 0.
int
getNonce()
For ES, else 0.
PublicKey
getRemoteKey()
For inbound ES, else null.
String
toString()
Returns a string representation of this data structure.
Methods inherited from class SessionKey
getPreparedKey, length, setData, setPreparedKey
Modifier and Type
Method
Description
Object
getPreparedKey()
Retrieve an internal representation of the session key, as known by the AES engine used.
int
length()
The legal length of the byte array in this data structure.
void
setData(byte[] data)
Session key data.
void
setPreparedKey(Object obj)
Set the internal prepared AES key representation.
Methods inherited from class SimpleDataStructure
calculateHash, equals, fromBase64, fromByteArray, getData, hashCode, read, readBytes, toBase64, toByteArray, writeBytes
Modifier and Type
Method
Description
Hash
calculateHash()
SHA256 hash of the byte array, or null if data is null.
boolean
equals(Object obj)
Compares the raw data only: two different SimpleDataStructure subclasses of the same length holding the same bytes are equal, e.g.
void
fromBase64(String data)
Data from the base64 string.
void
fromByteArray(byte[] data)
Does the same thing as SimpleDataStructure.setData(byte[]) but null not allowed.
byte[]
getData()
Data reference (not a copy).
int
hashCode()
We assume the data has enough randomness in it, so use the first 4 bytes for speed.
protected int
read(InputStream in, byte[] target)
Repeated reads until the buffer is full or IOException is thrown.
void
readBytes(InputStream in)
Data read from the stream.
String
toBase64()
Renders the structure into modified base 64 notation.
byte[]
toByteArray()
Same thing as getData().
void
writeBytes(OutputStream out)
Writes the data to the output stream.
Methods inherited from class Object
clone, getClass, notify, notifyAll, wait, wait, wait

Field Details
- _id
  private final int _id
  The session's id.
- _nonce
  private final int _nonce
  The nonce for the session's next message.
- _state
  private final HandshakeState _state
  The handshake state the keys came from.
- _remoteKey
  private final PublicKey _remoteKey
  The remote peer's key, for a reply.
Constructor Details
- SessionKeyAndNonce
  public SessionKeyAndNonce(byte[] data, int nonce)
  For outbound Existing Session.
  Parameters:
  data - the AEAD session key, handed to the superclass
  nonce - message nonce, 0 to 65535
- SessionKeyAndNonce
  public SessionKeyAndNonce(byte[] data, int id, int nonce, PublicKey remoteKey)
  For inbound Existing Session.
  Parameters:
  data - the AEAD session key, handed to the superclass
  id - index of the session within the inbound tag set
  nonce - message nonce, 0 to 65535
  remoteKey - the sender's static public key
- SessionKeyAndNonce
  public SessionKeyAndNonce(HandshakeState state)
  For New Session Replies.
  Parameters:
  state - the noise handshake state carried over into the new session
Method Details
- getNonce
  public int getNonce()
  For ES, else 0.
  Returns:
  the message nonce in the range 0 to 65535 that this session key is paired with, or 0 when no established session key is held yet
- getID
  public int getID()
  For inbound ES, else 0.
  Returns:
  the session ID
- getRemoteKey
  public PublicKey getRemoteKey()
  For inbound ES, else null. For NSR, use getHandshakeState().getRemotePublicKey().getPublicKey().
  Returns:
  the remote key
- getHandshakeState
  public HandshakeState getHandshakeState()
  For inbound NSR only, else null. MUST be cloned before processing NSR.
  Returns:
  the handshake state
- toString
  public String toString()
  Description copied from class: SimpleDataStructure
  Returns a string representation of this data structure.
  Overrides:
  toString in class SimpleDataStructure

Field Summary

Fields inherited from class SessionKey

Fields inherited from class SimpleDataStructure

Constructor Summary

Method Summary

Methods inherited from class SessionKey

Methods inherited from class SimpleDataStructure

Methods inherited from class Object

Field Details

_id

_nonce

_state

_remoteKey

Constructor Details

SessionKeyAndNonce

SessionKeyAndNonce

Method Details

getNonce

getID

getRemoteKey

getHandshakeState

toString