MuxedSKM (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.crypto.SessionKeyManager
- - net.i2p.router.crypto.ratchet.MuxedSKM

```
public class MuxedSKM
extends SessionKeyManager
```
Multiplexed session key manager combining ECIES and post-quantum key management

Constructor Summary
Constructors
Constructor and Description
MuxedSKM(TransientSessionKeyManager elg, RatchetSKM ec)
Combines ElGamal and ECIES SKMs with adaptive decrypt ordering.

Constructors
Constructor and Description
`MuxedSKM(TransientSessionKeyManager elg, RatchetSKM ec)` Combines ElGamal and ECIES SKMs with adaptive decrypt ordering.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RatchetEntry`	`consumeNextAvailableTag(PublicKey target)` EC only
`SessionTag`	`consumeNextAvailableTag(PublicKey target, SessionKey key)` ElG only
`SessionKey`	`consumeTag(SessionTag tag)` Tries ElGamal tag lookup first, falls back to ratchet lookup.
`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)` Delegates to the appropriate key manager by encryption type.
`long`	`getAvailableTimeLeft(PublicKey target, SessionKey key)` Delegates to the appropriate key manager by encryption type.
`SessionKey`	`getCurrentKey(PublicKey target)` ElG only
`SessionKey`	`getCurrentOrNewKey(PublicKey target)` ElG only
`RatchetSKM`	`getECSKM()` Return the eCSKM
`TransientSessionKeyManager`	`getElgSKM()` Return the elgSKM
`int`	`getLowThreshold()` Get the low threshold for tag sending.
`int`	`getTagsToSend()` Get the number of tags to send.
`(package private) boolean`	`preferRatchet()` Should we try the Ratchet slow decrypt before ElG slow decrypt? Adaptive test based on previous mix of traffic for this SKM, as reported by reportDecryptResult().
`void`	`renderStatusHTML(Writer out)` Renders debug status for both key managers.
`(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()` Shuts down both ElGamal and ECIES key managers.
`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 One time session
`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
  - MuxedSKM
```
public MuxedSKM(TransientSessionKeyManager elg,
                RatchetSKM ec)
```
    Combines ElGamal and ECIES SKMs with adaptive decrypt ordering.
- Method Detail
  - consumeNextAvailableTag
```
public RatchetEntry consumeNextAvailableTag(PublicKey target)
```
    EC only
  - consumeNextAvailableTag
```
public SessionTag consumeNextAvailableTag(PublicKey target,
                                          SessionKey key)
```
    ElG only
    Overrides:
    consumeNextAvailableTag in class SessionKeyManager
    Returns:
    the next available tag, or null
  - consumeTag
```
public SessionKey consumeTag(SessionTag tag)
```
    Tries ElGamal tag lookup first, falls back to ratchet lookup.
    Overrides:
    consumeTag in class SessionKeyManager
    Returns:
    the session key, or null
  - createSession
```
public SessionKey createSession(PublicKey target)
```
    ElG only
    Overrides:
    createSession in class SessionKeyManager
    Returns:
    the session key
  - 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
    Parameters:
    target - the target
    key - the session key
    ts - the tag set handle
  - getAvailableTags
```
public int getAvailableTags(PublicKey target,
                            SessionKey key)
```
    Delegates to the appropriate key manager by encryption type.
    Overrides:
    getAvailableTags in class SessionKeyManager
    Returns:
    the available tags
  - getAvailableTimeLeft
```
public long getAvailableTimeLeft(PublicKey target,
                                 SessionKey key)
```
    Delegates to the appropriate key manager by encryption type.
    Overrides:
    getAvailableTimeLeft in class SessionKeyManager
    Returns:
    the available time left
  - getCurrentKey
```
public SessionKey getCurrentKey(PublicKey target)
```
    ElG only
    Overrides:
    getCurrentKey in class SessionKeyManager
    Returns:
    the current key
  - getCurrentOrNewKey
```
public SessionKey getCurrentOrNewKey(PublicKey target)
```
    ElG only
    Overrides:
    getCurrentOrNewKey in class SessionKeyManager
    Returns:
    the current or new key
  - getECSKM
```
public RatchetSKM getECSKM()
```
    Return the eCSKM
  - getElgSKM
```
public TransientSessionKeyManager getElgSKM()
```
    Return the elgSKM
  - getLowThreshold
```
public int getLowThreshold()
```
    Description copied from class: SessionKeyManager
    Get the low threshold for tag sending.
    Overrides:
    getLowThreshold in class SessionKeyManager
    Returns:
    0, threshold not used for ratchet sessions
  - getTagsToSend
```
public int getTagsToSend()
```
    Description copied from class: SessionKeyManager
    Get the number of tags to send.
    Overrides:
    getTagsToSend in class SessionKeyManager
    Returns:
    0, tag management is handled by ratchet protocol
  - preferRatchet
```
boolean preferRatchet()
```
    Should we try the Ratchet slow decrypt before ElG 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
```
    Renders debug status for both key managers.
    Overrides:
    renderStatusHTML in class SessionKeyManager
    Parameters:
    out - the writer to render to
    Throws:
    IOException - if an I/O error occurs
  - reportDecryptResult
```
void reportDecryptResult(boolean isRatchet,
                         boolean success)
```
    Report the result of a slow decrypt attempt.
    Parameters:
    isRatchet - true for EC, false for ElG
    success - true for successful decrypt
  - shouldSendTags
```
public boolean shouldSendTags(PublicKey target,
                              SessionKey key)
```
    ElG only
    Overrides:
    shouldSendTags in class SessionKeyManager
    Parameters:
    target - the target
    key - the session key
    Returns:
    whether send tags
  - shouldSendTags
```
public boolean shouldSendTags(PublicKey target,
                              SessionKey key,
                              int lowThreshold)
```
    ElG only
    Overrides:
    shouldSendTags in class SessionKeyManager
    Parameters:
    target - the target
    key - the session key
    lowThreshold - the low threshold
    Returns:
    whether send tags
  - shutdown
```
public void shutdown()
```
    Shuts down both ElGamal and ECIES key managers.
    Overrides:
    shutdown in class SessionKeyManager
  - tagsAcked
```
public void tagsAcked(PublicKey target,
                      SessionKey key,
                      TagSetHandle ts)
```
    ElG only
    Overrides:
    tagsAcked in class SessionKeyManager
    Parameters:
    target - the target
    key - the session key
    ts - the tag set handle
  - tagsDelivered
```
public TagSetHandle tagsDelivered(PublicKey target,
                                  SessionKey key,
                                  Set<SessionTag> sessionTags)
```
    ElG only
    Overrides:
    tagsDelivered in class SessionKeyManager
    Returns:
    the tag set handle
  - tagsReceived
```
public void tagsReceived(SessionKey key,
                         RatchetSessionTag tag,
                         long expire)
```
    EC only One time session
    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

Class MuxedSKM

Constructor Summary

Method Summary

Methods inherited from class net.i2p.crypto.SessionKeyManager

Methods inherited from class java.lang.Object

Constructor Detail

MuxedSKM

Method Detail

consumeNextAvailableTag

consumeNextAvailableTag

consumeTag

createSession

createSession

failTags

getAvailableTags

getAvailableTimeLeft

getCurrentKey

getCurrentOrNewKey

getECSKM

getElgSKM

getLowThreshold

getTagsToSend

preferRatchet

renderStatusHTML

reportDecryptResult

shouldSendTags

shouldSendTags

shutdown

tagsAcked

tagsDelivered

tagsReceived

tagsReceived

tagsReceived