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
    if($found) {
380
        $accountInfo = $found;
381
    } else {
382
        my $link = $contextUrl. '/cgi-bin/ldapweb.cgi?cfg=' . $skinName;
383 8234 tao
        $accountInfo = "There are no accounts associated with the email " . $mail . ".\n" .
384 8221 tao
                       "You may create a new one by the following link: \n" . $link
385
    }
386
387
388
389
    my $mailhost = $properties->getProperty('email.mailhost');
390
    my $sender;
391
    $sender = $skinProperties->getProperty("email.sender") or $sender = $properties->getProperty('email.sender');
392
    debug("the sender is " . $sender);
393
    my $recipient = $query->param('mail');
394
    # Send the email message to them
395
    my $smtp = Net::SMTP->new($mailhost) or do {
396 8229 tao
                                                  fullTemplate( ['lookupName'], {allParams => $allParams,
397
                                                                errorMessage => "Our mail server currently is experiencing some difficulties. Please contact " .
398
                                                                $skinProperties->getProperty("email.recipient") . "." });
399 8221 tao
                                                  exit(0);
400
                                               };
401
    $smtp->mail($sender);
402
    $smtp->to($recipient);
403
404
    my $message = <<"     ENDOFMESSAGE";
405
    To: $recipient
406
    From: $sender
407 8234 tao
    Subject: Your Account Information
408 8221 tao
409 8234 tao
    Somebody (hopefully you) looked up the account information associated with the email address.
410
    Here is the account information:
411 8221 tao
412
    $accountInfo
413
414
    Thanks,
415 8234 tao
        $sender
416 8221 tao
417
     ENDOFMESSAGE
418
     $message =~ s/^[ \t\r\f]+//gm;
419
420
     $smtp->data($message);
421
     $smtp->quit;
422
     fullTemplate( ['lookupNameSuccess'] );
423
424
}
425
426
427
#
428 2341 sgarg
# create the initial registration form
429
#
430
sub handleInitRegister {
431
  my $vars = shift;
432
  print "Content-type: text/html\n\n";
433
  # process the template files:
434 4080 daigle
  fullTemplate(['register'], {stage => "register"});
435 2341 sgarg
  exit();
436
}
437
438 8221 tao
439
440 2341 sgarg
#
441
# process input from the register stage, which occurs when
442
# a user submits form data to create a new account
443
#
444
sub handleRegister {
445
446
    print "Content-type: text/html\n\n";
447 8220 tao
    if ($query->param('o') =~ "LTER") {
448
      fullTemplate( ['registerLter'] );
449
      exit(0);
450
    }
451 8166 tao
452 2341 sgarg
    my $allParams = { 'givenName' => $query->param('givenName'),
453
                      'sn' => $query->param('sn'),
454
                      'o' => $query->param('o'),
455
                      'mail' => $query->param('mail'),
456
                      'uid' => $query->param('uid'),
457
                      'userPassword' => $query->param('userPassword'),
458
                      'userPassword2' => $query->param('userPassword2'),
459
                      'title' => $query->param('title'),
460
                      'telephoneNumber' => $query->param('telephoneNumber') };
461 8166 tao
462
    # Check the recaptcha
463
    my $c = Captcha::reCAPTCHA->new;
464
    my $challenge = $query->param('recaptcha_challenge_field');
465
    my $response = $query->param('recaptcha_response_field');
466
    # Verify submission
467
    my $result = $c->check_answer(
468 8169 tao
        $recaptchaPrivateKey, $ENV{'REMOTE_ADDR'},
469 8166 tao
        $challenge, $response
470
    );
471
472
    if ( $result->{is_valid} ) {
473
        #print "Yes!";
474
        #exit();
475
    }
476
    else {
477
        my $errorMessage = "The verification code is wrong. Please input again.";
478
        fullTemplate(['register'], { stage => "register",
479
                                     allParams => $allParams,
480
                                     errorMessage => $errorMessage });
481
        exit();
482
    }
483
484
485 2341 sgarg
    # Check that all required fields are provided and not null
486
    my @requiredParams = ( 'givenName', 'sn', 'o', 'mail',
487
                           'uid', 'userPassword', 'userPassword2');
488
    if (! paramsAreValid(@requiredParams)) {
489
        my $errorMessage = "Required information is missing. " .
490
            "Please fill in all required fields and resubmit the form.";
491 4080 daigle
        fullTemplate(['register'], { stage => "register",
492
                                     allParams => $allParams,
493
                                     errorMessage => $errorMessage });
494
        exit();
495 2341 sgarg
    } else {
496 8186 tao
         if ($query->param('userPassword') ne $query->param('userPassword2')) {
497
            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
    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 4771 walbridge
        my $mailhost = $properties->getProperty('email.mailhost');
878 8197 tao
        my $sender;
879
        $sender = $skinProperties->getProperty("email.sender") or $sender = $properties->getProperty('email.sender');
880 2341 sgarg
        # Send the email message to them
881
        my $smtp = Net::SMTP->new($mailhost);
882
        $smtp->mail($sender);
883
        $smtp->to($recipient);
884
885
        my $message = <<"        ENDOFMESSAGE";
886
        To: $recipient
887
        From: $sender
888 8234 tao
        Subject: Your Account Password Reset
889 2341 sgarg
890 8234 tao
        Somebody (hopefully you) requested that your account password be reset.
891 2341 sgarg
        This is generally done when somebody forgets their password.  Your
892
        password can be changed by visiting the following URL:
893
894 4864 walbridge
        $contextUrl/cgi-bin/ldapweb.cgi?stage=changepass&cfg=$cfg
895 2341 sgarg
896
            Username: $username
897
        Organization: $org
898
        New Password: $newPass
899
900
        Thanks,
901 8234 tao
            $sender
902 2341 sgarg
903
        ENDOFMESSAGE
904
        $message =~ s/^[ \t\r\f]+//gm;
905
906
        $smtp->data($message);
907
        $smtp->quit;
908
    } else {
909
        $errorMessage = "Failed to send password because I " .
910
                        "couldn't find a valid email address.";
911
    }
912
    return $errorMessage;
913
}
914
915
#
916
# search the LDAP directory to see if a similar account already exists
917
#
918
sub findExistingAccounts {
919
    my $ldapurl = shift;
920
    my $base = shift;
921
    my $filter = shift;
922
    my $attref = shift;
923 8221 tao
    my $notHtmlFormat = shift;
924 3175 tao
    my $ldap;
925 4847 daigle
    my $mesg;
926 2341 sgarg
927
    my $foundAccounts = 0;
928 4749 walbridge
929 4394 walbridge
    #if main ldap server is down, a html file containing warning message will be returned
930 4868 walbridge
    debug("findExistingAccounts: connecting to $ldapurl, $timeout");
931 4771 walbridge
    $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
932 4845 daigle
    if ($ldap) {
933
    	$ldap->start_tls( verify => 'none');
934
    	$ldap->bind( version => 3, anonymous => 1);
935 4848 daigle
		$mesg = $ldap->search (
936 4845 daigle
			base   => $base,
937
			filter => $filter,
938
			attrs => @$attref,
939
		);
940 2341 sgarg
941 4845 daigle
	    if ($mesg->count() > 0) {
942
			$foundAccounts = "";
943
			my $entry;
944
			foreach $entry ($mesg->all_entries) {
945 5650 walbridge
                # a fix to ignore 'ou=Account' properties which are not usable accounts within Metacat.
946
                # this could be done directly with filters on the LDAP connection, instead.
947 8217 tao
                #if ($entry->dn !~ /ou=Account/) {
948 8221 tao
                    if($notHtmlFormat) {
949
                        $foundAccounts .= "\nAccount: ";
950
                    } else {
951
                        $foundAccounts .= "<p>\n<b><u>Account:</u> ";
952
                    }
953 5650 walbridge
                    $foundAccounts .= $entry->dn();
954 8221 tao
                    if($notHtmlFormat) {
955
                        $foundAccounts .= "\n";
956
                    } else {
957
                        $foundAccounts .= "</b><br />\n";
958
                    }
959 5650 walbridge
                    foreach my $attribute ($entry->attributes()) {
960
                        my $value = $entry->get_value($attribute);
961
                        $foundAccounts .= "$attribute: ";
962
                        $foundAccounts .= $value;
963 8221 tao
                         if($notHtmlFormat) {
964
                            $foundAccounts .= "\n";
965
                        } else {
966
                            $foundAccounts .= "<br />\n";
967
                        }
968 5650 walbridge
                    }
969 8221 tao
                    if($notHtmlFormat) {
970
                        $foundAccounts .= "\n";
971
                    } else {
972
                        $foundAccounts .= "</p>\n";
973
                    }
974
975 8217 tao
                #}
976 4845 daigle
			}
977 2341 sgarg
        }
978 4845 daigle
    	$ldap->unbind;   # take down session
979 2341 sgarg
980 4848 daigle
    	# Follow references
981
    	my @references = $mesg->references();
982
    	for (my $i = 0; $i <= $#references; $i++) {
983
        	my $uri = URI->new($references[$i]);
984
        	my $host = $uri->host();
985
        	my $path = $uri->path();
986
        	$path =~ s/^\///;
987
        	my $refFound = &findExistingAccounts($host, $path, $filter, $attref);
988
        	if ($refFound) {
989
            	$foundAccounts .= $refFound;
990
        	}
991
    	}
992 2341 sgarg
    }
993
994
    #print "<p>Checking referrals...</p>\n";
995
    #my @referrals = $mesg->referrals();
996
    #print "<p>Referrals count: ", scalar(@referrals), "</p>\n";
997
    #for (my $i = 0; $i <= $#referrals; $i++) {
998
        #print "<p>Referral: ", $referrals[$i], "</p>\n";
999
    #}
1000
1001
    return $foundAccounts;
1002
}
1003
1004
#
1005
# Validate that we have the proper set of input parameters
1006
#
1007
sub paramsAreValid {
1008
    my @pnames = @_;
1009
1010
    my $allValid = 1;
1011
    foreach my $parameter (@pnames) {
1012
        if (!defined($query->param($parameter)) ||
1013
            ! $query->param($parameter) ||
1014
            $query->param($parameter) =~ /^\s+$/) {
1015
            $allValid = 0;
1016
        }
1017
    }
1018
1019
    return $allValid;
1020
}
1021
1022
#
1023 8175 tao
# Create a temporary account for a user and send an email with a link which can click for the
1024
# verification. This is used to protect the ldap server against spams.
1025
#
1026
sub createTemporaryAccount {
1027
    my $allParams = shift;
1028 8180 tao
    my $org = $query->param('o');
1029 8220 tao
    my $ldapUsername = $ldapConfig->{$org}{'user'};
1030
    my $ldapPassword = $ldapConfig->{$org}{'password'};
1031
    my $tmp = 1;
1032 8185 tao
1033 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
1034
    my $orgAuthBase = $ldapConfig->{$org}{'base'};
1035
    my $tmpSearchBase = 'dc=tmp,' . $orgAuthBase;
1036
    my $tmpFilter = "dc=tmp";
1037
    my @attributes=['dc'];
1038
    my $foundTmp = searchDirectory($ldapurl, $orgAuthBase, $tmpFilter, \@attributes);
1039
    if (!$foundTmp) {
1040
        my $dn = $tmpSearchBase;
1041
        my $additions = [
1042
                    'dc' => 'tmp',
1043
                    'o'  => 'tmp',
1044
                    'objectclass' => ['top', 'dcObject', 'organization']
1045
                    ];
1046
        createItem($dn, $ldapUsername, $ldapPassword, $additions, $tmp, $allParams);
1047
    } else {
1048
     debug("found the tmp space");
1049
    }
1050 8175 tao
1051 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
1052 8201 tao
    my $filter = $ldapConfig->{$org}{'filter'};
1053 8220 tao
1054 8176 tao
    debug("search filer " . $filter);
1055
    debug("ldap server ". $ldapurl);
1056
    debug("sesarch base " . $tmpSearchBase);
1057 8180 tao
    print "Content-type: text/html\n\n";
1058 8175 tao
    my @attrs = ['o', 'ou' ];
1059
    my $found = searchDirectory($ldapurl, $tmpSearchBase, $filter, \@attrs);
1060 8220 tao
1061
    my @organizationInfo = split('=', $ldapConfig->{$org}{'org'}); #split 'o=NCEAS' or something like that
1062
    my $organization = $organizationInfo[0]; # This will be 'o' or 'ou'
1063
    my $organizationName = $organizationInfo[1]; # This will be 'NCEAS' or 'Account'
1064 8180 tao
1065 8176 tao
    if(!$found) {
1066 8180 tao
        debug("generate the subtree in the dc=tmp===========================");
1067 8176 tao
        #need to generate the subtree o or ou
1068 8220 tao
        my $additions;
1069 8207 tao
            if($organization eq 'ou') {
1070
                $additions = [
1071
                    $organization   => $organizationName,
1072
                    'objectclass' => ['top', 'organizationalUnit']
1073
                    ];
1074
1075
            } else {
1076
                $additions = [
1077
                    $organization   => $organizationName,
1078
                    'objectclass' => ['top', 'organization']
1079
                    ];
1080
1081
            }
1082 8220 tao
        my $dn=$ldapConfig->{$org}{'org'} . ',' . $tmpSearchBase;
1083
        createItem($dn, $ldapUsername, $ldapPassword, $additions, $tmp, $allParams);
1084 8176 tao
    }
1085 8175 tao
1086 8180 tao
    ################create an account under tmp subtree
1087 8176 tao
1088 8180 tao
    #generate a randomstr for matching the email.
1089
    my $randomStr = getRandomPassword(16);
1090
    # Create a hashed version of the password
1091
    my $shapass = createSeededPassHash($query->param('userPassword'));
1092
    my $additions = [
1093
                'uid'   => $query->param('uid'),
1094
                'cn'   => join(" ", $query->param('givenName'),
1095
                                    $query->param('sn')),
1096
                'sn'   => $query->param('sn'),
1097
                'givenName'   => $query->param('givenName'),
1098
                'mail' => $query->param('mail'),
1099
                'userPassword' => $shapass,
1100
                'employeeNumber' => $randomStr,
1101
                'objectclass' => ['top', 'person', 'organizationalPerson',
1102 8201 tao
                                'inetOrgPerson', 'uidObject' ],
1103
                $organization   => $organizationName
1104 8180 tao
                ];
1105
    if (defined($query->param('telephoneNumber')) &&
1106
                $query->param('telephoneNumber') &&
1107
                ! $query->param('telephoneNumber') =~ /^\s+$/) {
1108
                $$additions[$#$additions + 1] = 'telephoneNumber';
1109
                $$additions[$#$additions + 1] = $query->param('telephoneNumber');
1110
    }
1111
    if (defined($query->param('title')) &&
1112
                $query->param('title') &&
1113
                ! $query->param('title') =~ /^\s+$/) {
1114
                $$additions[$#$additions + 1] = 'title';
1115
                $$additions[$#$additions + 1] = $query->param('title');
1116
    }
1117 8201 tao
1118
1119
    #$$additions[$#$additions + 1] = 'o';
1120
    #$$additions[$#$additions + 1] = $org;
1121
    my $dn='uid=' . $query->param('uid') . ',' . $ldapConfig->{$org}{'org'} . ',' . $tmpSearchBase;
1122 8220 tao
    createItem($dn, $ldapUsername, $ldapPassword, $additions, $tmp, $allParams);
1123 8176 tao
1124 8180 tao
1125
    ####################send the verification email to the user
1126 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.
1127 8180 tao
1128 8253 leinfelder
    my $overrideURL;
1129
    $overrideURL = $skinProperties->getProperty("email.overrideURL");
1130
    debug("the overrideURL is " . $overrideURL);
1131
    if (defined($overrideURL) && !($overrideURL eq '')) {
1132
    	$link = $serverUrl . $overrideURL . $link;
1133
    } else {
1134
    	$link = $serverUrl . $link;
1135
    }
1136
1137 8181 tao
    my $mailhost = $properties->getProperty('email.mailhost');
1138 8197 tao
    my $sender;
1139
    $sender = $skinProperties->getProperty("email.sender") or $sender = $properties->getProperty('email.sender');
1140
    debug("the sender is " . $sender);
1141 8181 tao
    my $recipient = $query->param('mail');
1142
    # Send the email message to them
1143 8191 tao
    my $smtp = Net::SMTP->new($mailhost) or do {
1144
                                                  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 " .
1145
                                                  $skinProperties->getProperty("email.recipient") . "." });
1146
                                                  exit(0);
1147
                                               };
1148 8181 tao
    $smtp->mail($sender);
1149
    $smtp->to($recipient);
1150
1151
    my $message = <<"     ENDOFMESSAGE";
1152
    To: $recipient
1153
    From: $sender
1154 8239 leinfelder
    Subject: New Account Activation
1155 8181 tao
1156 8248 tao
    Somebody (hopefully you) registered an account on $metacatUrl.
1157 8181 tao
    Please click the following link to activate your account.
1158
    If the link doesn't work, please copy the link to your browser:
1159
1160
    $link
1161
1162
    Thanks,
1163 8234 tao
        $sender
1164 8181 tao
1165
     ENDOFMESSAGE
1166
     $message =~ s/^[ \t\r\f]+//gm;
1167
1168
     $smtp->data($message);
1169
     $smtp->quit;
1170 8182 tao
    debug("the link is " . $link);
1171 8181 tao
    fullTemplate( ['success'] );
1172
1173 8175 tao
}
1174
1175
#
1176 8220 tao
# Bind to LDAP and create a new item (a user or subtree) using the information provided
1177 2341 sgarg
# by the user
1178
#
1179 8220 tao
sub createItem {
1180 8180 tao
    my $dn = shift;
1181
    my $ldapUsername = shift;
1182
    my $ldapPassword = shift;
1183
    my $additions = shift;
1184
    my $temp = shift; #if it is for a temporary account.
1185
    my $allParams = shift;
1186
1187
    my @failureTemplate;
1188
    if($temp){
1189
        @failureTemplate = ['registerFailed', 'register'];
1190
    } else {
1191
        @failureTemplate = ['registerFailed'];
1192
    }
1193
    print "Content-type: text/html\n\n";
1194
    debug("the dn is " . $dn);
1195
    debug("LDAP connection to $ldapurl...");
1196
    #if main ldap server is down, a html file containing warning message will be returned
1197
    my $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
1198
    if ($ldap) {
1199
            $ldap->start_tls( verify => 'none');
1200
            debug("Attempting to bind to LDAP server with dn = $ldapUsername, pwd = $ldapPassword");
1201 8185 tao
            $ldap->bind( version => 3, dn => $ldapUsername, password => $ldapPassword );
1202 8180 tao
            my $result = $ldap->add ( 'dn' => $dn, 'attr' => [@$additions ]);
1203
            if ($result->code()) {
1204
                fullTemplate(@failureTemplate, { stage => "register",
1205
                                                            allParams => $allParams,
1206
                                                            errorMessage => $result->error });
1207 8220 tao
                exist(0);
1208 8180 tao
                # TODO SCW was included as separate errors, test this
1209
                #$templateVars    = setVars({ stage => "register",
1210
                #                     allParams => $allParams });
1211
                #$template->process( $templates->{'register'}, $templateVars);
1212
            } else {
1213 8181 tao
                #fullTemplate( ['success'] );
1214 8180 tao
            }
1215
            $ldap->unbind;   # take down session
1216
1217
    } else {
1218
         fullTemplate(@failureTemplate, { stage => "register",
1219
                                                            allParams => $allParams,
1220
                                                            errorMessage => "The ldap server is not available now. Please try it later"});
1221
         exit(0);
1222
    }
1223
1224
}
1225
1226 2341 sgarg
1227
1228
1229
1230
1231 8185 tao
#
1232
# This subroutine will handle a email verification:
1233
# If the hash string matches the one store in the ldap, the account will be
1234
# copied from the temporary space to the permanent tree and the account in
1235
# the temporary space will be removed.
1236
sub handleEmailVerification {
1237
1238
    my $cfg = $query->param('cfg');
1239
    my $dn = $query->param('dn');
1240
    my $hash = $query->param('hash');
1241
    my $org = $query->param('o');
1242
    my $uid = $query->param('uid');
1243
1244
    my $ldapUsername;
1245
    my $ldapPassword;
1246 8211 tao
    #my $orgAuthBase;
1247
1248
    $ldapUsername = $ldapConfig->{$org}{'user'};
1249
    $ldapPassword = $ldapConfig->{$org}{'password'};
1250
    #$orgAuthBase = $ldapConfig->{$org}{'base'};
1251
1252 8185 tao
    debug("LDAP connection to $ldapurl...");
1253
1254
1255
   print "Content-type: text/html\n\n";
1256
   #if main ldap server is down, a html file containing warning message will be returned
1257
   my $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
1258
   if ($ldap) {
1259
        $ldap->start_tls( verify => 'none');
1260
        $ldap->bind( version => 3, dn => $ldapUsername, password => $ldapPassword );
1261 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.
1262 8185 tao
        my $max = $mesg->count;
1263
        debug("the count is " . $max);
1264
        if($max < 1) {
1265
            $ldap->unbind;   # take down session
1266 8216 tao
            fullTemplate( ['verificationFailed'], {errorMessage => "No record matched the dn " . $dn . " for the activation. You probably already activated the account."});
1267 8185 tao
            #handleLDAPBindFailure($ldapurl);
1268
            exit(0);
1269
        } else {
1270
            #check if the hash string match
1271
            my $entry = $mesg->entry (0);
1272
            my $hashStrFromLdap = $entry->get_value('employeeNumber');
1273
            if( $hashStrFromLdap eq $hash) {
1274
                #my $additions = [ ];
1275
                #foreach my $attr ( $entry->attributes ) {
1276
                    #if($attr ne 'employeeNumber') {
1277
                        #$$additions[$#$additions + 1] = $attr;
1278
                        #$$additions[$#$additions + 1] = $entry->get_value( $attr );
1279
                    #}
1280
                #}
1281 8211 tao
1282
1283
                my $orgDn = $ldapConfig->{$org}{'dn'}; #the DN for the organization.
1284 8185 tao
                $mesg = $ldap->moddn(
1285
                            dn => $dn,
1286
                            deleteoldrdn => 1,
1287
                            newrdn => "uid=" . $uid,
1288 8211 tao
                            newsuperior  =>  $orgDn);
1289 8185 tao
                $ldap->unbind;   # take down session
1290 8186 tao
                if($mesg->code()) {
1291 8216 tao
                    fullTemplate( ['verificationFailed'], {errorMessage => "Cannot move the account from the inactive area to the ative area since " . $mesg->error()});
1292 8185 tao
                    exit(0);
1293
                } else {
1294 8216 tao
                    fullTemplate( ['verificationSuccess'] );
1295 8185 tao
                }
1296
                #createAccount2($dn, $ldapUsername, $ldapPassword, $additions, $tmp, $allParams);
1297
            } else {
1298
                $ldap->unbind;   # take down session
1299 8216 tao
                fullTemplate( ['verificationFailed'], {errorMessage => "The hash string " . $hash . " from your link doesn't match our record."});
1300 8185 tao
                exit(0);
1301
            }
1302
1303
        }
1304
    } else {
1305
        handleLDAPBindFailure($ldapurl);
1306
        exit(0);
1307
    }
1308
1309
}
1310
1311 2341 sgarg
sub handleResponseMessage {
1312
1313
  print "Content-type: text/html\n\n";
1314
  my $errorMessage = "You provided invalid input to the script. " .
1315
                     "Try again please.";
1316 4080 daigle
  fullTemplate( [], { stage => $templates->{'stage'},
1317
                      errorMessage => $errorMessage });
1318
  exit();
1319 2341 sgarg
}
1320
1321
#
1322
# perform a simple search against the LDAP database using
1323
# a small subset of attributes of each dn and return it
1324
# as a table to the calling browser.
1325
#
1326
sub handleSimpleSearch {
1327
1328
    my $o = $query->param('o');
1329
1330 4080 daigle
    my $ldapurl = $ldapConfig->{$o}{'url'};
1331
    my $searchBase = $ldapConfig->{$o}{'base'};
1332 2341 sgarg
1333
    print "Content-type: text/html\n\n";
1334
1335
    my $allParams = {
1336
                      'cn' => $query->param('cn'),
1337
                      'sn' => $query->param('sn'),
1338
                      'gn' => $query->param('gn'),
1339
                      'o'  => $query->param('o'),
1340
                      'facsimiletelephonenumber'
1341
                      => $query->param('facsimiletelephonenumber'),
1342
                      'mail' => $query->param('cmail'),
1343
                      'telephonenumber' => $query->param('telephonenumber'),
1344
                      'title' => $query->param('title'),
1345
                      'uid' => $query->param('uid'),
1346
                      'ou' => $query->param('ou'),
1347
                    };
1348
1349
    # Search LDAP for matching entries that already exist
1350
    my $filter = "(" .
1351
                 $query->param('searchField') . "=" .
1352
                 "*" .
1353
                 $query->param('searchValue') .
1354
                 "*" .
1355
                 ")";
1356
1357
    my @attrs = [ 'sn',
1358
                  'gn',
1359
                  'cn',
1360
                  'o',
1361
                  'facsimiletelephonenumber',
1362
                  'mail',
1363
                  'telephoneNumber',
1364
                  'title',
1365
                  'uid',
1366
                  'labeledURI',
1367
                  'ou' ];
1368
1369
    my $found = searchDirectory($ldapurl, $searchBase, $filter, \@attrs);
1370
1371
    # Send back the search results
1372
    if ($found) {
1373 4080 daigle
      fullTemplate( ('searchResults'), { stage => "searchresults",
1374
                                         allParams => $allParams,
1375
                                         foundAccounts => $found });
1376 2341 sgarg
    } else {
1377
      $found = "No entries matched your criteria.  Please try again\n";
1378
1379 4080 daigle
      fullTemplate( ('searchResults'), { stage => "searchresults",
1380
                                         allParams => $allParams,
1381
                                         foundAccounts => $found });
1382 2341 sgarg
    }
1383
1384
    exit();
1385
}
1386
1387
#
1388
# search the LDAP directory to see if a similar account already exists
1389
#
1390
sub searchDirectory {
1391
    my $ldapurl = shift;
1392
    my $base = shift;
1393
    my $filter = shift;
1394
    my $attref = shift;
1395
1396 4849 daigle
	my $mesg;
1397 2341 sgarg
    my $foundAccounts = 0;
1398 3177 tao
1399
    #if ldap server is down, a html file containing warning message will be returned
1400 4771 walbridge
    my $ldap = Net::LDAP->new($ldapurl, timeout => $timeout) or handleLDAPBindFailure($ldapurl);
1401 3177 tao
1402 4849 daigle
    if ($ldap) {
1403
    	$ldap->start_tls( verify => 'none');
1404
    	$ldap->bind( version => 3, anonymous => 1);
1405
    	my $mesg = $ldap->search (
1406
        	base   => $base,
1407
        	filter => $filter,
1408
        	attrs => @$attref,
1409
    	);
1410 2341 sgarg
1411 4849 daigle
    	if ($mesg->count() > 0) {
1412
        	$foundAccounts = "";
1413
        	my $entry;
1414
        	foreach $entry ($mesg->sorted(['sn'])) {
1415
          		$foundAccounts .= "<tr>\n<td class=\"main\">\n";
1416
          		$foundAccounts .= "<a href=\"" unless
1417 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1418 4849 daigle
         		 $foundAccounts .= $entry->get_value('labeledURI') unless
1419 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1420 4849 daigle
          		$foundAccounts .= "\">\n" unless
1421 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1422 4849 daigle
          		$foundAccounts .= $entry->get_value('givenName');
1423
          		$foundAccounts .= "</a>\n" unless
1424 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1425 4849 daigle
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1426
          		$foundAccounts .= "<a href=\"" unless
1427 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1428 4849 daigle
          		$foundAccounts .= $entry->get_value('labeledURI') unless
1429 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1430 4849 daigle
          		$foundAccounts .= "\">\n" unless
1431 2341 sgarg
                    (!$entry->get_value('labeledURI'));
1432 4849 daigle
          		$foundAccounts .= $entry->get_value('sn');
1433
          		$foundAccounts .= "</a>\n";
1434
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1435
          		$foundAccounts .= $entry->get_value('mail');
1436
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1437
          		$foundAccounts .= $entry->get_value('telephonenumber');
1438
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1439
          		$foundAccounts .= $entry->get_value('title');
1440
          		$foundAccounts .= "\n</td>\n<td class=\"main\">\n";
1441
          		$foundAccounts .= $entry->get_value('ou');
1442
          		$foundAccounts .= "\n</td>\n";
1443
          		$foundAccounts .= "</tr>\n";
1444
        	}
1445
    	}
1446
    	$ldap->unbind;   # take down session
1447 2341 sgarg
    }
1448
    return $foundAccounts;
1449
}
1450
1451
sub debug {
1452
    my $msg = shift;
1453
1454
    if ($debug) {
1455 4747 walbridge
        print STDERR "LDAPweb: $msg\n";
1456 2341 sgarg
    }
1457
}
1458 3175 tao
1459 4771 walbridge
sub handleLDAPBindFailure {
1460
    my $ldapAttemptUrl = shift;
1461
    my $primaryLdap =  $properties->getProperty('auth.url');
1462
1463
    if ($ldapAttemptUrl eq  $primaryLdap) {
1464
        handleGeneralServerFailure("The main LDAP server $ldapurl is down!");
1465
    } else {
1466
        debug("attempted to bind to nonresponsive LDAP server $ldapAttemptUrl, skipped.");
1467
    }
1468
}
1469
1470 3177 tao
sub handleGeneralServerFailure {
1471
    my $errorMessage = shift;
1472 4728 walbridge
    fullTemplate( ['mainServerFailure'], { errorMessage => $errorMessage });
1473 3175 tao
    exit(0);
1474
   }
1475
1476 4080 daigle
sub setVars {
1477
    my $paramVars = shift;
1478
    # initialize default parameters
1479
    my $templateVars = { cfg => $cfg,
1480 4394 walbridge
                         styleSkinsPath => $contextUrl . "/style/skins",
1481
                         styleCommonPath => $contextUrl . "/style/common",
1482
                         contextUrl => $contextUrl,
1483 4770 daigle
                         cgiPrefix => $cgiPrefix,
1484 8206 tao
                         orgList => \@validDisplayOrgList,
1485 4394 walbridge
                         config  => $config,
1486 4080 daigle
    };
1487
1488
    # append customized params
1489
    while (my ($k, $v) = each (%$paramVars)) {
1490
        $templateVars->{$k} = $v;
1491
    }
1492
1493
    return $templateVars;
1494
}