model/modx/hashing/modpbkdf2.class.php

Classes 
package
modx
subpackage
hashing
Classes
modPBKDF2

Description

This file contains a modHash implementation of RSA PDKDF2.

\modPBKDF2

Extends from
\modHash
package
modx
Methods
hash

Description

A PBKDF2 implementation of modHash.

{@inheritdoc}

Methods

hash

hash( string $string, array $options = array ) : mixed

Generate a hash of a string using the RSA PBKDFA2 specification.

The following options are available: - salt (required): a valid, non-empty string to salt the hashes - iterations: the number of iterations per block, default is 1000 (< 1000 not recommended) - derived_key_length: the size of the derived key to generate, default is 32 - algorithm: the hash algorithm to use, default is sha256 - raw_output: if true, returns binary output, otherwise derived key is base64_encode()'d; default is false

{@inheritdoc}

Arguments
$string
string
A string to generate a secure hash from.
$options
array
An array of options to be passed to the hash implementation.
Output
mixed
The hash result or false on failure.
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox 0.11.2.