Project

General

Profile

1 2341 sgarg
#!/usr/bin/perl -w
2 4865 walbridge
#
3
#  '$RCSfile$'
4
#  Copyright: 2001 Regents of the University of California
5
#
6
#   '$Author$'
7
#     '$Date$'
8
# '$Revision$'
9
#
10
# This program is free software; you can redistribute it and/or modify
11
# it under the terms of the GNU General Public License as published by
12
# the Free Software Foundation; either version 2 of the License, or
13
# (at your option) any later version.
14
#
15
# This program is distributed in the hope that it will be useful,
16
# but WITHOUT ANY WARRANTY; without even the implied warranty of
17
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
# GNU General Public License for more details.
19
#
20
# You should have received a copy of the GNU General Public License
21
# along with this program; if not, write to the Free Software
22
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23
#
24 2341 sgarg
25
#
26
# This is a web-based application for allowing users to register a new
27
# account for Metacat access.  We currently only support LDAP even
28
# though metacat could potentially support other types of directories.
29 4394 walbridge
30
use lib '../WEB-INF/lib';
31 4080 daigle
use strict;             # turn on strict syntax checking
32
use Template;           # load the template-toolkit module
33 4394 walbridge
use CGI qw/:standard :html3/; # load the CGI module
34 4080 daigle
use Net::LDAP;          # load the LDAP net libraries
35
use Net::SMTP;          # load the SMTP net libraries
36
use Digest::SHA1;       # for creating the password hash
37
use MIME::Base64;       # for creating the password hash
38
use URI;                # for parsing URL syntax
39
use Config::Properties; # for parsing Java .properties files
40
use File::Basename;     # for path name parsing
41 8166 tao
use Captcha::reCAPTCHA; # for protection against spams
42 4394 walbridge
use Cwd 'abs_path';
43 2341 sgarg
44 4080 daigle
# Global configuration paramters
45 4394 walbridge
# This entire block (including skin parsing) could be pushed out to a separate .pm file
46 4080 daigle
my $cgiUrl = $ENV{'SCRIPT_FILENAME'};
47
my $workingDirectory = dirname($cgiUrl);
48
my $metacatProps = "${workingDirectory}/../WEB-INF/metacat.properties";
49
my $properties = new Config::Properties();
50
unless (open (METACAT_PROPERTIES, $metacatProps)) {
51 4394 walbridge
    print "Content-type: text/html\n\n";
52 4080 daigle
    print "Unable to locate Metacat properties. Working directory is set as " .
53
        $workingDirectory .", is this correct?";
54
    exit(0);
55
}
56 2341 sgarg
57 4080 daigle
$properties->load(*METACAT_PROPERTIES);
58 4010 tao
59 4394 walbridge
# local directory configuration
60
my $skinsDir = "${workingDirectory}/../style/skins";
61
my $templatesDir = abs_path("${workingDirectory}/../style/common/templates");
62
my $tempDir = $properties->getProperty('application.tempDir');
63
64
# url configuration
65
my $server = $properties->splitToTree(qr/\./, 'server');
66 7199 leinfelder
my $protocol = 'http://';
67
if ( $properties->getProperty('server.httpPort') eq '443' ) {
68
	$protocol = 'https://';
69
}
70 8253 leinfelder
my $serverUrl = $protocol . $properties->getProperty('server.name');
71 4864 walbridge
if ($properties->getProperty('server.httpPort') ne '80') {
72 8253 leinfelder
        $serverUrl = $serverUrl . ':' . $properties->getProperty('server.httpPort');
73 4864 walbridge
}
74 8253 leinfelder
my $context = $properties->getProperty('application.context');
75
my $contextUrl = $serverUrl . '/' .  $context;
76 4394 walbridge
77
my $metacatUrl = $contextUrl . "/metacat";
78 8253 leinfelder
my $cgiPrefix = "/" . $context . "/cgi-bin";
79 4394 walbridge
my $styleSkinsPath = $contextUrl . "/style/skins";
80
my $styleCommonPath = $contextUrl . "/style/common";
81
82 8169 tao
#recaptcha key information
83
my $recaptchaPublicKey=$properties->getProperty('ldap.recaptcha.publickey');
84
my $recaptchaPrivateKey=$properties->getProperty('ldap.recaptcha.privatekey');
85
86 4394 walbridge
my @errorMessages;
87
my $error = 0;
88
89 8181 tao
my $emailVerification= 'emailverification';
90
91 4394 walbridge
# Import all of the HTML form fields as variables
92
import_names('FORM');
93
94
# Must have a config to use Metacat
95
my $skinName = "";
96
if ($FORM::cfg) {
97
    $skinName = $FORM::cfg;
98
} elsif ($ARGV[0]) {
99
    $skinName = $ARGV[0];
100
} else {
101 4747 walbridge
    debug("No configuration set.");
102 4394 walbridge
    print "Content-type: text/html\n\n";
103 4749 walbridge
    print 'LDAPweb Error: The registry requires a skin name to continue.';
104 4394 walbridge
    exit();
105
}
106
107
# Metacat isn't initialized, the registry will fail in strange ways.
108
if (!($metacatUrl)) {
109 4747 walbridge
    debug("No Metacat.");
110 4394 walbridge
    print "Content-type: text/html\n\n";
111
    'Registry Error: Metacat is not initialized! Make sure' .
112 5214 walbridge
        ' MetacatUrl is set correctly in ' .  $skinName . '.properties';
113 4394 walbridge
    exit();
114
}
115
116
my $skinProperties = new Config::Properties();
117
if (!($skinName)) {
118
    $error = "Application misconfigured.  Please contact the administrator.";
119
    push(@errorMessages, $error);
120
} else {
121
    my $skinProps = "$skinsDir/$skinName/$skinName.properties";
122
    unless (open (SKIN_PROPERTIES, $skinProps)) {
123
        print "Content-type: text/html\n\n";
124
        print "Unable to locate skin properties at $skinProps.  Is this path correct?";
125
        exit(0);
126
    }
127
    $skinProperties->load(*SKIN_PROPERTIES);
128
}
129
130
my $config = $skinProperties->splitToTree(qr/\./, 'registry.config');
131
132 4870 walbridge
# XXX HACK: this is a temporary fix to pull out the UCNRS password property from the
133
#           NRS skin instead of metacat.properties. The intent is to prevent editing
134
#           of our core properties file, which is manipulated purely through the web.
135
#           Once organizations are editable, this section should be removed as should
136
#           the properties within nrs/nrs.properties.
137
my $nrsProperties = new Config::Properties();
138
my $nrsProps = "$skinsDir/nrs/nrs.properties";
139
unless (open (NRS_PROPERTIES, $nrsProps)) {
140
    print "Content-type: text/html\n\n";
141
    print "Unable to locate skin properties at $nrsProps.  Is this path correct?";
142
    exit(0);
143
}
144
$nrsProperties->load(*NRS_PROPERTIES);
145
146
my $nrsConfig = $nrsProperties->splitToTree(qr/\./, 'registry.config');
147
148
# XXX END HACK
149
150
151 4394 walbridge
my $searchBase;
152
my $ldapUsername;
153
my $ldapPassword;
154 4728 walbridge
# TODO: when should we use surl instead? Is there a setting promoting one over the other?
155
# TODO: the default tree for accounts should be exposed somewhere, defaulting to unaffiliated
156
my $ldapurl = $properties->getProperty('auth.url');
157 4080 daigle
158
# Java uses miliseconds, Perl expects whole seconds
159 4728 walbridge
my $timeout = $properties->getProperty('ldap.connectTimeLimit') / 1000;
160 4080 daigle
161 2341 sgarg
# Get the CGI input variables
162
my $query = new CGI;
163 4747 walbridge
my $debug = 1;
164 2341 sgarg
165
#--------------------------------------------------------------------------80c->
166
# Set up the Template Toolkit to read html form templates
167
168 4080 daigle
# templates hash, imported from ldap.templates tree in metacat.properties
169
my $templates = $properties->splitToTree(qr/\./, 'ldap.templates');
170 4394 walbridge
$$templates{'header'} = $skinProperties->getProperty("registry.templates.header");
171
$$templates{'footer'} = $skinProperties->getProperty("registry.templates.footer");
172 2341 sgarg
173
# set some configuration options for the template object
174 4394 walbridge
my $ttConfig = {
175
             INCLUDE_PATH => $templatesDir,
176
             INTERPOLATE  => 0,
177
             POST_CHOMP   => 1,
178
             DEBUG        => 1,
179 2341 sgarg
             };
180
181
# create an instance of the template
182 4394 walbridge
my $template = Template->new($ttConfig) || handleGeneralServerFailure($Template::ERROR);
183 2341 sgarg
184 4080 daigle
# custom LDAP properties hash
185
my $ldapCustom = $properties->splitToTree(qr/\./, 'ldap');
186 2341 sgarg
187 8201 tao
# This is a hash which has the keys of the organization's properties 'name', 'base', 'organization'.
188 4394 walbridge
my $orgProps = $properties->splitToTree(qr/\./, 'organization');
189 8201 tao
190
#This is a hash which has the keys of the ldap sub tree names of the organizations, such as 'NCEAS', 'LTER' and 'KU', and values are real name of the organization.
191 4394 walbridge
my $orgNames = $properties->splitToTree(qr/\./, 'organization.name');
192
# pull out properties available e.g. 'name', 'base'
193
my @orgData = keys(%$orgProps);
194 4870 walbridge
195 8201 tao
my @orgList; #An array has the names (i.e, sub tree names, such as 'NCEAS', 'LTER' and 'KU')  of the all organizations in the metacat.properties.
196 4394 walbridge
while (my ($oKey, $oVal) = each(%$orgNames)) {
197
    push(@orgList, $oKey);
198
}
199
200 4866 walbridge
my $authBase = $properties->getProperty("auth.base");
201 4080 daigle
my $ldapConfig;
202
foreach my $o (@orgList) {
203 4394 walbridge
    foreach my $d (@orgData) {
204
        $ldapConfig->{$o}{$d} = $properties->getProperty("organization.$d.$o");
205 4080 daigle
    }
206 4866 walbridge
207 4870 walbridge
    # XXX hack, remove after 1.9
208
    if ($o eq 'UCNRS') {
209
        $ldapConfig->{'UCNRS'}{'base'} = $nrsConfig->{'base'};
210
        $ldapConfig->{'UCNRS'}{'user'} = $nrsConfig->{'username'};
211
        $ldapConfig->{'UCNRS'}{'password'} = $nrsConfig->{'password'};
212
    }
213
214 4866 walbridge
    # set default base
215
    if (!$ldapConfig->{$o}{'base'}) {
216
        $ldapConfig->{$o}{'base'} = $authBase;
217
    }
218
219
    # include filter information. By default, our filters are 'o=$name', e.g. 'o=NAPIER'
220
    # these can be overridden by specifying them in metacat.properties. Non-default configs
221
    # such as UCNRS must specify all LDAP properties.
222
    if ($ldapConfig->{$o}{'base'} eq $authBase) {
223
        my $filter = "o=$o";
224
        if (!$ldapConfig->{$o}{'org'}) {
225
            $ldapConfig->{$o}{'org'} = $filter;
226
        }
227
        if (!$ldapConfig->{$o}{'filter'}) {
228 8201 tao
            #$ldapConfig->{$o}{'filter'} = $filter;
229
            $ldapConfig->{$o}{'filter'} = $ldapConfig->{$o}{'org'};
230 4866 walbridge
        }
231
        # also include DN, which is just org + base
232
        if ($ldapConfig->{$o}{'org'}) {
233
            $ldapConfig->{$o}{'dn'} = $ldapConfig->{$o}{'org'} . "," . $ldapConfig->{$o}{'base'};
234
        }
235 4394 walbridge
    } else {
236
        $ldapConfig->{$o}{'dn'} = $ldapConfig->{$o}{'base'};
237
    }
238 4868 walbridge
239
    # set LDAP administrator user account
240 4866 walbridge
    if (!$ldapConfig->{$o}{'user'}) {
241
        $ldapConfig->{$o}{'user'} = $ldapConfig->{'unaffiliated'}{'user'};
242 4865 walbridge
    }
243 4868 walbridge
    # check for a fully qualified LDAP name. If it doesn't exist, append base.
244
    my @userParts = split(',', $ldapConfig->{$o}{'user'});
245
    if (scalar(@userParts) == 1) {
246
        $ldapConfig->{$o}{'user'} = $ldapConfig->{$o}{'user'} . "," . $ldapConfig->{$o}{'base'};
247
    }
248 4866 walbridge
249
    if (!$ldapConfig->{$o}{'password'}) {
250
        $ldapConfig->{$o}{'password'} = $ldapConfig->{'unaffiliated'}{'password'};
251
    }
252 2341 sgarg
}
253
254 8201 tao
### Determine the display organization list (such as NCEAS, Account ) in the ldap template files
255 8206 tao
my $displayOrgListStr;
256
$displayOrgListStr = $skinProperties->getProperty("ldap.templates.organizationList") or $displayOrgListStr = $properties->getProperty('ldap.templates.organizationList');
257 8207 tao
debug("the string of the org from properties : " . $displayOrgListStr);
258
my @displayOrgList = split(';', $displayOrgListStr);
259
260 8206 tao
my @validDisplayOrgList; #this array contains the org list which will be shown in the templates files.
261 8201 tao
262 8206 tao
my %orgNamesHash = %$orgNames;
263
foreach my $element (@displayOrgList) {
264
    if(exists $orgNamesHash{$element}) {
265 8207 tao
         debug("push the organization " . $element . " into the dispaly array");
266 8206 tao
         #if the name is found in the organization part of metacat.properties, put it into the valid array
267
         push(@validDisplayOrgList, $element);
268
    }
269
270
}
271 8201 tao
272 8206 tao
if(!@validDisplayOrgList) {
273
     my $sender;
274
     $sender = $skinProperties->getProperty("email.sender") or $sender = $properties->getProperty('email.sender');
275
    print "Content-type: text/html\n\n";
276
    print "The value of property ldap.templates.organizationList in "
277
     . $skinName . ".properties file or metacat.properties file (if the property doesn't exist in the "
278
     . $skinName . ".properties file) is invalid. Please send the information to ". $sender;
279
    exit(0);
280
}
281
282
283 2341 sgarg
#--------------------------------------------------------------------------80c->
284
# Define the main program logic that calls subroutines to do the work
285
#--------------------------------------------------------------------------80c->
286
287
# The processing step we are handling
288 4080 daigle
my $stage = $query->param('stage') || $templates->{'stage'};
289 2341 sgarg
290
my $cfg = $query->param('cfg');
291 4767 walbridge
debug("started with stage $stage, cfg $cfg");
292 2341 sgarg
293
# define the possible stages
294
my %stages = (
295
              'initregister'      => \&handleInitRegister,
296
              'register'          => \&handleRegister,
297
              'registerconfirmed' => \&handleRegisterConfirmed,
298
              'simplesearch'      => \&handleSimpleSearch,
299
              'initaddentry'      => \&handleInitAddEntry,
300
              'addentry'          => \&handleAddEntry,
301
              'initmodifyentry'   => \&handleInitModifyEntry,
302
              'modifyentry'       => \&handleModifyEntry,
303 2972 jones
              'changepass'        => \&handleChangePassword,
304
              'initchangepass'    => \&handleInitialChangePassword,
305 2341 sgarg
              'resetpass'         => \&handleResetPassword,
306 2414 sgarg
              'initresetpass'     => \&handleInitialResetPassword,
307 8185 tao
              'emailverification' => \&handleEmailVerification,
308 8229 tao
              'lookupname'        => \&handleLookupName,
309
              'searchnamesbyemail'=> \&handleSearchNameByEmail,
310 2341 sgarg
             );
311 4394 walbridge
312 2341 sgarg
# call the appropriate routine based on the stage
313
if ( $stages{$stage} ) {
314
  $stages{$stage}->();
315
} else {
316
  &handleResponseMessage();
317
}
318
319
#--------------------------------------------------------------------------80c->
320
# Define the subroutines to do the work
321
#--------------------------------------------------------------------------80c->
322
323 4728 walbridge
sub fullTemplate {
324
    my $templateList = shift;
325
    my $templateVars = setVars(shift);
326 8166 tao
    my $c = Captcha::reCAPTCHA->new;
327
    my $captcha = 'captcha';
328
    #my $error=null;
329
    my $use_ssl= 1;
330
    #my $options=null;
331 8250 leinfelder
    # use the AJAX style, only need to provide the public key to the template
332
    $templateVars->{'recaptchaPublicKey'} = $recaptchaPublicKey;
333
    #$templateVars->{$captcha} = $c->get_html($recaptchaPublicKey,undef, $use_ssl, undef);
334 4728 walbridge
    $template->process( $templates->{'header'}, $templateVars );
335
    foreach my $tmpl (@{$templateList}) {
336
        $template->process( $templates->{$tmpl}, $templateVars );
337
    }
338
    $template->process( $templates->{'footer'}, $templateVars );
339
}
340
341 8221 tao
342 8229 tao
#
343
# Initialize a form for a user to request the account name associated with an email address
344
#
345
sub handleLookupName {
346
347
    print "Content-type: text/html\n\n";
348
    # process the template files:
349
    fullTemplate(['lookupName']);
350
    exit();
351
}
352 8221 tao
353 2341 sgarg
#
354 8221 tao
# Handle the user's request to look up account names with a specified email address.
355
# This relates to "Forget your user name"
356
#
357 8229 tao
sub handleSearchNameByEmail{
358 8221 tao
359
    print "Content-type: text/html\n\n";
360
361
    my $allParams = {'mail' => $query->param('mail')};
362
    my @requiredParams = ('mail');
363
    if (! paramsAreValid(@requiredParams)) {
364
        my $errorMessage = "Required information is missing. " .
365
            "Please fill in all required fields and resubmit the form.";
366 8229 tao
        fullTemplate(['lookupName'], { allParams => $allParams,
367 8221 tao
                                     errorMessage => $errorMessage });
368
        exit();
369
    }
370
    my $mail = $query->param('mail');
371
372
    #search accounts with the specified emails
373
    $searchBase = $authBase;
374
    my $filter = "(mail=" . $mail . ")";
375
    my @attrs = [ 'uid', 'o', 'ou', 'cn', 'mail', 'telephoneNumber', 'title' ];
376
    my $notHtmlFormat = 1;
377
    my $found = findExistingAccounts($ldapurl, $searchBase, $filter, \@attrs, $notHtmlFormat);
378
    my $accountInfo;
379 8254 leinfelder
    if ($found) {
380 8221 tao
        $accountInfo = $found;
381
    } else {
382 8254 leinfelder
        $accountInfo = "There are no accounts associated with the email " . $mail . ".\n";
383 8221 tao
    }
384 8254 leinfelder
385 8221 tao
    my $mailhost = $properties->getProperty('email.mailhost');
386
    my $sender;
387
    $sender = $skinProperties->getProperty("email.sender") or $sender = $properties->getProperty('email.sender');
388
    debug("the sender is " . $sender);
389
    my $recipient = $query->param('mail');
390
    # Send the email message to them
391
    my $smtp = Net::SMTP->new($mailhost) or do {
392 8229 tao
                                                  fullTemplate( ['lookupName'], {allParams => $allParams,
393
                                                                errorMessage => "Our mail server currently is experiencing some difficulties. Please contact " .
394
                                                                $skinProperties->getProperty("email.recipient") . "." });
395 8221 tao
                                                  exit(0);
396
                                               };
397
    $smtp->mail($sender);
398
    $smtp->to($recipient);
399
400
    my $message = <<"     ENDOFMESSAGE";
401
    To: $recipient
402
    From: $sender
403 8234 tao
    Subject: Your Account Information
404 8221 tao
405 8234 tao
    Somebody (hopefully you) looked up the account information associated with the email address.
406
    Here is the account information:
407 8221 tao
408
    $accountInfo
409
410
    Thanks,
411 8234 tao
        $sender
412 8221 tao
413
     ENDOFMESSAGE
414
     $message =~ s/^[ \t\r\f]+//gm;
415
416
     $smtp->data($message);
417
     $smtp->quit;
418
     fullTemplate( ['lookupNameSuccess'] );
419
420
}
421
422
423
#
424 2341 sgarg
# create the initial registration form
425
#
426
sub handleInitRegister {
427
  my $vars = shift;
428
  print "Content-type: text/html\n\n";
429
  # process the template files:
430 4080 daigle
  fullTemplate(['register'], {stage => "register"});
431 2341 sgarg
  exit();
432
}
433
434 8221 tao
435
436 2341 sgarg
#
437
# process input from the register stage, which occurs when
438
# a user submits form data to create a new account
439
#
440
sub handleRegister {
441
442 8258 tao
    #print "Content-type: text/html\n\n";
443 8220 tao
    if ($query->param('o') =~ "LTER") {
444 8258 tao
      print "Content-type: text/html\n\n";
445 8220 tao
      fullTemplate( ['registerLter'] );
446
      exit(0);
447
    }
448 8166 tao
449 2341 sgarg
    my $allParams = { 'givenName' => $query->param('givenName'),
450
                      'sn' => $query->param('sn'),
451
                      'o' => $query->param('o'),
452
                      'mail' => $query->param('mail'),
453
                      'uid' => $query->param('uid'),
454
                      'userPassword' => $query->param('userPassword'),
455
                      'userPassword2' => $query->param('userPassword2'),
456
                      'title' => $query->param('title'),
457
                      'telephoneNumber' => $query->param('telephoneNumber') };
458 8166 tao
459
    # Check the recaptcha
460
    my $c = Captcha::reCAPTCHA->new;
461
    my $challenge = $query->param('recaptcha_challenge_field');
462
    my $response = $query->param('recaptcha_response_field');
463
    # Verify submission
464
    my $result = $c->check_answer(
465 8169 tao
        $recaptchaPrivateKey, $ENV{'REMOTE_ADDR'},
466 8166 tao
        $challenge, $response
467
    );
468
469
    if ( $result->{is_valid} ) {
470
        #print "Yes!";
471
        #exit();
472
    }
473
    else {
474 8258 tao
        print "Content-type: text/html\n\n";
475 8166 tao
        my $errorMessage = "The verification code is wrong. Please input again.";
476
        fullTemplate(['register'], { stage => "register",
477
                                     allParams => $allParams,
478
                                     errorMessage => $errorMessage });
479
        exit();
480
    }
481
482
483 2341 sgarg
    # Check that all required fields are provided and not null
484
    my @requiredParams = ( 'givenName', 'sn', 'o', 'mail',
485
                           'uid', 'userPassword', 'userPassword2');
486
    if (! paramsAreValid(@requiredParams)) {
487 8258 tao
        print "Content-type: text/html\n\n";
488 2341 sgarg
        my $errorMessage = "Required information is missing. " .
489
            "Please fill in all required fields and resubmit the form.";
490 4080 daigle
        fullTemplate(['register'], { stage => "register",
491
                                     allParams => $allParams,
492
                                     errorMessage => $errorMessage });
493
        exit();
494 2341 sgarg
    } else {
495 8186 tao
         if ($query->param('userPassword') ne $query->param('userPassword2')) {
496 8258 tao
            print "Content-type: text/html\n\n";
497 8186 tao
            my $errorMessage = "The passwords do not match. Try again.";
498
            fullTemplate( ['registerFailed', 'register'], { stage => "register",
499
                                                            allParams => $allParams,
500
                                                            errorMessage => $errorMessage });
501
            exit();
502
        }
503 2972 jones
        my $o = $query->param('o');
504 4080 daigle
        $searchBase = $ldapConfig->{$o}{'base'};
505 2341 sgarg
    }
506
507
    # Search LDAP for matching entries that already exist
508
    # Some forms use a single text search box, whereas others search per
509
    # attribute.
510
    my $filter;
511
    if ($query->param('searchField')) {
512
513
      $filter = "(|" .
514
                "(uid=" . $query->param('searchField') . ") " .
515
                "(mail=" . $query->param('searchField') . ")" .
516
                "(&(sn=" . $query->param('searchField') . ") " .
517
                "(givenName=" . $query->param('searchField') . "))" .
518
                ")";
519
    } else {
520
      $filter = "(|" .
521
                "(uid=" . $query->param('uid') . ") " .
522
                "(mail=" . $query->param('mail') . ")" .
523
                "(&(sn=" . $query->param('sn') . ") " .
524
                "(givenName=" . $query->param('givenName') . "))" .
525
                ")";
526
    }
527
528 8217 tao
    my @attrs = [ 'uid', 'o', 'ou', 'cn', 'mail', 'telephoneNumber', 'title' ];
529 2341 sgarg
    my $found = findExistingAccounts($ldapurl, $searchBase, $filter, \@attrs);
530
531
    # If entries match, send back a request to confirm new-user creation
532
    if ($found) {
533 4080 daigle
      fullTemplate( ['registerMatch', 'register'], { stage => "registerconfirmed",
534
                                                     allParams => $allParams,
535
                                                     foundAccounts => $found });
536 2341 sgarg
    # Otherwise, create a new user in the LDAP directory
537
    } else {
538 8180 tao
        createTemporaryAccount($allParams);
539 2341 sgarg
    }
540
541
    exit();
542
}
543
544
#
545
# process input from the registerconfirmed stage, which occurs when
546
# a user chooses to create an account despite similarities to other
547
# existing accounts
548
#
549
sub handleRegisterConfirmed {
550
551
    my $allParams = { 'givenName' => $query->param('givenName'),
552
                      'sn' => $query->param('sn'),
553 8207 tao
                      'o' => $query->param('o'),
554 2341 sgarg
                      'mail' => $query->param('mail'),
555
                      'uid' => $query->param('uid'),
556
                      'userPassword' => $query->param('userPassword'),
557
                      'userPassword2' => $query->param('userPassword2'),
558
                      'title' => $query->param('title'),
559
                      'telephoneNumber' => $query->param('telephoneNumber') };
560 8258 tao
    #print "Content-type: text/html\n\n";
561 8180 tao
    createTemporaryAccount($allParams);
562 2341 sgarg
    exit();
563
}
564
565
#
566
# change a user's password upon request
567
#
568
sub handleChangePassword {
569
570
    print "Content-type: text/html\n\n";
571
572
    my $allParams = { 'test' => "1", };
573
    if ($query->param('uid')) {
574
        $$allParams{'uid'} = $query->param('uid');
575
    }
576
    if ($query->param('o')) {
577
        $$allParams{'o'} = $query->param('o');
578 2972 jones
        my $o = $query->param('o');
579
580 4080 daigle
        $searchBase = $ldapConfig->{$o}{'base'};
581 2341 sgarg
    }
582
583
584
    # Check that all required fields are provided and not null
585
    my @requiredParams = ( 'uid', 'o', 'oldpass',
586
                           'userPassword', 'userPassword2');
587
    if (! paramsAreValid(@requiredParams)) {
588
        my $errorMessage = "Required information is missing. " .
589
            "Please fill in all required fields and submit the form.";
590 4080 daigle
        fullTemplate( ['changePass'], { stage => "changepass",
591
                                        allParams => $allParams,
592
                                        errorMessage => $errorMessage });
593
        exit();
594 2341 sgarg
    }
595
596
    # We have all of the info we need, so try to change the password
597
    if ($query->param('userPassword') =~ $query->param('userPassword2')) {
598
599 2972 jones
        my $o = $query->param('o');
600 4080 daigle
        $searchBase = $ldapConfig->{$o}{'base'};
601
        $ldapUsername = $ldapConfig->{$o}{'user'};
602
        $ldapPassword = $ldapConfig->{$o}{'password'};
603 2341 sgarg
604 4080 daigle
        my $dn = "uid=" . $query->param('uid') . "," . $ldapConfig->{$o}{'dn'};;
605 2341 sgarg
        if ($query->param('o') =~ "LTER") {
606 4080 daigle
            fullTemplate( ['registerLter'] );
607 2341 sgarg
        } else {
608
            my $errorMessage = changePassword(
609
                    $dn, $query->param('userPassword'),
610
                    $dn, $query->param('oldpass'), $query->param('o'));
611 2972 jones
            if ($errorMessage) {
612 4080 daigle
                fullTemplate( ['changePass'], { stage => "changepass",
613
                                                allParams => $allParams,
614
                                                errorMessage => $errorMessage });
615
                exit();
616 2341 sgarg
            } else {
617 4080 daigle
                fullTemplate( ['changePassSuccess'], { stage => "changepass",
618
                                                       allParams => $allParams });
619
                exit();
620 2341 sgarg
            }
621
        }
622
    } else {
623
        my $errorMessage = "The passwords do not match. Try again.";
624 4080 daigle
        fullTemplate( ['changePass'], { stage => "changepass",
625
                                        allParams => $allParams,
626
                                        errorMessage => $errorMessage });
627
        exit();
628 2341 sgarg
    }
629
}
630
631
#
632 2414 sgarg
# change a user's password upon request - no input params
633
# only display chagepass template without any error
634
#
635
sub handleInitialChangePassword {
636
    print "Content-type: text/html\n\n";
637
638
    my $allParams = { 'test' => "1", };
639
    my $errorMessage = "";
640 4080 daigle
    fullTemplate( ['changePass'], { stage => "changepass",
641
                                    errorMessage => $errorMessage });
642
    exit();
643 2414 sgarg
}
644
645
#
646 2341 sgarg
# reset a user's password upon request
647
#
648
sub handleResetPassword {
649
650
    print "Content-type: text/html\n\n";
651
652
    my $allParams = { 'test' => "1", };
653
    if ($query->param('uid')) {
654
        $$allParams{'uid'} = $query->param('uid');
655
    }
656
    if ($query->param('o')) {
657
        $$allParams{'o'} = $query->param('o');
658 2972 jones
        my $o = $query->param('o');
659
660 4080 daigle
        $searchBase = $ldapConfig->{$o}{'base'};
661 4868 walbridge
        $ldapUsername = $ldapConfig->{$o}{'user'};
662 4080 daigle
        $ldapPassword = $ldapConfig->{$o}{'password'};
663 2341 sgarg
    }
664
665
    # Check that all required fields are provided and not null
666
    my @requiredParams = ( 'uid', 'o' );
667
    if (! paramsAreValid(@requiredParams)) {
668
        my $errorMessage = "Required information is missing. " .
669
            "Please fill in all required fields and submit the form.";
670 4080 daigle
        fullTemplate( ['resetPass'],  { stage => "resetpass",
671
                                        allParams => $allParams,
672
                                        errorMessage => $errorMessage });
673
        exit();
674 2341 sgarg
    }
675
676
    # We have all of the info we need, so try to change the password
677
    my $o = $query->param('o');
678 4080 daigle
    my $dn = "uid=" . $query->param('uid') . "," . $ldapConfig->{$o}{'dn'};
679 4866 walbridge
    debug("handleResetPassword: dn: $dn");
680 2341 sgarg
    if ($query->param('o') =~ "LTER") {
681 4080 daigle
        fullTemplate( ['registerLter'] );
682
        exit();
683 2341 sgarg
    } else {
684
        my $errorMessage = "";
685
        my $recipient;
686
        my $userPass;
687
        my $entry = getLdapEntry($ldapurl, $searchBase,
688
                $query->param('uid'), $query->param('o'));
689
690
        if ($entry) {
691
            $recipient = $entry->get_value('mail');
692
            $userPass = getRandomPassword();
693 4080 daigle
            $errorMessage = changePassword($dn, $userPass, $ldapUsername, $ldapPassword, $query->param('o'));
694 2341 sgarg
        } else {
695
            $errorMessage = "User not found in database.  Please try again.";
696
        }
697
698
        if ($errorMessage) {
699 4080 daigle
            fullTemplate( ['resetPass'], { stage => "resetpass",
700
                                           allParams => $allParams,
701
                                           errorMessage => $errorMessage });
702
            exit();
703 2341 sgarg
        } else {
704
            my $errorMessage = sendPasswordNotification($query->param('uid'),
705 2972 jones
                    $query->param('o'), $userPass, $recipient, $cfg);
706 4080 daigle
            fullTemplate( ['resetPassSuccess'], { stage => "resetpass",
707
                                                  allParams => $allParams,
708
                                                  errorMessage => $errorMessage });
709
            exit();
710 2341 sgarg
        }
711
    }
712
}
713
714
#
715 2414 sgarg
# reset a user's password upon request- no initial params
716
# only display resetpass template without any error
717
#
718
sub handleInitialResetPassword {
719
    print "Content-type: text/html\n\n";
720
    my $errorMessage = "";
721 4080 daigle
    fullTemplate( ['resetPass'], { stage => "resetpass",
722
                                   errorMessage => $errorMessage });
723
    exit();
724 2414 sgarg
}
725
726
#
727 2341 sgarg
# Construct a random string to use for a newly reset password
728
#
729
sub getRandomPassword {
730
    my $length = shift;
731
    if (!$length) {
732
        $length = 8;
733
    }
734
    my $newPass = "";
735
736
    my @chars = ( "A" .. "Z", "a" .. "z", 0 .. 9, qw(! @ $ ^) );
737
    $newPass = join("", @chars[ map { rand @chars } ( 1 .. $length ) ]);
738
    return $newPass;
739
}
740
741
#
742
# Change a password to a new value, binding as the provided user
743
#
744
sub changePassword {
745
    my $userDN = shift;
746
    my $userPass = shift;
747
    my $bindDN = shift;
748
    my $bindPass = shift;
749
    my $o = shift;
750
751 4080 daigle
    my $searchBase = $ldapConfig->{$o}{'base'};
752 4868 walbridge
753 2341 sgarg
    my $errorMessage = 0;
754 3177 tao
    my $ldap;
755 4868 walbridge
756 4771 walbridge
    #if main ldap server is down, a html file containing warning message will be returned
757
    $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
758 4394 walbridge
759 4849 daigle
    if ($ldap) {
760 4868 walbridge
        #$ldap->start_tls( verify => 'require',
761 2972 jones
                      #cafile => '/usr/share/ssl/ldapcerts/cacert.pem');
762 4868 walbridge
        $ldap->start_tls( verify => 'none');
763
        debug("changePassword: attempting to bind to $bindDN");
764
        my $bindresult = $ldap->bind( version => 3, dn => $bindDN,
765 2341 sgarg
                                  password => $bindPass );
766 4868 walbridge
        if ($bindresult->code) {
767
            $errorMessage = "Failed to log in. Are you sure your connection credentails are " .
768
                            "correct? Please correct and try again...";
769
            return $errorMessage;
770
        }
771 2341 sgarg
772 4849 daigle
    	# Find the user here and change their entry
773
    	my $newpass = createSeededPassHash($userPass);
774
    	my $modifications = { userPassword => $newpass };
775 4868 walbridge
      debug("changePass: setting password for $userDN to $newpass");
776 4849 daigle
    	my $result = $ldap->modify( $userDN, replace => { %$modifications });
777 2341 sgarg
778 4849 daigle
    	if ($result->code()) {
779 4866 walbridge
            debug("changePass: error changing password: " . $result->error);
780
        	$errorMessage = "There was an error changing the password:" .
781 2341 sgarg
                           "<br />\n" . $result->error;
782 4849 daigle
    	}
783
    	$ldap->unbind;   # take down session
784
    }
785 2341 sgarg
786
    return $errorMessage;
787
}
788
789
#
790
# generate a Seeded SHA1 hash of a plaintext password
791
#
792
sub createSeededPassHash {
793
    my $secret = shift;
794
795
    my $salt = "";
796
    for (my $i=0; $i < 4; $i++) {
797
        $salt .= int(rand(10));
798
    }
799
800
    my $ctx = Digest::SHA1->new;
801
    $ctx->add($secret);
802
    $ctx->add($salt);
803
    my $hashedPasswd = '{SSHA}' . encode_base64($ctx->digest . $salt ,'');
804
805
    return $hashedPasswd;
806
}
807
808
#
809
# Look up an ldap entry for a user
810
#
811
sub getLdapEntry {
812
    my $ldapurl = shift;
813
    my $base = shift;
814
    my $username = shift;
815
    my $org = shift;
816
817
    my $entry = "";
818
    my $mesg;
819 3177 tao
    my $ldap;
820 4749 walbridge
    debug("ldap server: $ldapurl");
821 4394 walbridge
822
    #if main ldap server is down, a html file containing warning message will be returned
823 4771 walbridge
    $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
824 4849 daigle
825
    if ($ldap) {
826
    	$ldap->start_tls( verify => 'none');
827
    	my $bindresult = $ldap->bind;
828
    	if ($bindresult->code) {
829
        	return $entry;
830
    	}
831 2341 sgarg
832 4849 daigle
    	if($ldapConfig->{$org}{'filter'}){
833 4865 walbridge
            debug("getLdapEntry: filter set, searching for base=$base, " .
834
                  "(&(uid=$username)($ldapConfig->{$org}{'filter'})");
835 4849 daigle
        	$mesg = $ldap->search ( base   => $base,
836 4080 daigle
                filter => "(&(uid=$username)($ldapConfig->{$org}{'filter'}))");
837 4849 daigle
    	} else {
838 4865 walbridge
            debug("getLdapEntry: no filter, searching for $base, (uid=$username)");
839 4849 daigle
        	$mesg = $ldap->search ( base   => $base, filter => "(uid=$username)");
840
    	}
841 3177 tao
842 4849 daigle
    	if ($mesg->count > 0) {
843
        	$entry = $mesg->pop_entry;
844
        	$ldap->unbind;   # take down session
845
    	} else {
846
        	$ldap->unbind;   # take down session
847
        	# Follow references by recursive call to self
848
        	my @references = $mesg->references();
849
        	for (my $i = 0; $i <= $#references; $i++) {
850
            	my $uri = URI->new($references[$i]);
851
            	my $host = $uri->host();
852
            	my $path = $uri->path();
853
            	$path =~ s/^\///;
854
            	$entry = &getLdapEntry($host, $path, $username, $org);
855
            	if ($entry) {
856 4865 walbridge
                    debug("getLdapEntry: recursion found $host, $path, $username, $org");
857 4849 daigle
                	return $entry;
858
            	}
859
        	}
860
    	}
861 2341 sgarg
    }
862
    return $entry;
863
}
864
865
#
866
# send an email message notifying the user of the pw change
867
#
868
sub sendPasswordNotification {
869
    my $username = shift;
870
    my $org = shift;
871
    my $newPass = shift;
872
    my $recipient = shift;
873 2972 jones
    my $cfg = shift;
874 2341 sgarg
875
    my $errorMessage = "";
876
    if ($recipient) {
877 8254 leinfelder
878 4771 walbridge
        my $mailhost = $properties->getProperty('email.mailhost');
879 8197 tao
        my $sender;
880
        $sender = $skinProperties->getProperty("email.sender") or $sender = $properties->getProperty('email.sender');
881 2341 sgarg
        # Send the email message to them
882
        my $smtp = Net::SMTP->new($mailhost);
883
        $smtp->mail($sender);
884
        $smtp->to($recipient);
885
886
        my $message = <<"        ENDOFMESSAGE";
887
        To: $recipient
888
        From: $sender
889 8234 tao
        Subject: Your Account Password Reset
890 2341 sgarg
891 8234 tao
        Somebody (hopefully you) requested that your account password be reset.
892 8259 leinfelder
        Your temporary password is below. Please change it as soon as possible
893
        at: $contextUrl.
894 2341 sgarg
895
            Username: $username
896
        Organization: $org
897
        New Password: $newPass
898
899
        Thanks,
900 8234 tao
            $sender
901 2341 sgarg
902
        ENDOFMESSAGE
903
        $message =~ s/^[ \t\r\f]+//gm;
904
905
        $smtp->data($message);
906
        $smtp->quit;
907
    } else {
908
        $errorMessage = "Failed to send password because I " .
909
                        "couldn't find a valid email address.";
910
    }
911
    return $errorMessage;
912
}
913
914
#
915
# search the LDAP directory to see if a similar account already exists
916
#
917
sub findExistingAccounts {
918
    my $ldapurl = shift;
919
    my $base = shift;
920
    my $filter = shift;
921
    my $attref = shift;
922 8221 tao
    my $notHtmlFormat = shift;
923 3175 tao
    my $ldap;
924 4847 daigle
    my $mesg;
925 2341 sgarg
926
    my $foundAccounts = 0;
927 4749 walbridge
928 4394 walbridge
    #if main ldap server is down, a html file containing warning message will be returned
929 4868 walbridge
    debug("findExistingAccounts: connecting to $ldapurl, $timeout");
930 4771 walbridge
    $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
931 4845 daigle
    if ($ldap) {
932
    	$ldap->start_tls( verify => 'none');
933
    	$ldap->bind( version => 3, anonymous => 1);
934 4848 daigle
		$mesg = $ldap->search (
935 4845 daigle
			base   => $base,
936
			filter => $filter,
937
			attrs => @$attref,
938
		);
939 2341 sgarg
940 4845 daigle
	    if ($mesg->count() > 0) {
941
			$foundAccounts = "";
942
			my $entry;
943
			foreach $entry ($mesg->all_entries) {
944 5650 walbridge
                # a fix to ignore 'ou=Account' properties which are not usable accounts within Metacat.
945
                # this could be done directly with filters on the LDAP connection, instead.
946 8217 tao
                #if ($entry->dn !~ /ou=Account/) {
947 8221 tao
                    if($notHtmlFormat) {
948
                        $foundAccounts .= "\nAccount: ";
949
                    } else {
950
                        $foundAccounts .= "<p>\n<b><u>Account:</u> ";
951
                    }
952 5650 walbridge
                    $foundAccounts .= $entry->dn();
953 8221 tao
                    if($notHtmlFormat) {
954
                        $foundAccounts .= "\n";
955
                    } else {
956
                        $foundAccounts .= "</b><br />\n";
957
                    }
958 5650 walbridge
                    foreach my $attribute ($entry->attributes()) {
959
                        my $value = $entry->get_value($attribute);
960
                        $foundAccounts .= "$attribute: ";
961
                        $foundAccounts .= $value;
962 8221 tao
                         if($notHtmlFormat) {
963
                            $foundAccounts .= "\n";
964
                        } else {
965
                            $foundAccounts .= "<br />\n";
966
                        }
967 5650 walbridge
                    }
968 8221 tao
                    if($notHtmlFormat) {
969
                        $foundAccounts .= "\n";
970
                    } else {
971
                        $foundAccounts .= "</p>\n";
972
                    }
973
974 8217 tao
                #}
975 4845 daigle
			}
976 2341 sgarg
        }
977 4845 daigle
    	$ldap->unbind;   # take down session
978 2341 sgarg
979 4848 daigle
    	# Follow references
980
    	my @references = $mesg->references();
981
    	for (my $i = 0; $i <= $#references; $i++) {
982
        	my $uri = URI->new($references[$i]);
983
        	my $host = $uri->host();
984
        	my $path = $uri->path();
985
        	$path =~ s/^\///;
986 8254 leinfelder
        	my $refFound = &findExistingAccounts($host, $path, $filter, $attref, $notHtmlFormat);
987 4848 daigle
        	if ($refFound) {
988
            	$foundAccounts .= $refFound;
989
        	}
990
    	}
991 2341 sgarg
    }
992
993
    #print "<p>Checking referrals...</p>\n";
994
    #my @referrals = $mesg->referrals();
995
    #print "<p>Referrals count: ", scalar(@referrals), "</p>\n";
996
    #for (my $i = 0; $i <= $#referrals; $i++) {
997
        #print "<p>Referral: ", $referrals[$i], "</p>\n";
998
    #}
999
1000
    return $foundAccounts;
1001
}
1002
1003
#
1004
# Validate that we have the proper set of input parameters
1005
#
1006
sub paramsAreValid {
1007
    my @pnames = @_;
1008
1009
    my $allValid = 1;
1010
    foreach my $parameter (@pnames) {
1011
        if (!defined($query->param($parameter)) ||
1012
            ! $query->param($parameter) ||
1013
            $query->param($parameter) =~ /^\s+$/) {
1014
            $allValid = 0;
1015
        }
1016
    }
1017
1018
    return $allValid;
1019
}
1020
1021
#
1022 8175 tao
# Create a temporary account for a user and send an email with a link which can click for the
1023
# verification. This is used to protect the ldap server against spams.
1024
#
1025
sub createTemporaryAccount {
1026
    my $allParams = shift;
1027 8180 tao
    my $org = $query->param('o');
1028 8220 tao
    my $ldapUsername = $ldapConfig->{$org}{'user'};
1029
    my $ldapPassword = $ldapConfig->{$org}{'password'};
1030
    my $tmp = 1;
1031 8185 tao
1032 8220 tao
    ################## Search LDAP to see if the dc=tmp which stores the inactive accounts exist or not. If it doesn't exist, it will be generated
1033
    my $orgAuthBase = $ldapConfig->{$org}{'base'};
1034
    my $tmpSearchBase = 'dc=tmp,' . $orgAuthBase;
1035
    my $tmpFilter = "dc=tmp";
1036
    my @attributes=['dc'];
1037
    my $foundTmp = searchDirectory($ldapurl, $orgAuthBase, $tmpFilter, \@attributes);
1038
    if (!$foundTmp) {
1039
        my $dn = $tmpSearchBase;
1040
        my $additions = [
1041
                    'dc' => 'tmp',
1042
                    'o'  => 'tmp',
1043
                    'objectclass' => ['top', 'dcObject', 'organization']
1044
                    ];
1045
        createItem($dn, $ldapUsername, $ldapPassword, $additions, $tmp, $allParams);
1046
    } else {
1047
     debug("found the tmp space");
1048
    }
1049 8175 tao
1050 8220 tao
    ################## Search LDAP for matching o or ou under the dc=tmp that already exist. If it doesn't exist, it will be generated
1051 8201 tao
    my $filter = $ldapConfig->{$org}{'filter'};
1052 8220 tao
1053 8176 tao
    debug("search filer " . $filter);
1054
    debug("ldap server ". $ldapurl);
1055
    debug("sesarch base " . $tmpSearchBase);
1056 8180 tao
    print "Content-type: text/html\n\n";
1057 8175 tao
    my @attrs = ['o', 'ou' ];
1058
    my $found = searchDirectory($ldapurl, $tmpSearchBase, $filter, \@attrs);
1059 8220 tao
1060
    my @organizationInfo = split('=', $ldapConfig->{$org}{'org'}); #split 'o=NCEAS' or something like that
1061
    my $organization = $organizationInfo[0]; # This will be 'o' or 'ou'
1062
    my $organizationName = $organizationInfo[1]; # This will be 'NCEAS' or 'Account'
1063 8180 tao
1064 8176 tao
    if(!$found) {
1065 8180 tao
        debug("generate the subtree in the dc=tmp===========================");
1066 8176 tao
        #need to generate the subtree o or ou
1067 8220 tao
        my $additions;
1068 8207 tao
            if($organization eq 'ou') {
1069
                $additions = [
1070
                    $organization   => $organizationName,
1071
                    'objectclass' => ['top', 'organizationalUnit']
1072
                    ];
1073
1074
            } else {
1075
                $additions = [
1076
                    $organization   => $organizationName,
1077
                    'objectclass' => ['top', 'organization']
1078
                    ];
1079
1080
            }
1081 8220 tao
        my $dn=$ldapConfig->{$org}{'org'} . ',' . $tmpSearchBase;
1082
        createItem($dn, $ldapUsername, $ldapPassword, $additions, $tmp, $allParams);
1083 8176 tao
    }
1084 8175 tao
1085 8180 tao
    ################create an account under tmp subtree
1086 8176 tao
1087 8180 tao
    #generate a randomstr for matching the email.
1088
    my $randomStr = getRandomPassword(16);
1089
    # Create a hashed version of the password
1090
    my $shapass = createSeededPassHash($query->param('userPassword'));
1091
    my $additions = [
1092
                'uid'   => $query->param('uid'),
1093
                'cn'   => join(" ", $query->param('givenName'),
1094
                                    $query->param('sn')),
1095
                'sn'   => $query->param('sn'),
1096
                'givenName'   => $query->param('givenName'),
1097
                'mail' => $query->param('mail'),
1098
                'userPassword' => $shapass,
1099
                'employeeNumber' => $randomStr,
1100
                'objectclass' => ['top', 'person', 'organizationalPerson',
1101 8201 tao
                                'inetOrgPerson', 'uidObject' ],
1102
                $organization   => $organizationName
1103 8180 tao
                ];
1104
    if (defined($query->param('telephoneNumber')) &&
1105
                $query->param('telephoneNumber') &&
1106
                ! $query->param('telephoneNumber') =~ /^\s+$/) {
1107
                $$additions[$#$additions + 1] = 'telephoneNumber';
1108
                $$additions[$#$additions + 1] = $query->param('telephoneNumber');
1109
    }
1110
    if (defined($query->param('title')) &&
1111
                $query->param('title') &&
1112
                ! $query->param('title') =~ /^\s+$/) {
1113
                $$additions[$#$additions + 1] = 'title';
1114
                $$additions[$#$additions + 1] = $query->param('title');
1115
    }
1116 8201 tao
1117
1118
    #$$additions[$#$additions + 1] = 'o';
1119
    #$$additions[$#$additions + 1] = $org;
1120
    my $dn='uid=' . $query->param('uid') . ',' . $ldapConfig->{$org}{'org'} . ',' . $tmpSearchBase;
1121 8220 tao
    createItem($dn, $ldapUsername, $ldapPassword, $additions, $tmp, $allParams);
1122 8176 tao
1123 8180 tao
1124
    ####################send the verification email to the user
1125 8253 leinfelder
    my $link = '/' . $context . '/cgi-bin/ldapweb.cgi?cfg=' . $skinName . '&' . 'stage=' . $emailVerification . '&' . 'dn=' . $dn . '&' . 'hash=' . $randomStr . '&o=' . $org . '&uid=' . $query->param('uid'); #even though we use o=something. The emailVerification will figure the real o= or ou=something.
1126 8180 tao
1127 8253 leinfelder
    my $overrideURL;
1128
    $overrideURL = $skinProperties->getProperty("email.overrideURL");
1129
    debug("the overrideURL is " . $overrideURL);
1130
    if (defined($overrideURL) && !($overrideURL eq '')) {
1131
    	$link = $serverUrl . $overrideURL . $link;
1132
    } else {
1133
    	$link = $serverUrl . $link;
1134
    }
1135
1136 8181 tao
    my $mailhost = $properties->getProperty('email.mailhost');
1137 8197 tao
    my $sender;
1138
    $sender = $skinProperties->getProperty("email.sender") or $sender = $properties->getProperty('email.sender');
1139
    debug("the sender is " . $sender);
1140 8181 tao
    my $recipient = $query->param('mail');
1141
    # Send the email message to them
1142 8191 tao
    my $smtp = Net::SMTP->new($mailhost) or do {
1143
                                                  fullTemplate( ['registerFailed'], {errorMessage => "The temporary account " . $dn . " was created successfully. However, the vertification email can't be sent to you because the email server has some issues. Please contact " .
1144
                                                  $skinProperties->getProperty("email.recipient") . "." });
1145
                                                  exit(0);
1146
                                               };
1147 8181 tao
    $smtp->mail($sender);
1148
    $smtp->to($recipient);
1149
1150
    my $message = <<"     ENDOFMESSAGE";
1151
    To: $recipient
1152
    From: $sender
1153 8239 leinfelder
    Subject: New Account Activation
1154 8181 tao
1155 8254 leinfelder
    Somebody (hopefully you) registered an account on $contextUrl.
1156 8181 tao
    Please click the following link to activate your account.
1157
    If the link doesn't work, please copy the link to your browser:
1158
1159
    $link
1160
1161
    Thanks,
1162 8234 tao
        $sender
1163 8181 tao
1164
     ENDOFMESSAGE
1165
     $message =~ s/^[ \t\r\f]+//gm;
1166
1167
     $smtp->data($message);
1168
     $smtp->quit;
1169 8182 tao
    debug("the link is " . $link);
1170 8181 tao
    fullTemplate( ['success'] );
1171
1172 8175 tao
}
1173
1174
#
1175 8220 tao
# Bind to LDAP and create a new item (a user or subtree) using the information provided
1176 2341 sgarg
# by the user
1177
#
1178 8220 tao
sub createItem {
1179 8180 tao
    my $dn = shift;
1180
    my $ldapUsername = shift;
1181
    my $ldapPassword = shift;
1182
    my $additions = shift;
1183
    my $temp = shift; #if it is for a temporary account.
1184
    my $allParams = shift;
1185
1186
    my @failureTemplate;
1187
    if($temp){
1188
        @failureTemplate = ['registerFailed', 'register'];
1189
    } else {
1190
        @failureTemplate = ['registerFailed'];
1191
    }
1192
    print "Content-type: text/html\n\n";
1193
    debug("the dn is " . $dn);
1194
    debug("LDAP connection to $ldapurl...");
1195
    #if main ldap server is down, a html file containing warning message will be returned
1196
    my $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
1197
    if ($ldap) {
1198
            $ldap->start_tls( verify => 'none');
1199
            debug("Attempting to bind to LDAP server with dn = $ldapUsername, pwd = $ldapPassword");
1200 8185 tao
            $ldap->bind( version => 3, dn => $ldapUsername, password => $ldapPassword );
1201 8180 tao
            my $result = $ldap->add ( 'dn' => $dn, 'attr' => [@$additions ]);
1202
            if ($result->code()) {
1203
                fullTemplate(@failureTemplate, { stage => "register",
1204
                                                            allParams => $allParams,
1205
                                                            errorMessage => $result->error });
1206 8220 tao
                exist(0);
1207 8180 tao
                # TODO SCW was included as separate errors, test this
1208
                #$templateVars    = setVars({ stage => "register",
1209
                #                     allParams => $allParams });
1210
                #$template->process( $templates->{'register'}, $templateVars);
1211
            } else {
1212 8181 tao
                #fullTemplate( ['success'] );
1213 8180 tao
            }
1214
            $ldap->unbind;   # take down session
1215
1216
    } else {
1217
         fullTemplate(@failureTemplate, { stage => "register",
1218
                                                            allParams => $allParams,
1219
                                                            errorMessage => "The ldap server is not available now. Please try it later"});
1220
         exit(0);
1221
    }
1222
1223
}
1224
1225 2341 sgarg
1226
1227
1228
1229
1230 8185 tao
#
1231
# This subroutine will handle a email verification:
1232
# If the hash string matches the one store in the ldap, the account will be
1233
# copied from the temporary space to the permanent tree and the account in
1234
# the temporary space will be removed.
1235
sub handleEmailVerification {
1236
1237
    my $cfg = $query->param('cfg');
1238
    my $dn = $query->param('dn');
1239
    my $hash = $query->param('hash');
1240
    my $org = $query->param('o');
1241
    my $uid = $query->param('uid');
1242
1243
    my $ldapUsername;
1244
    my $ldapPassword;
1245 8211 tao
    #my $orgAuthBase;
1246
1247
    $ldapUsername = $ldapConfig->{$org}{'user'};
1248
    $ldapPassword = $ldapConfig->{$org}{'password'};
1249
    #$orgAuthBase = $ldapConfig->{$org}{'base'};
1250
1251 8185 tao
    debug("LDAP connection to $ldapurl...");
1252
1253
1254
   print "Content-type: text/html\n\n";
1255
   #if main ldap server is down, a html file containing warning message will be returned
1256
   my $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
1257
   if ($ldap) {
1258
        $ldap->start_tls( verify => 'none');
1259
        $ldap->bind( version => 3, dn => $ldapUsername, password => $ldapPassword );
1260 8211 tao
        my $mesg = $ldap->search(base => $dn, scope => 'base', filter => '(objectClass=*)'); #This dn is with the dc=tmp. So it will find out the temporary account registered in registration step.
1261 8185 tao
        my $max = $mesg->count;
1262
        debug("the count is " . $max);
1263
        if($max < 1) {
1264
            $ldap->unbind;   # take down session
1265 8216 tao
            fullTemplate( ['verificationFailed'], {errorMessage => "No record matched the dn " . $dn . " for the activation. You probably already activated the account."});
1266 8185 tao
            #handleLDAPBindFailure($ldapurl);
1267
            exit(0);
1268
        } else {
1269
            #check if the hash string match
1270
            my $entry = $mesg->entry (0);
1271
            my $hashStrFromLdap = $entry->get_value('employeeNumber');
1272
            if( $hashStrFromLdap eq $hash) {
1273
                #my $additions = [ ];
1274
                #foreach my $attr ( $entry->attributes ) {
1275
                    #if($attr ne 'employeeNumber') {
1276
                        #$$additions[$#$additions + 1] = $attr;
1277
                        #$$additions[$#$additions + 1] = $entry->get_value( $attr );
1278
                    #}
1279
                #}
1280 8211 tao
1281
1282
                my $orgDn = $ldapConfig->{$org}{'dn'}; #the DN for the organization.
1283 8185 tao
                $mesg = $ldap->moddn(
1284
                            dn => $dn,
1285
                            deleteoldrdn => 1,
1286
                            newrdn => "uid=" . $uid,
1287 8211 tao
                            newsuperior  =>  $orgDn);
1288 8185 tao
                $ldap->unbind;   # take down session
1289 8186 tao
                if($mesg->code()) {
1290 8216 tao
                    fullTemplate( ['verificationFailed'], {errorMessage => "Cannot move the account from the inactive area to the ative area since " . $mesg->error()});
1291 8185 tao
                    exit(0);
1292
                } else {
1293 8216 tao
                    fullTemplate( ['verificationSuccess'] );
1294 8185 tao
                }
1295
                #createAccount2($dn, $ldapUsername, $ldapPassword, $additions, $tmp, $allParams);
1296
            } else {
1297
                $ldap->unbind;   # take down session
1298 8216 tao
                fullTemplate( ['verificationFailed'], {errorMessage => "The hash string " . $hash . " from your link doesn't match our record."});
1299 8185 tao
                exit(0);
1300
            }
1301
1302
        }
1303
    } else {
1304
        handleLDAPBindFailure($ldapurl);
1305
        exit(0);
1306
    }
1307
1308
}
1309
1310 2341 sgarg
sub handleResponseMessage {
1311
1312
  print "Content-type: text/html\n\n";
1313
  my $errorMessage = "You provided invalid input to the script. " .
1314
                     "Try again please.";
1315 4080 daigle
  fullTemplate( [], { stage => $templates->{'stage'},
1316
                      errorMessage => $errorMessage });
1317
  exit();
1318 2341 sgarg
}
1319
1320
#
1321
# perform a simple search against the LDAP database using
1322
# a small subset of attributes of each dn and return it
1323
# as a table to the calling browser.
1324
#
1325
sub handleSimpleSearch {
1326
1327
    my $o = $query->param('o');
1328
1329 4080 daigle
    my $ldapurl = $ldapConfig->{$o}{'url'};
1330
    my $searchBase = $ldapConfig->{$o}{'base'};
1331 2341 sgarg
1332
    print "Content-type: text/html\n\n";
1333
1334
    my $allParams = {
1335
                      'cn' => $query->param('cn'),
1336
                      'sn' => $query->param('sn'),
1337
                      'gn' => $query->param('gn'),
1338
                      'o'  => $query->param('o'),
1339
                      'facsimiletelephonenumber'
1340
                      => $query->param('facsimiletelephonenumber'),
1341
                      'mail' => $query->param('cmail'),
1342
                      'telephonenumber' => $query->param('telephonenumber'),
1343
                      'title' => $query->param('title'),
1344
                      'uid' => $query->param('uid'),
1345
                      'ou' => $query->param('ou'),
1346
                    };
1347
1348
    # Search LDAP for matching entries that already exist
1349
    my $filter = "(" .
1350
                 $query->param('searchField') . "=" .
1351
                 "*" .
1352
                 $query->param('searchValue') .
1353
                 "*" .
1354
                 ")";
1355
1356
    my @attrs = [ 'sn',
1357
                  'gn',
1358
                  'cn',
1359
                  'o',
1360
                  'facsimiletelephonenumber',
1361
                  'mail',
1362
                  'telephoneNumber',
1363
                  'title',
1364
                  'uid',
1365
                  'labeledURI',
1366
                  'ou' ];
1367
1368
    my $found = searchDirectory($ldapurl, $searchBase, $filter, \@attrs);
1369
1370
    # Send back the search results
1371
    if ($found) {
1372 4080 daigle
      fullTemplate( ('searchResults'), { stage => "searchresults",
1373
                                         allParams => $allParams,
1374
                                         foundAccounts => $found });
1375 2341 sgarg
    } else {
1376
      $found = "No entries matched your criteria.  Please try again\n";
1377
1378 4080 daigle
      fullTemplate( ('searchResults'), { stage => "searchresults",
1379
                                         allParams => $allParams,
1380
                                         foundAccounts => $found });
1381 2341 sgarg
    }
1382
1383
    exit();
1384
}
1385
1386
#
1387
# search the LDAP directory to see if a similar account already exists
1388
#
1389
sub searchDirectory {
1390
    my $ldapurl = shift;
1391
    my $base = shift;
1392
    my $filter = shift;
1393
    my $attref = shift;
1394
1395 4849 daigle
	my $mesg;
1396 2341 sgarg
    my $foundAccounts = 0;
1397 3177 tao
1398
    #if ldap server is down, a html file containing warning message will be returned
1399 4771 walbridge
    my $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
1400 3177 tao
1401 4849 daigle
    if ($ldap) {
1402
    	$ldap->start_tls( verify => 'none');
1403
    	$ldap->bind( version => 3, anonymous => 1);
1404
    	my $mesg = $ldap->search (
1405
        	base   => $base,
1406
        	filter => $filter,
1407
        	attrs => @$attref,
1408
    	);
1409 2341 sgarg
1410 4849 daigle
    	if ($mesg->count() > 0) {
1411
        	$foundAccounts = "";
1412
        	my $entry;
1413
        	foreach $entry ($mesg->sorted(['sn'])) {
1414
          		$foundAccounts .= "<tr>\n<td class=\"main\">\n";
1415
          		$foundAccounts .= "<a href=\"" unless
1416 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1417 4849 daigle
         		 $foundAccounts .= $entry->get_value('labeledURI') unless
1418 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1419 4849 daigle
          		$foundAccounts .= "\">\n" unless
1420 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1421 4849 daigle
          		$foundAccounts .= $entry->get_value('givenName');
1422
          		$foundAccounts .= "</a>\n" unless
1423 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1424 4849 daigle
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1425
          		$foundAccounts .= "<a href=\"" unless
1426 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1427 4849 daigle
          		$foundAccounts .= $entry->get_value('labeledURI') unless
1428 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1429 4849 daigle
          		$foundAccounts .= "\">\n" unless
1430 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1431 4849 daigle
          		$foundAccounts .= $entry->get_value('sn');
1432
          		$foundAccounts .= "</a>\n";
1433
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1434
          		$foundAccounts .= $entry->get_value('mail');
1435
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1436
          		$foundAccounts .= $entry->get_value('telephonenumber');
1437
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1438
          		$foundAccounts .= $entry->get_value('title');
1439
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1440
          		$foundAccounts .= $entry->get_value('ou');
1441
          		$foundAccounts .= "\n</td>\n";
1442
          		$foundAccounts .= "</tr>\n";
1443
        	}
1444
    	}
1445
    	$ldap->unbind;   # take down session
1446 2341 sgarg
    }
1447
    return $foundAccounts;
1448
}
1449
1450
sub debug {
1451
    my $msg = shift;
1452
1453
    if ($debug) {
1454 4747 walbridge
        print STDERR "LDAPweb: $msg\n";
1455 2341 sgarg
    }
1456
}
1457 3175 tao
1458 4771 walbridge
sub handleLDAPBindFailure {
1459
    my $ldapAttemptUrl = shift;
1460
    my $primaryLdap =  $properties->getProperty('auth.url');
1461
1462
    if ($ldapAttemptUrl eq  $primaryLdap) {
1463
        handleGeneralServerFailure("The main LDAP server $ldapurl is down!");
1464
    } else {
1465
        debug("attempted to bind to nonresponsive LDAP server $ldapAttemptUrl, skipped.");
1466
    }
1467
}
1468
1469 3177 tao
sub handleGeneralServerFailure {
1470
    my $errorMessage = shift;
1471 4728 walbridge
    fullTemplate( ['mainServerFailure'], { errorMessage => $errorMessage });
1472 3175 tao
    exit(0);
1473
   }
1474
1475 4080 daigle
sub setVars {
1476
    my $paramVars = shift;
1477
    # initialize default parameters
1478
    my $templateVars = { cfg => $cfg,
1479 4394 walbridge
                         styleSkinsPath => $contextUrl . "/style/skins",
1480
                         styleCommonPath => $contextUrl . "/style/common",
1481
                         contextUrl => $contextUrl,
1482 4770 daigle
                         cgiPrefix => $cgiPrefix,
1483 8206 tao
                         orgList => \@validDisplayOrgList,
1484 4394 walbridge
                         config  => $config,
1485 4080 daigle
    };
1486
1487
    # append customized params
1488
    while (my ($k, $v) = each (%$paramVars)) {
1489
        $templateVars->{$k} = $v;
1490
    }
1491
1492
    return $templateVars;
1493
}