Notation@0 – Jelölés v0 feladat
Az Azure Pipepine-feladat a Notation CLI beállításához, a notation használatával való aláíráshoz és ellenőrzéshez.
Szintaxis
# Notation v0
# Azure Pipepine Task for setting up Notation CLI, sign and verify with Notation.
- task: Notation@0
inputs:
command: 'install' # 'install' | 'sign' | 'verify'. Required. Command to run. Default: install.
# Command Configuration
#isCustomVersion: false # boolean. Optional. Use when command = install. Custom Version. Default: false.
#version: '1.2.0' # string. Required when command = install && isCustomVersion = false. Version. Default: 1.2.0.
#url: # string. Required when command = install && isCustomVersion = true. Download URL.
#checksum: # string. Required when command = install && isCustomVersion = true. Checksum.
#artifactRefs: # string. Optional. Use when command = verify || command = sign. Artifact references.
#trustPolicy: # string. Required when command = verify. Trust Policy File Path.
#trustStore: # string. Required when command = verify. Trust Store Folder Path.
# Advanced Configuration
#signatureFormat: 'cose' # 'cose' | 'jws'. Optional. Use when command = sign && command = sign || command = verify. Signature Format. Default: cose.
#allowReferrersAPI: false # boolean. Optional. Use when command = sign || command = verify. [Experimental] Allow Referrers API. Default: false.
# Plugin Configuration
#plugin: 'azureKeyVault' # 'azureKeyVault'. Required when command = sign. Plugin. Default: azureKeyVault.
#akvPluginVersion: '1.2.0' # string. Required when plugin = azureKeyVault && command = sign. Plugin Version. Default: 1.2.0.
#azurekvServiceConection: # string. Optional. Use when plugin = azureKeyVault && command = sign. Azure Key Vault service connection.
#keyid: # string. Required when plugin = azureKeyVault && command = sign. Key ID.
#caCertBundle: # string. Optional. Use when plugin = azureKeyVault && command = sign. Certificate Bundle File Path.
#selfSigned: false # boolean. Optional. Use when plugin = azureKeyVault && command = sign. Self-signed Certificate. Default: false.
# Timestamp
#timestampURL: # string. Optional. Use when command = sign. Timestamp URL.
#timestampRootCert: # string. Optional. Use when command = sign. Timestamp Root Certificate.
Bemenetek
command
-
parancs futtatásához
string
. Szükséges. Engedélyezett értékek: install
, sign
, verify
. Alapértelmezett érték: install
.
A feladat parancsmódját adja meg.
-
telepítése – A
install
parancs észleli az aktuális operációs rendszert és architektúrát, hogy letöltse a megfelelő Notation CLI-t a GitHub-kiadásokból. Emellett ellenőrzi a letöltött fájl ellenőrzőösszegét a./data
mappában lévő arany fájlon, és hozzáadja a Notationt a PATH-hoz. -
aláírási – A
sign
parancs letölti a kijelölt Notation beépülő modult, ellenőrzi annak ellenőrzőösszegét, majd meghívja a Notation CLI-t az aláírásra. -
ellenőrzése – A
verify
parancs a Notation PARANCSSOR által megkövetelt módon átviszi a megbízhatósági tárházat és a megbízhatósági szabályzatot a felhasználó kódtárából a Notation konfigurációs mappába. Ezután meghívja a Notation CLI-t az ellenőrzés végrehajtásához.
isCustomVersion
-
egyéni verziós
boolean
. Szabadon választható. Használja a command = install
. Alapértelmezett érték: false
.
Adja meg a true
, hogy a feladathoz a Notation egyéni verzióját adja meg. Ehhez adjon meg egy letöltési URL-címet az egyéni verzióhoz a url
tulajdonságban.
version
-
verzió
string
.
command = install && isCustomVersion = false
esetén kötelező. Alapértelmezett érték: 1.2.0
.
A notation telepíteni kívánt verziója. Példa: 1.0.0, 1, 1.0, 1.0.0.
url
-
LETÖLTÉSI URL-
string
.
command = install && isCustomVersion = true
esetén kötelező.
A Notation egyéni verziójának URL-címe, például: https://github.com/notaryproject/notation/releases/download/v1.0.0/notation_1.0.0_linux_amd64.tar.gz
.
checksum
-
Ellenőrzőösszeg
string
.
command = install && isCustomVersion = true
esetén kötelező.
A letöltött fájl SHA-256 ellenőrzőösszege.
artifactRefs
-
Összetevő-hivatkozások
string
. Szabadon választható. Használja a command = verify || command = sign
.
Tárolóösszetevő-hivatkozások aláíráshoz. Ha nincs megadva, a tevékenység az előző Docker leküldéses tevékenység összetevő-hivatkozását használja. Példa: <registry name>/<repository name>@<digest>
. Több összetevőhivatkozást vesszővel kell elválasztani.
signatureFormat
-
Aláírásformátum
string
. Szabadon választható. Használja a command = sign && command = sign || command = verify
. Engedélyezett értékek: cose
, jws
. Alapértelmezett érték: cose
.
Aláírás borítékformátuma.
allowReferrersAPI
-
[Kísérleti] Referrers API- engedélyezése
boolean
. Szabadon választható. Használja a command = sign || command = verify
. Alapértelmezett érték: false
.
Ha nem támogatott (a 404-es értéket adja vissza), a Referrers API-val aláírhatja az aláírásokat a Referrers címkesémára.
plugin
-
beépülő modul
string
.
command = sign
esetén kötelező. Engedélyezett értékek: azureKeyVault
(Azure Key Vault beépülő modul). Alapértelmezett érték: azureKeyVault
.
akvPluginVersion
-
beépülő modul verziója
string
.
plugin = azureKeyVault && command = sign
esetén kötelező. Alapértelmezett érték: 1.2.0
.
A telepíteni kívánt Azure Key Vault beépülő modul verziója. Tekintse meg a notation-azure-kv kiadási lap az elérhető verziókhoz.
azurekvServiceConection
-
Azure Key Vault szolgáltatáskapcsolati
string
. Szabadon választható. Használja a plugin = azureKeyVault && command = sign
.
Válassza ki a kulcstartóHoz tartozó Azure-előfizetést, ha inkább szolgáltatáskapcsolatot szeretne használni a hitelesítéshez.
keyid
-
kulcsazonosító
string
.
plugin = azureKeyVault && command = sign
esetén kötelező.
A kulcsazonosító az Azure Key Vault kulcs- vagy tanúsítványazonosítója.
caCertBundle
-
tanúsítványcsomag fájlelérési útja
string
. Szabadon választható. Használja a plugin = azureKeyVault && command = sign
.
A tanúsítványcsomagfájl gyökér- és köztes tanúsítványokkal, a főtanúsítványtól kezdve a tanúsítványláncban szereplő sorrendet követve.
selfSigned
-
önaláírt tanúsítvány
boolean
. Szabadon választható. Használja a plugin = azureKeyVault && command = sign
. Alapértelmezett érték: false
.
Azt jelzi, hogy a tanúsítvány önaláírt tanúsítvány-e.
timestampURL
-
időbélyeg URL-címének
string
. Szabadon választható. Használja a command = sign
.
RFC 3161 időbélyegző szolgáltató (TSA) kiszolgáló URL-címe. (A Jelölés 1.2.0-s vagy újabb verziójának megkövetelése).
timestampRootCert
-
időbélyeg főtanúsítvány-
string
. Szabadon választható. Használja a command = sign
.
az időbélyegző-hitelesítés főtanúsítványának filepathja. (A Jelölés 1.2.0-s vagy újabb verziójának megkövetelése).
string
.
command = verify
esetén kötelező.
A megbízhatósági szabályzat elérési útja fájl az adattárhoz képest. Példa: ./path/to/trust-policy.json
.
trustStore
-
Megbízhatósági tár mappa elérési útja
string
.
command = verify
esetén kötelező.
A megbízhatósági tárat tartalmazó könyvtár elérési útja az adattárhoz képest. Példa: ./path/to/truststore/
.
Tevékenységvezérlési beállítások
Minden tevékenység a tevékenységbemeneteken kívül vezérlési lehetőségekkel is rendelkezik. További információ: Vezérlők és gyakori feladattulajdonságok.
Kimeneti változók
Egyik sem.
Megjegyzések
A Notation feladat az aláírási és ellenőrzési műveletek végrehajtására kéri a Notation parancssori felületet. A Notation CLI a Docker-tároló összetevőinek vagy lemezképeinek aláírására és ellenőrzésére szolgáló eszköz. Az összetevő aláírásakor a Notation aláírja az összetevő egyedi jegyzékleíróját, és ugyanahhoz az adattárhoz csatolja az aláírást. Az összetevő ellenőrzésekor a Notation lekéri az aláírást az adattárból, és ellenőrzi azt a megbízhatósági tárolóban lévő tanúsítványon.
Előfeltételek
- Ehhez a feladathoz nyilvános hálózati hozzáférésre van szükség a Notation CLI és a Notation Azure Key Vault beépülő modul GitHub-kiadásokból való letöltéséhez.
- Támogatott ügynök operációs rendszere: Linux x64/ARM64, Windows x64, macOS x64/ARM64
Notation install command
A install
parancs észleli az aktuális operációs rendszert és architektúrát, hogy letöltse a megfelelő Notation CLI-t a GitHub-kiadásokból. Emellett ellenőrzi a letöltött fájl ellenőrzőösszegét a ./data
mappában lévő arany fájlon, és hozzáadja a Notationt a PATH-hoz.
Jelölési jel parancs
A sign
parancs letölti a kijelölt Notation beépülő modult, ellenőrzi annak ellenőrzőösszegét, majd meghívja a Notation CLI-t az aláírásra.
Jelölés ellenőrzése parancs
A verify
parancs a Notation PARANCSSOR által megkövetelt módon a felhasználó kódtárából a Notation konfigurációs mappába helyezi át a megbízhatósági tárházat és a megbízhatósági szabályzatot. Ezután meghívja a Notation CLI-t az ellenőrzés végrehajtásához.
Követelmények
Követelmény | Leírás |
---|---|
Folyamattípusok | YAML, klasszikus build, klasszikus kiadás |
Futtatás bekapcsolva | Ügynök, DeploymentGroup |
Követelmények | Egyik sem |
képességek | Ez a tevékenység nem felel meg a feladat későbbi tevékenységeire vonatkozó követelményeknek. |
parancskorlátozások | Bármely |
Változók beállítása | Bármely |
Ügynök verziója | 2.144.0 vagy újabb |
Tevékenységkategória | Hasznosság |