Skip to content

fix(shell-api): rename kmsProvider to kmsProviders MONGOSH-604 #664

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
Feb 16, 2021
Merged

fix(shell-api): rename kmsProvider to kmsProviders MONGOSH-604 #664

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions packages/cli-repl/src/smoke-tests-fle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const local = { key: Buffer.from('kh4Gv2N8qopZQMQYMEtww/AkPsIrXNmEMxTrs3tUoTQZbZ

const keyMongo = Mongo(db.getMongo()._uri, {
keyVaultNamespace: 'encryption.__keyVault',
kmsProvider: { local }
kmsProviders: { local }
});

const keyVault = keyMongo.getKeyVault();
Expand All @@ -60,7 +60,7 @@ console.log('Using schema map', schemaMap);

const autoMongo = Mongo(db.getMongo()._uri, {
keyVaultNamespace: 'encryption.__keyVault',
kmsProvider: { local },
kmsProviders: { local },
schemaMap
});

Expand Down
2 changes: 1 addition & 1 deletion packages/cli-repl/test/e2e-fle.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ describe('FLE tests', () => {
await shell.executeLine('local = { key: BinData(0, "kh4Gv2N8qopZQMQYMEtww/AkPsIrXNmEMxTrs3tUoTQZbZu4msdRUaR8U5fXD7A7QXYHcEvuu4WctJLoT+NvvV3eeIg3MD+K8H9SR794m/safgRHdIfy6PD+rFpvmFbY") }');
await shell.executeLine(`keyMongo = Mongo(${JSON.stringify(await testServer.connectionString())}, { \
keyVaultNamespace: '${dbname}.keyVault', \
kmsProvider: { local }, \
kmsProviders: { local }, \
explicitEncryptionOnly: true \
});`);
await shell.executeLine('keyVault = keyMongo.getKeyVault();');
Expand Down
10 changes: 5 additions & 5 deletions packages/shell-api/src/field-level-encryption.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const SCHEMA_MAP = {
};
const AWS_KMS = {
keyVaultNamespace: `${DB}.${COLL}`,
kmsProvider: {
kmsProviders: {
aws: {
accessKeyId: 'abc',
secretAccessKey: '123'
Expand Down Expand Up @@ -143,7 +143,7 @@ describe('Field Level Encryption', () => {
{
keyVaultClient: undefined,
keyVaultNamespace: AWS_KMS.keyVaultNamespace,
kmsProviders: AWS_KMS.kmsProvider,
kmsProviders: AWS_KMS.kmsProviders,
bypassAutoEncryption: AWS_KMS.bypassAutoEncryption,
schemaMap: AWS_KMS.schemaMap
}
Expand Down Expand Up @@ -393,7 +393,7 @@ describe('Field Level Encryption', () => {
it('accepts the same local key twice', () => {
const localKmsOptions: ClientSideFieldLevelEncryptionOptions = {
keyVaultNamespace: `${DB}.${COLL}`,
kmsProvider: {
kmsProviders: {
local: {
key: new bson.Binary(Buffer.alloc(96).toString('base64'))
}
Expand All @@ -409,7 +409,7 @@ describe('Field Level Encryption', () => {
it('fails if both explicitEncryptionOnly and schemaMap are passed', () => {
const localKmsOptions: ClientSideFieldLevelEncryptionOptions = {
keyVaultNamespace: `${DB}.${COLL}`,
kmsProvider: {
kmsProviders: {
local: {
key: new bson.Binary(Buffer.alloc(96).toString('base64'))
}
Expand Down Expand Up @@ -521,7 +521,7 @@ srDVjIT3LsvTqw==`
it(`provides ClientEncryption for kms=${kmsName}`, async() => {
const mongo = new Mongo(internalState, uri, {
keyVaultNamespace: `${dbname}.__keyVault`,
kmsProvider: { [kmsName]: kmsOptions } as any,
kmsProviders: { [kmsName]: kmsOptions } as any,
explicitEncryptionOnly: true
}, serviceProvider);
await mongo.connect();
Expand Down
2 changes: 1 addition & 1 deletion packages/shell-api/src/field-level-encryption.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export type ClientSideFieldLevelEncryptionKmsProvider = Omit<KMSProviders, 'loca
export interface ClientSideFieldLevelEncryptionOptions {
keyVaultClient?: Mongo,
keyVaultNamespace: string,
kmsProvider: ClientSideFieldLevelEncryptionKmsProvider,
kmsProviders: ClientSideFieldLevelEncryptionKmsProvider,
schemaMap?: Document,
bypassAutoEncryption?: boolean;
explicitEncryptionOnly?: boolean;
Expand Down
10 changes: 5 additions & 5 deletions packages/shell-api/src/helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,9 +614,9 @@ export function assertCLI(platform: ReplPlatform): void {
}

export function processFLEOptions(fleOptions: ClientSideFieldLevelEncryptionOptions): AutoEncryptionOptions {
assertArgsDefined(fleOptions.keyVaultNamespace, fleOptions.kmsProvider);
assertArgsDefined(fleOptions.keyVaultNamespace, fleOptions.kmsProviders);
Object.keys(fleOptions).forEach(k => {
if (['keyVaultClient', 'keyVaultNamespace', 'kmsProvider', 'schemaMap', 'bypassAutoEncryption'].indexOf(k) === -1) {
if (['keyVaultClient', 'keyVaultNamespace', 'kmsProviders', 'schemaMap', 'bypassAutoEncryption'].indexOf(k) === -1) {
throw new MongoshInvalidInputError(`Unrecognized FLE Client Option ${k}`);
}
});
Expand All @@ -625,12 +625,12 @@ export function processFLEOptions(fleOptions: ClientSideFieldLevelEncryptionOpti
keyVaultNamespace: fleOptions.keyVaultNamespace
};

const localKey = fleOptions.kmsProvider.local?.key;
const localKey = fleOptions.kmsProviders.local?.key;
if (localKey && (localKey as BinaryType)._bsontype === 'Binary') {
const rawBuff = (localKey as BinaryType).value(true);
if (Buffer.isBuffer(rawBuff)) {
autoEncryption.kmsProviders = {
...fleOptions.kmsProvider,
...fleOptions.kmsProviders,
local: {
key: rawBuff
}
Expand All @@ -639,7 +639,7 @@ export function processFLEOptions(fleOptions: ClientSideFieldLevelEncryptionOpti
throw new MongoshInvalidInputError('When specifying the key of a local KMS as BSON binary it must be constructed from a base64 encoded string');
}
} else {
autoEncryption.kmsProviders = { ...fleOptions.kmsProvider } as KMSProviders;
autoEncryption.kmsProviders = { ...fleOptions.kmsProviders } as KMSProviders;
}

if (fleOptions.schemaMap) {
Expand Down
16 changes: 8 additions & 8 deletions packages/shell-api/src/shell-api.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ describe('ShellApi', () => {
it(`local kms provider - key is ${type}`, async() => {
await internalState.shellApi.Mongo('dbname', {
keyVaultNamespace: 'encryption.dataKeys',
kmsProvider: {
kmsProviders: {
local: {
key: key
}
Expand All @@ -239,7 +239,7 @@ describe('ShellApi', () => {
it('aws kms provider', async() => {
await internalState.shellApi.Mongo('dbname', {
keyVaultNamespace: 'encryption.dataKeys',
kmsProvider: {
kmsProviders: {
aws: {
accessKeyId: 'abc',
secretAccessKey: '123'
Expand All @@ -259,7 +259,7 @@ describe('ShellApi', () => {
it('local kms provider with current as Mongo', async() => {
await internalState.shellApi.Mongo('dbname', {
keyVaultNamespace: 'encryption.dataKeys',
kmsProvider: {
kmsProviders: {
local: {
key: Buffer.from(b641234, 'base64')
}
Expand All @@ -283,7 +283,7 @@ describe('ShellApi', () => {
const m = new Mongo({ initialServiceProvider: sp } as any, 'dbName', undefined, sp);
await internalState.shellApi.Mongo('dbname', {
keyVaultNamespace: 'encryption.dataKeys',
kmsProvider: {
kmsProviders: {
local: {
key: Buffer.from(b641234, 'base64')
}
Expand All @@ -303,7 +303,7 @@ describe('ShellApi', () => {
it('throws if missing namespace', async() => {
try {
await internalState.shellApi.Mongo('dbname', {
kmsProvider: {
kmsProviders: {
aws: {
accessKeyId: 'abc',
secretAccessKey: '123'
Expand All @@ -315,7 +315,7 @@ describe('ShellApi', () => {
}
expect.fail('failed to throw expected error');
});
it('throws if missing kmsProvider', async() => {
it('throws if missing kmsProviders', async() => {
try {
await internalState.shellApi.Mongo('dbname', {
keyVaultNamespace: 'encryption.dataKeys'
Expand All @@ -329,7 +329,7 @@ describe('ShellApi', () => {
try {
await internalState.shellApi.Mongo('dbname', {
keyVaultNamespace: 'encryption.dataKeys',
kmsProvider: {
kmsProviders: {
aws: {
accessKeyId: 'abc',
secretAccessKey: '123'
Expand All @@ -345,7 +345,7 @@ describe('ShellApi', () => {
it('passes along optional arguments', async() => {
await internalState.shellApi.Mongo('dbname', {
keyVaultNamespace: 'encryption.dataKeys',
kmsProvider: {
kmsProviders: {
local: {
key: Buffer.from(b641234, 'base64')
}
Expand Down