Package org.apache.logging.log4j.core.net.ssl

Class SslConfiguration

java.lang.Object

org.apache.logging.log4j.core.net.ssl.SslConfiguration

@NullMarked
@Plugin(name="Ssl",
        category="Core",
        printObject=true)
public class SslConfiguration
extends java.lang.Object

SSL Configuration

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable KeyStoreConfiguration	keyStoreConfig
private static StatusLogger	LOGGER
private java.lang.String	protocol
private @Nullable javax.net.ssl.SSLContext	sslContext
private @Nullable TrustStoreConfiguration	trustStoreConfig
private boolean	verifyHostName

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SslConfiguration(@Nullable java.lang.String protocol, boolean verifyHostName, @Nullable KeyStoreConfiguration keyStoreConfig, @Nullable TrustStoreConfiguration trustStoreConfig)

Method Summary

Modifier and Type	Method	Description
void	clearSecrets()	Clears the secret fields in this object but still allow it to operate normally.
private static @Nullable javax.net.ssl.SSLContext	createDefaultSslContext(java.lang.String protocol)
static SslConfiguration	createSSLConfiguration(java.lang.String protocol, KeyStoreConfiguration keyStoreConfig, TrustStoreConfiguration trustStoreConfig)	Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.
static SslConfiguration	createSSLConfiguration(java.lang.String protocol, KeyStoreConfiguration keyStoreConfig, TrustStoreConfiguration trustStoreConfig, boolean verifyHostName)	Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.
private static @Nullable javax.net.ssl.SSLContext	createSslContext(java.lang.String protocol, @Nullable KeyStoreConfiguration keyStoreConfig, @Nullable TrustStoreConfiguration trustStoreConfig)
boolean	equals(java.lang.Object obj)
@Nullable KeyStoreConfiguration	getKeyStoreConfig()
java.lang.String	getProtocol()
@Nullable javax.net.ssl.SSLContext	getSslContext()
@Nullable javax.net.ssl.SSLServerSocketFactory	getSslServerSocketFactory()	Deprecated. Use SSLContext.getServerSocketFactory() on getSslContext()
@Nullable javax.net.ssl.SSLSocketFactory	getSslSocketFactory()	Deprecated. Use SSLContext.getSocketFactory() on getSslContext()
@Nullable TrustStoreConfiguration	getTrustStoreConfig()
int	hashCode()
boolean	isVerifyHostName()
private static @Nullable javax.net.ssl.KeyManager[]	loadKeyManagers(@Nullable KeyStoreConfiguration config)
private static @Nullable javax.net.ssl.TrustManager[]	loadTrustManagers(@Nullable TrustStoreConfiguration config)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final StatusLogger LOGGER

protocol

private final java.lang.String protocol

verifyHostName

private final boolean verifyHostName

keyStoreConfig

private final @Nullable KeyStoreConfiguration keyStoreConfig

trustStoreConfig

private final @Nullable TrustStoreConfiguration trustStoreConfig

sslContext

private final transient @Nullable javax.net.ssl.SSLContext sslContext

Constructor Detail

SslConfiguration

private SslConfiguration(@Nullable java.lang.String protocol,
                         boolean verifyHostName,
                         @Nullable KeyStoreConfiguration keyStoreConfig,
                         @Nullable TrustStoreConfiguration trustStoreConfig)

Method Detail

clearSecrets

public void clearSecrets()

Clears the secret fields in this object but still allow it to operate normally.

getSslSocketFactory

@Deprecated
public @Nullable javax.net.ssl.SSLSocketFactory getSslSocketFactory()

Deprecated.

Use SSLContext.getSocketFactory() on getSslContext()

Gets the SSL socket factory of the configured SSL context.

Returns:

the SSL socket factory of the configured SSL context

getSslServerSocketFactory

@Deprecated
public @Nullable javax.net.ssl.SSLServerSocketFactory getSslServerSocketFactory()

Deprecated.

Use SSLContext.getServerSocketFactory() on getSslContext()

Gets the SSL server socket factory of the configured SSL context.

Returns:

the SSL server socket factory of the configured SSL context

createDefaultSslContext

private static @Nullable javax.net.ssl.SSLContext createDefaultSslContext(java.lang.String protocol)

createSslContext

private static @Nullable javax.net.ssl.SSLContext createSslContext(java.lang.String protocol,
                                                                   @Nullable KeyStoreConfiguration keyStoreConfig,
                                                                   @Nullable TrustStoreConfiguration trustStoreConfig)

loadKeyManagers

@NullUnmarked
private static @Nullable javax.net.ssl.KeyManager[] loadKeyManagers(@Nullable KeyStoreConfiguration config)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

loadTrustManagers

@NullUnmarked
private static @Nullable javax.net.ssl.TrustManager[] loadTrustManagers(@Nullable TrustStoreConfiguration config)
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

createSSLConfiguration

@NullUnmarked
public static SslConfiguration createSSLConfiguration(java.lang.String protocol,
                                                      KeyStoreConfiguration keyStoreConfig,
                                                      TrustStoreConfiguration trustStoreConfig)

Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.

Parameters:

protocol - The protocol, see SSLContext Algorithms

keyStoreConfig - The KeyStoreConfiguration.

trustStoreConfig - The TrustStoreConfiguration.

Returns:

a new SslConfiguration

createSSLConfiguration

@NullUnmarked
@PluginFactory
public static SslConfiguration createSSLConfiguration(@PluginAttribute("protocol")
                                                      java.lang.String protocol,
                                                      @PluginElement("KeyStore")
                                                      KeyStoreConfiguration keyStoreConfig,
                                                      @PluginElement("TrustStore")
                                                      TrustStoreConfiguration trustStoreConfig,
                                                      @PluginAttribute("verifyHostName")
                                                      boolean verifyHostName)

Creates an SslConfiguration from a KeyStoreConfiguration and a TrustStoreConfiguration.

Parameters:

protocol - The protocol, see SSLContext Algorithms

keyStoreConfig - The KeyStoreConfiguration.

trustStoreConfig - The TrustStoreConfiguration.

verifyHostName - whether or not to perform host name verification

Returns:

a new SslConfiguration

Since:

2.12

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getProtocol

public java.lang.String getProtocol()

isVerifyHostName

public boolean isVerifyHostName()

getKeyStoreConfig

public @Nullable KeyStoreConfiguration getKeyStoreConfig()

getTrustStoreConfig

public @Nullable TrustStoreConfiguration getTrustStoreConfig()

getSslContext

public @Nullable javax.net.ssl.SSLContext getSslContext()