Skip to content

Allow to disable nested groups extraction #245

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Allow to disable nested groups extraction #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fad7593
Fix: wrong default attributes for groups were passed
Jan 23, 2023
afbf814
Added a parameter to disable nested groups extraction
Jan 23, 2023
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -661,6 +661,7 @@ Currently supported ldapjs opts are:
* attributes - attributes to select and return (if these are set, the server will return only these attributes). Defaults to the empty set, which means all attributes.
* sizeLimit - the maximum number of entries to return. Defaults to 0 (unlimited).
* timeLimit - the maximum amount of time the server should take in responding, in seconds. Defaults to 10. Lots of servers will ignore this.
* includeNestedGroups - You can optionally pass here False if the results shouldn't include nested groups. Default is True.

Options for activedirectory.js:

Expand Down
22 changes: 13 additions & 9 deletions lib/activedirectory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -697,7 +697,7 @@ function pickAttributes(result, attributes) {
* Gets all of the groups that the specified distinguishedName (DN) belongs to.
*
* @private
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0, includeNestedGroups: {Boolean} }
* @param {String} dn The distinguishedName (DN) to find membership of.
* @param {Function} callback The callback to execute when completed. callback(err: {Object}, groups: {Array[Group]})
*/
Expand Down Expand Up @@ -765,6 +765,9 @@ function getGroupMembershipForDN(opts, dn, stack, callback) {
log.debug('Adding group "%s" to %s"', group.dn, dn);
groups.push(new Group(group));

if (!opts.includeNestedGroups) {
asyncCallback();
} else {
// Get the groups that this group may be a member of.
log.debug('Retrieving nested group membership for group "%s"', group.dn);
getGroupMembershipForDN.call(self, opts, group.dn, groups, function(err, nestedGroups) {
Expand All @@ -785,6 +788,7 @@ function getGroupMembershipForDN(opts, dn, stack, callback) {
Array.prototype.push.apply(groups, nestedGroups);
asyncCallback();
});
}
}
else asyncCallback();
}, function(err) {
Expand Down Expand Up @@ -1085,7 +1089,7 @@ ActiveDirectory.prototype.getUsersForGroup = function getUsersForGroup(opts, gro
* For the specified username, get all of the groups that the user is a member of.
*
* @public
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0, includeNestedGroups: {Boolean} }
* @param {String} username The username to retrieve membership information about.
* @param {Function} [callback] The callback to execute when completed. callback(err: {Object}, groups: {Array[Group]})
*/
Expand Down Expand Up @@ -1131,7 +1135,7 @@ ActiveDirectory.prototype.getGroupMembershipForUser = function getGroupMembershi
* For the specified group, get all of the groups that the group is a member of.
*
* @public
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0, includeNestedGroups: {Boolean} }
* @param {String} groupName The group to retrieve membership information about.
* @param {Function} [callback] The callback to execute when completed. callback(err: {Object}, groups: {Array[Group]})
*/
Expand Down Expand Up @@ -1300,7 +1304,7 @@ function includeGroupMembershipFor(opts, name) {
* (i.e. computer accounts, etc.) can be found in the 'other' attribute / array of the result.
*
* @public
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }. Optionally, if only a string is provided, then the string is assumed to be an LDAP filter.
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0, includeNestedGroups: {Boolean} }. Optionally, if only a string is provided, then the string is assumed to be an LDAP filter.
* @param {Function} callback The callback to execute when completed. callback(err: {Object}, { users: [ User ], groups: [ Group ], other: [ ] )
*/
ActiveDirectory.prototype.find = function find(opts, callback) {
Expand Down Expand Up @@ -1496,7 +1500,7 @@ ActiveDirectory.prototype.findDeletedObjects = function find(opts, callback) {
* Retrieves the specified group.
*
* @public
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0, includeNestedGroups: {Boolean} }
* @param {String} groupName The group (cn) to retrieve information about. Optionally can pass in the distinguishedName (dn) of the group to retrieve.
* @param {Function} callback The callback to execute when completed. callback(err: {Object}, group: {Group})
*/
Expand Down Expand Up @@ -1559,7 +1563,7 @@ ActiveDirectory.prototype.findGroup = function findGroup(opts, groupName, callba
* specified as (&(objectClass=group)(!(objectClass=computer))(!(objectClass=user))(!(objectClass=person)))
*
* @public
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }. Optionally, if only a string is provided, then the string is assumed to be an LDAP filter that will be appended as the last parameter in the default LDAP filter.
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0, includeNestedGroups: {Boolean} }. Optionally, if only a string is provided, then the string is assumed to be an LDAP filter that will be appended as the last parameter in the default LDAP filter.
* @param {Function} callback The callback to execute when completed. callback(err: {Object}, groups: [ Group ])
*/
ActiveDirectory.prototype.findGroups = function findGroup(opts, callback) {
Expand Down Expand Up @@ -1601,7 +1605,7 @@ ActiveDirectory.prototype.findGroups = function findGroup(opts, callback) {
// Parse the results in parallel.
async.forEach(results, function(result, asyncCallback) {
if (isGroupResult(result)) {
var group = new Group(pickAttributes(result, (opts || {}).attributes || defaultAttributes.user));
var group = new Group(pickAttributes(result, (opts || {}).attributes || defaultAttributes.group));
groups.push(group);

// Also retrieving user group memberships?
Expand Down Expand Up @@ -1637,7 +1641,7 @@ ActiveDirectory.prototype.findGroups = function findGroup(opts, callback) {
* Retrieves the specified user.
*
* @public
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0, includeNestedGroups: {Boolean} }
* @param {String} username The username to retrieve information about. Optionally can pass in the distinguishedName (dn) of the user to retrieve.
* @param {Boolean} [includeMembership] OBSOLETE; NOT NOT USE. Indicates if the results should include group memberships for the user. Defaults to false.
* @param {Function} callback The callback to execute when completed. callback(err: {Object}, user: {User})
Expand Down Expand Up @@ -1709,7 +1713,7 @@ ActiveDirectory.prototype.findUser = function findUser(opts, username, includeMe
* specified as (&(|(objectClass=user)(objectClass=person))(!(objectClass=computer))(!(objectClass=group)))
*
* @public
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }. Optionally, if only a string is provided, then the string is assumed to be an LDAP filter that will be appended as the last parameter in the default LDAP filter.
* @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0, includeNestedGroups: {Boolean} }. Optionally, if only a string is provided, then the string is assumed to be an LDAP filter that will be appended as the last parameter in the default LDAP filter.
* @param {Boolean} [includeMembership] OBSOLETE; NOT NOT USE. Indicates if the results should include group memberships for the user. Defaults to false.
* @param {Function} callback The callback to execute when completed. callback(err: {Object}, users: [ User ])
*/
Expand Down