/usr/share/perl5/Lemonldap/NG/Portal/MailReset.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 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 | ## @file
# Module for password reset by mail
## @class Lemonldap::NG::Portal::MailReset
# Module for password reset by mail
package Lemonldap::NG::Portal::MailReset;
use strict;
use warnings;
our $VERSION = '1.9.15';
use Lemonldap::NG::Portal::Simple qw(:all);
use base qw(Lemonldap::NG::Portal::SharedConf Exporter);
use HTML::Template;
use Encode;
use POSIX qw(strftime);
#inherits Lemonldap::NG::Portal::_SMTP
*EXPORT_OK = *Lemonldap::NG::Portal::Simple::EXPORT_OK;
*EXPORT_TAGS = *Lemonldap::NG::Portal::Simple::EXPORT_TAGS;
*EXPORT = *Lemonldap::NG::Portal::Simple::EXPORT;
## @method boolean process()
# Call functions to handle password reset by mail issued from
# - itself:
# - smtpInit
# - extractMailInfo
# - getMailUser
# - storeMailSession
# - sendConfirmationMail
# - changePassword
# - sendPasswordMail
# - portal core module:
# - controlUrlOrigin
# - setMacros
# - setLocalGroups
# - setGroups
# - authentication module:
# - authInit
# - authFinish
# - userDB module:
# - userDBInit
# - setSessionInfo
# - userDBFinish
# - passwordDB module:
# - passwordDBInit
# - passwordDBFinish
# @return 1 if all is OK
sub process {
my ($self) = @_;
# Process subroutines
$self->{error} = PE_OK;
$self->{error} = $self->_subProcess(
qw(controlUrlOrigin smtpInit authInit extractMailInfo userDBInit getMailUser setSessionInfo
setMacros setGroups setPersistentSessionInfo setLocalGroups userDBFinish
storeMailSession sendConfirmationMail passwordDBInit changePassword passwordDBFinish
sendPasswordMail authFinish)
);
return (
(
$self->{error} <= 0
or $self->{error} == PE_PASSWORD_OK
or $self->{error} == PE_CAPTCHAERROR
or $self->{error} == PE_CAPTCHAEMPTY
or $self->{error} == PE_MAILCONFIRMOK
or $self->{error} == PE_MAILOK
) ? 0 : 1
);
}
## @method int smtpInit()
# Load SMTP methods
# @return Lemonldap::NG::Portal constant
sub smtpInit {
my ($self) = @_;
eval { use base qw(Lemonldap::NG::Portal::_SMTP) };
if ($@) {
$self->lmLog( "Unable to load SMTP functions ($@)", 'error' );
return PE_ERROR;
}
PE_OK;
}
## @method int extractMailInfo
# Get mail from form or from mail_token
# @return Lemonldap::NG::Portal constant
sub extractMailInfo {
my ($self) = @_;
if ( $self->{captcha_mail_enabled} ) {
eval { $self->initCaptcha(); };
$self->lmLog( "Can't init captcha: $@", "error" ) if $@;
}
unless ( $self->param('mail') || $self->param('mail_token') ) {
return PE_MAILFIRSTACCESS if ( $self->request_method =~ /GET/ );
return PE_MAILFORMEMPTY;
}
$self->{mail_token} = $self->param('mail_token');
$self->{newpassword} = $self->param('newpassword');
$self->{confirmpassword} = $self->param('confirmpassword');
# If a mail token is present, find the corresponding mail
if ( $self->{mail_token} ) {
$self->lmLog( "Token given for password reset: " . $self->{mail_token},
'debug' );
# Get the corresponding session
my $mailSession = $self->getApacheSession( $self->{mail_token} );
if ($mailSession) {
$self->{mail} = $mailSession->data->{user};
$self->{mailAddress} =
$mailSession->data->{ $self->{mailSessionKey} };
$self->lmLog( "User associated to token: " . $self->{mail},
'debug' );
}
return PE_BADMAILTOKEN unless ( $self->{mail} );
}
else {
# Use submitted value
$self->{mail} = $self->param('mail');
# Captcha for mail form
# Only if mail session does not already exist
if ( $self->{captcha_mail_enabled}
&& $self->{mail}
&& !$self->getMailSession( $self->{mail} ) )
{
$self->{captcha_user_code} = $self->param('captcha_user_code');
$self->{captcha_check_code} = $self->param('captcha_code');
unless ( $self->{captcha_user_code} && $self->{captcha_check_code} )
{
$self->lmLog( "Captcha not filled", 'warn' );
return PE_CAPTCHAEMPTY;
}
$self->lmLog(
"Captcha data received: "
. $self->{captcha_user_code} . " and "
. $self->{captcha_check_code},
'debug'
);
# Check captcha
my $captcha_result =
$self->checkCaptcha( $self->{captcha_user_code},
$self->{captcha_check_code} );
if ( $captcha_result != 1 ) {
if ( $captcha_result == -3
or $captcha_result == -2 )
{
$self->lmLog( "Captcha failed: wrong code", 'warn' );
return PE_CAPTCHAERROR;
}
elsif ( $captcha_result == 0 ) {
$self->lmLog(
"Captcha failed: code not checked (file error)",
'warn' );
return PE_CAPTCHAERROR;
}
elsif ( $captcha_result == -1 ) {
$self->lmLog( "Captcha failed: code has expired", 'warn' );
return PE_CAPTCHAERROR;
}
}
$self->lmLog( "Captcha code verified", 'debug' );
}
}
# Check mail
return PE_MALFORMEDUSER unless ( $self->{mail} =~ /$self->{userControl}/o );
PE_OK;
}
## @method int getMailUser
# Search for user using UserDB module
# @return Lemonldap::NG::Portal constant
sub getMailUser {
my ($self) = @_;
my $error = $self->getUser();
if ( $error == PE_USERNOTFOUND or $error == PE_BADCREDENTIALS ) {
$self->_sub('userDBFinish');
if ( $self->{portalErrorOnMailNotFound} ) {
return PE_MAILNOTFOUND;
}
my $mailTimeout = $self->{mailTimeout} || $self->{timeout};
my $expTimestamp = time() + $mailTimeout;
$self->{expMailDate} = strftime( "%d/%m/%Y", localtime $expTimestamp );
$self->{expMailTime} = strftime( "%H:%M", localtime $expTimestamp );
return PE_MAILCONFIRMOK;
}
return $error;
}
## @method int storeMailSession
# Create mail session and store token
# @return Lemonldap::NG::Portal constant
sub storeMailSession {
my ($self) = @_;
# Skip this step if confirmation was already sent
return PE_OK
if ( $self->{mail_token} or $self->getMailSession( $self->{mail} ) );
# Create a new session
my $mailSession = $self->getApacheSession();
# Set _utime for session autoremove
# Use default session timeout and mail session timeout to compute it
my $time = time();
my $timeout = $self->{timeout};
my $mailTimeout = $self->{mailTimeout} || $timeout;
my $infos = {};
$infos->{_utime} = $time + ( $mailTimeout - $timeout );
# Store expiration timestamp for further use
$infos->{mailSessionTimeoutTimestamp} = $time + $mailTimeout;
$self->{mailSessionTimeoutTimestamp} = $time + $mailTimeout;
# Store start timestamp for further use
$infos->{mailSessionStartTimestamp} = $time;
$self->{mailSessionStartTimestamp} = $time;
# Store mail
$infos->{ $self->{mailSessionKey} } =
$self->getFirstValue( $self->{sessionInfo}->{ $self->{mailSessionKey} } );
# Store user
$infos->{user} = $self->{mail};
# Store type
$infos->{_type} = "mail";
# Update session
$mailSession->update($infos);
PE_OK;
}
## @method int sendConfirmationMail
# Send confirmation mail
# @return Lemonldap::NG::Portal constant
sub sendConfirmationMail {
my ($self) = @_;
# Skip this step if user clicked on the confirmation link
return PE_OK if $self->{mail_token};
# Check if confirmation mail has already been sent
my $mail_session = $self->getMailSession( $self->{mail} );
$self->{mail_already_sent} = ( $mail_session and !$self->{id} ) ? 1 : 0;
# Read mail session to get creation and expiration dates
$self->{id} = $mail_session unless $self->{id};
$self->lmLog( "Mail session found: $mail_session", 'debug' );
my $mailSession = $self->getApacheSession( $mail_session, 1 );
$self->{mailSessionTimeoutTimestamp} =
$mailSession->data->{mailSessionTimeoutTimestamp};
$self->{mailSessionStartTimestamp} =
$mailSession->data->{mailSessionStartTimestamp};
# Mail session expiration date
my $expTimestamp = $self->{mailSessionTimeoutTimestamp};
$self->lmLog( "Mail expiration timestamp: $expTimestamp", 'debug' );
$self->{expMailDate} = strftime( "%d/%m/%Y", localtime $expTimestamp );
$self->{expMailTime} = strftime( "%H:%M", localtime $expTimestamp );
# Mail session start date
my $startTimestamp = $self->{mailSessionStartTimestamp};
$self->lmLog( "Mail start timestamp: $startTimestamp", 'debug' );
$self->{startMailDate} = strftime( "%d/%m/%Y", localtime $startTimestamp );
$self->{startMailTime} = strftime( "%H:%M", localtime $startTimestamp );
# Ask if user want another confirmation email
if ( $self->{mail_already_sent} and !$self->param('resendconfirmation') ) {
return PE_MAILCONFIRMATION_ALREADY_SENT;
}
# Get mail address
unless ( $self->{mailAddress} ) {
$self->{mailAddress} =
$self->getFirstValue(
$self->{sessionInfo}->{ $self->{mailSessionKey} } );
}
# Build confirmation url
my $url = $self->{mailUrl} . "?mail_token=" . $self->{id};
$url .= '&skin=' . $self->getSkin();
$url .= '&' . $self->{authChoiceParam} . '=' . $self->{_authChoice}
if ( $self->{_authChoice} );
$url .= '&url=' . $self->{_url} if $self->{_url};
# Build mail content
my $subject = $self->{mailConfirmSubject};
my $body;
my $html;
if ( $self->{mailConfirmBody} ) {
# We use a specific text message, no html
$body = $self->{mailConfirmBody};
}
else {
# Use HTML template
my $tplfile = $self->getApacheHtdocsPath
. "/skins/$self->{portalSkin}/mail_confirm.tpl";
$tplfile = $self->getApacheHtdocsPath . "/skins/common/mail_confirm.tpl"
unless ( -e $tplfile );
my $template = HTML::Template->new(
filename => $tplfile,
filter => sub { $self->translate_template(@_) }
);
$body = $template->output();
$html = 1;
}
# Replace variables in body
$body =~ s/\$expMailDate/$self->{expMailDate}/g;
$body =~ s/\$expMailTime/$self->{expMailTime}/g;
$body =~ s/\$url/$url/g;
$body =~ s/\$(\w+)/$self->{sessionInfo}->{$1}/ge;
# Send mail
return PE_MAILCONFIRMOK
unless $self->send_mail( $self->{mailAddress}, $subject, $body, $html );
PE_MAILCONFIRMOK;
}
## @method int changePassword
# Change the password or generate a new password
# @return Lemonldap::NG::Portal constant
sub changePassword {
my ($self) = @_;
# Check if user wants to generate the new password
if ( $self->param('reset') ) {
$self->lmLog(
"Reset password request for " . $self->{sessionInfo}->{_user},
'debug' );
# Generate a complex password
my $password = $self->gen_password( $self->{randomPasswordRegexp} );
$self->lmLog( "Generated password: " . $password, 'debug' );
$self->{newpassword} = $password;
$self->{confirmpassword} = $password;
$self->{forceReset} = 1;
}
# Else a password is required
else {
unless ( $self->{newpassword} && $self->{confirmpassword} ) {
return PE_PASSWORDFIRSTACCESS if ( $self->request_method =~ /GET/ );
return PE_PASSWORDFORMEMPTY;
}
}
# Modify the password
$self->{portalRequireOldPassword} = 0;
$self->{user} = $self->{mail};
my $result = $self->modifyPassword();
$self->{user} = undef;
# Mail token can be used only one time, delete the session if all is ok
if ( $result == PE_PASSWORD_OK or $result == PE_OK ) {
# Get the corresponding session
my $mailSession = $self->getApacheSession( $self->{mail_token} );
if ($mailSession) {
$self->lmLog( "Delete mail session " . $self->{mail_token},
'debug' );
$mailSession->remove;
}
else {
$self->lmLog( "Mail session not found", 'warn' );
}
# Force result to PE_OK to continue the process
$result = PE_OK;
}
return $result;
}
## @method int sendPasswordMail
# Send mail containing the new password
# @return Lemonldap::NG::Portal constant
sub sendPasswordMail {
my ($self) = @_;
# Get mail address
unless ( $self->{mailAddress} ) {
$self->{mailAddress} =
$self->getFirstValue(
$self->{sessionInfo}->{ $self->{mailSessionKey} } );
}
# Build mail content
my $subject = $self->{mailSubject};
my $body;
my $html;
if ( $self->{mailBody} ) {
# We use a specific text message, no html
$body = $self->{mailBody};
}
else {
# Use HTML template
my $tplfile = $self->getApacheHtdocsPath
. "/skins/$self->{portalSkin}/mail_password.tpl";
$tplfile =
$self->getApacheHtdocsPath . "/skins/common/mail_password.tpl"
unless ( -e $tplfile );
my $template = HTML::Template->new(
filename => $tplfile,
filter => sub { $self->translate_template(@_) }
);
$template->param( RESET => $self->{forceReset} );
$body = $template->output();
$html = 1;
}
# Replace variables in body
my $password = $self->{newpassword};
$body =~ s/\$password/$password/g;
$body =~ s/\$(\w+)/$self->{sessionInfo}->{$1}/ge;
# Send mail
return PE_MAILERROR
unless $self->send_mail( $self->{mailAddress}, $subject, $body, $html );
PE_MAILOK;
}
1;
__END__
=head1 NAME
=encoding utf8
Lemonldap::NG::Portal::MailReset - Manage password reset by mail
=head1 SYNOPSIS
use Lemonldap::NG::Portal::MailReset;
my $portal = new Lemonldap::NG::Portal::MailReset();
$portal->process();
# Write here HTML to manage errors and confirmation messages
=head1 DESCRIPTION
Lemonldap::NG::Portal::MailReset enables password reset by mail
See L<Lemonldap::NG::Portal::SharedConf> for a complete example of use of
Lemonldap::Portal::* libraries.
=head1 METHODS
=head3 process
Main method.
=head1 SEE ALSO
L<Lemonldap::NG::Handler>, L<Lemonldap::NG::Portal::SharedConf>, L<CGI>,
L<http://lemonldap-ng.org/>
=head1 AUTHOR
=over
=item Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
=item François-Xavier Deltombe, E<lt>fxdeltombe@gmail.com.E<gt>
=item Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Sandro Cazzaniga, E<lt>cazzaniga.sandro@gmail.comE<gt>
=item Thomas Chemineau, E<lt>thomas.chemineau@gmail.comE<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) 2010-2012 by Xavier Guimard, E<lt>x.guimard@free.frE<gt>
=item Copyright (C) 2012 by Sandro Cazzaniga, E<lt>cazzaniga.sandro@gmail.comE<gt>
=item Copyright (C) 2012 by François-Xavier Deltombe, E<lt>fxdeltombe@gmail.com.E<gt>
=item Copyright (C) 2010-2015 by Clement Oudot, E<lt>clem.oudot@gmail.comE<gt>
=item Copyright (C) 2011 by Thomas Chemineau, E<lt>thomas.chemineau@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
|