Skip to content

feat: support multiple search bases #292

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 1 commit into
base: master
Choose a base branch
from
Open

feat: support multiple search bases #292

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
110 changes: 59 additions & 51 deletions src/auth/GoogleLDAPAuth.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ const usernameFields = ['posixUid', 'mail'];
interface IGoogleLDAPAuthOptions {
/** base DN
* e.g. 'dc=hokify,dc=com', */
base: string;
searchBase?: string; // default ou=users,{{base}}
base: string | string[];
searchBase?: string | string[]; // default ou=users,{{base}}
tls: {
keyFile: string;
certFile: string;
Expand All @@ -27,19 +27,20 @@ interface IGoogleLDAPAuthOptions {
}

export class GoogleLDAPAuth implements IAuthentication {
private base: string;

private config: ClientOptions;

private searchBase: string;
private searchBase: string | string[];

private dnsFetch: Promise<{ [key: string]: string }> | undefined;

private logger: IContextLogger;

constructor(config: IGoogleLDAPAuthOptions, logger: ILogger) {
this.base = config.base;
this.searchBase = config.searchBase || `ou=users,${this.base}`;
this.searchBase =
config.searchBase ||
(Array.isArray(config.base)
? config.base.map((base) => `ou=users,${base}`)
: `ou=users,${config.base}`);
this.logger = logger.context('GoogleLDAPAuth');

const tlsOptions = {
Expand All @@ -64,55 +65,62 @@ export class GoogleLDAPAuth implements IAuthentication {
try {
const dns: { [key: string]: string } = {};

const dnResult = await new Promise<{ [key: string]: string }>((resolve, reject) => {
const ldapDNClient = ldapjs.createClient(this.config).on('error', (error) => {
this.logger.error('Error in ldap', error);
reject(error);
});

ldapDNClient.search(
this.searchBase,
{
scope: 'sub',
// only select required attributes
attributes: [...usernameFields, 'dn'],
},
(err, res) => {
if (err) {
reject(err);
return;
}

res.on('searchEntry', (entry) => {
// this.logger.debug('entry: ' + JSON.stringify(entry.object));
usernameFields.forEach((field) => {
const index = entry.object[field] as string;
dns[index] = entry.object.dn;
});
});

res.on('searchReference', (referral) => {
this.logger.debug(`referral: ${referral.uris.join()}`);
});

res.on('error', (ldapErr) => {
this.logger.error(`error: ${JSON.stringify(ldapErr)}`);
reject(ldapErr);
});
const searchBases = Array.isArray(this.searchBase) ? this.searchBase : [this.searchBase];

res.on('end', (result) => {
this.logger.debug(`ldap status: ${result?.status}`);
await Promise.all(
searchBases.map(
(searchBase) =>
new Promise<void>((resolve, reject) => {
const ldapDNClient = ldapjs.createClient(this.config).on('error', (error) => {
this.logger.error('Error in ldap', error);
reject(error);
});

// this.logger.debug('allValidDNsCache', this.allValidDNsCache);
resolve(dns);
});
}
);
});
ldapDNClient.search(
searchBase,
{
scope: 'sub',
// only select required attributes
attributes: [...usernameFields, 'dn'],
},
(err, res) => {
if (err) {
reject(err);
return;
}

res.on('searchEntry', (entry) => {
// this.logger.debug('entry: ' + JSON.stringify(entry.object));
usernameFields.forEach((field) => {
const index = entry.object[field] as string;
dns[index] = entry.object.dn;
});
});

res.on('searchReference', (referral) => {
this.logger.debug(`referral: ${referral.uris.join()}`);
});

res.on('error', (ldapErr) => {
this.logger.error(`error: ${JSON.stringify(ldapErr)}`);
reject(ldapErr);
});

res.on('end', (result) => {
this.logger.debug(`ldap status: ${result?.status}`);

// this.logger.debug('allValidDNsCache', this.allValidDNsCache);
resolve();
});
}
);
})
)
);
setTimeout(() => {
this.dnsFetch = undefined;
}, 60 * 60 * 12 * 1000); // reset cache after 12h
return dnResult;
return dns;
} catch (err) {
console.error('dns fetch err', err);
// retry dns fetch next time
Expand Down