com.azure.security.keyvault.keys.implementation.KeyVaultKeysUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-security-keyvault-keys Show documentation
Show all versions of azure-security-keyvault-keys Show documentation
This module contains client library for Microsoft Azure KeyVault Keys.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.security.keyvault.keys.implementation;
import com.azure.core.exception.HttpResponseException;
import com.azure.core.exception.ResourceModifiedException;
import com.azure.core.exception.ResourceNotFoundException;
import com.azure.core.http.HttpPipeline;
import com.azure.core.util.CoreUtils;
import com.azure.core.util.logging.ClientLogger;
import com.azure.json.JsonReader;
import com.azure.security.keyvault.keys.KeyServiceVersion;
import com.azure.security.keyvault.keys.cryptography.CryptographyClientBuilder;
import com.azure.security.keyvault.keys.cryptography.CryptographyServiceVersion;
import com.azure.security.keyvault.keys.implementation.models.KeyVaultErrorException;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.time.Instant;
import java.time.OffsetDateTime;
import java.time.ZoneOffset;
import java.util.Base64;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;
/**
* Utility class for KeyVault Keys.
*/
public final class KeyVaultKeysUtils {
private static final ClientLogger LOGGER = new ClientLogger(KeyVaultKeysUtils.class);
/**
* Creates a {@link CryptographyClientBuilder} based on the values passed from a Keys service client.
*
* @param keyName The name of the key.
* @param keyVersion The version of the key.
* @param vaultUrl The URL of the KeyVault.
* @param httpPipeline The HttpPipeline to use for the CryptographyClient.
* @param serviceVersion The KeyServiceVersion of the service.
* @return A new {@link CryptographyClientBuilder} with the values passed from a Keys service client.
* @throws IllegalArgumentException If {@code keyName} is null or empty.
*/
public static CryptographyClientBuilder getCryptographyClientBuilder(String keyName, String keyVersion,
String vaultUrl, HttpPipeline httpPipeline, KeyServiceVersion serviceVersion) {
if (CoreUtils.isNullOrEmpty(keyName)) {
throw LOGGER.logExceptionAsError(new IllegalArgumentException("'keyName' cannot be null or empty."));
}
return new CryptographyClientBuilder()
.keyIdentifier(generateKeyId(keyName, keyVersion, vaultUrl))
.pipeline(httpPipeline)
.serviceVersion(CryptographyServiceVersion.valueOf(serviceVersion.name()));
}
/**
* Generates a KeyVault Key ID from the name and version of the key and the KeyVault URL.
*
* @param keyName The name of the key.
* @param keyVersion The version of the key.
* @param vaultUrl The URL of the KeyVault.
* @return The KeyVault Key ID.
*/
private static String generateKeyId(String keyName, String keyVersion, String vaultUrl) {
StringBuilder stringBuilder = new StringBuilder(vaultUrl);
if (!vaultUrl.endsWith("/")) {
stringBuilder.append("/");
}
stringBuilder.append("keys/").append(keyName);
if (!CoreUtils.isNullOrEmpty(keyVersion)) {
stringBuilder.append("/").append(keyVersion);
}
return stringBuilder.toString();
}
/**
* Calls a supplier and maps any {@link KeyVaultErrorException} to an {@link HttpResponseException}.
*
* @param The type of the result of the supplier.
* @param call The supplier to call.
* @param exceptionMapper The function to map a {@link KeyVaultErrorException} to an {@link HttpResponseException}.
* @return The result of the supplier.
*/
public static T callWithMappedException(Supplier call,
Function exceptionMapper) {
try {
return call.get();
} catch (KeyVaultErrorException ex) {
throw exceptionMapper.apply(ex);
}
}
/**
* Maps a {@link KeyVaultErrorException} to an {@link HttpResponseException} for get key operations.
*
* @param ex The {@link KeyVaultErrorException} to map.
* @return The {@link HttpResponseException} that maps from the {@link KeyVaultErrorException}.
*/
public static HttpResponseException mapGetKeyException(KeyVaultErrorException ex) {
if (ex.getResponse().getStatusCode() == 403) {
return new ResourceModifiedException(ex.getMessage(), ex.getResponse(), ex.getValue());
} else if (ex.getResponse().getStatusCode() == 404) {
return new ResourceNotFoundException(ex.getMessage(), ex.getResponse(), ex.getValue());
} else {
return ex;
}
}
/**
* Unpacks a Key Vault key ID into a name and version.
*
* @param id The Key Vault key ID to unpack.
* @param nameConsumer The consumer to accept the name.
* @param versionConsumer The consumer to accept the version.
*/
public static void unpackId(String id, Consumer nameConsumer, Consumer versionConsumer) {
if (CoreUtils.isNullOrEmpty(id)) {
return;
}
try {
URL url = new URL(id);
String[] tokens = url.getPath().split("/");
if (tokens.length >= 3) {
nameConsumer.accept(tokens[2]);
}
if (tokens.length >= 4) {
versionConsumer.accept(tokens[3]);
}
} catch (MalformedURLException e) {
// Should never come here.
LOGGER.error("Received Malformed Secret Id URL from KV Service");
}
}
/**
* Converts epoch time to OffsetDateTime.
*
* @param epochReader The JsonReader containing the epoch time.
* @return The OffsetDateTime.
* @throws IOException If an error occurs while reading the epoch time.
*/
public static OffsetDateTime epochToOffsetDateTime(JsonReader epochReader) throws IOException {
Instant instant = Instant.ofEpochMilli(epochReader.getLong() * 1000L);
return OffsetDateTime.ofInstant(instant, ZoneOffset.UTC);
}
/**
* Base64 URL encodes the binary value.
*
* Returns null if the {@code value} is null, returns an empty string if the {@code value} is empty.
*
* @param value The binary value to base64 URL encode.
* @return The base64 URL encoded value.
*/
public static String base64UrlJsonSerialization(byte[] value) {
if (value == null) {
return null;
} else if (value.length == 0) {
return "";
} else {
return Base64.getUrlEncoder().withoutPadding().encodeToString(value);
}
}
/**
* Base64 URL decodes the string value.
*
* @param value The string value to base64 URL decode.
* @return The base64 URL decoded value.
*/
public static byte[] base64UrlJsonDeserialization(String value) {
return value == null ? null : Base64.getUrlDecoder().decode(value);
}
}