mirror of
https://github.com/goldbergyoni/nodebestpractices.git
synced 2025-11-01 10:26:49 +08:00
Merge pull request #792 from MattJin/nodebestpractices_chinese
[Chinese]add avoid-build-time-secrets.chinese.md
This commit is contained in:
92
sections/docker/avoid-build-time-secrets.chinese.md
Normal file
92
sections/docker/avoid-build-time-secrets.chinese.md
Normal file
@ -0,0 +1,92 @@
|
|||||||
|
# 清理编译过程中的秘钥,避免使用秘钥作为参数
|
||||||
|
|
||||||
|
<br/><br/>
|
||||||
|
|
||||||
|
### 一段解释
|
||||||
|
|
||||||
|
Docker映像不仅仅是一堆文件,而是展示构建期间所发生的层级关系。在普通场景中,开发人员在构建过程中需要知道npm令牌(主要是对于私有registry)- 会通过把令牌作为构建参数来传递,但这种实现是错误的。这可能看起来是没什么问题,并且安全,但此令牌可以从开发人员机器中的Docker历史记录、Docker registry和CI中获得。获取到该令牌的攻击者就能够拥有写入此组织私有npm registry的权限。还有两个更安全的替代方法:完美无瑕的一个替代方案是使用Docker --secret功能(截至2020年7月还在实验阶段),它只允许在构建期间挂载(mount)文件。第二种方法是使用带args的多阶段(multi-stage)构建,然后只将必要的文件复制到生产环境。后一种技术将不会同时一起提供秘钥与镜像,但秘钥将出现在本地Docker的历史记录中 - 对大多数组织来说,这通常被认为足够安全。
|
||||||
|
|
||||||
|
<br/><br/>
|
||||||
|
|
||||||
|
### 代码示例 – 使用Docker挂载秘钥(实验功能但稳定)
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary><strong>Dockerfile</strong></summary>
|
||||||
|
|
||||||
|
```
|
||||||
|
# syntax = docker/dockerfile:1.0-experimental
|
||||||
|
|
||||||
|
FROM node:12-slim
|
||||||
|
WORKDIR /usr/src/app
|
||||||
|
COPY package.json package-lock.json ./
|
||||||
|
RUN --mount=type=secret,id=npm,target=/root/.npmrc npm ci
|
||||||
|
|
||||||
|
# 剩余部分
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<br/><br/>
|
||||||
|
|
||||||
|
### 代码示例 – 使用多阶段(multi-stage build)安全构建
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary><strong>Dockerfile</strong></summary>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
FROM node:12-slim AS build
|
||||||
|
ARG NPM_TOKEN
|
||||||
|
WORKDIR /usr/src/app
|
||||||
|
COPY . /dist
|
||||||
|
RUN echo "//registry.npmjs.org/:\_authToken=\$NPM_TOKEN" > .npmrc && \
|
||||||
|
npm ci --production && \
|
||||||
|
rm -f .npmrc
|
||||||
|
|
||||||
|
FROM build as prod
|
||||||
|
COPY --from=build /dist /dist
|
||||||
|
CMD ["node","index.js"]
|
||||||
|
|
||||||
|
# ARG和.npmrc在最终的镜像中不会出现,但会在Docker daemon的未打标签(un-tagged)镜像列表中找到它们 - 确保删除他们
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<br/><br/>
|
||||||
|
|
||||||
|
### 代码示例 反模式 - 使用构建参数
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary><strong>Dockerfile</strong></summary>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
FROM node:12-slim
|
||||||
|
ARG NPM_TOKEN
|
||||||
|
WORKDIR /usr/src/app
|
||||||
|
COPY . /dist
|
||||||
|
RUN echo "//registry.npmjs.org/:\_authToken=\$NPM_TOKEN" > .npmrc && \
|
||||||
|
npm ci --production && \
|
||||||
|
rm -f .npmrc
|
||||||
|
|
||||||
|
# 在拷贝命令的同时删除.npmrc文件不会在layer里面保存它, 但在镜像历史里面还是会找到它
|
||||||
|
|
||||||
|
CMD ["node","index.js"]
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<br/><br/>
|
||||||
|
|
||||||
|
### 博客引用: "秘钥不会保存在最终的Docker中"
|
||||||
|
|
||||||
|
摘自博客, [Alexandra Ulsh](https://www.alexandraulsh.com/2019/02/24/docker-build-secrets-and-npmrc/?fbclid=IwAR0EAr1nr4_QiGzlNQcQKkd9rem19an9atJRO_8-n7oOZXwprToFQ53Y0KQ)
|
||||||
|
|
||||||
|
> 在2018年11月,Docker18.09在docker构建过程中引入一个新的标志(flag)--secret。它允许用户通过一个文件传递秘钥到Docker包中(build)。这些秘钥不会保存在最终的Docker镜像,中间镜像和镜像提交历史里面。借助构建参数secret,您现在可以使用私有npm包安全地构建Docker映像,而无需构建参数和多阶段(multi-stage)构建。
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user