Package net.i2p.crypto
Class SessionKeyManager
java.lang.Object
net.i2p.crypto.SessionKeyManager
- Direct Known Subclasses:
MuxedSKM
,RatchetSKM
,TransientSessionKeyManager
Manage the session keys and session tags used for encryption and decryption.
This base implementation simply ignores sessions and acts as if everything is
unknown (and hence always forces a full ElGamal encryption for each message).
See TransientSessionKeyManager subclass which manages and persists keys and tags.
-
Constructor Summary
ConstructorDescriptionA dummy SessionKeyManager for testing or for passing to ElGamalAESEngine.decrypt()SessionKeyManager
(I2PAppContext context) A dummy SessionKeyManager for testing or for passing to ElGamalAESEngine.decrypt() -
Method Summary
Modifier and TypeMethodDescriptionconsumeNextAvailableTag
(PublicKey target, SessionKey key) Retrieve the next available session tag for identifying the use of the given key when communicating with the target.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(...)).createSession
(PublicKey target) Generate a new session key and associate it with the specified target.void
createSession
(PublicKey target, SessionKey key) Associate a new session key with the specified target.void
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.void
failTags
(PublicKey target, SessionKey key, TagSetHandle ts) int
getAvailableTags
(PublicKey target, SessionKey key) Determine (approximately) how many available session tags for the current target have been confirmed and are availablelong
getAvailableTimeLeft
(PublicKey target, SessionKey key) Determine how long the available tags will be available for before expiring, in millisecondsgetCurrentKey
(PublicKey target) Retrieve the session key currently associated with encryption to the target, or null if a new session key should be generated.getCurrentOrNewKey
(PublicKey target) Retrieve the session key currently associated with encryption to the target.int
int
How many to send, IF we need to.void
renderStatusHTML
(Writer out) boolean
shouldSendTags
(PublicKey target, SessionKey key) boolean
shouldSendTags
(PublicKey target, SessionKey key, int lowThreshold) 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) tagsDelivered
(PublicKey target, SessionKey key, Set<SessionTag> sessionTags) 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)void
tagsReceived
(SessionKey key, Set<SessionTag> sessionTags) Accept the given tags and associate them with the given key for decryption, with the default expiration.void
tagsReceived
(SessionKey key, Set<SessionTag> sessionTags, long expire) Accept the given tags and associate them with the given key for decryption, with specified expiration.
-
Constructor Details
-
SessionKeyManager
public SessionKeyManager()A dummy SessionKeyManager for testing or for passing to ElGamalAESEngine.decrypt()- Since:
- 0.9.14
-
SessionKeyManager
A dummy SessionKeyManager for testing or for passing to ElGamalAESEngine.decrypt()- Parameters:
context
- unused- Since:
- public since 0.9.14; protected before that
-
-
Method Details
-
getCurrentKey
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() -
getCurrentOrNewKey
Retrieve the session key currently associated with encryption to the target. Generates a new session and session key if not previously exising.- Returns:
- non-null
- Since:
- 0.9
-
createSession
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. -
createSession
Generate a new session key and associate it with the specified target. Racy if called after getCurrentKey() to check for a current session; use getCurrentOrNewKey() in that case. -
consumeNextAvailableTag
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) -
getTagsToSend
public int getTagsToSend()How many to send, IF we need to.- Since:
- 0.9.2
-
getLowThreshold
public int getLowThreshold()- Since:
- 0.9.2
-
shouldSendTags
- Returns:
- true if we have less than the threshold or what we have is about to expire
- Since:
- 0.9.2
-
shouldSendTags
- Returns:
- true if we have less than the threshold or what we have is about to expire
- Since:
- 0.9.2
-
getAvailableTags
Determine (approximately) how many available session tags for the current target have been confirmed and are available -
getAvailableTimeLeft
Determine how long the available tags will be available for before expiring, in milliseconds -
tagsDelivered
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) -
failTags
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 -
tagsReceived
Accept the given tags and associate them with the given key for decryption, with the default expiration. -
tagsReceived
Accept the given tags and associate them with the given key for decryption, with specified expiration.- Parameters:
sessionTags
- modifiable; NOT copiedexpire
- time from now- Since:
- 0.9.7
-
consumeTag
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 -
shutdown
public void shutdown()Called when the system is closing down, instructing the session key manager to take whatever precautions are necessary (saving state, etc) -
renderStatusHTML
- Throws:
IOException
-
failTags
-
tagsAcked
-