Java 中如何使用 SSL 连接 IoTDB

问题

Java 中如何使用 SSL 连接 IoTDB？

方案

SSL（Secure Sockets Layer）是一种安全协议，用于在网络通信中提供加密、认证和数据完整性保护。它主要用于在互联网上保护数据传输，确保数据在传输过程中不被窃听或篡改。

IoTDB 支持 SSL 协议，但是在配置文件中相关参数是默认关闭的状态，如下：

# Does dn_rpc_port enable SSL
# effectiveMode: restart
# Datatype: boolean
enable_thrift_ssl=false

# SSL key store path
# linux e.g. /home/iotdb/server.keystore (absolute path) or server.keystore (relative path)
# windows e.g. C:\\iotdb\\server.keystore (absolute path) or server.keystore (relative path)
# effectiveMode: restart
key_store_path=

# SSL key store password
# effectiveMode: restart
# Datatype: String
key_store_pwd=

因此，我们需要开启 SSL，并配置 key_store 相关参数（可使用 Java 提供的 keytool 工具生成 SSL 证书），然后重启 IoTDB 服务。

enable_thrift_ssl=true
key_store_path=/iotdb/ssl/.keystore   #keystore的完整路径
key_store_pwd=password  #keystore的密码

重启成功后，可以先通过 CLI 窗口验证一下 SSL 是否配置成功。进入到 sbin 目录下，通过 ./start-cli.sh 命令启动，此时需要注意，开启 SSL 后，需要在执行命令的时候添加相应的参数：

./start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root -usessl true -ts /iotdb/ssl/.truststore -tpw 123456
# -usessl             use_ssl statement 
# -ts             trust_store statement
# -tpw        trust_store_pwd statement

验证通过后，可以通过 IoTDB 提供的 Java 原生接口创建 SSL 连接。

Session 方式

• useSSL：是否开启 SSL
• trustStore：trustStore 的证书路径
• trustStorePwd：trustStore 的证书密码（秘钥库口令）

session = 
    new Session.Builder()
        .fetchSize(int fetchSize)
        .host(String host)
        .port(String port)
        .username(String username)
        .password(String password)
        .useSSL(true)
        .trustStore("/iotdb/ssl/.truststore")  
        .trustStorePwd("password")
        .build();

SessionPool 方式

• useSSL：是否开启 SSL
• trustStore：trustStore 的证书路径
• trustStorePwd：trustStore 的证书密码（秘钥库口令）

sessionPool =
     new SessionPool.Builder()
        .nodeUrls(List<String> nodeUrls)
        .user(String username)
        .password(String password)
        .useSSL(true)
        .trustStore("/iotdb/ssl/.truststore")  
        .trustStorePwd("password")
        .build();

备注

使用 keytool 工具生成 SSL 证书的简易步骤如下：

1. 生成密钥对：

keytool -genkeypair -alais mykey -keyalg RSA -validity 7 -keystore .keystore
# -alias：为你的密钥对指定一个别名，示例中为 mykey。
# -keyalg：指定密钥算法，示例中为 RSA。
# -validity：证书有效期，示例中为 7 天。
# -keystore：指定密钥库文件的名称，示例中为 .keystore。

2. 导出相应的证书：

keytool -export -alais mykey -keystore .keystore -rfc -file certificate.cer
# -alias：指定要从密钥库中导出的证书的别名，示例中为 mykey。
# -keystore：指定密钥库文件的位置和名称，示例中为当前目录下的 .keystore 文件。
# -rfc：指定导出证书的格式，示例中导出证书时使用 RFC 格式，这是一种更加通用的格式
# -file：指定导出的证书文件的名称，示例中导出的证书将被保存为当前目录下的 certificate.cer 文件。

3. 将该证书导入客户端信任库：

keytool -import -alais mykey -file certificate.cer -keystore .truststore
# -alias：指定导入证书的别名，示例中为 mykey。这个别名在信任库中必须是唯一的。
# -file：指定要导入的证书文件的路径和文件名，示例中为当前目录下的 certificate.cer 文件。
# -keystore：指定信任库文件的位置和名称，示例中为当前目录下的 .truststore 文件。