SSL

The Scala driver supports SSL connections to MongoDB servers using the underlying support for SSL provided by Netty. You can configure the driver to use SSL with MongoClientSettings by setting the sslEnabled property to true and the stream factory to NettyStreamFactoryFactory, as in:

import org.mongodb.scala.connection.{NettyStreamFactoryFactory, SslSettings}

MongoClientSettings.builder()
                   .sslSettings(SslSettings.builder()
                                           .enabled(true)
                                           .build())   
                   .streamFactoryFactory(NettyStreamFactoryFactory())
                   .build()

See Netty Configuration for details on configuring Netty.

Host name verification

By default, the driver ensures that the host name included in the server’s SSL certificate(s) matches the host name(s) provided when constructing a MongoClient. However, this host name verification requires a Java 7 JVM, as it relies on additions to the javax.net.SSLParameters class that were introduced in Java 7. If your application must run on Java 6, or for some other reason you need to disable host name verification, you must expicitly indicate this in SslSettings using the invalidHostNameAllowed property:

MongoClientSettings.builder()
                   .sslSettings(SslSettings.builder()
                                           .enabled(true)                 
                                           .invalidHostNameAllowed(true)  
                                           .build())                      
                   .streamFactoryFactory(NettyStreamFactoryFactory())
                   .build()

JVM system properties

A typical application will need to set several JVM system properties to ensure that the client is able to validate the SSL certificate presented by the server:

  • javax.net.ssl.trustStore: the path to a trust store containing the certificate of the signing authority
  • javax.net.ssl.trustStorePassword: the password to access this trust store

The trust store is typically created with the keytool command line program provided as part of the JDK. For example:

    keytool -importcert -trustcacerts -file <path to certificate authority file> 
        -keystore <path to trust store> -storepass <password>

A typical application will also need to set several JVM system properties to ensure that the client presents an SSL certificate to the MongoDB server:

  • javax.net.ssl.keyStore: the path to a key store containing the client’s SSL certificates
  • javax.net.ssl.keyStorePassword: the password to access this key store

The key store is typically created with the keytool or the openssl command line program.

For more information on configuring a Java application for SSL, please refer to the
JSSE Reference Guide.

JVM Support for TLS v1.1 and newer

Industry best practices recommend, and some regulations require, the use of TLS 1.1 or newer. Though no application changes are required for the driver to make use of the newest TLS protocols, Java runtime environments prior to Java 8 started to enable TLS 1.1 only in later updates:

  • Java 7

    • Starting with Update 131, released October 8, 2016, TSL 1.1 and TLS 1.2 are enabled by default.
    • Starting with Update 95, released January 19, 2016, TLS 1.1 and TLS 1.2 can be enabled by applications via the jdk.tls.client.protocols system property.

  • Java 6

    • Starting with Update 141, released on January 17, 2017, TSL 1.1 and TLS 1.2 are enabled by default.
    • Starting with Update 115 b32, released July 19, 2016, TLS 1.1 and TLS 1.2 can be enabled by applications via the jdk.tls.client.protocols system property.

Note that these updates are only available from Oracle via its Java SE commercial support program. Java 7 Update 131 is available via OpenJDK.

On this page