内容信任的委托
Docker内容信任(DCT)中的委托允许您控制谁可以签名和不可以签名镜像标签。委托将有一对私有和公共委托密钥。委托可以包含多对密钥和贡献者,以便a) 允许多个用户成为委托的一部分,以及b) 支持密钥轮换。
Docker内容信任中最重要的委托是targets/releases
。这被视为可信镜像标签的规范来源,如果没有贡献者的密钥在此委托下,他们将无法签名标签。
幸运的是,当使用$ docker trust
命令时,我们将自动初始化仓库、管理仓库密钥,并通过docker trust signer add
将协作者的密钥添加到targets/releases
委托中。
配置Docker客户端
默认情况下,$ docker trust
命令期望Notary服务器URL与镜像标签中指定的注册表URL相同(遵循与$ docker push
类似的逻辑)。当使用Docker Hub或DTR时,Notary服务器URL与注册表URL相同。但是,对于自托管环境或第三方注册表,您需要为Notary服务器指定替代URL。这是通过以下方式完成的
$ export DOCKER_CONTENT_TRUST_SERVER=https://<URL>:<PORT>
如果您没有在自托管环境中导出此变量,您可能会看到诸如以下错误
$ docker trust signer add --key cert.pem jeff registry.example.com/admin/demo
Adding signer "jeff" to registry.example.com/admin/demo...
<...>
Error: trust data missing for remote repository registry.example.com/admin/demo or remote repository not found: timestamp key trust data unavailable. Has a notary repository been initialized?
$ docker trust inspect registry.example.com/admin/demo --pretty
WARN[0000] Error while downloading remote metadata, using cached timestamp - this might not be the latest version available remotely
<...>
如果您已为Notary服务器启用身份验证,或正在使用DTR,则需要在将数据推送到Notary服务器之前登录。
$ docker login registry.example.com/user/repo
Username: admin
Password:
Login Succeeded
$ docker trust signer add --key cert.pem jeff registry.example.com/user/repo
Adding signer "jeff" to registry.example.com/user/repo...
Initializing signed repository for registry.example.com/user/repo...
Successfully initialized "registry.example.com/user/repo"
Successfully added signer: jeff to registry.example.com/user/repo
如果您没有登录,您将看到
$ docker trust signer add --key cert.pem jeff registry.example.com/user/repo
Adding signer "jeff" to registry.example.com/user/repo...
Initializing signed repository for registry.example.com/user/repo...
you are not authorized to perform this operation: server returned 401.
Failed to add signer to: registry.example.com/user/repo
配置Notary客户端
DCT的一些更高级的功能需要Notary CLI。要安装和配置Notary CLI
下载客户端 并确保它在您的路径上可用。
在
~/.notary/config.json
处创建一个配置文件,内容如下:
{
"trust_dir" : "~/.docker/trust",
"remote_server": {
"url": "https://registry.example.com",
"root_ca": "../.docker/ca.pem"
}
}
新创建的配置文件包含有关本地Docker信任数据位置和Notary服务器URL的信息。
有关如何在Docker内容信任用例之外使用Notary的更多详细信息,请参阅Notary CLI文档此处。
创建委托密钥
添加您的第一个贡献者的前提条件是一对委托密钥。这些密钥可以使用$ docker trust
本地生成,也可以由证书颁发机构生成。
使用Docker Trust生成密钥
Docker trust有一个内置的委托密钥对生成器,$ docker trust generate <name>
。运行此命令会自动将委托私钥加载到本地Docker信任存储中。
$ docker trust key generate jeff
Generating key for jeff...
Enter passphrase for new jeff key with ID 9deed25:
Repeat passphrase for new jeff key with ID 9deed25:
Successfully generated and loaded private key. Corresponding public key available: /home/ubuntu/Documents/mytrustdir/jeff.pub
手动生成密钥
如果您需要手动生成私钥(RSA 或 ECDSA)和包含公钥的 x509 证书,您可以使用本地工具,例如 openssl 或 cfssl,以及本地或公司范围内的证书颁发机构。
以下是如何生成 2048 位 RSA 私钥的示例(所有 RSA 密钥必须至少为 2048 位)。
$ openssl genrsa -out delegation.key 2048
Generating RSA private key, 2048 bit long modulus
....................................................+++
............+++
e is 65537 (0x10001)
他们应该将 `delegation.key` 保密,因为它用于签名标签。
然后,他们需要生成一个包含公钥的 x509 证书,这就是您需要从他们那里获得的。以下是生成 CSR(证书签名请求)的命令:
$ openssl req -new -sha256 -key delegation.key -out delegation.csr
然后,他们可以将其发送给您信任的任何 CA 来签名证书,或者他们可以自签名证书(在此示例中,创建一个有效期为 1 年的证书)。
$ openssl x509 -req -sha256 -days 365 -in delegation.csr -signkey delegation.key -out delegation.crt
然后,他们需要提供 `delegation.crt` 给您,无论它是自签名的还是由 CA 签名的。
最后,您需要将私钥添加到您的本地 Docker 可信存储区。
$ docker trust key load delegation.key --name jeff
Loading key from "delegation.key"...
Enter passphrase for new jeff key with ID 8ae710e:
Repeat passphrase for new jeff key with ID 8ae710e:
Successfully imported key from delegation.key
查看本地委托密钥
要列出已导入到本地 Docker 可信存储区的密钥,我们可以使用 Notary CLI。
$ notary key list
ROLE GUN KEY ID LOCATION
---- --- ------ --------
root f6c6a4b00fefd8751f86194c7d87a3bede444540eb3378c4a11ce10852ab1f96 /home/ubuntu/.docker/trust/private
jeff 9deed251daa1aa6f9d5f9b752847647cf8d705da0763aa5467650d0987ed5306 /home/ubuntu/.docker/trust/private
在Notary服务器中管理委托
当使用 `$ docker trust` 将第一个委托添加到 Notary 服务器时,我们会自动为存储库启动信任数据。这包括创建公证目标和快照密钥,以及轮换由公证服务器管理的快照密钥。有关这些密钥的更多信息,请点击此处
启动存储库时,您将需要本地 Notary 根密钥的密钥和密码。如果您以前从未启动过存储库,因此没有 Notary 根密钥,`$ docker trust` 将为您创建一个。
重要提示
请务必保护和备份您的Notary规范根密钥。
启动仓库
要将第一个密钥上传到委托,同时启动存储库,您可以使用 `$ docker trust signer add` 命令。这会将贡献者的公钥添加到 `targets/releases` 委托,并创建一个第二个 `targets/
对于 DCT,以下示例中的第二个委托名称 `jeff` 用于帮助您跟踪密钥的所有者。在 Notary 的更高级用例中,其他委托用于层次结构。
$ docker trust signer add --key cert.pem jeff registry.example.com/admin/demo
Adding signer "jeff" to registry.example.com/admin/demo...
Initializing signed repository for registry.example.com/admin/demo...
Enter passphrase for root key with ID f6c6a4b:
Enter passphrase for new repository key with ID b0014f8:
Repeat passphrase for new repository key with ID b0014f8:
Successfully initialized "registry.example.com/admin/demo"
Successfully added signer: jeff to registry.example.com/admin/demo
您可以使用 `$ docker trust inspect` 命令查看已推送到每个存储库的 Notary 服务器的密钥。
$ docker trust inspect --pretty registry.example.com/admin/demo
No signatures for registry.example.com/admin/demo
List of signers and their keys for registry.example.com/admin/demo
SIGNER KEYS
jeff 1091060d7bfd
Administrative keys for registry.example.com/admin/demo
Repository Key: b0014f8e4863df2d028095b74efcb05d872c3591de0af06652944e310d96598d
Root Key: 64d147e59e44870311dd2d80b9f7840039115ef3dfa5008127d769a5f657a5d7
您还可以使用 Notary CLI 列出委托和密钥。在这里,您可以清楚地看到密钥已附加到 `targets/releases` 和 `targets/jeff`。
$ notary delegation list registry.example.com/admin/demo
ROLE PATHS KEY IDS THRESHOLD
---- ----- ------- ---------
targets/jeff "" <all paths> 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 1
targets/releases "" <all paths> 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 1
添加其他签名者
Docker Trust 允许您为每个存储库配置多个委托,从而允许您管理委托的生命周期。使用 `$ docker trust` 添加其他委托时,协作者密钥将再次添加到 `targets/release` 角色。
请注意,您将需要存储库密钥的密码;这在您首次启动存储库时会进行配置。
$ docker trust signer add --key ben.pub ben registry.example.com/admin/demo
Adding signer "ben" to registry.example.com/admin/demo...
Enter passphrase for repository key with ID b0014f8:
Successfully added signer: ben to registry.example.com/admin/demo
检查以证明现在有两个委托(签名者)。
$ docker trust inspect --pretty registry.example.com/admin/demo
No signatures for registry.example.com/admin/demo
List of signers and their keys for registry.example.com/admin/demo
SIGNER KEYS
ben afa404703b25
jeff 1091060d7bfd
Administrative keys for registry.example.com/admin/demo
Repository Key: b0014f8e4863df2d028095b74efcb05d872c3591de0af06652944e310d96598d
Root Key: 64d147e59e44870311dd2d80b9f7840039115ef3dfa5008127d769a5f657a5d7
向现有委托添加密钥
为了支持密钥轮换和密钥过期/停用等操作,您可以为每个委托发布多个贡献者密钥。这里唯一的先决条件是确保您使用相同的委托名称,在本例中为 `jeff`。Docker trust 将自动处理将此新密钥添加到 `targets/releases`。
注意
您将需要存储库密钥的密码;这在您首次启动存储库时会进行配置。
$ docker trust signer add --key cert2.pem jeff registry.example.com/admin/demo
Adding signer "jeff" to registry.example.com/admin/demo...
Enter passphrase for repository key with ID b0014f8:
Successfully added signer: jeff to registry.example.com/admin/demo
检查以证明委托(签名者)现在包含多个密钥 ID。
$ docker trust inspect --pretty registry.example.com/admin/demo
No signatures for registry.example.com/admin/demo
List of signers and their keys for registry.example.com/admin/demo
SIGNER KEYS
jeff 1091060d7bfd, 5570b88df073
Administrative keys for registry.example.com/admin/demo
Repository Key: b0014f8e4863df2d028095b74efcb05d872c3591de0af06652944e310d96598d
Root Key: 64d147e59e44870311dd2d80b9f7840039115ef3dfa5008127d769a5f657a5d7
删除委托
如果您需要删除委托,包括附加到 `targets/releases` 角色的贡献者密钥,您可以使用 `$ docker trust signer remove` 命令。
注意
由已删除委托签名的标签需要由活动委托重新签名。
$ docker trust signer remove ben registry.example.com/admin/demo
Removing signer "ben" from registry.example.com/admin/demo...
Enter passphrase for repository key with ID b0014f8:
Successfully removed ben from registry.example.com/admin/demo
故障排除
如果您看到错误提示 `targets/releases` 中没有可用的密钥,则需要在重新签名镜像之前使用 `docker trust signer add` 添加其他委托。
WARN[0000] role targets/releases has fewer keys than its threshold of 1; it will not be usable until keys are added to it
如果您已经添加了其他委托,并且看到错误消息提示 `targets/releases` 中没有有效的签名,则需要使用 Notary CLI 重新签名 `targets/releases` 委托文件。
WARN[0000] Error getting targets/releases: valid signatures did not meet threshold for targets/releases
重新签名委托文件是使用 `$ notary witness` 命令完成的。
$ notary witness registry.example.com/admin/demo targets/releases --publish
有关 `$ notary witness` 命令的更多信息,请点击此处
从委托中删除贡献者的密钥
作为委托密钥轮换的一部分,您可能希望删除单个密钥但保留委托。这可以使用 Notary CLI 完成。
请记住,您必须从 `targets/releases` 角色和特定于该签名者的角色 `targets/
我们需要从 Notary 服务器获取密钥 ID。
$ notary delegation list registry.example.com/admin/demo ROLE PATHS KEY IDS THRESHOLD ---- ----- ------- --------- targets/jeff "" <all paths> 8fb597cbaf196f0781628b2f52bff6b3912e4e8075720378fda60d17232bbcf9 1 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 targets/releases "" <all paths> 8fb597cbaf196f0781628b2f52bff6b3912e4e8075720378fda60d17232bbcf9 1 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1
从 `targets/releases` 委托中删除。
$ notary delegation remove registry.example.com/admin/demo targets/releases 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 --publish Auto-publishing changes to registry.example.com/admin/demo Enter username: admin Enter password: Enter passphrase for targets key with ID b0014f8: Successfully published changes for repository registry.example.com/admin/demo
从 `targets/
` 委托中删除。 $ notary delegation remove registry.example.com/admin/demo targets/jeff 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 --publish Removal of delegation role targets/jeff with keys [5570b88df0736c468493247a07e235e35cf3641270c944d0e9e8899922fc6f99], to repository "registry.example.com/admin/demo" staged for next publish. Auto-publishing changes to registry.example.com/admin/demo Enter username: admin Enter password: Enter passphrase for targets key with ID b0014f8: Successfully published changes for repository registry.example.com/admin/demo
检查剩余的委托列表。
$ notary delegation list registry.example.com/admin/demo ROLE PATHS KEY IDS THRESHOLD ---- ----- ------- --------- targets/jeff "" <all paths> 8fb597cbaf196f0781628b2f52bff6b3912e4e8075720378fda60d17232bbcf9 1 targets/releases "" <all paths> 8fb597cbaf196f0781628b2f52bff6b3912e4e8075720378fda60d17232bbcf9 1
删除本地委托私钥
作为委托密钥轮换的一部分,您可能需要从本地 Docker 可信存储区中删除本地委托密钥。这可以使用 Notary CLI 完成,使用 `$ notary key remove` 命令。
我们需要从本地 Docker 可信存储区获取密钥 ID。
$ notary key list ROLE GUN KEY ID LOCATION ---- --- ------ -------- root f6c6a4b00fefd8751f86194c7d87a3bede444540eb3378c4a11ce10852ab1f96 /home/ubuntu/.docker/trust/private admin 8fb597cbaf196f0781628b2f52bff6b3912e4e8075720378fda60d17232bbcf9 /home/ubuntu/.docker/trust/private jeff 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 /home/ubuntu/.docker/trust/private targets ...example.com/admin/demo c819f2eda8fba2810ec6a7f95f051c90276c87fddfc3039058856fad061c009d /home/ubuntu/.docker/trust/private
从本地 Docker 可信存储区删除密钥。
$ notary key remove 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 Are you sure you want to remove 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 (role jeff) from /home/ubuntu/.docker/trust/private? (yes/no) y Deleted 1091060d7bfd938dfa5be703fa057974f9322a4faef6f580334f3d6df44c02d1 (role jeff) from /home/ubuntu/.docker/trust/private.
从仓库中删除所有信任数据
您可以使用 Notary CLI 从存储库中删除所有信任数据,包括存储库、目标、快照和所有委托密钥。
在删除特定存储库之前,容器注册表通常需要此操作。
$ notary delete registry.example.com/admin/demo --remote
Deleting trust data for repository registry.example.com/admin/demo
Enter username: admin
Enter password:
Successfully deleted local and remote trust data for repository registry.example.com/admin/demo
$ docker trust inspect --pretty registry.example.com/admin/demo
No signatures or cannot access registry.example.com/admin/demo