https://github.com/rchouinard/phpass

PHP Password Library: Easy, secure password management for PHP
https://github.com/rchouinard/phpass

Last synced: about 2 months ago
JSON representation

PHP Password Library: Easy, secure password management for PHP

• Host: GitHub
• URL: https://github.com/rchouinard/phpass
• Owner: rchouinard
• License: mit
• Created: 2011-08-29T23:39:01.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2016-07-20T17:02:57.000Z (over 8 years ago)
• Last Synced: 2024-09-07T08:41:26.760Z (4 months ago)
• Language: PHP
• Homepage: http://rchouinard.github.com/phpass/
• Size: 1.19 MB
• Stars: 245
• Watchers: 14
• Forks: 28
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - rchouinard/phpass - PHP Password Library: Easy, secure password management for PHP (PHP)

README

        
PHP Password Library

====================

The PHP Password Library is designed to ease the tasks associated with working with passwords in PHP. It is capable of generating strong cryptographic password hashes, verifying supplied password strings against those hashes, and calculating the strength of a password string using various algorithms.

This project was inspired by [Openwall's portable hashing library for PHP](http://openwall.com/phpass/) and [PassLib for Python](http://packages.python.org/passlib/).

Features

--------

 * Create and verify secure password hashes with only a few lines of code.

 * Supports bcrypt and PBKDF2 out of the box.

 * Easily extend to support additional hashing methods.

 * Additional password strength component based on well-known algorithms.

 * Follows the [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) standard for autoloader compatibility.

Installation

------------

### PEAR

Installing via PEAR is a simple matter of including the [PEAR channel](http://rchouinard.github.com/pear/) and installing the `rych/PHPass` package.

```bash

pear channel-discover rchouinard.github.com/pear

pear install rych/PHPass-2.1.0-alpha

```

### Composer

[Composer](http://getcomposer.org/) is an easy way to manage dependencies in your PHP projects. The PHP Password Library can be found in the default [Packagist](http://packagist.org/) repository.

After installing Composer into your project, the PHP Password Library can be installed by adding the following lines to your `composer.json` file and running the Composer command line tool:

```json

{

  "require": {

    "rych/phpass": "2.1.0-dev"

  }

}

```

Usage

-----

### Hashing passwords

The library provides the ability to generate strong cryptographic hashes of user passwords using a variety of methods. Each method may be customized as needed, and may also be combined with HMAC hashing when using the base class.

#### Examples

Use the default bcrypt adapter:

```php

 15000

));

$phpassHash = new \Phpass\Hash($adapter);

```

Create and verify a password hash:

```php

hashPassword($password);

if ($phpassHash->checkPassword($password, $passwordHash)) {

    // Password matches...

} else {

    // Password doesn't match...

}

```

### Calculating password strength

There are many different ways to calculate the relative strength of a given password, and this library supports a few of the most common. Each method returns a number which represents the estimated entropy for the given password. It's up to the developer to determine the minimum calculated entropy to accept. Combined with a sensible password policy, this can be a valuable tool in selecting strong passwords.

#### Examples

Calculate a password's entropy using [NIST recommendations](http://en.wikipedia.org/wiki/Password_strength#NIST_Special_Publication_800-63):

```php

calculate('MySecretPassword');

```

Calculate a password's entropy using [Wolfram Alpha's algorithm](http://www.wolframalpha.com/input/?i=password+strength+for+qwerty2345#):

```php

calculate('MySecretPassword');

```