.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Authen::Passphrase::PHPass 3pm"
.TH Authen::Passphrase::PHPass 3pm "2022-06-08" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Authen::Passphrase::PHPass \- passphrases using the phpass algorithm
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Authen::Passphrase::PHPass;
\&
\& $ppr = Authen::Passphrase::PHPass\->new(
\& cost => 10, salt => "NaClNaCl",
\& hash_base64 => "ObRxTm/.EiiYN02xUeAQs/");
\&
\& $ppr = Authen::Passphrase::PHPass\->new(
\& cost => 10, salt_random => 1,
\& passphrase => "passphrase");
\&
\& $ppr = Authen::Passphrase::PHPass\->from_crypt(
\& \*(Aq$P$8NaClNaClObRxTm/.EiiYN02xUeAQs/\*(Aq);
\&
\& $ppr = Authen::Passphrase::PHPass\->from_rfc2307(
\& \*(Aq{CRYPT}$P$8NaClNaClObRxTm/.EiiYN02xUeAQs/\*(Aq);
\&
\& $cost = $ppr\->cost;
\& $cost_base64 = $ppr\->cost_base64;
\& $cost = $ppr\->nrounds_log2;
\& $cost_base64 = $ppr\->nrounds_log2_base64;
\& $salt = $ppr\->salt;
\& $hash = $ppr\->hash;
\& $hash_base64 = $ppr\->hash_base64;
\&
\& if($ppr\->match($passphrase)) { ...
\&
\& $passwd = $ppr\->as_crypt;
\& $userPassword = $ppr\->as_rfc2307;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
An object of this class encapsulates a passphrase hashed using
the phpass algorithm invented by Solar Designer and described
at . This is a subclass of
Authen::Passphrase, and this document assumes that the reader is
familiar with the documentation for that class.
.PP
The phpass algorithm is based on the \s-1MD5\s0 message digest algorithm.
There is an eight-byte salt, which is conventionally restricted to
consist of base 64 digits. There is also a cost parameter that controls
the expense of hashing. First the salt and passphrase are concatenated
and hashed by \s-1MD5.\s0 Then, 2^cost times, the hash from the previous stage
is concatenated with the passphrase and hashed by \s-1MD5.\s0 The passphrase
hash is the output from the final iteration.
.PP
The passphrase hash is represented in \s-1ASCII\s0 using the crypt format with
prefix "\fB\f(CB$P\fB$\fR\*(L". The first character after the format prefix is a base 64
digit giving the cost parameter. The next eight characters are the salt.
The salt is followed by 22 base 64 digits giving the hash. The base 64
digits are \*(R"\fB.\fR\*(L", \*(R"\fB/\fR\*(L", \*(R"\fB0\fR\*(L" to \*(R"\fB9\fR\*(L", \*(R"\fBA\fR\*(L" to \*(R"\fBZ\fR\*(L", \*(R"\fBa\fR\*(L"
to \*(R"\fBz\fR" (in \s-1ASCII\s0 order).
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.IP "Authen::Passphrase::PHPass\->new(\s-1ATTR\s0 => \s-1VALUE, ...\s0)" 4
.IX Item "Authen::Passphrase::PHPass->new(ATTR => VALUE, ...)"
Generates a new passphrase recogniser object using the phpass algorithm.
The following attributes may be given:
.RS 4
.IP "\fBcost\fR" 4
.IX Item "cost"
Base-two logarithm of the number of hashing rounds to perform.
.IP "\fBcost_base64\fR" 4
.IX Item "cost_base64"
Base-two logarithm of the number of hashing rounds to perform, expressed
as a single base 64 digit.
.IP "\fBnrounds_log2\fR" 4
.IX Item "nrounds_log2"
Synonym for \fBcost\fR.
.IP "\fBnrounds_log2_base64\fR" 4
.IX Item "nrounds_log2_base64"
Synonym for \fBcost_base64\fR.
.IP "\fBsalt\fR" 4
.IX Item "salt"
The salt, as an eight-byte string.
.IP "\fBsalt_random\fR" 4
.IX Item "salt_random"
Causes salt to be generated randomly. The value given for this
attribute is ignored. The salt will be a string of eight base 64 digits.
The source of randomness may be controlled by the facility described
in Data::Entropy.
.IP "\fBhash\fR" 4
.IX Item "hash"
The hash, as a 16\-byte string.
.IP "\fBhash_base64\fR" 4
.IX Item "hash_base64"
The hash, as a string of 22 base 64 digits.
.IP "\fBpassphrase\fR" 4
.IX Item "passphrase"
A passphrase that will be accepted.
.RE
.RS 4
.Sp
The cost and salt must be given, and either the hash or the passphrase.
.RE
.IP "Authen::Passphrase::PHPass\->from_crypt(\s-1PASSWD\s0)" 4
.IX Item "Authen::Passphrase::PHPass->from_crypt(PASSWD)"
Generates a new phpass passphrase recogniser object from a crypt string.
The crypt string must consist of "\fB\f(CB$P\fB$\fR", one base 64 character encoding
the cost, the salt, then 22 base 64 digits giving the hash. The salt
must be exactly 8 characters long, and cannot contain any character that
cannot appear in a crypt string.
.IP "Authen::Passphrase::PHPass\->from_rfc2307(\s-1USERPASSWORD\s0)" 4
.IX Item "Authen::Passphrase::PHPass->from_rfc2307(USERPASSWORD)"
Generates a new phpass passphrase recogniser object from an \s-1RFC 2307\s0
string. The string must consist of "\fB{\s-1CRYPT\s0}\fR" (case insensitive)
followed by an acceptable crypt string.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$ppr\->cost" 4
.el .IP "\f(CW$ppr\fR\->cost" 4
.IX Item "$ppr->cost"
Returns the base-two logarithm of the number of hashing rounds that will
be performed.
.ie n .IP "$ppr\->cost_base64" 4
.el .IP "\f(CW$ppr\fR\->cost_base64" 4
.IX Item "$ppr->cost_base64"
Returns the base-two logarithm of the number of hashing rounds that will
be performed, expressed as a single base 64 digit.
.ie n .IP "$ppr\->nrounds_log2" 4
.el .IP "\f(CW$ppr\fR\->nrounds_log2" 4
.IX Item "$ppr->nrounds_log2"
Synonym for \*(L"cost\*(R".
.ie n .IP "$ppr\->nrounds_log2_base64" 4
.el .IP "\f(CW$ppr\fR\->nrounds_log2_base64" 4
.IX Item "$ppr->nrounds_log2_base64"
Synonym for \*(L"cost_base64\*(R".
.ie n .IP "$ppr\->salt" 4
.el .IP "\f(CW$ppr\fR\->salt" 4
.IX Item "$ppr->salt"
Returns the salt, as a string of eight bytes.
.ie n .IP "$ppr\->hash" 4
.el .IP "\f(CW$ppr\fR\->hash" 4
.IX Item "$ppr->hash"
Returns the hash value, as a string of 16 bytes.
.ie n .IP "$ppr\->hash_base64" 4
.el .IP "\f(CW$ppr\fR\->hash_base64" 4
.IX Item "$ppr->hash_base64"
Returns the hash value, as a string of 22 base 64 digits.
.ie n .IP "$ppr\->match(\s-1PASSPHRASE\s0)" 4
.el .IP "\f(CW$ppr\fR\->match(\s-1PASSPHRASE\s0)" 4
.IX Item "$ppr->match(PASSPHRASE)"
.PD 0
.ie n .IP "$ppr\->as_crypt" 4
.el .IP "\f(CW$ppr\fR\->as_crypt" 4
.IX Item "$ppr->as_crypt"
.ie n .IP "$ppr\->as_rfc2307" 4
.el .IP "\f(CW$ppr\fR\->as_rfc2307" 4
.IX Item "$ppr->as_rfc2307"
.PD
These methods are part of the standard Authen::Passphrase interface.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Authen::Passphrase,
Digest::MD5
.SH "AUTHOR"
.IX Header "AUTHOR"
Andrew Main (Zefram)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2006, 2007, 2009, 2010, 2012
Andrew Main (Zefram)
.SH "LICENSE"
.IX Header "LICENSE"
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.