Allow jumping directly into account registration process by going to ikiwiki.cgi...

[git.ikiwiki.info.git] / IkiWiki / Plugin / passwordauth.pm

diff --git a/IkiWiki/Plugin/passwordauth.pm b/IkiWiki/Plugin/passwordauth.pm
index af16c27542257de13251adae31acdd6578d31b95..1898030b58e9fca83496b6ca2c865ac0cdac62ac 100644 (file)
--- a/IkiWiki/Plugin/passwordauth.pm
+++ b/IkiWiki/Plugin/passwordauth.pm
@@ -4,29 +4,115 @@ package IkiWiki::Plugin::passwordauth;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 
 

-sub import { #{{{
-        hook(type => "formbuilder_setup", id => "passwordauth",
-               call => \&formbuilder_setup);
-        hook(type => "formbuilder", id => "passwordauth",
-               call => \&formbuilder);
-} # }}}
+sub import {
+       hook(type => "getsetup", id => "passwordauth", "call" => \&getsetup);
+       hook(type => "formbuilder_setup", id => "passwordauth", call => \&formbuilder_setup);
+       hook(type => "formbuilder", id => "passwordauth", call => \&formbuilder);
+       hook(type => "sessioncgi", id => "passwordauth", call => \&sessioncgi);
+       hook(type => "auth", id => "passwordauth", call => \&auth);
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
+               account_creation_password => {
+                       type => "string",
+                       example => "s3cr1t",
+                       description => "a password that must be entered when signing up for an account",
+                       safe => 1,
+                       rebuild => 0,
+               },
+               password_cost => {
+                       type => "integer",
+                       example => 8,
+                       description => "cost of generating a password using Authen::Passphrase::BlowfishCrypt",
+                       safe => 1,
+                       rebuild => 0,
+               },
+}
+
+# Checks if a string matches a user's password, and returns true or false.
+sub checkpassword ($$;$) {
+       my $user=shift;
+       my $password=shift;
+       my $field=shift || "password";
+
+       # It's very important that the user not be allowed to log in with
+       # an empty password!
+       if (! length $password) {
+               return 0;
+       }
+
+       my $userinfo=IkiWiki::userinfo_retrieve();
+       if (! length $user || ! defined $userinfo ||
+           ! exists $userinfo->{$user} || ! ref $userinfo->{$user}) {
+               return 0;
+       }

 
 

-sub formbuilder_setup (@) { #{{{
+       my $ret=0;
+       if (exists $userinfo->{$user}->{"crypt".$field}) {
+               eval q{use Authen::Passphrase};
+               error $@ if $@;
+               my $p = Authen::Passphrase->from_crypt($userinfo->{$user}->{"crypt".$field});
+               $ret=$p->match($password);
+       }
+       elsif (exists $userinfo->{$user}->{$field}) {
+               $ret=$password eq $userinfo->{$user}->{$field};
+       }
+
+       if ($ret &&
+           (exists $userinfo->{$user}->{resettoken} ||
+            exists $userinfo->{$user}->{cryptresettoken})) {
+               # Clear reset token since the user has successfully logged in.
+               delete $userinfo->{$user}->{resettoken};
+               delete $userinfo->{$user}->{cryptresettoken};
+               IkiWiki::userinfo_store($userinfo);
+       }
+
+       return $ret;
+}
+
+sub setpassword ($$;$) {
+       my $user=shift;
+       my $password=shift;
+       my $field=shift || "password";
+
+       eval q{use Authen::Passphrase::BlowfishCrypt};
+       if (! $@) {
+               my $p = Authen::Passphrase::BlowfishCrypt->new(
+                       cost => $config{password_cost} || 8,
+                       salt_random => 1,
+                       passphrase => $password,
+               );
+               IkiWiki::userinfo_set($user, "crypt$field", $p->as_crypt);
+               IkiWiki::userinfo_set($user, $field, "");
+       }
+       else {
+               IkiWiki::userinfo_set($user, $field, $password);
+       }
+}
+
+sub formbuilder_setup (@) {

        my %params=@_;
 
        my $form=$params{form};
        my $session=$params{session};
        my $cgi=$params{cgi};
 
        my %params=@_;
 
        my $form=$params{form};
        my $session=$params{session};
        my $cgi=$params{cgi};
 

-       if ($form->title eq "signin" || $form->title eq "register") {
+       if ($form->title eq "signin" || $form->title eq "register" || $cgi->param("do") eq "register") {

                $form->field(name => "name", required => 0);
                $form->field(name => "password", type => "password", required => 0);
                
                $form->field(name => "name", required => 0);
                $form->field(name => "password", type => "password", required => 0);
                

-               if ($form->submitted eq "Register" || $form->submitted eq "Create Account") {
+               if ($form->submitted eq "Register" || $form->submitted eq "Create Account" || $cgi->param("do") eq "register") {

                        $form->field(name => "confirm_password", type => "password");
                        $form->field(name => "confirm_password", type => "password");

-                       $form->field(name => "account_creation_password", type => "password") if (length $config{account_creation_password});
+                       $form->field(name => "account_creation_password", type => "password")
+                                if (defined $config{account_creation_password} &&
+                                    length $config{account_creation_password});

                        $form->field(name => "email", size => 50);
                        $form->title("register");
                        $form->text("");
                        $form->field(name => "email", size => 50);
                        $form->title("register");
                        $form->text("");


@@ -50,7 +136,7 @@ sub formbuilder_setup (@) { #{{{
                                "Login" => [qw(name password)],
                                "Register" => [],
                                "Create Account" => [qw(name password confirm_password email)],
                                "Login" => [qw(name password)],
                                "Register" => [],
                                "Create Account" => [qw(name password confirm_password email)],

-                               "Mail Password" => [qw(name)],
+                               "Reset Password" => [qw(name)],

                        );
                        foreach my $opt (@{$required{$submittype}}) {
                                $form->field(name => $opt, required => 1);
                        );
                        foreach my $opt (@{$required{$submittype}}) {
                                $form->field(name => $opt, required => 1);


@@ -63,7 +149,8 @@ sub formbuilder_setup (@) { #{{{
                                                shift eq $config{account_creation_password};
                                        },
                                        required => 1,
                                                shift eq $config{account_creation_password};
                                        },
                                        required => 1,

-                               ) if (length $config{account_creation_password});
+                               ) if (defined $config{account_creation_password} &&
+                                     length $config{account_creation_password});

                                $form->field(
                                        name => "email",
                                        validate => "EMAIL",
                                $form->field(
                                        name => "email",
                                        validate => "EMAIL",


@@ -75,14 +162,13 @@ sub formbuilder_setup (@) { #{{{
                                $form->field(
                                        name => "password",
                                        validate => sub {
                                $form->field(
                                        name => "password",
                                        validate => sub {

-                                               length $form->field("name") &&
-                                               shift eq IkiWiki::userinfo_get($form->field("name"), 'password');
+                                               checkpassword($form->field("name"), shift);

                                        },
                                );
                        }
                        elsif ($submittype eq "Register" ||
                               $submittype eq "Create Account" ||
                                        },
                                );
                        }
                        elsif ($submittype eq "Register" ||
                               $submittype eq "Create Account" ||

-                              $submittype eq "Mail Password") {
+                              $submittype eq "Reset Password") {

                                $form->field(name => "password", validate => 'VALUE');
                        }
                        
                                $form->field(name => "password", validate => 'VALUE');
                        }
                        


@@ -101,7 +187,7 @@ sub formbuilder_setup (@) { #{{{
                                );
                        }
                        elsif ($submittype eq "Login" ||
                                );
                        }
                        elsif ($submittype eq "Login" ||

-                              $submittype eq "Mail Password") {
+                              $submittype eq "Reset Password") {

                                $form->field( 
                                        name => "name",
                                        validate => sub {
                                $form->field( 
                                        name => "name",
                                        validate => sub {


@@ -137,7 +223,7 @@ sub formbuilder_setup (@) { #{{{
        }
 }
 
        }
 }
 

-sub formbuilder (@) { #{{{
+sub formbuilder (@) {

        my %params=@_;
 
        my $form=$params{form};
        my %params=@_;
 
        my $form=$params{form};


@@ -146,7 +232,7 @@ sub formbuilder (@) { #{{{
        my $buttons=$params{buttons};
 
        if ($form->title eq "signin" || $form->title eq "register") {
        my $buttons=$params{buttons};
 
        if ($form->title eq "signin" || $form->title eq "register") {

-               if ($form->submitted && $form->validate) {
+               if (($form->submitted && $form->validate) || $cgi->param("do") eq "register") {

                        if ($form->submitted eq 'Login') {
                                $session->param("name", $form->field("name"));
                                IkiWiki::cgi_postsignin($cgi, $session);
                        if ($form->submitted eq 'Login') {
                                $session->param("name", $form->field("name"));
                                IkiWiki::cgi_postsignin($cgi, $session);


@@ -155,8 +241,8 @@ sub formbuilder (@) { #{{{
                                my $user_name=$form->field('name');
                                if (IkiWiki::userinfo_setall($user_name, {
                                        'email' => $form->field('email'),
                                my $user_name=$form->field('name');
                                if (IkiWiki::userinfo_setall($user_name, {
                                        'email' => $form->field('email'),

-                                       'password' => $form->field('password'),

                                        'regdate' => time})) {
                                        'regdate' => time})) {

+                                       setpassword($user_name, $form->field('password'));

                                        $form->field(name => "confirm_password", type => "hidden");
                                        $form->field(name => "email", type => "hidden");
                                        $form->text(gettext("Account creation successful. Now you can Login."));
                                        $form->field(name => "confirm_password", type => "hidden");
                                        $form->field(name => "email", type => "hidden");
                                        $form->text(gettext("Account creation successful. Now you can Login."));


@@ -165,31 +251,51 @@ sub formbuilder (@) { #{{{
                                        error(gettext("Error creating account."));
                                }
                        }
                                        error(gettext("Error creating account."));
                                }
                        }

-                       elsif ($form->submitted eq 'Mail Password') {
+                       elsif ($form->submitted eq 'Reset Password') {

                                my $user_name=$form->field("name");
                                my $user_name=$form->field("name");

+                               my $email=IkiWiki::userinfo_get($user_name, "email");
+                               if (! length $email) {
+                                       error(gettext("No email address, so cannot email password reset instructions."));
+                               }
+                               
+                               # Store a token that can be used once
+                               # to log the user in. This needs to be hard
+                               # to guess. Generating a cgi session id will
+                               # make it as hard to guess as any cgi session.
+                               eval q{use CGI::Session};
+                               error($@) if $@;
+                               my $token = CGI::Session->new->id;
+                               setpassword($user_name, $token, "resettoken");
+                               

                                my $template=template("passwordmail.tmpl");
                                $template->param(
                                        user_name => $user_name,
                                my $template=template("passwordmail.tmpl");
                                $template->param(
                                        user_name => $user_name,

-                                       user_password => IkiWiki::userinfo_get($user_name, "password"),
+                                       passwordurl => IkiWiki::cgiurl(
+                                               'do' => "reset",
+                                               'name' => $user_name,
+                                               'token' => $token,
+                                       ),

                                        wikiurl => $config{url},
                                        wikiname => $config{wikiname},
                                        REMOTE_ADDR => $ENV{REMOTE_ADDR},
                                );
                                        wikiurl => $config{url},
                                        wikiname => $config{wikiname},
                                        REMOTE_ADDR => $ENV{REMOTE_ADDR},
                                );

-                       
+                               

                                eval q{use Mail::Sendmail};
                                error($@) if $@;
                                sendmail(
                                        To => IkiWiki::userinfo_get($user_name, "email"),
                                eval q{use Mail::Sendmail};
                                error($@) if $@;
                                sendmail(
                                        To => IkiWiki::userinfo_get($user_name, "email"),

-                                       From => "$config{wikiname} admin <$config{adminemail}>",
+                                       From => "$config{wikiname} admin <".
+                                               (defined $config{adminemail} ? $config{adminemail} : "")
+                                               .">",

                                        Subject => "$config{wikiname} information",
                                        Message => $template->output,
                                ) or error(gettext("Failed to send mail"));
                                        Subject => "$config{wikiname} information",
                                        Message => $template->output,
                                ) or error(gettext("Failed to send mail"));

-                       
-                               $form->text(gettext("Your password has been emailed to you."));
+                               
+                               $form->text(gettext("You have been mailed password reset instructions."));

                                $form->field(name => "name", required => 0);
                                $form->field(name => "name", required => 0);

-                               push @$buttons, "Mail Password";
+                               push @$buttons, "Reset Password";

                        }
                        }

-                       elsif ($form->submitted eq "Register") {
+                       elsif ($form->submitted eq "Register" || $cgi->param("do") eq "register") {

                                @$buttons="Create Account";
                        }
                }
                                @$buttons="Create Account";
                        }
                }


@@ -197,20 +303,53 @@ sub formbuilder (@) { #{{{
                        @$buttons="Create Account";
                }
                else {
                        @$buttons="Create Account";
                }
                else {

-                       push @$buttons, "Register", "Mail Password";
+                       push @$buttons, "Register", "Reset Password";

                }
        }
        elsif ($form->title eq "preferences") {
                if ($form->submitted eq "Save Preferences" && $form->validate) {
                        my $user_name=$form->field('name');
                }
        }
        elsif ($form->title eq "preferences") {
                if ($form->submitted eq "Save Preferences" && $form->validate) {
                        my $user_name=$form->field('name');

-                       foreach my $field (qw(password)) {
-                               if (defined $form->field($field) && length $form->field($field)) {
-                                       IkiWiki::userinfo_set($user_name, $field, $form->field($field)) ||
-                                               error("failed to set $field");
-                               }
-                       }
+                       if ($form->field("password") && length $form->field("password")) {
+                               setpassword($user_name, $form->field('password'));
+                       }
+               }
+       }
+}
+
+sub sessioncgi ($$) {
+       my $q=shift;
+       my $session=shift;
+
+       if ($q->param('do') eq 'reset') {
+               my $name=$q->param("name");
+               my $token=$q->param("token");
+
+               if (! defined $name || ! defined $token ||
+                   ! length $name  || ! length $token) {
+                       error(gettext("incorrect password reset url"));
+               }
+               if (! checkpassword($name, $token, "resettoken")) {
+                       error(gettext("password reset denied"));

                }
                }

+
+               $session->param("name", $name);
+               IkiWiki::cgi_prefs($q, $session);
+               exit;

        }
        }

-} #}}}
+       elsif ($q->param("do") eq "register") {
+               # After registration, need to go somewhere, so show prefs page.
+               $session->param(postsignin => "do=prefs");
+               # Due to do=register, this will run in registration-only
+               # mode.
+               IkiWiki::cgi_signin($q, $session);
+               exit;
+       }
+}
+
+sub auth ($$) {
+       # While this hook is not currently used, it needs to exist
+       # so ikiwiki knows that the wiki supports logins, and will
+       # enable the Preferences page.
+}

 
 1
 
 1