ArangoDB v3.5 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent version here: Latest Docs

Authentication

const createAuth = require('@arangodb/foxx/auth');

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

Creating an authenticator

createAuth([options]): Authenticator

Creates an authenticator.

Arguments

  • options: Object (optional)

    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.

      Supported values:

      • "md5"
      • "sha1"
      • "sha224"
      • "sha256"
      • "sha384"
      • "sha512"
      • "pbkdf2"

      Note: PBKDF2 is more secure but also takes considerably more resources to compute, which will impact ArangoDB performance, especially when verifying/hashing multiple passwords at a time. If you need a secure authentication mechanism consider performing authentication outside the database or using a third-party identity provider that supports OAuth 1.0a or OAuth 2.0.

    • saltLength: number (Default: 16)

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

      Also used as the key length for PBKDF2.

    • workFactor: number (Default: 1)

      Can be used to scale the number of iterations for PBKDF2 hashes, lower means faster, higher means slower.

      Note that when using PBKDF2 the number of iterations will be automatically scaled based on the number of milliseconds elapsed since 1 January 2000, the work factor can be used to adjust the result further as needed.

Returns an authenticator.

Creating authentication data objects

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.

  • salt: string

    A random salt used to generate this hash.

  • hash: string

    The hash string itself.

Arguments

  • password: string

    A password to hash.

Returns the authentication data object.

Validating passwords against authentication data objects

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.

  • password: string (optional)

    A password to verify against the hash.

Returns true if the hash matches the given password. Returns false otherwise.