?
This document uses PHP Chinese website manual Release
本文檔適用于希望促進(jìn) CLI 交互或指定自定義選項的公證人客戶端的高級用戶。
公證客戶端的配置文件通常駐留在~/.notary/config.json
,但可以使用-c
或--configFile
命令行標(biāo)志指定不同配置文件的路徑。
除了配置文件格式之外,請查看公證人客戶端可以使用的可選密碼環(huán)境變量以便使用。
這是一個完整的客戶端配置文件示例; 請點擊頂層的 JSON 鍵以了解更多關(guān)于與該鍵相對應(yīng)的配置部分:
{ "trust_dir" : "~/.docker/trust", "remote_server": { "url": "https://my-notary-server.my-private-registry.com", "root_ca": "./fixtures/root-ca.crt", "tls_client_cert": "./fixtures/secure.example.com.crt", "tls_client_key": "./fixtures/secure.example.com.crt" }, "trust_pinning": { "certs": { "docker.com/notary": ["49cf5c6404a35fa41d5a5aa2ce539dfee0d7a2176d0da488914a38603b1f4292"] } }}
在trust_dir
其中的元數(shù)據(jù) TUF 和私有密鑰將被存儲指定的位置(為絕對路徑或相對于配置文件的目錄的路徑)。
這通常是默認(rèn)的~/.notary
,但是指定~/.docker/trust
促進(jìn)與內(nèi)容信任的互操作性。
請注意,該選項可以用命令行標(biāo)志覆蓋--trustDir
。
在remote_server
指定如何連接到公證服務(wù)器下載元數(shù)據(jù)更新和發(fā)布元數(shù)據(jù)的變化。
遠(yuǎn)程服務(wù)器示例:
"remote_server": { "url": "https://my-notary-server.my-private-registry.com", "root_ca": "./fixtures/root-ca.crt", "tls_client_cert": "./fixtures/secure.example.com.crt", "tls_client_key": "./fixtures/secure.example.com.crt" }
參數(shù) | 需要 | 描述 |
---|---|---|
網(wǎng)址(url) | 沒有 | 公證服務(wù)器的URL:默認(rèn)為該配置選項可以用命令行標(biāo)志-s或--server。 |
root_ca | 沒有 | 包含根CA的文件的路徑,用于驗證公證服務(wù)器的TLS證書(例如,是否為自簽名)。該路徑相對于配置文件的目錄。該配置選項可以用命令行標(biāo)志覆蓋,該標(biāo)志--tlscacert將指定相對于公證客戶端被調(diào)用的當(dāng)前工作目錄的路徑。 |
tls_client_cert | 沒有 | 客戶端證書的路徑,用于與公證服務(wù)器進(jìn)行相互TLS。必須與tls_client_key一起提供或根本不提供。該路徑相對于配置文件的目錄。該配置選項可以用命令行標(biāo)志覆蓋,該標(biāo)志--tlscert將指定相對于公證客戶端被調(diào)用的當(dāng)前工作目錄的路徑。 |
tls_client_key | 沒有 | 客戶端密鑰用于與公證服務(wù)器進(jìn)行相互TLS的路徑。必須與tls_client_cert一起提供或根本不提供。該路徑相對于配置文件的目錄。該配置選項可以用命令行標(biāo)志覆蓋,該標(biāo)志--tlskey將指定相對于公證客戶端被調(diào)用的當(dāng)前工作目錄的路徑。 |
該trust_pinning
指定如何引導(dǎo)信任的公證客戶的信任集的根目錄。
此部分是可選的,默認(rèn)情況下,公證人將通過 HTTPS 使用 TOFU,并在所下載的根文件中信任證書。
在本節(jié)中,可以提供特定的證書以供引腳連接,或者 CA 可以將其作為 GUN 的信任根。可以指定多個部分,但固定證書將以最高優(yōu)先級進(jìn)行驗證,然后是固定 CA,然后是 TOFUS(通過 HTTPS 的 TOFU)。下圖描述了此驗證流程:
</img>
即使指定了多個部分,也只會使用一個信任釘住選項來驗證 GUN,任何驗證失敗都會導(dǎo)致回購的引導(dǎo)失敗。
參數(shù) | 需要 | 描述 |
---|---|---|
certs | 沒有 | 將GUN映射到要插入的證書ID。兩者都是JSON對象中的字符串。 |
ca | 沒有 | 將GUN前綴映射到包含根CA文件的文件路徑,用于驗證根文件中的證書。該文件可以包含多個根證書,捆綁在單獨的PEM塊中。該路徑相對于配置文件的目錄。 |
disable_tofu | 沒有 | 在對集合的根文件進(jìn)行引導(dǎo)驗證時,確定是否在首次使用時使用信任的布爾值。這會默認(rèn)保持TOFU。 |
包含簽名密鑰密碼的以下環(huán)境變量可以用于幫助公證客戶端 CLI 交互。如果提供,這些密碼將最初用于簽署 TUF 元數(shù)據(jù)。如果密碼不正確,系統(tǒng)將提示您輸入正確的密碼。
環(huán)境變量 | 描述 |
---|---|
NOTARY_ROOT_PASSPHRASE | root / offline密鑰短語 |
NOTARY_TARGETS_PASSPHRASE | 目標(biāo)(在線)密鑰密碼 |
NOTARY_SNAPSHOT_PASSPHRASE | 快照(在線)密鑰密碼 |
NOTARY_DELEGATION_PASSPHRASE | 代表團(tuán)(在線)密鑰密碼 |
請注意,如果提供,NOTARY_DELEGATION_PASSPHRASE
將嘗試為公證人嘗試簽署的所有代表團(tuán)角色輸入密碼。