nce-user

    0.0.3 • Public • Published

    NCE user extension

    Description

    A user module for the nce framework build with passport.

    How to install

    Install with npm: npm install --save nce-user

    Integrate in NCE with the extension-manager:

    var NCE = require("nce");
    var nce = new NCE(/*{}*/);
    var extMgr = require("nce-extension-manager")(nce);
    extMgr.activateExtension(extMgr);
    
    var user = extMgr.getActivatedExtension("user");
    

    How to use

    Config settings

    You are able to use the following config-settings (listed with their defaults):

    • authenticationCallbackURL: "/authcb": URL-prefix to listen for authentication callbacks (e.g. OAuth-Callbacks)
    • defaultAdminPassword: false: In general a function generate a admin password, but you can pass one here.
    • modelName: "user": The name for the model in mongoose store for nce.
    • local: {...}: Object for settings of the local strategy for passport.
      • usernameField: "username": Fieldname for username for local passport-strategy.
      • passwordField: "password": Fieldname for the password of the user for local passport-strategy.
      • saltLength: 32: Length of the salt generated for a user.
      • iterations: 25000: Numbers of interactions to get a "random" salt.
      • keyLength: 512: Length of a stored hashed key.
      • encoding: "hex": Encoding for salts, keys and hashes.
    • complexity: {uppercase:1, lowercase:1, special:1, digit:1, alphaNumeric:1, min:8}: Set complexity of passwords with the module complexity look at its documentation for further informations.
    • logger: {}: Settings for logger-extension.

    Schema of users

    The schema and model of users are build with mongoose and has the following structure:

    • name[String]: A name representing a user (not unique!).
    • email[String]: An email address of an user (unique!).
    • usergroups[Array of Strings]: Groups of an user.
    • username[String]: A unique username.
    • password[String]: You can set a cleartext password but it will be saved salt-hashed.
    • salt[String]: The salt used for hashing the password (can not be set!).
    • timestamp[Object]: Timestamps:
      • created[Date]: Timestamp of the creation of an user.
      • last[Date]: Last login of a user.
    • additional[Object]: A place to store additional data for an user. Use user.setAdditionalValue(name, value, cb) to set additional data and user.getAdditionalValue(name, cb) to get additional data.

    Basic functions

    checkAuthentication(request, response, authCb, unauthCb, options)

    You can use this function to check for authentication.

    Arguments
    1. request[Object]: The request from http(s)-server.
    2. response[Object]: The response from http(s)-server.
    3. authCb[Function]: Callback-function if a user is granted:
      1. error[Error]: (Not really) used for exceptions. All exceptions goes over the unauthCb!
      2. user[Object]: The user-object from passport (request.user).
    4. unauthCb[Function]: Callback-function if a user is not granted:
      1. error[Error]: (Really) used for exceptions.
      2. user[Object]: The user-object from passport if there is one (request.user).
    5. opts[Object]: Authentication options (one of them have to match to get authenticated, if nothing is set, someone have to be logged in):
      • id[String, RegExp or Array]: Only allow users with a matching id.
      • username[String, RegExp or Array]: Only allow users with a matching username.
      • usergroups[String, RegExp or Array]: Only allow users with a matching usergroup.
      • email[String, RegExp or Array]: Only allow users with a matching email-address.

    proofUser(user, opts, authCb, unauthCb)

    Proof for a user like checkAuthentication but without request and response, but also without login form (just proof).

    Arguments
    1. user[Object]: A valid user object (for example from request.user).
    2. opts[Object]: Authentication options (one of them have to match to get authenticated, if nothing is set, someone have to be logged in):
      • id[String, RegExp or Array]: Only allow users with a matching id.
      • username[String, RegExp or Array]: Only allow users with a matching username.
      • usergroups[String, RegExp or Array]: Only allow users with a matching usergroup.
      • email[String, RegExp or Array]: Only allow users with a matching email-address.
    3. authCb[Function]: Callback-function if a user is granted:
      1. error[Error]: (Not really) used for exceptions. All exceptions goes over the unauthCb!
      2. user[Object]: The user-object from passport (request.user).
    4. unauthCb[Function]: Callback-function if a user is not granted:
      1. error[Error]: (Really) used for exceptions.
      2. user[Object]: The user-object from passport if there is one (request.user).

    createUser(data, callback)

    Create a user according to its schema.

    Arguments
    1. data[Object]: Data according to its schema.
    2. callback[Function]: Callback-function with the arguments:
      1. error[Error]: Used for exceptions.
      2. document[Object]: User-document from mongoose-store.

    removeUser(id, callback)

    Delete a user account with its internal (mongoose-object-)id.

    Arguments
    1. id[Object]: Internal id from user document (_id).
    2. callback[Function]: Callback-function with the arguments:
      1. error[Error]: Used for exceptions.

    getUser(query, callback)

    Get the first user matching a query. You are also able to query to for "additional values" with "additional".

    Arguments
    1. query[Object]: A query-object from mongoose.
    2. callback[Function]: Callback-function with the arguments:
      1. error[Error]: Used for exceptions.
      2. document[Object]: User-document from mongoose-store.

    updateUser(query, data, callback)

    Update user data.

    Arguments
    1. query[Object]: A query-object from mongoose.
    2. data[Object]: Data according to its schema.
    3. callback[Function]: Callback-function with the arguments:
      1. error[Error]: Used for exceptions.
      2. document[Object]: User-document from mongoose-store.

    useStrategy(strategy)

    Add other strategies, like facebook or google, like you add strategies in passport with passport.use(strategy).

    The callback url is automatically set to the url-prefix according to the config-settings and the strategy name. For example with the default config-settings and the facebook strategy the callback-url will be: /authcb/facebook.

    Arguments
    1. strategy[Function]: A passport-strategy.

    Methods of the user object

    setAdditionalValue(name, value, callback)

    You are able to set additional values to an user object. This might be a oauth information, a gpg key or an address. You are free to use this values as you and the other modules want.

    Arguments
    1. name[Object]: Name for a value.
    2. data[Object]: Saved value.
    3. callback[Function]: Callback-function with the arguments:
      1. error[Error]: Used for exceptions.
      2. document[Object]: User-document from mongoose-store.

    getAdditionalValue(name, callback)

    Get the value set by setAdditionalValue

    Arguments
    1. name[Object]: Name for a value.
    2. callback[Function]: Callback-function with the arguments:
      1. error[Error]: Used for exceptions.
      2. document[Object]: User-document from mongoose-store.

    authenticate(password, callback)

    The password ist hashed with a salt, so you are not able to proof the password directly. With authenticate you are able to proof the correct password. If the password is incorrect the callback throws an exception.

    Arguments
    1. password[Object]: Unsalt-hashed password.
    2. callback[Function]: Callback-function with the arguments:
      1. error[Error]: Used for exceptions.
      2. document[Object]: User-document from mongoose-store.

    setPassword(password, callback)

    The password ist hashed with a salt, so you are not able to set the password directly. With setPassword you are able to set a password.

    Arguments
    1. password[Object]: Unsalt-hashed password.
    2. callback[Function]: Callback-function with the arguments:
      1. error[Error]: Used for exceptions.
      2. document[Object]: User-document from mongoose-store.

    Install

    npm i nce-user

    DownloadsWeekly Downloads

    0

    Version

    0.0.3

    License

    ISC

    Last publish

    Collaborators

    • avatar