X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/54cf5a62cab254e923c8d73ae8bd043a1f33c3b1..37a4cf13744ee6e96338409fe1e35debeee91f4d:/IkiWiki/Plugin/openid.pm diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm index 55b1c4b17..e10e21f4d 100644 --- a/IkiWiki/Plugin/openid.pm +++ b/IkiWiki/Plugin/openid.pm @@ -4,71 +4,201 @@ package IkiWiki::Plugin::openid; use warnings; use strict; -use IkiWiki; +use IkiWiki 3.00; -sub import { #{{{ - hook(type => "checkconfig", id => "smiley", call => \&checkconfig); - hook(type => "auth", id => "skeleton", call => \&auth); -} # }}} +sub import { + add_underlay("openid-selector"); + hook(type => "checkconfig", id => "openid", call => \&checkconfig); + 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); +} -sub checkconfig () { #{{{ - # Currently part of the OpenID code is in CGI.pm, and is enabled by - # this setting. - # TODO: modularise it all out into this plugin.. - $config{openid}=1; -} #}}} +sub checkconfig () { + if ($config{cgi}) { + # Intercept normal signin form, so the openid selector + # can be displayed. + # + # When other auth hooks are registered, give the selector + # a reference to the normal signin form. + require IkiWiki::CGI; + my $real_cgi_signin; + if (keys %{$IkiWiki::hooks{auth}} > 1) { + $real_cgi_signin=\&IkiWiki::cgi_signin; + } + inject(name => "IkiWiki::cgi_signin", call => sub ($$) { + openid_selector($real_cgi_signin, @_); + }); + } +} -sub auth ($$) { #{{{ - my $q=shift; - my $session=shift; +sub getsetup () { + return + plugin => { + safe => 1, + rebuild => 0, + section => "auth", + }, +} - if (defined $q->param('openid.mode')) { - my $csr=getobj($q, $session); +sub openid_selector { + my $real_cgi_signin=shift; + my $q=shift; + my $session=shift; - if (my $setup_url = $csr->user_setup_url) { - IkiWiki::redirect($q, $setup_url); - } - elsif ($csr->user_cancel) { - IkiWiki::redirect($q, $config{url}); - } - elsif (my $vident = $csr->verified_identity) { - $session->param(name => $vident->url); + my $openid_url=$q->param('openid_identifier'); + my $openid_error; + + if (! load_openid_module()) { + if ($real_cgi_signin) { + $real_cgi_signin->($q, $session); + exit; } + error(sprintf(gettext("failed to load openid module: "), @_)); + } + elsif (defined $q->param("action") && $q->param("action") eq "verify") { + validate($q, $session, $openid_url, sub { + $openid_error=shift; + }); + } + + my $template=IkiWiki::template("openid-selector.tmpl"); + $template->param( + cgiurl => $config{cgiurl}, + (defined $openid_error ? (openid_error => $openid_error) : ()), + (defined $openid_url ? (openid_url => $openid_url) : ()), + ($real_cgi_signin ? (nonopenidform => $real_cgi_signin->($q, $session, 1)) : ()), + ); + + IkiWiki::printheader($session); + print IkiWiki::misctemplate("signin", $template->output); + exit; +} + +sub formbuilder_setup (@) { + my %params=@_; + + my $form=$params{form}; + my $session=$params{session}; + my $cgi=$params{cgi}; + + if ($form->title eq "preferences" && + IkiWiki::openiduser($session->param("name"))) { + $form->field(name => "openid_identifier", disabled => 1, + label => htmllink("", "", "ikiwiki/OpenID", noimageinline => 1), + value => $session->param("name"), + size => length($session->param("name")), force => 1, + fieldset => "login"); + $form->field(name => "email", type => "hidden"); } -} #}}} +} -sub validate ($$$$) { #{{{ +sub validate ($$$;$) { my $q=shift; my $session=shift; - my $form=shift; my $openid_url=shift; + my $errhandler=shift; my $csr=getobj($q, $session); my $claimed_identity = $csr->claimed_identity($openid_url); if (! $claimed_identity) { - # Put the error in the form and fail validation. - $form->field(name => "openid_url", comment => $csr->err); - return 0; + if ($errhandler) { + $errhandler->($csr->err); + return 0; + } + else { + error($csr->err); + } + } + + # 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 $check_url = $claimed_identity->check_url( - return_to => IkiWiki::cgiurl( - do => $form->field("do"), - page => $form->field("page"), - title => $form->field("title"), - from => $form->field("from"), - subpage => $form->field("subpage") - ), + return_to => IkiWiki::cgiurl(do => "postsignin"), trust_root => $config{cgiurl}, delayed_return => 1, ); # Redirect the user to the OpenID server, which will - # eventually bounce them back to auth() above. + # eventually bounce them back to auth() IkiWiki::redirect($q, $check_url); exit 0; -} #}}} +} -sub getobj ($$) { #{{{ +sub auth ($$) { + my $q=shift; + my $session=shift; + + if (defined $q->param('openid.mode')) { + my $csr=getobj($q, $session); + + if (my $setup_url = $csr->user_setup_url) { + IkiWiki::redirect($q, $setup_url); + } + elsif ($csr->user_cancel) { + IkiWiki::redirect($q, $config{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'), + ); + } + 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}); + last; + } + } + foreach my $field (qw{value.nickname nickname value.fullname fullname value.firstname}) { + if (exists $ext->{$field} && + defined $ext->{$field} && + length $ext->{$field}) { + $session->param(username => $ext->{$field}); + last; + } + } + } + } + else { + error("OpenID failure: ".$csr->err); + } + } + elsif (defined $q->param('openid_identifier')) { + # myopenid.com affiliate support + validate($q, $session, $q->param('openid_identifier')); + } +} + +sub getobj ($$) { my $q=shift; my $session=shift; @@ -87,15 +217,26 @@ sub getobj ($$) { #{{{ # Store the secret in the session. my $secret=$session->param("openid_secret"); if (! defined $secret) { - $secret=$session->param(openid_secret => time); + $secret=rand; + $session->param(openid_secret => $secret); } return Net::OpenID::Consumer->new( ua => $ua, args => $q, - consumer_secret => $secret, + consumer_secret => sub { return shift()+$secret }, required_root => $config{cgiurl}, ); -} #}}} +} + +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 1; +} 1