跳到主要内容

MongoDB TLS 连接配置

本文介绍如何配置 HAP 信任 MongoDB 服务端的 CA 证书,并通过 TLS 建立加密连接。

目前,HAP 支持 MongoDB 单向 TLS 认证,暂不支持 mTLS(双向 TLS 认证)。

配置前,请确保 MongoDB 已启用 TLS。

准备证书​

准备签发 MongoDB 服务端证书的 CA 证书,使用 PEM 格式:

文件说明
custom-ca.crt用于验证 MongoDB 服务端证书的 CA 证书

多个 CA 证书可依次放入同一个 custom-ca.crt 文件。

  • 证书文件中只放 CA 公钥证书,不要包含私钥;包含私钥的文件会被整体拒绝导入。
  • MongoDB 连接地址须与服务端证书中的域名或 IP 地址匹配。

挂载证书​

自 HAP v7.4.0 起,支持导入自定义 CA 证书。

将 CA 证书挂载到容器内,容器启动时会自动导入。

  1. 在 HAP 服务器上,将 CA 证书放入 /data/mingdao/script/volume/cafile/custom-ca.crt 文件。

  2. 检查 /data/mingdao/script/docker-compose.yaml 中 app 服务的 volumes 配置,将证书挂载到容器内。例如:

    services:
    app:
    volumes:
    - ./volume/cafile/custom-ca.crt:/Housekeeper/cafile/custom-ca.crt:ro

如果已有对应的挂载配置,无需重复添加。

配置连接​

根据部署方式,修改对应的配置文件:

在 /data/mingdao/script/docker-compose.yaml 的 app 服务下配置。

在 ENV_MONGODB_OPTIONS 中增加 tls=true,保留已有参数,并根据实际情况修改 MongoDB 地址、端口和账号信息:

ENV_MONGODB_URI: 'mongodb://hap:YOUR_PASSWORD@192.0.2.10:27017,192.0.2.11:27017,192.0.2.12:27017'
ENV_MONGODB_OPTIONS: '?tls=true'

ENV_MONGODB_OPTIONS 以 ? 开头,多个参数以 & 分隔。

配置完成后,单机模式在安装管理器所在目录执行以下命令,重新创建 app 容器以应用 Compose 配置:

docker compose -f docker-compose.yaml up -d --no-deps --force-recreate app

然后重启 HAP 微服务。集群模式应用配置后,重启 HAP 微服务使配置生效。