SSLParser (service-proxy-core 4.6.3 API)

java.lang.Object
- com.predic8.membrane.core.config.security.SSLParser

```
public class SSLParser
extends Object
```
Description

Configures inbound or outbound SSL connections.

Topic

6. Security

Constructor Summary

Constructors
Constructor and Description

SSLParser()

Constructors
Constructor and Description
`SSLParser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAlgorithm()`
`String`	`getCiphers()`
`String`	`getClientAuth()`
`String`	`getEndpointIdentificationAlgorithm()`
`Key`	`getKey()`
`KeyGenerator`	`getKeyGenerator()`
`KeyStore`	`getKeyStore()`
`String`	`getProtocol()`
`String`	`getProtocols()`
`String`	`getServerName()`
`Trust`	`getTrust()`
`TrustStore`	`getTrustStore()`
`boolean`	`isIgnoreTimestampCheckFailure()`
`boolean`	`isShowSSLExceptions()`
`void`	`setAlgorithm(String algorithm)`
`void`	`setCiphers(String ciphers)`
`void`	`setClientAuth(String clientAuth)`
`void`	`setEndpointIdentificationAlgorithm(String endpointIdentificationAlgorithm)`
`void`	`setIgnoreTimestampCheckFailure(boolean ignoreTimestampCheckFailure)`
`void`	`setKey(Key key)`
`void`	`setKeyGenerator(KeyGenerator keyGenerator)`
`void`	`setKeyStore(KeyStore keyStore)`
`void`	`setProtocol(String protocol)`
`void`	`setProtocols(String protocols)`
`void`	`setServerName(String serverName)`
`void`	`setShowSSLExceptions(boolean showSSLExceptions)`
`void`	`setTrust(Trust trust)`
`void`	`setTrustStore(TrustStore trustStore)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SSLParser
```
public SSLParser()
```
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getKeyStore
```
public KeyStore getKeyStore()
```
  - setKeyStore
```
public void setKeyStore(KeyStore keyStore)
```
  - getKey
```
public Key getKey()
```
  - setKey
```
public void setKey(Key key)
```
    Description
    
    Used to manually compose the keystore.
  - getKeyGenerator
```
public KeyGenerator getKeyGenerator()
```
  - setKeyGenerator
```
public void setKeyGenerator(KeyGenerator keyGenerator)
```
    Description
    
    Used to dynamically generate a key for the incoming connection on the fly.
  - getTrustStore
```
public TrustStore getTrustStore()
```
  - setTrustStore
```
public void setTrustStore(TrustStore trustStore)
```
  - getAlgorithm
```
public String getAlgorithm()
```
  - setAlgorithm
```
public void setAlgorithm(String algorithm)
```
    Default
    
    java default
    
    Description
    
    getDefaultAlgorithm()
    
    Example
    
    SunX509
  - getProtocol
```
public String getProtocol()
```
  - setProtocol
```
public void setProtocol(String protocol)
```
    Default
    
    TLS
    
    Description
    
    SSLContext.getInstance()
  - getProtocols
```
public String getProtocols()
```
  - setProtocols
```
public void setProtocols(String protocols)
```
    Default
    
    TLS*
    
    Description
    
    SSLSocket.setEnabledProtocols()
  - getCiphers
```
public String getCiphers()
```
  - setCiphers
```
public void setCiphers(String ciphers)
```
    Default
    
    all system default ciphers
    
    Description
    
    Space separated list of ciphers to allow. getSupportedCipherSuites()
    
    Example
    
    TLS_ECDH_anon_WITH_RC4_128_SHA
  - getClientAuth
```
public String getClientAuth()
```
  - setClientAuth
```
public void setClientAuth(String clientAuth)
```
    Default
    
    not set
    
    Description
    
    Either not set (=no), or want or need.
    
    Example
    
    need
  - isIgnoreTimestampCheckFailure
```
public boolean isIgnoreTimestampCheckFailure()
```
  - setIgnoreTimestampCheckFailure
```
public void setIgnoreTimestampCheckFailure(boolean ignoreTimestampCheckFailure)
```
  - getTrust
```
public Trust getTrust()
```
  - setTrust
```
public void setTrust(Trust trust)
```
    Description
    
    Used to manually compose the truststore.
  - getEndpointIdentificationAlgorithm
```
public String getEndpointIdentificationAlgorithm()
```
  - setEndpointIdentificationAlgorithm
```
public void setEndpointIdentificationAlgorithm(String endpointIdentificationAlgorithm)
```
    Default
    
    HTTPS
    
    Description
    
    See setEndpointIdentificationAlgorithm().
  - getServerName
```
public String getServerName()
```
  - setServerName
```
public void setServerName(String serverName)
```
    Default
    
    same as target hostname.
    
    Description
    
    Setting the serverName tells Java to use the SNI (http://www.rfc-base.org/txt/rfc-3546.txt) on outbound TLS connections to indicate to the TLS server, which hostname the client wants to connect to.
  - isShowSSLExceptions
```
public boolean isShowSSLExceptions()
```
  - setShowSSLExceptions
```
public void setShowSSLExceptions(boolean showSSLExceptions)
```
    Default
    
    true
    
    Description
    
    Tells Membrane to show SSL exceptions in its log

Class SSLParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SSLParser

Method Detail

equals

getKeyStore

setKeyStore

getKey

setKey

getKeyGenerator

setKeyGenerator

getTrustStore

setTrustStore

getAlgorithm

setAlgorithm

getProtocol

setProtocol

getProtocols

setProtocols

getCiphers

setCiphers

getClientAuth

setClientAuth

isIgnoreTimestampCheckFailure

setIgnoreTimestampCheckFailure

getTrust

setTrust

getEndpointIdentificationAlgorithm

setEndpointIdentificationAlgorithm

getServerName

setServerName

isShowSSLExceptions

setShowSSLExceptions