io.netty.handler.ssl

类 SslMasterKeyHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.ssl.SslMasterKeyHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

public abstract class SslMasterKeyHandler
extends ChannelInboundHandlerAdapter

The SslMasterKeyHandler is a channel-handler you can include in your pipeline to consume the master key & session identifier for a TLS session. This can be very useful, for instance the WiresharkSslMasterKeyHandler implementation will log the secret & identifier in a format that is consumable by Wireshark -- allowing easy decryption of pcap/tcpdumps.

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	SYSTEM_PROP_KEY A system property that can be used to turn on/off the SslMasterKeyHandler dynamically without having to edit your pipeline.

构造器概要

构造器

限定符	构造器和说明
protected	SslMasterKeyHandler() Constructor.

方法概要

限定符和类型	方法和说明
protected abstract void	accept(javax.crypto.SecretKey masterKey, javax.net.ssl.SSLSession session) Consume the master key for the session and the sessionId
static void	ensureSunSslEngineAvailability() Ensure that SSLSessionImpl is available.
static boolean	isSunSslEngineAvailable()
protected boolean	masterKeyHandlerEnabled() Checks if the handler is set up to actually handle/accept the event.
static SslMasterKeyHandler	newWireSharkSslMasterKeyHandler() Create a WiresharkSslMasterKeyHandler instance.
static java.lang.Throwable	sunSslEngineUnavailabilityCause() Returns the cause of unavailability.
void	userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt) Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

字段详细资料

SYSTEM_PROP_KEY

public static final java.lang.String SYSTEM_PROP_KEY

A system property that can be used to turn on/off the SslMasterKeyHandler dynamically without having to edit your pipeline. -Dio.netty.ssl.masterKeyHandler=true

另请参阅:

常量字段值

构造器详细资料

SslMasterKeyHandler

protected SslMasterKeyHandler()

Constructor.

方法详细资料

ensureSunSslEngineAvailability

public static void ensureSunSslEngineAvailability()

Ensure that SSLSessionImpl is available.

抛出:

java.lang.UnsatisfiedLinkError - if unavailable

sunSslEngineUnavailabilityCause

public static java.lang.Throwable sunSslEngineUnavailabilityCause()

Returns the cause of unavailability.

返回:

the cause if unavailable. null if available.

isSunSslEngineAvailable

public static boolean isSunSslEngineAvailable()

accept

protected abstract void accept(javax.crypto.SecretKey masterKey,
                               javax.net.ssl.SSLSession session)

Consume the master key for the session and the sessionId

参数:

masterKey - A 48-byte secret shared between the client and server.

session - The current TLS session

userEventTriggered

public final void userEventTriggered(ChannelHandlerContext ctx,
                                     java.lang.Object evt)

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

userEventTriggered 在接口中 ChannelInboundHandler

覆盖:

userEventTriggered 在类中 ChannelInboundHandlerAdapter

masterKeyHandlerEnabled

protected boolean masterKeyHandlerEnabled()

Checks if the handler is set up to actually handle/accept the event. By default the SYSTEM_PROP_KEY property is checked, but any implementations of this class are free to override if they have different mechanisms of checking.

返回:

true if it should handle, false otherwise.

newWireSharkSslMasterKeyHandler

public static SslMasterKeyHandler newWireSharkSslMasterKeyHandler()

Create a WiresharkSslMasterKeyHandler instance. This TLS master key handler logs the master key and session-id in a format understood by Wireshark -- this can be especially useful if you need to ever decrypt a TLS session and are using perfect forward secrecy (i.e. Diffie-Hellman) The key and session identifier are forwarded to the log named 'io.netty.wireshark'.