org.jboss.netty.handler.ssl

Class OpenSslServerContext

java.lang.Object

org.jboss.netty.handler.ssl.SslContext

org.jboss.netty.handler.ssl.OpenSslServerContext

public final class OpenSslServerContext
extends SslContext

A server-side SslContext which uses OpenSSL's SSL/TLS implementation.

Field Summary

Fields

Modifier and Type	Field and Description
private long	aprPool
private java.util.List<java.lang.String>	ciphers
private long	ctx The OpenSSL SSL_CTX object
private static java.util.List<java.lang.String>	DEFAULT_CIPHERS
private static InternalLogger	logger
private java.util.List<java.lang.String>	nextProtocols
private long	sessionCacheSize
private long	sessionTimeout
private OpenSslSessionStats	stats
private java.util.List<java.lang.String>	unmodifiableCiphers

Constructor Summary

Constructors

Constructor and Description
OpenSslServerContext(java.io.File certChainFile, java.io.File keyFile) Creates a new instance.
OpenSslServerContext(java.io.File certChainFile, java.io.File keyFile, java.lang.String keyPassword) Creates a new instance.
OpenSslServerContext(SslBufferPool bufPool, java.io.File certChainFile, java.io.File keyFile, java.lang.String keyPassword, java.lang.Iterable<java.lang.String> ciphers, java.lang.Iterable<java.lang.String> nextProtocols, long sessionCacheSize, long sessionTimeout) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	cipherSuites() Returns the list of enabled cipher suites, in the order of preference.
long	context() Returns the SSL_CTX object of this context.
private void	destroyPools()
protected void	finalize()
boolean	isClient() Returns the true if and only if this context is for client-side.
(package private) SslBufferPool	newBufferPool()
javax.net.ssl.SSLEngine	newEngine() Returns a new server-side SSLEngine with the current configuration.
javax.net.ssl.SSLEngine	newEngine(java.lang.String peerHost, int peerPort) Creates a new SSLEngine using advisory peer information.
java.util.List<java.lang.String>	nextProtocols() Returns the list of application layer protocols for the TLS NPN/ALPN extension, in the order of preference.
long	sessionCacheSize() Returns the size of the cache used for storing SSL session objects.
long	sessionTimeout() Returns the timeout for the cached SSL session objects, in seconds.
void	setTicketKeys(byte[] keys) Sets the SSL session ticket keys of this context.
OpenSslSessionStats	stats() Returns the stats of this context.

Methods inherited from class org.jboss.netty.handler.ssl.SslContext

bufferPool, defaultClientProvider, defaultServerProvider, isServer, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newHandler, newHandler, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final InternalLogger logger

DEFAULT_CIPHERS

private static final java.util.List<java.lang.String> DEFAULT_CIPHERS

aprPool

private final long aprPool

ciphers

private final java.util.List<java.lang.String> ciphers

unmodifiableCiphers

private final java.util.List<java.lang.String> unmodifiableCiphers

sessionCacheSize

private final long sessionCacheSize

sessionTimeout

private final long sessionTimeout

nextProtocols

private final java.util.List<java.lang.String> nextProtocols

ctx

private final long ctx

The OpenSSL SSL_CTX object

stats

private final OpenSslSessionStats stats

Constructor Detail

OpenSslServerContext

public OpenSslServerContext(java.io.File certChainFile,
                            java.io.File keyFile)
                     throws javax.net.ssl.SSLException

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

Throws:

javax.net.ssl.SSLException

OpenSslServerContext

public OpenSslServerContext(java.io.File certChainFile,
                            java.io.File keyFile,
                            java.lang.String keyPassword)
                     throws javax.net.ssl.SSLException

Creates a new instance.

Parameters:

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

Throws:

javax.net.ssl.SSLException

OpenSslServerContext

public OpenSslServerContext(SslBufferPool bufPool,
                            java.io.File certChainFile,
                            java.io.File keyFile,
                            java.lang.String keyPassword,
                            java.lang.Iterable<java.lang.String> ciphers,
                            java.lang.Iterable<java.lang.String> nextProtocols,
                            long sessionCacheSize,
                            long sessionTimeout)
                     throws javax.net.ssl.SSLException

Creates a new instance.

Parameters:

bufPool - the buffer pool which will be used by this context. null to use the default buffer pool.

certChainFile - an X.509 certificate chain file in PEM format

keyFile - a PKCS#8 private key file in PEM format

keyPassword - the password of the keyFile. null if it's not password-protected.

ciphers - the cipher suites to enable, in the order of preference. null to use the default cipher suites.

nextProtocols - the application layer protocols to accept, in the order of preference. null to disable TLS NPN/ALPN extension.

sessionCacheSize - the size of the cache used for storing SSL session objects. 0 to use the default value.

sessionTimeout - the timeout for the cached SSL session objects, in seconds. 0 to use the default value.

Throws:

javax.net.ssl.SSLException

Method Detail

newBufferPool

SslBufferPool newBufferPool()

Overrides:

newBufferPool in class SslContext

isClient

public boolean isClient()

Description copied from class: SslContext

Returns the true if and only if this context is for client-side.

Specified by:

isClient in class SslContext

cipherSuites

public java.util.List<java.lang.String> cipherSuites()

Description copied from class: SslContext

Returns the list of enabled cipher suites, in the order of preference.

Specified by:

cipherSuites in class SslContext

sessionCacheSize

public long sessionCacheSize()

Description copied from class: SslContext

Returns the size of the cache used for storing SSL session objects.

Specified by:

sessionCacheSize in class SslContext

sessionTimeout

public long sessionTimeout()

Description copied from class: SslContext

Returns the timeout for the cached SSL session objects, in seconds.

Specified by:

sessionTimeout in class SslContext

nextProtocols

public java.util.List<java.lang.String> nextProtocols()

Description copied from class: SslContext

Returns the list of application layer protocols for the TLS NPN/ALPN extension, in the order of preference.

Specified by:

nextProtocols in class SslContext

Returns:

the list of application layer protocols. null if NPN/ALPN extension has been disabled.

context

public long context()

Returns the SSL_CTX object of this context.

stats

public OpenSslSessionStats stats()

Returns the stats of this context.

newEngine

public javax.net.ssl.SSLEngine newEngine()

Returns a new server-side SSLEngine with the current configuration.

Specified by:

newEngine in class SslContext

Returns:

a new SSLEngine

newEngine

public javax.net.ssl.SSLEngine newEngine(java.lang.String peerHost,
                                         int peerPort)

Description copied from class: SslContext

Creates a new SSLEngine using advisory peer information.

Specified by:

newEngine in class SslContext

Parameters:

peerHost - the non-authoritative name of the host

peerPort - the non-authoritative port

Returns:

a new SSLEngine

setTicketKeys

public void setTicketKeys(byte[] keys)

Sets the SSL session ticket keys of this context.

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

destroyPools

private void destroyPools()