IkiWiki/Plugin/openid.pm

   1 #!/usr/bin/perl
   2 # OpenID support.
   3 package IkiWiki::Plugin::openid;
   4
   5 use warnings;
   6 use strict;
   7 use IkiWiki 3.00;
   8
   9 sub import {
  10         add_underlay("openid-selector");
  11         hook(type => "checkconfig", id => "openid", call => \&checkconfig);
  12         hook(type => "getsetup", id => "openid", call => \&getsetup);
  13         hook(type => "auth", id => "openid", call => \&auth);
  14         hook(type => "formbuilder_setup", id => "openid",
  15                 call => \&formbuilder_setup, last => 1);
  16 }
  17
  18 sub checkconfig () {
  19         if ($config{cgi}) {
  20                 # Intercept normal signin form, so the openid selector
  21                 # can be displayed.
  22                 #
  23                 # When other auth hooks are registered, give the selector
  24                 # a reference to the normal signin form.
  25                 require IkiWiki::CGI;
  26                 my $real_cgi_signin;
  27                 if (keys %{$IkiWiki::hooks{auth}} > 1) {
  28                         $real_cgi_signin=\&IkiWiki::cgi_signin;
  29                 }
  30                 inject(name => "IkiWiki::cgi_signin", call => sub ($$) {
  31                         openid_selector($real_cgi_signin, @_);
  32                 });
  33         }
  34 }
  35
  36 sub getsetup () {
  37         return
  38                 plugin => {
  39                         safe => 1,
  40                         rebuild => 0,
  41                         section => "auth",
  42                 },
  43 }
  44
  45 sub openid_selector {
  46         my $real_cgi_signin=shift;
  47         my $q=shift;
  48         my $session=shift;
  49
  50         my $openid_url=$q->param('openid_identifier');
  51         my $openid_error;
  52
  53         if (! load_openid_module()) {
  54                 if ($real_cgi_signin) {
  55                         $real_cgi_signin->($q, $session);
  56                         exit;
  57                 }
  58                 error(sprintf(gettext("failed to load openid module: "), @_));
  59         }
  60         elsif (defined $q->param("action") && $q->param("action") eq "verify") {
  61                 validate($q, $session, $openid_url, sub {
  62                         $openid_error=shift;
  63                 });
  64         }
  65
  66         my $template=IkiWiki::template("openid-selector.tmpl");
  67         $template->param(
  68                 cgiurl => $config{cgiurl},
  69                 (defined $openid_error ? (openid_error => $openid_error) : ()),
  70                 (defined $openid_url ? (openid_url => $openid_url) : ()),
  71                 ($real_cgi_signin ? (nonopenidform => $real_cgi_signin->($q, $session, 1)) : ()),
  72         );
  73
  74         IkiWiki::printheader($session);
  75         print IkiWiki::misctemplate("signin", $template->output);
  76         exit;
  77 }
  78
  79 sub formbuilder_setup (@) {
  80         my %params=@_;
  81
  82         my $form=$params{form};
  83         my $session=$params{session};
  84         my $cgi=$params{cgi};
  85
  86         if ($form->title eq "preferences" &&
  87                IkiWiki::openiduser($session->param("name"))) {
  88                 $form->field(name => "openid_identifier", disabled => 1,
  89                         label => htmllink("", "", "ikiwiki/OpenID", noimageinline => 1),
  90                         value => $session->param("name"),
  91                         size => length($session->param("name")), force => 1,
  92                         fieldset => "login");
  93                 $form->field(name => "email", type => "hidden");
  94         }
  95 }
  96
  97 sub validate ($$$;$) {
  98         my $q=shift;
  99         my $session=shift;
 100         my $openid_url=shift;
 101         my $errhandler=shift;
 102
 103         my $csr=getobj($q, $session);
 104
 105         my $claimed_identity = $csr->claimed_identity($openid_url);
 106         if (! $claimed_identity) {
 107                 if ($errhandler) {
 108                         $errhandler->($csr->err);
 109                         return 0;
 110                 }
 111                 else {
 112                         error($csr->err);
 113                 }
 114         }
 115
 116         # Ask for client to provide a name and email, if possible.
 117         # Try sreg and ax
 118         if ($claimed_identity->can("set_extension_args")) {
 119                 $claimed_identity->set_extension_args(
 120                         'http://openid.net/extensions/sreg/1.1',
 121                         {
 122                                 optional => 'email,fullname,nickname',
 123                         },
 124                 );
 125                 $claimed_identity->set_extension_args(
 126                         'http://openid.net/srv/ax/1.0',
 127                         {
 128                                 mode => 'fetch_request',
 129                                 'required' => 'email,fullname,nickname,firstname',
 130                                 'type.email' => "http://schema.openid.net/contact/email",
 131                                 'type.fullname' => "http://axschema.org/namePerson",
 132                                 'type.nickname' => "http://axschema.org/namePerson/friendly",
 133                                 'type.firstname' => "http://axschema.org/namePerson/first",
 134                         },
 135                 );
 136         }
 137
 138         my $check_url = $claimed_identity->check_url(
 139                 return_to => IkiWiki::cgiurl(do => "postsignin"),
 140                 trust_root => $config{cgiurl},
 141                 delayed_return => 1,
 142         );
 143         # Redirect the user to the OpenID server, which will
 144         # eventually bounce them back to auth()
 145         IkiWiki::redirect($q, $check_url);
 146         exit 0;
 147 }
 148
 149 sub auth ($$) {
 150         my $q=shift;
 151         my $session=shift;
 152
 153         if (defined $q->param('openid.mode')) {
 154                 my $csr=getobj($q, $session);
 155
 156                 if (my $setup_url = $csr->user_setup_url) {
 157                         IkiWiki::redirect($q, $setup_url);
 158                 }
 159                 elsif ($csr->user_cancel) {
 160                         IkiWiki::redirect($q, $config{url});
 161                 }
 162                 elsif (my $vident = $csr->verified_identity) {
 163                         $session->param(name => $vident->url);
 164
 165                         my @extensions;
 166                         if ($vident->can("signed_extension_fields")) {
 167                                 @extensions=grep { defined } (
 168                                         $vident->signed_extension_fields('http://openid.net/extensions/sreg/1.1'),
 169                                         $vident->signed_extension_fields('http://openid.net/srv/ax/1.0'),
 170                                 );
 171                         }
 172                         foreach my $ext (@extensions) {
 173                                 foreach my $field (qw{value.email email}) {
 174                                         if (exists $ext->{$field} &&
 175                                             defined $ext->{$field} &&
 176                                             length $ext->{$field}) {
 177                                                 $session->param(email => $ext->{$field});
 178                                                 last;
 179                                         }
 180                                 }
 181                                 foreach my $field (qw{value.nickname nickname value.fullname fullname value.firstname}) {
 182                                         if (exists $ext->{$field} &&
 183                                             defined $ext->{$field} &&
 184                                             length $ext->{$field}) {
 185                                                 $session->param(username => $ext->{$field});
 186                                                 last;
 187                                         }
 188                                 }
 189                         }
 190                 }
 191                 else {
 192                         error("OpenID failure: ".$csr->err);
 193                 }
 194         }
 195         elsif (defined $q->param('openid_identifier')) {
 196                 # myopenid.com affiliate support
 197                 validate($q, $session, $q->param('openid_identifier'));
 198         }
 199 }
 200
 201 sub getobj ($$) {
 202         my $q=shift;
 203         my $session=shift;
 204
 205         eval q{use Net::OpenID::Consumer};
 206         error($@) if $@;
 207
 208         my $ua;
 209         eval q{use LWPx::ParanoidAgent};
 210         if (! $@) {
 211                 $ua=LWPx::ParanoidAgent->new;
 212         }
 213         else {
 214                 $ua=LWP::UserAgent->new;
 215         }
 216
 217         # Store the secret in the session.
 218         my $secret=$session->param("openid_secret");
 219         if (! defined $secret) {
 220                 $secret=rand;
 221                 $session->param(openid_secret => $secret);
 222         }
 223
 224         return Net::OpenID::Consumer->new(
 225                 ua => $ua,
 226                 args => $q,
 227                 consumer_secret => sub { return shift()+$secret },
 228                 required_root => $config{cgiurl},
 229         );
 230 }
 231
 232 sub load_openid_module {
 233         # Give up if module is unavailable to avoid needing to depend on it.
 234         eval q{use Net::OpenID::Consumer};
 235         if ($@) {
 236                 debug("unable to load Net::OpenID::Consumer, not enabling OpenID login ($@)");
 237                 return;
 238         }
 239         return 1;
 240 }
 241
 242 1