Package com.browserup.bup.mitm.manager

Class ImpersonatingMitmManager.Builder

java.lang.Object

com.browserup.bup.mitm.manager.ImpersonatingMitmManager.Builder

Enclosing class:

ImpersonatingMitmManager

public static class ImpersonatingMitmManager.Builder
extends java.lang.Object

A Builder for ImpersonatingMitmManagers. Initialized with suitable default values suitable for most purposes.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ImpersonatingMitmManager	build()
ImpersonatingMitmManager.Builder	cacheConcurrencyLevel(int cacheConcurrencyLevel)	The concurrency level for the SSLContext cache.
ImpersonatingMitmManager.Builder	cacheExpirationInterval(long cacheExpirationInterval, java.util.concurrent.TimeUnit timeUnit)	The length of time SSLContexts with forged certificates will be kept in the cache.
ImpersonatingMitmManager.Builder	certificateInfoGenerator(CertificateInfoGenerator certificateInfoGenerator)	The CertificateInfoGenerator that will populate CertificateInfo objects containing certificate data for forced X509Certificates.
ImpersonatingMitmManager.Builder	certificateTool(SecurityProviderTool securityProviderTool)	The SecurityProviderTool implementation that will be used to generate certificates.
ImpersonatingMitmManager.Builder	clientCiphers(java.util.Collection<java.lang.String> clientCiphers)	The cipher suites allowed on client connections to the proxy.
ImpersonatingMitmManager.Builder	rootCertificateSource(CertificateAndKeySource certificateAndKeySource)	The source of the CA root certificate that will be used to sign the impersonated server certificates.
ImpersonatingMitmManager.Builder	serverCiphers(java.util.Collection<java.lang.String> serverCiphers)	The cipher suites allowed on connections to upstream servers.
ImpersonatingMitmManager.Builder	serverKeyGenerator(KeyGenerator serverKeyGenerator)	The KeyGenerator that will be used to generate the server public and private keys.
ImpersonatingMitmManager.Builder	serverMessageDigest(java.lang.String serverMessageDigest)	The message digest that will be used when signing server certificates with the root certificate's private key.
ImpersonatingMitmManager.Builder	trustAllServers(boolean trustAllServers)	When true, no upstream certificate verification will be performed.
ImpersonatingMitmManager.Builder	trustSource(TrustSource trustSource)	The TrustSource that supplies the trusted root CAs used to validate upstream servers' certificates.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

rootCertificateSource

public ImpersonatingMitmManager.Builder rootCertificateSource(CertificateAndKeySource certificateAndKeySource)

The source of the CA root certificate that will be used to sign the impersonated server certificates. Custom certificates can be used by supplying an implementation of CertificateAndKeySource, such as PemFileCertificateSource. Alternatively, a new root certificate can be generated and saved (for later import into browsers) using RootCertificateGenerator.

Parameters:

certificateAndKeySource - impersonation materials source to use

Returns:

Builder

serverMessageDigest

public ImpersonatingMitmManager.Builder serverMessageDigest(java.lang.String serverMessageDigest)

The message digest that will be used when signing server certificates with the root certificate's private key.

Parameters:

serverMessageDigest - serverMessageDigest

Returns:

Builder

trustAllServers

public ImpersonatingMitmManager.Builder trustAllServers(boolean trustAllServers)

When true, no upstream certificate verification will be performed. This will make it possible for attackers to MITM communications with the upstream server, so use trustAllServers only when testing. Calling this method with 'true' will remove any trustSource set with trustSource(TrustSource). Calling this method with 'false' has no effect unless trustAllServers was previously called with 'true'. To set a specific TrustSource, use trustSource(TrustSource).

Parameters:

trustAllServers - trustAllServers

Returns:

Builder

trustSource

public ImpersonatingMitmManager.Builder trustSource(TrustSource trustSource)

The TrustSource that supplies the trusted root CAs used to validate upstream servers' certificates.

Parameters:

trustSource - trustSource

Returns:

Builder

serverKeyGenerator

public ImpersonatingMitmManager.Builder serverKeyGenerator(KeyGenerator serverKeyGenerator)

The KeyGenerator that will be used to generate the server public and private keys.

Parameters:

serverKeyGenerator - serverKeyGenerator

Returns:

Builder

cacheConcurrencyLevel

public ImpersonatingMitmManager.Builder cacheConcurrencyLevel(int cacheConcurrencyLevel)

The concurrency level for the SSLContext cache. Increase this beyond the default value for high-volume proxy servers.

Parameters:

cacheConcurrencyLevel - cacheConcurrencyLevel

Returns:

Builder

cacheExpirationInterval

public ImpersonatingMitmManager.Builder cacheExpirationInterval(long cacheExpirationInterval,
                                                                java.util.concurrent.TimeUnit timeUnit)

The length of time SSLContexts with forged certificates will be kept in the cache.

Parameters:

cacheExpirationInterval - cacheExpirationInterval

timeUnit - timeUnit

Returns:

Builder

certificateInfoGenerator

public ImpersonatingMitmManager.Builder certificateInfoGenerator(CertificateInfoGenerator certificateInfoGenerator)

The CertificateInfoGenerator that will populate CertificateInfo objects containing certificate data for forced X509Certificates.

Parameters:

certificateInfoGenerator - certificateInfoGenerator

Returns:

Builder

serverCiphers

public ImpersonatingMitmManager.Builder serverCiphers(java.util.Collection<java.lang.String> serverCiphers)

The cipher suites allowed on connections to upstream servers. Cipher suite names should be specified in Java format, rather than OpenSSL format (e.g., TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384), even when using OpenSSL. Ciphers will be preferred in the order they are returned by the collection's iterator.

Parameters:

serverCiphers - serverCiphers

Returns:

Builder

clientCiphers

public ImpersonatingMitmManager.Builder clientCiphers(java.util.Collection<java.lang.String> clientCiphers)

The cipher suites allowed on client connections to the proxy. Cipher suite names should be specified in Java format, rather than OpenSSL format (e.g., TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384), even when using OpenSSL. Ciphers will be preferred in the order they are returned by the collection's iterator.

Parameters:

clientCiphers - clientCiphers

Returns:

Builder

certificateTool

public ImpersonatingMitmManager.Builder certificateTool(SecurityProviderTool securityProviderTool)

The SecurityProviderTool implementation that will be used to generate certificates.

Parameters:

securityProviderTool - securityProviderTool

Returns:

Builder

build

public ImpersonatingMitmManager build()