Skip to content

fix(NODE-6241): allow Binary as local KMS provider key #4160

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 2 commits into from
Jun 26, 2024
Merged

fix(NODE-6241): allow Binary as local KMS provider key #4160

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56b7ab1
fix(NODE-6241): allow `Binary` as local KMS provider key
addaleax Jun 25, 2024
9043877
Update src/client-side-encryption/providers/index.ts
addaleax Jun 25, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/client-side-encryption/providers/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { Binary } from '../../bson';
import { loadAWSCredentials } from './aws';
import { loadAzureCredentials } from './azure';
import { loadGCPCredentials } from './gcp';
Expand Down Expand Up @@ -39,7 +40,7 @@ export interface LocalKMSProviderConfiguration {
* The master key used to encrypt/decrypt data keys.
* A 96-byte long Buffer or base64 encoded string.
*/
key: Buffer | string;
key: Binary | Buffer | string;
}

/** @public */
Expand Down
6 changes: 5 additions & 1 deletion test/types/client-side-encryption.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import type {
KMSProviders,
RangeOptions
} from '../..';
import type { ClientEncryptionDataKeyProvider } from '../mongodb';
import { Binary, type ClientEncryptionDataKeyProvider } from '../mongodb';

type RequiredCreateEncryptedCollectionSettings = Parameters<
ClientEncryption['createEncryptedCollection']
Expand Down Expand Up @@ -51,6 +51,10 @@ expectAssignable<RequiredCreateEncryptedCollectionSettings>({

{
// KMSProviders
// local
expectAssignable<KMSProviders['local']>({ key: '' });
expectAssignable<KMSProviders['local']>({ key: Buffer.alloc(0) });
expectAssignable<KMSProviders['local']>({ key: Binary.createFromBase64('') });
// aws
expectAssignable<KMSProviders['aws']>({ accessKeyId: '', secretAccessKey: '' });
expectAssignable<KMSProviders['aws']>({
Expand Down