fix(NODE-2026): support SERVICE_REALM authentication mechanism property

mongodb · Jul 1, 2021 · c0544fa · c0544fa
1 parent 05035eb
commit c0544fa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 10 deletions.
diff --git a/src/cmap/auth/gssapi.ts b/src/cmap/auth/gssapi.ts
@@ -7,6 +7,7 @@ import type { Document } from '../../bson';
 type MechanismProperties = {
   gssapiCanonicalizeHostName?: boolean;
   SERVICE_NAME?: string;
+  SERVICE_REALM?: string;
 };
 
 import * as dns from 'dns';
@@ -90,14 +91,15 @@ function makeKerberosClient(authContext: AuthContext, callback: Callback<Kerbero
         Object.assign(initOptions, { user: username, password: password });
       }
 
-      initializeClient(
-        `${serviceName}${process.platform === 'win32' ? '/' : '@'}${host}`,
-        initOptions,
-        (err: string, client: KerberosClient): void => {
-          if (err) return callback(new MongoDriverError(err));
-          callback(undefined, client);
-        }
-      );
+      let spn = `${serviceName}${process.platform === 'win32' ? '/' : '@'}${host}`;
+      if ('SERVICE_REALM' in mechanismProperties) {
+        spn = `${spn}@${mechanismProperties.SERVICE_REALM}`;
+      }
+
+      initializeClient(spn, initOptions, (err: string, client: KerberosClient): void => {
+        if (err) return callback(new MongoDriverError(err));
+        callback(undefined, client);
+      });
     }
   );
 }

diff --git a/test/manual/kerberos.test.js b/test/manual/kerberos.test.js
@@ -50,8 +50,8 @@ describe('Kerberos', function () {
     });
   });
 
-  // TODO: this test only tests that these properties do not crash anything - but not that they actually have an effect
-  it('validate that SERVICE_REALM and CANONICALIZE_HOST_NAME can be passed in', function (done) {
+  // Unskip this test when a proper setup is available - see NODE-3060
+  it.skip('validate that SERVICE_REALM and CANONICALIZE_HOST_NAME can be passed in', function (done) {
     const client = new MongoClient(
       `${krb5Uri}&authMechanismProperties=SERVICE_NAME:mongodb,CANONICALIZE_HOST_NAME:false,SERVICE_REALM:windows&maxPoolSize=1`
     );