/usr/share/perl5/Lemonldap/NG/Portal/AuthGoogle.pm is in liblemonldap-ng-portal-perl 1.9.16-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 | ##@file
# Google authentication backend file
##@class
# Google authentication backend class.
package Lemonldap::NG::Portal::AuthGoogle;
use strict;
use Lemonldap::NG::Portal::Simple;
use Lemonldap::NG::Common::Regexp;
use Lemonldap::NG::Portal::_Browser;
use URI::Escape;
use constant AXSPECURL => 'http://openid.net/srv/ax/1.0';
use constant GOOGLEENDPOINT => 'https://www.google.com/accounts/o8/id';
our @ISA = (qw(Lemonldap::NG::Portal::_Browser));
our $VERSION = '1.9.1';
our $googleEndPoint;
BEGIN {
eval {
require threads::shared;
threads::shared::share($googleEndPoint);
};
}
## @method string googleEndPoint()
# Return the Google OpenID endpoint given by
# https://www.google.com/accounts/o8/id
# @return string
sub googleEndPoint {
my $self = shift;
# First time, get and store Google endpoint
unless ($googleEndPoint) {
my $response =
$self->ua()->get( GOOGLEENDPOINT, Accept => 'application/xrds+xml' );
if ( $response->is_success ) {
# Dirty XML parse
# (searching for <URI>https://www.google.com/accounts/o8/ud</URI>)
my $tmp = $response->decoded_content;
if ( $tmp =~ m#<URI.*?>\s*(\S+)\s*</URI>#mi ) {
$googleEndPoint = $1;
}
else {
$self->lmLog(
'Here is the Google response: '
. $response->decoded_content,
'error'
);
$self->abort('Can\'t find endpoint in Google response');
}
}
else {
$self->abort( 'Can\'t access to Google endpoint:',
$response->status_line );
}
}
return $googleEndPoint;
}
## @method boolean checkGoogleSession()
# Search for claimed_id in persistent sessions DB.
# @return true if sessions was recovered
sub checkGoogleSession {
my $self = shift;
# Find in Google response for AX attributes
# See https://developers.google.com/accounts/docs/OpenID#Parameters
# for more
( $self->{_AXNS} ) = map {
( /^openid\.ns\.(.*)/ and $self->param($_) eq AXSPECURL )
? ($1)
: ()
} $self->param();
# Look at persistent database
my $id = $self->param('openid.claimed_id');
my $pSession = $self->getPersistentSession($id);
my $gs;
# No AX response, if datas are already shared, store them
unless ( $self->{_AXNS} ) {
if ( $pSession->data ) {
$self->{user} = $pSession->data->{email};
foreach my $k ( keys %{ $pSession->data } ) {
$gs->{$k} = $pSession->data->{$k};
}
}
}
else { # Parse AX response
# First store email as user key. Note that this is the returned value
# so if it's empty, request is retried
$self->{user} = $self->param("openid.$self->{_AXNS}.value.email");
# Retrieve AX datas (and store them in persistent session)
my $infos;
foreach my $k ( $self->param() ) {
if ( $k =~ /^openid\.$self->{_AXNS}\.value\.(\w+)$/ ) {
$gs->{$1} = $infos->{$1} = $self->param($k);
}
}
$pSession->update($infos);
}
# Now store datas in session
my %vars = ( %{ $self->{exportedVars} }, %{ $self->{googleExportedVars} } );
while ( my ( $k, $v ) = each %vars ) {
my $attr = $k;
$attr =~ s/^!//;
# Value (ie AX attribute) must be one of:
if ( $v =~ Lemonldap::NG::Common::Regexp::GOOGLEAXATTR() ) {
# One value is missing:
unless ( exists( $gs->{$v} ) ) {
# Case 1: value was asked but not returned, set an empty value
# in persistent session (so that it's defined)
if ( $self->{_AXNS} ) {
$self->_sub( 'userInfo',
"$v required attribute is missing in Google response, storing ''"
);
$gs->{$v} = '';
$pSession->update( { $v => '' } );
}
# Case 2: value is not stored, probably configuration has
# changed and this value was never asked
else {
$self->_sub( 'userInfo',
"$v required attribute is missing in persistent session, let's ask it"
);
return 0;
}
}
$self->{sessionInfo}->{$attr} = $gs->{$v};
}
# If an exported variable is not AX compliant, just warn
else {
$self->lmLog(
"Ignoring attribute $v which is not a valid Google OpenID AX attribute",
'warn'
);
}
}
# Boolean value: ~false if no $user value
return $self->{user};
}
## @apmethod int authInit()
# @return Lemonldap::NG::Portal constant
sub authInit {
PE_OK;
}
## @apmethod int extractFormInfo()
# Read username return by Google authentication system.
# @return Lemonldap::NG::Portal constant
sub extractFormInfo {
my $self = shift;
my $ax = '';
# 1. Check Google responses
if ( $self->param('openid.mode') ) {
# 1.1 First, verify that the response isn't forged
# Build verification request
my $check_url = $self->googleEndPoint() . "?" . join(
'&',
map {
my $val = $self->param($_);
$val = 'check_authentication' if $_ eq 'openid.mode';
sprintf '%s=%s', uri_escape_utf8($_), uri_escape_utf8($val);
} $self->param()
);
# Launch request
my $response = $self->ua()->get( $check_url, Accept => 'text/plain' );
unless ( $response->is_success ) {
$self->abort( 'Can\'t verify Google authentication',
$response->status_line );
}
else {
my %tmp =
map { my ( $key, $value ) = split /:/, $_, 2; $key => $value }
split /\n/, $response->decoded_content;
# Reject invalid requests
unless ( $tmp{is_valid} eq 'true' ) {
return PE_BADCREDENTIALS;
}
# 1.2 Check if datas are already shared with Google
unless ( $self->checkGoogleSession() ) {
# Datas are missing, prepare AX query which will be added to
# the request to Google
# a) email is required, will be used as 'user' field
$ax =
'&openid.ns.ax='
. AXSPECURL
. '&openid.ax.mode=fetch_request'
. '&openid.ax.type.email=http://axschema.org/contact/email'
. '&openid.ax.required=email';
# b) if UserDB is Google, ask for exported variables
if ( $self->get_module('user') eq 'Google' ) {
my $u;
foreach my $k ( values %{ $self->{exportedVars} } ) {
next if ( $k eq 'email' );
# Check if wanted attribute is known by Google
if ( $k =~
/^(?:(?:la(?:nguag|stnam)|firstnam)e|country)$/ )
{
$ax .= ",$k";
# Note: AX type seems to be required by Google
$u .= "&openid.ax.type.$k="
. {
country =>
"http://axschema.org/contact/country/home",
firstname =>
"http://axschema.org/namePerson/first",
lastname =>
"http://axschema.org/namePerson/last",
language => "http://axschema.org/pref/language"
}->{$k};
}
else {
$self->lmLog(
"Field name: $k is not exported by Google",
'warn' );
}
}
$ax .= $u;
}
}
# 1.3 Datas are recovered, user is authenticated
else {
$self->lmLog( 'Good Google authentication', 'debug' );
# Force redirection to avoid displaying OpenID datas
$self->{mustRedirect} = 1;
return PE_OK;
}
}
}
# 2. Redirect user to Google login page:
# => no OpenID response or missing datas
# Build request to Google
my $check_url =
$self->googleEndPoint()
. '?openid.mode=checkid_setup'
. '&openid.ns=http://specs.openid.net/auth/2.0'
. '&openid.claimed_id=http://specs.openid.net/auth/2.0/identifier_select'
. '&openid.identity=http://specs.openid.net/auth/2.0/identifier_select'
. $ax; # Requested attributes if set
# Build portal URI...
my $sep = '?';
my $returnTo = $self->{portal};
foreach my $v (
[ $self->{_url}, "url" ],
[ $self->param( $self->{authChoiceParam} ), $self->{authChoiceParam} ]
)
{
if ( $v->[0] ) {
$returnTo .= "$sep$v->[1]=$v->[0]";
$sep = '&';
}
}
# ... and add it
$check_url .= '&openid.return_to=' . uri_escape_utf8($returnTo);
# Now redirect user
print $self->redirect($check_url);
$self->quit();
}
## @apmethod int setAuthSessionInfo()
# Set _user and authenticationLevel.
# @return Lemonldap::NG::Portal constant
sub setAuthSessionInfo {
my $self = shift;
$self->{sessionInfo}->{'_user'} = $self->{user};
$self->{sessionInfo}->{authenticationLevel} = $self->{googleAuthnLevel};
PE_OK;
}
## @apmethod int authenticate()
# Does nothing.
# @return Lemonldap::NG::Portal constant
sub authenticate {
PE_OK;
}
## @apmethod int authFinish()
# Does nothing.
# @return Lemonldap::NG::Portal constant
sub authFinish {
PE_OK;
}
## @apmethod int authLogout()
# Does nothing
# @return Lemonldap::NG::Portal constant
sub authLogout {
PE_OK;
}
## @apmethod boolean authForce()
# Does nothing
# @return result
sub authForce {
return 0;
}
## @method string getDisplayType
# @return display type
sub getDisplayType {
return "logo";
}
1;
__END__
=head1 NAME
=encoding utf8
Lemonldap::NG::Portal::AuthGoogle - Perl extension for building Lemonldap::NG
compatible portals with Google authentication.
=head1 SYNOPSIS
use Lemonldap::NG::Portal::SharedConf;
my $portal = new Lemonldap::NG::Portal::Simple(
configStorage => {...}, # See Lemonldap::NG::Portal
authentication => 'Google',
);
if($portal->process()) {
# Write here the menu with CGI methods. This page is displayed ONLY IF
# the user was not redirected here.
print $portal->header('text/html; charset=utf-8'); # DON'T FORGET THIS (see CGI(3))
print "...";
}
else {
# If the user enters here, IT MEANS THAT CAS REDIRECTION DOES NOT WORK
print $portal->header('text/html; charset=utf-8'); # DON'T FORGET THIS (see CGI(3))
print "<html><body><h1>Unable to work</h1>";
print "This server isn't well configured. Contact your administrator.";
print "</body></html>";
}
=head1 DESCRIPTION
This library just overload few methods of Lemonldap::NG::Portal::Simple to use
Google authentication mechanism.
See L<Lemonldap::NG::Portal::Simple> for usage and other methods.
=head1 SEE ALSO
L<Lemonldap::NG::Portal>, L<Lemonldap::NG::Portal::Simple>,
L<http://lemonldap-ng.org/>,
L<https://developers.google.com/accounts/docs/OpenID>
=head1 AUTHOR
=over
=item Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
=item Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=back
=head1 BUG REPORT
Use OW2 system to report bug or ask for features:
L<https://gitlab.ow2.org/lemonldap-ng/lemonldap-ng/issues>
=head1 DOWNLOAD
Lemonldap::NG is available at
L<http://forge.objectweb.org/project/showfiles.php?group_id=274>
=head1 COPYRIGHT AND LICENSE
=over
=item Copyright (C) 2013 by Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Copyright (C) 2013 by Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
=back
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see L<http://www.gnu.org/licenses/>.
=cut
|