Skip to content

Use strong type for parseKeyVaultSecretIdentifier #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2025
Merged

Use strong type for parseKeyVaultSecretIdentifier #193

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions src/keyvault/AzureKeyVaultKeyValueAdapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ConfigurationSetting, isSecretReference, parseSecretReference } from "@
import { IKeyValueAdapter } from "../IKeyValueAdapter.js";
import { KeyVaultOptions } from "./KeyVaultOptions.js";
import { ArgumentError, KeyVaultReferenceError } from "../common/error.js";
import { SecretClient, parseKeyVaultSecretIdentifier } from "@azure/keyvault-secrets";
import { KeyVaultSecretIdentifier, SecretClient, parseKeyVaultSecretIdentifier } from "@azure/keyvault-secrets";
import { isRestError } from "@azure/core-rest-pipeline";
import { AuthenticationError } from "@azure/identity";

Expand All @@ -29,32 +29,28 @@ export class AzureKeyVaultKeyValueAdapter implements IKeyValueAdapter {
if (!this.#keyVaultOptions) {
throw new ArgumentError("Failed to process the Key Vault reference because Key Vault options are not configured.");
}
let secretName, vaultUrl, sourceId, version;
let secretIdentifier: KeyVaultSecretIdentifier;
try {
const { name: parsedName, vaultUrl: parsedVaultUrl, sourceId: parsedSourceId, version: parsedVersion } = parseKeyVaultSecretIdentifier(
secretIdentifier = parseKeyVaultSecretIdentifier(
parseSecretReference(setting).value.secretId
);
secretName = parsedName;
vaultUrl = parsedVaultUrl;
sourceId = parsedSourceId;
version = parsedVersion;
} catch (error) {
throw new KeyVaultReferenceError(buildKeyVaultReferenceErrorMessage("Invalid Key Vault reference.", setting), { cause: error });
}

try {
// precedence: secret clients > credential > secret resolver
const client = this.#getSecretClient(new URL(vaultUrl));
const client = this.#getSecretClient(new URL(secretIdentifier.vaultUrl));
if (client) {
const secret = await client.getSecret(secretName, { version });
const secret = await client.getSecret(secretIdentifier.name, { version: secretIdentifier.version });
return [setting.key, secret.value];
}
if (this.#keyVaultOptions.secretResolver) {
return [setting.key, await this.#keyVaultOptions.secretResolver(new URL(sourceId))];
return [setting.key, await this.#keyVaultOptions.secretResolver(new URL(secretIdentifier.sourceId))];
}
} catch (error) {
if (isRestError(error) || error instanceof AuthenticationError) {
throw new KeyVaultReferenceError(buildKeyVaultReferenceErrorMessage("Failed to resolve Key Vault reference.", setting, sourceId), { cause: error });
throw new KeyVaultReferenceError(buildKeyVaultReferenceErrorMessage("Failed to resolve Key Vault reference.", setting, secretIdentifier.sourceId), { cause: error });
}
throw error;
}
Expand Down