快速入門：適用於 Go 的 Azure Key Vault 金鑰用戶端程式庫

發行項
03/12/2024

在本快速入門文章中，您將瞭解如何使用 Azure SDK for Go 來建立、擷取、更新、列出和刪除 Azure Key Vault 金鑰。

Azure Key Vault 是一項雲端服務，可作為安全的祕密存放區。您也可以安全地儲存金鑰、密碼、憑證和其他祕密。如需 Key Vault 的詳細資訊，您可以檢閱概觀。

請遵循本指南，瞭解如何使用 azkeys 套件，以使用 Go 管理 Azure Key Vault 金鑰。

必要條件

Azure 訂用帳戶 - 建立免費帳戶。
Go 已安裝：版本 1.18 或更高版本
Azure CLI

設定您的環境

登入 Azure。
```
az login
```

建立新的資源群組。

az group create --name quickstart-rg --location eastus

部署新的金鑰保存庫執行個體。
```
az keyvault create --name <keyVaultName> --resource-group quickstart-rg
```
以 Azure 中的唯一名稱取代 <keyVaultName>。您通常會使用個人或公司名稱，以及其他數字和識別碼。

建立新的 Go 模組並安裝封裝

go mod init quickstart-keys
go get -u github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get -u github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys

建立範例程式碼

建立名稱為 main.go 的檔案，並將下列程式碼複製至檔案：

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys"
)

func main() {
	keyVaultName := os.Getenv("KEY_VAULT_NAME")
	keyVaultUrl := fmt.Sprintf("https://%s.vault.azure.net/", keyVaultName)

	// create credential
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}

	// create azkeys client
	client, err := azkeys.NewClient(keyVaultUrl, cred, nil)
	if err != nil {
		log.Fatal(err)
	}

	// create RSA Key
	rsaKeyParams := azkeys.CreateKeyParameters{
		Kty:     to.Ptr(azkeys.JSONWebKeyTypeRSA),
		KeySize: to.Ptr(int32(2048)),
	}
	rsaResp, err := client.CreateKey(context.TODO(), "new-rsa-key", rsaKeyParams, nil)
	if err != nil {
		log.Fatalf("failed to create rsa key: %v", err)
	}
	fmt.Printf("New RSA key ID: %s\n", *rsaResp.Key.KID)

	// create EC Key
	ecKeyParams := azkeys.CreateKeyParameters{
		Kty:   to.Ptr(azkeys.JSONWebKeyTypeEC),
		Curve: to.Ptr(azkeys.JSONWebKeyCurveNameP256),
	}
	ecResp, err := client.CreateKey(context.TODO(), "new-ec-key", ecKeyParams, nil)
	if err != nil {
		log.Fatalf("failed to create ec key: %v", err)
	}
	fmt.Printf("New EC key ID: %s\n", *ecResp.Key.KID)

	// list all vault keys
	fmt.Println("List all vault keys:")
	pager := client.NewListKeysPager(nil)
	for pager.More() {
		page, err := pager.NextPage(context.TODO())
		if err != nil {
			log.Fatal(err)
		}
		for _, key := range page.Value {
			fmt.Println(*key.KID)
		}
	}

	// update key properties to disable key
	updateParams := azkeys.UpdateKeyParameters{
		KeyAttributes: &azkeys.KeyAttributes{
			Enabled: to.Ptr(false),
		},
	}
	// an empty string version updates the latest version of the key
	version := ""
	updateResp, err := client.UpdateKey(context.TODO(), "new-rsa-key", version, updateParams, nil)
	if err != nil {
		panic(err)
	}
	fmt.Printf("Key %s Enabled attribute set to: %t\n", *updateResp.Key.KID, *updateResp.Attributes.Enabled)

	// delete the created keys
	for _, keyName := range []string{"new-rsa-key", "new-ec-key"} {
		// DeleteKey returns when Key Vault has begun deleting the key. That can take several
		// seconds to complete, so it may be necessary to wait before performing other operations
		// on the deleted key.
		delResp, err := client.DeleteKey(context.TODO(), keyName, nil)
		if err != nil {
			panic(err)
		}
		fmt.Printf("Successfully deleted key %s", *delResp.Key.KID)
	}
}

執行程式碼

執行程式碼之前，請先建立名稱為 KEY_VAULT_NAME 的環境變數。將環境變數的值設為先前所建立 Azure Key Vault 的名稱。

export KEY_VAULT_NAME=quickstart-kv

接下來，執行下列 go run 命令來執行應用程式：

go run main.go

Key ID: https://quickstart-kv.vault.azure.net/keys/new-rsa-key4/f78fe1f34b064934bac86cc8c66a75c3: Key Type: RSA
Key ID: https://quickstart-kv.vault.azure.net/keys/new-ec-key2/10e2cec51d1749c0a26aab784808cfaf: Key Type: EC
List all vault keys:
https://quickstart-kv.vault.azure.net/keys/new-ec-key
https://quickstart-kv.vault.azure.net/keys/new-ec-key1
https://quickstart-kv.vault.azure.net/keys/new-ec-key2
https://quickstart-kv.vault.azure.net/keys/new-rsa-key4
Enabled set to: false
Successfully deleted key https://quickstart-kv.vault.azure.net/keys/new-rsa-key4/f78fe1f34b064934bac86cc8c66a75c3

注意

輸出僅供參考用途。您的傳回值可能會根據 Azure 訂用帳戶和 Azure Key Vault 而有所不同。

程式碼範例

如需更多範例，請參閱課程模組文件。

清除資源

若要刪除資源群組及其所有剩餘資源，請執行下列命令︰

az group delete --resource-group quickstart-rg

共用方式為