java.lang.Object
- io.restassured.config.SSLConfig

All Implemented Interfaces:: Config

public class SSLConfig
extends Object
implements Config

Configure SSL for REST Assured.

The following documentation is taken from https://github.com/jgritman/httpbuilder/wiki/SSL:

SSL Configuration

SSL should, for the most part, "just work." There are a few situations where it is not completely intuitive. You can follow the example below, or see HttpClient's SSLSocketFactory documentation for more information.

SSLPeerUnverifiedException

If you can't connect to an SSL website, it is likely because the certificate chain is not trusted. This is an Apache HttpClient issue, but explained here for convenience. To correct the untrusted certificate, you need to import a certificate into an SSL truststore.

First, export a certificate from the website using your browser. For example, if you go to https://dev.java.net in Firefox, you will probably get a warning in your browser. Choose "Add Exception," "Get Certificate," "View," "Details tab." Choose a certificate in the chain and export it as a PEM file. You can view the details of the exported certificate like so:

 $ keytool -printcert -file EquifaxSecureGlobaleBusinessCA-1.crt
 Owner: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Issuer: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Serial number: 1
 Valid from: Mon Jun 21 00:00:00 EDT 1999 until: Sun Jun 21 00:00:00 EDT 2020
 Certificate fingerprints:
 MD5:  8F:5D:77:06:27:C4:98:3C:5B:93:78:E7:D7:7D:9B:CC
 SHA1: 7E:78:4A:10:1C:82:65:CC:2D:E1:F1:6D:47:B4:40:CA:D9:0A:19:45
 Signature algorithm name: MD5withRSA
 Version: 3
 ....

Now, import that into a Java keystore file:

 $ keytool -importcert -alias "equifax-ca" -file EquifaxSecureGlobaleBusinessCA-1.crt -keystore truststore_javanet.jks -storepass test1234
 Owner: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Issuer: CN=Equifax Secure Global eBusiness CA-1, O=Equifax Secure Inc., C=US
 Serial number: 1
 Valid from: Mon Jun 21 00:00:00 EDT 1999 until: Sun Jun 21 00:00:00 EDT 2020
 Certificate fingerprints:
 MD5:  8F:5D:77:06:27:C4:98:3C:5B:93:78:E7:D7:7D:9B:CC
 SHA1: 7E:78:4A:10:1C:82:65:CC:2D:E1:F1:6D:47:B4:40:CA:D9:0A:19:45
 Signature algorithm name: MD5withRSA
 Version: 3
 ...
 Trust this certificate? [no]:  yes
 Certificate was added to keystore

Now you want to use this truststore in your client:

 RestAssured.config = RestAssured.newConfig().sslConfig(new SSLConfig("/truststore_javanet.jks", "test1234");

 given().config(newConfig().sslConfig(new SSLConfig("/truststore_javanet.jks", "test1234")). ..

Constructor Summary

Constructors
Constructor and Description
`SSLConfig()` Creates a new SSL Config instance with the following settings: No keystore No truststore No password `KeyStore.getDefaultType()` No explicit default port No trust store No SSLSocketFactory `SSLSocketFactory.STRICT_HOSTNAME_VERIFIER` as `X509HostnameVerifier` implementation

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SSLConfig`	`allowAllHostnames()` Configure the SSLConfig to allow all host names.
`SSLConfig`	`and()` Syntactic sugar.
`KeyStore`	`getKeyStore()`
`String`	`getKeyStorePassword()`
`String`	`getKeyStoreType()`
`Object`	`getPathToKeyStore()`
`Object`	`getPathToTrustStore()`
`int`	`getPort()`
`org.apache.http.conn.ssl.SSLSocketFactory`	`getSSLSocketFactory()`
`KeyStore`	`getTrustStore()`
`String`	`getTrustStorePassword()`
`String`	`getTrustStoreType()`
`org.apache.http.conn.ssl.X509HostnameVerifier`	`getX509HostnameVerifier()`
`boolean`	`isUserConfigured()`
`SSLConfig`	`keyStore(File pathToJks, String password)` Use a keystore located on the file-system.
`SSLConfig`	`keyStore(String password)` Uses the user default keystore stored in <user.home>/.keystore
`SSLConfig`	`keyStore(String pathToJks, String password)`
`SSLConfig`	`keystoreType(String keystoreType)` The certificate type, will use `KeyStore.getDefaultType()` by default.
`SSLConfig`	`port(int port)` The port for which REST Assured will apply the SSL configuration.
`SSLConfig`	`relaxedHTTPSValidation()` Use relaxed HTTP validation.
`SSLConfig`	`relaxedHTTPSValidation(String protocol)` Use relaxed HTTP validation.
`static SSLConfig`	`sslConfig()`
`SSLConfig`	`sslSocketFactory(org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory)` Specify a `SSLSocketFactory`.
`SSLConfig`	`strictHostnames()` Configure the SSLConfig to use strict host name verification (this is the default behavior).
`SSLConfig`	`trustStore(File pathToTrustStore, String password)` Use a trustStore located on the file-system.
`SSLConfig`	`trustStore(KeyStore trustStore)` A trust store to use during SSL/Certificate authentication.
`SSLConfig`	`trustStore(String pathToTrustStore, String password)`
`SSLConfig`	`trustStoreType(String trustStoreType)` The trust store type, will use `KeyStore.getDefaultType()` by default.
`SSLConfig`	`using()` Syntactic sugar.
`SSLConfig`	`with()` Syntactic sugar.
`SSLConfig`	`x509HostnameVerifier(org.apache.http.conn.ssl.X509HostnameVerifier x509HostnameVerifier)` Provide a custom `X509HostnameVerifier` implementation that'll be used by the `SSLSocketFactory`.

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

- Constructor Detail
  - SSLConfig
```
public SSLConfig()
```
    Creates a new SSL Config instance with the following settings:
    - No keystore
    - No truststore
    - No password
    - KeyStore.getDefaultType()
    - No explicit default port
    - No trust store
    - No SSLSocketFactory
    - SSLSocketFactory.STRICT_HOSTNAME_VERIFIER as X509HostnameVerifier implementation
- Method Detail
  - keyStore
```
public SSLConfig keyStore(String pathToJks,
                          String password)
```
    Parameters:
    
    pathToJks - The path to the JKS. REST Assured will first look in the classpath and if not found it will look for the JKS in the local file-system
    
    password - The store pass
    
    Returns:
    
    A new SSLConfig instance
  - keyStore
```
public SSLConfig keyStore(File pathToJks,
                          String password)
```
    Use a keystore located on the file-system. See keyStore(String, String) for more details.
    
    Parameters:
    
    pathToJks - The path to JKS file on the file-system
    
    password - The password for the keystore
    
    Returns:
    
    The request specification
    
    See Also:
    
    keyStore(String, String)
  - keyStore
```
public SSLConfig keyStore(String password)
```
    Uses the user default keystore stored in <user.home>/.keystore
    
    Parameters:
    
    password - - Use null for no password
    
    Returns:
    
    The keystore specification
  - trustStore
```
public SSLConfig trustStore(String pathToTrustStore,
                            String password)
```
    Parameters:
    
    pathToTrustStore - The path to the trust store. REST Assured will first look in the classpath and if not found it will look for the JKS in the local file-system
    
    password - The store pass
    
    Returns:
    
    A new SSLConfig instance
  - trustStore
```
public SSLConfig trustStore(File pathToTrustStore,
                            String password)
```
    Use a trustStore located on the file-system. See trustStore(String, String) for more details.
    
    Parameters:
    
    pathToTrustStore - The path to trust store file on the file-system
    
    password - The password for the trustStore
    
    Returns:
    
    The request specification
    
    See Also:
    
    trustStore(String, String)
  - keystoreType
```
public SSLConfig keystoreType(String keystoreType)
```
    The certificate type, will use KeyStore.getDefaultType() by default.
    
    Parameters:
    
    keystoreType - The keystore type.
    
    Returns:
    
    A new SSLConfig instance
  - trustStoreType
```
public SSLConfig trustStoreType(String trustStoreType)
```
    The trust store type, will use KeyStore.getDefaultType() by default.
    
    Parameters:
    
    trustStoreType - The trust store type.
    
    Returns:
    
    A new SSLConfig instance
  - port
```
public SSLConfig port(int port)
```
    The port for which REST Assured will apply the SSL configuration. This is advanced configuration and most of the time you do not need to specify a port since REST Assured will apply the configuration to the https port defined in the URI.
    
    Parameters:
    
    port - port.
    
    Returns:
    
    A new SSLConfig instance
  - trustStore
```
public SSLConfig trustStore(KeyStore trustStore)
```
    A trust store to use during SSL/Certificate authentication.
    
    Parameters:
    
    trustStore - The trust store to use.
    
    Returns:
    
    A new SSLConfig instance
  - relaxedHTTPSValidation
```
public SSLConfig relaxedHTTPSValidation()
```
    Use relaxed HTTP validation. This means that you'll trust all hosts regardless if the SSL certificate is invalid. By using this method you don't need to specify a keystore (see keyStore(String, String) or trust store (see trustStore(java.security.KeyStore). This method assumes that the protocol for the SSLContext instance is . If this is not the case use relaxedHTTPSValidation(String).
    
    Returns:
    
    A new SSLConfig instance.
  - relaxedHTTPSValidation
```
public SSLConfig relaxedHTTPSValidation(String protocol)
```
    Use relaxed HTTP validation. This means that you'll trust all hosts regardless if the SSL certificate is invalid. By using this method you don't need to specify a keystore (see keyStore(String, String) or trust store (see trustStore(java.security.KeyStore).
    
    Parameters:
    
    protocol - The standard name of the requested protocol. See the SSLContext section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard protocol names.
    
    Returns:
    
    A new SSLConfig instance
  - sslSocketFactory
```
public SSLConfig sslSocketFactory(org.apache.http.conn.ssl.SSLSocketFactory sslSocketFactory)
```
    Specify a SSLSocketFactory. This will override settings from trust store as well as keystore and password.
    
    Parameters:
    
    sslSocketFactory - The SSLSocketFactory to use.
    
    Returns:
    
    A new SSLConfig instance
  - x509HostnameVerifier
```
public SSLConfig x509HostnameVerifier(org.apache.http.conn.ssl.X509HostnameVerifier x509HostnameVerifier)
```
    Provide a custom X509HostnameVerifier implementation that'll be used by the SSLSocketFactory. You can replace the X509HostnameVerifier for example if you want to allow all host names etc.
    
    Parameters:
    
    x509HostnameVerifier - The X509HostnameVerifier to use.
    
    Returns:
    
    A new SSLConfig instance
    
    See Also:
    
    allowAllHostnames(), strictHostnames()
  - strictHostnames
```
public SSLConfig strictHostnames()
```
    Configure the SSLConfig to use strict host name verification (this is the default behavior).
    
    Returns:
    
    A new SSLConfig instance
    
    See Also:
    
    SSLSocketFactory.STRICT_HOSTNAME_VERIFIER
  - allowAllHostnames
```
public SSLConfig allowAllHostnames()
```
    Configure the SSLConfig to allow all host names.
    
    Returns:
    
    A new SSLConfig instance
    
    See Also:
    
    SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER
  - sslConfig
```
public static SSLConfig sslConfig()
```
    Returns:
    
    A static way to create a new SSLConfig instance without calling "new" explicitly. Mainly for syntactic sugar.
  - and
```
public SSLConfig and()
```
    Syntactic sugar.
    
    Returns:
    
    The same SSL config instance.
  - with
```
public SSLConfig with()
```
    Syntactic sugar.
    
    Returns:
    
    The same SSL config instance.
  - using
```
public SSLConfig using()
```
    Syntactic sugar.
    
    Returns:
    
    The same SSL config instance.
  - getPathToKeyStore
```
public Object getPathToKeyStore()
```
    Returns:
    
    The path or file to the JKS
  - getPathToTrustStore
```
public Object getPathToTrustStore()
```
    Returns:
    
    The path or file to the trust store
  - getKeyStorePassword
```
public String getKeyStorePassword()
```
    Returns:
    
    The password to the JKS
  - getTrustStorePassword
```
public String getTrustStorePassword()
```
    Returns:
    
    The password to the trust store
  - getKeyStoreType
```
public String getKeyStoreType()
```
    Returns:
    
    The keystore type
  - getTrustStoreType
```
public String getTrustStoreType()
```
    Returns:
    
    The trust store type
  - getPort
```
public int getPort()
```
    Returns:
    
    The port
  - getTrustStore
```
public KeyStore getTrustStore()
```
    Returns:
    
    The trust store
  - getKeyStore
```
public KeyStore getKeyStore()
```
    Returns:
    
    The key store
  - getSSLSocketFactory
```
public org.apache.http.conn.ssl.SSLSocketFactory getSSLSocketFactory()
```
    Returns:
    
    The configured SSLSocketFactory
  - getX509HostnameVerifier
```
public org.apache.http.conn.ssl.X509HostnameVerifier getX509HostnameVerifier()
```
    Returns:
    
    The X509HostnameVerifier instance.
  - isUserConfigured
```
public boolean isUserConfigured()
```
    Specified by:
    
    isUserConfigured in interface Config
    
    Returns:
    
    true if user has configured this SSL Configuration instance, false otherwise.

Class SSLConfig

SSL Configuration

SSLPeerUnverifiedException

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SSLConfig

Method Detail

keyStore

keyStore

keyStore

trustStore

trustStore

keystoreType

trustStoreType

port

trustStore

relaxedHTTPSValidation

relaxedHTTPSValidation

sslSocketFactory

x509HostnameVerifier

strictHostnames

allowAllHostnames

sslConfig

and

with

using

getPathToKeyStore

getPathToTrustStore

getKeyStorePassword

getTrustStorePassword

getKeyStoreType

getTrustStoreType

getPort

getTrustStore

getKeyStore

getSSLSocketFactory

getX509HostnameVerifier

isUserConfigured