edu.vt.middleware.ldap.ssl.AbstractTLSSocketFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vt-ldap Show documentation
Show all versions of vt-ldap Show documentation
Library for performing common LDAP operations
/*
$Id$
Copyright (C) 2003-2010 Virginia Tech.
All rights reserved.
SEE LICENSE FOR MORE INFORMATION
Author: Middleware Services
Email: [email protected]
Version: $Revision$
Updated: $Date$
*/
package edu.vt.middleware.ldap.ssl;
import java.io.IOException;
import java.net.InetAddress;
import java.net.Socket;
import java.security.GeneralSecurityException;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLPeerUnverifiedException;
import javax.net.ssl.SSLSocket;
import javax.net.ssl.SSLSocketFactory;
/**
* Provides common implementation for TLSSocketFactory.
*
* @author Middleware Services
* @version $Revision: 1106 $ $Date: 2010-01-29 23:34:13 -0500 (Fri, 29 Jan 2010) $
*/
public abstract class AbstractTLSSocketFactory extends SSLSocketFactory
{
/** Default SSL protocol, value is {@value}. */
public static final String DEFAULT_PROTOCOL = "TLS";
/** SSLSocketFactory used for creating SSL sockets. */
protected SSLSocketFactory factory;
/** Hostname verifier for this socket factory. */
protected HostnameVerifier hostnameVerifier;
/** Enabled cipher suites. */
protected String[] cipherSuites;
/** Enabled protocol versions. */
protected String[] protocols;
/**
* Prepares this socket factory for use. Must be called before factory can be
* used.
*
* @throws GeneralSecurityException if the factory cannot be initialized
*/
public abstract void initialize()
throws GeneralSecurityException;
/**
* This returns the underlying SSLSocketFactory that this class
* uses for creating SSL Sockets.
*
* @return SSLSocketFactory
*/
public SSLSocketFactory getFactory()
{
return this.factory;
}
/**
* Returns the hostname verifier to invoke when sockets are created.
*
* @return hostname verifier
*/
public HostnameVerifier getHostnameVerifier()
{
return hostnameVerifier;
}
/**
* Sets the hostname verifier to invoke when sockets are created.
*
* @param verifier for SSL hostnames
*/
public void setHostnameVerifier(final HostnameVerifier verifier)
{
hostnameVerifier = verifier;
}
/**
* This returns the names of the SSL cipher suites which are currently enabled
* for use on sockets created by this factory. A null value indicates that no
* specific cipher suites have been enabled and that the default suites are in
* use.
*
* @return String[] of cipher suites
*/
public String[] getEnabledCipherSuites()
{
return this.cipherSuites;
}
/**
* Sets the cipher suites enabled for use on sockets created by this factory.
* See {@link javax.net.ssl.SSLSocket#setEnabledCipherSuites(String[])}.
*
* @param s String[] of cipher suites
*/
public void setEnabledCipherSuites(final String[] s)
{
this.cipherSuites = s;
}
/**
* This returns the names of the protocol versions which are currently enabled
* for use on sockets created by this factory. A null value indicates that no
* specific protocols have been enabled and that the default protocols are in
* use.
*
* @return String[] of protocols
*/
public String[] getEnabledProtocols()
{
return this.protocols;
}
/**
* Sets the protocol versions enabled for use on sockets created by this
* factory. See {@link javax.net.ssl.SSLSocket#setEnabledProtocols(String[])}.
*
* @param s String[] of cipher suites
*/
public void setEnabledProtocols(final String[] s)
{
this.protocols = s;
}
/**
* Initializes the supplied socket for use.
*
* @param s SSLSocket to initialize
*
* @return SSLSocket
*
* @throws IOException if an I/O error occurs when initializing the socket
*/
protected SSLSocket initSSLSocket(final SSLSocket s)
throws IOException
{
if (this.cipherSuites != null) {
s.setEnabledCipherSuites(this.cipherSuites);
}
if (this.protocols != null) {
s.setEnabledProtocols(this.protocols);
}
if (hostnameVerifier != null) {
// calling getSession() will initiate the handshake if necessary
final String hostname = s.getSession().getPeerHost();
if (!hostnameVerifier.verify(hostname, s.getSession())) {
s.close();
s.getSession().invalidate();
throw new SSLPeerUnverifiedException(
String.format(
"Hostname '%s' does not match the hostname in the server's " +
"certificate", hostname));
}
}
return s;
}
/**
* This returns a socket layered over an existing socket connected to the
* named host, at the given port.
*
* @param s Socket existing socket
* @param host String server hostname
* @param port int server port
* @param autoClose boolean close the underlying socket when
* this socket is closed
*
* @return Socket - connected to the specified host and port
*
* @throws IOException if an I/O error occurs when creating the socket
*/
public Socket createSocket(
final Socket s,
final String host,
final int port,
final boolean autoClose)
throws IOException
{
SSLSocket socket = null;
if (this.factory != null) {
socket = this.initSSLSocket(
(SSLSocket) this.factory.createSocket(s, host, port, autoClose));
}
return socket;
}
/**
* This creates an unconnected socket.
*
* @return Socket - unconnected socket
*
* @throws IOException if an I/O error occurs when creating the socket
*/
public Socket createSocket()
throws IOException
{
SSLSocket socket = null;
if (this.factory != null) {
socket = this.initSSLSocket((SSLSocket) this.factory.createSocket());
}
return socket;
}
/**
* This creates a socket and connects it to the specified port number at the
* specified address.
*
* @param host InetAddress server hostname
* @param port int server port
*
* @return Socket - connected to the specified host and port
*
* @throws IOException if an I/O error occurs when creating the socket
*/
public Socket createSocket(final InetAddress host, final int port)
throws IOException
{
SSLSocket socket = null;
if (this.factory != null) {
socket = this.initSSLSocket(
(SSLSocket) this.factory.createSocket(host, port));
}
return socket;
}
/**
* This creates a socket and connect it to the specified port number at the
* specified address. The socket will also be bound to the supplied local
* address and port.
*
* @param address InetAddress server hostname
* @param port int server port
* @param localAddress InetAddress client hostname
* @param localPort int client port
*
* @return Socket - connected to the specified host and port
*
* @throws IOException if an I/O error occurs when creating the socket
*/
public Socket createSocket(
final InetAddress address,
final int port,
final InetAddress localAddress,
final int localPort)
throws IOException
{
SSLSocket socket = null;
if (this.factory != null) {
socket = this.initSSLSocket(
(SSLSocket) this.factory.createSocket(
address,
port,
localAddress,
localPort));
}
return socket;
}
/**
* This creates a socket and connects it to the specified port number at the
* specified address.
*
* @param host String server hostname
* @param port int server port
*
* @return Socket - connected to the specified host and port
*
* @throws IOException if an I/O error occurs when creating the socket
*/
public Socket createSocket(final String host, final int port)
throws IOException
{
SSLSocket socket = null;
if (this.factory != null) {
socket = this.initSSLSocket(
(SSLSocket) this.factory.createSocket(host, port));
}
return socket;
}
/**
* This creates a socket and connect it to the specified port number at the
* specified address. The socket will also be bound to the supplied local
* address and port.
*
* @param host String server hostname
* @param port int server port
* @param localHost InetAddress client hostname
* @param localPort int client port
*
* @return Socket - connected to the specified host and port
*
* @throws IOException if an I/O error occurs when creating the socket
*/
public Socket createSocket(
final String host,
final int port,
final InetAddress localHost,
final int localPort)
throws IOException
{
SSLSocket socket = null;
if (this.factory != null) {
socket = this.initSSLSocket(
(SSLSocket) this.factory.createSocket(
host,
port,
localHost,
localPort));
}
return socket;
}
/**
* This returns the list of cipher suites which are enabled by default.
*
* @return String[] - array of the cipher suites
*/
public String[] getDefaultCipherSuites()
{
String[] ciphers = null;
if (this.factory != null) {
ciphers = this.factory.getDefaultCipherSuites();
}
return ciphers;
}
/**
* This returns the names of the cipher suites which could be enabled for use
* on an SSL connection.
*
* @return String[] - array of the cipher suites
*/
public String[] getSupportedCipherSuites()
{
String[] ciphers = null;
if (this.factory != null) {
ciphers = this.factory.getSupportedCipherSuites();
}
return ciphers;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy