net.i2p.router.crypto.ratchet

Class MuxedPQSKM

java.lang.Object

net.i2p.crypto.SessionKeyManager

net.i2p.router.crypto.ratchet.MuxedPQSKM

public class MuxedPQSKM
extends SessionKeyManager

Post-quantum hybrid session key manager combining ECIES and ML-KEM operations

Constructor Summary

Constructors

Constructor and Description
MuxedPQSKM(RatchetSKM ec, RatchetSKM pq)

Method Summary

Modifier and Type	Method and Description
RatchetEntry	consumeNextAvailableTag(PublicKey target) EC/PQ
SessionTag	consumeNextAvailableTag(PublicKey target, SessionKey key) ElG only
SessionKey	consumeTag(SessionTag tag) 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(...)).
SessionKey	createSession(PublicKey target) ElG only
void	createSession(PublicKey target, SessionKey key) ElG only
void	failTags(PublicKey target, SessionKey key, TagSetHandle ts) ElG only
int	getAvailableTags(PublicKey target, SessionKey key) Determine (approximately) how many available session tags for the current target have been confirmed and are available
long	getAvailableTimeLeft(PublicKey target, SessionKey key) Determine how long the available tags will be available for before expiring, in milliseconds
SessionKey	getCurrentKey(PublicKey target) ElG only
SessionKey	getCurrentOrNewKey(PublicKey target) ElG only
RatchetSKM	getECSKM()
int	getLowThreshold() Get the low threshold for tag sending.
RatchetSKM	getPQSKM()
int	getTagsToSend() Get the number of tags to send.
(package private) boolean	preferRatchet() Should we try the Ratchet slow decrypt before PQ slow decrypt? Adaptive test based on previous mix of traffic for this SKM, as reported by reportDecryptResult().
void	renderStatusHTML(Writer out)
(package private) void	reportDecryptResult(boolean isRatchet, boolean success) Report the result of a slow decrypt attempt.
boolean	shouldSendTags(PublicKey target, SessionKey key) ElG only
boolean	shouldSendTags(PublicKey target, SessionKey key, int lowThreshold) ElG only
void	shutdown() Called when the system is closing down, instructing the session key manager to take whatever precautions are necessary (saving state, etc)
void	tagsAcked(PublicKey target, SessionKey key, TagSetHandle ts) ElG only
TagSetHandle	tagsDelivered(PublicKey target, SessionKey key, Set<SessionTag> sessionTags) ElG only
void	tagsReceived(SessionKey key, RatchetSessionTag tag, long expire) EC only.
void	tagsReceived(SessionKey key, Set<SessionTag> sessionTags) ElG only
void	tagsReceived(SessionKey key, Set<SessionTag> sessionTags, long expire) ElG only

Methods inherited from class net.i2p.crypto.SessionKeyManager

failTags

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MuxedPQSKM

public MuxedPQSKM(RatchetSKM ec,
                  RatchetSKM pq)

Method Detail

consumeNextAvailableTag

public RatchetEntry consumeNextAvailableTag(PublicKey target)

EC/PQ

consumeNextAvailableTag

public SessionTag consumeNextAvailableTag(PublicKey target,
                                          SessionKey key)

ElG only

Overrides:

consumeNextAvailableTag in class SessionKeyManager

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

createSession

public SessionKey createSession(PublicKey target)

ElG only

Overrides:

createSession in class SessionKeyManager

createSession

public void createSession(PublicKey target,
                          SessionKey key)

ElG only

Overrides:

createSession in class SessionKeyManager

failTags

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

ElG only

Overrides:

failTags in class SessionKeyManager

getAvailableTags

public int getAvailableTags(PublicKey target,
                            SessionKey key)

Description copied from class: SessionKeyManager

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)

Description copied from class: SessionKeyManager

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

Overrides:

getAvailableTimeLeft in class SessionKeyManager

getCurrentKey

public SessionKey getCurrentKey(PublicKey target)

ElG only

Overrides:

getCurrentKey in class SessionKeyManager

getCurrentOrNewKey

public SessionKey getCurrentOrNewKey(PublicKey target)

ElG only

Overrides:

getCurrentOrNewKey in class SessionKeyManager

Returns:

non-null

getECSKM

public RatchetSKM getECSKM()

getLowThreshold

public int getLowThreshold()

Description copied from class: SessionKeyManager

Get the low threshold for tag sending.

Overrides:

getLowThreshold in class SessionKeyManager

Returns:

the low threshold, or 0 if not implemented

getPQSKM

public RatchetSKM getPQSKM()

getTagsToSend

public int getTagsToSend()

Description copied from class: SessionKeyManager

Get the number of tags to send.

Overrides:

getTagsToSend in class SessionKeyManager

Returns:

the number of tags to send, or 0 if not implemented

preferRatchet

boolean preferRatchet()

Should we try the Ratchet slow decrypt before PQ slow decrypt? Adaptive test based on previous mix of traffic for this SKM, as reported by reportDecryptResult().

renderStatusHTML

public void renderStatusHTML(Writer out)
                      throws IOException

Overrides:

renderStatusHTML in class SessionKeyManager

Throws:

IOException

reportDecryptResult

void reportDecryptResult(boolean isRatchet,
                         boolean success)

Report the result of a slow decrypt attempt.

Parameters:

isRatchet - true for EC, false for PQ

success - true for successful decrypt

shouldSendTags

public boolean shouldSendTags(PublicKey target,
                              SessionKey key)

ElG only

Overrides:

shouldSendTags in class SessionKeyManager

Parameters:

target - the target public key

key - the session key

Returns:

true if we have less than the threshold or what we have is about to expire

shouldSendTags

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

ElG only

Overrides:

shouldSendTags in class SessionKeyManager

Parameters:

target - the target public key

key - the session key

lowThreshold - the low threshold

Returns:

true if we have less than the threshold or what we have is about to expire

shutdown

public void shutdown()

Description copied from class: SessionKeyManager

Called when the system is closing down, instructing the session key manager to take whatever precautions are necessary (saving state, etc)

Overrides:

shutdown in class SessionKeyManager

tagsAcked

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

ElG only

Overrides:

tagsAcked in class SessionKeyManager

tagsDelivered

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

ElG only

Overrides:

tagsDelivered in class SessionKeyManager

tagsReceived

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

EC only. One time session We do not support PQ one-time sessions on MuxedPQSKM.

Parameters:

expire - time from now

tagsReceived

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

ElG only

Overrides:

tagsReceived in class SessionKeyManager

tagsReceived

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

ElG only

Overrides:

tagsReceived in class SessionKeyManager

sessionTags - modifiable; NOT copied

expire - time from now