https://github.com/ether/ep_hash_auth
Etherpad plugin that allows the usage of hash values for authentoication in settings.json
https://github.com/ether/ep_hash_auth
Last synced: 9 months ago
JSON representation
Etherpad plugin that allows the usage of hash values for authentoication in settings.json
- Host: GitHub
- URL: https://github.com/ether/ep_hash_auth
- Owner: ether
- License: apache-2.0
- Created: 2015-10-06T20:54:16.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T21:44:37.000Z (almost 2 years ago)
- Last Synced: 2025-04-03T02:47:47.485Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 236 KB
- Stars: 6
- Watchers: 4
- Forks: 11
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
 
# ep_hash_auth
This [Etherpad](http://etherpad.org) plugin allows the usage of hashed passwords for authentication.
As of version 2.x it uses the crypto lib and/or the [bcrypt](https://www.npmjs.com/package/bcrypt) lib for comparison.
Besides settings.json, it is now possible to store the user-database in a filesystem hierarchy. The hash files are read on authentication.
```JSON
"users": {
"admin": {"password": "admin","is_admin": true},
"y": {"is_admin": true, "hash": "b2112aa7399 ... b071ea5976"},
"z": {"is_admin": true, "hash": "b5152ab7359 ... a041fa5646", "displayname": "Jane Doe"}
}
```
optionally specify hash type and digest, folders and extension, defaults are:
```JSON
"ep_hash_auth": {
"hash_typ": "sha512",
"hash_dig": "hex",
"hash_dir": "/var/etherpad/users",
"hash_ext": "/.hash",
"hash_adm": false,
"displayname_ext": "/.displayname"
},
```
This means user Alice would have to have her hash in sha512 hex OR in bcrypt format in the following file:
```Shell
/var/etherpad/users/Alice/.hash
```
The hash_adm parameter defines the role of file-authenticated users, by default they are not admins.
The displayname_ext parameter defines from which file the displayname of a user can be read. If the file does not exist for a user, the displayname remains unchanged.
## Generate the hashes
#### Bcrypt:
```Shell
apt-get install -yqq python-bcrypt
python -c 'import bcrypt; print(bcrypt.hashpw(b"password", bcrypt.gensalt(rounds=10, prefix=b"2a")))'
```
#### Scrypt:
```Javascript
var scrypt = require('scrypt');
console.log(scrypt.kdfSync("password", scrypt.paramsSync(0.1)));
```
#### Argon2:
```Javascript
var argon2 = require('argon2');
argon2.hash("password", {timeCost: 4, memoryCost: 2 ** 13, parallelism: 2, type: argon2.argon2i}).then(hash => {console.log(hash);});
```
## Credits
* István Király [LaKing](https://github.com/LaKing) (author and maintainer)
* [Robin `ypid` Schneider](https://github.com/ypid) (contributor)
* [id01](https://github.com/id01) (contributor)
## the [npm](https://www.npmjs.com/package/ep_hash_auth)