Bug 300410: Bugzilla::Auth needs to be restructured to not require a BEGIN block

Patch By Max Kanat-Alexander <mkanat@bugzilla.org> r=LpSolit, a=myk

3 files changed, 0 insertions, 544 deletions

diff --git a/Bugzilla/Auth/Login/WWW/CGI.pm b/Bugzilla/Auth/Login/WWW/CGI.pm
deleted file mode 100644
index 5030691e3..000000000
--- a/Bugzilla/Auth/Login/WWW/CGI.pm
+++ /dev/null
@@ -1,275 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# The contents of this file are subject to the Mozilla Public
-# License Version 1.1 (the "License"); you may not use this file
-# except in compliance with the License. You may obtain a copy of
-# the License at http://www.mozilla.org/MPL/
-#
-# Software distributed under the License is distributed on an "AS
-# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
-# implied. See the License for the specific language governing
-# rights and limitations under the License.
-#
-# The Original Code is the Bugzilla Bug Tracking System.
-#
-# The Initial Developer of the Original Code is Netscape Communications
-# Corporation. Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): Terry Weissman <terry@mozilla.org>
-#                 Dan Mosedale <dmose@mozilla.org>
-#                 Joe Robins <jmrobins@tgix.com>
-#                 Dave Miller <justdave@syndicomm.com>
-#                 Christopher Aillon <christopher@aillon.com>
-#                 Gervase Markham <gerv@gerv.net>
-#                 Christian Reis <kiko@async.com.br>
-#                 Bradley Baetz <bbaetz@acm.org>
-#                 Erik Stambaugh <erik@dasbistro.com>
-
-package Bugzilla::Auth::Login::WWW::CGI;
-
-use strict;
-
-use Bugzilla::Config;
-use Bugzilla::Constants;
-use Bugzilla::Error;
-use Bugzilla::Util;
-use Bugzilla::Token;
-
-sub login {
-    my ($class, $type) = @_;
-
-    # 'NORMAL' logins depend on the 'requirelogin' param
-    if ($type == LOGIN_NORMAL) {
-        $type = Param('requirelogin') ? LOGIN_REQUIRED : LOGIN_OPTIONAL;
-    }
-
-    my $cgi = Bugzilla->cgi;
-    my $dbh = Bugzilla->dbh;
-
-    # First, try the actual login method against form variables
-    my $username = trim($cgi->param("Bugzilla_login"));
-    my $passwd = $cgi->param("Bugzilla_password");
-    
-    $cgi->delete('Bugzilla_login', 'Bugzilla_password');
-
-    # Perform the actual authentication, get the method name from the class name
-    my ($authmethod, $authres, $userid, $extra, $info) =
-      Bugzilla::Auth->authenticate($username, $passwd);
-
-    if ($authres == AUTH_OK) {
-        # Login via username/password was correct and valid, so create
-        # and send out the login cookies
-        my $ipaddr = $cgi->remote_addr;
-        unless ($cgi->param('Bugzilla_restrictlogin') ||
-                Param('loginnetmask') == 32) {
-            $ipaddr = Bugzilla::Auth::get_netaddr($ipaddr);
-        }
-
-        # The IP address is valid, at least for comparing with itself in a
-        # subsequent login
-        trick_taint($ipaddr);
-
-        my $logincookie = Bugzilla::Token::GenerateUniqueToken('logincookies', 'cookie');
-
-        $dbh->do("INSERT INTO logincookies (cookie, userid, ipaddr, lastused)
-                 VALUES (?, ?, ?, NOW())",
-                 undef,
-                 $logincookie, $userid, $ipaddr);
-
-        # Remember cookie only if admin has told so
-        # or admin didn't forbid it and user told to remember.
-        if ((Param('rememberlogin') eq 'on') ||
-            ((Param('rememberlogin') ne 'off') &&
-             $cgi->param('Bugzilla_remember') &&
-             ($cgi->param('Bugzilla_remember') eq 'on'))) {
-            $cgi->send_cookie(-name => 'Bugzilla_login',
-                              -value => $userid,
-                              -expires => 'Fri, 01-Jan-2038 00:00:00 GMT');
-            $cgi->send_cookie(-name => 'Bugzilla_logincookie',
-                              -value => $logincookie,
-                              -expires => 'Fri, 01-Jan-2038 00:00:00 GMT');
-
-        }
-        else {
-            $cgi->send_cookie(-name => 'Bugzilla_login',
-                              -value => $userid);
-            $cgi->send_cookie(-name => 'Bugzilla_logincookie',
-                              -value => $logincookie);
-        }
-    }
-    elsif ($authres == AUTH_NODATA) {
-        # No data from the form, so try to login via cookies
-        $username = $cgi->cookie("Bugzilla_login");
-        $passwd = $cgi->cookie("Bugzilla_logincookie");
-
-        require Bugzilla::Auth::Login::WWW::CGI::Cookie;
-        my $authmethod = "Cookie";
-
-        ($authres, $userid, $extra) =
-          Bugzilla::Auth::Login::WWW::CGI::Cookie->authenticate($username, $passwd);
-
-        # If the data for the cookie was incorrect, then treat that as
-        # NODATA. This could occur if the user's IP changed, for example.
-        # Give them un-loggedin access if allowed (checked below)
-        $authres = AUTH_NODATA if $authres == AUTH_LOGINFAILED;
-    }
-
-    # Now check the result
-
-    # An error may have occurred with the login mechanism
-    if ($authres == AUTH_ERROR) {
-        ThrowCodeError("auth_err",
-                       { authmethod => lc($authmethod),
-                         userid => $userid,
-                         auth_err_tag => $extra,
-                         info => $info
-                       });
-    }
-
-    # We can load the page if the login was ok, or there was no data
-    # but a login wasn't required
-    if ($authres == AUTH_OK ||
-        ($authres == AUTH_NODATA && $type == LOGIN_OPTIONAL)) {
-
-        # login succeded, so we're done
-        return $userid;
-    }
-
-    # No login details were given, but we require a login if the
-    # page does
-    if ($authres == AUTH_NODATA && $type == LOGIN_REQUIRED) {
-
-        # Redirect to SSL if required
-        if (Param('sslbase') ne '' and Param('ssl') ne 'never') {
-            $cgi->require_https(Param('sslbase'));
-        }
-    
-        # Throw up the login page
-
-        print Bugzilla->cgi->header();
-
-        my $template = Bugzilla->template;
-        $template->process("account/auth/login.html.tmpl",
-                           { 'target' => $cgi->url(-relative=>1),
-                             'caneditaccount' => Bugzilla::Auth->can_edit('new'),
-                             'has_db' => Bugzilla::Auth->has_db,
-                           }
-                          )
-          || ThrowTemplateError($template->error());
-
-        # This seems like as good as time as any to get rid of old
-        # crufty junk in the logincookies table.  Get rid of any entry
-        # that hasn't been used in a month.
-        $dbh->do("DELETE FROM logincookies WHERE " .
-                 $dbh->sql_to_days('NOW()') . " - " .
-                 $dbh->sql_to_days('lastused') . " > 30");
-
-        exit;
-    }
-
-    # The username/password may be wrong
-    # Don't let the user know whether the username exists or whether
-    # the password was just wrong. (This makes it harder for a cracker
-    # to find account names by brute force)
-    if ($authres == AUTH_LOGINFAILED) {
-        ThrowUserError("invalid_username_or_password");
-    }
-
-    # The account may be disabled
-    if ($authres == AUTH_DISABLED) {
-        clear_browser_cookies();
-        # and throw a user error
-        ThrowUserError("account_disabled",
-                       {'disabled_reason' => $extra});
-    }
-
-    # If we get here, then we've run out of options, which shouldn't happen
-    ThrowCodeError("authres_unhandled", { authres => $authres, 
-                                          type => $type });
-}
-
-# This auth style allows the user to log out.
-sub can_logout { return 1; }
-
-# Logs user out, according to the option provided; this consists of
-# removing entries from logincookies for the specified $user.
-sub logout {
-    my ($class, $user, $option) = @_;
-    my $dbh = Bugzilla->dbh;
-    my $cgi = Bugzilla->cgi;
-    $option = LOGOUT_ALL unless defined $option;
-
-    if ($option == LOGOUT_ALL) {
-            $dbh->do("DELETE FROM logincookies WHERE userid = ?",
-                     undef, $user->id);
-            return;
-    }
-
-    # The LOGOUT_*_CURRENT options require the current login cookie.
-    # If a new cookie has been issued during this run, that's the current one.
-    # If not, it's the one we've received.
-    my $cookie;
-    foreach (@{$cgi->{'Bugzilla_cookie_list'}}) {
-        if ($_->name() eq 'Bugzilla_logincookie') {
-            $cookie = $_->value();
-            last;
-        }
-    }
-    $cookie ||= $cgi->cookie("Bugzilla_logincookie");
-    trick_taint($cookie);
-
-    # These queries use both the cookie ID and the user ID as keys. Even
-    # though we know the userid must match, we still check it in the SQL
-    # as a sanity check, since there is no locking here, and if the user
-    # logged out from two machines simultaneously, while someone else
-    # logged in and got the same cookie, we could be logging the other
-    # user out here. Yes, this is very very very unlikely, but why take
-    # chances? - bbaetz
-    if ($option == LOGOUT_KEEP_CURRENT) {
-        $dbh->do("DELETE FROM logincookies WHERE cookie != ? AND userid = ?",
-                 undef, $cookie, $user->id);
-    } elsif ($option == LOGOUT_CURRENT) {
-        $dbh->do("DELETE FROM logincookies WHERE cookie = ? AND userid = ?",
-                 undef, $cookie, $user->id);
-    } else {
-        die("Invalid option $option supplied to logout()");
-    }
-
-    if ($option != LOGOUT_KEEP_CURRENT) {
-        clear_browser_cookies();
-        Bugzilla->logout_request();
-    }
-}
-
-sub clear_browser_cookies {
-    my $cgi = Bugzilla->cgi;
-    $cgi->remove_cookie('Bugzilla_login');
-    $cgi->remove_cookie('Bugzilla_logincookie');
-}
-
-1;
-
-__END__
-
-=head1 NAME
-
-Bugzilla::Auth::Login::WWW::CGI - CGI-based logins for Bugzilla
-
-=head1 SUMMARY
-
-This is a L<login module|Bugzilla::Auth/"LOGIN"> for Bugzilla. Users connecting
-from a CGI script use this module to authenticate. Logouts are also handled here.
-
-=head1 BEHAVIOUR
-
-Users are first authenticated against the default authentication handler,
-using the CGI parameters I<Bugzilla_login> and I<Bugzilla_password>.
-
-If no data is present for that, then cookies are tried, using
-L<Bugzilla::Auth::Login::WWW::CGI::Cookie>.
-
-=head1 SEE ALSO
-
-L<Bugzilla::Auth>
diff --git a/Bugzilla/Auth/Login/WWW/CGI/Cookie.pm b/Bugzilla/Auth/Login/WWW/CGI/Cookie.pm
deleted file mode 100644
index c2244d15d..000000000
--- a/Bugzilla/Auth/Login/WWW/CGI/Cookie.pm
+++ /dev/null
@@ -1,113 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# The contents of this file are subject to the Mozilla Public
-# License Version 1.1 (the "License"); you may not use this file
-# except in compliance with the License. You may obtain a copy of
-# the License at http://www.mozilla.org/MPL/
-#
-# Software distributed under the License is distributed on an "AS
-# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
-# implied. See the License for the specific language governing
-# rights and limitations under the License.
-#
-# The Original Code is the Bugzilla Bug Tracking System.
-#
-# The Initial Developer of the Original Code is Netscape Communications
-# Corporation. Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): Terry Weissman <terry@mozilla.org>
-#                 Dan Mosedale <dmose@mozilla.org>
-#                 Joe Robins <jmrobins@tgix.com>
-#                 Dave Miller <justdave@syndicomm.com>
-#                 Christopher Aillon <christopher@aillon.com>
-#                 Gervase Markham <gerv@gerv.net>
-#                 Christian Reis <kiko@async.com.br>
-#                 Bradley Baetz <bbaetz@acm.org>
-
-package Bugzilla::Auth::Login::WWW::CGI::Cookie;
-
-use strict;
-
-use Bugzilla::Auth;
-use Bugzilla::Config;
-use Bugzilla::Constants;
-use Bugzilla::Util;
-
-sub authenticate {
-    my ($class, $login, $login_cookie) = @_;
-
-    return (AUTH_NODATA) unless defined $login && defined $login_cookie;
-
-    my $cgi = Bugzilla->cgi;
-
-    my $ipaddr = $cgi->remote_addr();
-    my $netaddr = Bugzilla::Auth::get_netaddr($ipaddr);
-
-    # Anything goes for these params - they're just strings which
-    # we're going to verify against the db
-    trick_taint($login);
-    trick_taint($login_cookie);
-    trick_taint($ipaddr);
-
-    my $query = "SELECT profiles.userid, profiles.disabledtext " .
-                "FROM logincookies, profiles " .
-                "WHERE logincookies.cookie=? AND " .
-                "  logincookies.userid=profiles.userid AND " .
-                "  logincookies.userid=? AND " .
-                "  (logincookies.ipaddr=?";
-    my @params = ($login_cookie, $login, $ipaddr);
-    if (defined $netaddr) {
-        trick_taint($netaddr);
-        $query .= " OR logincookies.ipaddr=?";
-        push(@params, $netaddr);
-    }
-    $query .= ")";
-
-    my $dbh = Bugzilla->dbh;
-    my ($userid, $disabledtext) = $dbh->selectrow_array($query, undef, @params);
-
-    return (AUTH_DISABLED, $userid, $disabledtext)
-      if ($disabledtext);
-
-    if ($userid) {
-        # If we logged in successfully, then update the lastused time on the
-        # login cookie
-        $dbh->do("UPDATE logincookies SET lastused=NOW() WHERE cookie=?",
-                 undef,
-                 $login_cookie);
-
-        return (AUTH_OK, $userid);
-    }
-
-    # If we get here, then the login failed.
-    return (AUTH_LOGINFAILED);
-}
-
-1;
-
-__END__
-
-=head1 NAME
-
-Bugzilla::Auth::Login::WWW::CGI::Cookie - cookie authentication for Bugzilla
-
-=head1 SUMMARY
-
-This is an L<authentication module|Bugzilla::Auth/"AUTHENTICATION"> for
-Bugzilla, which logs the user in using a persistent cookie stored in the
-C<logincookies> table.
-
-The actual password is not stored in the cookie; only the userid and a
-I<logincookie> (which is used to reverify the login without requiring the
-password to be sent over the network) are. These I<logincookies> are
-restricted to certain IP addresses as a security meaure. The exact
-restriction can be specified by the admin via the C<loginnetmask> parameter.
-
-This module does not ever send a cookie (It has no way of knowing when a user
-is successfully logged in). Instead L<Bugzilla::Auth::Login::WWW::CGI> handles this.
-
-=head1 SEE ALSO
-
-L<Bugzilla::Auth>, L<Bugzilla::Auth::Login::WWW::CGI>
diff --git a/Bugzilla/Auth/Login/WWW/Env.pm b/Bugzilla/Auth/Login/WWW/Env.pm
deleted file mode 100644
index f437bf06f..000000000
--- a/Bugzilla/Auth/Login/WWW/Env.pm
+++ /dev/null
@@ -1,156 +0,0 @@
-# -*- Mode: perl; indent-tabs-mode: nil -*-
-#
-# The contents of this file are subject to the Mozilla Public
-# License Version 1.1 (the "License"); you may not use this file
-# except in compliance with the License. You may obtain a copy of
-# the License at http://www.mozilla.org/MPL/
-#
-# Software distributed under the License is distributed on an "AS
-# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
-# implied. See the License for the specific language governing
-# rights and limitations under the License.
-#
-# The Original Code is the Bugzilla Bug Tracking System.
-#
-# The Initial Developer of the Original Code is Netscape Communications
-# Corporation. Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): Erik Stambaugh <erik@dasbistro.com>
-
-package Bugzilla::Auth::Login::WWW::Env;
-
-use strict;
-
-use Bugzilla::Config;
-use Bugzilla::Error;
-use Bugzilla::Util;
-use Bugzilla::User;
-
-sub login {
-    my ($class, $type) = @_;
-    my $dbh = Bugzilla->dbh;
-
-    # XXX This does not currently work correctly with Param('requirelogin').
-    #     Bug 253636 will hopefully see that param's needs taken care of in a
-    #     parent module, but for the time being, this module does not honor
-    #     the param in the way that CGI.pm does.
-
-    my $matched_userid;
-    my $matched_extern_id;
-    my $disabledtext;
-
-    # Gather the environment variables
-    my $env_id       = $ENV{Param("auth_env_id")} || '';
-    my $env_email    = $ENV{Param("auth_env_email")} || '';
-    my $env_realname = $ENV{Param("auth_env_realname")} || '';
-
-    # make sure the email field contains only a valid email address
-    my $emailregexp = Param("emailregexp");
-    if ($env_email =~ /($emailregexp)/) {
-        $env_email = $1;
-    }
-    else {
-        $env_email = '';
-    }
-
-    return undef unless $env_email;
-
-    # untaint the remaining values
-    trick_taint($env_id);
-    trick_taint($env_realname);
-
-    # Look in the DB for the extern_id
-    if ($env_id) {
-        ($matched_userid, $disabledtext) =
-            $dbh->selectrow_array('SELECT userid, disabledtext
-                                   FROM profiles WHERE extern_id = ?',
-                                   undef, $env_id);
-    }
-
-    unless ($matched_userid) {
-        # There was either no match for the external ID given, or one was
-        # not present.
-        #
-        # Check to see if the email address is in there and has no
-        # external id assigned.  We test for both the login name (which we
-        # also sent), and the id, so that we have a way of telling that we
-        # got something instead of a bunch of NULLs
-        ($matched_extern_id, $matched_userid, $disabledtext) =
-            $dbh->selectrow_array('SELECT extern_id, userid, disabledtext
-                                   FROM profiles WHERE ' .
-                                   $dbh->sql_istrcmp('login_name', '?'),
-                                   undef, $env_email);
-
-        if ($matched_userid) {
-            if ($matched_extern_id) {
-                # someone with a different external ID has that address!
-                ThrowUserError("extern_id_conflict");
-            }
-            else {
-                # someone with no external ID used that address, time to
-                # add the ID!
-                $dbh->do('UPDATE profiles SET extern_id = ? WHERE userid = ?',
-                         undef,($env_id, $matched_userid));
-            }
-        }
-        else {
-            # Need to create a new user with that email address.  Note
-            # that cryptpassword has been filled in with '*', since the
-            # user has no DB password.
-            insert_new_user($env_email, $env_realname, '*');
-            my $new_user = Bugzilla::User->new_from_login($env_email);
-            $matched_userid = $new_user->id;
-        }
-    }
-
-    # now that we hopefully have a username, we need to see if the data
-    # has to be updated. If we just created this account, then the data
-    # is already up to date.
-    my ($username, $this_realname) =
-        $dbh->selectrow_array('SELECT login_name, realname
-                               FROM profiles WHERE userid = ?',
-                               undef, $matched_userid);
-
-    if (($username ne $env_email) || ($this_realname ne $env_realname)) {
-        $dbh->do('UPDATE profiles SET login_name = ?, realname = ?
-                  WHERE userid = ?', undef,
-                  ($env_email, ($env_realname || $this_realname), $matched_userid));
-
-        # If the login name may be new, make sure the regexp groups are current
-        my $userprofile = new Bugzilla::User($matched_userid);
-        $userprofile->derive_regexp_groups;
-    }
-
-    # Now we throw an error if the user has been disabled
-    if ($disabledtext) {
-        ThrowUserError("account_disabled",
-                       {'disabled_reason' => $disabledtext});
-    }
-
-    return $matched_userid;
-}
-
-# This auth style does not allow the user to log out.
-sub can_logout { return 0; }
-
-1;
-
-__END__
-
-=head1 NAME
-
-Bugzilla::Auth::Env - Environment Variable Authentication
-
-=head1 DESCRIPTION
-
-Many external user authentication systems supply login information to CGI
-programs via environment variables.  This module checks to see if those
-variables are populated and, if so, assumes authentication was successful and
-returns the user's ID, having automatically created a new profile if
-necessary.
-
-=head1 SEE ALSO
-
-L<Bugzilla::Auth>