sinopia-htpasswd

auth plugin for sinopia supporting htpasswd format

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
sinopia-htpasswd
1140.4.510 years ago10 years agoMinified + gzip package size for sinopia-htpasswd in KB

Readme

Installation

$ npm install sinopia
$ npm install sinopia-htpasswd

PS: Actually, this module is bundled with sinopia, so you don't have to install it like this. But with other auth plugins you have to.

Config

Add to your config.yaml:
auth:
  htpasswd:
    file: ./htpasswd

    # Maximum amount of users allowed to register, defaults to "+inf".
    # You can set this to -1 to disable registration.
    #max_users: 1000

For plugin writers

It's called as:
require('sinopia-htpasswd')(config, stuff)

Where:
- config - module's own config - stuff - collection of different internal sinopia objects
- stuff.config - main config
- stuff.logger - logger
This should export two functions:
- adduser(user, password, cb)
It should respond with:
 - `cb(err)` in case of an error (error will be returned to user)
 - `cb(null, false)` in case registration is disabled (next auth plugin will be executed)
 - `cb(null, true)` in case user registered successfully

It's useful to set `err.status` property to set http status code (e.g. `err.status = 403`).
- authenticate(user, password, cb)
It should respond with:
 - `cb(err)` in case of a fatal error (error will be returned to user, keep those rare)
 - `cb(null, false)` in case user not authenticated (next auth plugin will be executed)
 - `cb(null, [groups])` in case user is authenticated

Groups is an array of all users/usergroups this user has access to. You should probably include username itself here.