Skip to content

Commit 5f21067

Browse files
committed
update comments
Signed-off-by: Yi Zha <[email protected]>
1 parent dc27f33 commit 5f21067

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

articles/container-registry/container-registry-tutorial-sign-build-push.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Sign container images with Notation and Azure Key Vault using a self-signed certificate (preview)
3-
description: In this tutorial you'll learn to create a signing certificate in Azure Key Vault (AKV), build and sign a container image stored in Azure Container Registry (ACR) with notation and AKV, and then verify the container image with notation.
2+
title: Sign container images with Notation and Azure Key Vault using a self-signed certificate (Preview)
3+
description: In this tutorial you'll learn to create a self-signed certificate in Azure Key Vault (AKV), build and sign a container image stored in Azure Container Registry (ACR) with notation and AKV, and then verify the container image with notation.
44
author: yizha1
55
ms.author: yizha1
66
ms.service: container-registry
@@ -9,9 +9,9 @@ ms.topic: how-to
99
ms.date: 4/23/2023
1010
---
1111

12-
# Sign container images with Notation and Azure Key Vault using a self-signed certificate (preview)
12+
# Sign container images with Notation and Azure Key Vault using a self-signed certificate (Preview)
1313

14-
Signing container images is a process that ensures their authenticity and integrity. This is achieved by adding a digital signature to the container image, which can be validated during deployment. The signature helps to verify that the image is from a trusted publisher and has not been tampered with. [Notation](https://github.com/notaryproject/notation) is an open source supply chain tool developed by [Notary Project](https://notaryproject.dev/), which supports signing and verifying container images and other artifacts. The Azure Key Vault (AKV) is used to store a signing certificate that can be utilized by Notation with the Notation AKV plugin (azure-kv) to sign and verify container images and other artifacts. The Azure Container Registry (ACR) allows you to attach and discover these signatures to container images.
14+
Signing container images is a process that ensures their authenticity and integrity. This is achieved by adding a digital signature to the container image, which can be validated during deployment. The signature helps to verify that the image is from a trusted publisher and has not been tampered with. [Notation](https://github.com/notaryproject/notation) is an open source supply chain tool developed by [Notary Project](https://notaryproject.dev/), which supports signing and verifying container images and other artifacts. The Azure Key Vault (AKV) is used to store certificates with signing keys that can be utilized by Notation with the Notation AKV plugin (azure-kv) to sign and verify container images and other artifacts. The Azure Container Registry (ACR) allows you to attach and discover these signatures to container images.
1515

1616
> [!IMPORTANT]
1717
> This feature is currently in preview. Previews are made available to you on the condition that you agree to the [supplemental terms of use][terms-of-use]. Some aspects of this feature may change prior to general availability (GA).
@@ -20,15 +20,15 @@ In this tutorial:
2020

2121
> [!div class="checklist"]
2222
> * Install Notation CLI and AKV plugin
23-
> * Create a self-signed signing certificate in AKV
23+
> * Create a self-signed certificate in AKV
2424
> * Build and push a container image with ACR task
2525
> * Sign a container image with Notation CLI and AKV plugin
2626
> * Validate a container image against the signature with Notation CLI
2727
2828
## Prerequisites
2929

3030
* Create or use an [Azure Container Registry](../container-registry/container-registry-get-started-azure-cli.md) for storing container images and signatures
31-
* Create or use an [Azure Key Vault](../key-vault/general/quick-create-cli.md) for managing signing certificates
31+
* Create or use an [Azure Key Vault](../key-vault/general/quick-create-cli.md) for managing certificates
3232
* Install and configure the latest [Azure CLI](/cli/azure/install-azure-cli), or Run commands in the [Azure Cloud Shell](https://portal.azure.com/#cloudshell/)
3333

3434
## Install Notation CLI and AKV plugin
@@ -104,7 +104,7 @@ In this tutorial:
104104
az login
105105
```
106106

107-
To learn more about Azure CLI and how to sign in with it, see [Sign in with Azure CLI](https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli).
107+
To learn more about Azure CLI and how to sign in with it, see [Sign in with Azure CLI](/cli/azure/authenticate-azure-cli).
108108

109109
## Assign access policy in AKV (Azure CLI)
110110

@@ -126,13 +126,13 @@ az keyvault set-policy -n $AKV_NAME --certificate-permissions create get --key-p
126126
> [!NOTE]
127127
> The permissions granted are necessary for creating a certificate and signing a container image. Depending on your requirements, you may need to grant additional permissions.
128128

129-
## Create a self-signed signing certificate in AKV (Azure CLI)
129+
## Create a self-signed certificate in AKV (Azure CLI)
130130

131-
The following steps show how to create a self-signed signing certificate for testing purpose.
131+
The following steps show how to create a self-signed certificate for testing purpose.
132132

133133
1. Create a certificate policy file.
134134

135-
Once the certificate policy file is executed as below, it creates a valid signing certificate compatible with [Notary Project certificate requirement](https://github.com/notaryproject/specifications/blob/v1.0.0/specs/signature-specification.md#certificate-requirements) in AKV. The EKU listed is for code-signing, but isn't required for notation to sign artifacts. The subject is used later as trust identity that user trust during verification.
135+
Once the certificate policy file is executed as below, it creates a valid certificate compatible with [Notary Project certificate requirement](https://github.com/notaryproject/specifications/blob/v1.0.0/specs/signature-specification.md#certificate-requirements) in AKV. The EKU listed is for code-signing, but isn't required for notation to sign artifacts. The subject is used later as trust identity that user trust during verification.
136136
137137
```bash
138138
cat <<EOF > ./my_policy.json
@@ -207,7 +207,7 @@ The following steps show how to create a self-signed signing certificate for tes
207207
208208
## Verify a container image with Notation CLI
209209
210-
To verify the container image, you need to add the root certificate that signs the signing certificate to a trust store and create trust policies for verification. For a self-signed certificate used in this tutorial, the root certificate is the self-signed certificate itself.
210+
To verify the container image, you need to add the root certificate that signs the certificate to a trust store and create trust policies for verification. For a self-signed certificate used in this tutorial, the root certificate is the self-signed certificate itself.
211211
212212
1. Download public certificate.
213213
@@ -231,7 +231,7 @@ To verify the container image, you need to add the root certificate that signs t
231231
232232
4. Configure trust policy before verification.
233233
234-
Trust policies allow users to specify fine-tuned verification policies. Use the following command to configure trust policy. Upon successful execution of the command, one trust policy named `wabbit-networks-images` is created. This trust policy applies to all the artifacts stored in repositories defined in `$REGISTRY/$REPO`. Assuming that the user trusts a specific identity with the X.509 subject `$CERT_SUBJECT`, which is used for the signing certificate. The named trust store `$STORE_NAME` of type `$STORE_TYPE` contains the root certificates. See [Trust store and trust policy specification](https://github.com/notaryproject/notaryproject/blob/v1.0.0/specs/trust-store-trust-policy.md) for details.
234+
Trust policies allow users to specify fine-tuned verification policies. Use the following command to configure trust policy. Upon successful execution of the command, one trust policy named `wabbit-networks-images` is created. This trust policy applies to all the artifacts stored in repositories defined in `$REGISTRY/$REPO`. Assuming that the user trusts a specific identity with the X.509 subject `$CERT_SUBJECT`, which is used for the certificate. The named trust store `$STORE_NAME` of type `$STORE_TYPE` contains the root certificates. See [Trust store and trust policy specification](https://github.com/notaryproject/notaryproject/blob/v1.0.0/specs/trust-store-trust-policy.md) for details.
235235
236236
```bash
237237
cat <<EOF > ./trustpolicy.json

0 commit comments

Comments
 (0)