com.unboundid.util.ssl.SetEnabledProtocolsAndCipherSuitesSSLSocketFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2015-2023 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2015-2023 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2015-2023 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.util.ssl;
import java.io.IOException;
import java.net.InetAddress;
import java.net.Socket;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import javax.net.ssl.SSLSocketFactory;
import com.unboundid.util.InternalUseOnly;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class provides an implementation of an {@code SSLSocketFactory} that
* will update the set of enabled protocols and cipher suites as soon as the
* socket is connected. Note that although not all socket factory
* implementations are threadsafe, the LDAP SDK will only use this factory in a
* way that is threadsafe.
*/
@InternalUseOnly()
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.MOSTLY_THREADSAFE)
final class SetEnabledProtocolsAndCipherSuitesSSLSocketFactory
extends SSLSocketFactory
{
// The set of cipher suites that should be enabled for sockets created by this
// socket factory.
@NotNull private final Set cipherSuites;
// The set of protocols that should be enabled for sockets created by this
// socket factory.
@NotNull private final Set protocols;
// The SSL socket factory to which most of the work will be delegated.
@NotNull private final SSLSocketFactory delegateFactory;
/**
* Creates a new instance of this socket factory with the provided
* information.
*
* @param delegateFactory The SSL socket factory to which most processing
* will be delegated.
* @param defaultProtocol The default protocol to use.
* @param cipherSuites The cipher suites to be enabled on sockets created
* by this socket factory.
*/
SetEnabledProtocolsAndCipherSuitesSSLSocketFactory(
@NotNull final SSLSocketFactory delegateFactory,
@NotNull final String defaultProtocol,
@NotNull final Set cipherSuites)
{
this.delegateFactory = delegateFactory;
this.cipherSuites = cipherSuites;
if (defaultProtocol.equalsIgnoreCase(SSLUtil.SSL_PROTOCOL_TLS_1_3))
{
protocols = new HashSet<>(Arrays.asList(SSLUtil.SSL_PROTOCOL_TLS_1_3,
SSLUtil.SSL_PROTOCOL_TLS_1_2));
}
else if (defaultProtocol.equalsIgnoreCase(SSLUtil.SSL_PROTOCOL_TLS_1_2))
{
protocols = new HashSet<>(Collections.singletonList(
SSLUtil.SSL_PROTOCOL_TLS_1_2));
}
else if (defaultProtocol.equalsIgnoreCase(SSLUtil.SSL_PROTOCOL_TLS_1_1))
{
protocols = new HashSet<>(Arrays.asList(SSLUtil.SSL_PROTOCOL_TLS_1_1,
SSLUtil.SSL_PROTOCOL_TLS_1));
}
else if (defaultProtocol.equalsIgnoreCase(SSLUtil.SSL_PROTOCOL_TLS_1))
{
protocols = new HashSet<>(Collections.singletonList(
SSLUtil.SSL_PROTOCOL_TLS_1));
}
else
{
// This will cause the socket to just use its default set of protocols.
protocols = Collections.emptySet();
}
}
/**
* Creates a new instance of this socket factory with the provided
* information.
*
* @param delegateFactory The SSL socket factory to which most processing
* will be delegated.
* @param protocols The protocols to be enabled on sockets created by
* this socket factory.
* @param cipherSuites The cipher suites to be enabled on sockets created
* by this socket factory.
*/
SetEnabledProtocolsAndCipherSuitesSSLSocketFactory(
@NotNull final SSLSocketFactory delegateFactory,
@NotNull final Set protocols,
@NotNull final Set cipherSuites)
{
this.delegateFactory = delegateFactory;
this.protocols = protocols;
this.cipherSuites = cipherSuites;
}
/**
* Creates a new unconnected socket.
*
* @return The socket that was created.
*
* @throws IOException If the socket cannot be created.
*/
@Override()
@NotNull()
public Socket createSocket()
throws IOException
{
return new SetEnabledProtocolsAndCipherSuitesSocket(
delegateFactory.createSocket(), protocols, cipherSuites);
}
/**
* Creates a new socket with the provided information.
*
* @param host The remote address to which the socket should be connected.
* @param port The remote port to which the socket should be connected.
*
* @return The socket that was created.
*
* @throws IOException If the socket cannot be created.
*/
@Override()
@NotNull()
public Socket createSocket(@NotNull final String host, final int port)
throws IOException
{
final Socket createdSocket =
delegateFactory.createSocket(host, port);
SSLUtil.applyEnabledSSLProtocols(createdSocket, protocols);
SSLUtil.applyEnabledSSLCipherSuites(createdSocket, cipherSuites);
return createdSocket;
}
/**
* Creates a new socket with the provided information.
*
* @param host The remote address to which the socket should be
* connected.
* @param port The remote port to which the socket should be
* connected.
* @param localHost The local address to which the socket should be
* connected.
* @param localPort The local port to which the socket should be connected.
*
* @return The socket that was created.
*
* @throws IOException If the socket cannot be created.
*/
@Override()
@NotNull()
public Socket createSocket(@NotNull final String host, final int port,
@NotNull final InetAddress localHost,
final int localPort)
throws IOException
{
final Socket createdSocket =
delegateFactory.createSocket(host, port, localHost, localPort);
SSLUtil.applyEnabledSSLProtocols(createdSocket, protocols);
SSLUtil.applyEnabledSSLCipherSuites(createdSocket, cipherSuites);
return createdSocket;
}
/**
* Creates a new socket with the provided information.
*
* @param host The remote address to which the socket should be connected.
* @param port The remote port to which the socket should be connected.
*
* @return The socket that was created.
*
* @throws IOException If the socket cannot be created.
*/
@Override()
@NotNull()
public Socket createSocket(@NotNull final InetAddress host, final int port)
throws IOException
{
final Socket createdSocket =
delegateFactory.createSocket(host, port);
SSLUtil.applyEnabledSSLProtocols(createdSocket, protocols);
SSLUtil.applyEnabledSSLCipherSuites(createdSocket, cipherSuites);
return createdSocket;
}
/**
* Creates a new socket with the provided information.
*
* @param host The remote address to which the socket should be
* connected.
* @param port The remote port to which the socket should be
* connected.
* @param localHost The local address to which the socket should be
* connected.
* @param localPort The local port to which the socket should be connected.
*
* @return The socket that was created.
*
* @throws IOException If the socket cannot be created.
*/
@Override()
@NotNull()
public Socket createSocket(@NotNull final InetAddress host, final int port,
@NotNull final InetAddress localHost,
final int localPort)
throws IOException
{
final Socket createdSocket =
delegateFactory.createSocket(host, port, localHost, localPort);
SSLUtil.applyEnabledSSLProtocols(createdSocket, protocols);
SSLUtil.applyEnabledSSLCipherSuites(createdSocket, cipherSuites);
return createdSocket;
}
/**
* Creates a new socket that adds TLS protection to the provided socket.
*
* @param s The socket to use to create the {@code SSLSocket}.
* @param host The host to which the socket is connected.
* @param port The port to which the socket is connected.
* @param autoClose Indicates whether to close the underlying socket when
* the {@code SSLSocket} is closed.
*
* @return The socket that was created.
*
* @throws IOException If a problem is encountered while creating the
* socket.
*/
@Override()
@NotNull()
public Socket createSocket(@NotNull final Socket s,
@NotNull final String host, final int port,
final boolean autoClose)
throws IOException
{
final Socket createdSocket =
delegateFactory.createSocket(s, host, port, autoClose);
SSLUtil.applyEnabledSSLProtocols(createdSocket, protocols);
SSLUtil.applyEnabledSSLCipherSuites(createdSocket, cipherSuites);
return createdSocket;
}
/**
* Retrieves the set of cipher suites that are enabled by default.
*
* @return The set of cipher suites that are enabled by default.
*/
@Override()
@NotNull()
public String[] getDefaultCipherSuites()
{
return delegateFactory.getDefaultCipherSuites();
}
/**
* Retrieves the set of cipher suites that could be enabled.
*
* @return The set of cipher suites that could be enabled.
*/
@Override()
@NotNull()
public String[] getSupportedCipherSuites()
{
return delegateFactory.getSupportedCipherSuites();
}
}