NAME

PHP::Functions::Password - Perl ports of PHP password functions

DESCRIPTION

This module provides ported PHP password functions. This module only supports the bcrypt algorithm, as is the case with the equivalent PHP functions at the date of writing this. All functions may also be called as class methods and support inheritance too. See http://php.net/manual/en/ref.password.php for detailed usage instructions.

SYNOPSIS

        use PHP::Functions::Password ();

Functional interface use:

        use PHP::Functions::Password qw(password_hash);
        my $password = 'secret';
        my $crypted_string = password_hash($password);

Functional interface use, using options:

        use PHP::Functions::Password qw(:all);
        my $password = 'secret';
        my $crypted_string = password_hash($password, PASSWORD_DEFAULT, cost => 11);

Class method use, using options:

        use PHP::Functions::Password;
        my $password = 'secret';
        my $crypted_string = PHP::Functions::Password->hash($password, cost => 9);
        # Note that the 2nd argument of password_hash() has been dropped here and may be specified
        # as an option as should've been the case in the original password_hash() function IMHO.

EXPORTS

The following names can be imported into the calling namespace by request:

        password_get_info
        password_hash
        password_needs_rehash
        password_verify
        PASSWORD_BCRYPT
        PASSWORD_DEFAULT
        :all    - what it says
        :consts - the PASSWORD_* constants
        :funcs  - the password_* functions

PHP COMPATIBLE AND EXPORTABLE FUNCTIONS

password_get_info($crypted)

The same as http://php.net/manual/en/function.password-get-info.php with the exception that it returns the following additional keys in the result:

        algoSig e.g. '2y'
        salt
        hash

Returns a hash in array context, else a hashref.

password_hash($password, $algo, %options)

Similar to http://php.net/manual/en/function.password-hash.php with difference that the $algo argument is optional and defaults to PASSWORD_DEFAULT for your programming pleasure.

password_needs_rehash($crypted, $algo, %options)

The same as http://php.net/manual/en/function.password-needs-rehash.php.

password_verify($password, $crypted)

The same as http://php.net/manual/en/function.password-verify.php.

SHORTENED ALIAS METHODS

get_info($crypted)

Alias of password_get_info($crypted).

hash($password, %options)

Proxy method for password_hash($password, $algo, $options). The difference is that this method allows does have an $algo argument, but instead allows the algorithm to be specified with the 'algo' option (in %options).

needs_rehash($crypted, $algo, %options)

Alias of password_needs_rehash($crypted, $algo, %options).

verify($password, $crypted)

Alias of verify($password, $crypted).

SEE ALSO

Crypt::Eksblowfish::Bcrypt from which several internal functions were copied and slightly modified, Crypt::Eksblowfish used for creating/verifying crypted strings in bcrypt format, Crypt::OpenSSL::Random used for random salt generation.

COPYRIGHT

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Craig Manley (craigmanley.com)