index.d.ts

import { type ClientOptions as LdapClientOptions } from 'ldapts';
import { type ActiveDirectoryAuthenticateErrorType } from './errorTypes.js';
export interface ActiveDirectoryAuthenticateConfig {
    /**
     * The base distinguished name (DN) for the LDAP search.
     * This is the starting point in the directory tree where the search for users will begin.
     * It should be set to the root of the user container.
     *
     * Example: 'DC=example,DC=com'
     */
    baseDN: string;
    /**
     * The distinguished name (DN) of the user to bind to the LDAP server.
     * This user must have permission to search for other users in the directory.
     * Often a service account or an administrative account.
     *
     * Example: 'CN=administrator,CN=Users,DC=example,DC=com'
     */
    bindUserDN: string;
    /**
     * The password for the bind user.
     * This should be kept secure and not hard-coded in production code.
     * Used to authenticate the bind user before searching for the target user.
     *
     * Example: 'password123'
     */
    bindUserPassword: string;
    /**
     * Optional. If true, the user bind DNs will be cached for 60 seconds for failed logons.
     * This can improve performance by avoiding repeated searches for the same user.
     * If false, the user bind DNs will not be cached and will be looked up each time.
     * Default is false.
     */
    cacheUserBindDNs?: boolean;
}
export type ActiveDirectoryAuthenticateResult = {
    bindUserDN: string;
} & ({
    success: false;
    error?: unknown;
    errorType: ActiveDirectoryAuthenticateErrorType;
} | {
    success: true;
    sAMAccountName: string;
});
export default class ActiveDirectoryAuthenticate {
    #private;
    /**
     * Creates an instance of ActiveDirectoryAuthenticate.
     * This class is used to authenticate users against an Active Directory server using LDAP.
     * It requires the LDAP client options and the Active Directory configuration for binding.
     * @param ldapClientUrlOrOptions - The LDAP URL, or the options for the LDAP client connection.
     * This can be a string in the format 'ldap://example.com' or 'ldaps://example.com',
     * or an object of type LdapClientOptions.
     * If a string is provided, it will be used as the URL for the LDAP connection.
     * If an object is provided, it should contain the necessary options for connecting to the LDAP server.
     * Example: { url: 'ldap://example.com' } or { url: 'ldaps://example.com', timeout: 5000 }
     * @param activeDirectoryAuthenticateConfig - The configuration for Active Directory authentication.
     * This includes the base DN for searching users, the bind user DN, and the bind user password.
     * Example: { baseDN: 'DC=example,DC=com', bindUserDN: 'CN=admin,CN=Users,DC=example,DC=com', bindUserPassword: 'password123' }
     */
    constructor(ldapClientUrlOrOptions: LdapClientOptions | string, activeDirectoryAuthenticateConfig: ActiveDirectoryAuthenticateConfig);
    /**
     * Authenticates a user against the Active Directory server.
     * @param username - The user name to authenticate. Domain names are removed.
     * Can be in the format 'domain\username', 'username', or 'username@domain.com'.
     * @param password - The password for the user to authenticate.
     * @returns A promise that resolves to an object indicating the success or failure of the authentication.
     * If successful, it returns the bind user DN and the sAMAccountName of the authenticated user.
     * If unsuccessful, it returns an error type and message.
     */
    authenticate(username: string, password: string): Promise<ActiveDirectoryAuthenticateResult>;
    /**
     * Clears the cache of user bind DNs.
     * This method is used to clear the cached user bind DNs and their associated timeouts.
     * Useful when you want to ensure that the next authentication attempt will not use a cached user bind DN,
     * or if you are exiting your application.
     */
    clearCache(): void;
}
export { type ActiveDirectoryAuthenticateErrorType, activeDirectoryErrors } from './errorTypes.js';
export type { ClientOptions as LdapClientOptions } from 'ldapts';