Kulcs tulajdonságainak létrehozása, elforgatása és frissítése az Azure Key Vaultban JavaScript használatával

Hozza létre a KeyClientet a megfelelő programozott hitelesítési hitelesítő adatokkal, majd használja az ügyfelet egy kulcs beállítására, frissítésére és elforgatására az Azure Key Vaultban.

A kulcs elforgatása azt jelenti, hogy létrehoz egy új verziót a kulcsból, és ezt a verziót állítja be a legújabb verzióként. Az előző verzió nem törlődik, de már nem az aktív verzió.

Kulcs létrehozása rotációs szabályzattal

Kulcs azure Key Vaultban való létrehozásához használja a KeyClient osztály createKey metódusát. Bármilyen tulajdonság beállítása az opcionális createKeyOptions objektummal. A kulcs létrehozása után frissítse a kulcsot egy rotációs szabályzattal.

A függvény egy KeyVaultKey-et ad vissza. Frissítse a kulcsot az updateKeyRotationPolicy használatával egy szabályzattal, amely tartalmazza az értesítést.

A kényelmi létrehozási módszerek a következő kulcstípusokhoz érhetők el, amelyek az adott kulcstípushoz társított tulajdonságokat állítják be:

// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
  CreateKeyOptions,
  KeyClient,
  KeyRotationPolicyProperties,
  KnownKeyOperations,
  KnownKeyTypes
} from '@azure/keyvault-keys';

// Day/time manipulation
import dayjs from 'dayjs';
import duration from 'dayjs/plugin/duration';
dayjs.extend(duration);

// Authenticate to Azure Key Vault
const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

// Name of key
const keyName = `mykey-${Date.now().toString()}`;

// Set key options
const keyOptions: CreateKeyOptions = {
enabled: true,
expiresOn: dayjs().add(1, 'year').toDate(),
exportable: false,
tags: {
    project: 'test-project'
},
keySize: 2048,
keyOps: [
    KnownKeyOperations.Encrypt,
    KnownKeyOperations.Decrypt
    // KnownKeyOperations.Verify,
    // KnownKeyOperations.Sign,
    // KnownKeyOperations.Import,
    // KnownKeyOperations.WrapKey,
    // KnownKeyOperations.UnwrapKey
]
};

// Set key type
const keyType = KnownKeyTypes.RSA; //  'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct', 'oct-HSM'

// Create key
const key = await client.createKey(keyName, keyType, keyOptions);
if (key) {
    // Set rotation policy properties: KeyRotationPolicyProperties
    const rotationPolicyProperties: KeyRotationPolicyProperties = {
        expiresIn: 'P90D',
        lifetimeActions: [
        {
            action: 'Rotate',
            timeAfterCreate: 'P30D'
        },
        {
            action: 'Notify',
            timeBeforeExpiry: dayjs.duration({ days: 7 }).toISOString()
        }
    ]};
    
    // Set rotation policy: KeyRotationPolicy
    const keyRotationPolicy = await client.updateKeyRotationPolicy(
        key.name,
        rotationPolicyProperties
    );
    console.log(keyRotationPolicy);
}

Kulcs manuális elforgatása

Ha el kell forgatnia a kulcsot, használja a rotateKey metódust. Ezzel létrehoz egy új verziót a kulcshoz, és ezt a verziót állítja be aktív verzióként.

// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
  KeyClient
} from '@azure/keyvault-keys';

// Authenticate to Azure Key Vault
const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

// Get existing key
let key = await client.getKey(`MyKey`);
console.log(key);

if(key?.name){

    // rotate key
    key = await client.rotateKey(key.name);
    console.log(key);
}

Kulcstulajdonságok frissítése

Frissítse a kulcs legújabb verziójának tulajdonságait az updateKeyProperties használatával, vagy frissítse a kulcs egy adott verzióját az updateKeyProperties használatával. A nem megadott UpdateKeyPropertiesOptions tulajdonságok változatlanok maradnak. Ez nem módosítja a kulcs értékét.

// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
  KeyClient
} from '@azure/keyvault-keys';

// Authenticate to Azure Key Vault
const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

// Get existing key
const key = await client.getKey('MyKey');

if (key) {

    // 
    const updateKeyPropertiesOptions = {
        enabled: false,
        // expiresOn,
        // keyOps,
        // notBefore, 
        // releasePolicy, 
        tags: { 
            ...key.properties.tags, subproject: 'Health and wellness' 
        }
    }
    
    // update properties of latest version
    await client.updateKeyProperties(
        key.name,
        updateKeyPropertiesOptions
    );
    
    // update properties of specific version
    await client.updateKeyProperties(
        key.name,
        key?.properties?.version,
        {
            enabled: true
        }
    );
}

Kulcsérték frissítése

Kulcsérték frissítéséhez használja a rotateKey metódust. Mindenképpen adja át az új értéket az összes olyan tulajdonsággal, amelyet meg szeretne tartani a kulcs aktuális verziójától. A további hívásokban nem beállított jelenlegi tulajdonságok elvesznek.

Ez létrehoz egy kulcs új verzióját. A visszaadott KeyVaultKey objektum tartalmazza az új verzióazonosítót.

Következő lépések

  • Last updated on