项目管理与开发
开发团队的密钥管理|不把 API 密钥和密码写进代码的做法,以及泄露后的作废步骤
中级|白板 4 页·任务看板 5 列(4 个父任务、12 个子任务)
中级:会出现方法的名称,但要点已在白板上说明。以填写示例为线索,结合自己的情况思考并填写。
开发团队的全体成员一起定下并共享:API 密钥、数据库密码、证书私钥不写进代码、配置文件、聊天和工单的做法,以及泄露后作废旧值、换成新值的步骤。按每个密钥列出用在哪里、现在放在哪里、由谁负责,并为开发、测试、生产每个环境只定一个存放位置。从文件里删掉后旧提交里仍留着值、屏幕共享和错误日志会把值显示出来、个人电脑的配置文件里残留生产环境的值,这些容易泄露的陷阱会在第 2 张白板上逐一检查。已经提交的值要当作已泄露处理,基本做法是先在发行方作废,再考虑改写历史。密钥为什么会混进代码,用 5 Whys(连问五次为什么)挖出原因,再按泄露后的影响和更换难易程度排列,然后定下不写的规则、管理机制和提交前的把关。为了避免因担心更换后系统停摆而放着旧密钥不管,还会做一张写明如何确认哪里会停的更换计划表。另外,人记忆的登录密码不必定期更换,在泄露或不放心时再换。想在团队里定下 API 密钥的管理方式时,可以先打开所用外部服务的管理后台,从抄写密钥列表里的名称开始。白板共 4 张,依次是盘点、存放位置、原因、机制与步骤。任务看板有 5 列,包含与 4 张白板对应的 4 个父任务和 12 个子任务。
免费注册后,即可从模板市场复制并使用此模板
白板预览
以文字形式阅读白板内容
开发团队的密钥管理
使用方法(共 4 张):① 在第 1 张盘点密钥并写下散落处(白板①~⑤) → ② 在第 2 张定下各环境的存放位置并检查陷阱(白板⑥~⑨) → ③ 在第 3 张挖出混入代码的原因并定下防范机制(白板⑩~⑭) → ④ 在第 4 张做出泄露后的步骤和更换计划(白板⑮~⑰)
1/4 盘点密钥和密码
① 目的和范围(从这里开始写)
- 目的 例:让 API 密钥和密码从代码和聊天里消失,即使泄露也能在 30 分钟内止住
- 范围 例:支付、邮件发送、数据库这 3 项,以及 2 个仓库
- 期间和牵头人 例:2 周。开发负责人牵头,检查由全员分担
② 密钥清单(一行一个,不写值本身)
| 使用位置 | 现在放在哪 | 负责人 | 上次更换时间 | |
|---|---|---|---|---|
| 支付 API 密钥 | 例:生产环境的订单处理 | 例:服务器的环境变量 | 例:开发负责人 | 例:不明(没有记录) |
| 数据库密码 | 例:生产和测试的应用 | 例:直接写在配置文件里 | 例:基础设施负责人 | 例:一年以上前 |
| 证书私钥 | 例:生产环境的 Web 服务器 | 例:服务器里的文件 | 例:基础设施负责人 | 例:在上次到期前更新 |
| 邮件发送密钥 | 例:发送通知邮件 | 例:一直贴在聊天里 | 例:没有定 | 例:创建后一直没换过 |
③ 散落处:代码和配置文件
- 例:测试用的代码里直接写着 API 密钥
- 例:配置文件的样例里放着真实的值
- 按“文件名·什么值”写下找到的地方
④ 散落处:聊天和工单
- 例:操作步骤的工单里写着密码
- 例:在聊天里贴出值说“用这把密钥”
- 按“哪个位置·大约何时”写下找到的地方
⑤ 散落处:个人设备
- 例:下载后没处理的证书密钥文件还在桌面上
- 例:在备忘录应用里留着证书的密码
- 按“谁的设备·什么值”写下找到的地方
2/4 画出存放位置
⑥ 各环境的存放规则(把②的密钥迁到哪里)
| 开发 | 测试 | 生产 | |
|---|---|---|---|
| 存放位置 | 例:各人设备上的配置文件(只放开发用的值) | 例:密钥管理服务 | 例:密钥管理服务 |
| 谁能读取 | 例:开发成员全员 | 例:开发成员和测试负责人 | 例:2 名运维负责人和应用本身 |
| 怎么交付 | 例:每个人从管理服务里取出 | 例:部署时自动读取 | 例:运行时读取,不让人看到 |
| 不能写在哪 | 例:代码·聊天·工单 | 例:代码·聊天·工单 | 例:代码·聊天·工单·个人设备 |
⑦ 陷阱:提交过的值会留在历史里
- 会发生什么:例:从文件里删掉后旧提交里仍留着值,能看仓库的人都能读到
- 怎么确认:例:用仓库搜索和密钥检测功能的结果,确认②的密钥过去有没有被提交过
- 防范的一招:例:已提交的值按已泄露处理,先在发行方作废并更换,再考虑改写历史
- 检查结果:例:确认了 2 个仓库,发现 1 处→按⑮的步骤更换
⑧ 陷阱:会显示在屏幕和日志上
- 会发生什么:例:屏幕共享、截图、错误日志、调试输出里值会原样出现
- 怎么确认:例:在日志设置里确认密钥项是否被遮成星号,并对照设置界面和日志输出
- 防范的一招:例:加上输出日志前先遮蔽的设置,屏幕共享前先关掉配置文件
- 检查结果:例:错误日志里数据库的连接地址和密码一起显示了→加上遮蔽设置
⑨ 陷阱:放在个人设备上的配置文件
- 会发生什么:例:个人电脑的配置文件里残留生产环境的值,设备丢失或调岗之后仍可使用
- 怎么确认:例:问⑤写下的设备和②的负责人,开发用配置文件里有没有放生产环境的值,并在发行方的管理后台看密钥名称、备注和使用记录(能看到的项目因服务而异,以其说明为准)
- 防范的一招:例:个人设备上只放开发用的值,生产环境的值在运行时从管理服务读取
- 检查结果:例:2 个人的设备上有生产密钥→删除,并更换了该密钥
3/4 挖出混入的原因
⑩ 5 Whys 分析(从③~⑤和⑦~⑨中选 1 项,连问五次为什么会混进去)
- 为什么 1 例:配置文件里直接写了生产数据库的密码,是为什么?→想在本机马上跑起来
- 为什么 2 例:为了马上跑起来就直接写了,是为什么?→没定从哪里读取值
- 为什么 3 例:没有定下来,是为什么?→没有按环境区分存放位置
- 为什么 4 例:没有区分,是为什么?→刚开始是一个人开发,没觉得有问题
- 为什么 5 例:人多了也没有重新审视,是为什么?→没有人负责密钥的管理
- 根本原因 例:没有存放位置和交付方式的规则,也没有人当负责人
⑪ 把②的密钥按泄露后的影响 × 更换难易排列
纵轴:泄露后的影响(越靠上越大)/横轴:更换难易(越靠左越难,越靠右越容易)
- 影响大,难更换 先做出不停机的更换步骤 例:数据库密码(用到它的应用很多)
- 影响大,易更换 马上迁到管理服务并更换 例:支付 API 密钥(能在管理后台发行新密钥)
- 影响小,难更换 排好计划,依次迁移 例:旧内部工具的连接密码
- 影响小,易更换 下次更换时一起迁移 例:开发用的邮件发送密钥
⑫ 不写的规则
- 例:代码、聊天、工单里不写值,只写“放在哪里”
- 例:配置文件的样例里放假的值
- 写下规则的负责人和开始时间
⑬ 管理机制
- 例:定下一个密钥管理服务,把存放位置都集中到那里
- 例:按角色区分能读取的人,生产环境只限 2 人
- 写下机制的负责人和开始时间
⑭ 提交前的把关
- 例:在全员的设备上运行提交前检测密钥的机制
- 例:在代码评审的检查项里加上“有没有直接写值”
- 写下把关的负责人和开始时间
4/4 落实机制和步骤
⑮ 泄露后的五步(用⑪里判定影响大的密钥套一遍)
- 通知 发现的人马上告知 例:向团队定好的联系人写明什么东西出现在了哪里。不追究责任
- 作废 在发行方停用旧值 例:在支付服务的管理后台,让泄露的密钥失效
- 换成新值 发行新值并替换存放位置 例:把新密钥放进管理服务,让生产环境重新读取
- 确认痕迹 查看有没有被使用的痕迹 例:在发行方的使用记录和账单里,确认有没有自己不知道的使用记录
- 留下原因 记下为什么会泄露,并反映到机制里 例:用⑩挖原因,再补充⑫~⑭的规则
⑯ 更换计划表(从⑪的右上和左上依次做)
| 下次更换时间 | 确认哪里会停的方法 | 负责人 | |
|---|---|---|---|
| 支付 API 密钥 | 例:本月第 2 周 | 例:新旧 2 把密钥同时运行,确认订单能通过后再停旧的 | 例:开发负责人 |
| 数据库密码 | 例:下月第 1 周 | 例:在②里数出用到它的应用,先在测试环境更换,再换生产 | 例:基础设施负责人 |
| 证书私钥 | 例:到期前 1 个月 | 例:在②里数出用到证书的服务器,先在测试环境替换并确认能连上,再换生产 | 例:基础设施负责人 |
| 邮件发送密钥 | 例:本月内(一直贴在聊天里,所以提前) | 例:在测试环境确认通知邮件能收到 | 例:开发成员 1 人 |
⑰ 给新成员的说明(第一天就交给对方)
- 不写的地方和存放位置 例:值不写在代码、聊天、工单里,从⑥的存放位置读取
- 陷阱:怕更换后停摆而放着不管 会发生什么 例:旧密钥用了好几年,泄露了也发现不了 怎么确认 例:看⑯的负责人和时间有没有空着 防范的一招 例:先让新旧密钥同时运行,再停掉旧的
- 觉得可能泄露了的时候 例:不会追究责任,马上联系⑮第 1 步的联系人
任务看板内容
未开始 16 项
盘点密钥和密码
在第 1 张白板上写下目的和范围,列出密钥清单和散落的地方。清单做好后,第 2 张以后就能以它为依据决定存放位置和原因。按 Ctrl+F(Mac 为 ⌘F)输入“3/4”,可以跳到第 3 张。
抄下已发行的密钥
在所用外部服务(支付、邮件发送、云等)的管理后台打开 API 密钥列表页,把密钥的名称和用途抄到白板②的行里。约 15 分钟,写满 3 个以上名称即完成。不要写密钥的值本身。
写下目的和范围
在白板①写下目的、对象服务和仓库、期间和牵头人。3 张便签都写满即完成。
把散落处写进三个框
在白板③~⑤写下代码与配置文件、聊天与工单、个人设备中放着密钥的地方。每个框至少写出 1 个实例即完成。
画出存放位置
在第 2 张白板上,决定白板②的密钥在各环境放在哪里,并检查三个陷阱。存放位置定成一个后,第 3 张选择防范机制会更容易。
写下各环境的规则
在白板⑥的表里写下开发、测试、生产各自的存放位置、谁能读取、怎么交付、不能写在哪里。12 个格子写满即完成。
检查历史和日志
在白板⑦⑧确认旧提交里是否还留着值、屏幕和日志上是否显示出了值,把检查结果写在便签上。
检查设备上的配置
在白板⑨以⑤写下的设备为线索,询问负责人开发用配置文件里是否放了生产环境的值,并写下检查结果。发现生产环境的值,就按⑮的步骤更换该密钥。
挖出混入的原因
在第 3 张白板上,挖出密钥混进代码和聊天的原因,决定优先处理的密钥和防范机制。这里定下的机制,是第 4 张白板上步骤和计划的前提。
连问五次为什么
在白板⑩从③~⑤和⑦~⑨中选 1 项,连问五次为什么会混进去,在最后一格写下根本原因。
按影响和易换性排列
在白板⑪把②的密钥按泄露后的影响和更换难易分到四个象限。放在右上和左上的先着手处理。
定下防范机制
在白板⑫~⑭各定一条:不写的规则、管理机制、提交前的把关。写到负责人和开始时间即完成。
落实机制和步骤
在第 4 张白板上,做出泄露后作废并更换的步骤、更换计划和给新成员的说明。完成的步骤抄进团队文档,在任务看板的“待确认”列等待大家一起过一遍。
定下泄露后的五步
在白板⑮的 5 个步骤里写下通知谁、在哪里作废、确认什么。用⑪里判定影响大的 1 个密钥套一遍,没有犹豫的地方即完成。
排好更换计划
在白板⑯的表里写下每个密钥的下次更换时间、确认哪里会停的方法和负责人。每一行都填上时间即完成。
写给新成员
在白板⑰写下不写的地方和存放位置、不能放着不换的原因、觉得可能泄露时的联系方式。长度新成员第一天能读完即完成。