Azure / notation-azure-kv

Azure Provider for Notation CLI

notation-azure-kv

Azure Provider for the Notation CLI

The notation-azure-kv plugin allows you to sign the Notation-generated payload with a certificate in Azure Key Vault (AKV). The certificate and private key are stored in AKV and the plugin will request signing and obtain the leaf certificate from AKV.

The plugin supports several credential types.

Installation the AKV plugin

Before you begin, make sure the latest version of the Notation CLI has been installed.

1. Navigate to the Releases page and choose a release of notation-azure-kv.

2. Download, verify, and then install the specified version of the plugin.

   Automatically install:

   For Notation >= v1.1.0, please use notation plugin install command to automatically install azure-kv plugin.

   For Linux amd64:

   notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.1.0/notation-azure-kv_1.1.0_linux_amd64.tar.gz --sha256sum 2fc959bf850275246b044203609202329d015005574fabbf3e6393345e49b884 
   

   For Linux arm64:

   notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.1.0/notation-azure-kv_1.1.0_linux_arm64.tar.gz --sha256sum b0f230fb526b4398e8ed35262870ed364c13adf68dce2972670aa6174e91ac78
   

   For Windows amd64:

   notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.1.0/notation-azure-kv_1.1.0_windows_amd64.zip --sha256sum 64406f9e9065e30c56c5d4fa9fbe79f0f49e89378f43bc4d0e05a9f3f0155d88
   

   For macOS amd64:

   notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.1.0/notation-azure-kv_1.1.0_darwin_amd64.tar.gz --sha256sum 50d36e3e50d9f596f050f984b31459632a6214585bf8ef496640481fddea9b08
   

   For macOS arm64:

   notation plugin install --url https://github.com/Azure/notation-azure-kv/releases/download/v1.1.0/notation-azure-kv_1.1.0_darwin_arm64.tar.gz --sha256sum 189aefbba52dfd997c610654cf1e7c755b23d0eb1c35fdd4aede6671fe4e2e1d
   

   Manually install:

   For Linux Bash:

   version=1.1.0
   arch=amd64
   install_path="${HOME}/.config/notation/plugins/azure-kv"
   
   # download tarball and checksum
   checksum_file="notation-azure-kv_${version}_checksums.txt"
   tar_file="notation-azure-kv_${version}_linux_${arch}.tar.gz"
   curl -Lo ${checksum_file} "https://github.com/Azure/notation-azure-kv/releases/download/v${version}/${checksum_file}"
   curl -Lo ${tar_file} "https://github.com/Azure/notation-azure-kv/releases/download/v${version}/${tar_file}"
   
   # validate checksum
   grep ${tar_file} ${checksum_file} | sha256sum -c
   
   # install the plugin
   mkdir -p ${install_path}
   tar xvzf ${tar_file} -C ${install_path} notation-azure-kv

   For macOS Zsh:

   version=1.1.0
   arch=arm64
   install_path="${HOME}/Library/Application Support/notation/plugins/azure-kv"
   
   # download tarball and checksum
   checksum_file="notation-azure-kv_${version}_checksums.txt"
   tar_file="notation-azure-kv_${version}_darwin_${arch}.tar.gz"
   curl -Lo ${checksum_file} "https://github.com/Azure/notation-azure-kv/releases/download/v${version}/${checksum_file}"
   curl -Lo ${tar_file} "https://github.com/Azure/notation-azure-kv/releases/download/v${version}/${tar_file}"
   
   # validate checksum
   grep ${tar_file} ${checksum_file} | shasum -a 256 -c
   
   # install the plugin
   mkdir -p ${install_path}
   tar xvzf ${tar_file} -C ${install_path} notation-azure-kv

   For Windows Powershell:

   $version = "1.1.0"
   $arch = "amd64"
   $install_path = "${env:AppData}\notation\plugins\azure-kv"
   
   # download zip file and checksum
   $checksum_file = "notation-azure-kv_${version}_checksums.txt"
   $zip_file = "notation-azure-kv_${version}_windows_${arch}.zip"
   Invoke-WebRequest -OutFile ${checksum_file} "https://github.com/Azure/notation-azure-kv/releases/download/v${version}/${checksum_file}"
   Invoke-WebRequest -OutFile ${zip_file} "https://github.com/Azure/notation-azure-kv/releases/download/v${version}/${zip_file}"
   
   # validate checksum
   $checksum = (Get-Content ${checksum_file} | Select-String -List ${zip_file}).Line.Split() | Where-Object {$_}
   If ($checksum[0] -ne (Get-FileHash -Algorithm SHA256 $checksum[1]).Hash) {
      throw "$($checksum[1]): Failed"
   }
   
   # install the plugin
   mkdir ${install_path}
   Expand-Archive -Path ${zip_file} -DestinationPath ${install_path}

3. Run notation plugin list and confirm the azure-kv plugin is installed.

Getting started

1. Sign and verify an artifact with a self-signed Azure Key Vault certificate
2. Sign and verify an artifact with a certificate signed by a trusted CA in Azure Key Vault
3. Plugin configuration

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.