Skip to content
No description or website provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix typo Jun 28, 2018
lib Add the capability to call createHash instead of createHmac (#60) Feb 25, 2019
test Add the capability to call createHash instead of createHmac (#60) Feb 25, 2019
.eslintrc.json dependencies update Mar 16, 2018
.gitignore 760 Unit tests initial commit Apr 19, 2017
.npmignore
.travis.yml [ci] update npm api key Feb 26, 2019
CHANGELOG.md Add empty Changelog File Jun 20, 2017
LICENSE.md Release 5.0.0 Jun 20, 2017
README.md Add the capability to call createHash instead of createHmac (#60) Feb 25, 2019
manifest.json add manifest.json file (#58) Aug 9, 2018
package-lock.json [dependencies] update dependencies Feb 25, 2019
package.json [dependencies] update dependencies Feb 25, 2019

README.md

Build Status

Plugin Local Password Authentication

This plugin provides a local authentication with username/password with passportjs module.

By default, this plugin is already installed in Kuzzle.

Configuration

The default and recommended configuration is:

{
  "algorithm": "sha512",
  "stretching": true,
  "digest": "hex",
  "encryption": "hmac"
}

All the configurations are used to set the behavior of the password hash.

  • algorithm: one of the supported encryption algorithms (run crypto.getHashes() to get the complete list). Examples: sha256, sha512, blake2b512, whirlpool, ...
  • stretching must be a boolean and controls if the password is stretched or not.
  • digest describes how the hashed password is stored in the persisting layer. See other possible values in the node.js documentation
  • encryption determines whether the hashing algorithm uses crypto.createHash (hash) or crypto.createHmac (hmac). For more details, see the node.js documentation

Usage

Just send following data to the auth controller:

{
  "controller": "auth",
  "action": "login",
  "strategy": "local",
  "body": {
    "username": "<username>",
    "password": "<password>"
  }
}

See Kuzzle API Documentation for more details about Kuzzle authentication mechanism.

How to create a plugin

See Kuzzle documentation about plugin for more information about how to create your own plugin.

About Kuzzle

For UI and linked objects developers, Kuzzle is an open-source solution that handles all the data management (CRUD, real-time storage, search, high-level features, etc).

Kuzzle features are accessible through a secured API. It can be used through a large choice of protocols such as REST, Websocket or Message Queuing protocols.

You can’t perform that action at this time.