Package org.snmp4j.transport
Class TLSTM
java.lang.Object
org.snmp4j.transport.AbstractTransportMapping<TcpAddress>
org.snmp4j.transport.TcpTransportMapping
org.snmp4j.transport.TLSTM
- All Implemented Interfaces:
ConnectionOrientedTransportMapping<TcpAddress>
,TransportMapping<TcpAddress>
The
TLSTM
implements the Transport Layer Security
Transport Mapping (TLS-TM) as defined by RFC 5953
with the new IO API and SSLEngine
.
It uses a single thread for processing incoming and outgoing messages.
The thread is started when the listen
method is called, or
when an outgoing request is sent using the sendMessage
method.
- Since:
- 2.0
- Version:
- 2.6.4
- Author:
- Frank Fock
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
static interface
-
Field Summary
Fields inherited from class org.snmp4j.transport.TcpTransportMapping
openSocketOnSending, suspendedAddresses, tcpAddress
Fields inherited from class org.snmp4j.transport.AbstractTransportMapping
asyncMsgProcessingSupported, maxInboundMessageSize, maxOutboundMessageSize, transportListener
-
Constructor Summary
ConstructorDescriptionTLSTM()
Creates a default TCP transport mapping with the server for incoming messages disabled.TLSTM
(TlsAddress address) Creates a TLS transport mapping with the server for incoming messages bind to the given address.TLSTM
(TlsTmSecurityCallback<X509Certificate> securityCallback, TlsAddress serverAddress) Creates a TLS transport mapping that binds to the given address (interface) on the local host.TLSTM
(TlsTmSecurityCallback<X509Certificate> securityCallback, TlsAddress serverAddress, CounterSupport counterSupport) Creates a TLS transport mapping that binds to the given address (interface) on the local host. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes all open sockets and stops the internal server thread that processes messages.boolean
close
(TcpAddress remoteAddress) Closes a connection to the supplied remote address, if it is open.long
Gets the connection timeout.static OctetString
Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.int
Gets the inbound buffer size for incoming requests.Returns theMessageLengthDecoder
used by this transport mapping.static Object
getSubjAltName
(Collection<List<?>> subjAltNames, int type) Gets theAddress
class that is supported by this transport mapping.Returns the name of the listen thread.String[]
protected static boolean
isEngineClosed
(SSLEngine engine) Check if aSSLEngine
is fully closed.boolean
Returnstrue
if the transport mapping is listening for incoming messages.boolean
Checks whether a server for incoming requests is enabled.void
listen()
Listen for incoming and outgoing requests.protected Object
removeSocketEntry
(TcpAddress remoteAddress) void
sendMessage
(TcpAddress address, byte[] message, TransportStateReference tmStateReference) Sends a SNMP message to the supplied address.void
setConnectionTimeout
(long connectionTimeout) Sets the connection timeout.void
setKeyStore
(String keyStore) void
setKeyStorePassword
(String keyStorePassword) void
setLocalCertificateAlias
(String localCertificateAlias) Sets the certificate alias used for client and server authentication by this TLSTM.void
setMaxInboundMessageSize
(int maxInboundMessageSize) Sets the maximum buffer size for incoming requests.void
setMessageLengthDecoder
(MessageLengthDecoder messageLengthDecoder) Sets theMessageLengthDecoder
that decodes the total message length from the header of a message.void
setSecurityCallback
(TlsTmSecurityCallback<X509Certificate> securityCallback) void
setServerEnabled
(boolean serverEnabled) Sets whether a server for incoming requests should be created when the transport is set into listen state.protected void
setSocketOptions
(ServerSocket serverSocket) Sets optional server socket options.void
setThreadName
(String name) Sets the name of the listen thread for this UDP transport mapping.void
setTlsProtocols
(String[] tlsProtocols) Sets the TLS protocols/versions that TLSTM should use during handshake.void
setTrustManagerFactory
(TLSTM.TLSTMTrustManagerFactory trustManagerFactory) Set the TLSTM trust manager factory.void
setTrustStore
(String trustStore) void
setTrustStorePassword
(String trustStorePassword) Methods inherited from class org.snmp4j.transport.TcpTransportMapping
addTransportStateListener, cancelNonServerSelectionKey, fireConnectionStateChanged, getAddress, handleDroppedMessageToSend, isOpenSocketOnSending, removeTransportStateListener, resumeAddress, setOpenSocketOnSending, suspendAddress
Methods inherited from class org.snmp4j.transport.AbstractTransportMapping
addTransportListener, fireProcessMessage, getMaxOutboundMessageSize, isAsyncMsgProcessingSupported, removeAllTransportListeners, removeTransportListener, setAsyncMsgProcessingSupported
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.snmp4j.TransportMapping
addTransportListener, getMaxOutboundMessageSize, removeTransportListener
-
Field Details
-
TLS_MAX_FRAGMENT_SIZE
public static final int TLS_MAX_FRAGMENT_SIZE- See Also:
-
DEFAULT_TLSTM_PROTOCOLS
- See Also:
-
MAX_TLS_PAYLOAD_SIZE
public static final int MAX_TLS_PAYLOAD_SIZE- See Also:
-
-
Constructor Details
-
TLSTM
Creates a default TCP transport mapping with the server for incoming messages disabled.- Throws:
UnknownHostException
- if the local host cannot be determined.
-
TLSTM
Creates a TLS transport mapping with the server for incoming messages bind to the given address. ThesecurityCallback
needs to be specified beforelisten()
is called.- Parameters:
address
- the address to bind for incoming requests.- Throws:
IOException
- on failure of binding a local port.
-
TLSTM
public TLSTM(TlsTmSecurityCallback<X509Certificate> securityCallback, TlsAddress serverAddress) throws IOException Creates a TLS transport mapping that binds to the given address (interface) on the local host.- Parameters:
securityCallback
- a security name callback to resolve X509 certificates to tmSecurityNames.serverAddress
- the TcpAddress instance that describes the server address to listen on incoming connection requests.- Throws:
IOException
- if the given address cannot be bound.
-
TLSTM
public TLSTM(TlsTmSecurityCallback<X509Certificate> securityCallback, TlsAddress serverAddress, CounterSupport counterSupport) throws IOException Creates a TLS transport mapping that binds to the given address (interface) on the local host.- Parameters:
securityCallback
- a security name callback to resolve X509 certificates to tmSecurityNames.serverAddress
- the TcpAddress instance that describes the server address to listen on incoming connection requests.counterSupport
- The CounterSupport instance to be used to count events created by this TLSTM instance. To get a default instance, useCounterSupport.getInstance()
.- Throws:
IOException
- if the given address cannot be bound.
-
-
Method Details
-
getLocalCertificateAlias
-
getTlsProtocols
-
setTlsProtocols
Sets the TLS protocols/versions that TLSTM should use during handshake. The default is defined byDEFAULT_TLSTM_PROTOCOLS
.- Parameters:
tlsProtocols
- an array of TLS protocol (version) names supported by the SunJSSE provider. The order in the array defines which protocol is tried during handshake first.- Since:
- 2.0.3
-
getKeyStore
-
setKeyStore
-
getKeyStorePassword
-
setKeyStorePassword
-
setLocalCertificateAlias
Sets the certificate alias used for client and server authentication by this TLSTM. Setting this property to a value other thannull
filters out any certificates which are not in the chain of the given alias.- Parameters:
localCertificateAlias
- a certificate alias which filters a single certification chain from thejavax.net.ssl.keyStore
key store to be used to authenticate this TLS transport mapping. Ifnull
no filtering appears, which could lead to more than a single chain available for authentication by the peer, which would violate the TLSTM standard requirements.
-
getCounterSupport
-
getSupportedAddressClass
Description copied from interface:TransportMapping
Gets theAddress
class that is supported by this transport mapping.- Specified by:
getSupportedAddressClass
in interfaceTransportMapping<TcpAddress>
- Overrides:
getSupportedAddressClass
in classTcpTransportMapping
- Returns:
- a subclass of
Address
.
-
getSecurityCallback
-
setSecurityCallback
-
getTrustManagerFactory
-
setTrustManagerFactory
Set the TLSTM trust manager factory. Using a trust manager factory other than the default allows to add support for Java 1.7 X509ExtendedTrustManager.- Parameters:
trustManagerFactory
- a X.509 trust manager factory implementing the interfaceTLSTM.TLSTMTrustManagerFactory
.- Since:
- 2.0.3
-
listen
Listen for incoming and outgoing requests. If theserverEnabled
member isfalse
the server for incoming requests is not started. This starts the internal server thread that processes messages.- Specified by:
listen
in interfaceTransportMapping<TcpAddress>
- Specified by:
listen
in classTcpTransportMapping
- Throws:
SocketException
- when the transport is already listening for incoming/outgoing messages.IOException
- if the listen port could not be bound to the server thread.
-
setThreadName
Sets the name of the listen thread for this UDP transport mapping. This method has no effect, if called beforelisten()
has been called for this transport mapping.- Parameters:
name
- the new thread name.- Since:
- 1.6
-
getThreadName
Returns the name of the listen thread.- Returns:
- the thread name if in listening mode, otherwise
null
. - Since:
- 1.6
-
close
public void close()Closes all open sockets and stops the internal server thread that processes messages.- Specified by:
close
in interfaceTransportMapping<TcpAddress>
- Specified by:
close
in classTcpTransportMapping
-
close
Closes a connection to the supplied remote address, if it is open. This method is particularly useful when not using a timeout for remote connections.- Parameters:
remoteAddress
- the address of the peer socket.- Returns:
true
if the connection has been closed andfalse
if there was nothing to close.- Throws:
IOException
- if the remote address cannot be closed due to an IO exception.- Since:
- 1.7.1
-
removeSocketEntry
-
sendMessage
public void sendMessage(TcpAddress address, byte[] message, TransportStateReference tmStateReference) throws IOException Sends a SNMP message to the supplied address.- Specified by:
sendMessage
in interfaceTransportMapping<TcpAddress>
- Specified by:
sendMessage
in classTcpTransportMapping
- Parameters:
address
- anTcpAddress
. AClassCastException
is thrown ifaddress
is not aTcpAddress
instance.message
- byte[] the message to sent.tmStateReference
- the (optional) transport model state reference as defined by RFC 5590 section 6.1.- Throws:
IOException
- if an IO exception occurs while trying to send the message.
-
getConnectionTimeout
public long getConnectionTimeout()Gets the connection timeout. This timeout specifies the time a connection may be idle before it is closed.- Returns:
- long the idle timeout in milliseconds.
-
setConnectionTimeout
public void setConnectionTimeout(long connectionTimeout) Sets the connection timeout. This timeout specifies the time a connection may be idle before it is closed.- Specified by:
setConnectionTimeout
in interfaceConnectionOrientedTransportMapping<TcpAddress>
- Specified by:
setConnectionTimeout
in classTcpTransportMapping
- Parameters:
connectionTimeout
- the idle timeout in milliseconds. A zero or negative value will disable any timeout and connections opened by this transport mapping will stay opened until they are explicitly closed.
-
isServerEnabled
public boolean isServerEnabled()Checks whether a server for incoming requests is enabled.- Returns:
- boolean
-
getMessageLengthDecoder
Description copied from class:TcpTransportMapping
Returns theMessageLengthDecoder
used by this transport mapping.- Specified by:
getMessageLengthDecoder
in interfaceConnectionOrientedTransportMapping<TcpAddress>
- Specified by:
getMessageLengthDecoder
in classTcpTransportMapping
- Returns:
- a MessageLengthDecoder instance.
-
setServerEnabled
public void setServerEnabled(boolean serverEnabled) Sets whether a server for incoming requests should be created when the transport is set into listen state. Setting this value has no effect until thelisten()
method is called (if the transport is already listening,close()
has to be called before).- Parameters:
serverEnabled
- iftrue
if the transport will listens for incoming requests afterlisten()
has been called.
-
setMessageLengthDecoder
Description copied from class:TcpTransportMapping
Sets theMessageLengthDecoder
that decodes the total message length from the header of a message.- Specified by:
setMessageLengthDecoder
in interfaceConnectionOrientedTransportMapping<TcpAddress>
- Specified by:
setMessageLengthDecoder
in classTcpTransportMapping
- Parameters:
messageLengthDecoder
- a MessageLengthDecoder instance.
-
getMaxInboundMessageSize
public int getMaxInboundMessageSize()Gets the inbound buffer size for incoming requests. When SNMP packets are received that are longer than this maximum size, the messages will be silently dropped and the connection will be closed.- Specified by:
getMaxInboundMessageSize
in interfaceTransportMapping<TcpAddress>
- Overrides:
getMaxInboundMessageSize
in classAbstractTransportMapping<TcpAddress>
- Returns:
- the maximum inbound buffer size in bytes.
-
setMaxInboundMessageSize
public void setMaxInboundMessageSize(int maxInboundMessageSize) Sets the maximum buffer size for incoming requests. When SNMP packets are received that are longer than this maximum size, the messages will be silently dropped and the connection will be closed.- Parameters:
maxInboundMessageSize
- the length of the inbound buffer in bytes.
-
isListening
public boolean isListening()Description copied from interface:TransportMapping
Returnstrue
if the transport mapping is listening for incoming messages. For connection oriented transport mappings this is a prerequisite to be able to send SNMP messages. For connectionless transport mappings it is a prerequisite to be able to receive responses.- Returns:
true
if this transport mapping is listening for messages.
-
getFingerprint
-
getSubjAltName
-
getListenAddress
Description copied from interface:TransportMapping
Returns the address that represents the actual incoming address this transport mapping uses to listen for incoming packets.- Specified by:
getListenAddress
in interfaceTransportMapping<TcpAddress>
- Overrides:
getListenAddress
in classTcpTransportMapping
- Returns:
- the address for incoming packets or
null
this transport mapping is not configured to listen for incoming packets.
-
setSocketOptions
Sets optional server socket options. The default implementation does nothing.- Parameters:
serverSocket
- theServerSocket
to apply additional non-default options.
-
isEngineClosed
Check if aSSLEngine
is fully closed.- Parameters:
engine
- an SSL engine.- Returns:
true
if inbound and outbound is done.
-
getTrustStore
-
setTrustStore
-
getTrustStorePassword
-
setTrustStorePassword
-