From 35e1ce98831859b80554bdaf917bfc583442d705 Mon Sep 17 00:00:00 2001 From: Matt Simerson Date: Tue, 8 May 2012 18:04:10 -0400 Subject: [PATCH] consolidate auth logic into Qpsmtpd::Auth These 3 auth plugins all have a data store they fetch the reference password or hash from. They then match the attemped password or hash against the reference. This consolidates the latter portion (validating the password/hash) into Auth.pm. * less duplicated code in the plugins. * Pass validation consistently handled for these 3 plugins. * less work to create new auth plugins Also caches the CRAM-MD5 ticket. It could also cache user/pass info if this was desirable. --- lib/Qpsmtpd/Auth.pm | 59 ++++++++++++++++++++++++++++++++-- lib/Qpsmtpd/Plugin.pm | 14 +++++--- plugins/auth/auth_flat_file | 34 +++++++++++--------- plugins/auth/auth_vpopmail | 45 +++++++------------------- plugins/auth/auth_vpopmail_sql | 47 +++++++++------------------ t/Test/Qpsmtpd/Plugin.pm | 54 ++++++++++++++++++++++++++++++- 6 files changed, 165 insertions(+), 88 deletions(-) diff --git a/lib/Qpsmtpd/Auth.pm b/lib/Qpsmtpd/Auth.pm index ec885b4..52e441d 100644 --- a/lib/Qpsmtpd/Auth.pm +++ b/lib/Qpsmtpd/Auth.pm @@ -4,9 +4,11 @@ package Qpsmtpd::Auth; use strict; use warnings; -use MIME::Base64; use Qpsmtpd::Constants; +use Digest::HMAC_MD5 qw(hmac_md5_hex); +use MIME::Base64; + sub e64 { my ($arg) = @_; my $res = encode_base64($arg); @@ -144,6 +146,7 @@ sub get_auth_details_cram_md5 { return; } + $session->{auth}{ticket} = $ticket; return ($ticket, $user, $passHash); }; @@ -159,6 +162,58 @@ sub get_base64_response { return $answer; }; -# tag: qpsmtpd plugin that sets RELAYCLIENT when the user authentifies +sub validate_password { + my ( $self, %a ) = @_; + + my ($pkg, $file, $line) = caller(); + $file = (split '/', $file)[-1]; # strip off the path + + my $src_clear = $a{src_clear}; + my $src_crypt = $a{src_crypt}; + my $attempt_clear = $a{attempt_clear}; + my $attempt_hash = $a{attempt_hash}; + my $method = $a{method} or die "missing method"; + my $ticket = $a{ticket} || $self->{auth}{ticket}; + my $deny = $a{deny} || DENY; + + if ( ! $src_crypt && ! $src_clear ) { + $self->log(LOGINFO, "fail: missing password"); + return ( $deny, "$file - no such user" ); + }; + + if ( ! $src_clear && $method =~ /CRAM-MD5/i ) { + $self->log(LOGINFO, "skip: cram-md5 not supported w/o clear pass"); + return ( DECLINED, $file ); + } + + if ( defined $attempt_clear ) { + if ( $src_clear && $src_clear eq $attempt_clear ) { + $self->log(LOGINFO, "pass: clear match"); + return ( OK, $file ); + }; + + if ( $src_crypt && $src_crypt eq crypt( $attempt_clear, $src_crypt ) ) { + $self->log(LOGINFO, "pass: crypt match"); + return ( OK, $file ); + } + }; + + if ( defined $attempt_hash && $src_clear ) { + if ( ! $ticket ) { + $self->log(LOGERROR, "skip: missing ticket"); + return ( DECLINED, $file ); + }; + + if ( $attempt_hash eq hmac_md5_hex( $ticket, $src_clear ) ) { + $self->log(LOGINFO, "pass: hash match"); + return ( OK, $file ); + }; + }; + + $self->log(LOGINFO, "fail: wrong password"); + return ( $deny, "$file - wrong password" ); +}; + +# tag: qpsmtpd plugin that sets RELAYCLIENT when the user authenticates 1; diff --git a/lib/Qpsmtpd/Plugin.pm b/lib/Qpsmtpd/Plugin.pm index 7758788..6f4922d 100644 --- a/lib/Qpsmtpd/Plugin.pm +++ b/lib/Qpsmtpd/Plugin.pm @@ -1,12 +1,16 @@ package Qpsmtpd::Plugin; -use Qpsmtpd::Constants; + use strict; +use warnings; + +use Qpsmtpd::Constants; +use Digest::HMAC_MD5 qw(hmac_md5_hex); # more or less in the order they will fire our @hooks = qw( logging config post-fork pre-connection connect ehlo_parse ehlo helo_parse helo auth_parse auth auth-plain auth-login auth-cram-md5 - rcpt_parse rcpt_pre rcpt mail_parse mail mail_pre + rcpt_parse rcpt_pre rcpt mail_parse mail mail_pre data data_headers_end data_post queue_pre queue queue_post vrfy noop quit reset_transaction disconnect post-connection unrecognized_command deny ok received_line help @@ -19,7 +23,7 @@ sub new { bless ({}, $class); } -sub hook_name { +sub hook_name { return shift->{_hook}; } @@ -138,10 +142,10 @@ sub isa_plugin { # why isn't compile private? it's only called from Plugin and Qpsmtpd. sub compile { my ($class, $plugin, $package, $file, $test_mode, $orig_name) = @_; - + my $sub; open F, $file or die "could not open $file: $!"; - { + { local $/ = undef; $sub = ; } diff --git a/plugins/auth/auth_flat_file b/plugins/auth/auth_flat_file index 4d0abbc..a17d051 100644 --- a/plugins/auth/auth_flat_file +++ b/plugins/auth/auth_flat_file @@ -30,7 +30,11 @@ algorithm so no password is transfered in the clear. =cut -use Digest::HMAC_MD5 qw(hmac_md5_hex); +use strict; +use warnings; + +use Qpsmtpd::Auth; +use Qpsmtpd::Constants; sub register { my ( $self, $qp ) = @_; @@ -45,35 +49,35 @@ sub auth_flat_file { @_; if ( ! defined $passClear && ! defined $passHash ) { + $self->log(LOGINFO, "fail: missing password"); return ( DENY, "authflat - missing password" ); } my ( $pw_name, $pw_domain ) = split '@', lc($user); unless ( defined $pw_domain ) { + $self->log(LOGINFO, "fail: missing domain"); return DECLINED; } my ($auth_line) = grep {/^$pw_name\@$pw_domain:/} $self->qp->config('flat_auth_pw'); - + if ( ! defined $auth_line) { - $self->log(LOGINFO, "User not found: $pw_name\@$pw_domain"); + $self->log(LOGINFO, "fail: no such user: $user"); return DECLINED; } - - $self->log(LOGINFO, "Authentication for: $pw_name\@$pw_domain"); my ($auth_user, $auth_pass) = split(/:/, $auth_line, 2); - + # at this point we can assume the user name matched - if ( defined $passClear && $auth_pass eq $passClear ) { - return ( OK, "authflat" ); - }; - - if ( defined $passHash && $passHash eq hmac_md5_hex($ticket, $auth_pass) ) { - return ( OK, "authflat" ); - }; - - return ( DENY, "authflat - wrong password" ); + return Qpsmtpd::Auth::validate_password( $self, + src_clear => $auth_pass, + src_crypt => undef, + attempt_clear => $passClear, + attempt_hash => $passHash, + method => $method, + ticket => $ticket, + deny => DENY, + ); } diff --git a/plugins/auth/auth_vpopmail b/plugins/auth/auth_vpopmail index ab05698..43720c6 100644 --- a/plugins/auth/auth_vpopmail +++ b/plugins/auth/auth_vpopmail @@ -42,9 +42,9 @@ Please see the LICENSE file included with qpsmtpd for details. use strict; use warnings; +use Qpsmtpd::Auth; use Qpsmtpd::Constants; -use Digest::HMAC_MD5 qw(hmac_md5_hex); #use vpopmail; # we eval this in $test_vpopmail sub register { @@ -60,47 +60,26 @@ sub register { sub auth_vpopmail { my ($self, $transaction, $method, $user, $passClear, $passHash, $ticket) = @_; - my ($pw_name, $pw_domain) = split "@", lc($user); - $self->log(LOGINFO, "Authenticating against vpopmail: $user"); - - my $pw = vauth_getpw($pw_name, $pw_domain); + my $pw = vauth_getpw( split '@', lc($user) ); my $pw_clear_passwd = $pw->{pw_clear_passwd}; my $pw_passwd = $pw->{pw_passwd}; - # make sure the user exists if (!$pw || (!$pw_clear_passwd && !$pw_passwd)) { + $self->log(LOGINFO, "fail: invalid user $user"); return (DENY, "auth_vpopmail - invalid user"); - # change DENY to DECLINED to support multiple auth plugins } - return (OK, "auth_vpopmail") - if $pw_passwd eq crypt($passClear, $pw_passwd); - - # simplest case: clear text passwords - if (defined $passClear && defined $pw_clear_passwd) { - return (DENY, "auth_vpopmail - incorrect password") - if $passClear ne $pw_clear_passwd; - return (OK, "auth_vpopmail"); - } - - if ($method =~ /CRAM-MD5/i) { - - # clear_passwd isn't defined so we cannot support CRAM-MD5 - return (DECLINED, "auth_vpopmail") if !defined $pw_clear_passwd; - - if (defined $passHash - and $passHash eq hmac_md5_hex($ticket, $pw_clear_passwd)) - { - } - } - - return (OK, "auth_vpopmail") - if (defined $passHash - && $passHash eq hmac_md5_hex($ticket, $pw_clear_passwd)); - - return (DENY, "auth_vpopmail - unknown error"); + return Qpsmtpd::Auth::validate_password( $self, + src_clear => $pw->{pw_clear_passwd}, + src_crypt => $pw->{pw_passwd}, + attempt_clear => $passClear, + attempt_hash => $passHash, + method => $method, + ticket => $ticket, + deny => DENY, + ); } sub test_vpopmail_module { diff --git a/plugins/auth/auth_vpopmail_sql b/plugins/auth/auth_vpopmail_sql index b68cec2..ca00531 100644 --- a/plugins/auth/auth_vpopmail_sql +++ b/plugins/auth/auth_vpopmail_sql @@ -66,9 +66,10 @@ Please see the LICENSE file included with qpsmtpd for details. use strict; use warnings; -use DBI; +use Qpsmtpd::Auth; use Qpsmtpd::Constants; -use Digest::HMAC_MD5 qw(hmac_md5_hex); + +use DBI; sub register { my ( $self, $qp ) = @_; @@ -122,45 +123,27 @@ sub auth_vmysql { my ( $self, $transaction, $method, $user, $passClear, $passHash, $ticket ) = @_; my $dbh = $self->get_db_handle() or return DECLINED; - my $db_user = $self->get_vpopmail_user($dbh, $user) or return DECLINED; + my $u = $self->get_vpopmail_user($dbh, $user) or return DECLINED; # if vpopmail was not built with '--enable-clear-passwd=y' # then pw_clear_passwd may not even exist - my $pw_clear_passwd = $db_user->{'pw_clear_passwd'}; - my $pw_passwd = $db_user->{'pw_passwd'}; # always present + # my $pw_clear_passwd = $db_user->{'pw_clear_passwd'}; - if ( ! $pw_passwd && ! $pw_clear_passwd ) { + if ( ! $u->{pw_passwd} && ! $u->{pw_clear_passwd} ) { $self->log(LOGINFO, "fail: no such user"); return ( DENY, "auth_vmysql - no such user" ); }; # at this point, the user name has matched - if ( ! $pw_clear_passwd && $method =~ /CRAM-MD5/i ) { - $self->log(LOGINFO, "skip: cram-md5 not supported w/o clear pass"); - return ( DECLINED, "auth_vmysql" ); - } - - if ( defined $passClear ) { - if ( $pw_clear_passwd && $pw_clear_passwd eq $passClear ) { - $self->log(LOGINFO, "pass: clear match"); - return ( OK, "auth_vmysql" ); - }; - - if ( $pw_passwd eq crypt( $passClear, $pw_passwd ) ) { - $self->log(LOGINFO, "pass: crypt match"); - return ( OK, "auth_vmysql" ); - } - }; - - if ( defined $passHash && $pw_clear_passwd && - $passHash eq hmac_md5_hex( $ticket, $pw_clear_passwd ) - ) { - $self->log(LOGINFO, "pass: hash match"); - return ( OK, "auth_vmysql" ); - }; - - $self->log(LOGINFO, "fail: wrong password"); - return ( DENY, "auth_vmysql - wrong password" ); + return Qpsmtpd::Auth::validate_password( $self, + src_clear => $u->{pw_clear_passwd}, + src_crypt => $u->{pw_passwd}, + attempt_clear => $passClear, + attempt_hash => $passHash, + method => $method, + ticket => $ticket, + deny => DENY, + ); } diff --git a/t/Test/Qpsmtpd/Plugin.pm b/t/Test/Qpsmtpd/Plugin.pm index 12edc9f..6e7773d 100644 --- a/t/Test/Qpsmtpd/Plugin.pm +++ b/t/Test/Qpsmtpd/Plugin.pm @@ -4,8 +4,9 @@ package Test::Qpsmtpd::Plugin; # Additional plugin methods used during testing package Qpsmtpd::Plugin; -use Test::More; use strict; +use Test::More; +use Qpsmtpd::Constants; sub register_tests { # Virtual base method - implement in plugin @@ -37,4 +38,55 @@ sub run_tests { } } +sub validate_password { + my ( $self, %a ) = @_; + + my ($pkg, $file, $line) = caller(); + + my $src_clear = $a{src_clear}; + my $src_crypt = $a{src_crypt}; + my $attempt_clear = $a{attempt_clear}; + my $attempt_hash = $a{attempt_hash}; + my $method = $a{method} or die "missing method"; + my $ticket = $a{ticket}; + my $deny = $a{deny} || DENY; + + if ( ! $src_crypt && ! $src_clear ) { + $self->log(LOGINFO, "fail: missing password"); + return ( $deny, "$file - no such user" ); + }; + + if ( ! $src_clear && $method =~ /CRAM-MD5/i ) { + $self->log(LOGINFO, "skip: cram-md5 not supported w/o clear pass"); + return ( DECLINED, $file ); + } + + if ( defined $attempt_clear ) { + if ( $src_clear && $src_clear eq $attempt_clear ) { + $self->log(LOGINFO, "pass: clear match"); + return ( OK, $file ); + }; + + if ( $src_crypt && $src_crypt eq crypt( $attempt_clear, $src_crypt ) ) { + $self->log(LOGINFO, "pass: crypt match"); + return ( OK, $file ); + } + }; + + if ( defined $attempt_hash && $src_clear ) { + if ( ! $ticket ) { + $self->log(LOGERROR, "skip: missing ticket"); + return ( DECLINED, $file ); + }; + + if ( $attempt_hash eq hmac_md5_hex( $ticket, $src_clear ) ) { + $self->log(LOGINFO, "pass: hash match"); + return ( OK, $file ); + }; + }; + + $self->log(LOGINFO, "fail: wrong password"); + return ( $deny, "$file - wrong password" ); +}; + 1;