Class RatchetSKM

Method Details

• shutdown

  public void shutdown()

  Cannot be restarted

  Overrides:

  shutdown in class SessionKeyManager

• getDestination

  public Destination getDestination()

  Since:

  0.9.46

• getCurrentKey

  public SessionKey getCurrentKey​(PublicKey target)

  Description copied from class: SessionKeyManager

  Retrieve the session key currently associated with encryption to the target, or null if a new session key should be generated. Warning - don't generate a new session if this returns null, it's racy, use getCurrentOrNewKey()

  Overrides:

  getCurrentKey in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• getCurrentOrNewKey

  public SessionKey getCurrentOrNewKey​(PublicKey target)

  Description copied from class: SessionKeyManager

  Retrieve the session key currently associated with encryption to the target. Generates a new session and session key if not previously exising.

  Overrides:

  getCurrentOrNewKey in class SessionKeyManager

  Returns:

  non-null

  Throws:

  UnsupportedOperationException - always

• createSession

  public void createSession​(PublicKey target, SessionKey key)

  Description copied from class: SessionKeyManager

  Associate a new session key with the specified target. Metrics to determine when to expire that key begin with this call. Racy if called after getCurrentKey() to check for a current session; use getCurrentOrNewKey() in that case.

  Overrides:

  createSession in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• isDuplicate

  boolean isDuplicate​(PublicKey pk)

  Returns:

  true if a dup

  Since:

  0.9.46

• createSession

  boolean createSession​(PublicKey target, Destination d, HandshakeState state, ReplyCallback callback)

  Inbound or outbound. Checks state.getRole() to determine. For outbound (NS sent), adds to list of pending inbound sessions and returns true. For inbound (NS rcvd), if no other pending outbound sessions, creates one and returns true, or false if one already exists.

  Parameters:

  d - null if unknown

  callback - null for inbound, may be null for outbound

• updateSession

  boolean updateSession​(PublicKey target, HandshakeState oldState, HandshakeState state, ReplyCallback callback, SplitKeys split)

  Inbound or outbound. Checks state.getRole() to determine. For outbound (NSR rcvd by Alice), sets session to transition to ES mode outbound. For inbound (NSR sent by Bob), sets up inbound ES tagset.

  Parameters:

  oldState - null for inbound, pre-clone for outbound

  Returns:

  true if this was the first NSR received

• nextKeyReceived

  void nextKeyReceived​(PublicKey target, NextSessionKey key)

  Since:

  0.9.46

• registerTimer

  boolean registerTimer​(PublicKey target, Destination d, SimpleTimer2.TimedEvent timer)

  Side effect - binds this session to the supplied destination.

  Parameters:

  d - the far-end Destination for this PublicKey if known, or null

  Returns:

  true if registered

  Since:

  0.9.47

• getDestination

  Destination getDestination​(PublicKey target)

  Returns:

  the far-end Destination for this PublicKey, or null

  Since:

  0.9.47

• consumeNextAvailableTag

  public SessionTag consumeNextAvailableTag​(PublicKey target, SessionKey key)

  Description copied from class: SessionKeyManager

  Retrieve the next available session tag for identifying the use of the given key when communicating with the target. If this returns null, no tags are available so ElG should be used with the given key (a new sessionKey should NOT be used)

  Overrides:

  consumeNextAvailableTag in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• consumeNextAvailableTag

  public RatchetEntry consumeNextAvailableTag​(PublicKey target)

  Outbound. Retrieve the next available session tag and key for sending a message to the target. If this returns null, no session is set up yet, and a New Session message should be sent. If this returns non-null, the tag in the RatchetEntry will be non-null. If the SessionKeyAndNonce contains a HandshakeState, then the session setup is in progress, and a New Session Reply message should be sent. Otherwise, an Existing Session message should be sent.

• getTagsToSend

  public int getTagsToSend()

  How many to send, IF we need to.

  Overrides:

  getTagsToSend in class SessionKeyManager

  Returns:

  the configured value (not adjusted for current available)

• getLowThreshold

  public int getLowThreshold()

  Overrides:

  getLowThreshold in class SessionKeyManager

  Returns:

  the configured value

• shouldSendTags

  public boolean shouldSendTags​(PublicKey target, SessionKey key, int lowThreshold)

  Overrides:

  shouldSendTags in class SessionKeyManager

  Returns:

  false always

• getAvailableTags

  public int getAvailableTags​(PublicKey target, SessionKey key)

  Determine (approximately) how many available session tags for the current target have been confirmed and are available

  Overrides:

  getAvailableTags in class SessionKeyManager

• getAvailableTimeLeft

  public long getAvailableTimeLeft​(PublicKey target, SessionKey key)

  Determine how long the available tags will be available for before expiring, in milliseconds

  Overrides:

  getAvailableTimeLeft in class SessionKeyManager

• tagsDelivered

  public TagSetHandle tagsDelivered​(PublicKey target, SessionKey key, Set<SessionTag> sessionTags)

  Description copied from class: SessionKeyManager

  Take note of the fact that the given sessionTags associated with the key for encryption to the target have definitely been received at the target (aka call this method after receiving an ack to a message delivering them)

  Overrides:

  tagsDelivered in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• failTags

  @Deprecated public void failTags​(PublicKey target)

  Deprecated.

  unused and rather drastic

  Mark all of the tags delivered to the target up to this point as invalid, since the peer has failed to respond when they should have. This call essentially lets the system recover from corrupted tag sets and crashes

  Overrides:

  failTags in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• failTags

  public void failTags​(PublicKey target, SessionKey key, TagSetHandle ts)

  Overrides:

  failTags in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• tagsAcked

  public void tagsAcked​(PublicKey target, SessionKey key, TagSetHandle ts)

  Overrides:

  tagsAcked in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• tagsReceived

  public void tagsReceived​(SessionKey key, Set<SessionTag> sessionTags)

  Description copied from class: SessionKeyManager

  Accept the given tags and associate them with the given key for decryption, with the default expiration.

  Overrides:

  tagsReceived in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• tagsReceived

  public void tagsReceived​(SessionKey key, Set<SessionTag> sessionTags, long expire)

  Description copied from class: SessionKeyManager

  Accept the given tags and associate them with the given key for decryption, with specified expiration.

  Overrides:

  tagsReceived in class SessionKeyManager

  sessionTags - modifiable; NOT copied

  expire - time from now

  Throws:

  UnsupportedOperationException - always

• tagsReceived

  public void tagsReceived​(SessionKey key, RatchetSessionTag tag, long expire)

  One time session

  Parameters:

  expire - time from now

• consumeTag

  public SessionKey consumeTag​(SessionTag tag)

  Description copied from class: SessionKeyManager

  Determine if we have received a session key associated with the given session tag, and if so, discard it (but keep track for frequent dups) and return the decryption key it was received with (via tagsReceived(...)). returns null if no session key matches

  Overrides:

  consumeTag in class SessionKeyManager

  Throws:

  UnsupportedOperationException - always

• consumeTag

  public SessionKeyAndNonce consumeTag​(RatchetSessionTag tag)

  Inbound. Determine if we have received a session key associated with the given session tag, and if so, discard it and return the decryption key it was received with (via tagsReceived(...)). returns null if no session key matches If the return value has null data, it will have a non-null HandshakeState.

  Returns:

  a SessionKeyAndNonce or null

• addTag

  public boolean addTag​(RatchetSessionTag tag, RatchetTagSet ts)

  Map the tag to this tagset.

  Specified by:

  addTag in interface SessionTagListener

  Returns:

  true if added, false if dup

• expireTag

  public void expireTag​(RatchetSessionTag tag, RatchetTagSet ts)

  Remove the tag associated with this tagset.

  Specified by:

  expireTag in interface SessionTagListener

• registerCallback

  void registerCallback​(PublicKey target, int id, int n, ReplyCallback callback)

  Since:

  0.9.46

• receivedACK

  void receivedACK​(PublicKey target, int id, int n)

  Since:

  0.9.46

• ackRequested

  void ackRequested​(PublicKey target, int id, int n)

  Since:

  0.9.46

• renderStatusHTML

  public void renderStatusHTML​(Writer out) throws IOException

  Overrides:

  renderStatusHTML in class SessionKeyManager

  Throws:

  IOException