Skip to content

feat(signatures): allow using alternate google-kms client implementation #45

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
Mythie merged 1 commit into from
Mar 6, 2026
Merged

feat(signatures): allow using alternate google-kms client implementation #45

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
17 changes: 10 additions & 7 deletions src/signatures/signers/google-kms.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ import type { DigestAlgorithm, KeyType, SignatureAlgorithm, Signer } from "../ty

/** KMS client type - dynamically imported */
type KeyManagementServiceClient = import("@google-cloud/kms").KeyManagementServiceClient;
/** Subset of methods actually used for signing */
type KmsClient = Pick<
KeyManagementServiceClient,
"asymmetricSign" | "getCryptoKeyVersion" | "getPublicKey"
>;

/** Secret Manager client type - dynamically imported */
type SecretManagerServiceClient = import("@google-cloud/secret-manager").SecretManagerServiceClient;
Expand All @@ -41,7 +46,7 @@ interface GoogleKmsSignerBaseOptions {
chainTimeout?: number;

/** Pre-configured KMS client (optional, uses ADC if not provided) */
client?: KeyManagementServiceClient;
client?: KmsClient;
}

/** Full resource name style */
Expand Down Expand Up @@ -356,10 +361,10 @@ export class GoogleKmsSigner implements Signer {
/** Full resource name of the KMS key version (for logging/debugging) */
readonly keyVersionName: string;

private readonly client: KeyManagementServiceClient;
private readonly client: KmsClient;

private constructor(
client: KeyManagementServiceClient,
client: KmsClient,
keyVersionName: string,
certificate: Uint8Array,
certificateChain: Uint8Array[],
Expand Down Expand Up @@ -403,16 +408,14 @@ export class GoogleKmsSigner implements Signer {
* ```
*/
static async create(options: GoogleKmsSignerOptions): Promise<GoogleKmsSigner> {
// Dynamically import KMS
const kms = await importKms();

// Build full resource name if shorthand
const keyVersionName = isFullNameOptions(options)
? options.keyVersionName
: buildKeyVersionName(options);

// Create or use provided client
const client = options.client ?? new kms.KeyManagementServiceClient();
// Dynamically import KMS only if client was not provided
const client = options.client ?? new (await importKms()).KeyManagementServiceClient();

try {
// Fetch key version metadata
Expand Down