(no commit message)

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

diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm
index de31f38ee3fffb7d8e9910afd5fadcf46ad41983..35ef52a581e745a38d11b5d43a57d8dc4cab558e 100644 (file)
--- a/IkiWiki/Plugin/openid.pm
+++ b/IkiWiki/Plugin/openid.pm
@@ -4,91 +4,106 @@ package IkiWiki::Plugin::openid;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 
 

-sub import { #{{{
-       hook(type => "getopt", id => "openid", call => \&getopt);
+sub import {
+       hook(type => "getsetup", id => "openid", call => \&getsetup);

        hook(type => "auth", id => "openid", call => \&auth);
        hook(type => "formbuilder_setup", id => "openid",
                call => \&formbuilder_setup, last => 1);
        hook(type => "auth", id => "openid", call => \&auth);
        hook(type => "formbuilder_setup", id => "openid",
                call => \&formbuilder_setup, last => 1);

-} # }}}
+       IkiWiki::loadplugin("emailauth");
+       IkiWiki::loadplugin("loginselector");
+       IkiWiki::Plugin::loginselector::register_login_plugin(
+               "openid",
+               \&openid_setup,
+               \&openid_check_input,
+               \&openid_auth,
+       );
+}

 
 

-sub getopt () { #{{{
-       eval q{use Getopt::Long};
-       error($@) if $@;
-       Getopt::Long::Configure('pass_through');
-       GetOptions("openidsignup=s" => \$config{openidsignup});
-} #}}}
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+                       section => "auth",
+               },
+               openid_realm => {
+                       type => "string",
+                       description => "url pattern of openid realm (default is cgiurl)",
+                       safe => 0,
+                       rebuild => 0,
+               },
+               openid_cgiurl => {
+                       type => "string",
+                       description => "url to ikiwiki cgi to use for openid authentication (default is cgiurl)",
+                       safe => 0,
+                       rebuild => 0,
+               },
+}
+
+sub openid_setup ($$) {
+       my $q=shift;
+       my $template=shift;
+
+       if (load_openid_module()) {
+               my $openid_url=$q->param('openid_identifier');
+               if (defined $openid_url) {
+                       $template->param(openid_url => $openid_url);
+               }
+               return 1;
+       }
+       else {
+               return 0;
+       }
+}
+
+sub openid_check_input ($) {
+       my $q=shift;
+       my $openid_url=$q->param('openid_identifier');
+       defined $q->param("action") && $q->param("action") eq "verify" && defined $openid_url && length $openid_url;
+}

 
 

-sub formbuilder_setup (@) { #{{{
+sub openid_auth ($$$$) {
+       my $q=shift;
+       my $session=shift;
+       my $errordisplayer=shift;
+       my $openid_url=$q->param('openid_identifier');
+       validate($q, $session, $openid_url, $errordisplayer);
+}
+
+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};
        

-       # Give up if module is unavailable to avoid needing to depend on
-       # it.
-       eval q{use Net::OpenID::Consumer};
-       if ($@) {
-               debug("unable to load Net::OpenID::Consumer, not enabling OpenID login");
-               return;
-       }
-
-       if ($form->title eq "signin") {
-               # This avoids it displaying a redundant label for the
-               # OpenID fieldset.
-               $form->fieldsets("OpenID");
-
-               $form->field(
-                       name => "openid_url",
-                       label => gettext("Log in with")." ".htmllink("", "", "ikiwiki/OpenID", noimageinline => 1),
-                       fieldset => "OpenID",
-                       size => 30,
-                       comment => ($config{openidsignup} ? " | <a href=\"$config{openidsignup}\">".gettext("Get an OpenID")."</a>" : "")
-               );
-
-               # Handle submission of an OpenID as validation.
-               if ($form->submitted && $form->submitted eq "Login" &&
-                   defined $form->field("openid_url") && 
-                   length $form->field("openid_url")) {
-                       $form->field(
-                               name => "openid_url",
-                               validate => sub {
-                                       validate($cgi, $session, shift, $form);
-                               },
-                       );
-                       # Skip all other required fields in this case.
-                       foreach my $field ($form->field) {
-                               next if $field eq "openid_url";
-                               $form->field(name => $field, required => 0,
-                                       validate => '/.*/');
-                       }
-               }
-       }
-       elsif ($form->title eq "preferences") {
-               if (! defined $form->field(name => "name")) {
-                       $form->field(name => "OpenID", disabled => 1,
-                               value => $session->param("name"), 
-                               size => 50, force => 1,
-                               fieldset => "login");
-               }
+       if ($form->title eq "preferences" &&
+              IkiWiki::openiduser($session->param("name"))) {
+               $form->field(name => "openid_identifier", disabled => 1,
+                       label => htmllink("", "", "ikiwiki/OpenID", noimageinline => 1),
+                       value => "", 
+                       size => 1, force => 1,
+                       fieldset => "login",
+                       comment => $session->param("name"));

        }
 }
 
        }
 }
 

-sub validate ($$$;$) { #{{{
+sub validate ($$$;$) {

        my $q=shift;
        my $session=shift;
        my $openid_url=shift;
        my $q=shift;
        my $session=shift;
        my $openid_url=shift;

-       my $form=shift;
+       my $errhandler=shift;

 
        my $csr=getobj($q, $session);
 
        my $claimed_identity = $csr->claimed_identity($openid_url);
        if (! $claimed_identity) {
 
        my $csr=getobj($q, $session);
 
        my $claimed_identity = $csr->claimed_identity($openid_url);
        if (! $claimed_identity) {

-               if ($form) {
-                       # Put the error in the form and fail validation.
-                       $form->field(name => "openid_url", comment => $csr->err);
+               if ($errhandler) {
+                       if (ref($errhandler) eq 'CODE') {
+                               $errhandler->($csr->err);
+                       }

                        return 0;
                }
                else {
                        return 0;
                }
                else {


@@ -96,18 +111,46 @@ sub validate ($$$;$) { #{{{
                }
        }
 
                }
        }
 

+       # Ask for client to provide a name and email, if possible.
+       # Try sreg and ax
+       if ($claimed_identity->can("set_extension_args")) {
+               $claimed_identity->set_extension_args(
+                       'http://openid.net/extensions/sreg/1.1',
+                       {
+                               optional => 'email,fullname,nickname',
+                       },
+               );
+               $claimed_identity->set_extension_args(
+                       'http://openid.net/srv/ax/1.0',
+                       {
+                               mode => 'fetch_request',
+                               'required' => 'email,fullname,nickname,firstname',
+                               'type.email' => "http://schema.openid.net/contact/email",
+                               'type.fullname' => "http://axschema.org/namePerson",
+                               'type.nickname' => "http://axschema.org/namePerson/friendly",
+                               'type.firstname' => "http://axschema.org/namePerson/first",
+                       },
+               );
+       }
+
+       my $cgiurl=$config{openid_cgiurl};
+       $cgiurl=$q->url if ! defined $cgiurl;
+
+       my $trust_root=$config{openid_realm};
+       $trust_root=$cgiurl if ! defined $trust_root;
+

        my $check_url = $claimed_identity->check_url(
        my $check_url = $claimed_identity->check_url(

-               return_to => IkiWiki::cgiurl(do => "postsignin"),
-               trust_root => $config{cgiurl},
+               return_to => auto_upgrade_https($q, "$cgiurl?do=postsignin"),
+               trust_root => auto_upgrade_https($q, $trust_root),

                delayed_return => 1,
        );
        # Redirect the user to the OpenID server, which will
        # eventually bounce them back to auth()
        IkiWiki::redirect($q, $check_url);
        exit 0;
                delayed_return => 1,
        );
        # Redirect the user to the OpenID server, which will
        # eventually bounce them back to auth()
        IkiWiki::redirect($q, $check_url);
        exit 0;

-} #}}}
+}

 
 

-sub auth ($$) { #{{{
+sub auth ($$) {

        my $q=shift;
        my $session=shift;
 
        my $q=shift;
        my $session=shift;
 


@@ -118,10 +161,45 @@ sub auth ($$) { #{{{
                        IkiWiki::redirect($q, $setup_url);
                }
                elsif ($csr->user_cancel) {
                        IkiWiki::redirect($q, $setup_url);
                }
                elsif ($csr->user_cancel) {

-                       IkiWiki::redirect($q, $config{url});
+                       IkiWiki::redirect($q, IkiWiki::baseurl(undef));

                }
                elsif (my $vident = $csr->verified_identity) {
                        $session->param(name => $vident->url);
                }
                elsif (my $vident = $csr->verified_identity) {
                        $session->param(name => $vident->url);

+
+                       my @extensions;
+                       if ($vident->can("signed_extension_fields")) {
+                               @extensions=grep { defined } (
+                                       $vident->signed_extension_fields('http://openid.net/extensions/sreg/1.1'),
+                                       $vident->signed_extension_fields('http://openid.net/srv/ax/1.0'),
+                               );
+                       }
+                       my $nickname;
+                       foreach my $ext (@extensions) {
+                               foreach my $field (qw{value.email email}) {
+                                       if (exists $ext->{$field} &&
+                                           defined $ext->{$field} &&
+                                           length $ext->{$field}) {
+                                               $session->param(email => $ext->{$field});
+                                               if (! defined $nickname &&
+                                                   $ext->{$field}=~/(.+)@.+/) {
+                                                       $nickname = $1;
+                                               }
+                                               last;
+                                       }
+                               }
+                               foreach my $field (qw{value.nickname nickname value.fullname fullname value.firstname}) {
+                                       if (exists $ext->{$field} &&
+                                           defined $ext->{$field} &&
+                                           length $ext->{$field}) {
+                                               $nickname=$ext->{$field};
+                                               last;
+                                       }
+                               }
+                       }
+                       if (defined $nickname) {
+                               $session->param(nickname =>
+                                       Encode::decode_utf8($nickname));
+                       }

                }
                else {
                        error("OpenID failure: ".$csr->err);
                }
                else {
                        error("OpenID failure: ".$csr->err);


@@ -129,24 +207,25 @@ sub auth ($$) { #{{{
        }
        elsif (defined $q->param('openid_identifier')) {
                # myopenid.com affiliate support
        }
        elsif (defined $q->param('openid_identifier')) {
                # myopenid.com affiliate support

-               validate($q, $session, $q->param('openid_identifier'));
+               validate($q, $session, scalar $q->param('openid_identifier'));

        }
        }

-} #}}}
+}

 
 

-sub getobj ($$) { #{{{
+sub getobj ($$) {

        my $q=shift;
        my $session=shift;
 
        my $q=shift;
        my $session=shift;
 

+       eval q{use Net::INET6Glue::INET_is_INET6}; # may not be available

        eval q{use Net::OpenID::Consumer};
        error($@) if $@;
 
        my $ua;
        eval q{use LWPx::ParanoidAgent};
        if (! $@) {
        eval q{use Net::OpenID::Consumer};
        error($@) if $@;
 
        my $ua;
        eval q{use LWPx::ParanoidAgent};
        if (! $@) {

-               $ua=LWPx::ParanoidAgent->new;
+               $ua=LWPx::ParanoidAgent->new(agent => $config{useragent});

        }
        else {
        }
        else {

-               $ua=LWP::UserAgent->new;
+               $ua=useragent();

        }
 
        # Store the secret in the session.
        }
 
        # Store the secret in the session.


@@ -155,40 +234,35 @@ sub getobj ($$) { #{{{
                $secret=rand;
                $session->param(openid_secret => $secret);
        }
                $secret=rand;
                $session->param(openid_secret => $secret);
        }

+       
+       my $cgiurl=$config{openid_cgiurl};
+       $cgiurl=$q->url if ! defined $cgiurl;

 
        return Net::OpenID::Consumer->new(
                ua => $ua,
                args => $q,
                consumer_secret => sub { return shift()+$secret },
 
        return Net::OpenID::Consumer->new(
                ua => $ua,
                args => $q,
                consumer_secret => sub { return shift()+$secret },

-               required_root => $config{cgiurl},
+               required_root => auto_upgrade_https($q, $cgiurl),

        );
        );

-} #}}}
-
-package IkiWiki;
-
-# This is not used by this plugin, but this seems the best place to put it.
-# Used elsewhere to pretty-display the name of an openid user.
-sub openiduser ($) { #{{{
-       my $user=shift;
-
-       if ($user =~ m!^https?://! &&
-           eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
-               my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
-               my $display=$oid->display;
-               # Convert "user.somehost.com" to "user [somehost.com]".
-               if ($display !~ /\[/) {
-                       $display=~s/^(.*?)\.([^.]+\.[a-z]+)$/$1 [$2]/;
-               }
-               # Convert "http://somehost.com/user" to "user [somehost.com]".
-               if ($display !~ /\[/) {
-                       $display=~s/^https?:\/\/(.+)\/([^\/]+)$/$2 [$1]/;
-               }
-               $display=~s!^https?://!!; # make sure this is removed
-               eval q{use CGI 'escapeHTML'};
-               error($@) if $@;
-               return escapeHTML($display);
+}
+
+sub auto_upgrade_https {
+       my $q=shift;
+       my $url=shift;
+       if ($q->https()) {
+               $url=~s/^http:/https:/i;
+       }
+       return $url;
+}
+
+sub load_openid_module {
+       # Give up if module is unavailable to avoid needing to depend on it.
+       eval q{use Net::OpenID::Consumer};
+       if ($@) {
+               debug("unable to load Net::OpenID::Consumer, not enabling OpenID login ($@)");
+               return;

        }
        }

-       return;
+       return 1;

 }
 
 1
 }
 
 1