You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2020/04/13 22:59:54 UTC
[logging-log4j2] branch release-2.x updated (9af4523 -> 6851b50)
This is an automated email from the ASF dual-hosted git repository.
mattsicker pushed a change to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git.
from 9af4523 Add docs for verifyHostName
new 4093eaf Add javadoc for verifyHostName
new 6851b50 [LOG4J2-2819] Add support for specifying an SSL configuration for SmtpAppender
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
log4j-core/revapi.json | 29 ++-
.../logging/log4j/core/appender/SmtpAppender.java | 251 +++++++++++++++++----
.../apache/logging/log4j/core/net/SmtpManager.java | 31 ++-
.../log4j/core/net/ssl/SslConfiguration.java | 1 +
.../log4j/core/appender/SmtpAppenderTest.java | 20 +-
5 files changed, 276 insertions(+), 56 deletions(-)
[logging-log4j2] 02/02: [LOG4J2-2819] Add support for specifying an
SSL configuration for SmtpAppender
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mattsicker pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 6851b5083ef9610bae320bf07e1f24d2aa08851b
Author: Matt Sicker <bo...@gmail.com>
AuthorDate: Mon Apr 13 17:59:43 2020 -0500
[LOG4J2-2819] Add support for specifying an SSL configuration for SmtpAppender
Signed-off-by: Matt Sicker <bo...@gmail.com>
---
log4j-core/revapi.json | 29 ++-
.../logging/log4j/core/appender/SmtpAppender.java | 251 +++++++++++++++++----
.../apache/logging/log4j/core/net/SmtpManager.java | 31 ++-
.../log4j/core/appender/SmtpAppenderTest.java | 20 +-
4 files changed, 275 insertions(+), 56 deletions(-)
diff --git a/log4j-core/revapi.json b/log4j-core/revapi.json
index 3aff652..d809da3 100644
--- a/log4j-core/revapi.json
+++ b/log4j-core/revapi.json
@@ -119,7 +119,34 @@
"old": "parameter java.nio.file.FileVisitResult java.nio.file.SimpleFileVisitor<T>::visitFileFailed(===T===, java.io.IOException) throws java.io.IOException @ org.apache.logging.log4j.core.appender.rolling.action.SortingVisitor",
"new": "parameter java.nio.file.FileVisitResult org.apache.logging.log4j.core.appender.rolling.action.SortingVisitor::visitFileFailed(===java.nio.file.Path===, java.io.IOException) throws java.io.IOException",
"justification": "Class overrides a type with generics, in practice there is no change."
+ },
+ {
+ "code": "java.annotation.removed",
+ "old": "method org.apache.logging.log4j.core.appender.SmtpAppender org.apache.logging.log4j.core.appender.SmtpAppender::createAppender(org.apache.logging.log4j.core.config.Configuration, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.apache.logging.log4j.core.Layout<? extend [...]
+ "new": "method org.apache.logging.log4j.core.appender.SmtpAppender org.apache.logging.log4j.core.appender.SmtpAppender::createAppender(org.apache.logging.log4j.core.config.Configuration, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.apache.logging.log4j.core.Layout<? extend [...]
+ "annotation": "@org.apache.logging.log4j.core.config.plugins.PluginFactory",
+ "justification": "Plugin is created through builder class now. No practical change here."
+ },
+ {
+ "code": "java.method.numberOfParametersChanged",
+ "old": "method org.apache.logging.log4j.core.net.SmtpManager org.apache.logging.log4j.core.net.SmtpManager::getSmtpManager(org.apache.logging.log4j.core.config.Configuration, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, boolean, java.lang.String, int)",
+ "new": "method org.apache.logging.log4j.core.net.SmtpManager org.apache.logging.log4j.core.net.SmtpManager::getSmtpManager(org.apache.logging.log4j.core.config.Configuration, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, boolean, java.lang.String, int, org.apache.logging.log4j.core.net.ssl.SslConfiguration)",
+ "justification": "LOG4J2-2819 - Add support for specifying an SSL configuration for SmtpAppender"
+ },
+ {
+ "code": "java.annotation.added",
+ "old": "parameter org.apache.logging.log4j.core.net.ssl.SslConfiguration org.apache.logging.log4j.core.net.ssl.SslConfiguration::createSSLConfiguration(java.lang.String, org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration, org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration, ===boolean===)",
+ "new": "parameter org.apache.logging.log4j.core.net.ssl.SslConfiguration org.apache.logging.log4j.core.net.ssl.SslConfiguration::createSSLConfiguration(java.lang.String, org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration, org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration, ===boolean===)",
+ "annotation": "@org.apache.logging.log4j.core.config.plugins.PluginAttribute(\"verifyHostName\")",
+ "justification": "LOG4J2-TODO"
+ },
+ {
+ "code": "java.annotation.removed",
+ "old": "parameter org.apache.logging.log4j.core.net.ssl.SslConfiguration org.apache.logging.log4j.core.net.ssl.SslConfiguration::createSSLConfiguration(java.lang.String, org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration, org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration, ===boolean===)",
+ "new": "parameter org.apache.logging.log4j.core.net.ssl.SslConfiguration org.apache.logging.log4j.core.net.ssl.SslConfiguration::createSSLConfiguration(java.lang.String, org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration, org.apache.logging.log4j.core.net.ssl.TrustStoreConfiguration, ===boolean===)",
+ "annotation": "@org.apache.logging.log4j.core.config.plugins.PluginElement(\"verifyHostName\")",
+ "justification": "LOG4J2-TODO"
}
]
}
-]
\ No newline at end of file
+]
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SmtpAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SmtpAppender.java
index 714fe2d..f123441 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SmtpAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SmtpAppender.java
@@ -17,8 +17,6 @@
package org.apache.logging.log4j.core.appender;
-import java.io.Serializable;
-
import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.Core;
import org.apache.logging.log4j.core.Filter;
@@ -29,16 +27,20 @@ import org.apache.logging.log4j.core.config.DefaultConfiguration;
import org.apache.logging.log4j.core.config.Property;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
+import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
+import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
-import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;
import org.apache.logging.log4j.core.config.plugins.validation.constraints.ValidPort;
import org.apache.logging.log4j.core.filter.ThresholdFilter;
import org.apache.logging.log4j.core.layout.HtmlLayout;
import org.apache.logging.log4j.core.net.SmtpManager;
+import org.apache.logging.log4j.core.net.ssl.SslConfiguration;
import org.apache.logging.log4j.core.util.Booleans;
+import java.io.Serializable;
+
/**
* Send an e-mail when a specific logging event occurs, typically on errors or
* fatal errors.
@@ -72,45 +74,212 @@ public final class SmtpAppender extends AbstractAppender {
}
/**
+ * @since 2.13.2
+ */
+ public static class Builder extends AbstractAppender.Builder<Builder>
+ implements org.apache.logging.log4j.core.util.Builder<SmtpAppender> {
+ @PluginBuilderAttribute
+ private String to;
+
+ @PluginBuilderAttribute
+ private String cc;
+
+ @PluginBuilderAttribute
+ private String bcc;
+
+ @PluginBuilderAttribute
+ private String from;
+
+ @PluginBuilderAttribute
+ private String replyTo;
+
+ @PluginBuilderAttribute
+ private String subject;
+
+ @PluginBuilderAttribute
+ private String smtpProtocol = "smtp";
+
+ @PluginBuilderAttribute
+ private String smtpHost;
+
+ @PluginBuilderAttribute
+ @ValidPort
+ private int smtpPort;
+
+ @PluginBuilderAttribute
+ private String smtpUsername;
+
+ @PluginBuilderAttribute(sensitive = true)
+ private String smtpPassword;
+
+ @PluginBuilderAttribute
+ private boolean smtpDebug;
+
+ @PluginBuilderAttribute
+ private int bufferSize = DEFAULT_BUFFER_SIZE;
+
+ @PluginElement("SSL")
+ private SslConfiguration sslConfiguration;
+
+ /**
+ * Comma-separated list of recipient email addresses.
+ */
+ public Builder setTo(final String to) {
+ this.to = to;
+ return this;
+ }
+
+ /**
+ * Comma-separated list of CC email addresses.
+ */
+ public Builder setCc(final String cc) {
+ this.cc = cc;
+ return this;
+ }
+
+ /**
+ * Comma-separated list of BCC email addresses.
+ */
+ public Builder setBcc(final String bcc) {
+ this.bcc = bcc;
+ return this;
+ }
+
+ /**
+ * Email address of the sender.
+ */
+ public Builder setFrom(final String from) {
+ this.from = from;
+ return this;
+ }
+
+ /**
+ * Comma-separated list of Reply-To email addresses.
+ */
+ public Builder setReplyTo(final String replyTo) {
+ this.replyTo = replyTo;
+ return this;
+ }
+
+ /**
+ * Subject template for the email messages.
+ * @see org.apache.logging.log4j.core.layout.PatternLayout
+ */
+ public Builder setSubject(final String subject) {
+ this.subject = subject;
+ return this;
+ }
+
+ /**
+ * Transport protocol to use for SMTP such as "smtp" or "smtps". Defaults to "smtp".
+ */
+ public Builder setSmtpProtocol(final String smtpProtocol) {
+ this.smtpProtocol = smtpProtocol;
+ return this;
+ }
+
+ /**
+ * Host name of SMTP server to send messages through.
+ */
+ public Builder setSmtpHost(final String smtpHost) {
+ this.smtpHost = smtpHost;
+ return this;
+ }
+
+ /**
+ * Port number of SMTP server to send messages through.
+ */
+ public Builder setSmtpPort(final int smtpPort) {
+ this.smtpPort = smtpPort;
+ return this;
+ }
+
+ /**
+ * Username to authenticate with SMTP server.
+ */
+ public Builder setSmtpUsername(final String smtpUsername) {
+ this.smtpUsername = smtpUsername;
+ return this;
+ }
+
+ /**
+ * Password to authenticate with SMTP server.
+ */
+ public Builder setSmtpPassword(final String smtpPassword) {
+ this.smtpPassword = smtpPassword;
+ return this;
+ }
+
+ /**
+ * Enables or disables mail session debugging on STDOUT. Disabled by default.
+ */
+ public Builder setSmtpDebug(final boolean smtpDebug) {
+ this.smtpDebug = smtpDebug;
+ return this;
+ }
+
+ /**
+ * Number of log events to buffer before sending an email. Defaults to {@value #DEFAULT_BUFFER_SIZE}.
+ */
+ public Builder setBufferSize(final int bufferSize) {
+ this.bufferSize = bufferSize;
+ return this;
+ }
+
+ /**
+ * Specifies an SSL configuration for smtps connections.
+ */
+ public Builder setSslConfiguration(final SslConfiguration sslConfiguration) {
+ this.sslConfiguration = sslConfiguration;
+ return this;
+ }
+
+ /**
+ * Specifies the layout used for the email message body. By default, this uses the
+ * {@linkplain HtmlLayout#createDefaultLayout() default HTML layout}.
+ */
+ @Override
+ public Builder setLayout(final Layout<? extends Serializable> layout) {
+ return super.setLayout(layout);
+ }
+
+ /**
+ * Specifies the filter used for this appender. By default, uses a {@link ThresholdFilter} with a level of
+ * ERROR.
+ */
+ @Override
+ public Builder setFilter(final Filter filter) {
+ return super.setFilter(filter);
+ }
+
+ @Override
+ public SmtpAppender build() {
+ if (getLayout() == null) {
+ setLayout(HtmlLayout.createDefaultLayout());
+ }
+ if (getFilter() == null) {
+ setFilter(ThresholdFilter.createFilter(null, null, null));
+ }
+ final SmtpManager smtpManager = SmtpManager.getSmtpManager(getConfiguration(), to, cc, bcc, from, replyTo,
+ subject, smtpProtocol, smtpHost, smtpPort, smtpUsername, smtpPassword, smtpDebug,
+ getFilter().toString(), bufferSize, sslConfiguration);
+ return new SmtpAppender(getName(), getFilter(), getLayout(), smtpManager, isIgnoreExceptions(), getPropertyArray());
+ }
+ }
+
+ /**
+ * @since 2.13.2
+ */
+ @PluginBuilderFactory
+ public static Builder newBuilder() {
+ return new Builder();
+ }
+
+ /**
* Create a SmtpAppender.
- *
- * @param name
- * The name of the Appender.
- * @param to
- * The comma-separated list of recipient email addresses.
- * @param cc
- * The comma-separated list of CC email addresses.
- * @param bcc
- * The comma-separated list of BCC email addresses.
- * @param from
- * The email address of the sender.
- * @param replyTo
- * The comma-separated list of reply-to email addresses.
- * @param subject The subject of the email message.
- * @param smtpProtocol The SMTP transport protocol (such as "smtps", defaults to "smtp").
- * @param smtpHost
- * The SMTP hostname to send to.
- * @param smtpPortStr
- * The SMTP port to send to.
- * @param smtpUsername
- * The username required to authenticate against the SMTP server.
- * @param smtpPassword
- * The password required to authenticate against the SMTP server.
- * @param smtpDebug
- * Enable mail session debuging on STDOUT.
- * @param bufferSizeStr
- * How many log events should be buffered for inclusion in the
- * message?
- * @param layout
- * The layout to use (defaults to HtmlLayout).
- * @param filter
- * The Filter or null (defaults to ThresholdFilter, level of
- * ERROR).
- * @param ignore If {@code "true"} (default) exceptions encountered when appending events are logged; otherwise
- * they are propagated to the caller.
- * @return The SmtpAppender.
+ * @deprecated Use {@link #newBuilder()} to create and configure a {@link Builder} instance.
+ * @see Builder
*/
- @PluginFactory
public static SmtpAppender createAppender(
@PluginConfiguration final Configuration config,
@PluginAttribute("name") @Required final String name,
@@ -149,7 +318,7 @@ public final class SmtpAppender extends AbstractAppender {
final Configuration configuration = config != null ? config : new DefaultConfiguration();
final SmtpManager manager = SmtpManager.getSmtpManager(configuration, to, cc, bcc, from, replyTo, subject, smtpProtocol,
- smtpHost, smtpPort, smtpUsername, smtpPassword, isSmtpDebug, filter.toString(), bufferSize);
+ smtpHost, smtpPort, smtpUsername, smtpPassword, isSmtpDebug, filter.toString(), bufferSize, null);
if (manager == null) {
return null;
}
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SmtpManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SmtpManager.java
index 84b07fe..c637859 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SmtpManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SmtpManager.java
@@ -35,6 +35,7 @@ import javax.mail.internet.MimeMessage;
import javax.mail.internet.MimeMultipart;
import javax.mail.internet.MimeUtility;
import javax.mail.util.ByteArrayDataSource;
+import javax.net.ssl.SSLSocketFactory;
import org.apache.logging.log4j.LoggingException;
import org.apache.logging.log4j.core.Layout;
@@ -46,6 +47,7 @@ import org.apache.logging.log4j.core.impl.Log4jLogEvent;
import org.apache.logging.log4j.core.impl.MutableLogEvent;
import org.apache.logging.log4j.core.layout.AbstractStringLayout.Serializer;
import org.apache.logging.log4j.core.layout.PatternLayout;
+import org.apache.logging.log4j.core.net.ssl.SslConfiguration;
import org.apache.logging.log4j.core.util.CyclicBuffer;
import org.apache.logging.log4j.core.util.NameUtil;
import org.apache.logging.log4j.core.util.NetUtils;
@@ -99,7 +101,8 @@ public class SmtpManager extends AbstractManager {
final String from, final String replyTo,
final String subject, String protocol, final String host,
final int port, final String username, final String password,
- final boolean isDebug, final String filterName, final int numElements) {
+ final boolean isDebug, final String filterName, final int numElements,
+ final SslConfiguration sslConfiguration) {
if (Strings.isEmpty(protocol)) {
protocol = "smtp";
}
@@ -144,7 +147,7 @@ public class SmtpManager extends AbstractManager {
final Serializer subjectSerializer = PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(subject).build();
return getManager(name, FACTORY, new FactoryData(to, cc, bcc, from, replyTo, subjectSerializer,
- protocol, host, port, username, password, isDebug, numElements));
+ protocol, host, port, username, password, isDebug, numElements, sslConfiguration));
}
/**
@@ -275,10 +278,12 @@ public class SmtpManager extends AbstractManager {
private final String password;
private final boolean isDebug;
private final int numElements;
+ private final SslConfiguration sslConfiguration;
public FactoryData(final String to, final String cc, final String bcc, final String from, final String replyTo,
final Serializer subjectSerializer, final String protocol, final String host, final int port,
- final String username, final String password, final boolean isDebug, final int numElements) {
+ final String username, final String password, final boolean isDebug, final int numElements,
+ final SslConfiguration sslConfiguration) {
this.to = to;
this.cc = cc;
this.bcc = bcc;
@@ -292,6 +297,7 @@ public class SmtpManager extends AbstractManager {
this.password = password;
this.isDebug = isDebug;
this.numElements = numElements;
+ this.sslConfiguration = sslConfiguration;
}
}
@@ -317,22 +323,31 @@ public class SmtpManager extends AbstractManager {
final String prefix = "mail." + data.protocol;
final Properties properties = PropertiesUtil.getSystemProperties();
- properties.put("mail.transport.protocol", data.protocol);
+ properties.setProperty("mail.transport.protocol", data.protocol);
if (properties.getProperty("mail.host") == null) {
// Prevent an UnknownHostException in Java 7
- properties.put("mail.host", NetUtils.getLocalHostname());
+ properties.setProperty("mail.host", NetUtils.getLocalHostname());
}
if (null != data.host) {
- properties.put(prefix + ".host", data.host);
+ properties.setProperty(prefix + ".host", data.host);
}
if (data.port > 0) {
- properties.put(prefix + ".port", String.valueOf(data.port));
+ properties.setProperty(prefix + ".port", String.valueOf(data.port));
}
final Authenticator authenticator = buildAuthenticator(data.username, data.password);
if (null != authenticator) {
- properties.put(prefix + ".auth", "true");
+ properties.setProperty(prefix + ".auth", "true");
+ }
+
+ if (data.protocol.equals("smtps")) {
+ final SslConfiguration sslConfiguration = data.sslConfiguration;
+ if (sslConfiguration != null) {
+ final SSLSocketFactory sslSocketFactory = sslConfiguration.getSslSocketFactory();
+ properties.put(prefix + ".ssl.socketFactory", sslSocketFactory);
+ properties.setProperty(prefix + ".ssl.checkserveridentity", Boolean.toString(sslConfiguration.isVerifyHostName()));
+ }
}
final Session session = Session.getInstance(properties, authenticator);
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SmtpAppenderTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SmtpAppenderTest.java
index 61b9b92..d595d16 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SmtpAppenderTest.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SmtpAppenderTest.java
@@ -40,8 +40,6 @@ import static org.junit.Assert.*;
public class SmtpAppenderTest {
private static final String HOST = "localhost";
- private static final int PORTNUM = AvailablePortFinder.getNextAvailable();
- private static final String PORT = String.valueOf(PORTNUM);
@Test
public void testMessageFactorySetFrom() throws MessagingException {
@@ -114,9 +112,19 @@ public class SmtpAppenderTest {
final String subjectKey = getClass().getName();
final String subjectValue = "SubjectValue1";
ThreadContext.put(subjectKey, subjectValue);
- final SmtpAppender appender = SmtpAppender.createAppender(null, "Test", "to@example.com", "cc@example.com",
- "bcc@example.com", "from@example.com", "replyTo@example.com", "Subject Pattern %X{" + subjectKey + "}",
- null, HOST, PORT, null, null, "false", "3", null, null, "true");
+ final int smtpPort = AvailablePortFinder.getNextAvailable();
+ final SmtpAppender appender = SmtpAppender.newBuilder()
+ .setName("Test")
+ .setTo("to@example.com")
+ .setCc("cc@example.com")
+ .setBcc("bcc@example.com")
+ .setFrom("from@example.com")
+ .setReplyTo("replyTo@example.com")
+ .setSubject("Subject Pattern %X{" + subjectKey + "}")
+ .setSmtpHost(HOST)
+ .setSmtpPort(smtpPort)
+ .setBufferSize(3)
+ .build();
appender.start();
final LoggerContext context = LoggerContext.getContext();
@@ -125,7 +133,7 @@ public class SmtpAppenderTest {
root.setAdditive(false);
root.setLevel(Level.DEBUG);
- final SimpleSmtpServer server = SimpleSmtpServer.start(PORTNUM);
+ final SimpleSmtpServer server = SimpleSmtpServer.start(smtpPort);
root.debug("Debug message #1");
root.debug("Debug message #2");
[logging-log4j2] 01/02: Add javadoc for verifyHostName
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mattsicker pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 4093eaf91d906d8aad6063459c6cf4198a3256cd
Author: Matt Sicker <bo...@gmail.com>
AuthorDate: Mon Apr 13 17:24:20 2020 -0500
Add javadoc for verifyHostName
Signed-off-by: Matt Sicker <bo...@gmail.com>
---
.../java/org/apache/logging/log4j/core/net/ssl/SslConfiguration.java | 1 +
1 file changed, 1 insertion(+)
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/ssl/SslConfiguration.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/ssl/SslConfiguration.java
index ad03552..e6df7ff 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/ssl/SslConfiguration.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/ssl/SslConfiguration.java
@@ -243,6 +243,7 @@ public class SslConfiguration {
* @param protocol The protocol, see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#SSLContext
* @param keyStoreConfig The KeyStoreConfiguration.
* @param trustStoreConfig The TrustStoreConfiguration.
+ * @param verifyHostName whether or not to perform host name verification
* @return a new SslConfiguration
* @since 2.12
*/