Global

Type Definitions

credentialsLookup(req) → {credentialsLookupResult|credentialsLookupResultAlt}

Credentials lookup function
Parameters:
Name Type Description
req Object The HTTP request
Source:
Returns:
- Found credentials
Type
credentialsLookupResult | credentialsLookupResultAlt

credentialsLookupResult

Type:
  • object
Properties:
Name Type Description
username string Username to use
password string Password to use
Source:

credentialsLookupResultAlt

Type:
  • object
Properties:
Name Type Description
user string Username to use
pass string Password to use
Source:

failureErrorCallback(err)

Synchronous function for doing something with an error if handling errors as failures
Parameters:
Name Type Description
err Error The error occurred
Source:

optionsCallback(req, callback)

Options callback
Parameters:
Name Type Description
req Object HTTP request
callback optionsCallbackCallback The callback returning the options
Source:

optionsCallbackCallback(err, options)

Options callback callback (ie. the callback given if giving a callback for options instead of an object)
Parameters:
Name Type Description
err Error | undefined Possible error
options Object Options object
Source:

verifyCallback(user, callback)

Found LDAP user verify callback
Parameters:
Name Type Description
user Object The user object from LDAP
callback verifyDoneCallback The verify callback
Source:

verifyDoneCallback(err, user, infoopt)

Verify done callback
Parameters:
Name Type Attributes Description
err Error | undefined Possible error
user Object | boolean The verified user or false if not allowed
info Object <optional>
 info - Additional info message
Source:

verifyReqCallback(req, user, callback)

Found LDAP user verify callback with request
Parameters:
Name Type Description
req Object The HTTP request
user Object The user object from LDAP
callback verifyDoneCallback The verify callback
Source: