Authentication

    Authenticators allow implementing basic password mechanism using simple built-in hashing functions.

    For a full example of sessions with authentication and registration see the example in the chapter on User Management.

    createAuth([options]): Authenticator

    Creates an authenticator.

    Arguments

    An object with the following properties:

    • method: string (Default: "sha256")

    The hashing algorithm to use to create password hashes. The authenticator will be able to verify passwords against hashes using any supported hashing algorithm. This only affects new hashes created by the authenticator.

    • saltLength: (Default: 16)

    Length of the salts that will be generated for password hashes.

    Returns an authenticator.

    auth.create(password): AuthData

    Creates an authentication data object for the given password with the following properties:

    • method: string

    The method used to generate the hash.

    A random salt used to generate this hash.

    • hash:

    The hash string itself.

    • password: string

    A password to hash.

    Returns the authentication data object.

    auth.verify([hash, [password]]): boolean

    Verifies the given password against the given hash using a constant time string comparison.

    Arguments

    • hash: AuthData (optional)

    A authentication data object generated with the create method.

    A password to verify against the hash.