机密

你的操作对外调用所用的凭据保存在项目的保管库中。值以加密方式存储(详情见安全页面),通过引用来寻址,并且不出现在你的配置文件中。

标签与引用

机密有一个你选择的标签和一个所有者:项目、某个应用或你的某位用户。创建机密会返回一个不透明的引用,此后就通过该引用来寻址。你可以在控制台的“设置”下存储,也可以用 CLI 存储,或者提交一个 foir.secrets.ts 文件来存储,该文件只声明标签、不含明文,并由 foir secrets push 与项目协调一致。

值如何被读取

对于你托管的端点,随调用到达的分发令牌已经授予读取权限。处理程序携带引用和用途调用 getSecret,自身不持有任何凭据。用途是必填的,并会被记录。

对于 Fóir 自己发出的调用,请求模板通过占位符名称引用机密,操作上的绑定把该名称映射到引用。值在调用时解析,绝不存储在操作上。

谁可以持有访问权

机密的作用域可以由机密 API 密钥持有,公开密钥则永远不能。由你的某位用户触发的操作可以存储该用户拥有的机密,并且只有该用户的操作能读回它。

轮换与删除

轮换会替换现有引用背后的值。读取方在下一次读取时获得新值,无需重新部署任何东西。删除是软删除:机密立即停止解析,并可在 30 天内恢复。

了解详情

机密指南涵盖机密的存储、读取和轮换、用户拥有的机密,以及哪些内容会被审计。