# ssl_passphrase_command

> ssl_passphrase_command 定义用于获取 SSL 私钥口令的命令。
---

> [!NOTE]
> **Fact — 官方简述译文**：设置用于获取 SSL 私钥口令的命令。

## 身份 {#identity}

| 字段 | 值 | 含义 |
| --- | --- | --- |
| 类型 | `string` | 上游 pg_settings 类型 |
| Context | `sighup` | 配置 reload 后生效 |
| 单位 | — | 原始单位 |
| 范围 | — | 最后在档版本的原始上下限 |
| 枚举值 | — | 非枚举类型记为 — |
| 分类 | Connections and Authentication / SSL | 上游分类 |
| 最后 boot 值 | `""` | empty string |
{.fields meta="-"}

## 生命周期 {#lifecycle}

| Fact | 值 |
| --- | --- |
| 首次观测 | PG11 |
| 在档版本 | PG11–19 Beta 3 |
| 移除版本 | 否 |
| 引入提交 | [`8a3d9425290f`](https://git.postgresql.org/gitweb/?p=postgresql.git;a=commit;h=8a3d9425290ff5f6434990349886afae9e1c6008) — Add ssl_passphrase_command setting |
| 提交日期 | 2018-02-26 |
| Discussion | — |

## 默认值变迁 {#default-history}

| 版本 | 原始 `boot_val` | 单位 | 人类可读值 |
| --- | --- | --- | --- |
| PG11–19 Beta 3 | `""` | — | empty string |
{.full-width caption="PG9.0–19 Beta 3 实测 boot 默认值"}

## 机制详解 {#mechanism}

ssl_passphrase_command 是 PostgreSQL 需要解密加密私钥等 SSL 文件时调用的外部助手。助手必须把口令写到标准输出并以状态零退出；PostgreSQL 会去掉输出末尾的一个换行。

配置命令中的 %p 会替换为可能包含空白的提示字符串，因此必须安全引用；%% 输出字面百分号。命令以 PostgreSQL 服务账号运行，其环境、路径、参数、输出与错误日志都不得泄漏秘密。

它属于 SIGHUP 上下文，但重载时能否替换加密私钥还取决于 ssl_passphrase_command_supports_reload。非交互 keychain/文件助手可支持重载；TTY 提示通常只适合受控启动，Windows 另有重载要求。

## 调优建议 {#tuning-advice}

> [!TIP]
> **Advice。** 以下建议是工作负载起点，必须用真实测量验证。

| 场景 | 建议 |
| --- | --- |
| OLTP | 使用绝对路径、最小化、非交互助手，并由受保护 keychain 或文件描述符提供秘密。测试精确标准输出、退出状态、%p 引用、超时/失败、启动、重载和故障节点可用性，且不得记录口令。 |
| OLAP | 分析节点使用相同助手与秘密源；负载类型不会改变私钥信任要求。安排证书轮换前测试无人值守重启。 |
| 小规格 | 优先使用最简单且可审计、能无人值守重启的助手。若保留 TTY 提示，应记录：除非安全启用 supports_reload，否则重载无法替换加密私钥。 |
{.full-width}

## Pigsty 取值 {#pigsty}

以下值来自固定 8 核、32 GiB、100 GiB SSD 夹具，并按 PG19 Beta 3 渲染当前 Pigsty 模板；这不表示 Pigsty 当前支持该历史或测试版本。

| 模板 | 有效值 | 与上游 boot 比较 | 源表达式 |
| --- | --- | --- | --- |
| OLTP | 未修改 | — | — |
| OLAP | 未修改 | — | — |
| CRIT | 未修改 | — | — |
| TINY | 未修改 | — | — |
{.full-width}

> [!CAUTION]
> **Advice — 待人工复核。** 当前 Pigsty 模板投影事实：OLTP: PG11–19 Beta 3 未修改；OLAP: PG11–19 Beta 3 未修改；CRIT: PG11–19 Beta 3 未修改；TINY: PG11–19 Beta 3 未修改。 未发现覆盖值，因此不推断 Pigsty 专属理由。

## 常见坑 {#common-pitfalls}

- 在标准输出中写入口令以外内容，或返回非零状态。
- 没有引用 %p，而替换后的提示可能含空白；或忘记字面百分号需要写成 %%。
- 通过命令参数、进程列表、环境变量、shell 跟踪、标准错误或服务器日志泄漏口令。
- 部署只在一个主库交互运行成功，却在无人值守重启、重载或故障转移时失败的助手。

## 关联参数 {#related-parameters}

[`ssl`](/zh/parameters/ssl/) · [`ssl_cert_file`](/zh/parameters/ssl-cert-file/) · [`ssl_key_file`](/zh/parameters/ssl-key-file/) · [`ssl_ca_file`](/zh/parameters/ssl-ca-file/) · [`ssl_crl_file`](/zh/parameters/ssl-crl-file/) · [`ssl_min_protocol_version`](/zh/parameters/ssl-min-protocol-version/)

## 参考资料 {#references}

- [PostgreSQL 19 Beta 3 — ssl_passphrase_command](https://www.postgresql.org/docs/19/runtime-config-connection.html#GUC-SSL-PASSPHRASE-COMMAND)
- [PostgreSQL 19 发行说明](https://www.postgresql.org/docs/19/release-19.html)
- [机器可读 GUC 全量导出](/data/guc.jsonl)