com.unboundid.util.ProxySocketFactory 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 2023 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 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) 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;
import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.Proxy;
import java.net.Socket;
import javax.net.SocketFactory;
import javax.net.ssl.SSLSocketFactory;
import static com.unboundid.util.UtilityMessages.*;
/**
* This class provides a base API for creating sockets that tunnel communication
* through a proxy server. Subclasses may implement support for specific types
* of proxy servers (e.g., HTTP or SOCKS).
*/
@NotExtensible()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
abstract class ProxySocketFactory
extends SocketFactory
{
// The maximum length of time in milliseconds to wait for a connection to be
// established.
private final int connectTimeoutMillis;
// The Proxy instance that will be used to communicate with the proxy server.
@NotNull private final Proxy proxy;
// An optional SSLSocketFactory instance that can be used to secure
// communication through the proxy server.
@Nullable private final SSLSocketFactory sslSocketFactory;
/**
* Creates a new instance of this socket factory with the provided settings.
* The resulting socket factory may provide support for either unencrypted
* LDAP communication (if the provided {@code sslSocketFactory} value is
* {@code null}) or encrypted LDAPS communication (if the provided
* {@code sslSocketFactory} value is non-{@code null}).
*
* @param proxy A preconfigured {@code Proxy} instance to use
* to communicate with the proxy server. It
* must not be {@code null}.
* @param connectTimeoutMillis The maximum length of time in milliseconds to
* wait for a connection to be established. A
* value that is less than or equal to zero
* indicates that no explicit timeout will be
* imposed.
* @param sslSocketFactory An SSL socket factory that should be used if
* communication with the target LDAP server
* should be encrypted with TLS. It must be
* {@code null} if communication should not be
* encrypted, and it must not be {@code null} if
* communication should be encrypted with TLS.
*/
protected ProxySocketFactory(@NotNull final Proxy proxy,
final int connectTimeoutMillis,
@Nullable final SSLSocketFactory sslSocketFactory)
{
this.proxy = proxy;
this.connectTimeoutMillis = Math.max(connectTimeoutMillis, 0);
this.sslSocketFactory = sslSocketFactory;
}
/**
* Creates an unconnected socket that will use the configured proxy server for
* communication. Note that this method can only be used when communication
* through the proxy server will not be encrypted.
*
* @throws UnsupportedOperationException If an {@code SSLSocketFactory}
* has been configured to secure
* communication with end servers.
*/
@Override()
@NotNull()
public final Socket createSocket()
throws UnsupportedOperationException
{
if (sslSocketFactory == null)
{
return new Socket(proxy);
}
else
{
throw new UnsupportedOperationException(
ERR_PROXY_SF_CANNOT_CREATE_UNCONNECTED_SOCKET.get());
}
}
/**
* Creates a new socket that is connected to the specified system through the
* proxy server.
*
* @param host The address of the server to which the socket should be
* established. It must not be {@code null}.
* @param port The port of the server to which the socket should be
* established.
*
* @throws IOException If a problem is encountered while attempting to
* establish the connection.
*/
@Override()
@NotNull()
public final Socket createSocket(@NotNull final String host, final int port)
throws IOException
{
final Socket socket = new Socket(proxy);
socket.connect(new InetSocketAddress(host, port), connectTimeoutMillis);
return secureSocket(socket, host, port);
}
/**
* Creates a new socket that is connected to the specified system through the
* proxy server.
*
* @param host The address of the server to which the socket should be
* established. It must not be {@code null}.
* @param port The port of the server to which the socket should be
* established.
* @param localHost The local address to which the socket should be bound.
* It may optionally be {@code null} it may be bound to
* any local address.
* @param localPort The local port to which the socket should be bound.
*
* @throws IOException If a problem is encountered while attempting to
* establish the connection.
*/
@Override()
@NotNull()
public final Socket createSocket(@NotNull final String host, final int port,
@Nullable final InetAddress localHost,
final int localPort)
throws IOException
{
final Socket socket = new Socket(proxy);
socket.bind(new InetSocketAddress(localHost, localPort));
socket.connect(new InetSocketAddress(host, port), connectTimeoutMillis);
return secureSocket(socket, host, port);
}
/**
* Creates a new socket that is connected to the specified system through the
* proxy server.
*
* @param host The address of the server to which the socket should be
* established. It must not be {@code null}.
* @param port The port of the server to which the socket should be
* established.
*
* @throws IOException If a problem is encountered while attempting to
* establish the connection.
*/
@Override()
@NotNull()
public final Socket createSocket(@NotNull final InetAddress host,
final int port)
throws IOException
{
final Socket socket = new Socket(proxy);
socket.connect(new InetSocketAddress(host, port), connectTimeoutMillis);
return secureSocket(socket, host.getHostName(), port);
}
/**
* Creates a new socket that is connected to the specified system through the
* proxy server.
*
* @param host The address of the server to which the socket should be
* established. It must not be {@code null}.
* @param port The port of the server to which the socket should be
* established.
* @param localHost The local address to which the socket should be bound.
* It may optionally be {@code null} if it may be bound to
* any local address.
* @param localPort The local port to which the socket should be bound.
*
* @throws IOException If a problem is encountered while attempting to
* establish the connection.
*/
@Override()
@NotNull()
public final Socket createSocket(@NotNull final InetAddress host,
final int port,
@Nullable final InetAddress localHost,
final int localPort)
throws IOException
{
final Socket socket = new Socket(proxy);
socket.bind(new InetSocketAddress(localHost, localPort));
socket.connect(new InetSocketAddress(host, port), connectTimeoutMillis);
return secureSocket(socket, host.getHostName(), port);
}
/**
* Adds TLS security to the provided socket, if appropriate.
*
* @param socket The socket to be optionally secured.
* @param host The address of the server to which the socket is
* established.
* @param port The port of the server to which the socket is established.
*
* @return An {@code SSLSocket} that wraps the provided socket if the
* communication should be secured, or the provided socket if no
* additional security is needed.
*
* @throws IOException If a problem is encountered while attempting to
* secure communication with the target server. If an
* exception is thrown, then the socket will have been
* closed
*/
@NotNull()
private Socket secureSocket(@NotNull final Socket socket,
@NotNull final String host,
final int port)
throws IOException
{
if (sslSocketFactory == null)
{
return socket;
}
try
{
return sslSocketFactory.createSocket(socket, host, port, true);
}
catch (final IOException e)
{
Debug.debugException(e);
try
{
socket.close();
}
catch (final Exception e2)
{
Debug.debugException(e2);
}
throw e;
}
}
}