Class PasswordAuthenticator

PasswordAuthenticator implements a simple IPasswordAuthenticator.

Implements

IPasswordAuthenticator

Index

Constructors

Properties

allowed_sasl_mechanisms? password username

Methods

Constructors

constructor

new PasswordAuthenticator(username, password): PasswordAuthenticator
Constructs this PasswordAuthenticator with the passed username and password.
Parameters
- username: string
  The username to initialize this authenticator with.
- password: string
  The password to initialize this authenticator with.
Returns PasswordAuthenticator
- Defined in lib/authenticators.ts:69

Properties

`Optional` allowed_sasl_mechanisms

allowed_sasl_mechanisms?: string[]

The sasl mechanisms to authenticate with.

password

password: string

The password that will be used to authenticate with.

username

username: string

The username that will be used to authenticate with.

Methods

`Static` ldapCompatible

ldapCompatible(username, password): PasswordAuthenticator
Creates a LDAP compatible password authenticator which is INSECURE if not used with TLS.

Please note that this is INSECURE and will leak user credentials on the wire to eavesdroppers. This should only be enabled in trusted environments.
Parameters
- username: string
  The username to initialize this authenticator with.
- password: string
  The password to initialize this authenticator with.
Returns PasswordAuthenticator
- Defined in lib/authenticators.ts:83