文档菜单
文档首页
/
语言
/
Scala
/
Scala
/
教程
/
连接到 MongoDB

TLS/SSL

在本页

  • MongoClient API
  • 在 ConnectionString 中指定 TLS/SSL
  • 在MongoClientSettings中指定TLS/SSL
  • 在MongoClientSettings中指定Java SE SSLContext
  • 禁用主机名验证
  • 常见的TLS/SSL配置任务
  • 配置受信任存储库和密钥存储库
  • 强制使用TLS v1.2
  • OCSP

默认情况下，驱动程序支持使用JDK提供的TLS/SSL底层支持，通过MongoDB服务器进行TLS/SSL连接。这可以通过利用Java SE API的扩展性来更改。Java SE API.

MongoClient API

您可以通过在ConnectionString或MongoClientSettings实例中指定选项来配置驱动程序以使用TLS/SSL。ConnectionString或MongoClientSettings实例中指定TLS/SSL

在ConnectionString中指定TLS/SSL

包含以下导入语句

import org.mongodb.scala._

要指定ConnectionString中的TLS/SSL，请将连接字符串中的ssl=true指定为部分

val mongoClient: MongoClient = MongoClient("mongodb://localhost/?ssl=true")

在MongoClientSettings中指定TLS/SSL

包含以下导入语句

import org.mongodb.scala._

要指定MongoClientSettings实例中的TLS/SSL，将enabled属性设置为true

val settings = MongoClientSettings.builder()
    .applyToSslSettings((builder: SslSettings.Builder) => builder.enabled(true))
    .build()
val client = MongoClient(settings)

在MongoClientSettings中指定Java SE SSLContext

包含以下导入语句

import javax.net.ssl.SSLContext

要指定与MongoClientSettings一起使用的javax.net.ssl.SSLContext，设置sslContext属性

val sslContext: SSLContext = ...
val settings = MongoClientSettings.builder()
    .applyToSslSettings((builder: SslSettings.Builder) => {
        builder.enabled(true)
        builder.context(sslContext)
    })
    .build()
val client = MongoClient(settings)

禁用主机名验证

默认情况下，驱动程序确保服务器SSL证书中包含的主机名与构建MongoClient时提供的主机名相匹配。

如果您的应用程序需要禁用主机名验证，您必须在MongoClientSettings中显式表示此操作

val settings = MongoClientSettings.builder()
    .applyToSslSettings((builder: SslSettings.Builder) => {
        builder.enabled(true)
        builder.invalidHostNameAllowed(true)
    })
    .build()

常见的TLS/SSL配置任务

本节基于Oracle JDK的文档编写，因此其中一些部分可能不适用于您的JDK或您使用的自定义TLS/SSL实现。

配置信任库和密钥库

您可以通过使用javax.net.ssl.SSLContext.init(KeyManager[] km, TrustManager[] tm, SecureRandom random)来配置针对客户端的特定信任库和密钥库，或者您可能需要设置JVM默认的信任库和密钥库。

设置默认信任库

典型应用程序需要设置几个JVM系统属性，以确保客户端可以验证服务器提供的TLS/SSL证书

  • javax.net.ssl.trustStore：包含签名机构证书的信任库路径

  • javax.net.ssl.trustStorePassword：访问此信任库的密码

信任库通常使用JDK提供的keytool命令行程序创建

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

设置默认密钥库

典型的应用程序还需要设置几个JVM系统属性，以确保客户端能够向MongoDB服务器展示 TLS/SSL客户端证书

  • javax.net.ssl.keyStore：包含客户端TLS/SSL证书的密钥库路径

  • javax.net.ssl.keyStorePassword：访问此密钥库的密码

密钥库通常使用keytool或openssl命令行程序创建。例如，如果您有一个包含客户端证书及其私钥的文件，并且您想在PKCS #12格式中创建密钥库，可以运行以下命令

openssl pkcs12 -export -in <path to client certificate & private key file>
             -out <path to key store> -passout pass:<trust store password>

要了解如何配置Java应用程序以使用TLS/SSL，请参阅JSSE参考指南。

强制使用TLS v1.2

某些应用程序可能只想强制使用TLS 1.2协议。为此，将jdk.tls.client.protocols系统属性设置为TLSv1.2。

Java运行时环境在Java 8之前才在后续更新中开始启用TLS 1.2协议，如前文所述。为了在Java 8之前的Java运行时环境中强制使用TLS 1.2协议，请确保更新已启用TLS 1.2。

OCSP

注意

默认情况下，驱动程序不能在单个MongoClient的基础上启用OCSP。

客户端驱动OCSP

应用程序需要设置以下JVM系统和安全属性，以确保启用客户端驱动的OCSP：

  • com.sun.net.ssl.checkRevocation：当设置为true时，此系统属性启用撤销检查

  • ocsp.enable：当设置为true时，此安全属性启用客户端驱动的OCSP

要将应用程序配置为使用客户端驱动的OCSP，该应用程序必须已经设置为使用TLS连接到服务器。设置这些系统属性是启用客户端驱动的OCSP所必需的。

注意

JDK提供的TLS支持在OCSP响应器不可用的情况下使用“硬失败”行为，这与使用“软失败”行为的mongosh和驱动程序不同。

OCSP Stapling

重要

当使用TLS 1.3协议（Java 11及以上版本默认使用TLS 1.3）的Java运行时环境时，使用OCSP Stapling可能会出现以下异常

javax.net.ssl.SSLHandshakeException: extension (5) should not be presented in certificate_request

该异常是由于Java 11及更高版本中TLS 1.3的一个已知问题。为了避免在使用基于TLS 1.3协议的Java运行时环境时出现此异常，您可以强制应用程序使用TLS 1.2协议。为此，将系统属性jdk.tls.client.protocols设置为TLSv1.2。

要设置OCSP Stapling，应用程序需要设置几个JVM系统属性

  • jdk.tls.client.enableStatusRequestExtension：当设置为true（其默认值）时，此属性启用OCSP Stapling。

  • com.sun.net.ssl.checkRevocation：当设置为true时，此属性启用吊销检查。如果此属性未设置为true，则无论吊销信息的出现或状态如何，都将允许连接继续。

要配置应用程序使用OCSP Stapling，应用程序必须已经设置为使用TLS连接到服务器，并且服务器必须配置为将其返回的证书的OCSP响应 staple 到TLS握手过程中。

要了解有关配置Java应用程序使用OCSP的更多信息，请参阅Java文档中的客户端驱动的OCSP和OCSP Stapling。

返回

连接到 MongoDB

下一步

身份验证