X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/54cf5a62cab254e923c8d73ae8bd043a1f33c3b1..e9e75f5f29d78b0631f98d9b0fa93184fcb181fe:/IkiWiki/Plugin/openid.pm?ds=inline diff --git a/IkiWiki/Plugin/openid.pm b/IkiWiki/Plugin/openid.pm index 55b1c4b17..5424c57e2 100644 --- a/IkiWiki/Plugin/openid.pm +++ b/IkiWiki/Plugin/openid.pm @@ -4,71 +4,152 @@ 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 { + hook(type => "getopt", id => "openid", call => \&getopt); + 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 getopt () { + eval q{use Getopt::Long}; + error($@) if $@; + Getopt::Long::Configure('pass_through'); + GetOptions("openidsignup=s" => \$config{openidsignup}); +} -sub auth ($$) { #{{{ - my $q=shift; - my $session=shift; +sub getsetup () { + return + plugin => { + safe => 1, + rebuild => 0, + }, + openidsignup => { + type => "string", + example => "http://myopenid.com/", + description => "an url where users can signup for an OpenID", + safe => 1, + rebuild => 0, + }, +} - if (defined $q->param('openid.mode')) { - my $csr=getobj($q, $session); +sub formbuilder_setup (@) { + my %params=@_; - if (my $setup_url = $csr->user_setup_url) { - IkiWiki::redirect($q, $setup_url); + my $form=$params{form}; + my $session=$params{session}; + my $cgi=$params{cgi}; + + if ($form->title eq "signin") { + # 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; } - elsif ($csr->user_cancel) { - IkiWiki::redirect($q, $config{url}); + + # 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} ? " | ".gettext("Get an OpenID")."" : "") + ); + + # 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 (my $vident = $csr->verified_identity) { - $session->param(name => $vident->url); + } + 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"); } } -} #}}} +} -sub validate ($$$$) { #{{{ +sub validate ($$$;$) { my $q=shift; my $session=shift; - my $form=shift; my $openid_url=shift; + my $form=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 ($form) { + # Put the error in the form and fail validation. + $form->field(name => "openid_url", comment => $csr->err); + return 0; + } + else { + error($csr->err); + } } + 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); + } + 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 +168,45 @@ 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}, ); -} #}}} +} + +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]" + # (also "user.somehost.co.uk") + if ($display !~ /\[/) { + $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/; + } + # Convert "http://somehost.com/user" to "user [somehost.com]". + # (also "https://somehost.com/user/") + 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); + } + return; +} 1