Class KeyExchangeMessageHandler
SshConstants.SSH_MSG_KEXINIT message is received.
Apache MINA sshd queues up high-level messages that threads try to send while a key exchange is ongoing, and sends them once the key exchange is done. Sending queued messages may make the peer re-trigger a new key exchange, in which case sending queued messages stops and is resumed at the end of the new key exchange.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final ExecutorServiceAnExecutorServiceused to flush the queue asynchronously.protected final AtomicBooleanIndicates that all pending packets have been flushed.protected final AtomicReference<DefaultKeyExchangeFuture> Nevernull.protected final ReentrantReadWriteLockWe need the flushing thread to have priority over writing threads.protected final org.slf4j.LoggerTheLoggerto use.protected final Queue<PendingWriteFuture> Queues up high-level packets written during an ongoing key exchange.protected final AbstractSessionTheAbstractSessionthisKeyExchangeMessageHandlerbelongs to.protected final AtomicBooleanIndicates that the handler has been shut down. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate voiddrainQueueTo(List<AbstractMap.SimpleImmutableEntry<PendingWriteFuture, IoWriteFuture>> pendingAborted, IoWriteFuture aborted) protected PendingWriteFutureenqueuePendingPacket(int cmd, Buffer buffer) Enqueues a packet to be written once a running key exchange terminates.protected voidflushQueue(DefaultKeyExchangeFuture flushDone) Flushes all packets enqueued while a key exchange was ongoing.Initializes the state for a new key exchange.protected booleanisBlockAllowed(int cmd) Tells whether the calling thread may be blocked inwritePacket(Buffer, long, TimeUnit).voidshutdown()Pretends all pending packets had been written.To be called when the key exchange is done.voidupdateState(Runnable update) <V> VupdateState(Supplier<V> update) protected IoWriteFuturewriteOrEnqueue(int cmd, Buffer buffer, long timeout, TimeUnit unit) Writes an SSH packet.writePacket(Buffer buffer, long timeout, TimeUnit unit) Writes a packet.
-
Field Details
-
lock
We need the flushing thread to have priority over writing threads. So we use a lock that favors writers over readers, and any state updates and the flushing thread are writers, while writePacket() is a reader. -
flushRunner
AnExecutorServiceused to flush the queue asynchronously.- See Also:
-
session
TheAbstractSessionthisKeyExchangeMessageHandlerbelongs to. -
log
protected final org.slf4j.Logger logTheLoggerto use. -
pendingPackets
Queues up high-level packets written during an ongoing key exchange. -
kexFlushed
Indicates that all pending packets have been flushed. Set totrueby the flushing thread, or at the end of KEX if there are no packets to be flushed. Set tofalsewhen a new KEX starts. Initiallytrue. -
shutDown
Indicates that the handler has been shut down. -
kexFlushedFuture
Nevernull. Used to block some threads when writing packets while pending packets are still being flushed at the end of a KEX to avoid overrunning the flushing thread. Always set, initially fulfilled. At the beginning of a KEX a new future is installed, which is fulfilled at the end of the KEX once there are no more pending packets to be flushed.
-
-
Constructor Details
-
KeyExchangeMessageHandler
- Parameters:
session-AbstractSessionthe new instance belongs tolog-Loggerto use for writing log messages
-
-
Method Details
-
updateState
-
updateState
-
initNewKeyExchange
Initializes the state for a new key exchange.allPacketsFlushedwill befalse, and a new future to be fulfilled when all queued packets will be flushed once the key exchange is done is set. The currently set future from an earlier key exchange is returned. The returned future may or may not be fulfilled; if it isn't, there are still left-over pending packets to write from the previous key exchange, which will be written once the new key exchange flushes pending packets.- Returns:
- the previous
DefaultKeyExchangeFutureindicating whether all pending packets were flushed.
-
terminateKeyExchange
To be called when the key exchange is done. If there are any pending packets, returns a future that will be fulfilled whenflushQueue(DefaultKeyExchangeFuture)with that future as argument has flushed all pending packets, if there are any.- Returns:
- the current
DefaultKeyExchangeFutureand the number of currently pending packets
-
shutdown
public void shutdown()Pretends all pending packets had been written. To be called when theAbstractSessioncloses. -
writePacket
Writes a packet. If a key exchange is ongoing, only low-level messages are written directly; all other messages are queued and will be written onceflushQueue(DefaultKeyExchangeFuture)is called when the key exchange is done. Packets written while there are still pending packets to be flushed will either be queued, too, or the calling thread will be blocked with the given timeout until all packets have been flushed. Whether a write will be blocked is determined byisBlockAllowed(int).If a packet was written, a key exchange may be triggered via
AbstractSession.checkRekey().If
timeout <= 0orunit == null, a time-out of "forever" is assumed. Note that a timeout applies only if the calling thread is blocked.- Parameters:
buffer- packet to writetimeout- number ofTimeUnits to wait at most if the calling thread is blockedunit-TimeUnitoftimeout- Returns:
- an
IoWriteFuturethat will be fulfilled once the packet has indeed been written. - Throws:
IOException- if an error occurs
-
writeOrEnqueue
protected IoWriteFuture writeOrEnqueue(int cmd, Buffer buffer, long timeout, TimeUnit unit) throws IOException Writes an SSH packet. If no KEX is ongoing and there are no pending packets queued to be written after KEX, the buffer is written directly. Otherwise, the write is enqueued or the calling thread is blocked until all pending packets have been written, depending on the result ofisBlockAllowed(int). If the calling thread holds the monitor of the session'sAbstractCloseable.getFutureLock(), it is never blocked and the write is queued.If
timeout <= 0orunit == null, a time-out of "forever" is assumed. Note that a timeout applies only if the calling thread is blocked.- Parameters:
cmd- SSH command from the bufferbuffer-Buffercontaining the packet to writetimeout- number ofTimeUnits to wait at most if the calling thread is blockedunit-TimeUnitoftimeout- Returns:
- an
IoWriteFuturethat will be fulfilled once the packet has indeed been written. - Throws:
IOException- if an error occurs
-
isBlockAllowed
protected boolean isBlockAllowed(int cmd) Tells whether the calling thread may be blocked inwritePacket(Buffer, long, TimeUnit). This implementation blocks writes of channel data packets unless written by aninternal thread.Typically an internal thread is one of the reading threads of Apache MINA sshd handling an SSH protocol message: it's holding the
AbstractSession.decodeLock; blocking it would mean we couldn't handle any other incoming message, not even disconnections or another key exchange triggered by having lots of data queued.- Parameters:
cmd- SSH command of the buffer to be written- Returns:
trueif the thread may be blocked;falseif the packet written must be queued without blocking the thread
-
enqueuePendingPacket
Enqueues a packet to be written once a running key exchange terminates.- Parameters:
cmd- the SSH command from the bufferbuffer- theBuffercontaining the packet to be sent- Returns:
- the enqueued
PendingWriteFuture
-
flushQueue
Flushes all packets enqueued while a key exchange was ongoing. If writing the pending packets triggers a new key exchange, flushing is stopped and is to be resumed by another call to this method when the new key exchange is done.- Parameters:
flushDone- the future obtained fromgetFlushedFuture; will be fulfilled once all pending packets have been written
-
drainQueueTo
private void drainQueueTo(List<AbstractMap.SimpleImmutableEntry<PendingWriteFuture, IoWriteFuture>> pendingAborted, IoWriteFuture aborted)
-