配置文件加密 - 敏捷诊断工具 V3.7.0

配置文件加密

更新时间：2025-10-02 20:49:06

编辑

obd 自 V3.6.0 起支持通过 obdiag tool crypto_config 命令对配置文件进行加密，本文将介绍具体使用。

功能介绍

该命令用于对 obdiag 的配置文件进行加密。可以在使用 obdiag 功能时，使用加密后的配置文件，配合 --config_password 选项使用。

对配置文件进行加密后，会在原路径下生成一个新文件（后文统称为：加密文件），文件后缀为 .encrypted。

命令介绍

可在命令后配置 -h 选项查看命令帮助：

obdiag tool crypto_config -h

输出如下：

Usage: obdiag tool crypto_config [options]

Options:
  --config_password=CONFIG_PASSWORD
                        config password
  --inner_config=INNER_CONFIG
                        change inner config.
  --key=KEY             the key to encrypt or decrypt
  --file=FILE           the file path to encrypt or decrypt
  --encrypted_file=ENCRYPTED_FILE
                        the file path to encrypt
  -h, --help            Show help and exit.
  -v, --verbose         Activate verbose output.

选项说明如下：

选项名	是否必选	数据类型	默认值	说明
--config_password	否	string	默认为空	obdiag 使用加密的配置文件时，需通过该选项传入对应的密码。
--key	否	string	`./rca`	加密或解密配置文件所需的密码。
--file	否	string	默认为空	需要加密的配置文件路径。
--encrypted_file	否	string	默认为空	加密文件的路径，解密配置文件或密码验证时需要配置该选项。
--inner_config	否	string	默认为空	obdiag 自用的配置。固定样式：`--inner_config key1=value1 --inner_config key2=value2`。说明支持通过该选项配置的参数可参见 obdiag 配置中系统配置文件（obdiag 自用的配置）部分。

使用示例

加密配置文件

方式一：指定密钥加密
```
obdiag tool crypto_config --file ~/.obdiag/config.yml --key=<your_secret_key>
```
此处仅为示例，实际使用时，您需根据实际文件路径进行配置，并将 <your_secret_key> 替换为实际的密钥。
方式二：交互式输入密钥
```
obdiag tool crypto_config --file ~/.obdiag/config.yml
# 系统会提示输入密码，手动输入密钥后回车
```
此处仅为示例，实际使用时，您需根据实际文件路径进行配置。

解密配置文件

解密配置文件时，解密成功的配置文件仅进行命令行打印，不会影响其他的文件，也不会保存。

obdiag tool crypto_config --encrypted_file=~/.obdiag/config.yml.encrypted --key=<your_secret_key>

此处仅为示例，实际使用时，您需根据实际文件路径进行配置，并将 <your_secret_key> 替换为实际的密钥。

验证密码是否正确

obdiag tool crypto_config --encrypted_file=~/.obdiag/config.yml.encrypted --key=<your_secret_key> --file=~/.obdiag/config.yml

此处仅为示例，实际使用时，您需根据实际文件路径进行配置，并将 <your_secret_key> 替换为实际的密钥。

使用加密的配置文件

此处以使用加密的配置文件进行全量巡检为例介绍如何使用：

obdiag check run -c ~/.obdiag/config.yml.encrypted --config_password=<your_secret_key>

此处仅为示例，实际使用时，您需根据实际文件路径进行配置，并将 <your_secret_key> 替换为实际的密钥。