sinopia-htpasswd

WebJar for sinopia-htpasswd

License	WTFPL
GroupId	org.webjars.npm
ArtifactId	sinopia-htpasswd
Last Version	0.4.5
Release Date	Nov 19, 2016
Type	jar
Description	sinopia-htpasswd WebJar for sinopia-htpasswd
Project URL	http://webjars.org
Source Code Management	https://github.com/rlidwka/sinopia-htpasswd

Download sinopia-htpasswd

Filename	Size
sinopia-htpasswd-0.4.5.pom
sinopia-htpasswd-0.4.5.jar	9 KB
sinopia-htpasswd-0.4.5-sources.jar	22 bytes
sinopia-htpasswd-0.4.5-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/sinopia-htpasswd/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>sinopia-htpasswd</artifactId>
    <version>0.4.5</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/sinopia-htpasswd/
implementation 'org.webjars.npm:sinopia-htpasswd:0.4.5'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/sinopia-htpasswd/
implementation ("org.webjars.npm:sinopia-htpasswd:0.4.5")

Apache Buildr

'org.webjars.npm:sinopia-htpasswd:jar:0.4.5'

Apache Ivy

<dependency org="org.webjars.npm" name="sinopia-htpasswd" rev="0.4.5">
  <artifact name="sinopia-htpasswd" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='sinopia-htpasswd', version='0.4.5')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "sinopia-htpasswd" % "0.4.5"

Leiningen

[org.webjars.npm/sinopia-htpasswd "0.4.5"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : crypt3	jar	[0.1.5,1.0.0-0)
org.webjars.npm : fs-ext	jar	[0,)

Project Modules

There are no modules declared in this project.

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

Password file format

Passwords are stored in htpasswd file, and it is designed to be compatible with Nginx.

We use standard password hashing in linux (same as in /etc/shadow, on most modern systems it's salted SHA-512), but you can use whatever your glibc supports.

You can manually add new user with this command (see different commands here):

$ echo "user:`mkpasswd --method=sha-512 password`" >> htpasswd

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.

Versions

Version
0.4.5 Nov 19, 2016