/usr/share/perl5/Authen/Passphrase/PHPass.pm is in libauthen-passphrase-perl 0.007-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 | =head1 NAME
Authen::Passphrase::PHPass - passphrases using the phpass algorithm
=head1 SYNOPSIS
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(
'$P$8NaClNaClObRxTm/.EiiYN02xUeAQs/');
$ppr = Authen::Passphrase::PHPass->from_rfc2307(
'{CRYPT}$P$8NaClNaClObRxTm/.EiiYN02xUeAQs/');
$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;
=head1 DESCRIPTION
An object of this class encapsulates a passphrase hashed using
the phpass algorithm invented by Solar Designer and described
at L<http://www.openwall.com/phpass/>. This is a subclass of
C<Authen::Passphrase>, and this document assumes that the reader is
familiar with the documentation for that class.
The phpass algorithm is based on the MD5 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 MD5. Then, 2^cost times, the hash from the previous stage
is concatenated with the passphrase and hashed by MD5. The passphrase
hash is the ouptut from the final iteration.
The passphrase hash is represented in ASCII using the crypt format with
prefix "B<$P$>". 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 "B<.>", "B</>", "B<0>" to "B<9>", "B<A>" to "B<Z>", "B<a>"
to "B<z>" (in ASCII order).
=cut
package Authen::Passphrase::PHPass;
{ use 5.006; }
use warnings;
use strict;
use Authen::Passphrase 0.003;
use Carp qw(croak);
use Data::Entropy::Algorithms 0.000 qw(rand_bits);
use Digest::MD5 1.99_53 ();
our $VERSION = "0.007";
use parent "Authen::Passphrase";
my $base64_digits = "./0123456789ABCDEFGHIJKLMNOPQRST".
"UVWXYZabcdefghijklmnopqrstuvwxyz";
sub _en_base64($) {
my($bytes) = @_;
my $nbytes = length($bytes);
my $npadbytes = 2 - ($nbytes + 2) % 3;
$bytes .= "\0" x $npadbytes;
my $digits = "";
for(my $i = 0; $i < $nbytes; $i += 3) {
my $v = ord(substr($bytes, $i, 1)) |
(ord(substr($bytes, $i+1, 1)) << 8) |
(ord(substr($bytes, $i+2, 1)) << 16);
$digits .= substr($base64_digits, $v & 0x3f, 1) .
substr($base64_digits, ($v >> 6) & 0x3f, 1) .
substr($base64_digits, ($v >> 12) & 0x3f, 1) .
substr($base64_digits, ($v >> 18) & 0x3f, 1);
}
substr $digits, -$npadbytes, $npadbytes, "";
return $digits;
}
sub _de_base64($) {
my($digits) = @_;
my $ndigits = length($digits);
my $npadbytes = 3 - ($ndigits + 3) % 4;
$digits .= "." x $npadbytes;
my $bytes = "";
for(my $i = 0; $i < $ndigits; $i += 4) {
my $v = index($base64_digits, substr($digits,$i,1)) |
(index($base64_digits, substr($digits,$i+1,1)) << 6) |
(index($base64_digits, substr($digits,$i+2,1)) << 12) |
(index($base64_digits, substr($digits,$i+3,1)) << 18);
$bytes .= chr($v & 0xff) .
chr(($v >> 8) & 0xff) .
chr(($v >> 16) & 0xff);
}
substr $bytes, -$npadbytes, $npadbytes, "";
return $bytes;
}
=head1 CONSTRUCTORS
=over
=item Authen::Passphrase::PHPass->new(ATTR => VALUE, ...)
Generates a new passphrase recogniser object using the phpass algorithm.
The following attributes may be given:
=over
=item B<cost>
Base-two logarithm of the number of hashing rounds to perform.
=item B<cost_base64>
Base-two logarithm of the number of hashing rounds to perform, expressed
as a single base 64 digit.
=item B<nrounds_log2>
Synonym for B<cost>.
=item B<nrounds_log2_base64>
Synonym for B<cost_base64>.
=item B<salt>
The salt, as an eight-byte string.
=item B<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 L<Data::Entropy>.
=item B<hash>
The hash, as a 16-byte string.
=item B<hash_base64>
The hash, as a string of 22 base 64 digits.
=item B<passphrase>
A passphrase that will be accepted.
=back
The cost and salt must be given, and either the hash or the passphrase.
=cut
sub new {
my $class = shift;
my $self = bless({}, $class);
my $passphrase;
while(@_) {
my $attr = shift;
my $value = shift;
if($attr eq "cost" || $attr eq "nrounds_log2") {
croak "cost specified redundantly"
if exists $self->{cost};
croak "\"$value\" is not a valid cost parameter"
unless $value == int($value) && $value >= 0 &&
$value <= 30;
$self->{cost} = 0+$value;
} elsif($attr eq "cost_base64" ||
$attr eq "nrounds_log2_base64") {
croak "cost specified redundantly"
if exists $self->{cost};
croak "\"$value\" is not a valid cost parameter"
unless $value =~ m#\A[./0-9A-S]\z#;
$self->{cost} = index($base64_digits, $value);
} elsif($attr eq "salt") {
croak "salt specified redundantly"
if exists $self->{salt};
$value =~ m#\A[\x00-\xff]{8}\z#
or croak "\"$value\" is not a valid salt";
$self->{salt} = "$value";
} elsif($attr eq "salt_random") {
croak "salt specified redundantly"
if exists $self->{salt};
$self->{salt} = _en_base64(rand_bits(48));
} elsif($attr eq "hash") {
croak "hash specified redundantly"
if exists($self->{hash}) ||
defined($passphrase);
$value =~ m#\A[\x00-\xff]{16}\z#
or croak "not a valid raw hash";
$self->{hash} = "$value";
} elsif($attr eq "hash_base64") {
croak "hash specified redundantly"
if exists($self->{hash}) ||
defined($passphrase);
$value =~ m#\A[./0-9A-Za-z]{21}[./01]\z#
or croak "\"$value\" is not a valid hash";
$self->{hash} = _de_base64($value);
} elsif($attr eq "passphrase") {
croak "passphrase specified redundantly"
if exists($self->{hash}) ||
defined($passphrase);
$passphrase = $value;
} else {
croak "unrecognised attribute `$attr'";
}
}
croak "cost not specified" unless exists $self->{cost};
croak "salt not specified" unless exists $self->{salt};
$self->{hash} = $self->_hash_of($passphrase) if defined $passphrase;
croak "hash not specified" unless exists $self->{hash};
return $self;
}
=item Authen::Passphrase::PHPass->from_crypt(PASSWD)
Generates a new phpass passphrase recogniser object from a crypt string.
The crypt string must consist of "B<$P$>", 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.
=cut
sub from_crypt {
my($class, $passwd) = @_;
if($passwd =~ /\A\$P\$/) {
$passwd =~ m#\A\$P\$([./0-9A-Za-z])([!-9;-~]{8})
([./0-9A-Za-z]{22})\z#x
or croak "malformed \$P\$ data";
return $class->new(cost_base64 => $1, salt => $2,
hash_base64 => $3);
}
return $class->SUPER::from_crypt($passwd);
}
=item Authen::Passphrase::PHPass->from_rfc2307(USERPASSWORD)
Generates a new phpass passphrase recogniser object from an RFC 2307
string. The string must consist of "B<{CRYPT}>" (case insensitive)
followed by an acceptable crypt string.
=back
=head1 METHODS
=over
=item $ppr->cost
Returns the base-two logarithm of the number of hashing rounds that will
be performed.
=cut
sub cost {
my($self) = @_;
return $self->{cost};
}
=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.
=cut
sub cost_base64 {
my($self) = @_;
return substr($base64_digits, $self->{cost}, 1);
}
=item $ppr->nrounds_log2
Synonym for C<cost>.
=cut
*nrounds_log2 = \&cost;
=item $ppr->nrounds_log2_base64
Synonym for C<cost_base64>.
=cut
*nrounds_log2_base64 = \&cost_base64;
=item $ppr->salt
Returns the salt, as a string of eight bytes.
=cut
sub salt {
my($self) = @_;
return $self->{salt};
}
=item $ppr->hash
Returns the hash value, as a string of 16 bytes.
=cut
sub hash {
my($self) = @_;
return $self->{hash};
}
=item $ppr->hash_base64
Returns the hash value, as a string of 22 base 64 digits.
=cut
sub hash_base64 {
my($self) = @_;
return _en_base64($self->{hash});
}
=item $ppr->match(PASSPHRASE)
=item $ppr->as_crypt
=item $ppr->as_rfc2307
These methods are part of the standard C<Authen::Passphrase> interface.
=cut
sub _hash_of {
my($self, $passphrase) = @_;
my $ctx = Digest::MD5->new;
$ctx->add($self->{salt});
$ctx->add($passphrase);
my $hash = $ctx->digest;
for(my $i = 1 << $self->{cost}; $i--; ) {
$ctx = Digest::MD5->new;
$ctx->add($hash);
$ctx->add($passphrase);
$hash = $ctx->digest;
}
return $hash;
}
sub match {
my($self, $passphrase) = @_;
return $self->_hash_of($passphrase) eq $self->{hash};
}
sub as_crypt {
my($self) = @_;
croak "can't put this salt into a crypt string"
if $self->{salt} =~ /[^!-9;-~]/;
return "\$P\$".$self->cost_base64.$self->{salt}.$self->hash_base64;
}
=back
=head1 SEE ALSO
L<Authen::Passphrase>,
L<Digest::MD5>
=head1 AUTHOR
Andrew Main (Zefram) <zefram@fysh.org>
=head1 COPYRIGHT
Copyright (C) 2006, 2007, 2009, 2010
Andrew Main (Zefram) <zefram@fysh.org>
=head1 LICENSE
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
1;
|