chore: replace references to csfle shared library MONGOSH-1237 (#1297)

Author: addaleax

config/build.conf.js

@@ -50,10 +50,10 @@ const EXECUTABLE_PATH = path.join(OUTPUT_DIR, process.platform === 'win32' ? 'mo
 
 /**
  * The path to the downloaded csfe shared library.
- * We use the name mongosh_csfle_v1 to avoid conflicts with users
- * potentially installing the 'proper' csfle shared library.
+ * We use the name mongosh_crypt_v1 to avoid conflicts with users
+ * potentially installing the 'proper' crypt shared library.
  */
-const CSFLE_LIBRARY_PATH = path.resolve(TMP_DIR, 'mongosh_csfle_v1.' + SHARED_LIBRARY_SUFFIX);
+const CRYPT_LIBRARY_PATH = path.resolve(TMP_DIR, 'mongosh_crypt_v1.' + SHARED_LIBRARY_SUFFIX);
 
 /**
  * Build info JSON data file.
@@ -119,7 +119,7 @@ module.exports = {
     repo: 'mongosh'
   },
   artifactUrlFile: process.env.ARTIFACT_URL_FILE,
-  csfleLibraryPath: CSFLE_LIBRARY_PATH,
+  cryptSharedLibPath: CRYPT_LIBRARY_PATH,
   packageInformation: {
     binaries: [
       {
@@ -134,11 +134,11 @@ module.exports = {
         }
       },
       {
-        sourceFilePath: CSFLE_LIBRARY_PATH,
+        sourceFilePath: CRYPT_LIBRARY_PATH,
         category: 'lib',
         license: {
-          sourceFilePath: path.resolve(__dirname, '..', 'packaging', 'LICENSE-csfle'),
-          packagedFilePath: 'LICENSE-csfle',
+          sourceFilePath: path.resolve(__dirname, '..', 'packaging', 'LICENSE-crypt-library'),
+          packagedFilePath: 'LICENSE-crypt-library',
           debCopyright: COPYRIGHT,
           debIdentifier: 'Proprietary',
           rpmIdentifier: 'Proprietary'

package-lock.json

@@ -124,7 +124,7 @@
     "lerna": "^4.0.0",
     "mocha": "^7.1.2",
     "mongodb": "^4.6.0",
-    "mongodb-download-url": "^1.2.1",
+    "mongodb-download-url": "^1.2.2",
     "mongodb-js-precommit": "^2.0.0",
     "nock": "^13.0.11",
     "node-codesign": "^0.3.3",

package.json

@@ -105,7 +105,10 @@ const MAPPINGS: {
   awsSecretAccessKey: (i, v) => setAWSKMS(i, 'secretAccessKey', v),
   awsSessionToken: (i, v) => setAWSKMS(i, 'sessionToken', v),
   awsIamSessionToken: (i, v) => setAuthMechProp(i, 'AWS_SESSION_TOKEN', v),
-  csfleLibraryPath: (i, v) => setAutoEncryptExtra(i, 'csflePath', v),
+  // @ts-expect-error AutoEncryption options have been renamed, drop the (outer) csflePath call after the next release
+  csfleLibraryPath: (i, v) => setAutoEncryptExtra(setAutoEncryptExtra(i, 'cryptSharedLibPath', v), 'csflePath', v),
+  // @ts-expect-error AutoEncryption options have been renamed, drop the (outer) csflePath call after the next release
+  cryptSharedLibPath: (i, v) => setAutoEncryptExtra(setAutoEncryptExtra(i, 'cryptSharedLibPath', v), 'csflePath', v),
   gssapiServiceName: (i, v) => setAuthMechProp(i, 'SERVICE_NAME', v),
   sspiRealmOverride: (i, v) => setAuthMechProp(i, 'SERVICE_REALM', v),
   sspiHostnameCanonicalization:

packages/arg-parser/src/arg-mapper.ts

@@ -17,6 +17,7 @@ export interface CliOptions {
   awsSecretAccessKey?: string;
   awsSessionToken?: string;
   csfleLibraryPath?: string;
+  cryptSharedLibPath?: string;
   db?: string;
   eval?: string;
   gssapiServiceName?: string;

packages/arg-parser/src/cli-options.ts

@@ -93,9 +93,9 @@ export class SignableCompiler {
       path: await findModulePath('service-provider-server', 'os-dns-native'),
       requireRegexp: /\bos_dns_native\.node$/
     };
-    const csfleLibraryVersionAddon = {
-      path: await findModulePath('cli-repl', 'mongodb-csfle-library-version'),
-      requireRegexp: /\bmongodb_csfle_library_version\.node$/
+    const cryptLibraryVersionAddon = {
+      path: await findModulePath('cli-repl', 'mongodb-crypt-library-version'),
+      requireRegexp: /\bmongodb_crypt_library_version\.node$/
     };
     // Warning! Until https://jira.mongodb.org/browse/MONGOSH-990,
     // packages/service-provider-server *also* has a copy of these.
@@ -137,7 +137,7 @@ export class SignableCompiler {
         fleAddon,
         osDnsAddon,
         kerberosAddon,
-        csfleLibraryVersionAddon
+        cryptLibraryVersionAddon
       ].concat(winCAAddon ? [
         winCAAddon
       ] : []).concat(winConsoleProcessListAddon ? [

packages/build/src/compile/signable-compiler.ts

@@ -40,7 +40,7 @@ export interface Config {
   };
   isPatch?: boolean;
   triggeringGitTag?: string;
-  csfleLibraryPath: string;
+  cryptSharedLibPath: string;
   packageInformation?: PackageInformation;
   artifactUrlFile?: string;
   manpage?: ManPageConfig;

packages/build/src/config/config.ts

@@ -17,7 +17,7 @@ export function redactConfig(config: Config): Partial<Config> {
     repo: config.repo,
     isPatch: config.isPatch,
     packageInformation: config.packageInformation,
-    csfleLibraryPath: config.csfleLibraryPath,
+    cryptSharedLibPath: config.cryptSharedLibPath,
     artifactUrlFile: config.artifactUrlFile,
     isDryRun: config.isDryRun
   };

packages/build/src/config/redact-config.ts

@@ -25,7 +25,7 @@ export async function downloadMongoDb(tmpdir: string, targetVersionSemverSpecifi
 
   await fs.mkdir(tmpdir, { recursive: true });
   if (targetVersionSemverSpecifier === 'latest-alpha') {
-    return await doDownload(tmpdir, !!options.csfle, 'latest-alpha', lookupDownloadUrl);
+    return await doDownload(tmpdir, !!options.crypt_shared, 'latest-alpha', lookupDownloadUrl);
   }
 
   if (/-community$/.test(targetVersionSemverSpecifier)) {
@@ -35,15 +35,15 @@ export async function downloadMongoDb(tmpdir: string, targetVersionSemverSpecifi
 
   return await doDownload(
     tmpdir,
-    !!options.csfle,
+    !!options.crypt_shared,
     targetVersionSemverSpecifier + (wantsEnterprise ? '-enterprise' : '-community'),
     () => lookupDownloadUrl());
 }
 
 const downloadPromises: Record<string, Promise<string>> = {};
 async function doDownload(
   tmpdir: string,
-  isCsfle: boolean,
+  isCryptLibrary: boolean,
   version: string,
   lookupDownloadUrl: () => Promise<string>) {
   const downloadTarget = path.resolve(
@@ -53,7 +53,7 @@ async function doDownload(
   return downloadPromises[downloadTarget] ??= (async() => {
     const bindir = path.resolve(
       downloadTarget,
-      isCsfle && process.platform !== 'win32' ? 'lib' : 'bin');
+      isCryptLibrary && process.platform !== 'win32' ? 'lib' : 'bin');
     try {
       await fs.stat(bindir);
       console.info(`Skipping download because ${downloadTarget} exists`);
@@ -71,10 +71,10 @@ async function doDownload(
         const response = await fetch(url);
         await promisify(pipeline)(
           response.body,
-          tar.x({ cwd: downloadTarget, strip: isCsfle ? 0 : 1 })
+          tar.x({ cwd: downloadTarget, strip: isCryptLibrary ? 0 : 1 })
         );
       } else {
-        await download(url, downloadTarget, { extract: true, strip: isCsfle ? 0 : 1 });
+        await download(url, downloadTarget, { extract: true, strip: isCryptLibrary ? 0 : 1 });
       }
 
       try {

packages/build/src/download-mongodb.ts

@@ -4,36 +4,36 @@ import { promises as fs, constants as fsConstants } from 'fs';
 import { downloadMongoDb, DownloadOptions } from '../download-mongodb';
 import { BuildVariant, getDistro, getArch } from '../config';
 
-export async function downloadCsfleLibrary(variant: BuildVariant | 'host'): Promise<string> {
+export async function downloadCryptLibrary(variant: BuildVariant | 'host'): Promise<string> {
   const opts: DownloadOptions = {};
   opts.arch = variant === 'host' ? undefined : getArch(variant);
   opts.distro = variant === 'host' ? undefined : lookupReleaseDistro(variant);
   opts.enterprise = true;
-  opts.csfle = true;
-  console.info('mongosh: downloading latest csfle shared library for inclusion in package:', JSON.stringify(opts));
+  opts.crypt_shared = true;
+  console.info('mongosh: downloading latest crypt shared library for inclusion in package:', JSON.stringify(opts));
 
   let libdir = '';
-  const csfleTmpTargetDir = path.resolve(__dirname, '..', '..', '..', '..', 'tmp', 'csfle-store', variant);
+  const cryptTmpTargetDir = path.resolve(__dirname, '..', '..', '..', '..', 'tmp', 'crypt-store', variant);
   // Download mongodb for latest server version. Fall back to the 6.0.0-rcX
   // version if no stable version is available.
   let error: Error | undefined;
   for (const version of [ 'stable', '>= 6.0.0-rc5' ]) {
     try {
-      libdir = await downloadMongoDb(csfleTmpTargetDir, version, opts);
+      libdir = await downloadMongoDb(cryptTmpTargetDir, version, opts);
       break;
     } catch (e: any) {
       error = e;
     }
   }
   if (!libdir) throw error;
-  const csfleLibrary = path.join(
+  const cryptLibrary = path.join(
     libdir,
-    (await fs.readdir(libdir)).find(filename => filename.match(/^mongo_csfle_v1\.(so|dylib|dll)$/)) as string
+    (await fs.readdir(libdir)).find(filename => filename.match(/^mongo_crypt_v1\.(so|dylib|dll)$/)) as string
   );
   // Make sure that the binary exists and is readable.
-  await fs.access(csfleLibrary, fsConstants.R_OK);
-  console.info('mongosh: downloaded', csfleLibrary);
-  return csfleLibrary;
+  await fs.access(cryptLibrary, fsConstants.R_OK);
+  console.info('mongosh: downloaded', cryptLibrary);
+  return cryptLibrary;
 }
 
 function lookupReleaseDistro(variant: BuildVariant): string {