Merge pull request #972 from kriswest/909-ldap-user-group-confirmation

JamieSlome · web-flow · commit 9d96614f4213 · 2025-06-16T15:45:55.000+01:00
feat: support direct querying of AD group membership via LDAP
diff --git a/config.schema.json b/config.schema.json
@@ -10,7 +10,32 @@
     "sessionMaxAgeHours": { "type": "number" },
     "api": {
       "description": "Third party APIs",
-      "type": "object"
+      "type": "object",
+      "properties": {
+        "ls": {
+          "type": "object",
+          "description": "Configuration used in conjunction with ActiveDirectory auth, which relates to a REST API used to check user group membership, as opposed to direct querying via LDAP.<br />If this configuration is set direct querying of group membership via LDAP will be disabled.",
+          "properties": {
+            "userInADGroup": {
+              "type": "string",
+              "description": "URL template for a GET request that confirms a user's membership of a specific group. Should respond with a non-empty 200 status if the user is a member of the group, an empty response or non-200 status indicates that the user is not a group member. If set, this URL will be queried and direct queries via LDAP will be disabled. The template should contain the following string placeholders, which will be replaced to produce the final URL:<ul><li>\"&lt;domain&gt;\": AD domain,</li><li>\"&lt;name&gt;\": The group name to check membership of.</li><li>\"&lt;id&gt;\": The username to check group membership for.</li></ul>",
+              "examples": [
+                "https://somedomain.com/some/path/checkUserGroups?domain=<domain>&name=<name>&id=<id>"
+              ]
+            }
+          }
+        },
+        "github": {
+          "type": "object",
+          "properties": {
+            "baseUrl": {
+              "type": "string",
+              "format": "uri",
+              "examples": ["https://api.github.com"]
+            }
+          }
+        }
+      }
     },
     "commitConfig": {
       "description": "Enforce rules and patterns on commits including e-mail and message",
@@ -169,12 +194,98 @@
     },
     "authentication": {
       "type": "object",
-      "properties": {
-        "type": { "type": "string" },
-        "enabled": { "type": "boolean" },
-        "options": { "type": "object" }
-      },
-      "required": ["type", "enabled"]
+      "description": "Configuration for an authentication source",
+      "oneOf": [
+        {
+          "title": "Local Auth Config",
+          "description": "Configuration for the use of the local database as the authentication source.",
+          "properties": {
+            "type": { "type": "string", "const": "local" },
+            "enabled": { "type": "boolean" }
+          },
+          "required": ["type", "enabled"]
+        },
+        {
+          "title": "Active Directory Auth Config",
+          "description": "Configuration for Active Directory authentication.",
+          "properties": {
+            "type": { "type": "string", "const": "ActiveDirectory" },
+            "enabled": { "type": "boolean" },
+            "adminGroup": {
+              "type": "string",
+              "description": "Group that indicates that a user is an admin"
+            },
+            "userGroup": {
+              "type": "string",
+              "description": "Group that indicates that a user should be able to login to the Git Proxy UI and can work as a reviewer"
+            },
+            "domain": { "type": "string", "description": "Active Directory domain" },
+            "adConfig": {
+              "type": "object",
+              "description": "Additional Active Directory configuration supporting LDAP connection which can be used to confirm group membership. For the full set of available options see the activedirectory 2 NPM module docs at https://www.npmjs.com/package/activedirectory2#activedirectoryoptions <br /><br />Please note that if the Third Party APIs config `api.ls.userInADGroup` is set then the REST API it represents is used in preference to direct querying of group memebership via LDAP.",
+              "properties": {
+                "url": {
+                  "type": "string",
+                  "description": "Active Directory server to connect to, e.g. `ldap://ad.example.com`."
+                },
+                "baseDN": {
+                  "type": "string",
+                  "description": "The root DN from which all searches will be performed, e.g. `dc=example,dc=com`."
+                },
+                "username": {
+                  "type": "string",
+                  "description": "An account name capable of performing the operations desired."
+                },
+                "password": {
+                  "type": "string",
+                  "description": "Password for the given `username`."
+                }
+              },
+              "required": ["url", "baseDN", "username", "password"]
+            }
+          },
+          "required": ["type", "enabled", "adminGroup", "userGroup", "domain"]
+        },
+        {
+          "title": "Open ID Connect Auth Config",
+          "description": "Configuration for Open ID Connect authentication.",
+          "properties": {
+            "type": { "type": "string", "const": "openidconnect" },
+            "enabled": { "type": "boolean" },
+            "oidcConfig": {
+              "type": "object",
+              "description": "Additional OIDC configuration.",
+              "properties": {
+                "issuer": { "type": "string" },
+                "clientID": { "type": "string" },
+                "clientSecret": { "type": "string" },
+                "callbackURL": { "type": "string" },
+                "scope": { "type": "string" }
+              },
+              "required": ["issuer", "clientID", "clientSecret", "callbackURL", "scope"]
+            }
+          },
+          "required": ["type", "enabled", "oidcConfig"]
+        },
+        {
+          "title": "JWT Auth Config",
+          "description": "Configuration for JWT authentication.",
+          "properties": {
+            "type": { "type": "string", "const": "jwt" },
+            "enabled": { "type": "boolean" },
+            "jwtConfig": {
+              "type": "object",
+              "description": "Additional JWT configuration.",
+              "properties": {
+                "clientID": { "type": "string" },
+                "authorityURL": { "type": "string" }
+              },
+              "required": ["clientID", "authorityURL"]
+            }
+          },
+          "required": ["type", "enabled", "jwtConfig"]
+        }
+      ]
     },
     "routeAuthRule": {
       "type": "object",
diff --git a/proxy.config.json b/proxy.config.json
@@ -51,7 +51,9 @@
       "adConfig": {
         "url": "",
         "baseDN": "",
-        "searchBase": ""
+        "searchBase": "",
+        "username": "",
+        "password": ""
       }
     },
     {
diff --git a/src/config/index.ts b/src/config/index.ts
@@ -87,7 +87,7 @@ export const getDatabase = () => {
     }
   }
 
-  throw Error('No database cofigured!');
+  throw Error('No database configured!');
 };
 
 /**
diff --git a/src/service/passport/activeDirectory.js b/src/service/passport/activeDirectory.js
@@ -31,18 +31,35 @@ const configure = (passport) => {
           profile.id = profile.username;
           req.user = profile;
 
-          // First check to see if the user is in the usergroups
-          const isUser = await ldaphelper.isUserInAdGroup(profile.username, domain, userGroup);
-
-          if (!isUser) {
-            const message = `User it not a member of ${userGroup}`;
+          console.log(
+            `passport.activeDirectory: resolved login ${
+              profile._json.userPrincipalName
+            }, profile=${JSON.stringify(profile)}`,
+          );
+          // First check to see if the user is in the AD user group
+          try {
+            const isUser = await ldaphelper.isUserInAdGroup(req, profile, ad, domain, userGroup);
+            if (!isUser) {
+              const message = `User it not a member of ${userGroup}`;
+              return done(message, null);
+            }
+          } catch (e) {
+            const message = `An error occurred while checking if the user is a member of the user group: ${JSON.stringify(e)}`;
             return done(message, null);
           }
-
+        
           // Now check if the user is an admin
-          const isAdmin = await ldaphelper.isUserInAdGroup(profile.username, domain, adminGroup);
+          let isAdmin = false;
+          try {
+            isAdmin = await ldaphelper.isUserInAdGroup(req, profile, ad, domain, adminGroup);
+
+          } catch (e) {
+            const message = `An error occurred while checking if the user is a member of the admin group: ${JSON.stringify(e)}`;
+            console.error(message, e); // don't return an error for this case as you may still be a user
+          }
 
           profile.admin = isAdmin;
+          console.log(`passport.activeDirectory: ${profile.username} admin=${isAdmin}`);
 
           const user = {
             username: profile.username,
@@ -70,6 +87,7 @@ const configure = (passport) => {
   passport.deserializeUser(function (user, done) {
     done(null, user);
   });
+  passport.type = "ActiveDirectory";
 
   return passport;
 };
diff --git a/src/service/passport/ldaphelper.js b/src/service/passport/ldaphelper.js
@@ -1,18 +1,42 @@
-const axios = require('axios');
 const thirdpartyApiConfig = require('../../config').getAPIs();
-const client = axios.create({
-  responseType: 'json',
-  headers: {
-    'content-type': 'application/json',
-  },
-});
+const axios = require('axios');
+
+const isUserInAdGroup = (req, profile, ad, domain, name) => {
+  // determine, via config, if we're using HTTP or AD directly
+  if (thirdpartyApiConfig?.ls?.userInADGroup) {
+    return isUserInAdGroupViaHttp(profile.username, domain, name);
+  } else {
+    return isUserInAdGroupViaAD(req, profile, ad, domain, name);
+  }
+};
 
-const isUserInAdGroup = (id, domain, name) => {
+const isUserInAdGroupViaAD = (req, profile, ad, domain, name) => {
+  return new Promise((resolve, reject) => {
+    ad.isUserMemberOf(profile.username, name, function (err, isMember) {
+      if (err) {
+        const msg = 'ERROR isUserMemberOf: ' + JSON.stringify(err);
+        reject(msg);
+      } else {
+        console.log(profile.username + ' isMemberOf ' + name + ': ' + isMember);
+        resolve(isMember);
+      }
+    });
+  });
+};
+
+const isUserInAdGroupViaHttp = (id, domain, name) => {
   const url = String(thirdpartyApiConfig.ls.userInADGroup)
     .replace('<domain>', domain)
     .replace('<name>', name)
     .replace('<id>', id);
 
+  const client = axios.create({
+    responseType: 'json',
+    headers: {
+      'content-type': 'application/json',
+    },
+  });
+
   console.log(`checking if user is in group ${url}`);
   return client
     .get(url)
diff --git a/website/docs/configuration/reference.mdx b/website/docs/configuration/reference.mdx

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,9 @@`
`51`	`51`	`"adConfig": {`
`52`	`52`	`"url": "",`
`53`	`53`	`"baseDN": "",`
`54`		`- "searchBase": ""`
	`54`	`+ "searchBase": "",`
	`55`	`+ "username": "",`
	`56`	`+ "password": ""`
`55`	`57`	`}`
`56`	`58`	`},`
`57`	`59`	`{`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ export const getDatabase = () => {`
`87`	`87`	`}`
`88`	`88`	`}`
`89`	`89`
`90`		`- throw Error('No database cofigured!');`
	`90`	`+ throw Error('No database configured!');`
`91`	`91`	`};`
`92`	`92`
`93`	`93`	`/**`