Skill v1.0.1
currentAutomated scan100/100+4 new
name: azure-security-keyvault-keys-java description: "Azure Key Vault Keys Java SDK for cryptographic key management. Use when creating, managing, or using RSA/EC keys, performing encrypt/decrypt/sign/verify operations, or working with HSM-backed keys." risk: critical source: community date_added: "2026-02-27" metadata: version: "1.0.1"
Azure Key Vault Keys (Java)
Manage cryptographic keys and perform cryptographic operations in Azure Key Vault and Managed HSM.
Installation
<dependency><groupId>com.azure</groupId><artifactId>azure-security-keyvault-keys</artifactId><version>4.9.0</version></dependency>
Client Creation
import com.azure.security.keyvault.keys.KeyClient;import com.azure.security.keyvault.keys.KeyClientBuilder;import com.azure.security.keyvault.keys.cryptography.CryptographyClient;import com.azure.security.keyvault.keys.cryptography.CryptographyClientBuilder;import com.azure.identity.DefaultAzureCredentialBuilder;// Key management clientKeyClient keyClient = new KeyClientBuilder().vaultUrl("https://<vault-name>.vault.azure.net").credential(new DefaultAzureCredentialBuilder().build()).buildClient();// Async clientKeyAsyncClient keyAsyncClient = new KeyClientBuilder().vaultUrl("https://<vault-name>.vault.azure.net").credential(new DefaultAzureCredentialBuilder().build()).buildAsyncClient();// Cryptography client (for encrypt/decrypt/sign/verify)CryptographyClient cryptoClient = new CryptographyClientBuilder().keyIdentifier("https://<vault-name>.vault.azure.net/keys/<key-name>/<key-version>").credential(new DefaultAzureCredentialBuilder().build()).buildClient();
Key Types
| Type | Description | |
|---|---|---|
RSA | RSA key (2048, 3072, 4096 bits) | |
RSA_HSM | RSA key in HSM | |
EC | Elliptic Curve key | |
EC_HSM | Elliptic Curve key in HSM | |
OCT | Symmetric key (Managed HSM only) | |
OCT_HSM | Symmetric key in HSM |
Create Keys
Create RSA Key
import com.azure.security.keyvault.keys.models.*;// Simple RSA keyKeyVaultKey rsaKey = keyClient.createRsaKey(new CreateRsaKeyOptions("my-rsa-key").setKeySize(2048));System.out.println("Key name: " + rsaKey.getName());System.out.println("Key ID: " + rsaKey.getId());System.out.println("Key type: " + rsaKey.getKeyType());// RSA key with optionsKeyVaultKey rsaKeyWithOptions = keyClient.createRsaKey(new CreateRsaKeyOptions("my-rsa-key-2").setKeySize(4096).setExpiresOn(OffsetDateTime.now().plusYears(1)).setNotBefore(OffsetDateTime.now()).setEnabled(true).setKeyOperations(KeyOperation.ENCRYPT, KeyOperation.DECRYPT,KeyOperation.WRAP_KEY, KeyOperation.UNWRAP_KEY).setTags(Map.of("environment", "production")));// HSM-backed RSA keyKeyVaultKey hsmKey = keyClient.createRsaKey(new CreateRsaKeyOptions("my-hsm-key").setKeySize(2048).setHardwareProtected(true));
Create EC Key
// EC key with P-256 curveKeyVaultKey ecKey = keyClient.createEcKey(new CreateEcKeyOptions("my-ec-key").setCurveName(KeyCurveName.P_256));// EC key with other curvesKeyVaultKey ecKey384 = keyClient.createEcKey(new CreateEcKeyOptions("my-ec-key-384").setCurveName(KeyCurveName.P_384));KeyVaultKey ecKey521 = keyClient.createEcKey(new CreateEcKeyOptions("my-ec-key-521").setCurveName(KeyCurveName.P_521));// HSM-backed EC keyKeyVaultKey ecHsmKey = keyClient.createEcKey(new CreateEcKeyOptions("my-ec-hsm-key").setCurveName(KeyCurveName.P_256).setHardwareProtected(true));
Create Symmetric Key (Managed HSM only)
KeyVaultKey octKey = keyClient.createOctKey(new CreateOctKeyOptions("my-symmetric-key").setKeySize(256).setHardwareProtected(true));
Get Key
// Get latest versionKeyVaultKey key = keyClient.getKey("my-key");// Get specific versionKeyVaultKey keyVersion = keyClient.getKey("my-key", "<version-id>");// Get only key properties (no key material)KeyProperties keyProps = keyClient.getKey("my-key").getProperties();
Update Key Properties
KeyVaultKey key = keyClient.getKey("my-key");// Update propertieskey.getProperties().setEnabled(false).setExpiresOn(OffsetDateTime.now().plusMonths(6)).setTags(Map.of("status", "archived"));KeyVaultKey updatedKey = keyClient.updateKeyProperties(key.getProperties(),KeyOperation.ENCRYPT, KeyOperation.DECRYPT);
List Keys
import com.azure.core.util.paging.PagedIterable;// List all keysfor (KeyProperties keyProps : keyClient.listPropertiesOfKeys()) {System.out.println("Key: " + keyProps.getName());System.out.println(" Enabled: " + keyProps.isEnabled());System.out.println(" Created: " + keyProps.getCreatedOn());}// List key versionsfor (KeyProperties version : keyClient.listPropertiesOfKeyVersions("my-key")) {System.out.println("Version: " + version.getVersion());System.out.println("Created: " + version.getCreatedOn());}
Delete Key
import com.azure.core.util.polling.SyncPoller;// Begin delete (soft-delete enabled vaults)SyncPoller<DeletedKey, Void> deletePoller = keyClient.beginDeleteKey("my-key");// Wait for deletionDeletedKey deletedKey = deletePoller.poll().getValue();System.out.println("Deleted: " + deletedKey.getDeletedOn());deletePoller.waitForCompletion();// Recovery is an ALTERNATIVE to purge: a purged key cannot be recovered.// Purge requires separate explicit authorization and may be blocked by purge protection.// Recover the soft-deleted keySyncPoller<KeyVaultKey, Void> recoverPoller = keyClient.beginRecoverDeletedKey("my-key");recoverPoller.waitForCompletion();
Cryptographic Operations
Confirm vault/tenant, key operations and resource authorization first. Destructive disable/delete/purge operations can make dependent data unavailable; inventory consumers and recovery before writes. Use the returned versioned key ID with ciphertext/signatures for future decryption/verification after rotation. Never log decrypted production plaintext or imported private components. Backup blobs are sensitive encrypted material with restore restrictions, not a general export: write them to approved private storage without overwriting existing backups. Pin Java SDK versions and verify method support for the chosen vault/HSM and algorithm.
Encrypt/Decrypt
import com.azure.security.keyvault.keys.cryptography.models.*;CryptographyClient cryptoClient = new CryptographyClientBuilder().keyIdentifier("https://<vault>.vault.azure.net/keys/<key-name>").credential(new DefaultAzureCredentialBuilder().build()).buildClient();byte[] plaintext = "Hello, World!".getBytes(StandardCharsets.UTF_8);// EncryptEncryptResult encryptResult = cryptoClient.encrypt(EncryptionAlgorithm.RSA_OAEP, plaintext);byte[] ciphertext = encryptResult.getCipherText();System.out.println("Ciphertext length: " + ciphertext.length);// DecryptDecryptResult decryptResult = cryptoClient.decrypt(EncryptionAlgorithm.RSA_OAEP, ciphertext);String decrypted = new String(decryptResult.getPlainText(), StandardCharsets.UTF_8);System.out.println("Decrypted: " + decrypted);
Sign/Verify
import java.security.MessageDigest;// Create digest of databyte[] data = "Data to sign".getBytes(StandardCharsets.UTF_8);MessageDigest md = MessageDigest.getInstance("SHA-256");byte[] digest = md.digest(data);// SignSignResult signResult = cryptoClient.sign(SignatureAlgorithm.RS256, digest);byte[] signature = signResult.getSignature();// VerifyVerifyResult verifyResult = cryptoClient.verify(SignatureAlgorithm.RS256, digest, signature);System.out.println("Valid signature: " + verifyResult.isValid());
Wrap/Unwrap Key
// Key to wrap (e.g., AES key)byte[] keyToWrap = new byte[32]; // 256-bit keynew SecureRandom().nextBytes(keyToWrap);// WrapWrapResult wrapResult = cryptoClient.wrapKey(KeyWrapAlgorithm.RSA_OAEP, keyToWrap);byte[] wrappedKey = wrapResult.getEncryptedKey();// UnwrapUnwrapResult unwrapResult = cryptoClient.unwrapKey(KeyWrapAlgorithm.RSA_OAEP, wrappedKey);byte[] unwrappedKey = unwrapResult.getKey();
Backup and Restore
// Backupbyte[] backup = keyClient.backupKey("my-key");// Save backup to fileFiles.write(Paths.get("key-backup.blob"), backup);// Restorebyte[] backupData = Files.readAllBytes(Paths.get("key-backup.blob"));KeyVaultKey restoredKey = keyClient.restoreKeyBackup(backupData);
Key Rotation
// Rotate to new versionKeyVaultKey rotatedKey = keyClient.rotateKey("my-key");System.out.println("New version: " + rotatedKey.getProperties().getVersion());// Set rotation policyKeyRotationPolicy policy = new KeyRotationPolicy().setExpiresIn("P90D") // Expire after 90 days.setLifetimeActions(Arrays.asList(new KeyRotationLifetimeAction(KeyRotationPolicyAction.ROTATE).setTimeBeforeExpiry("P30D"))); // Rotate 30 days before expirykeyClient.updateKeyRotationPolicy("my-key", policy);// Get rotation policyKeyRotationPolicy currentPolicy = keyClient.getKeyRotationPolicy("my-key");
Import Key
import com.azure.security.keyvault.keys.models.ImportKeyOptions;import com.azure.security.keyvault.keys.models.JsonWebKey;// Import existing key materialJsonWebKey jsonWebKey = new JsonWebKey().setKeyType(KeyType.RSA).setN(modulus).setE(exponent).setD(privateExponent)// ... other RSA components;ImportKeyOptions importOptions = new ImportKeyOptions("imported-key", jsonWebKey).setHardwareProtected(false);KeyVaultKey importedKey = keyClient.importKey(importOptions);
Encryption Algorithms
| Algorithm | Key Type | Description | |
|---|---|---|---|
RSA1_5 | RSA | RSAES-PKCS1-v1_5 | |
RSA_OAEP | RSA | RSAES with OAEP (recommended) | |
RSA_OAEP_256 | RSA | RSAES with OAEP using SHA-256 | |
A128GCM | OCT | AES-GCM 128-bit | |
A256GCM | OCT | AES-GCM 256-bit | |
A128CBC | OCT | AES-CBC 128-bit | |
A256CBC | OCT | AES-CBC 256-bit |
Signature Algorithms
| Algorithm | Key Type | Hash | |
|---|---|---|---|
RS256 | RSA | SHA-256 | |
RS384 | RSA | SHA-384 | |
RS512 | RSA | SHA-512 | |
PS256 | RSA | SHA-256 (PSS) | |
ES256 | EC P-256 | SHA-256 | |
ES384 | EC P-384 | SHA-384 | |
ES512 | EC P-521 | SHA-512 |
Error Handling
import com.azure.core.exception.HttpResponseException;import com.azure.core.exception.ResourceNotFoundException;try {KeyVaultKey key = keyClient.getKey("non-existent-key");} catch (ResourceNotFoundException e) {System.out.println("Key not found: " + e.getMessage());} catch (HttpResponseException e) {System.out.println("HTTP error " + e.getResponse().getStatusCode());System.out.println("Message: " + e.getMessage());}
Environment Variables
AZURE_KEYVAULT_URL=https://<vault-name>.vault.azure.net
Best Practices
- Use HSM Keys for Production - Set
setHardwareProtected(true)for sensitive keys - Enable Soft Delete - Protects against accidental deletion
- Key Rotation - Set up automatic rotation policies
- Least Privilege - Use separate keys for different operations
- Local Crypto When Possible - Use
CryptographyClientwith local key material to reduce round-trips
Trigger Phrases
- "Key Vault keys Java", "cryptographic keys Java"
- "encrypt decrypt Java", "sign verify Java"
- "RSA key", "EC key", "HSM key"
- "key rotation", "wrap unwrap key"
When to Use
This skill is applicable to execute the workflow or actions described in the overview.
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.