Authentication Strategy #

Plugins can add new authentication strategies to Kuzzle. For example, our official OAUTH2 Authentication plugin adds OAUTH2 support to Kuzzle.

All authentication strategies supported by Passport.js can be integrated to Kuzzle.

Exposing authenticators #

Passport.js provides a wide range of authentication strategies. Custom authentication strategies can also be implemented by subclassing the abstract Passport Strategy class.

To register strategies to Kuzzle, a authenticators object property must be exposed by the plugin, for instance:

this.authenticators = {
  Local: require('passport-local'),
  Oauth2: require('passport-oauth2')
};

Credentials security #

User credentials are very sensitive data, and these must be properly isolated to prevent security vulnerabilities. To do so, Kuzzle guarantees that it never interprets, modifies, or stores credentials information.

Instead, Kuzzle:

• provides a global user unique identifier (referred from now on as the user's kuid, giving the possibility to a user to authenticate with multiple strategies
• entrusts implemented strategies with credentials protection, validation, verification and storage

There are two ways of registering new strategies:

• statically, by exposing a strategies object
• dynamically, by using the dedicated PluginContextAccessors.strategies methods

Whether strategies are added statically or dynamically, the registered strategy must expose the following properties:

object

object

Statically register strategies #

Plugins can declare a strategies object which contains the authentication strategies to register.
This object will be interpreted by Kuzzle only once, immediately after this plugin's init function has resolved.
Each key of this object is the name of the strategy to register and the value is the strategy object containing config and methods properties.

For example, to register a strategy named local with the Local authenticator:

this.authenticators = {
  Local: require('passport-local')
};

this.strategies = {
  local: {
    config: {
      authenticator: 'Local'
    },
    // these methods must be exposed by the plugin 
    methods: {
      create: 'create',
      delete: 'delete',
      exists: 'exists',
      getById: 'getById',
      getInfo: 'getInfo',
      search: 'search',
      update: 'update',
      validate: 'validate',
      verify: 'verify'
    }
  }
}

Dynamically register strategies #

Strategies can be register at runtime with the PluginStrategy.add method.

config #

The config part of the strategies object can contain the following properties:

string

object

string[]

object

Strategy Methods #

The methods part of the strategies object can contain the following properties:

string

string

string

string

string

string

string

string

string

string

Even though each strategy must declare its own set of properties, the same strategy method can be used by multiple strategies.

create #

The create function adds credentials to a user.

For security reasons, plugins are entirely responsible of how credentials are managed, storage included: Kuzzle does not read, modify, or store credentials.

If needed, Kuzzle exposes a secure and isolated storage space for each plugin. It can be accessed using the Repository constructor.

Arguments #

create(request, credentials, kuid, strategy);

object

string

string

Returned value #

The create function must return a promise, resolving to an object. The content of that object depends on this authentication strategy; usually a feedback about the created credentials is expected. That object can be left empty.

delete #

The delete function deletes a user's credentials.

Arguments #

delete (request, kuid, strategy);

string

string

Returned value #

The delete function must return a promise. The resolved value is not used.

exists #

The exists function checks whether a user is known to the authentication strategy.

Arguments #

exists(request, kuid, strategy);

string

string

Returned value #

The exists function must return a promise, resolving to a boolean representing the result of the user existence check.

update #

The update function updates a user's credentials.

Arguments #

update(request, credentials, kuid, strategy);

object

string

string

Returned value #

The update function must return a promise, resolving to an object. The content of that object depends on this authentication strategy; usually a feedback about the updated credentials is expected. That object can be left empty.

validate #

The validate function verifies that credentials are well-formed.

Arguments #

validate(request, credentials, kuid, strategy, isUpdate);

object

string

string

boolean

Returned value #

The function validate must return a promise. The resolved value, if there is one, is ignored.

verify #

The verify function authenticates a user.

The number of arguments taken by the verify function depends on the authentication strategy. For instance, a local authentication strategy requires that the verify function validates both a user name and a password, so these two arguments will have to be provided to the verify function.

Arguments #

verify(payload, ...)

object

*

payload #

The payload object has the following properties:

object

object

Returned value #

The verify function must return a promise, resolving to an object with the following properties:

string

string

(optional) afterRegister #

The afterRegister function is called when the Passport.js strategy is instantiated by Kuzzle.

Arguments #

afterRegister(strategyInstance);

object

(optional) getById #

The getById function returns credentials information using the authentication strategy's user identifier (which may not be the kuid).

If this function is not implemented, an empty object is returned by Kuzzle instead.

Arguments #

getById(request, id, strategy);

string

string

Returned value #

The getById function must return a promise, resolving to an object containing credentials information. It can be left empty.

(optional) getInfo #

The getInfo function returns information about a user's credentials.

If this function is not implemented, an empty object is returned by Kuzzle instead.

Arguments #

getInfo(request, kuid, strategy);

string

string

Returned value #

The getInfo function must return a promise, resolving to an object containing credentials information. It can be left empty.

(optional) search #

Given a credentials related search query, returns matched users' kuid.

If this function is not implemented, a missing_optional_method error occurs.

Arguments #

search(searchBody, options);

Returned value #

The search function must return a promise, resolving to an search result with the following properties:

• hits: Array of matched users. Each hit has the following properties:
  • kuid: Users unique identifier
  • ...: Non sensitive credentials specific to this authentication strategy
• total: Total of matched users.

Example #

module.exports = class AuthenticationPlugin {
  constructor() {}

  /**
    Required plugin initialization function
    (see the "Plugin prerequisites" section)
   */
  init (customConfig, context) {
    this.authenticators = {
      StrategyConstructor: require('some-passport-strategy')
    };

    this.strategies = {
      '<strategy name>': {
        config: {
          // Must be declared in this.authenticators
          authenticator: 'StrategyConstructor',

          // The list of fields that have to be provided in the credentials
          fields: ['login', 'password']
        },
        methods: {
          create: 'create',
          delete: 'delete',
          exists: 'exists',
          update: 'update',
          validate: 'validate',
          verify: 'verify'
        }
      }
    };
  }

  /**
   * Stores the provided credentials
   * Must keep a link between the persisted credentials
   * and the kuid
   */
  create (request, credentials, kuid) {
    // store credentials
    return Promise.resolve({/* non sensitive credentials info */});
  }

  /**
   * Removes the user's stored credentials from
   * the plugin persistence layer
   */
  delete (request, kuid) {
    // remove credentials
    return Promise.resolve();
  }

  /**
   * Checks if user's credentials exist in the persistence layer
   */
  exists (request, kuid) {
    // check credentials existence
    return Promise.resolve(/* boolean value *);
  }

  /**
   * Updates the user's credentials information in the
   * persistence layer
   *
   * @param {KuzzleRequest} request
   * @param {object} credentials
   * @param {string} kuid
   * @returns {Promise<object>}
   */
  update (request, credentials, kuid) {
    // update credentials
    return Promise.resolve(/* non sensitive credentials info *);
  }

  /**
   * Validates credentials against the strategy rules
   * (required fields, password strength, username uniqueness, ...)
   */
  validate (request, credentials, kuid, strategy, isUpdate) {
    // validate credentials
    return Promise.resolve(/* true|false *);
  }

  /**
   * Returns an object with the authenticated user id if successful,
   * and a reason if the authentication fails
   */
  verify (request, ...credentials) {
    const kuid = /* authentification */;

    if (kuid) {
      return Promise.resolve({kuid});
    }

    return Promise.resolve({
      kuid: null,
      message: 'Login failed - You shall not pass! Reason: ...'
    });
  }
}