phpbb-password/README.md

phpbb's password hashing algorithm for Nodejs

node-phpbb-password
===================

phpbb's password hashing algorithm for Nodejs

## Installation

### In a project
``` sh
npm install --save phpbb-password
```

### For command line use
``` sh
npm install -g phpbb-password
```

## Usage

### In your code
``` javascript

var phpbb = require('phpbb-password');

// hash a password
var hash = phpbb.hash('bonjour, mot de passe');
console.log(hash); // examples : $H$9sPKRpbzFtCY8ZGFvmPQU7qAaZlQ1E. $H$9940UI0zss3hbAt6bytgCIAthYapG20

// verify 
var ok = phpbb.check_hash('bonjour, mot de passe', hash);
console.log(ok); // true
```

### In the shell
``` sh
export HASH=$(phpbb-password hash "mypassword")

echo $(phpbb-password verify "mypassword" "$HASH")
```

## TODO

 * Tests !
 * Async ?

## License

[GNU General Public License v2](https://github.com/phpbb/phpbb3#license)

Since the original PHP code come from PHPbb itself, I think this code must also be under the GPLv2.
If you think we can use BSD or something else, let me know !