X-Git-Url: http://git.ieval.ro/?a=blobdiff_plain;f=lib%2FPlack%2FMiddleware%2FAuth%2FComplex.pm;h=d4b5e4b997d218c76cb584f514da5ee5e3ff733e;hb=58b36d0a9ae89d54e341f17988b8f943a4943764;hp=ac70da693554a5aec710f194b3e386ba93fcf874;hpb=d332726d5726e639bc597493c3db9e79fe5a0174;p=plack-middleware-auth-complex.git diff --git a/lib/Plack/Middleware/Auth/Complex.pm b/lib/Plack/Middleware/Auth/Complex.pm index ac70da6..d4b5e4b 100644 --- a/lib/Plack/Middleware/Auth/Complex.pm +++ b/lib/Plack/Middleware/Auth/Complex.pm @@ -4,15 +4,17 @@ use 5.014000; use strict; use warnings; -our $VERSION = '0.001'; +our $VERSION = '0.002'; use parent qw/Plack::Middleware/; use re '/s'; use Authen::Passphrase; use Authen::Passphrase::BlowfishCrypt; -use Bytes::Random::Secure qw/random_bytes/; -use Carp qw/croak/; +use Data::Entropy qw/entropy_source/; +use Data::Entropy::Source; +use Data::Entropy::RawSource::Local; +use Carp qw/carp croak/; use DBI; use Digest::SHA qw/hmac_sha1_base64 sha256/; use Email::Simple; @@ -21,6 +23,18 @@ use MIME::Base64 qw/decode_base64/; use Plack::Request; use Tie::Hash::Expire; +sub make_entropy_source { + if (-e '/dev/urandom') { + Data::Entropy::Source->new( + Data::Entropy::RawSource::Local->new('/dev/urandom'), + 'sysread' + ) + } else { + carp "/dev/urandom not found, using insecure random source\n"; + entropy_source + } +} + sub default_opts {( dbi_connect => ['dbi:Pg:', '', ''], select_user => 'SELECT passphrase, email FROM users WHERE id = ?', @@ -32,6 +46,7 @@ sub default_opts {( cache_max_age => 5 * 60, token_max_age => 60 * 60, username_regex => qr/^\w{2,20}$/as, + invalid_username => 'Invalid username', register_url => '/action/register', passwd_url => '/action/passwd', request_reset_url => '/action/request-reset', @@ -42,6 +57,18 @@ sub new { my ($class, $opts) = @_; my %self = $class->default_opts; %self = (%self, %$opts); + $self{entropy_source} //= make_entropy_source; + # If the user did not set [use_scrypt], we set it to 1 if scrypt + # is available and to 0 otherwise. + # If the user set [use_scrypt] to 1, we try to load scrypt and + # croak if we fail to do so. + unless (exists $self{use_scrypt}) { + my $success = eval 'use Authen::Passphrase::Scrypt'; + $self{use_scrypt} = !!$success + } + if ($self{use_scrypt}) { + eval 'use Authen::Passphrase::Scrypt; 1' or croak "Failed to load Authen::Passphrase::Scrypt: $@\n"; + } my $self = bless \%self, $class; $self } @@ -78,18 +105,31 @@ sub check_passphrase { return $self->{cache}{$cachekey} if exists $self->{cache}{$cachekey}; # uncoverable branch true my $user = $self->get_user($username); return 0 unless $user; - my $ret = Authen::Passphrase->from_rfc2307($user->{passphrase})->match($passphrase); + my $ret; + if ($user->{passphrase} =~ /^{SCRYPT}/) { + croak "$username has a scrypt password but use_scrypt is false\n" unless $self->{use_scrypt}; + $ret = Authen::Passphrase::Scrypt->from_rfc2307($user->{passphrase}) + } else { + $ret = Authen::Passphrase->from_rfc2307($user->{passphrase}); + } + $ret = $ret->match($passphrase); $self->{cache}{$cachekey} = $ret if $ret || $self->{cache_fail}; $ret } sub hash_passphrase { my ($self, $passphrase) = @_; - Authen::Passphrase::BlowfishCrypt->new( - cost => 10, - passphrase => $passphrase, - salt_random => 1, - )->as_rfc2307 + if ($self->{use_scrypt}) { + Authen::Passphrase::Scrypt->new({ + passphrase => $passphrase, + })->as_rfc2307 + } else { + Authen::Passphrase::BlowfishCrypt->new( + cost => 10, + passphrase => $passphrase, + salt_random => 1, + )->as_rfc2307 + } } sub set_passphrase { @@ -99,7 +139,7 @@ sub set_passphrase { sub make_reset_hmac { my ($self, $username, @data) = @_; - $self->{hmackey} //= random_bytes 512; # uncoverable condition false + $self->{hmackey} //= $self->{entropy_source}->get_bits(8 * 512); # uncoverable condition false my $user = $self->get_user($username); my $message = join ' ', $username, $user->{passphrase}, @data; hmac_sha1_base64 $message, $self->{hmackey}; @@ -176,7 +216,7 @@ sub call_register { return $self->bad_request("Missing parameter $_") unless $parms{$_}; } - return $self->bad_request('Username must match ' . $self->{username_regex}) unless $parms{username} =~ $self->{username_regex}; + return $self->bad_request($self->{invalid_username}) unless $parms{username} =~ $self->{username_regex}; return $self->bad_request('Username already in use') if $self->get_user($parms{username}); return $self->bad_request('The two passwords do not match') unless $parms{password} eq $parms{confirm_password}; @@ -331,6 +371,30 @@ This URL performs a password reset. Arrayref of arguments to pass to DBI->connect. Defaults to C<['dbi:Pg', '', '']>. +=item entropy_source + +C object to get random numbers from. By default +uses F via C if +possible, or the default entropy source otherwise. A warning is +printed if the default entropy source is used, to supress it set this +argument to the default entropy source. + +=item use_scrypt + +Boolean determining whether to use the scrypt algorithm via the +C module. + +If true, the default implementation of C uses scrypt +and C accepts scrypt passphrases (in addition to +passphrases supported by C). + +If false, the default implementation of C uses bcrypt +and C only accepts passphrases supported by +C. + +The default value is true if C is +installed, false otherwise. + =item post_connect_cb Callback (coderef) that is called just after connecting to the @@ -391,6 +455,11 @@ Password reset token validity, in seconds. Defaults to 1 hour. Regular expression that matches valid usernames. Defaults to C. +=item invalid_username + +Error message returned when the username does not match +username_regex. Defaults to C<'Invalid username'> + =item register_url URL for registering. Defaults to C<'/action/register'>. @@ -443,13 +512,20 @@ address). =item B(I<$username>, I<$passphrase>) Returns true if the given plaintext passphrase matches the one -obtained from database. Default implementation uses L. +obtained from database. Default implementation uses +L (and L if +C is true). =item B(I<$passphrase>) -Returns a RFC2307-formatted hash of the passphrase. Default -implementation uses L with a cost -of 10 and a random salt. +Returns a RFC2307-formatted hash of the passphrase. + +If C is true, default implementation uses +L with default parameters. + +If C is false, default implementation uses +L with a cost of 10 and a random +salt. =item B(I<$username>, I<$passphrase>) @@ -513,7 +589,7 @@ Marius Gavrilescu, Emarius@ieval.roE =head1 COPYRIGHT AND LICENSE -Copyright (C) 2015 by Marius Gavrilescu +Copyright (C) 2015-2017 by Marius Gavrilescu This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.20.1 or,