chezmoi 模板函数passRaw详解读取 pass 密码库的完整原始内容【免费下载链接】chezmoiManage your dotfiles across multiple diverse machines, securely.项目地址: https://gitcode.com/gh_mirrors/ch/chezmoi导读passRaw是 chezmoi 内置的一组 pass 模板函数之一用于在生成点文件模板时读取 passUnix 密码管理器中存储的密码条目。与仅返回首行的pass函数不同passRaw将pass show的全部输出原样返回适合读取多行结构的密码条目如包含备注、多字段信息的完整记录。读完本文你将掌握passRaw的调用语法、与pass/passFields的差异、底层缓存机制以及如何通过pass.command配置接入 passage 等 pass 兼容工具。函数签名与核心语义passRaw的模板调用形式为{{ passRaw pass-name }}根据 passRaw 参考文档 的定义passRaw使用 pass 命令行工具pass返回存储在 pass 中的密码模板参数pass-name会被原样拼接到pass show $PASS_NAME命令中执行pass命令的完整输出被直接返回——不做首行截断、不做字段解析输出结果会被缓存同一pass-name多次调用passRaw时pass进程只会在第一次真正执行。这与 chezmoi 中另外两个 pass 函数形成互补模板函数返回内容适用场景passpass show输出的第一行去掉末尾换行符常规密码单行口令passFields按行解析key: value冒号分隔结构返回键值映射结构化元数据登录名、URL 等passRawpass show的完整原始输出多行备注、证书、密钥块等完整条目三者共享同一底层调用与缓存但输出处理策略各不相同详见下文源码分析。与pass/passFields的行为差异pass函数会截取pass show输出的第一行并去除行尾空白。例如对如下 pass 条目examplepassword login: examplelogin{{ pass misc/example.com }}返回examplepassword{{ (passFields misc/example.com).login }}返回examplelogin{{ passRaw misc/example.com }}返回完整两行文本examplepassword login: examplelogin因此当你的密码条目只有单行口令时pass与passRaw结果等价但当条目包含多行附加信息TOTP 密钥、SSH 私钥、多字段记录等需要完整内容时就必须使用passRaw。相关函数的行为说明分别见 pass 参考文档 与 passFields 参考文档。源码级实现原理passRaw的实际实现位于 internal/cmd/passtemplatefuncs.go核心逻辑如下func (c *Config) passRawTemplateFunc(id string) string { chezmoi.SkipTemplateIf(c.skipSecrets) return string(mustValue(c.passOutput(id))) }从源码结构可以归纳出以下几点实现事实跳过标记函数首先调用chezmoi.SkipTemplateIf(c.skipSecrets)。当用户设置了跳过机密secrets的相关配置时模板渲染会被提前中断避免在不应读取机密的场景下触发pass外部调用。完整输出passRaw直接返回passOutput的字节内容并转换为字符串不做任何首行截断或字段解析——这正是它与passbytes.Cut(output, []byte{\n})截首行、passFields按:切分键值在源码层面的本质区别。命令拼接底层passOutput通过exec.Command(c.Pass.Command, show, id)构造命令等效于 shell 中的pass show $PASS_NAME同时将标准输入与标准错误透传给终端确保 GPG 解密时的交互提示如 PIN 输入能够正常进行。错误处理命令执行失败时passOutput返回newCmdOutputError包装的错误mustValue会将其转换为模板渲染错误最终导致chezmoi execute-template等命令以非零状态退出。缓存机制一次调用多次复用passOutput实现了按条目 ID 的进程级缓存func (c *Config) passOutput(id string) ([]byte, error) { if output, ok : c.Pass.cache[id]; ok { return output, nil } // ... 执行 pass show $ID ... c.Pass.cache[id] output return output, nil }passConfig结构体同文件包含Command string与cache map[string][]byte两个字段缓存以pass-name为键。这意味着在一次chezmoi apply、chezmoi execute-template等命令的运行过程中如果多个模板文件引用了同一个 pass 条目pass进程只会真正执行一次其余调用直接命中缓存——既节省了外部进程开销也减少了 GPG 解密次数。配置 pass 命令与兼容工具passRaw及其他 pass* 函数默认调用二进制名为pass的命令。从 internal/cmd/config.go 可以看到默认配置Pass: passConfig{ Command: pass, },该配置可在 chezmoi 配置文件中通过pass.command覆盖。一个典型场景是接入 pass 的兼容实现 passage 中给出了 TOML 示例[pass] command passage设置后passRaw、pass、passFields三个函数都会透明地改用passage二进制模板代码无需任何改动。命令格式同样支持其他配置格式如 JSON/YAML字段名均为pass.command。实战用法示例读取完整多行条目# 假设 pass 条目 misc/example.com 内容为 # examplepassword # login: examplelogin {{ passRaw misc/example.com }}渲染结果为examplepassword login: examplelogin结合字符串处理提取子内容由于返回的是完整文本你可以继续用 sprig 等模板函数做二次处理例如只取第一行{{ (passRaw misc/example.com | splitList \n | first) }}在点文件模板中的典型用法以管理包含完整私钥内容的文件为例passRaw可以直接作为文件内容注入# ~/.local/share/chezmoi/private_dot_ssh/private_id_ed25519.tmpl {{ passRaw ssh/ed25519 }}测试验证仓库中的 pass.txtar 集成测试 使用 mock 的pass二进制验证了三个函数的完整行为exec chezmoi execute-template {{ pass misc/example.com }} stdout ^examplepassword$ exec chezmoi execute-template {{ (passFields misc/example.com).login }} stdout ^examplelogin$ exec chezmoi execute-template {{ passRaw misc/example.com }} cmp stdout golden/pass-raw其中 mockpass对show misc/example.com返回如下内容而 golden 文件golden/pass-raw中保存的正是完整输出两行均包含examplepassword login: examplelogin这从测试角度印证了本文的关键结论pass只取首行、passFields解析键值、passRaw原样返回全部输出。该测试同时验证了缓存逻辑——三次调用同一条目mock 的pass只被触发一次。小结passRaw返回pass show name的完整原始输出适合多行结构的密码条目同一进程内对同一条目的多次调用只执行一次pass缓存机制默认使用pass二进制可通过pass.command切换为 passage 等兼容工具与pass首行、passFields键值映射共同构成 chezmoi 的 pass 模板函数族可在 用户指南 与 pass-functions 参考目录 中查看更多资料。【免费下载链接】chezmoiManage your dotfiles across multiple diverse machines, securely.项目地址: https://gitcode.com/gh_mirrors/ch/chezmoi创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考