Package io.opentelemetry.exporter.internal

Class TlsConfigHelper

java.lang.Object

io.opentelemetry.exporter.internal.TlsConfigHelper

public class TlsConfigHelper
extends java.lang.Object

Utility class to help with management of TLS related components. TLS config consists keyManager, trustManager, which combine to form sslContext. These components can be configured via higher level APIs (setTrustManagerFromCerts(byte[]) and setKeyManagerFromCerts(byte[], byte[])) which parse keys in PEM format, or the lower level API setSslContext(SSLContext, X509TrustManager) in which the components are directly set, but NOT both. Attempts to reconfigure components which have already been configured throw IllegalStateException. Consumers access components via any combination of getKeyManager(), getTrustManager(), and getSslContext().

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Field Summary

Fields

Modifier and Type	Field	Description
private javax.net.ssl.X509KeyManager	keyManager
private javax.net.ssl.SSLContext	sslContext
private javax.net.ssl.X509TrustManager	trustManager

Constructor Summary

Constructors

Constructor	Description
TlsConfigHelper()

Method Summary

Modifier and Type	Method	Description
TlsConfigHelper	copy()	Return a shallow copy of this instance.
javax.net.ssl.X509KeyManager	getKeyManager()	Get the X509KeyManager.
javax.net.ssl.SSLContext	getSslContext()	Get the SSLContext.
javax.net.ssl.X509TrustManager	getTrustManager()	Get the X509TrustManager.
void	setKeyManagerFromCerts(byte[] privateKeyPem, byte[] certificatePem)	Configure the X509KeyManager from the given private key and certificate, both in PEM format.
void	setSslContext(javax.net.ssl.SSLContext sslContext, javax.net.ssl.X509TrustManager trustManager)	Configure the SSLContext and X509TrustManager.
void	setTrustManagerFromCerts(byte[] trustedCertsPem)	Configure the X509TrustManager from the given cert content.

Methods inherited from class java.lang.Object

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

Field Detail

keyManager

@Nullable
private javax.net.ssl.X509KeyManager keyManager

trustManager

@Nullable
private javax.net.ssl.X509TrustManager trustManager

sslContext

@Nullable
private javax.net.ssl.SSLContext sslContext

Constructor Detail

TlsConfigHelper

public TlsConfigHelper()

Method Detail

setTrustManagerFromCerts

public void setTrustManagerFromCerts(byte[] trustedCertsPem)

Configure the X509TrustManager from the given cert content.

Must not be called multiple times, or if setSslContext(SSLContext, X509TrustManager) has been previously called.

Parameters:

trustedCertsPem - Certificate in PEM format.

setKeyManagerFromCerts

public void setKeyManagerFromCerts(byte[] privateKeyPem,
                                   byte[] certificatePem)

Configure the X509KeyManager from the given private key and certificate, both in PEM format.

Must not be called multiple times, or if setSslContext(SSLContext, X509TrustManager) has been previously called.

Parameters:

privateKeyPem - Private key content in PEM format.

certificatePem - Certificate content in PEM format.

setSslContext

public void setSslContext(javax.net.ssl.SSLContext sslContext,
                          javax.net.ssl.X509TrustManager trustManager)

Configure the SSLContext and X509TrustManager.

Must not be called multiple times, or if setTrustManagerFromCerts(byte[]) or setKeyManagerFromCerts(byte[], byte[]) has been previously called.

Parameters:

sslContext - the SSL context.

trustManager - the trust manager.

getKeyManager

@Nullable
public javax.net.ssl.X509KeyManager getKeyManager()

Get the X509KeyManager.

getTrustManager

@Nullable
public javax.net.ssl.X509TrustManager getTrustManager()

Get the X509TrustManager.

getSslContext

@Nullable
public javax.net.ssl.SSLContext getSslContext()

Get the SSLContext.

copy

public TlsConfigHelper copy()

Return a shallow copy of this instance.