Class SpiffeSslSocketFactory

java.lang.Object

javax.net.SocketFactory

javax.net.ssl.SSLSocketFactory

io.spiffe.provider.SpiffeSslSocketFactory

public class SpiffeSslSocketFactory
extends SSLSocketFactory

Implementation of SSLSocketFactory that provides methods to create SSLSocket backed by a SPIFFE SSLContext SpiffeSslContextFactory.

Constructor Summary

Constructors

Constructor	Description
SpiffeSslSocketFactory()	Default Constructor.
SpiffeSslSocketFactory(SpiffeSslContextFactory.SslContextOptions contextOptions)	Constructor.

Method Summary

Modifier and Type	Method	Description
Socket	createSocket()
Socket	createSocket(String s, int i)
Socket	createSocket(String s, int i, InetAddress inetAddress, int i1)
Socket	createSocket(InetAddress inetAddress, int i)
Socket	createSocket(InetAddress inetAddress, int i, InetAddress inetAddress1, int i1)
Socket	createSocket(Socket socket, String s, int i, boolean b)
String[]	getDefaultCipherSuites()
String[]	getSupportedCipherSuites()

Methods inherited from class javax.net.ssl.SSLSocketFactory

createSocket, getDefault

Methods inherited from class java.lang.Object

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

Constructor Details

SpiffeSslSocketFactory

public SpiffeSslSocketFactory()
                       throws io.spiffe.exception.SocketEndpointAddressException,
io.spiffe.exception.X509SourceException,
NoSuchAlgorithmException,
KeyManagementException

Default Constructor. This SpiffeSslSocketFactory is backed by SPIFFE-aware SSLContext that obtains certificates from the SPIFFE Workload API, connecting to a socket configured through the environment variable 'SPIFFE_ENDPOINT_SOCKET'. The list of accepted SPIFFE IDs, that will be used to validate the SAN in a peer certificate, can be configured through the property 'ssl.spiffe.accept', separating the SPIFFE IDs using commas without spaces, e.g., '-Dssl.spiffe.accept=spiffe://domain.test/service,spiffe://example.org/app' If the property is not set, any SPIFFE ID will be accepted in a TLS connection.

Throws:

NoSuchAlgorithmException - if there is a problem creating the SSL context

KeyManagementException - if there is a problem initializing the SSL context

io.spiffe.exception.X509SourceException - if there is a problem creating the source of X.509 certificates

io.spiffe.exception.SocketEndpointAddressException - if there is a problem connecting to the local SPIFFE socket

SpiffeSslSocketFactory

public SpiffeSslSocketFactory(SpiffeSslContextFactory.SslContextOptions contextOptions)
                       throws KeyManagementException,
NoSuchAlgorithmException

Constructor.

Parameters:

contextOptions - options for creating the SSL Context

Throws:

NoSuchAlgorithmException - if there is a problem creating the SSL context

KeyManagementException - if there is a problem initializing the SSL context

Method Details

getDefaultCipherSuites

public String[] getDefaultCipherSuites()

Specified by:

getDefaultCipherSuites in class SSLSocketFactory

getSupportedCipherSuites

public String[] getSupportedCipherSuites()

Specified by:

getSupportedCipherSuites in class SSLSocketFactory

createSocket

public Socket createSocket(Socket socket,
 String s,
 int i,
 boolean b)
                    throws IOException

Specified by:

createSocket in class SSLSocketFactory

Throws:

IOException

createSocket

public Socket createSocket(String s,
 int i)
                    throws IOException

Specified by:

createSocket in class SocketFactory

Throws:

IOException

createSocket

public Socket createSocket(String s,
 int i,
 InetAddress inetAddress,
 int i1)
                    throws IOException

Specified by:

createSocket in class SocketFactory

Throws:

IOException

createSocket

public Socket createSocket(InetAddress inetAddress,
 int i)
                    throws IOException

Specified by:

createSocket in class SocketFactory

Throws:

IOException

createSocket

public Socket createSocket(InetAddress inetAddress,
 int i,
 InetAddress inetAddress1,
 int i1)
                    throws IOException

Specified by:

createSocket in class SocketFactory

Throws:

IOException

createSocket

public Socket createSocket()
                    throws IOException

Overrides:

createSocket in class SocketFactory

Throws:

IOException