1: #!/usr/bin/perl
2: # The LearningOnline Network
3: # lond "LON Daemon" Server (port "LOND" 5663)
4: #
5: # $Id: lond,v 1.232 2004/08/18 11:31:50 foxr Exp $
6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
13: # the Free Software Foundation; either version 2 of the License, or
14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
27:
28:
29: # http://www.lon-capa.org/
30: #
31:
32: use strict;
33: use lib '/home/httpd/lib/perl/';
34: use LONCAPA::Configuration;
35:
36: use IO::Socket;
37: use IO::File;
38: #use Apache::File;
39: use Symbol;
40: use POSIX;
41: use Crypt::IDEA;
42: use LWP::UserAgent();
43: use GDBM_File;
44: use Authen::Krb4;
45: use Authen::Krb5;
46: use lib '/home/httpd/lib/perl/';
47: use localauth;
48: use localenroll;
49: use File::Copy;
50: use LONCAPA::ConfigFileEdit;
51: use LONCAPA::lonlocal;
52: use LONCAPA::lonssl;
53: use Fcntl qw(:flock);
54:
55: my $DEBUG = 1; # Non zero to enable debug log entries.
56:
57: my $status='';
58: my $lastlog='';
59:
60: my $VERSION='$Revision: 1.232 $'; #' stupid emacs
61: my $remoteVERSION;
62: my $currenthostid="default";
63: my $currentdomainid;
64:
65: my $client;
66: my $clientip; # IP address of client.
67: my $clientdns; # DNS name of client.
68: my $clientname; # LonCAPA name of client.
69:
70: my $server;
71: my $thisserver; # DNS of us.
72:
73: my $keymode;
74:
75: my $cipher; # Cipher key negotiated with client
76: my $tmpsnum = 0; # Id of tmpputs.
77:
78: #
79: # Connection type is:
80: # client - All client actions are allowed
81: # manager - only management functions allowed.
82: # both - Both management and client actions are allowed
83: #
84:
85: my $ConnectionType;
86:
87: my %hostid; # ID's for hosts in cluster by ip.
88: my %hostdom; # LonCAPA domain for hosts in cluster.
89: my %hostip; # IPs for hosts in cluster.
90: my %hostdns; # ID's of hosts looked up by DNS name.
91:
92: my %managers; # Ip -> manager names
93:
94: my %perlvar; # Will have the apache conf defined perl vars.
95:
96: #
97: # The hash below is used for command dispatching, and is therefore keyed on the request keyword.
98: # Each element of the hash contains a reference to an array that contains:
99: # A reference to a sub that executes the request corresponding to the keyword.
100: # A flag that is true if the request must be encoded to be acceptable.
101: # A mask with bits as follows:
102: # CLIENT_OK - Set when the function is allowed by ordinary clients
103: # MANAGER_OK - Set when the function is allowed to manager clients.
104: #
105: my $CLIENT_OK = 1;
106: my $MANAGER_OK = 2;
107: my %Dispatcher;
108:
109:
110: #
111: # The array below are password error strings."
112: #
113: my $lastpwderror = 13; # Largest error number from lcpasswd.
114: my @passwderrors = ("ok",
115: "lcpasswd must be run as user 'www'",
116: "lcpasswd got incorrect number of arguments",
117: "lcpasswd did not get the right nubmer of input text lines",
118: "lcpasswd too many simultaneous pwd changes in progress",
119: "lcpasswd User does not exist.",
120: "lcpasswd Incorrect current passwd",
121: "lcpasswd Unable to su to root.",
122: "lcpasswd Cannot set new passwd.",
123: "lcpasswd Username has invalid characters",
124: "lcpasswd Invalid characters in password",
125: "lcpasswd User already exists",
126: "lcpasswd Something went wrong with user addition.",
127: "lcpasswd Password mismatch",
128: "lcpasswd Error filename is invalid");
129:
130:
131: # The array below are lcuseradd error strings.:
132:
133: my $lastadderror = 13;
134: my @adderrors = ("ok",
135: "User ID mismatch, lcuseradd must run as user www",
136: "lcuseradd Incorrect number of command line parameters must be 3",
137: "lcuseradd Incorrect number of stdinput lines, must be 3",
138: "lcuseradd Too many other simultaneous pwd changes in progress",
139: "lcuseradd User does not exist",
140: "lcuseradd Unable to make www member of users's group",
141: "lcuseradd Unable to su to root",
142: "lcuseradd Unable to set password",
143: "lcuseradd Usrname has invalid characters",
144: "lcuseradd Password has an invalid character",
145: "lcuseradd User already exists",
146: "lcuseradd Could not add user.",
147: "lcuseradd Password mismatch");
148:
149:
150:
151: #
152: # Statistics that are maintained and dislayed in the status line.
153: #
154: my $Transactions = 0; # Number of attempted transactions.
155: my $Failures = 0; # Number of transcations failed.
156:
157: # ResetStatistics:
158: # Resets the statistics counters:
159: #
160: sub ResetStatistics {
161: $Transactions = 0;
162: $Failures = 0;
163: }
164:
165: #------------------------------------------------------------------------
166: #
167: # LocalConnection
168: # Completes the formation of a locally authenticated connection.
169: # This function will ensure that the 'remote' client is really the
170: # local host. If not, the connection is closed, and the function fails.
171: # If so, initcmd is parsed for the name of a file containing the
172: # IDEA session key. The fie is opened, read, deleted and the session
173: # key returned to the caller.
174: #
175: # Parameters:
176: # $Socket - Socket open on client.
177: # $initcmd - The full text of the init command.
178: #
179: # Implicit inputs:
180: # $clientdns - The DNS name of the remote client.
181: # $thisserver - Our DNS name.
182: #
183: # Returns:
184: # IDEA session key on success.
185: # undef on failure.
186: #
187: sub LocalConnection {
188: my ($Socket, $initcmd) = @_;
189: Debug("Attempting local connection: $initcmd client: $clientdns me: $thisserver");
190: if($clientdns ne $thisserver) {
191: &logthis('<font color="red"> LocalConnection rejecting non local: '
192: ."$clientdns ne $thisserver </font>");
193: close $Socket;
194: return undef;
195: } else {
196: chomp($initcmd); # Get rid of \n in filename.
197: my ($init, $type, $name) = split(/:/, $initcmd);
198: Debug(" Init command: $init $type $name ");
199:
200: # Require that $init = init, and $type = local: Otherwise
201: # the caller is insane:
202:
203: if(($init ne "init") && ($type ne "local")) {
204: &logthis('<font color = "red"> LocalConnection: caller is insane! '
205: ."init = $init, and type = $type </font>");
206: close($Socket);;
207: return undef;
208:
209: }
210: # Now get the key filename:
211:
212: my $IDEAKey = lonlocal::ReadKeyFile($name);
213: return $IDEAKey;
214: }
215: }
216: #------------------------------------------------------------------------------
217: #
218: # SSLConnection
219: # Completes the formation of an ssh authenticated connection. The
220: # socket is promoted to an ssl socket. If this promotion and the associated
221: # certificate exchange are successful, the IDEA key is generated and sent
222: # to the remote peer via the SSL tunnel. The IDEA key is also returned to
223: # the caller after the SSL tunnel is torn down.
224: #
225: # Parameters:
226: # Name Type Purpose
227: # $Socket IO::Socket::INET Plaintext socket.
228: #
229: # Returns:
230: # IDEA key on success.
231: # undef on failure.
232: #
233: sub SSLConnection {
234: my $Socket = shift;
235:
236: Debug("SSLConnection: ");
237: my $KeyFile = lonssl::KeyFile();
238: if(!$KeyFile) {
239: my $err = lonssl::LastError();
240: &logthis("<font color=\"red\"> CRITICAL"
241: ."Can't get key file $err </font>");
242: return undef;
243: }
244: my ($CACertificate,
245: $Certificate) = lonssl::CertificateFile();
246:
247:
248: # If any of the key, certificate or certificate authority
249: # certificate filenames are not defined, this can't work.
250:
251: if((!$Certificate) || (!$CACertificate)) {
252: my $err = lonssl::LastError();
253: &logthis("<font color=\"red\"> CRITICAL"
254: ."Can't get certificates: $err </font>");
255:
256: return undef;
257: }
258: Debug("Key: $KeyFile CA: $CACertificate Cert: $Certificate");
259:
260: # Indicate to our peer that we can procede with
261: # a transition to ssl authentication:
262:
263: print $Socket "ok:ssl\n";
264:
265: Debug("Approving promotion -> ssl");
266: # And do so:
267:
268: my $SSLSocket = lonssl::PromoteServerSocket($Socket,
269: $CACertificate,
270: $Certificate,
271: $KeyFile);
272: if(! ($SSLSocket) ) { # SSL socket promotion failed.
273: my $err = lonssl::LastError();
274: &logthis("<font color=\"red\"> CRITICAL "
275: ."SSL Socket promotion failed: $err </font>");
276: return undef;
277: }
278: Debug("SSL Promotion successful");
279:
280: #
281: # The only thing we'll use the socket for is to send the IDEA key
282: # to the peer:
283:
284: my $Key = lonlocal::CreateCipherKey();
285: print $SSLSocket "$Key\n";
286:
287: lonssl::Close($SSLSocket);
288:
289: Debug("Key exchange complete: $Key");
290:
291: return $Key;
292: }
293: #
294: # InsecureConnection:
295: # If insecure connections are allowd,
296: # exchange a challenge with the client to 'validate' the
297: # client (not really, but that's the protocol):
298: # We produce a challenge string that's sent to the client.
299: # The client must then echo the challenge verbatim to us.
300: #
301: # Parameter:
302: # Socket - Socket open on the client.
303: # Returns:
304: # 1 - success.
305: # 0 - failure (e.g.mismatch or insecure not allowed).
306: #
307: sub InsecureConnection {
308: my $Socket = shift;
309:
310: # Don't even start if insecure connections are not allowed.
311:
312: if(! $perlvar{londAllowInsecure}) { # Insecure connections not allowed.
313: return 0;
314: }
315:
316: # Fabricate a challenge string and send it..
317:
318: my $challenge = "$$".time; # pid + time.
319: print $Socket "$challenge\n";
320: &status("Waiting for challenge reply");
321:
322: my $answer = <$Socket>;
323: $answer =~s/\W//g;
324: if($challenge eq $answer) {
325: return 1;
326: } else {
327: logthis("<font color='blue'>WARNING client did not respond to challenge</font>");
328: &status("No challenge reqply");
329: return 0;
330: }
331:
332:
333: }
334:
335: #
336: # GetCertificate: Given a transaction that requires a certificate,
337: # this function will extract the certificate from the transaction
338: # request. Note that at this point, the only concept of a certificate
339: # is the hostname to which we are connected.
340: #
341: # Parameter:
342: # request - The request sent by our client (this parameterization may
343: # need to change when we really use a certificate granting
344: # authority.
345: #
346: sub GetCertificate {
347: my $request = shift;
348:
349: return $clientip;
350: }
351:
352: #
353: # Return true if client is a manager.
354: #
355: sub isManager {
356: return (($ConnectionType eq "manager") || ($ConnectionType eq "both"));
357: }
358: #
359: # Return tru if client can do client functions
360: #
361: sub isClient {
362: return (($ConnectionType eq "client") || ($ConnectionType eq "both"));
363: }
364:
365:
366: #
367: # ReadManagerTable: Reads in the current manager table. For now this is
368: # done on each manager authentication because:
369: # - These authentications are not frequent
370: # - This allows dynamic changes to the manager table
371: # without the need to signal to the lond.
372: #
373: sub ReadManagerTable {
374:
375: # Clean out the old table first..
376:
377: foreach my $key (keys %managers) {
378: delete $managers{$key};
379: }
380:
381: my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
382: if (!open (MANAGERS, $tablename)) {
383: logthis('<font color="red">No manager table. Nobody can manage!!</font>');
384: return;
385: }
386: while(my $host = <MANAGERS>) {
387: chomp($host);
388: if ($host =~ "^#") { # Comment line.
389: next;
390: }
391: if (!defined $hostip{$host}) { # This is a non cluster member
392: # The entry is of the form:
393: # cluname:hostname
394: # cluname - A 'cluster hostname' is needed in order to negotiate
395: # the host key.
396: # hostname- The dns name of the host.
397: #
398: my($cluname, $dnsname) = split(/:/, $host);
399:
400: my $ip = gethostbyname($dnsname);
401: if(defined($ip)) { # bad names don't deserve entry.
402: my $hostip = inet_ntoa($ip);
403: $managers{$hostip} = $cluname;
404: logthis('<font color="green"> registering manager '.
405: "$dnsname as $cluname with $hostip </font>\n");
406: }
407: } else {
408: logthis('<font color="green"> existing host'." $host</font>\n");
409: $managers{$hostip{$host}} = $host; # Use info from cluster tab if clumemeber
410: }
411: }
412: }
413:
414: #
415: # ValidManager: Determines if a given certificate represents a valid manager.
416: # in this primitive implementation, the 'certificate' is
417: # just the connecting loncapa client name. This is checked
418: # against a valid client list in the configuration.
419: #
420: #
421: sub ValidManager {
422: my $certificate = shift;
423:
424: return isManager;
425: }
426: #
427: # CopyFile: Called as part of the process of installing a
428: # new configuration file. This function copies an existing
429: # file to a backup file.
430: # Parameters:
431: # oldfile - Name of the file to backup.
432: # newfile - Name of the backup file.
433: # Return:
434: # 0 - Failure (errno has failure reason).
435: # 1 - Success.
436: #
437: sub CopyFile {
438:
439: my ($oldfile, $newfile) = @_;
440:
441: # The file must exist:
442:
443: if(-e $oldfile) {
444:
445: # Read the old file.
446:
447: my $oldfh = IO::File->new("< $oldfile");
448: if(!$oldfh) {
449: return 0;
450: }
451: my @contents = <$oldfh>; # Suck in the entire file.
452:
453: # write the backup file:
454:
455: my $newfh = IO::File->new("> $newfile");
456: if(!(defined $newfh)){
457: return 0;
458: }
459: my $lines = scalar @contents;
460: for (my $i =0; $i < $lines; $i++) {
461: print $newfh ($contents[$i]);
462: }
463:
464: $oldfh->close;
465: $newfh->close;
466:
467: chmod(0660, $newfile);
468:
469: return 1;
470:
471: } else {
472: return 0;
473: }
474: }
475: #
476: # Host files are passed out with externally visible host IPs.
477: # If, for example, we are behind a fire-wall or NAT host, our
478: # internally visible IP may be different than the externally
479: # visible IP. Therefore, we always adjust the contents of the
480: # host file so that the entry for ME is the IP that we believe
481: # we have. At present, this is defined as the entry that
482: # DNS has for us. If by some chance we are not able to get a
483: # DNS translation for us, then we assume that the host.tab file
484: # is correct.
485: # BUGBUGBUG - in the future, we really should see if we can
486: # easily query the interface(s) instead.
487: # Parameter(s):
488: # contents - The contents of the host.tab to check.
489: # Returns:
490: # newcontents - The adjusted contents.
491: #
492: #
493: sub AdjustHostContents {
494: my $contents = shift;
495: my $adjusted;
496: my $me = $perlvar{'lonHostID'};
497:
498: foreach my $line (split(/\n/,$contents)) {
499: if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {
500: chomp($line);
501: my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
502: if ($id eq $me) {
503: my $ip = gethostbyname($name);
504: my $ipnew = inet_ntoa($ip);
505: $ip = $ipnew;
506: # Reconstruct the host line and append to adjusted:
507:
508: my $newline = "$id:$domain:$role:$name:$ip";
509: if($maxcon ne "") { # Not all hosts have loncnew tuning params
510: $newline .= ":$maxcon:$idleto:$mincon";
511: }
512: $adjusted .= $newline."\n";
513:
514: } else { # Not me, pass unmodified.
515: $adjusted .= $line."\n";
516: }
517: } else { # Blank or comment never re-written.
518: $adjusted .= $line."\n"; # Pass blanks and comments as is.
519: }
520: }
521: return $adjusted;
522: }
523: #
524: # InstallFile: Called to install an administrative file:
525: # - The file is created with <name>.tmp
526: # - The <name>.tmp file is then mv'd to <name>
527: # This lugubrious procedure is done to ensure that we are never without
528: # a valid, even if dated, version of the file regardless of who crashes
529: # and when the crash occurs.
530: #
531: # Parameters:
532: # Name of the file
533: # File Contents.
534: # Return:
535: # nonzero - success.
536: # 0 - failure and $! has an errno.
537: #
538: sub InstallFile {
539:
540: my ($Filename, $Contents) = @_;
541: my $TempFile = $Filename.".tmp";
542:
543: # Open the file for write:
544:
545: my $fh = IO::File->new("> $TempFile"); # Write to temp.
546: if(!(defined $fh)) {
547: &logthis('<font color="red"> Unable to create '.$TempFile."</font>");
548: return 0;
549: }
550: # write the contents of the file:
551:
552: print $fh ($Contents);
553: $fh->close; # In case we ever have a filesystem w. locking
554:
555: chmod(0660, $TempFile);
556:
557: # Now we can move install the file in position.
558:
559: move($TempFile, $Filename);
560:
561: return 1;
562: }
563:
564:
565: #
566: # ConfigFileFromSelector: converts a configuration file selector
567: # (one of host or domain at this point) into a
568: # configuration file pathname.
569: #
570: # Parameters:
571: # selector - Configuration file selector.
572: # Returns:
573: # Full path to the file or undef if the selector is invalid.
574: #
575: sub ConfigFileFromSelector {
576: my $selector = shift;
577: my $tablefile;
578:
579: my $tabledir = $perlvar{'lonTabDir'}.'/';
580: if ($selector eq "hosts") {
581: $tablefile = $tabledir."hosts.tab";
582: } elsif ($selector eq "domain") {
583: $tablefile = $tabledir."domain.tab";
584: } else {
585: return undef;
586: }
587: return $tablefile;
588:
589: }
590: #
591: # PushFile: Called to do an administrative push of a file.
592: # - Ensure the file being pushed is one we support.
593: # - Backup the old file to <filename.saved>
594: # - Separate the contents of the new file out from the
595: # rest of the request.
596: # - Write the new file.
597: # Parameter:
598: # Request - The entire user request. This consists of a : separated
599: # string pushfile:tablename:contents.
600: # NOTE: The contents may have :'s in it as well making things a bit
601: # more interesting... but not much.
602: # Returns:
603: # String to send to client ("ok" or "refused" if bad file).
604: #
605: sub PushFile {
606: my $request = shift;
607: my ($command, $filename, $contents) = split(":", $request, 3);
608:
609: # At this point in time, pushes for only the following tables are
610: # supported:
611: # hosts.tab ($filename eq host).
612: # domain.tab ($filename eq domain).
613: # Construct the destination filename or reject the request.
614: #
615: # lonManage is supposed to ensure this, however this session could be
616: # part of some elaborate spoof that managed somehow to authenticate.
617: #
618:
619:
620: my $tablefile = ConfigFileFromSelector($filename);
621: if(! (defined $tablefile)) {
622: return "refused";
623: }
624: #
625: # >copy< the old table to the backup table
626: # don't rename in case system crashes/reboots etc. in the time
627: # window between a rename and write.
628: #
629: my $backupfile = $tablefile;
630: $backupfile =~ s/\.tab$/.old/;
631: if(!CopyFile($tablefile, $backupfile)) {
632: &logthis('<font color="green"> CopyFile from '.$tablefile." to ".$backupfile." failed </font>");
633: return "error:$!";
634: }
635: &logthis('<font color="green"> Pushfile: backed up '
636: .$tablefile." to $backupfile</font>");
637:
638: # If the file being pushed is the host file, we adjust the entry for ourself so that the
639: # IP will be our current IP as looked up in dns. Note this is only 99% good as it's possible
640: # to conceive of conditions where we don't have a DNS entry locally. This is possible in a
641: # network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
642: # that possibilty.
643:
644: if($filename eq "host") {
645: $contents = AdjustHostContents($contents);
646: }
647:
648: # Install the new file:
649:
650: if(!InstallFile($tablefile, $contents)) {
651: &logthis('<font color="red"> Pushfile: unable to install '
652: .$tablefile." $! </font>");
653: return "error:$!";
654: } else {
655: &logthis('<font color="green"> Installed new '.$tablefile
656: ."</font>");
657:
658: }
659:
660:
661: # Indicate success:
662:
663: return "ok";
664:
665: }
666:
667: #
668: # Called to re-init either lonc or lond.
669: #
670: # Parameters:
671: # request - The full request by the client. This is of the form
672: # reinit:<process>
673: # where <process> is allowed to be either of
674: # lonc or lond
675: #
676: # Returns:
677: # The string to be sent back to the client either:
678: # ok - Everything worked just fine.
679: # error:why - There was a failure and why describes the reason.
680: #
681: #
682: sub ReinitProcess {
683: my $request = shift;
684:
685:
686: # separate the request (reinit) from the process identifier and
687: # validate it producing the name of the .pid file for the process.
688: #
689: #
690: my ($junk, $process) = split(":", $request);
691: my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
692: if($process eq 'lonc') {
693: $processpidfile = $processpidfile."lonc.pid";
694: if (!open(PIDFILE, "< $processpidfile")) {
695: return "error:Open failed for $processpidfile";
696: }
697: my $loncpid = <PIDFILE>;
698: close(PIDFILE);
699: logthis('<font color="red"> Reinitializing lonc pid='.$loncpid
700: ."</font>");
701: kill("USR2", $loncpid);
702: } elsif ($process eq 'lond') {
703: logthis('<font color="red"> Reinitializing self (lond) </font>');
704: &UpdateHosts; # Lond is us!!
705: } else {
706: &logthis('<font color="yellow" Invalid reinit request for '.$process
707: ."</font>");
708: return "error:Invalid process identifier $process";
709: }
710: return 'ok';
711: }
712: # Validate a line in a configuration file edit script:
713: # Validation includes:
714: # - Ensuring the command is valid.
715: # - Ensuring the command has sufficient parameters
716: # Parameters:
717: # scriptline - A line to validate (\n has been stripped for what it's worth).
718: #
719: # Return:
720: # 0 - Invalid scriptline.
721: # 1 - Valid scriptline
722: # NOTE:
723: # Only the command syntax is checked, not the executability of the
724: # command.
725: #
726: sub isValidEditCommand {
727: my $scriptline = shift;
728:
729: # Line elements are pipe separated:
730:
731: my ($command, $key, $newline) = split(/\|/, $scriptline);
732: &logthis('<font color="green"> isValideditCommand checking: '.
733: "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");
734:
735: if ($command eq "delete") {
736: #
737: # key with no newline.
738: #
739: if( ($key eq "") || ($newline ne "")) {
740: return 0; # Must have key but no newline.
741: } else {
742: return 1; # Valid syntax.
743: }
744: } elsif ($command eq "replace") {
745: #
746: # key and newline:
747: #
748: if (($key eq "") || ($newline eq "")) {
749: return 0;
750: } else {
751: return 1;
752: }
753: } elsif ($command eq "append") {
754: if (($key ne "") && ($newline eq "")) {
755: return 1;
756: } else {
757: return 0;
758: }
759: } else {
760: return 0; # Invalid command.
761: }
762: return 0; # Should not get here!!!
763: }
764: #
765: # ApplyEdit - Applies an edit command to a line in a configuration
766: # file. It is the caller's responsiblity to validate the
767: # edit line.
768: # Parameters:
769: # $directive - A single edit directive to apply.
770: # Edit directives are of the form:
771: # append|newline - Appends a new line to the file.
772: # replace|key|newline - Replaces the line with key value 'key'
773: # delete|key - Deletes the line with key value 'key'.
774: # $editor - A config file editor object that contains the
775: # file being edited.
776: #
777: sub ApplyEdit {
778:
779: my ($directive, $editor) = @_;
780:
781: # Break the directive down into its command and its parameters
782: # (at most two at this point. The meaning of the parameters, if in fact
783: # they exist depends on the command).
784:
785: my ($command, $p1, $p2) = split(/\|/, $directive);
786:
787: if($command eq "append") {
788: $editor->Append($p1); # p1 - key p2 null.
789: } elsif ($command eq "replace") {
790: $editor->ReplaceLine($p1, $p2); # p1 - key p2 = newline.
791: } elsif ($command eq "delete") {
792: $editor->DeleteLine($p1); # p1 - key p2 null.
793: } else { # Should not get here!!!
794: die "Invalid command given to ApplyEdit $command"
795: }
796: }
797: #
798: # AdjustOurHost:
799: # Adjusts a host file stored in a configuration file editor object
800: # for the true IP address of this host. This is necessary for hosts
801: # that live behind a firewall.
802: # Those hosts have a publicly distributed IP of the firewall, but
803: # internally must use their actual IP. We assume that a given
804: # host only has a single IP interface for now.
805: # Formal Parameters:
806: # editor - The configuration file editor to adjust. This
807: # editor is assumed to contain a hosts.tab file.
808: # Strategy:
809: # - Figure out our hostname.
810: # - Lookup the entry for this host.
811: # - Modify the line to contain our IP
812: # - Do a replace for this host.
813: sub AdjustOurHost {
814: my $editor = shift;
815:
816: # figure out who I am.
817:
818: my $myHostName = $perlvar{'lonHostID'}; # LonCAPA hostname.
819:
820: # Get my host file entry.
821:
822: my $ConfigLine = $editor->Find($myHostName);
823: if(! (defined $ConfigLine)) {
824: die "AdjustOurHost - no entry for me in hosts file $myHostName";
825: }
826: # figure out my IP:
827: # Use the config line to get my hostname.
828: # Use gethostbyname to translate that into an IP address.
829: #
830: my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
831: my $BinaryIp = gethostbyname($name);
832: my $ip = inet_ntoa($ip);
833: #
834: # Reassemble the config line from the elements in the list.
835: # Note that if the loncnew items were not present before, they will
836: # be now even if they would be empty
837: #
838: my $newConfigLine = $id;
839: foreach my $item ($domain, $role, $name, $ip, $maxcon, $idleto, $mincon) {
840: $newConfigLine .= ":".$item;
841: }
842: # Replace the line:
843:
844: $editor->ReplaceLine($id, $newConfigLine);
845:
846: }
847: #
848: # ReplaceConfigFile:
849: # Replaces a configuration file with the contents of a
850: # configuration file editor object.
851: # This is done by:
852: # - Copying the target file to <filename>.old
853: # - Writing the new file to <filename>.tmp
854: # - Moving <filename.tmp> -> <filename>
855: # This laborious process ensures that the system is never without
856: # a configuration file that's at least valid (even if the contents
857: # may be dated).
858: # Parameters:
859: # filename - Name of the file to modify... this is a full path.
860: # editor - Editor containing the file.
861: #
862: sub ReplaceConfigFile {
863:
864: my ($filename, $editor) = @_;
865:
866: CopyFile ($filename, $filename.".old");
867:
868: my $contents = $editor->Get(); # Get the contents of the file.
869:
870: InstallFile($filename, $contents);
871: }
872: #
873: #
874: # Called to edit a configuration table file
875: # Parameters:
876: # request - The entire command/request sent by lonc or lonManage
877: # Return:
878: # The reply to send to the client.
879: #
880: sub EditFile {
881: my $request = shift;
882:
883: # Split the command into it's pieces: edit:filetype:script
884:
885: my ($request, $filetype, $script) = split(/:/, $request,3); # : in script
886:
887: # Check the pre-coditions for success:
888:
889: if($request != "edit") { # Something is amiss afoot alack.
890: return "error:edit request detected, but request != 'edit'\n";
891: }
892: if( ($filetype ne "hosts") &&
893: ($filetype ne "domain")) {
894: return "error:edit requested with invalid file specifier: $filetype \n";
895: }
896:
897: # Split the edit script and check it's validity.
898:
899: my @scriptlines = split(/\n/, $script); # one line per element.
900: my $linecount = scalar(@scriptlines);
901: for(my $i = 0; $i < $linecount; $i++) {
902: chomp($scriptlines[$i]);
903: if(!isValidEditCommand($scriptlines[$i])) {
904: return "error:edit with bad script line: '$scriptlines[$i]' \n";
905: }
906: }
907:
908: # Execute the edit operation.
909: # - Create a config file editor for the appropriate file and
910: # - execute each command in the script:
911: #
912: my $configfile = ConfigFileFromSelector($filetype);
913: if (!(defined $configfile)) {
914: return "refused\n";
915: }
916: my $editor = ConfigFileEdit->new($configfile);
917:
918: for (my $i = 0; $i < $linecount; $i++) {
919: ApplyEdit($scriptlines[$i], $editor);
920: }
921: # If the file is the host file, ensure that our host is
922: # adjusted to have our ip:
923: #
924: if($filetype eq "host") {
925: AdjustOurHost($editor);
926: }
927: # Finally replace the current file with our file.
928: #
929: ReplaceConfigFile($configfile, $editor);
930:
931: return "ok\n";
932: }
933:
934: #---------------------------------------------------------------
935: #
936: # Manipulation of hash based databases (factoring out common code
937: # for later use as we refactor.
938: #
939: # Ties a domain level resource file to a hash.
940: # If requested a history entry is created in the associated hist file.
941: #
942: # Parameters:
943: # domain - Name of the domain in which the resource file lives.
944: # namespace - Name of the hash within that domain.
945: # how - How to tie the hash (e.g. GDBM_WRCREAT()).
946: # loghead - Optional parameter, if present a log entry is created
947: # in the associated history file and this is the first part
948: # of that entry.
949: # logtail - Goes along with loghead, The actual logentry is of the
950: # form $loghead:<timestamp>:logtail.
951: # Returns:
952: # Reference to a hash bound to the db file or alternatively undef
953: # if the tie failed.
954: #
955: sub tie_domain_hash {
956: my ($domain,$namespace,$how,$loghead,$logtail) = @_;
957:
958: # Filter out any whitespace in the domain name:
959:
960: $domain =~ s/\W//g;
961:
962: # We have enough to go on to tie the hash:
963:
964: my $user_top_dir = $perlvar{'lonUsersDir'};
965: my $domain_dir = $user_top_dir."/$domain";
966: my $resource_file = $domain_dir."/$namespace.db";
967: my %hash;
968: if(tie(%hash, 'GDBM_File', $resource_file, $how, 0640)) {
969: if (defined($loghead)) { # Need to log the operation.
970: my $logFh = IO::File->new(">>$domain_dir/$namespace.hist");
971: if($logFh) {
972: my $timestamp = time;
973: print $logFh "$loghead:$timestamp:$logtail\n";
974: }
975: $logFh->close;
976: }
977: return \%hash; # Return the tied hash.
978: } else {
979: return undef; # Tie failed.
980: }
981: }
982:
983: #
984: # Ties a user's resource file to a hash.
985: # If necessary, an appropriate history
986: # log file entry is made as well.
987: # This sub factors out common code from the subs that manipulate
988: # the various gdbm files that keep keyword value pairs.
989: # Parameters:
990: # domain - Name of the domain the user is in.
991: # user - Name of the 'current user'.
992: # namespace - Namespace representing the file to tie.
993: # how - What the tie is done to (e.g. GDBM_WRCREAT().
994: # loghead - Optional first part of log entry if there may be a
995: # history file.
996: # what - Optional tail of log entry if there may be a history
997: # file.
998: # Returns:
999: # hash to which the database is tied. It's up to the caller to untie.
1000: # undef if the has could not be tied.
1001: #
1002: sub tie_user_hash {
1003: my ($domain,$user,$namespace,$how,$loghead,$what) = @_;
1004:
1005: $namespace=~s/\//\_/g; # / -> _
1006: $namespace=~s/\W//g; # whitespace eliminated.
1007: my $proname = propath($domain, $user);
1008:
1009: # Tie the database.
1010:
1011: my %hash;
1012: if(tie(%hash, 'GDBM_File', "$proname/$namespace.db",
1013: $how, 0640)) {
1014: # If this is a namespace for which a history is kept,
1015: # make the history log entry:
1016: if (($namespace =~/^nohist\_/) && (defined($loghead))) {
1017: my $args = scalar @_;
1018: Debug(" Opening history: $namespace $args");
1019: my $hfh = IO::File->new(">>$proname/$namespace.hist");
1020: if($hfh) {
1021: my $now = time;
1022: print $hfh "$loghead:$now:$what\n";
1023: }
1024: $hfh->close;
1025: }
1026: return \%hash;
1027: } else {
1028: return undef;
1029: }
1030:
1031: }
1032:
1033: #--------------------- Request Handlers --------------------------------------------
1034: #
1035: # By convention each request handler registers itself prior to the sub
1036: # declaration:
1037: #
1038:
1039: #++
1040: #
1041: # Handles ping requests.
1042: # Parameters:
1043: # $cmd - the actual keyword that invoked us.
1044: # $tail - the tail of the request that invoked us.
1045: # $replyfd- File descriptor connected to the client
1046: # Implicit Inputs:
1047: # $currenthostid - Global variable that carries the name of the host we are
1048: # known as.
1049: # Returns:
1050: # 1 - Ok to continue processing.
1051: # 0 - Program should exit.
1052: # Side effects:
1053: # Reply information is sent to the client.
1054:
1055: sub ping_handler {
1056: my ($cmd, $tail, $client) = @_;
1057: Debug("$cmd $tail $client .. $currenthostid:");
1058:
1059: Reply( $client,"$currenthostid\n","$cmd:$tail");
1060:
1061: return 1;
1062: }
1063: ®ister_handler("ping", \&ping_handler, 0, 1, 1); # Ping unencoded, client or manager.
1064:
1065: #++
1066: #
1067: # Handles pong requests. Pong replies with our current host id, and
1068: # the results of a ping sent to us via our lonc.
1069: #
1070: # Parameters:
1071: # $cmd - the actual keyword that invoked us.
1072: # $tail - the tail of the request that invoked us.
1073: # $replyfd- File descriptor connected to the client
1074: # Implicit Inputs:
1075: # $currenthostid - Global variable that carries the name of the host we are
1076: # connected to.
1077: # Returns:
1078: # 1 - Ok to continue processing.
1079: # 0 - Program should exit.
1080: # Side effects:
1081: # Reply information is sent to the client.
1082:
1083: sub pong_handler {
1084: my ($cmd, $tail, $replyfd) = @_;
1085:
1086: my $reply=&reply("ping",$clientname);
1087: &Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");
1088: return 1;
1089: }
1090: ®ister_handler("pong", \&pong_handler, 0, 1, 1); # Pong unencoded, client or manager
1091:
1092: #++
1093: # Called to establish an encrypted session key with the remote client.
1094: # Note that with secure lond, in most cases this function is never
1095: # invoked. Instead, the secure session key is established either
1096: # via a local file that's locked down tight and only lives for a short
1097: # time, or via an ssl tunnel...and is generated from a bunch-o-random
1098: # bits from /dev/urandom, rather than the predictable pattern used by
1099: # by this sub. This sub is only used in the old-style insecure
1100: # key negotiation.
1101: # Parameters:
1102: # $cmd - the actual keyword that invoked us.
1103: # $tail - the tail of the request that invoked us.
1104: # $replyfd- File descriptor connected to the client
1105: # Implicit Inputs:
1106: # $currenthostid - Global variable that carries the name of the host
1107: # known as.
1108: # $clientname - Global variable that carries the name of the hsot we're connected to.
1109: # Returns:
1110: # 1 - Ok to continue processing.
1111: # 0 - Program should exit.
1112: # Implicit Outputs:
1113: # Reply information is sent to the client.
1114: # $cipher is set with a reference to a new IDEA encryption object.
1115: #
1116: sub establish_key_handler {
1117: my ($cmd, $tail, $replyfd) = @_;
1118:
1119: my $buildkey=time.$$.int(rand 100000);
1120: $buildkey=~tr/1-6/A-F/;
1121: $buildkey=int(rand 100000).$buildkey.int(rand 100000);
1122: my $key=$currenthostid.$clientname;
1123: $key=~tr/a-z/A-Z/;
1124: $key=~tr/G-P/0-9/;
1125: $key=~tr/Q-Z/0-9/;
1126: $key=$key.$buildkey.$key.$buildkey.$key.$buildkey;
1127: $key=substr($key,0,32);
1128: my $cipherkey=pack("H32",$key);
1129: $cipher=new IDEA $cipherkey;
1130: &Reply($replyfd, "$buildkey\n", "$cmd:$tail");
1131:
1132: return 1;
1133:
1134: }
1135: ®ister_handler("ekey", \&establish_key_handler, 0, 1,1);
1136:
1137:
1138: # Handler for the load command. Returns the current system load average
1139: # to the requestor.
1140: #
1141: # Parameters:
1142: # $cmd - the actual keyword that invoked us.
1143: # $tail - the tail of the request that invoked us.
1144: # $replyfd- File descriptor connected to the client
1145: # Implicit Inputs:
1146: # $currenthostid - Global variable that carries the name of the host
1147: # known as.
1148: # $clientname - Global variable that carries the name of the hsot we're connected to.
1149: # Returns:
1150: # 1 - Ok to continue processing.
1151: # 0 - Program should exit.
1152: # Side effects:
1153: # Reply information is sent to the client.
1154: sub load_handler {
1155: my ($cmd, $tail, $replyfd) = @_;
1156:
1157: # Get the load average from /proc/loadavg and calculate it as a percentage of
1158: # the allowed load limit as set by the perl global variable lonLoadLim
1159:
1160: my $loadavg;
1161: my $loadfile=IO::File->new('/proc/loadavg');
1162:
1163: $loadavg=<$loadfile>;
1164: $loadavg =~ s/\s.*//g; # Extract the first field only.
1165:
1166: my $loadpercent=100*$loadavg/$perlvar{'lonLoadLim'};
1167:
1168: &Reply( $replyfd, "$loadpercent\n", "$cmd:$tail");
1169:
1170: return 1;
1171: }
1172: register_handler("load", \&load_handler, 0, 1, 0);
1173:
1174: #
1175: # Process the userload request. This sub returns to the client the current
1176: # user load average. It can be invoked either by clients or managers.
1177: #
1178: # Parameters:
1179: # $cmd - the actual keyword that invoked us.
1180: # $tail - the tail of the request that invoked us.
1181: # $replyfd- File descriptor connected to the client
1182: # Implicit Inputs:
1183: # $currenthostid - Global variable that carries the name of the host
1184: # known as.
1185: # $clientname - Global variable that carries the name of the hsot we're connected to.
1186: # Returns:
1187: # 1 - Ok to continue processing.
1188: # 0 - Program should exit
1189: # Implicit inputs:
1190: # whatever the userload() function requires.
1191: # Implicit outputs:
1192: # the reply is written to the client.
1193: #
1194: sub user_load_handler {
1195: my ($cmd, $tail, $replyfd) = @_;
1196:
1197: my $userloadpercent=&userload();
1198: &Reply($replyfd, "$userloadpercent\n", "$cmd:$tail");
1199:
1200: return 1;
1201: }
1202: register_handler("userload", \&user_load_handler, 0, 1, 0);
1203:
1204: # Process a request for the authorization type of a user:
1205: # (userauth).
1206: #
1207: # Parameters:
1208: # $cmd - the actual keyword that invoked us.
1209: # $tail - the tail of the request that invoked us.
1210: # $replyfd- File descriptor connected to the client
1211: # Returns:
1212: # 1 - Ok to continue processing.
1213: # 0 - Program should exit
1214: # Implicit outputs:
1215: # The user authorization type is written to the client.
1216: #
1217: sub user_authorization_type {
1218: my ($cmd, $tail, $replyfd) = @_;
1219:
1220: my $userinput = "$cmd:$tail";
1221:
1222: # Pull the domain and username out of the command tail.
1223: # and call get_auth_type to determine the authentication type.
1224:
1225: my ($udom,$uname)=split(/:/,$tail);
1226: my $result = &get_auth_type($udom, $uname);
1227: if($result eq "nouser") {
1228: &Failure( $replyfd, "unknown_user\n", $userinput);
1229: } else {
1230: #
1231: # We only want to pass the second field from get_auth_type
1232: # for ^krb.. otherwise we'll be handing out the encrypted
1233: # password for internals e.g.
1234: #
1235: my ($type,$otherinfo) = split(/:/,$result);
1236: if($type =~ /^krb/) {
1237: $type = $result;
1238: }
1239: &Reply( $replyfd, "$type:\n", $userinput);
1240: }
1241:
1242: return 1;
1243: }
1244: ®ister_handler("currentauth", \&user_authorization_type, 1, 1, 0);
1245:
1246: # Process a request by a manager to push a hosts or domain table
1247: # to us. We pick apart the command and pass it on to the subs
1248: # that already exist to do this.
1249: #
1250: # Parameters:
1251: # $cmd - the actual keyword that invoked us.
1252: # $tail - the tail of the request that invoked us.
1253: # $client - File descriptor connected to the client
1254: # Returns:
1255: # 1 - Ok to continue processing.
1256: # 0 - Program should exit
1257: # Implicit Output:
1258: # a reply is written to the client.
1259:
1260: sub push_file_handler {
1261: my ($cmd, $tail, $client) = @_;
1262:
1263: my $userinput = "$cmd:$tail";
1264:
1265: # At this time we only know that the IP of our partner is a valid manager
1266: # the code below is a hook to do further authentication (e.g. to resolve
1267: # spoofing).
1268:
1269: my $cert = &GetCertificate($userinput);
1270: if(&ValidManager($cert)) {
1271:
1272: # Now presumably we have the bona fides of both the peer host and the
1273: # process making the request.
1274:
1275: my $reply = &PushFile($userinput);
1276: &Reply($client, "$reply\n", $userinput);
1277:
1278: } else {
1279: &Failure( $client, "refused\n", $userinput);
1280: }
1281: return 1;
1282: }
1283: ®ister_handler("pushfile", \&push_file_handler, 1, 0, 1);
1284:
1285:
1286:
1287: # Process a reinit request. Reinit requests that either
1288: # lonc or lond be reinitialized so that an updated
1289: # host.tab or domain.tab can be processed.
1290: #
1291: # Parameters:
1292: # $cmd - the actual keyword that invoked us.
1293: # $tail - the tail of the request that invoked us.
1294: # $client - File descriptor connected to the client
1295: # Returns:
1296: # 1 - Ok to continue processing.
1297: # 0 - Program should exit
1298: # Implicit output:
1299: # a reply is sent to the client.
1300: #
1301: sub reinit_process_handler {
1302: my ($cmd, $tail, $client) = @_;
1303:
1304: my $userinput = "$cmd:$tail";
1305:
1306: my $cert = &GetCertificate($userinput);
1307: if(&ValidManager($cert)) {
1308: chomp($userinput);
1309: my $reply = &ReinitProcess($userinput);
1310: &Reply( $client, "$reply\n", $userinput);
1311: } else {
1312: &Failure( $client, "refused\n", $userinput);
1313: }
1314: return 1;
1315: }
1316:
1317: ®ister_handler("reinit", \&reinit_process_handler, 1, 0, 1);
1318:
1319: # Process the editing script for a table edit operation.
1320: # the editing operation must be encrypted and requested by
1321: # a manager host.
1322: #
1323: # Parameters:
1324: # $cmd - the actual keyword that invoked us.
1325: # $tail - the tail of the request that invoked us.
1326: # $client - File descriptor connected to the client
1327: # Returns:
1328: # 1 - Ok to continue processing.
1329: # 0 - Program should exit
1330: # Implicit output:
1331: # a reply is sent to the client.
1332: #
1333: sub edit_table_handler {
1334: my ($command, $tail, $client) = @_;
1335:
1336: my $userinput = "$command:$tail";
1337:
1338: my $cert = &GetCertificate($userinput);
1339: if(&ValidManager($cert)) {
1340: my($filetype, $script) = split(/:/, $tail);
1341: if (($filetype eq "hosts") ||
1342: ($filetype eq "domain")) {
1343: if($script ne "") {
1344: &Reply($client, # BUGBUG - EditFile
1345: &EditFile($userinput), # could fail.
1346: $userinput);
1347: } else {
1348: &Failure($client,"refused\n",$userinput);
1349: }
1350: } else {
1351: &Failure($client,"refused\n",$userinput);
1352: }
1353: } else {
1354: &Failure($client,"refused\n",$userinput);
1355: }
1356: return 1;
1357: }
1358: register_handler("edit", \&edit_table_handler, 1, 0, 1);
1359:
1360:
1361: #
1362: # Authenticate a user against the LonCAPA authentication
1363: # database. Note that there are several authentication
1364: # possibilities:
1365: # - unix - The user can be authenticated against the unix
1366: # password file.
1367: # - internal - The user can be authenticated against a purely
1368: # internal per user password file.
1369: # - kerberos - The user can be authenticated against either a kerb4 or kerb5
1370: # ticket granting authority.
1371: # - user - The person tailoring LonCAPA can supply a user authentication
1372: # mechanism that is per system.
1373: #
1374: # Parameters:
1375: # $cmd - The command that got us here.
1376: # $tail - Tail of the command (remaining parameters).
1377: # $client - File descriptor connected to client.
1378: # Returns
1379: # 0 - Requested to exit, caller should shut down.
1380: # 1 - Continue processing.
1381: # Implicit inputs:
1382: # The authentication systems describe above have their own forms of implicit
1383: # input into the authentication process that are described above.
1384: #
1385: sub authenticate_handler {
1386: my ($cmd, $tail, $client) = @_;
1387:
1388:
1389: # Regenerate the full input line
1390:
1391: my $userinput = $cmd.":".$tail;
1392:
1393: # udom - User's domain.
1394: # uname - Username.
1395: # upass - User's password.
1396:
1397: my ($udom,$uname,$upass)=split(/:/,$tail);
1398: &Debug(" Authenticate domain = $udom, user = $uname, password = $upass");
1399: chomp($upass);
1400: $upass=&unescape($upass);
1401:
1402: my $pwdcorrect = &validate_user($udom, $uname, $upass);
1403: if($pwdcorrect) {
1404: &Reply( $client, "authorized\n", $userinput);
1405: #
1406: # Bad credentials: Failed to authorize
1407: #
1408: } else {
1409: &Failure( $client, "non_authorized\n", $userinput);
1410: }
1411:
1412: return 1;
1413: }
1414:
1415: register_handler("auth", \&authenticate_handler, 1, 1, 0);
1416:
1417: #
1418: # Change a user's password. Note that this function is complicated by
1419: # the fact that a user may be authenticated in more than one way:
1420: # At present, we are not able to change the password for all types of
1421: # authentication methods. Only for:
1422: # unix - unix password or shadow passoword style authentication.
1423: # local - Locally written authentication mechanism.
1424: # For now, kerb4 and kerb5 password changes are not supported and result
1425: # in an error.
1426: # FUTURE WORK:
1427: # Support kerberos passwd changes?
1428: # Parameters:
1429: # $cmd - The command that got us here.
1430: # $tail - Tail of the command (remaining parameters).
1431: # $client - File descriptor connected to client.
1432: # Returns
1433: # 0 - Requested to exit, caller should shut down.
1434: # 1 - Continue processing.
1435: # Implicit inputs:
1436: # The authentication systems describe above have their own forms of implicit
1437: # input into the authentication process that are described above.
1438: sub change_password_handler {
1439: my ($cmd, $tail, $client) = @_;
1440:
1441: my $userinput = $cmd.":".$tail; # Reconstruct client's string.
1442:
1443: #
1444: # udom - user's domain.
1445: # uname - Username.
1446: # upass - Current password.
1447: # npass - New password.
1448:
1449: my ($udom,$uname,$upass,$npass)=split(/:/,$tail);
1450:
1451: $upass=&unescape($upass);
1452: $npass=&unescape($npass);
1453: &Debug("Trying to change password for $uname");
1454:
1455: # First require that the user can be authenticated with their
1456: # old password:
1457:
1458: my $validated = &validate_user($udom, $uname, $upass);
1459: if($validated) {
1460: my $realpasswd = &get_auth_type($udom, $uname); # Defined since authd.
1461:
1462: my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
1463: if ($howpwd eq 'internal') {
1464: &Debug("internal auth");
1465: my $salt=time;
1466: $salt=substr($salt,6,2);
1467: my $ncpass=crypt($npass,$salt);
1468: if(&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
1469: &logthis("Result of password change for "
1470: ."$uname: pwchange_success");
1471: &Reply($client, "ok\n", $userinput);
1472: } else {
1473: &logthis("Unable to open $uname passwd "
1474: ."to change password");
1475: &Failure( $client, "non_authorized\n",$userinput);
1476: }
1477: } elsif ($howpwd eq 'unix') {
1478: # Unix means we have to access /etc/password
1479: &Debug("auth is unix");
1480: my $execdir=$perlvar{'lonDaemons'};
1481: &Debug("Opening lcpasswd pipeline");
1482: my $pf = IO::File->new("|$execdir/lcpasswd > "
1483: ."$perlvar{'lonDaemons'}"
1484: ."/logs/lcpasswd.log");
1485: print $pf "$uname\n$npass\n$npass\n";
1486: close $pf;
1487: my $err = $?;
1488: my $result = ($err>0 ? 'pwchange_failure' : 'ok');
1489: &logthis("Result of password change for $uname: ".
1490: &lcpasswdstrerror($?));
1491: &Reply($client, "$result\n", $userinput);
1492: } else {
1493: # this just means that the current password mode is not
1494: # one we know how to change (e.g the kerberos auth modes or
1495: # locally written auth handler).
1496: #
1497: &Failure( $client, "auth_mode_error\n", $userinput);
1498: }
1499:
1500: } else {
1501: &Failure( $client, "non_authorized\n", $userinput);
1502: }
1503:
1504: return 1;
1505: }
1506: register_handler("passwd", \&change_password_handler, 1, 1, 0);
1507:
1508:
1509: #
1510: # Create a new user. User in this case means a lon-capa user.
1511: # The user must either already exist in some authentication realm
1512: # like kerberos or the /etc/passwd. If not, a user completely local to
1513: # this loncapa system is created.
1514: #
1515: # Parameters:
1516: # $cmd - The command that got us here.
1517: # $tail - Tail of the command (remaining parameters).
1518: # $client - File descriptor connected to client.
1519: # Returns
1520: # 0 - Requested to exit, caller should shut down.
1521: # 1 - Continue processing.
1522: # Implicit inputs:
1523: # The authentication systems describe above have their own forms of implicit
1524: # input into the authentication process that are described above.
1525: sub add_user_handler {
1526:
1527: my ($cmd, $tail, $client) = @_;
1528:
1529:
1530: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1531: my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
1532:
1533: &Debug("cmd =".$cmd." $udom =".$udom." uname=".$uname);
1534:
1535:
1536: if($udom eq $currentdomainid) { # Reject new users for other domains...
1537:
1538: my $oldumask=umask(0077);
1539: chomp($npass);
1540: $npass=&unescape($npass);
1541: my $passfilename = &password_path($udom, $uname);
1542: &Debug("Password file created will be:".$passfilename);
1543: if (-e $passfilename) {
1544: &Failure( $client, "already_exists\n", $userinput);
1545: } else {
1546: my @fpparts=split(/\//,$passfilename);
1547: my $fpnow=$fpparts[0].'/'.$fpparts[1].'/'.$fpparts[2];
1548: my $fperror='';
1549: for (my $i=3;$i<= ($#fpparts-1);$i++) {
1550: $fpnow.='/'.$fpparts[$i];
1551: unless (-e $fpnow) {
1552: &logthis("mkdir $fpnow");
1553: unless (mkdir($fpnow,0777)) {
1554: $fperror="error: ".($!+0)." mkdir failed while attempting "
1555: ."makeuser";
1556: }
1557: }
1558: }
1559: unless ($fperror) {
1560: my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);
1561: &Reply($client, $result, $userinput); #BUGBUG - could be fail
1562: } else {
1563: &Failure($client, "$fperror\n", $userinput);
1564: }
1565: }
1566: umask($oldumask);
1567: } else {
1568: &Failure($client, "not_right_domain\n",
1569: $userinput); # Even if we are multihomed.
1570:
1571: }
1572: return 1;
1573:
1574: }
1575: ®ister_handler("makeuser", \&add_user_handler, 1, 1, 0);
1576:
1577: #
1578: # Change the authentication method of a user. Note that this may
1579: # also implicitly change the user's password if, for example, the user is
1580: # joining an existing authentication realm. Known authentication realms at
1581: # this time are:
1582: # internal - Purely internal password file (only loncapa knows this user)
1583: # local - Institutionally written authentication module.
1584: # unix - Unix user (/etc/passwd with or without /etc/shadow).
1585: # kerb4 - kerberos version 4
1586: # kerb5 - kerberos version 5
1587: #
1588: # Parameters:
1589: # $cmd - The command that got us here.
1590: # $tail - Tail of the command (remaining parameters).
1591: # $client - File descriptor connected to client.
1592: # Returns
1593: # 0 - Requested to exit, caller should shut down.
1594: # 1 - Continue processing.
1595: # Implicit inputs:
1596: # The authentication systems describe above have their own forms of implicit
1597: # input into the authentication process that are described above.
1598: #
1599: sub change_authentication_handler {
1600:
1601: my ($cmd, $tail, $client) = @_;
1602:
1603: my $userinput = "$cmd:$tail"; # Reconstruct user input.
1604:
1605: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1606: &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
1607: if ($udom ne $currentdomainid) {
1608: &Failure( $client, "not_right_domain\n", $client);
1609: } else {
1610:
1611: chomp($npass);
1612:
1613: $npass=&unescape($npass);
1614: my $passfilename = &password_path($udom, $uname);
1615: if ($passfilename) { # Not allowed to create a new user!!
1616: my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
1617: &Reply($client, $result, $userinput);
1618: } else {
1619: &Failure($client, "non_authorized", $userinput); # Fail the user now.
1620: }
1621: }
1622: return 1;
1623: }
1624: ®ister_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
1625:
1626: #
1627: # Determines if this is the home server for a user. The home server
1628: # for a user will have his/her lon-capa passwd file. Therefore all we need
1629: # to do is determine if this file exists.
1630: #
1631: # Parameters:
1632: # $cmd - The command that got us here.
1633: # $tail - Tail of the command (remaining parameters).
1634: # $client - File descriptor connected to client.
1635: # Returns
1636: # 0 - Requested to exit, caller should shut down.
1637: # 1 - Continue processing.
1638: # Implicit inputs:
1639: # The authentication systems describe above have their own forms of implicit
1640: # input into the authentication process that are described above.
1641: #
1642: sub is_home_handler {
1643: my ($cmd, $tail, $client) = @_;
1644:
1645: my $userinput = "$cmd:$tail";
1646:
1647: my ($udom,$uname)=split(/:/,$tail);
1648: chomp($uname);
1649: my $passfile = &password_filename($udom, $uname);
1650: if($passfile) {
1651: &Reply( $client, "found\n", $userinput);
1652: } else {
1653: &Failure($client, "not_found\n", $userinput);
1654: }
1655: return 1;
1656: }
1657: ®ister_handler("home", \&is_home_handler, 0,1,0);
1658:
1659: #
1660: # Process an update request for a resource?? I think what's going on here is
1661: # that a resource has been modified that we hold a subscription to.
1662: # If the resource is not local, then we must update, or at least invalidate our
1663: # cached copy of the resource.
1664: # FUTURE WORK:
1665: # I need to look at this logic carefully. My druthers would be to follow
1666: # typical caching logic, and simple invalidate the cache, drop any subscription
1667: # an let the next fetch start the ball rolling again... however that may
1668: # actually be more difficult than it looks given the complex web of
1669: # proxy servers.
1670: # Parameters:
1671: # $cmd - The command that got us here.
1672: # $tail - Tail of the command (remaining parameters).
1673: # $client - File descriptor connected to client.
1674: # Returns
1675: # 0 - Requested to exit, caller should shut down.
1676: # 1 - Continue processing.
1677: # Implicit inputs:
1678: # The authentication systems describe above have their own forms of implicit
1679: # input into the authentication process that are described above.
1680: #
1681: sub update_resource_handler {
1682:
1683: my ($cmd, $tail, $client) = @_;
1684:
1685: my $userinput = "$cmd:$tail";
1686:
1687: my $fname= $tail; # This allows interactive testing
1688:
1689:
1690: my $ownership=ishome($fname);
1691: if ($ownership eq 'not_owner') {
1692: if (-e $fname) {
1693: my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
1694: $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);
1695: my $now=time;
1696: my $since=$now-$atime;
1697: if ($since>$perlvar{'lonExpire'}) {
1698: my $reply=&reply("unsub:$fname","$clientname");
1699: unlink("$fname");
1700: } else {
1701: my $transname="$fname.in.transfer";
1702: my $remoteurl=&reply("sub:$fname","$clientname");
1703: my $response;
1704: alarm(120);
1705: {
1706: my $ua=new LWP::UserAgent;
1707: my $request=new HTTP::Request('GET',"$remoteurl");
1708: $response=$ua->request($request,$transname);
1709: }
1710: alarm(0);
1711: if ($response->is_error()) {
1712: unlink($transname);
1713: my $message=$response->status_line;
1714: &logthis("LWP GET: $message for $fname ($remoteurl)");
1715: } else {
1716: if ($remoteurl!~/\.meta$/) {
1717: alarm(120);
1718: {
1719: my $ua=new LWP::UserAgent;
1720: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1721: my $mresponse=$ua->request($mrequest,$fname.'.meta');
1722: if ($mresponse->is_error()) {
1723: unlink($fname.'.meta');
1724: }
1725: }
1726: alarm(0);
1727: }
1728: rename($transname,$fname);
1729: }
1730: }
1731: &Reply( $client, "ok\n", $userinput);
1732: } else {
1733: &Failure($client, "not_found\n", $userinput);
1734: }
1735: } else {
1736: &Failure($client, "rejected\n", $userinput);
1737: }
1738: return 1;
1739: }
1740: ®ister_handler("update", \&update_resource_handler, 0 ,1, 0);
1741:
1742: #
1743: # Fetch a user file from a remote server to the user's home directory
1744: # userfiles subdir.
1745: # Parameters:
1746: # $cmd - The command that got us here.
1747: # $tail - Tail of the command (remaining parameters).
1748: # $client - File descriptor connected to client.
1749: # Returns
1750: # 0 - Requested to exit, caller should shut down.
1751: # 1 - Continue processing.
1752: #
1753: sub fetch_user_file_handler {
1754:
1755: my ($cmd, $tail, $client) = @_;
1756:
1757: my $userinput = "$cmd:$tail";
1758: my $fname = $tail;
1759: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
1760: my $udir=&propath($udom,$uname).'/userfiles';
1761: unless (-e $udir) {
1762: mkdir($udir,0770);
1763: }
1764: Debug("fetch user file for $fname");
1765: if (-e $udir) {
1766: $ufile=~s/^[\.\~]+//;
1767:
1768: # IF necessary, create the path right down to the file.
1769: # Note that any regular files in the way of this path are
1770: # wiped out to deal with some earlier folly of mine.
1771:
1772: my $path = $udir;
1773: if ($ufile =~m|(.+)/([^/]+)$|) {
1774: my @parts=split('/',$1);
1775: foreach my $part (@parts) {
1776: $path .= '/'.$part;
1777: if( -f $path) {
1778: unlink($path);
1779: }
1780: if ((-e $path)!=1) {
1781: mkdir($path,0770);
1782: }
1783: }
1784: }
1785:
1786:
1787: my $destname=$udir.'/'.$ufile;
1788: my $transname=$udir.'/'.$ufile.'.in.transit';
1789: my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;
1790: my $response;
1791: Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
1792: alarm(120);
1793: {
1794: my $ua=new LWP::UserAgent;
1795: my $request=new HTTP::Request('GET',"$remoteurl");
1796: $response=$ua->request($request,$transname);
1797: }
1798: alarm(0);
1799: if ($response->is_error()) {
1800: unlink($transname);
1801: my $message=$response->status_line;
1802: &logthis("LWP GET: $message for $fname ($remoteurl)");
1803: &Failure($client, "failed\n", $userinput);
1804: } else {
1805: Debug("Renaming $transname to $destname");
1806: if (!rename($transname,$destname)) {
1807: &logthis("Unable to move $transname to $destname");
1808: unlink($transname);
1809: &Failure($client, "failed\n", $userinput);
1810: } else {
1811: &Reply($client, "ok\n", $userinput);
1812: }
1813: }
1814: } else {
1815: &Failure($client, "not_home\n", $userinput);
1816: }
1817: return 1;
1818: }
1819: ®ister_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
1820:
1821: #
1822: # Remove a file from a user's home directory userfiles subdirectory.
1823: # Parameters:
1824: # cmd - the Lond request keyword that got us here.
1825: # tail - the part of the command past the keyword.
1826: # client- File descriptor connected with the client.
1827: #
1828: # Returns:
1829: # 1 - Continue processing.
1830:
1831: sub remove_user_file_handler {
1832: my ($cmd, $tail, $client) = @_;
1833:
1834: my ($fname) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
1835:
1836: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
1837: if ($ufile =~m|/\.\./|) {
1838: # any files paths with /../ in them refuse
1839: # to deal with
1840: &Failure($client, "refused\n", "$cmd:$tail");
1841: } else {
1842: my $udir = &propath($udom,$uname);
1843: if (-e $udir) {
1844: my $file=$udir.'/userfiles/'.$ufile;
1845: if (-e $file) {
1846: unlink($file);
1847: if (-e $file) {
1848: &Failure($client, "failed\n", "$cmd:$tail");
1849: } else {
1850: &Reply($client, "ok\n", "$cmd:$tail");
1851: }
1852: } else {
1853: &Failure($client, "not_found\n", "$cmd:$tail");
1854: }
1855: } else {
1856: &Failure($client, "not_home\n", "$cmd:$tail");
1857: }
1858: }
1859: return 1;
1860: }
1861: ®ister_handler("removeuserfile", \&remove_user_file_handler, 0,1,0);
1862:
1863:
1864: #
1865: # Authenticate access to a user file by checking the user's
1866: # session token(?)
1867: #
1868: # Parameters:
1869: # cmd - The request keyword that dispatched to tus.
1870: # tail - The tail of the request (colon separated parameters).
1871: # client - Filehandle open on the client.
1872: # Return:
1873: # 1.
1874:
1875: sub token_auth_user_file_handler {
1876: my ($cmd, $tail, $client) = @_;
1877:
1878: my ($fname, $session) = split(/:/, $tail);
1879:
1880: chomp($session);
1881: my $reply='non_auth';
1882: if (open(ENVIN,$perlvar{'lonIDsDir'}.'/'.
1883: $session.'.id')) {
1884: while (my $line=<ENVIN>) {
1885: if ($line=~ m|userfile\.\Q$fname\E\=|) { $reply='ok'; }
1886: }
1887: close(ENVIN);
1888: &Reply($client, $reply);
1889: } else {
1890: &Failure($client, "invalid_token\n", "$cmd:$tail");
1891: }
1892: return 1;
1893:
1894: }
1895:
1896: ®ister_handler("tokenauthuserfile", \&token_auth_user_file_handler, 0,1,0);
1897:
1898:
1899: #
1900: # Unsubscribe from a resource.
1901: #
1902: # Parameters:
1903: # $cmd - The command that got us here.
1904: # $tail - Tail of the command (remaining parameters).
1905: # $client - File descriptor connected to client.
1906: # Returns
1907: # 0 - Requested to exit, caller should shut down.
1908: # 1 - Continue processing.
1909: #
1910: sub unsubscribe_handler {
1911: my ($cmd, $tail, $client) = @_;
1912:
1913: my $userinput= "$cmd:$tail";
1914:
1915: my ($fname) = split(/:/,$tail); # Split in case there's extrs.
1916:
1917: &Debug("Unsubscribing $fname");
1918: if (-e $fname) {
1919: &Debug("Exists");
1920: &Reply($client, &unsub($fname,$clientip), $userinput);
1921: } else {
1922: &Failure($client, "not_found\n", $userinput);
1923: }
1924: return 1;
1925: }
1926: ®ister_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
1927: # Subscribe to a resource
1928: #
1929: # Parameters:
1930: # $cmd - The command that got us here.
1931: # $tail - Tail of the command (remaining parameters).
1932: # $client - File descriptor connected to client.
1933: # Returns
1934: # 0 - Requested to exit, caller should shut down.
1935: # 1 - Continue processing.
1936: #
1937: sub subscribe_handler {
1938: my ($cmd, $tail, $client)= @_;
1939:
1940: my $userinput = "$cmd:$tail";
1941:
1942: &Reply( $client, &subscribe($userinput,$clientip), $userinput);
1943:
1944: return 1;
1945: }
1946: ®ister_handler("sub", \&subscribe_handler, 0, 1, 0);
1947:
1948: #
1949: # Determine the version of a resource (?) Or is it return
1950: # the top version of the resource? Not yet clear from the
1951: # code in currentversion.
1952: #
1953: # Parameters:
1954: # $cmd - The command that got us here.
1955: # $tail - Tail of the command (remaining parameters).
1956: # $client - File descriptor connected to client.
1957: # Returns
1958: # 0 - Requested to exit, caller should shut down.
1959: # 1 - Continue processing.
1960: #
1961: sub current_version_handler {
1962: my ($cmd, $tail, $client) = @_;
1963:
1964: my $userinput= "$cmd:$tail";
1965:
1966: my $fname = $tail;
1967: &Reply( $client, ¤tversion($fname)."\n", $userinput);
1968: return 1;
1969:
1970: }
1971: ®ister_handler("currentversion", \¤t_version_handler, 0, 1, 0);
1972:
1973: # Make an entry in a user's activity log.
1974: #
1975: # Parameters:
1976: # $cmd - The command that got us here.
1977: # $tail - Tail of the command (remaining parameters).
1978: # $client - File descriptor connected to client.
1979: # Returns
1980: # 0 - Requested to exit, caller should shut down.
1981: # 1 - Continue processing.
1982: #
1983: sub activity_log_handler {
1984: my ($cmd, $tail, $client) = @_;
1985:
1986:
1987: my $userinput= "$cmd:$tail";
1988:
1989: my ($udom,$uname,$what)=split(/:/,$tail);
1990: chomp($what);
1991: my $proname=&propath($udom,$uname);
1992: my $now=time;
1993: my $hfh;
1994: if ($hfh=IO::File->new(">>$proname/activity.log")) {
1995: print $hfh "$now:$clientname:$what\n";
1996: &Reply( $client, "ok\n", $userinput);
1997: } else {
1998: &Failure($client, "error: ".($!+0)." IO::File->new Failed "
1999: ."while attempting log\n",
2000: $userinput);
2001: }
2002:
2003: return 1;
2004: }
2005: register_handler("log", \&activity_log_handler, 0, 1, 0);
2006:
2007: #
2008: # Put a namespace entry in a user profile hash.
2009: # My druthers would be for this to be an encrypted interaction too.
2010: # anything that might be an inadvertent covert channel about either
2011: # user authentication or user personal information....
2012: #
2013: # Parameters:
2014: # $cmd - The command that got us here.
2015: # $tail - Tail of the command (remaining parameters).
2016: # $client - File descriptor connected to client.
2017: # Returns
2018: # 0 - Requested to exit, caller should shut down.
2019: # 1 - Continue processing.
2020: #
2021: sub put_user_profile_entry {
2022: my ($cmd, $tail, $client) = @_;
2023:
2024: my $userinput = "$cmd:$tail";
2025:
2026: my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
2027: if ($namespace ne 'roles') {
2028: chomp($what);
2029: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2030: &GDBM_WRCREAT(),"P",$what);
2031: if($hashref) {
2032: my @pairs=split(/\&/,$what);
2033: foreach my $pair (@pairs) {
2034: my ($key,$value)=split(/=/,$pair);
2035: $hashref->{$key}=$value;
2036: }
2037: if (untie(%$hashref)) {
2038: &Reply( $client, "ok\n", $userinput);
2039: } else {
2040: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2041: "while attempting put\n",
2042: $userinput);
2043: }
2044: } else {
2045: &Failure( $client, "error: ".($!)." tie(GDBM) Failed ".
2046: "while attempting put\n", $userinput);
2047: }
2048: } else {
2049: &Failure( $client, "refused\n", $userinput);
2050: }
2051:
2052: return 1;
2053: }
2054: ®ister_handler("put", \&put_user_profile_entry, 0, 1, 0);
2055:
2056: #
2057: # Increment a profile entry in the user history file.
2058: # The history contains keyword value pairs. In this case,
2059: # The value itself is a pair of numbers. The first, the current value
2060: # the second an increment that this function applies to the current
2061: # value.
2062: #
2063: # Parameters:
2064: # $cmd - The command that got us here.
2065: # $tail - Tail of the command (remaining parameters).
2066: # $client - File descriptor connected to client.
2067: # Returns
2068: # 0 - Requested to exit, caller should shut down.
2069: # 1 - Continue processing.
2070: #
2071: sub increment_user_value_handler {
2072: my ($cmd, $tail, $client) = @_;
2073:
2074: my $userinput = "$cmd:$tail";
2075:
2076: my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
2077: if ($namespace ne 'roles') {
2078: chomp($what);
2079: my $hashref = &tie_user_hash($udom, $uname,
2080: $namespace, &GDBM_WRCREAT(),
2081: "P",$what);
2082: if ($hashref) {
2083: my @pairs=split(/\&/,$what);
2084: foreach my $pair (@pairs) {
2085: my ($key,$value)=split(/=/,$pair);
2086: # We could check that we have a number...
2087: if (! defined($value) || $value eq '') {
2088: $value = 1;
2089: }
2090: $hashref->{$key}+=$value;
2091: }
2092: if (untie(%$hashref)) {
2093: &Reply( $client, "ok\n", $userinput);
2094: } else {
2095: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2096: "while attempting inc\n", $userinput);
2097: }
2098: } else {
2099: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2100: "while attempting inc\n", $userinput);
2101: }
2102: } else {
2103: &Failure($client, "refused\n", $userinput);
2104: }
2105:
2106: return 1;
2107: }
2108: ®ister_handler("inc", \&increment_user_value_handler, 0, 1, 0);
2109:
2110:
2111: #
2112: # Put a new role for a user. Roles are LonCAPA's packaging of permissions.
2113: # Each 'role' a user has implies a set of permissions. Adding a new role
2114: # for a person grants the permissions packaged with that role
2115: # to that user when the role is selected.
2116: #
2117: # Parameters:
2118: # $cmd - The command string (rolesput).
2119: # $tail - The remainder of the request line. For rolesput this
2120: # consists of a colon separated list that contains:
2121: # The domain and user that is granting the role (logged).
2122: # The domain and user that is getting the role.
2123: # The roles being granted as a set of & separated pairs.
2124: # each pair a key value pair.
2125: # $client - File descriptor connected to the client.
2126: # Returns:
2127: # 0 - If the daemon should exit
2128: # 1 - To continue processing.
2129: #
2130: #
2131: sub roles_put_handler {
2132: my ($cmd, $tail, $client) = @_;
2133:
2134: my $userinput = "$cmd:$tail";
2135:
2136: my ( $exedom, $exeuser, $udom, $uname, $what) = split(/:/,$tail);
2137:
2138:
2139: my $namespace='roles';
2140: chomp($what);
2141: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2142: &GDBM_WRCREAT(), "P",
2143: "$exedom:$exeuser:$what");
2144: #
2145: # Log the attempt to set a role. The {}'s here ensure that the file
2146: # handle is open for the minimal amount of time. Since the flush
2147: # is done on close this improves the chances the log will be an un-
2148: # corrupted ordered thing.
2149: if ($hashref) {
2150: my @pairs=split(/\&/,$what);
2151: foreach my $pair (@pairs) {
2152: my ($key,$value)=split(/=/,$pair);
2153: &manage_permissions($key, $udom, $uname,
2154: &get_auth_type( $udom, $uname));
2155: $hashref->{$key}=$value;
2156: }
2157: if (untie($hashref)) {
2158: &Reply($client, "ok\n", $userinput);
2159: } else {
2160: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2161: "while attempting rolesput\n", $userinput);
2162: }
2163: } else {
2164: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2165: "while attempting rolesput\n", $userinput);
2166: }
2167: return 1;
2168: }
2169: ®ister_handler("rolesput", \&roles_put_handler, 1,1,0); # Encoded client only.
2170:
2171: #
2172: # Deletes (removes) a role for a user. This is equivalent to removing
2173: # a permissions package associated with the role from the user's profile.
2174: #
2175: # Parameters:
2176: # $cmd - The command (rolesdel)
2177: # $tail - The remainder of the request line. This consists
2178: # of:
2179: # The domain and user requesting the change (logged)
2180: # The domain and user being changed.
2181: # The roles being revoked. These are shipped to us
2182: # as a bunch of & separated role name keywords.
2183: # $client - The file handle open on the client.
2184: # Returns:
2185: # 1 - Continue processing
2186: # 0 - Exit.
2187: #
2188: sub roles_delete_handler {
2189: my ($cmd, $tail, $client) = @_;
2190:
2191: my $userinput = "$cmd:$tail";
2192:
2193: my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
2194: &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.
2195: "what = ".$what);
2196: my $namespace='roles';
2197: chomp($what);
2198: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2199: &GDBM_WRCREAT(), "D",
2200: "$exedom:$exeuser:$what");
2201:
2202: if ($hashref) {
2203: my @rolekeys=split(/\&/,$what);
2204:
2205: foreach my $key (@rolekeys) {
2206: delete $hashref->{$key};
2207: }
2208: if (untie(%$hashref)) {
2209: &Reply($client, "ok\n", $userinput);
2210: } else {
2211: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2212: "while attempting rolesdel\n", $userinput);
2213: }
2214: } else {
2215: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2216: "while attempting rolesdel\n", $userinput);
2217: }
2218:
2219: return 1;
2220: }
2221: ®ister_handler("rolesdel", \&roles_delete_handler, 1,1, 0); # Encoded client only
2222:
2223: # Unencrypted get from a user's profile database. See
2224: # GetProfileEntryEncrypted for a version that does end-to-end encryption.
2225: # This function retrieves a keyed item from a specific named database in the
2226: # user's directory.
2227: #
2228: # Parameters:
2229: # $cmd - Command request keyword (get).
2230: # $tail - Tail of the command. This is a colon separated list
2231: # consisting of the domain and username that uniquely
2232: # identifies the profile,
2233: # The 'namespace' which selects the gdbm file to
2234: # do the lookup in,
2235: # & separated list of keys to lookup. Note that
2236: # the values are returned as an & separated list too.
2237: # $client - File descriptor open on the client.
2238: # Returns:
2239: # 1 - Continue processing.
2240: # 0 - Exit.
2241: #
2242: sub get_profile_entry {
2243: my ($cmd, $tail, $client) = @_;
2244:
2245: my $userinput= "$cmd:$tail";
2246:
2247: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2248: chomp($what);
2249: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2250: &GDBM_READER());
2251: if ($hashref) {
2252: my @queries=split(/\&/,$what);
2253: my $qresult='';
2254:
2255: for (my $i=0;$i<=$#queries;$i++) {
2256: $qresult.="$hashref->{$queries[$i]}&"; # Presumably failure gives empty string.
2257: }
2258: $qresult=~s/\&$//; # Remove trailing & from last lookup.
2259: if (untie(%$hashref)) {
2260: &Reply($client, "$qresult\n", $userinput);
2261: } else {
2262: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2263: "while attempting get\n", $userinput);
2264: }
2265: } else {
2266: if ($!+0 == 2) { # +0 coerces errno -> number 2 is ENOENT
2267: &Failure($client, "error:No such file or ".
2268: "GDBM reported bad block error\n", $userinput);
2269: } else { # Some other undifferentiated err.
2270: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2271: "while attempting get\n", $userinput);
2272: }
2273: }
2274: return 1;
2275: }
2276: ®ister_handler("get", \&get_profile_entry, 0,1,0);
2277:
2278: #
2279: # Process the encrypted get request. Note that the request is sent
2280: # in clear, but the reply is encrypted. This is a small covert channel:
2281: # information about the sensitive keys is given to the snooper. Just not
2282: # information about the values of the sensitive key. Hmm if I wanted to
2283: # know these I'd snoop for the egets. Get the profile item names from them
2284: # and then issue a get for them since there's no enforcement of the
2285: # requirement of an encrypted get for particular profile items. If I
2286: # were re-doing this, I'd force the request to be encrypted as well as the
2287: # reply. I'd also just enforce encrypted transactions for all gets since
2288: # that would prevent any covert channel snooping.
2289: #
2290: # Parameters:
2291: # $cmd - Command keyword of request (eget).
2292: # $tail - Tail of the command. See GetProfileEntry
# for more information about this.
2293: # $client - File open on the client.
2294: # Returns:
2295: # 1 - Continue processing
2296: # 0 - server should exit.
2297: sub get_profile_entry_encrypted {
2298: my ($cmd, $tail, $client) = @_;
2299:
2300: my $userinput = "$cmd:$tail";
2301:
2302: my ($cmd,$udom,$uname,$namespace,$what) = split(/:/,$userinput);
2303: chomp($what);
2304: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2305: &GDBM_READER());
2306: if ($hashref) {
2307: my @queries=split(/\&/,$what);
2308: my $qresult='';
2309: for (my $i=0;$i<=$#queries;$i++) {
2310: $qresult.="$hashref->{$queries[$i]}&";
2311: }
2312: if (untie(%$hashref)) {
2313: $qresult=~s/\&$//;
2314: if ($cipher) {
2315: my $cmdlength=length($qresult);
2316: $qresult.=" ";
2317: my $encqresult='';
2318: for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
2319: $encqresult.= unpack("H16",
2320: $cipher->encrypt(substr($qresult,
2321: $encidx,
2322: 8)));
2323: }
2324: &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
2325: } else {
2326: &Failure( $client, "error:no_key\n", $userinput);
2327: }
2328: } else {
2329: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2330: "while attempting eget\n", $userinput);
2331: }
2332: } else {
2333: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2334: "while attempting eget\n", $userinput);
2335: }
2336:
2337: return 1;
2338: }
2339: ®ister_handler("eget", \&GetProfileEntryEncrypted, 0, 1, 0);
2340: #
2341: # Deletes a key in a user profile database.
2342: #
2343: # Parameters:
2344: # $cmd - Command keyword (del).
2345: # $tail - Command tail. IN this case a colon
2346: # separated list containing:
2347: # The domain and user that identifies uniquely
2348: # the identity of the user.
2349: # The profile namespace (name of the profile
2350: # database file).
2351: # & separated list of keywords to delete.
2352: # $client - File open on client socket.
2353: # Returns:
2354: # 1 - Continue processing
2355: # 0 - Exit server.
2356: #
2357: #
2358:
2359: sub delete_profile_entry {
2360: my ($cmd, $tail, $client) = @_;
2361:
2362: my $userinput = "cmd:$tail";
2363:
2364: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2365: chomp($what);
2366: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2367: &GDBM_WRCREAT(),
2368: "D",$what);
2369: if ($hashref) {
2370: my @keys=split(/\&/,$what);
2371: foreach my $key (@keys) {
2372: delete($hashref->{$key});
2373: }
2374: if (untie(%$hashref)) {
2375: &Reply($client, "ok\n", $userinput);
2376: } else {
2377: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2378: "while attempting del\n", $userinput);
2379: }
2380: } else {
2381: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2382: "while attempting del\n", $userinput);
2383: }
2384: return 1;
2385: }
2386: ®ister_handler("del", \&delete_profile_entry, 0, 1, 0);
2387: #
2388: # List the set of keys that are defined in a profile database file.
2389: # A successful reply from this will contain an & separated list of
2390: # the keys.
2391: # Parameters:
2392: # $cmd - Command request (keys).
2393: # $tail - Remainder of the request, a colon separated
2394: # list containing domain/user that identifies the
2395: # user being queried, and the database namespace
2396: # (database filename essentially).
2397: # $client - File open on the client.
2398: # Returns:
2399: # 1 - Continue processing.
2400: # 0 - Exit the server.
2401: #
2402: sub get_profile_keys {
2403: my ($cmd, $tail, $client) = @_;
2404:
2405: my $userinput = "$cmd:$tail";
2406:
2407: my ($udom,$uname,$namespace)=split(/:/,$tail);
2408: my $qresult='';
2409: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2410: &GDBM_READER());
2411: if ($hashref) {
2412: foreach my $key (keys %$hashref) {
2413: $qresult.="$key&";
2414: }
2415: if (untie(%$hashref)) {
2416: $qresult=~s/\&$//;
2417: &Reply($client, "$qresult\n", $userinput);
2418: } else {
2419: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2420: "while attempting keys\n", $userinput);
2421: }
2422: } else {
2423: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2424: "while attempting keys\n", $userinput);
2425: }
2426:
2427: return 1;
2428: }
2429: ®ister_handler("keys", \&get_profile_keys, 0, 1, 0);
2430:
2431: #
2432: # Dump the contents of a user profile database.
2433: # Note that this constitutes a very large covert channel too since
2434: # the dump will return sensitive information that is not encrypted.
2435: # The naive security assumption is that the session negotiation ensures
2436: # our client is trusted and I don't believe that's assured at present.
2437: # Sure want badly to go to ssl or tls. Of course if my peer isn't really
2438: # a LonCAPA node they could have negotiated an encryption key too so >sigh<.
2439: #
2440: # Parameters:
2441: # $cmd - The command request keyword (currentdump).
2442: # $tail - Remainder of the request, consisting of a colon
2443: # separated list that has the domain/username and
2444: # the namespace to dump (database file).
2445: # $client - file open on the remote client.
2446: # Returns:
2447: # 1 - Continue processing.
2448: # 0 - Exit the server.
2449: #
2450: sub dump_profile_database {
2451: my ($cmd, $tail, $client) = @_;
2452:
2453: my $userinput = "$cmd:$tail";
2454:
2455: my ($udom,$uname,$namespace) = split(/:/,$tail);
2456: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2457: &GDBM_READER());
2458: if ($hashref) {
2459: # Structure of %data:
2460: # $data{$symb}->{$parameter}=$value;
2461: # $data{$symb}->{'v.'.$parameter}=$version;
2462: # since $parameter will be unescaped, we do not
2463: # have to worry about silly parameter names...
2464:
2465: my $qresult='';
2466: my %data = (); # A hash of anonymous hashes..
2467: while (my ($key,$value) = each(%$hashref)) {
2468: my ($v,$symb,$param) = split(/:/,$key);
2469: next if ($v eq 'version' || $symb eq 'keys');
2470: next if (exists($data{$symb}) &&
2471: exists($data{$symb}->{$param}) &&
2472: $data{$symb}->{'v.'.$param} > $v);
2473: $data{$symb}->{$param}=$value;
2474: $data{$symb}->{'v.'.$param}=$v;
2475: }
2476: if (untie(%$hashref)) {
2477: while (my ($symb,$param_hash) = each(%data)) {
2478: while(my ($param,$value) = each (%$param_hash)){
2479: next if ($param =~ /^v\./); # Ignore versions...
2480: #
2481: # Just dump the symb=value pairs separated by &
2482: #
2483: $qresult.=$symb.':'.$param.'='.$value.'&';
2484: }
2485: }
2486: chop($qresult);
2487: &Reply($client , "$qresult\n", $userinput);
2488: } else {
2489: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2490: "while attempting currentdump\n", $userinput);
2491: }
2492: } else {
2493: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2494: "while attempting currentdump\n", $userinput);
2495: }
2496:
2497: return 1;
2498: }
2499: ®ister_handler("currentdump", \&dump_profile_database, 0, 1, 0);
2500:
2501: #
2502: # Dump a profile database with an optional regular expression
2503: # to match against the keys. In this dump, no effort is made
2504: # to separate symb from version information. Presumably the
2505: # databases that are dumped by this command are of a different
2506: # structure. Need to look at this and improve the documentation of
2507: # both this and the currentdump handler.
2508: # Parameters:
2509: # $cmd - The command keyword.
2510: # $tail - All of the characters after the $cmd:
2511: # These are expected to be a colon
2512: # separated list containing:
2513: # domain/user - identifying the user.
2514: # namespace - identifying the database.
2515: # regexp - optional regular expression
2516: # that is matched against
2517: # database keywords to do
2518: # selective dumps.
2519: # $client - Channel open on the client.
2520: # Returns:
2521: # 1 - Continue processing.
2522: # Side effects:
2523: # response is written to $client.
2524: #
2525: sub dump_with_regexp {
2526: my ($cmd, $tail, $client) = @_;
2527:
2528:
2529: my $userinput = "$cmd:$tail";
2530:
2531: my ($udom,$uname,$namespace,$regexp)=split(/:/,$tail);
2532: if (defined($regexp)) {
2533: $regexp=&unescape($regexp);
2534: } else {
2535: $regexp='.';
2536: }
2537: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2538: &GDBM_READER());
2539: if ($hashref) {
2540: my $qresult='';
2541: while (my ($key,$value) = each(%$hashref)) {
2542: if ($regexp eq '.') {
2543: $qresult.=$key.'='.$value.'&';
2544: } else {
2545: my $unescapeKey = &unescape($key);
2546: if (eval('$unescapeKey=~/$regexp/')) {
2547: $qresult.="$key=$value&";
2548: }
2549: }
2550: }
2551: if (untie(%$hashref)) {
2552: chop($qresult);
2553: &Reply($client, "$qresult\n", $userinput);
2554: } else {
2555: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2556: "while attempting dump\n", $userinput);
2557: }
2558: } else {
2559: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2560: "while attempting dump\n", $userinput);
2561: }
2562:
2563: return 1;
2564: }
2565:
2566: ®ister_handler("dump", \&dump_with_regexp, 0, 1, 0);
2567:
2568: # Store a set of key=value pairs associated with a versioned name.
2569: #
2570: # Parameters:
2571: # $cmd - Request command keyword.
2572: # $tail - Tail of the request. This is a colon
2573: # separated list containing:
2574: # domain/user - User and authentication domain.
2575: # namespace - Name of the database being modified
2576: # rid - Resource keyword to modify.
2577: # what - new value associated with rid.
2578: #
2579: # $client - Socket open on the client.
2580: #
2581: #
2582: # Returns:
2583: # 1 (keep on processing).
2584: # Side-Effects:
2585: # Writes to the client
2586: sub store_handler {
2587: my ($cmd, $tail, $client) = @_;
2588:
2589: my $userinput = "$cmd:$tail";
2590:
2591: my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);
2592: if ($namespace ne 'roles') {
2593:
2594: chomp($what);
2595: my @pairs=split(/\&/,$what);
2596: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2597: &GDBM_WRCREAT(), "P",
2598: "$rid:$what");
2599: if ($hashref) {
2600: my $now = time;
2601: my @previouskeys=split(/&/,$hashref->{"keys:$rid"});
2602: my $key;
2603: $hashref->{"version:$rid"}++;
2604: my $version=$hashref->{"version:$rid"};
2605: my $allkeys='';
2606: foreach my $pair (@pairs) {
2607: my ($key,$value)=split(/=/,$pair);
2608: $allkeys.=$key.':';
2609: $hashref->{"$version:$rid:$key"}=$value;
2610: }
2611: $hashref->{"$version:$rid:timestamp"}=$now;
2612: $allkeys.='timestamp';
2613: $hashref->{"$version:keys:$rid"}=$allkeys;
2614: if (untie($hashref)) {
2615: &Reply($client, "ok\n", $userinput);
2616: } else {
2617: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2618: "while attempting store\n", $userinput);
2619: }
2620: } else {
2621: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2622: "while attempting store\n", $userinput);
2623: }
2624: } else {
2625: &Failure($client, "refused\n", $userinput);
2626: }
2627:
2628: return 1;
2629: }
2630: ®ister_handler("store", \&store_handler, 0, 1, 0);
2631: #
2632: # Dump out all versions of a resource that has key=value pairs associated
2633: # with it for each version. These resources are built up via the store
2634: # command.
2635: #
2636: # Parameters:
2637: # $cmd - Command keyword.
2638: # $tail - Remainder of the request which consists of:
2639: # domain/user - User and auth. domain.
2640: # namespace - name of resource database.
2641: # rid - Resource id.
2642: # $client - socket open on the client.
2643: #
2644: # Returns:
2645: # 1 indicating the caller should not yet exit.
2646: # Side-effects:
2647: # Writes a reply to the client.
2648: # The reply is a string of the following shape:
2649: # version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
2650: # Where the 1 above represents version 1.
2651: # this continues for all pairs of keys in all versions.
2652: #
2653: #
2654: #
2655: #
2656: sub restore_handler {
2657: my ($cmd, $tail, $client) = @_;
2658:
2659: my $userinput = "$cmd:$tail"; # Only used for logging purposes.
2660:
2661: my ($cmd,$udom,$uname,$namespace,$rid) = split(/:/,$userinput);
2662: $namespace=~s/\//\_/g;
2663: $namespace=~s/\W//g;
2664: chomp($rid);
2665: my $proname=&propath($udom,$uname);
2666: my $qresult='';
2667: my %hash;
2668: if (tie(%hash,'GDBM_File',"$proname/$namespace.db",
2669: &GDBM_READER(),0640)) {
2670: my $version=$hash{"version:$rid"};
2671: $qresult.="version=$version&";
2672: my $scope;
2673: for ($scope=1;$scope<=$version;$scope++) {
2674: my $vkeys=$hash{"$scope:keys:$rid"};
2675: my @keys=split(/:/,$vkeys);
2676: my $key;
2677: $qresult.="$scope:keys=$vkeys&";
2678: foreach $key (@keys) {
2679: $qresult.="$scope:$key=".$hash{"$scope:$rid:$key"}."&";
2680: }
2681: }
2682: if (untie(%hash)) {
2683: $qresult=~s/\&$//;
2684: &Reply( $client, "$qresult\n", $userinput);
2685: } else {
2686: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2687: "while attempting restore\n", $userinput);
2688: }
2689: } else {
2690: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2691: "while attempting restore\n", $userinput);
2692: }
2693:
2694: return 1;
2695:
2696:
2697: }
2698: ®ister_handler("restore", \&restore_handler, 0,1,0);
2699: #
2700: #
2701: #---------------------------------------------------------------
2702: #
2703: # Getting, decoding and dispatching requests:
2704: #
2705:
2706: #
2707: # Get a Request:
2708: # Gets a Request message from the client. The transaction
2709: # is defined as a 'line' of text. We remove the new line
2710: # from the text line.
2711: #
2712: sub get_request {
2713: my $input = <$client>;
2714: chomp($input);
2715:
2716: Debug("get_request: Request = $input\n");
2717:
2718: &status('Processing '.$clientname.':'.$input);
2719:
2720: return $input;
2721: }
2722: #---------------------------------------------------------------
2723: #
2724: # Process a request. This sub should shrink as each action
2725: # gets farmed out into a separat sub that is registered
2726: # with the dispatch hash.
2727: #
2728: # Parameters:
2729: # user_input - The request received from the client (lonc).
2730: # Returns:
2731: # true to keep processing, false if caller should exit.
2732: #
2733: sub process_request {
2734: my ($userinput) = @_; # Easier for now to break style than to
2735: # fix all the userinput -> user_input.
2736: my $wasenc = 0; # True if request was encrypted.
2737: # ------------------------------------------------------------ See if encrypted
2738: if ($userinput =~ /^enc/) {
2739: $userinput = decipher($userinput);
2740: $wasenc=1;
2741: if(!$userinput) { # Cipher not defined.
2742: &Failure($client, "error: Encrypted data without negotated key");
2743: return 0;
2744: }
2745: }
2746: Debug("process_request: $userinput\n");
2747:
2748: #
2749: # The 'correct way' to add a command to lond is now to
2750: # write a sub to execute it and Add it to the command dispatch
2751: # hash via a call to register_handler.. The comments to that
2752: # sub should give you enough to go on to show how to do this
2753: # along with the examples that are building up as this code
2754: # is getting refactored. Until all branches of the
2755: # if/elseif monster below have been factored out into
2756: # separate procesor subs, if the dispatch hash is missing
2757: # the command keyword, we will fall through to the remainder
2758: # of the if/else chain below in order to keep this thing in
2759: # working order throughout the transmogrification.
2760:
2761: my ($command, $tail) = split(/:/, $userinput, 2);
2762: chomp($command);
2763: chomp($tail);
2764: $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
2765: $command =~ s/(\r)//; # And this too for parameterless commands.
2766: if(!$tail) {
2767: $tail =""; # defined but blank.
2768: }
2769:
2770: &Debug("Command received: $command, encoded = $wasenc");
2771:
2772: if(defined $Dispatcher{$command}) {
2773:
2774: my $dispatch_info = $Dispatcher{$command};
2775: my $handler = $$dispatch_info[0];
2776: my $need_encode = $$dispatch_info[1];
2777: my $client_types = $$dispatch_info[2];
2778: Debug("Matched dispatch hash: mustencode: $need_encode "
2779: ."ClientType $client_types");
2780:
2781: # Validate the request:
2782:
2783: my $ok = 1;
2784: my $requesterprivs = 0;
2785: if(&isClient()) {
2786: $requesterprivs |= $CLIENT_OK;
2787: }
2788: if(&isManager()) {
2789: $requesterprivs |= $MANAGER_OK;
2790: }
2791: if($need_encode && (!$wasenc)) {
2792: Debug("Must encode but wasn't: $need_encode $wasenc");
2793: $ok = 0;
2794: }
2795: if(($client_types & $requesterprivs) == 0) {
2796: Debug("Client not privileged to do this operation");
2797: $ok = 0;
2798: }
2799:
2800: if($ok) {
2801: Debug("Dispatching to handler $command $tail");
2802: my $keep_going = &$handler($command, $tail, $client);
2803: return $keep_going;
2804: } else {
2805: Debug("Refusing to dispatch because client did not match requirements");
2806: Failure($client, "refused\n", $userinput);
2807: return 1;
2808: }
2809:
2810: }
2811:
2812: #------------------- Commands not yet in spearate handlers. --------------
2813:
2814:
2815:
2816: # -------------------------------------------------------------------- chatsend
2817: if ($userinput =~ /^chatsend/) {
2818: if(isClient) {
2819: my ($cmd,$cdom,$cnum,$newpost)=split(/\:/,$userinput);
2820: &chatadd($cdom,$cnum,$newpost);
2821: print $client "ok\n";
2822: } else {
2823: Reply($client, "refused\n", $userinput);
2824:
2825: }
2826: # -------------------------------------------------------------------- chatretr
2827: } elsif ($userinput =~ /^chatretr/) {
2828: if(isClient) {
2829: my
2830: ($cmd,$cdom,$cnum,$udom,$uname)=split(/\:/,$userinput);
2831: my $reply='';
2832: foreach (&getchat($cdom,$cnum,$udom,$uname)) {
2833: $reply.=&escape($_).':';
2834: }
2835: $reply=~s/\:$//;
2836: print $client $reply."\n";
2837: } else {
2838: Reply($client, "refused\n", $userinput);
2839:
2840: }
2841: # ------------------------------------------------------------------- querysend
2842: } elsif ($userinput =~ /^querysend/) {
2843: if (isClient) {
2844: my ($cmd,$query,
2845: $arg1,$arg2,$arg3)=split(/\:/,$userinput);
2846: $query=~s/\n*$//g;
2847: print $client "".
2848: sqlreply("$clientname\&$query".
2849: "\&$arg1"."\&$arg2"."\&$arg3")."\n";
2850: } else {
2851: Reply($client, "refused\n", $userinput);
2852:
2853: }
2854: # ------------------------------------------------------------------ queryreply
2855: } elsif ($userinput =~ /^queryreply/) {
2856: if(isClient) {
2857: my ($cmd,$id,$reply)=split(/:/,$userinput);
2858: my $store;
2859: my $execdir=$perlvar{'lonDaemons'};
2860: if ($store=IO::File->new(">$execdir/tmp/$id")) {
2861: $reply=~s/\&/\n/g;
2862: print $store $reply;
2863: close $store;
2864: my $store2=IO::File->new(">$execdir/tmp/$id.end");
2865: print $store2 "done\n";
2866: close $store2;
2867: print $client "ok\n";
2868: } else {
2869: print $client "error: ".($!+0)
2870: ." IO::File->new Failed ".
2871: "while attempting queryreply\n";
2872: }
2873: } else {
2874: Reply($client, "refused\n", $userinput);
2875:
2876: }
2877: # ----------------------------------------------------------------- courseidput
2878: } elsif ($userinput =~ /^courseidput/) {
2879: if(isClient) {
2880: my ($cmd,$udom,$what)=split(/:/,$userinput);
2881: chomp($what);
2882: $udom=~s/\W//g;
2883: my $proname=
2884: "$perlvar{'lonUsersDir'}/$udom/nohist_courseids";
2885: my $now=time;
2886: my @pairs=split(/\&/,$what);
2887: my %hash;
2888: if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_WRCREAT(),0640)) {
2889: foreach my $pair (@pairs) {
2890: my ($key,$descr,$inst_code)=split(/=/,$pair);
2891: $hash{$key}=$descr.':'.$inst_code.':'.$now;
2892: }
2893: if (untie(%hash)) {
2894: print $client "ok\n";
2895: } else {
2896: print $client "error: ".($!+0)
2897: ." untie(GDBM) Failed ".
2898: "while attempting courseidput\n";
2899: }
2900: } else {
2901: print $client "error: ".($!+0)
2902: ." tie(GDBM) Failed ".
2903: "while attempting courseidput\n";
2904: }
2905: } else {
2906: Reply($client, "refused\n", $userinput);
2907:
2908: }
2909: # ---------------------------------------------------------------- courseiddump
2910: } elsif ($userinput =~ /^courseiddump/) {
2911: if(isClient) {
2912: my ($cmd,$udom,$since,$description)
2913: =split(/:/,$userinput);
2914: if (defined($description)) {
2915: $description=&unescape($description);
2916: } else {
2917: $description='.';
2918: }
2919: unless (defined($since)) { $since=0; }
2920: my $qresult='';
2921: my $proname=
2922: "$perlvar{'lonUsersDir'}/$udom/nohist_courseids";
2923: my %hash;
2924: if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_READER(),0640)) {
2925: while (my ($key,$value) = each(%hash)) {
2926: my ($descr,$lasttime,$inst_code);
2927: if ($value =~ m/^([^\:]*):([^\:]*):(\d+)$/) {
2928: ($descr,$inst_code,$lasttime)=($1,$2,$3);
2929: } else {
2930: ($descr,$lasttime) = split(/\:/,$value);
2931: }
2932: if ($lasttime<$since) { next; }
2933: if ($description eq '.') {
2934: $qresult.=$key.'='.$descr.':'.$inst_code.'&';
2935: } else {
2936: my $unescapeVal = &unescape($descr);
2937: if (eval('$unescapeVal=~/\Q$description\E/i')) {
2938: $qresult.=$key.'='.$descr.':'.$inst_code.'&';
2939: }
2940: }
2941: }
2942: if (untie(%hash)) {
2943: chop($qresult);
2944: print $client "$qresult\n";
2945: } else {
2946: print $client "error: ".($!+0)
2947: ." untie(GDBM) Failed ".
2948: "while attempting courseiddump\n";
2949: }
2950: } else {
2951: print $client "error: ".($!+0)
2952: ." tie(GDBM) Failed ".
2953: "while attempting courseiddump\n";
2954: }
2955: } else {
2956: Reply($client, "refused\n", $userinput);
2957:
2958: }
2959: # ----------------------------------------------------------------------- idput
2960: } elsif ($userinput =~ /^idput/) {
2961: if(isClient) {
2962: my ($cmd,$udom,$what)=split(/:/,$userinput);
2963: chomp($what);
2964: $udom=~s/\W//g;
2965: my $proname="$perlvar{'lonUsersDir'}/$udom/ids";
2966: my $now=time;
2967: my @pairs=split(/\&/,$what);
2968: my %hash;
2969: if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_WRCREAT(),0640)) {
2970: {
2971: my $hfh;
2972: if ($hfh=IO::File->new(">>$proname.hist")) {
2973: print $hfh "P:$now:$what\n";
2974: }
2975: }
2976: foreach my $pair (@pairs) {
2977: my ($key,$value)=split(/=/,$pair);
2978: $hash{$key}=$value;
2979: }
2980: if (untie(%hash)) {
2981: print $client "ok\n";
2982: } else {
2983: print $client "error: ".($!+0)
2984: ." untie(GDBM) Failed ".
2985: "while attempting idput\n";
2986: }
2987: } else {
2988: print $client "error: ".($!+0)
2989: ." tie(GDBM) Failed ".
2990: "while attempting idput\n";
2991: }
2992: } else {
2993: Reply($client, "refused\n", $userinput);
2994:
2995: }
2996: # ----------------------------------------------------------------------- idget
2997: } elsif ($userinput =~ /^idget/) {
2998: if(isClient) {
2999: my ($cmd,$udom,$what)=split(/:/,$userinput);
3000: chomp($what);
3001: $udom=~s/\W//g;
3002: my $proname="$perlvar{'lonUsersDir'}/$udom/ids";
3003: my @queries=split(/\&/,$what);
3004: my $qresult='';
3005: my %hash;
3006: if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_READER(),0640)) {
3007: for (my $i=0;$i<=$#queries;$i++) {
3008: $qresult.="$hash{$queries[$i]}&";
3009: }
3010: if (untie(%hash)) {
3011: $qresult=~s/\&$//;
3012: print $client "$qresult\n";
3013: } else {
3014: print $client "error: ".($!+0)
3015: ." untie(GDBM) Failed ".
3016: "while attempting idget\n";
3017: }
3018: } else {
3019: print $client "error: ".($!+0)
3020: ." tie(GDBM) Failed ".
3021: "while attempting idget\n";
3022: }
3023: } else {
3024: Reply($client, "refused\n", $userinput);
3025:
3026: }
3027: # ---------------------------------------------------------------------- tmpput
3028: } elsif ($userinput =~ /^tmpput/) {
3029: if(isClient) {
3030: my ($cmd,$what)=split(/:/,$userinput);
3031: my $store;
3032: $tmpsnum++;
3033: my $id=$$.'_'.$clientip.'_'.$tmpsnum;
3034: $id=~s/\W/\_/g;
3035: $what=~s/\n//g;
3036: my $execdir=$perlvar{'lonDaemons'};
3037: if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
3038: print $store $what;
3039: close $store;
3040: print $client "$id\n";
3041: }
3042: else {
3043: print $client "error: ".($!+0)
3044: ."IO::File->new Failed ".
3045: "while attempting tmpput\n";
3046: }
3047: } else {
3048: Reply($client, "refused\n", $userinput);
3049:
3050: }
3051:
3052: # ---------------------------------------------------------------------- tmpget
3053: } elsif ($userinput =~ /^tmpget/) {
3054: if(isClient) {
3055: my ($cmd,$id)=split(/:/,$userinput);
3056: chomp($id);
3057: $id=~s/\W/\_/g;
3058: my $store;
3059: my $execdir=$perlvar{'lonDaemons'};
3060: if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
3061: my $reply=<$store>;
3062: print $client "$reply\n";
3063: close $store;
3064: }
3065: else {
3066: print $client "error: ".($!+0)
3067: ."IO::File->new Failed ".
3068: "while attempting tmpget\n";
3069: }
3070: } else {
3071: Reply($client, "refused\n", $userinput);
3072:
3073: }
3074: # ---------------------------------------------------------------------- tmpdel
3075: } elsif ($userinput =~ /^tmpdel/) {
3076: if(isClient) {
3077: my ($cmd,$id)=split(/:/,$userinput);
3078: chomp($id);
3079: $id=~s/\W/\_/g;
3080: my $execdir=$perlvar{'lonDaemons'};
3081: if (unlink("$execdir/tmp/$id.tmp")) {
3082: print $client "ok\n";
3083: } else {
3084: print $client "error: ".($!+0)
3085: ."Unlink tmp Failed ".
3086: "while attempting tmpdel\n";
3087: }
3088: } else {
3089: Reply($client, "refused\n", $userinput);
3090:
3091: }
3092: # ----------------------------------------- portfolio directory list (portls)
3093: } elsif ($userinput =~ /^portls/) {
3094: if(isClient) {
3095: my ($cmd,$uname,$udom)=split(/:/,$userinput);
3096: my $udir=propath($udom,$uname).'/userfiles/portfolio';
3097: my $dirLine='';
3098: my $dirContents='';
3099: if (opendir(LSDIR,$udir.'/')){
3100: while ($dirLine = readdir(LSDIR)){
3101: $dirContents = $dirContents.$dirLine.'<br />';
3102: }
3103: } else {
3104: $dirContents = "No directory found\n";
3105: }
3106: print $client $dirContents."\n";
3107: } else {
3108: Reply($client, "refused\n", $userinput);
3109: }
3110: # -------------------------------------------------------------------------- ls
3111: } elsif ($userinput =~ /^ls/) {
3112: if(isClient) {
3113: my $obs;
3114: my $rights;
3115: my ($cmd,$ulsdir)=split(/:/,$userinput);
3116: my $ulsout='';
3117: my $ulsfn;
3118: if (-e $ulsdir) {
3119: if(-d $ulsdir) {
3120: if (opendir(LSDIR,$ulsdir)) {
3121: while ($ulsfn=readdir(LSDIR)) {
3122: undef $obs, $rights;
3123: my @ulsstats=stat($ulsdir.'/'.$ulsfn);
3124: #We do some obsolete checking here
3125: if(-e $ulsdir.'/'.$ulsfn.".meta") {
3126: open(FILE, $ulsdir.'/'.$ulsfn.".meta");
3127: my @obsolete=<FILE>;
3128: foreach my $obsolete (@obsolete) {
3129: if($obsolete =~ m|(<obsolete>)(on)|) { $obs = 1; }
3130: if($obsolete =~ m|(<copyright>)(default)|) { $rights = 1; }
3131: }
3132: }
3133: $ulsout.=$ulsfn.'&'.join('&',@ulsstats);
3134: if($obs eq '1') { $ulsout.="&1"; }
3135: else { $ulsout.="&0"; }
3136: if($rights eq '1') { $ulsout.="&1:"; }
3137: else { $ulsout.="&0:"; }
3138: }
3139: closedir(LSDIR);
3140: }
3141: } else {
3142: my @ulsstats=stat($ulsdir);
3143: $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
3144: }
3145: } else {
3146: $ulsout='no_such_dir';
3147: }
3148: if ($ulsout eq '') { $ulsout='empty'; }
3149: print $client "$ulsout\n";
3150: } else {
3151: Reply($client, "refused\n", $userinput);
3152:
3153: }
3154: # ----------------------------------------------------------------- setannounce
3155: } elsif ($userinput =~ /^setannounce/) {
3156: if (isClient) {
3157: my ($cmd,$announcement)=split(/:/,$userinput);
3158: chomp($announcement);
3159: $announcement=&unescape($announcement);
3160: if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
3161: '/announcement.txt')) {
3162: print $store $announcement;
3163: close $store;
3164: print $client "ok\n";
3165: } else {
3166: print $client "error: ".($!+0)."\n";
3167: }
3168: } else {
3169: Reply($client, "refused\n", $userinput);
3170:
3171: }
3172: # ------------------------------------------------------------------ Hanging up
3173: } elsif (($userinput =~ /^exit/) ||
3174: ($userinput =~ /^init/)) { # no restrictions.
3175: &logthis(
3176: "Client $clientip ($clientname) hanging up: $userinput");
3177: print $client "bye\n";
3178: $client->shutdown(2); # shutdown the socket forcibly.
3179: $client->close();
3180: return 0;
3181:
3182: # ---------------------------------- set current host/domain
3183: } elsif ($userinput =~ /^sethost/) {
3184: if (isClient) {
3185: print $client &sethost($userinput)."\n";
3186: } else {
3187: print $client "refused\n";
3188: }
3189: #---------------------------------- request file (?) version.
3190: } elsif ($userinput =~/^version/) {
3191: if (isClient) {
3192: print $client &version($userinput)."\n";
3193: } else {
3194: print $client "refused\n";
3195: }
3196: #------------------------------- is auto-enrollment enabled?
3197: } elsif ($userinput =~/^autorun/) {
3198: if (isClient) {
3199: my ($cmd,$cdom) = split(/:/,$userinput);
3200: my $outcome = &localenroll::run($cdom);
3201: print $client "$outcome\n";
3202: } else {
3203: print $client "0\n";
3204: }
3205: #------------------------------- get official sections (for auto-enrollment).
3206: } elsif ($userinput =~/^autogetsections/) {
3207: if (isClient) {
3208: my ($cmd,$coursecode,$cdom)=split(/:/,$userinput);
3209: my @secs = &localenroll::get_sections($coursecode,$cdom);
3210: my $seclist = &escape(join(':',@secs));
3211: print $client "$seclist\n";
3212: } else {
3213: print $client "refused\n";
3214: }
3215: #----------------------- validate owner of new course section (for auto-enrollment).
3216: } elsif ($userinput =~/^autonewcourse/) {
3217: if (isClient) {
3218: my ($cmd,$inst_course_id,$owner,$cdom)=split(/:/,$userinput);
3219: my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom);
3220: print $client "$outcome\n";
3221: } else {
3222: print $client "refused\n";
3223: }
3224: #-------------- validate course section in schedule of classes (for auto-enrollment).
3225: } elsif ($userinput =~/^autovalidatecourse/) {
3226: if (isClient) {
3227: my ($cmd,$inst_course_id,$cdom)=split(/:/,$userinput);
3228: my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
3229: print $client "$outcome\n";
3230: } else {
3231: print $client "refused\n";
3232: }
3233: #--------------------------- create password for new user (for auto-enrollment).
3234: } elsif ($userinput =~/^autocreatepassword/) {
3235: if (isClient) {
3236: my ($cmd,$authparam,$cdom)=split(/:/,$userinput);
3237: my ($create_passwd,$authchk);
3238: ($authparam,$create_passwd,$authchk) = &localenroll::create_password($authparam,$cdom);
3239: print $client &escape($authparam.':'.$create_passwd.':'.$authchk)."\n";
3240: } else {
3241: print $client "refused\n";
3242: }
3243: #--------------------------- read and remove temporary files (for auto-enrollment).
3244: } elsif ($userinput =~/^autoretrieve/) {
3245: if (isClient) {
3246: my ($cmd,$filename) = split(/:/,$userinput);
3247: my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
3248: if ( (-e $source) && ($filename ne '') ) {
3249: my $reply = '';
3250: if (open(my $fh,$source)) {
3251: while (<$fh>) {
3252: chomp($_);
3253: $_ =~ s/^\s+//g;
3254: $_ =~ s/\s+$//g;
3255: $reply .= $_;
3256: }
3257: close($fh);
3258: print $client &escape($reply)."\n";
3259: # unlink($source);
3260: } else {
3261: print $client "error\n";
3262: }
3263: } else {
3264: print $client "error\n";
3265: }
3266: } else {
3267: print $client "refused\n";
3268: }
3269: #--------------------- read and retrieve institutional code format (for support form).
3270: } elsif ($userinput =~/^autoinstcodeformat/) {
3271: if (isClient) {
3272: my $reply;
3273: my($cmd,$cdom,$course) = split(/:/,$userinput);
3274: my @pairs = split/\&/,$course;
3275: my %instcodes = ();
3276: my %codes = ();
3277: my @codetitles = ();
3278: my %cat_titles = ();
3279: my %cat_order = ();
3280: foreach (@pairs) {
3281: my ($key,$value) = split/=/,$_;
3282: $instcodes{&unescape($key)} = &unescape($value);
3283: }
3284: my $formatreply = &localenroll::instcode_format($cdom,\%instcodes,\%codes,\@codetitles,\%cat_titles,\%cat_order);
3285: if ($formatreply eq 'ok') {
3286: my $codes_str = &hash2str(%codes);
3287: my $codetitles_str = &array2str(@codetitles);
3288: my $cat_titles_str = &hash2str(%cat_titles);
3289: my $cat_order_str = &hash2str(%cat_order);
3290: print $client $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'.$cat_order_str."\n";
3291: }
3292: } else {
3293: print $client "refused\n";
3294: }
3295: # ------------------------------------------------------------- unknown command
3296:
3297: } else {
3298: # unknown command
3299: print $client "unknown_cmd\n";
3300: }
3301: # -------------------------------------------------------------------- complete
3302: Debug("process_request - returning 1");
3303: return 1;
3304: }
3305: #
3306: # Decipher encoded traffic
3307: # Parameters:
3308: # input - Encoded data.
3309: # Returns:
3310: # Decoded data or undef if encryption key was not yet negotiated.
3311: # Implicit input:
3312: # cipher - This global holds the negotiated encryption key.
3313: #
3314: sub decipher {
3315: my ($input) = @_;
3316: my $output = '';
3317:
3318:
3319: if($cipher) {
3320: my($enc, $enclength, $encinput) = split(/:/, $input);
3321: for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
3322: $output .=
3323: $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
3324: }
3325: return substr($output, 0, $enclength);
3326: } else {
3327: return undef;
3328: }
3329: }
3330:
3331: #
3332: # Register a command processor. This function is invoked to register a sub
3333: # to process a request. Once registered, the ProcessRequest sub can automatically
3334: # dispatch requests to an appropriate sub, and do the top level validity checking
3335: # as well:
3336: # - Is the keyword recognized.
3337: # - Is the proper client type attempting the request.
3338: # - Is the request encrypted if it has to be.
3339: # Parameters:
3340: # $request_name - Name of the request being registered.
3341: # This is the command request that will match
3342: # against the hash keywords to lookup the information
3343: # associated with the dispatch information.
3344: # $procedure - Reference to a sub to call to process the request.
3345: # All subs get called as follows:
3346: # Procedure($cmd, $tail, $replyfd, $key)
3347: # $cmd - the actual keyword that invoked us.
3348: # $tail - the tail of the request that invoked us.
3349: # $replyfd- File descriptor connected to the client
3350: # $must_encode - True if the request must be encoded to be good.
3351: # $client_ok - True if it's ok for a client to request this.
3352: # $manager_ok - True if it's ok for a manager to request this.
3353: # Side effects:
3354: # - On success, the Dispatcher hash has an entry added for the key $RequestName
3355: # - On failure, the program will die as it's a bad internal bug to try to
3356: # register a duplicate command handler.
3357: #
3358: sub register_handler {
3359: my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok) = @_;
3360:
3361: # Don't allow duplication#
3362:
3363: if (defined $Dispatcher{$request_name}) {
3364: die "Attempting to define a duplicate request handler for $request_name\n";
3365: }
3366: # Build the client type mask:
3367:
3368: my $client_type_mask = 0;
3369: if($client_ok) {
3370: $client_type_mask |= $CLIENT_OK;
3371: }
3372: if($manager_ok) {
3373: $client_type_mask |= $MANAGER_OK;
3374: }
3375:
3376: # Enter the hash:
3377:
3378: my @entry = ($procedure, $must_encode, $client_type_mask);
3379:
3380: $Dispatcher{$request_name} = \@entry;
3381:
3382: }
3383:
3384:
3385: #------------------------------------------------------------------
3386:
3387:
3388:
3389:
3390: #
3391: # Convert an error return code from lcpasswd to a string value.
3392: #
3393: sub lcpasswdstrerror {
3394: my $ErrorCode = shift;
3395: if(($ErrorCode < 0) || ($ErrorCode > $lastpwderror)) {
3396: return "lcpasswd Unrecognized error return value ".$ErrorCode;
3397: } else {
3398: return $passwderrors[$ErrorCode];
3399: }
3400: }
3401:
3402: #
3403: # Convert an error return code from lcuseradd to a string value:
3404: #
3405: sub lcuseraddstrerror {
3406: my $ErrorCode = shift;
3407: if(($ErrorCode < 0) || ($ErrorCode > $lastadderror)) {
3408: return "lcuseradd - Unrecognized error code: ".$ErrorCode;
3409: } else {
3410: return $adderrors[$ErrorCode];
3411: }
3412: }
3413:
3414: # grabs exception and records it to log before exiting
3415: sub catchexception {
3416: my ($error)=@_;
3417: $SIG{'QUIT'}='DEFAULT';
3418: $SIG{__DIE__}='DEFAULT';
3419: &status("Catching exception");
3420: &logthis("<font color='red'>CRITICAL: "
3421: ."ABNORMAL EXIT. Child $$ for server $thisserver died through "
3422: ."a crash with this error msg->[$error]</font>");
3423: &logthis('Famous last words: '.$status.' - '.$lastlog);
3424: if ($client) { print $client "error: $error\n"; }
3425: $server->close();
3426: die($error);
3427: }
3428: sub timeout {
3429: &status("Handling Timeout");
3430: &logthis("<font color='red'>CRITICAL: TIME OUT ".$$."</font>");
3431: &catchexception('Timeout');
3432: }
3433: # -------------------------------- Set signal handlers to record abnormal exits
3434:
3435:
3436: $SIG{'QUIT'}=\&catchexception;
3437: $SIG{__DIE__}=\&catchexception;
3438:
3439: # ---------------------------------- Read loncapa_apache.conf and loncapa.conf
3440: &status("Read loncapa.conf and loncapa_apache.conf");
3441: my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');
3442: %perlvar=%{$perlvarref};
3443: undef $perlvarref;
3444:
3445: # ----------------------------- Make sure this process is running from user=www
3446: my $wwwid=getpwnam('www');
3447: if ($wwwid!=$<) {
3448: my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
3449: my $subj="LON: $currenthostid User ID mismatch";
3450: system("echo 'User ID mismatch. lond must be run as user www.' |\
3451: mailto $emailto -s '$subj' > /dev/null");
3452: exit 1;
3453: }
3454:
3455: # --------------------------------------------- Check if other instance running
3456:
3457: my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
3458:
3459: if (-e $pidfile) {
3460: my $lfh=IO::File->new("$pidfile");
3461: my $pide=<$lfh>;
3462: chomp($pide);
3463: if (kill 0 => $pide) { die "already running"; }
3464: }
3465:
3466: # ------------------------------------------------------------- Read hosts file
3467:
3468:
3469:
3470: # establish SERVER socket, bind and listen.
3471: $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},
3472: Type => SOCK_STREAM,
3473: Proto => 'tcp',
3474: Reuse => 1,
3475: Listen => 10 )
3476: or die "making socket: $@\n";
3477:
3478: # --------------------------------------------------------- Do global variables
3479:
3480: # global variables
3481:
3482: my %children = (); # keys are current child process IDs
3483:
3484: sub REAPER { # takes care of dead children
3485: $SIG{CHLD} = \&REAPER;
3486: &status("Handling child death");
3487: my $pid;
3488: do {
3489: $pid = waitpid(-1,&WNOHANG());
3490: if (defined($children{$pid})) {
3491: &logthis("Child $pid died");
3492: delete($children{$pid});
3493: } elsif ($pid > 0) {
3494: &logthis("Unknown Child $pid died");
3495: }
3496: } while ( $pid > 0 );
3497: foreach my $child (keys(%children)) {
3498: $pid = waitpid($child,&WNOHANG());
3499: if ($pid > 0) {
3500: &logthis("Child $child - $pid looks like we missed it's death");
3501: delete($children{$pid});
3502: }
3503: }
3504: &status("Finished Handling child death");
3505: }
3506:
3507: sub HUNTSMAN { # signal handler for SIGINT
3508: &status("Killing children (INT)");
3509: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
3510: kill 'INT' => keys %children;
3511: &logthis("Free socket: ".shutdown($server,2)); # free up socket
3512: my $execdir=$perlvar{'lonDaemons'};
3513: unlink("$execdir/logs/lond.pid");
3514: &logthis("<font color='red'>CRITICAL: Shutting down</font>");
3515: &status("Done killing children");
3516: exit; # clean up with dignity
3517: }
3518:
3519: sub HUPSMAN { # signal handler for SIGHUP
3520: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
3521: &status("Killing children for restart (HUP)");
3522: kill 'INT' => keys %children;
3523: &logthis("Free socket: ".shutdown($server,2)); # free up socket
3524: &logthis("<font color='red'>CRITICAL: Restarting</font>");
3525: my $execdir=$perlvar{'lonDaemons'};
3526: unlink("$execdir/logs/lond.pid");
3527: &status("Restarting self (HUP)");
3528: exec("$execdir/lond"); # here we go again
3529: }
3530:
3531: #
3532: # Kill off hashes that describe the host table prior to re-reading it.
3533: # Hashes affected are:
3534: # %hostid, %hostdom %hostip %hostdns.
3535: #
3536: sub KillHostHashes {
3537: foreach my $key (keys %hostid) {
3538: delete $hostid{$key};
3539: }
3540: foreach my $key (keys %hostdom) {
3541: delete $hostdom{$key};
3542: }
3543: foreach my $key (keys %hostip) {
3544: delete $hostip{$key};
3545: }
3546: foreach my $key (keys %hostdns) {
3547: delete $hostdns{$key};
3548: }
3549: }
3550: #
3551: # Read in the host table from file and distribute it into the various hashes:
3552: #
3553: # - %hostid - Indexed by IP, the loncapa hostname.
3554: # - %hostdom - Indexed by loncapa hostname, the domain.
3555: # - %hostip - Indexed by hostid, the Ip address of the host.
3556: sub ReadHostTable {
3557:
3558: open (CONFIG,"$perlvar{'lonTabDir'}/hosts.tab") || die "Can't read host file";
3559: my $myloncapaname = $perlvar{'lonHostID'};
3560: Debug("My loncapa name is : $myloncapaname");
3561: while (my $configline=<CONFIG>) {
3562: if (!($configline =~ /^\s*\#/)) {
3563: my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
3564: chomp($ip); $ip=~s/\D+$//;
3565: $hostid{$ip}=$id; # LonCAPA name of host by IP.
3566: $hostdom{$id}=$domain; # LonCAPA domain name of host.
3567: $hostip{$id}=$ip; # IP address of host.
3568: $hostdns{$name} = $id; # LonCAPA name of host by DNS.
3569:
3570: if ($id eq $perlvar{'lonHostID'}) {
3571: Debug("Found me in the host table: $name");
3572: $thisserver=$name;
3573: }
3574: }
3575: }
3576: close(CONFIG);
3577: }
3578: #
3579: # Reload the Apache daemon's state.
3580: # This is done by invoking /home/httpd/perl/apachereload
3581: # a setuid perl script that can be root for us to do this job.
3582: #
3583: sub ReloadApache {
3584: my $execdir = $perlvar{'lonDaemons'};
3585: my $script = $execdir."/apachereload";
3586: system($script);
3587: }
3588:
3589: #
3590: # Called in response to a USR2 signal.
3591: # - Reread hosts.tab
3592: # - All children connected to hosts that were removed from hosts.tab
3593: # are killed via SIGINT
3594: # - All children connected to previously existing hosts are sent SIGUSR1
3595: # - Our internal hosts hash is updated to reflect the new contents of
3596: # hosts.tab causing connections from hosts added to hosts.tab to
3597: # now be honored.
3598: #
3599: sub UpdateHosts {
3600: &status("Reload hosts.tab");
3601: logthis('<font color="blue"> Updating connections </font>');
3602: #
3603: # The %children hash has the set of IP's we currently have children
3604: # on. These need to be matched against records in the hosts.tab
3605: # Any ip's no longer in the table get killed off they correspond to
3606: # either dropped or changed hosts. Note that the re-read of the table
3607: # will take care of new and changed hosts as connections come into being.
3608:
3609:
3610: KillHostHashes;
3611: ReadHostTable;
3612:
3613: foreach my $child (keys %children) {
3614: my $childip = $children{$child};
3615: if(!$hostid{$childip}) {
3616: logthis('<font color="blue"> UpdateHosts killing child '
3617: ." $child for ip $childip </font>");
3618: kill('INT', $child);
3619: } else {
3620: logthis('<font color="green"> keeping child for ip '
3621: ." $childip (pid=$child) </font>");
3622: }
3623: }
3624: ReloadApache;
3625: &status("Finished reloading hosts.tab");
3626: }
3627:
3628:
3629: sub checkchildren {
3630: &status("Checking on the children (sending signals)");
3631: &initnewstatus();
3632: &logstatus();
3633: &logthis('Going to check on the children');
3634: my $docdir=$perlvar{'lonDocRoot'};
3635: foreach (sort keys %children) {
3636: #sleep 1;
3637: unless (kill 'USR1' => $_) {
3638: &logthis ('Child '.$_.' is dead');
3639: &logstatus($$.' is dead');
3640: delete($children{$_});
3641: }
3642: }
3643: sleep 5;
3644: $SIG{ALRM} = sub { Debug("timeout");
3645: die "timeout"; };
3646: $SIG{__DIE__} = 'DEFAULT';
3647: &status("Checking on the children (waiting for reports)");
3648: foreach (sort keys %children) {
3649: unless (-e "$docdir/lon-status/londchld/$_.txt") {
3650: eval {
3651: alarm(300);
3652: &logthis('Child '.$_.' did not respond');
3653: kill 9 => $_;
3654: #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
3655: #$subj="LON: $currenthostid killed lond process $_";
3656: #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
3657: #$execdir=$perlvar{'lonDaemons'};
3658: #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
3659: delete($children{$_});
3660: alarm(0);
3661: }
3662: }
3663: }
3664: $SIG{ALRM} = 'DEFAULT';
3665: $SIG{__DIE__} = \&catchexception;
3666: &status("Finished checking children");
3667: &logthis('Finished Checking children');
3668: }
3669:
3670: # --------------------------------------------------------------------- Logging
3671:
3672: sub logthis {
3673: my $message=shift;
3674: my $execdir=$perlvar{'lonDaemons'};
3675: my $fh=IO::File->new(">>$execdir/logs/lond.log");
3676: my $now=time;
3677: my $local=localtime($now);
3678: $lastlog=$local.': '.$message;
3679: print $fh "$local ($$): $message\n";
3680: }
3681:
3682: # ------------------------- Conditional log if $DEBUG true.
3683: sub Debug {
3684: my $message = shift;
3685: if($DEBUG) {
3686: &logthis($message);
3687: }
3688: }
3689:
3690: #
3691: # Sub to do replies to client.. this gives a hook for some
3692: # debug tracing too:
3693: # Parameters:
3694: # fd - File open on client.
3695: # reply - Text to send to client.
3696: # request - Original request from client.
3697: #
3698: sub Reply {
3699: my ($fd, $reply, $request) = @_;
3700: print $fd $reply;
3701: Debug("Request was $request Reply was $reply");
3702:
3703: $Transactions++;
3704:
3705:
3706: }
3707:
3708:
3709: #
3710: # Sub to report a failure.
3711: # This function:
3712: # - Increments the failure statistic counters.
3713: # - Invokes Reply to send the error message to the client.
3714: # Parameters:
3715: # fd - File descriptor open on the client
3716: # reply - Reply text to emit.
3717: # request - The original request message (used by Reply
3718: # to debug if that's enabled.
3719: # Implicit outputs:
3720: # $Failures- The number of failures is incremented.
3721: # Reply (invoked here) sends a message to the
3722: # client:
3723: #
3724: sub Failure {
3725: my $fd = shift;
3726: my $reply = shift;
3727: my $request = shift;
3728:
3729: $Failures++;
3730: Reply($fd, $reply, $request); # That's simple eh?
3731: }
3732: # ------------------------------------------------------------------ Log status
3733:
3734: sub logstatus {
3735: &status("Doing logging");
3736: my $docdir=$perlvar{'lonDocRoot'};
3737: {
3738: my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
3739: print $fh $status."\n".$lastlog."\n".time."\n$keymode";
3740: $fh->close();
3741: }
3742: &status("Finished $$.txt");
3743: {
3744: open(LOG,">>$docdir/lon-status/londstatus.txt");
3745: flock(LOG,LOCK_EX);
3746: print LOG $$."\t".$clientname."\t".$currenthostid."\t"
3747: .$status."\t".$lastlog."\t $keymode\n";
3748: flock(DB,LOCK_UN);
3749: close(LOG);
3750: }
3751: &status("Finished logging");
3752: }
3753:
3754: sub initnewstatus {
3755: my $docdir=$perlvar{'lonDocRoot'};
3756: my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");
3757: my $now=time;
3758: my $local=localtime($now);
3759: print $fh "LOND status $local - parent $$\n\n";
3760: opendir(DIR,"$docdir/lon-status/londchld");
3761: while (my $filename=readdir(DIR)) {
3762: unlink("$docdir/lon-status/londchld/$filename");
3763: }
3764: closedir(DIR);
3765: }
3766:
3767: # -------------------------------------------------------------- Status setting
3768:
3769: sub status {
3770: my $what=shift;
3771: my $now=time;
3772: my $local=localtime($now);
3773: $status=$local.': '.$what;
3774: $0='lond: '.$what.' '.$local;
3775: }
3776:
3777: # -------------------------------------------------------- Escape Special Chars
3778:
3779: sub escape {
3780: my $str=shift;
3781: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
3782: return $str;
3783: }
3784:
3785: # ----------------------------------------------------- Un-Escape Special Chars
3786:
3787: sub unescape {
3788: my $str=shift;
3789: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3790: return $str;
3791: }
3792:
3793: # ----------------------------------------------------------- Send USR1 to lonc
3794:
3795: sub reconlonc {
3796: my $peerfile=shift;
3797: &logthis("Trying to reconnect for $peerfile");
3798: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
3799: if (my $fh=IO::File->new("$loncfile")) {
3800: my $loncpid=<$fh>;
3801: chomp($loncpid);
3802: if (kill 0 => $loncpid) {
3803: &logthis("lonc at pid $loncpid responding, sending USR1");
3804: kill USR1 => $loncpid;
3805: } else {
3806: &logthis(
3807: "<font color='red'>CRITICAL: "
3808: ."lonc at pid $loncpid not responding, giving up</font>");
3809: }
3810: } else {
3811: &logthis('<font color="red">CRITICAL: lonc not running, giving up</font>');
3812: }
3813: }
3814:
3815: # -------------------------------------------------- Non-critical communication
3816:
3817: sub subreply {
3818: my ($cmd,$server)=@_;
3819: my $peerfile="$perlvar{'lonSockDir'}/$server";
3820: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
3821: Type => SOCK_STREAM,
3822: Timeout => 10)
3823: or return "con_lost";
3824: print $sclient "$cmd\n";
3825: my $answer=<$sclient>;
3826: chomp($answer);
3827: if (!$answer) { $answer="con_lost"; }
3828: return $answer;
3829: }
3830:
3831: sub reply {
3832: my ($cmd,$server)=@_;
3833: my $answer;
3834: if ($server ne $currenthostid) {
3835: $answer=subreply($cmd,$server);
3836: if ($answer eq 'con_lost') {
3837: $answer=subreply("ping",$server);
3838: if ($answer ne $server) {
3839: &logthis("sub reply: answer != server answer is $answer, server is $server");
3840: &reconlonc("$perlvar{'lonSockDir'}/$server");
3841: }
3842: $answer=subreply($cmd,$server);
3843: }
3844: } else {
3845: $answer='self_reply';
3846: }
3847: return $answer;
3848: }
3849:
3850: # -------------------------------------------------------------- Talk to lonsql
3851:
3852: sub sqlreply {
3853: my ($cmd)=@_;
3854: my $answer=subsqlreply($cmd);
3855: if ($answer eq 'con_lost') { $answer=subsqlreply($cmd); }
3856: return $answer;
3857: }
3858:
3859: sub subsqlreply {
3860: my ($cmd)=@_;
3861: my $unixsock="mysqlsock";
3862: my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
3863: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
3864: Type => SOCK_STREAM,
3865: Timeout => 10)
3866: or return "con_lost";
3867: print $sclient "$cmd\n";
3868: my $answer=<$sclient>;
3869: chomp($answer);
3870: if (!$answer) { $answer="con_lost"; }
3871: return $answer;
3872: }
3873:
3874: # -------------------------------------------- Return path to profile directory
3875:
3876: sub propath {
3877: my ($udom,$uname)=@_;
3878: $udom=~s/\W//g;
3879: $uname=~s/\W//g;
3880: my $subdir=$uname.'__';
3881: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
3882: my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
3883: return $proname;
3884: }
3885:
3886: # --------------------------------------- Is this the home server of an author?
3887:
3888: sub ishome {
3889: my $author=shift;
3890: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3891: my ($udom,$uname)=split(/\//,$author);
3892: my $proname=propath($udom,$uname);
3893: if (-e $proname) {
3894: return 'owner';
3895: } else {
3896: return 'not_owner';
3897: }
3898: }
3899:
3900: # ======================================================= Continue main program
3901: # ---------------------------------------------------- Fork once and dissociate
3902:
3903: my $fpid=fork;
3904: exit if $fpid;
3905: die "Couldn't fork: $!" unless defined ($fpid);
3906:
3907: POSIX::setsid() or die "Can't start new session: $!";
3908:
3909: # ------------------------------------------------------- Write our PID on disk
3910:
3911: my $execdir=$perlvar{'lonDaemons'};
3912: open (PIDSAVE,">$execdir/logs/lond.pid");
3913: print PIDSAVE "$$\n";
3914: close(PIDSAVE);
3915: &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
3916: &status('Starting');
3917:
3918:
3919:
3920: # ----------------------------------------------------- Install signal handlers
3921:
3922:
3923: $SIG{CHLD} = \&REAPER;
3924: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
3925: $SIG{HUP} = \&HUPSMAN;
3926: $SIG{USR1} = \&checkchildren;
3927: $SIG{USR2} = \&UpdateHosts;
3928:
3929: # Read the host hashes:
3930:
3931: ReadHostTable;
3932:
3933: # --------------------------------------------------------------
3934: # Accept connections. When a connection comes in, it is validated
3935: # and if good, a child process is created to process transactions
3936: # along the connection.
3937:
3938: while (1) {
3939: &status('Starting accept');
3940: $client = $server->accept() or next;
3941: &status('Accepted '.$client.' off to spawn');
3942: make_new_child($client);
3943: &status('Finished spawning');
3944: }
3945:
3946: sub make_new_child {
3947: my $pid;
3948: # my $cipher; # Now global
3949: my $sigset;
3950:
3951: $client = shift;
3952: &status('Starting new child '.$client);
3953: &logthis('<font color="green"> Attempting to start child ('.$client.
3954: ")</font>");
3955: # block signal for fork
3956: $sigset = POSIX::SigSet->new(SIGINT);
3957: sigprocmask(SIG_BLOCK, $sigset)
3958: or die "Can't block SIGINT for fork: $!\n";
3959:
3960: die "fork: $!" unless defined ($pid = fork);
3961:
3962: $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
3963: # connection liveness.
3964:
3965: #
3966: # Figure out who we're talking to so we can record the peer in
3967: # the pid hash.
3968: #
3969: my $caller = getpeername($client);
3970: my ($port,$iaddr);
3971: if (defined($caller) && length($caller) > 0) {
3972: ($port,$iaddr)=unpack_sockaddr_in($caller);
3973: } else {
3974: &logthis("Unable to determine who caller was, getpeername returned nothing");
3975: }
3976: if (defined($iaddr)) {
3977: $clientip = inet_ntoa($iaddr);
3978: Debug("Connected with $clientip");
3979: $clientdns = gethostbyaddr($iaddr, AF_INET);
3980: Debug("Connected with $clientdns by name");
3981: } else {
3982: &logthis("Unable to determine clientip");
3983: $clientip='Unavailable';
3984: }
3985:
3986: if ($pid) {
3987: # Parent records the child's birth and returns.
3988: sigprocmask(SIG_UNBLOCK, $sigset)
3989: or die "Can't unblock SIGINT for fork: $!\n";
3990: $children{$pid} = $clientip;
3991: &status('Started child '.$pid);
3992: return;
3993: } else {
3994: # Child can *not* return from this subroutine.
3995: $SIG{INT} = 'DEFAULT'; # make SIGINT kill us as it did before
3996: $SIG{CHLD} = 'DEFAULT'; #make this default so that pwauth returns
3997: #don't get intercepted
3998: $SIG{USR1}= \&logstatus;
3999: $SIG{ALRM}= \&timeout;
4000: $lastlog='Forked ';
4001: $status='Forked';
4002:
4003: # unblock signals
4004: sigprocmask(SIG_UNBLOCK, $sigset)
4005: or die "Can't unblock SIGINT for fork: $!\n";
4006:
4007: # my $tmpsnum=0; # Now global
4008: #---------------------------------------------------- kerberos 5 initialization
4009: &Authen::Krb5::init_context();
4010: &Authen::Krb5::init_ets();
4011:
4012: &status('Accepted connection');
4013: # =============================================================================
4014: # do something with the connection
4015: # -----------------------------------------------------------------------------
4016: # see if we know client and 'check' for spoof IP by ineffective challenge
4017:
4018: ReadManagerTable; # May also be a manager!!
4019:
4020: my $clientrec=($hostid{$clientip} ne undef);
4021: my $ismanager=($managers{$clientip} ne undef);
4022: $clientname = "[unknonwn]";
4023: if($clientrec) { # Establish client type.
4024: $ConnectionType = "client";
4025: $clientname = $hostid{$clientip};
4026: if($ismanager) {
4027: $ConnectionType = "both";
4028: }
4029: } else {
4030: $ConnectionType = "manager";
4031: $clientname = $managers{$clientip};
4032: }
4033: my $clientok;
4034:
4035: if ($clientrec || $ismanager) {
4036: &status("Waiting for init from $clientip $clientname");
4037: &logthis('<font color="yellow">INFO: Connection, '.
4038: $clientip.
4039: " ($clientname) connection type = $ConnectionType </font>" );
4040: &status("Connecting $clientip ($clientname))");
4041: my $remotereq=<$client>;
4042: chomp($remotereq);
4043: Debug("Got init: $remotereq");
4044: my $inikeyword = split(/:/, $remotereq);
4045: if ($remotereq =~ /^init/) {
4046: &sethost("sethost:$perlvar{'lonHostID'}");
4047: #
4048: # If the remote is attempting a local init... give that a try:
4049: #
4050: my ($i, $inittype) = split(/:/, $remotereq);
4051:
4052: # If the connection type is ssl, but I didn't get my
4053: # certificate files yet, then I'll drop back to
4054: # insecure (if allowed).
4055:
4056: if($inittype eq "ssl") {
4057: my ($ca, $cert) = lonssl::CertificateFile;
4058: my $kfile = lonssl::KeyFile;
4059: if((!$ca) ||
4060: (!$cert) ||
4061: (!$kfile)) {
4062: $inittype = ""; # This forces insecure attempt.
4063: &logthis("<font color=\"blue\"> Certificates not "
4064: ."installed -- trying insecure auth</font>");
4065: } else { # SSL certificates are in place so
4066: } # Leave the inittype alone.
4067: }
4068:
4069: if($inittype eq "local") {
4070: my $key = LocalConnection($client, $remotereq);
4071: if($key) {
4072: Debug("Got local key $key");
4073: $clientok = 1;
4074: my $cipherkey = pack("H32", $key);
4075: $cipher = new IDEA($cipherkey);
4076: print $client "ok:local\n";
4077: &logthis('<font color="green"'
4078: . "Successful local authentication </font>");
4079: $keymode = "local"
4080: } else {
4081: Debug("Failed to get local key");
4082: $clientok = 0;
4083: shutdown($client, 3);
4084: close $client;
4085: }
4086: } elsif ($inittype eq "ssl") {
4087: my $key = SSLConnection($client);
4088: if ($key) {
4089: $clientok = 1;
4090: my $cipherkey = pack("H32", $key);
4091: $cipher = new IDEA($cipherkey);
4092: &logthis('<font color="green">'
4093: ."Successfull ssl authentication with $clientname </font>");
4094: $keymode = "ssl";
4095:
4096: } else {
4097: $clientok = 0;
4098: close $client;
4099: }
4100:
4101: } else {
4102: my $ok = InsecureConnection($client);
4103: if($ok) {
4104: $clientok = 1;
4105: &logthis('<font color="green">'
4106: ."Successful insecure authentication with $clientname </font>");
4107: print $client "ok\n";
4108: $keymode = "insecure";
4109: } else {
4110: &logthis('<font color="yellow">'
4111: ."Attempted insecure connection disallowed </font>");
4112: close $client;
4113: $clientok = 0;
4114:
4115: }
4116: }
4117: } else {
4118: &logthis(
4119: "<font color='blue'>WARNING: "
4120: ."$clientip failed to initialize: >$remotereq< </font>");
4121: &status('No init '.$clientip);
4122: }
4123:
4124: } else {
4125: &logthis(
4126: "<font color='blue'>WARNING: Unknown client $clientip</font>");
4127: &status('Hung up on '.$clientip);
4128: }
4129:
4130: if ($clientok) {
4131: # ---------------- New known client connecting, could mean machine online again
4132:
4133: foreach my $id (keys(%hostip)) {
4134: if ($hostip{$id} ne $clientip ||
4135: $hostip{$currenthostid} eq $clientip) {
4136: # no need to try to do recon's to myself
4137: next;
4138: }
4139: &reconlonc("$perlvar{'lonSockDir'}/$id");
4140: }
4141: &logthis("<font color='green'>Established connection: $clientname</font>");
4142: &status('Will listen to '.$clientname);
4143: # ------------------------------------------------------------ Process requests
4144: my $keep_going = 1;
4145: my $user_input;
4146: while(($user_input = get_request) && $keep_going) {
4147: alarm(120);
4148: Debug("Main: Got $user_input\n");
4149: $keep_going = &process_request($user_input);
4150: alarm(0);
4151: &status('Listening to '.$clientname." ($keymode)");
4152: }
4153:
4154: # --------------------------------------------- client unknown or fishy, refuse
4155: } else {
4156: print $client "refused\n";
4157: $client->close();
4158: &logthis("<font color='blue'>WARNING: "
4159: ."Rejected client $clientip, closing connection</font>");
4160: }
4161: }
4162:
4163: # =============================================================================
4164:
4165: &logthis("<font color='red'>CRITICAL: "
4166: ."Disconnect from $clientip ($clientname)</font>");
4167:
4168:
4169: # this exit is VERY important, otherwise the child will become
4170: # a producer of more and more children, forking yourself into
4171: # process death.
4172: exit;
4173:
4174: }
4175:
4176:
4177: #
4178: # Checks to see if the input roleput request was to set
4179: # an author role. If so, invokes the lchtmldir script to set
4180: # up a correct public_html
4181: # Parameters:
4182: # request - The request sent to the rolesput subchunk.
4183: # We're looking for /domain/_au
4184: # domain - The domain in which the user is having roles doctored.
4185: # user - Name of the user for which the role is being put.
4186: # authtype - The authentication type associated with the user.
4187: #
4188: sub manage_permissions
4189: {
4190:
4191: my ($request, $domain, $user, $authtype) = @_;
4192:
4193: # See if the request is of the form /$domain/_au
4194: if($request =~ /^(\/$domain\/_au)$/) { # It's an author rolesput...
4195: my $execdir = $perlvar{'lonDaemons'};
4196: my $userhome= "/home/$user" ;
4197: &logthis("system $execdir/lchtmldir $userhome $user $authtype");
4198: system("$execdir/lchtmldir $userhome $user $authtype");
4199: }
4200: }
4201:
4202:
4203: #
4204: # Return the full path of a user password file, whether it exists or not.
4205: # Parameters:
4206: # domain - Domain in which the password file lives.
4207: # user - name of the user.
4208: # Returns:
4209: # Full passwd path:
4210: #
4211: sub password_path {
4212: my ($domain, $user) = @_;
4213:
4214:
4215: my $path = &propath($domain, $user);
4216: $path .= "/passwd";
4217:
4218: return $path;
4219: }
4220:
4221: # Password Filename
4222: # Returns the path to a passwd file given domain and user... only if
4223: # it exists.
4224: # Parameters:
4225: # domain - Domain in which to search.
4226: # user - username.
4227: # Returns:
4228: # - If the password file exists returns its path.
4229: # - If the password file does not exist, returns undefined.
4230: #
4231: sub password_filename {
4232: my ($domain, $user) = @_;
4233:
4234: Debug ("PasswordFilename called: dom = $domain user = $user");
4235:
4236: my $path = &password_path($domain, $user);
4237: Debug("PasswordFilename got path: $path");
4238: if(-e $path) {
4239: return $path;
4240: } else {
4241: return undef;
4242: }
4243: }
4244:
4245: #
4246: # Rewrite the contents of the user's passwd file.
4247: # Parameters:
4248: # domain - domain of the user.
4249: # name - User's name.
4250: # contents - New contents of the file.
4251: # Returns:
4252: # 0 - Failed.
4253: # 1 - Success.
4254: #
4255: sub rewrite_password_file {
4256: my ($domain, $user, $contents) = @_;
4257:
4258: my $file = &password_filename($domain, $user);
4259: if (defined $file) {
4260: my $pf = IO::File->new(">$file");
4261: if($pf) {
4262: print $pf "$contents\n";
4263: return 1;
4264: } else {
4265: return 0;
4266: }
4267: } else {
4268: return 0;
4269: }
4270:
4271: }
4272:
4273: #
4274: # get_auth_type - Determines the authorization type of a user in a domain.
4275:
4276: # Returns the authorization type or nouser if there is no such user.
4277: #
4278: sub get_auth_type
4279: {
4280:
4281: my ($domain, $user) = @_;
4282:
4283: Debug("get_auth_type( $domain, $user ) \n");
4284: my $proname = &propath($domain, $user);
4285: my $passwdfile = "$proname/passwd";
4286: if( -e $passwdfile ) {
4287: my $pf = IO::File->new($passwdfile);
4288: my $realpassword = <$pf>;
4289: chomp($realpassword);
4290: Debug("Password info = $realpassword\n");
4291: my ($authtype, $contentpwd) = split(/:/, $realpassword);
4292: Debug("Authtype = $authtype, content = $contentpwd\n");
4293: my $availinfo = '';
4294: if($authtype eq 'krb4' or $authtype eq 'krb5') {
4295: $availinfo = $contentpwd;
4296: }
4297:
4298: return "$authtype:$availinfo";
4299: } else {
4300: Debug("Returning nouser");
4301: return "nouser";
4302: }
4303: }
4304:
4305: #
4306: # Validate a user given their domain, name and password. This utility
4307: # function is used by both AuthenticateHandler and ChangePasswordHandler
4308: # to validate the login credentials of a user.
4309: # Parameters:
4310: # $domain - The domain being logged into (this is required due to
4311: # the capability for multihomed systems.
4312: # $user - The name of the user being validated.
4313: # $password - The user's propoposed password.
4314: #
4315: # Returns:
4316: # 1 - The domain,user,pasword triplet corresponds to a valid
4317: # user.
4318: # 0 - The domain,user,password triplet is not a valid user.
4319: #
4320: sub validate_user {
4321: my ($domain, $user, $password) = @_;
4322:
4323:
4324: # Why negative ~pi you may well ask? Well this function is about
4325: # authentication, and therefore very important to get right.
4326: # I've initialized the flag that determines whether or not I've
4327: # validated correctly to a value it's not supposed to get.
4328: # At the end of this function. I'll ensure that it's not still that
4329: # value so we don't just wind up returning some accidental value
4330: # as a result of executing an unforseen code path that
4331: # did not set $validated.
4332:
4333: my $validated = -3.14159;
4334:
4335: # How we authenticate is determined by the type of authentication
4336: # the user has been assigned. If the authentication type is
4337: # "nouser", the user does not exist so we will return 0.
4338:
4339: my $contents = &get_auth_type($domain, $user);
4340: my ($howpwd, $contentpwd) = split(/:/, $contents);
4341:
4342: my $null = pack("C",0); # Used by kerberos auth types.
4343:
4344: if ($howpwd ne 'nouser') {
4345:
4346: if($howpwd eq "internal") { # Encrypted is in local password file.
4347: $validated = (crypt($password, $contentpwd) eq $contentpwd);
4348: }
4349: elsif ($howpwd eq "unix") { # User is a normal unix user.
4350: $contentpwd = (getpwnam($user))[1];
4351: if($contentpwd) {
4352: if($contentpwd eq 'x') { # Shadow password file...
4353: my $pwauth_path = "/usr/local/sbin/pwauth";
4354: open PWAUTH, "|$pwauth_path" or
4355: die "Cannot invoke authentication";
4356: print PWAUTH "$user\n$password\n";
4357: close PWAUTH;
4358: $validated = ! $?;
4359:
4360: } else { # Passwords in /etc/passwd.
4361: $validated = (crypt($password,
4362: $contentpwd) eq $contentpwd);
4363: }
4364: } else {
4365: $validated = 0;
4366: }
4367: }
4368: elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
4369: if(! ($password =~ /$null/) ) {
4370: my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
4371: "",
4372: $contentpwd,,
4373: 'krbtgt',
4374: $contentpwd,
4375: 1,
4376: $password);
4377: if(!$k4error) {
4378: $validated = 1;
4379: } else {
4380: $validated = 0;
4381: &logthis('krb4: '.$user.', '.$contentpwd.', '.
4382: &Authen::Krb4::get_err_txt($Authen::Krb4::error));
4383: }
4384: } else {
4385: $validated = 0; # Password has a match with null.
4386: }
4387: } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
4388: if(!($password =~ /$null/)) { # Null password not allowed.
4389: my $krbclient = &Authen::Krb5::parse_name($user.'@'
4390: .$contentpwd);
4391: my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
4392: my $krbserver = &Authen::Krb5::parse_name($krbservice);
4393: my $credentials= &Authen::Krb5::cc_default();
4394: $credentials->initialize($krbclient);
4395: my $krbreturn = &Authen::KRb5::get_in_tkt_with_password($krbclient,
4396: $krbserver,
4397: $password,
4398: $credentials);
4399: $validated = ($krbreturn == 1);
4400: } else {
4401: $validated = 0;
4402: }
4403: } elsif ($howpwd eq "localauth") {
4404: # Authenticate via installation specific authentcation method:
4405: $validated = &localauth::localauth($user,
4406: $password,
4407: $contentpwd);
4408: } else { # Unrecognized auth is also bad.
4409: $validated = 0;
4410: }
4411: } else {
4412: $validated = 0;
4413: }
4414: #
4415: # $validated has the correct stat of the authentication:
4416: #
4417:
4418: unless ($validated != -3.14159) {
4419: die "ValidateUser - failed to set the value of validated";
4420: }
4421: return $validated;
4422: }
4423:
4424:
4425: sub addline {
4426: my ($fname,$hostid,$ip,$newline)=@_;
4427: my $contents;
4428: my $found=0;
4429: my $expr='^'.$hostid.':'.$ip.':';
4430: $expr =~ s/\./\\\./g;
4431: my $sh;
4432: if ($sh=IO::File->new("$fname.subscription")) {
4433: while (my $subline=<$sh>) {
4434: if ($subline !~ /$expr/) {$contents.= $subline;} else {$found=1;}
4435: }
4436: $sh->close();
4437: }
4438: $sh=IO::File->new(">$fname.subscription");
4439: if ($contents) { print $sh $contents; }
4440: if ($newline) { print $sh $newline; }
4441: $sh->close();
4442: return $found;
4443: }
4444:
4445: sub getchat {
4446: my ($cdom,$cname,$udom,$uname)=@_;
4447: my %hash;
4448: my $proname=&propath($cdom,$cname);
4449: my @entries=();
4450: if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",
4451: &GDBM_READER(),0640)) {
4452: @entries=map { $_.':'.$hash{$_} } sort keys %hash;
4453: untie %hash;
4454: }
4455: my @participants=();
4456: my $cutoff=time-60;
4457: if (tie(%hash,'GDBM_File',"$proname/nohist_inchatroom.db",
4458: &GDBM_WRCREAT(),0640)) {
4459: $hash{$uname.':'.$udom}=time;
4460: foreach (sort keys %hash) {
4461: if ($hash{$_}>$cutoff) {
4462: $participants[$#participants+1]='active_participant:'.$_;
4463: }
4464: }
4465: untie %hash;
4466: }
4467: return (@participants,@entries);
4468: }
4469:
4470: sub chatadd {
4471: my ($cdom,$cname,$newchat)=@_;
4472: my %hash;
4473: my $proname=&propath($cdom,$cname);
4474: my @entries=();
4475: my $time=time;
4476: if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",
4477: &GDBM_WRCREAT(),0640)) {
4478: @entries=map { $_.':'.$hash{$_} } sort keys %hash;
4479: my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
4480: my ($thentime,$idnum)=split(/\_/,$lastid);
4481: my $newid=$time.'_000000';
4482: if ($thentime==$time) {
4483: $idnum=~s/^0+//;
4484: $idnum++;
4485: $idnum=substr('000000'.$idnum,-6,6);
4486: $newid=$time.'_'.$idnum;
4487: }
4488: $hash{$newid}=$newchat;
4489: my $expired=$time-3600;
4490: foreach (keys %hash) {
4491: my ($thistime)=($_=~/(\d+)\_/);
4492: if ($thistime<$expired) {
4493: delete $hash{$_};
4494: }
4495: }
4496: untie %hash;
4497: }
4498: {
4499: my $hfh;
4500: if ($hfh=IO::File->new(">>$proname/chatroom.log")) {
4501: print $hfh "$time:".&unescape($newchat)."\n";
4502: }
4503: }
4504: }
4505:
4506: sub unsub {
4507: my ($fname,$clientip)=@_;
4508: my $result;
4509: my $unsubs = 0; # Number of successful unsubscribes:
4510:
4511:
4512: # An old way subscriptions were handled was to have a
4513: # subscription marker file:
4514:
4515: Debug("Attempting unlink of $fname.$clientname");
4516: if (unlink("$fname.$clientname")) {
4517: $unsubs++; # Successful unsub via marker file.
4518: }
4519:
4520: # The more modern way to do it is to have a subscription list
4521: # file:
4522:
4523: if (-e "$fname.subscription") {
4524: my $found=&addline($fname,$clientname,$clientip,'');
4525: if ($found) {
4526: $unsubs++;
4527: }
4528: }
4529:
4530: # If either or both of these mechanisms succeeded in unsubscribing a
4531: # resource we can return ok:
4532:
4533: if($unsubs) {
4534: $result = "ok\n";
4535: } else {
4536: $result = "not_subscribed\n";
4537: }
4538:
4539: return $result;
4540: }
4541:
4542: sub currentversion {
4543: my $fname=shift;
4544: my $version=-1;
4545: my $ulsdir='';
4546: if ($fname=~/^(.+)\/[^\/]+$/) {
4547: $ulsdir=$1;
4548: }
4549: my ($fnamere1,$fnamere2);
4550: # remove version if already specified
4551: $fname=~s/\.\d+\.(\w+(?:\.meta)*)$/\.$1/;
4552: # get the bits that go before and after the version number
4553: if ( $fname=~/^(.*\.)(\w+(?:\.meta)*)$/ ) {
4554: $fnamere1=$1;
4555: $fnamere2='.'.$2;
4556: }
4557: if (-e $fname) { $version=1; }
4558: if (-e $ulsdir) {
4559: if(-d $ulsdir) {
4560: if (opendir(LSDIR,$ulsdir)) {
4561: my $ulsfn;
4562: while ($ulsfn=readdir(LSDIR)) {
4563: # see if this is a regular file (ignore links produced earlier)
4564: my $thisfile=$ulsdir.'/'.$ulsfn;
4565: unless (-l $thisfile) {
4566: if ($thisfile=~/\Q$fnamere1\E(\d+)\Q$fnamere2\E$/) {
4567: if ($1>$version) { $version=$1; }
4568: }
4569: }
4570: }
4571: closedir(LSDIR);
4572: $version++;
4573: }
4574: }
4575: }
4576: return $version;
4577: }
4578:
4579: sub thisversion {
4580: my $fname=shift;
4581: my $version=-1;
4582: if ($fname=~/\.(\d+)\.\w+(?:\.meta)*$/) {
4583: $version=$1;
4584: }
4585: return $version;
4586: }
4587:
4588: sub subscribe {
4589: my ($userinput,$clientip)=@_;
4590: my $result;
4591: my ($cmd,$fname)=split(/:/,$userinput);
4592: my $ownership=&ishome($fname);
4593: if ($ownership eq 'owner') {
4594: # explitly asking for the current version?
4595: unless (-e $fname) {
4596: my $currentversion=¤tversion($fname);
4597: if (&thisversion($fname)==$currentversion) {
4598: if ($fname=~/^(.+)\.\d+\.(\w+(?:\.meta)*)$/) {
4599: my $root=$1;
4600: my $extension=$2;
4601: symlink($root.'.'.$extension,
4602: $root.'.'.$currentversion.'.'.$extension);
4603: unless ($extension=~/\.meta$/) {
4604: symlink($root.'.'.$extension.'.meta',
4605: $root.'.'.$currentversion.'.'.$extension.'.meta');
4606: }
4607: }
4608: }
4609: }
4610: if (-e $fname) {
4611: if (-d $fname) {
4612: $result="directory\n";
4613: } else {
4614: if (-e "$fname.$clientname") {&unsub($fname,$clientip);}
4615: my $now=time;
4616: my $found=&addline($fname,$clientname,$clientip,
4617: "$clientname:$clientip:$now\n");
4618: if ($found) { $result="$fname\n"; }
4619: # if they were subscribed to only meta data, delete that
4620: # subscription, when you subscribe to a file you also get
4621: # the metadata
4622: unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
4623: $fname=~s/\/home\/httpd\/html\/res/raw/;
4624: $fname="http://$thisserver/".$fname;
4625: $result="$fname\n";
4626: }
4627: } else {
4628: $result="not_found\n";
4629: }
4630: } else {
4631: $result="rejected\n";
4632: }
4633: return $result;
4634: }
4635:
4636: sub make_passwd_file {
4637: my ($uname, $umode,$npass,$passfilename)=@_;
4638: my $result="ok\n";
4639: if ($umode eq 'krb4' or $umode eq 'krb5') {
4640: {
4641: my $pf = IO::File->new(">$passfilename");
4642: print $pf "$umode:$npass\n";
4643: }
4644: } elsif ($umode eq 'internal') {
4645: my $salt=time;
4646: $salt=substr($salt,6,2);
4647: my $ncpass=crypt($npass,$salt);
4648: {
4649: &Debug("Creating internal auth");
4650: my $pf = IO::File->new(">$passfilename");
4651: print $pf "internal:$ncpass\n";
4652: }
4653: } elsif ($umode eq 'localauth') {
4654: {
4655: my $pf = IO::File->new(">$passfilename");
4656: print $pf "localauth:$npass\n";
4657: }
4658: } elsif ($umode eq 'unix') {
4659: {
4660: #
4661: # Don't allow the creation of privileged accounts!!! that would
4662: # be real bad!!!
4663: #
4664: my $uid = getpwnam($uname);
4665: if((defined $uid) && ($uid == 0)) {
4666: &logthis(">>>Attempted to create privilged account blocked");
4667: return "no_priv_account_error\n";
4668: }
4669:
4670: my $execpath ="$perlvar{'lonDaemons'}/"."lcuseradd";
4671:
4672: my $lc_error_file = $execdir."/tmp/lcuseradd".$$.".status";
4673: {
4674: &Debug("Executing external: ".$execpath);
4675: &Debug("user = ".$uname.", Password =". $npass);
4676: my $se = IO::File->new("|$execpath > $perlvar{'lonDaemons'}/logs/lcuseradd.log");
4677: print $se "$uname\n";
4678: print $se "$npass\n";
4679: print $se "$npass\n";
4680: print $se "$lc_error_file\n"; # Status -> unique file.
4681: }
4682: my $error = IO::File->new("< $lc_error_file");
4683: my $useraddok = <$error>;
4684: $error->close;
4685: unlink($lc_error_file);
4686:
4687: chomp $useraddok;
4688:
4689: if($useraddok > 0) {
4690: my $error_text = &lcuseraddstrerror($useraddok);
4691: &logthis("Failed lcuseradd: $error_text");
4692: $result = "lcuseradd_failed:$error_text\n";
4693: } else {
4694: my $pf = IO::File->new(">$passfilename");
4695: print $pf "unix:\n";
4696: }
4697: }
4698: } elsif ($umode eq 'none') {
4699: {
4700: my $pf = IO::File->new("> $passfilename");
4701: print $pf "none:\n";
4702: }
4703: } else {
4704: $result="auth_mode_error\n";
4705: }
4706: return $result;
4707: }
4708:
4709: sub sethost {
4710: my ($remotereq) = @_;
4711: my (undef,$hostid)=split(/:/,$remotereq);
4712: if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
4713: if ($hostip{$perlvar{'lonHostID'}} eq $hostip{$hostid}) {
4714: $currenthostid =$hostid;
4715: $currentdomainid=$hostdom{$hostid};
4716: &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
4717: } else {
4718: &logthis("Requested host id $hostid not an alias of ".
4719: $perlvar{'lonHostID'}." refusing connection");
4720: return 'unable_to_set';
4721: }
4722: return 'ok';
4723: }
4724:
4725: sub version {
4726: my ($userinput)=@_;
4727: $remoteVERSION=(split(/:/,$userinput))[1];
4728: return "version:$VERSION";
4729: }
4730:
4731: #There is a copy of this in lonnet.pm
4732: sub userload {
4733: my $numusers=0;
4734: {
4735: opendir(LONIDS,$perlvar{'lonIDsDir'});
4736: my $filename;
4737: my $curtime=time;
4738: while ($filename=readdir(LONIDS)) {
4739: if ($filename eq '.' || $filename eq '..') {next;}
4740: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
4741: if ($curtime-$mtime < 1800) { $numusers++; }
4742: }
4743: closedir(LONIDS);
4744: }
4745: my $userloadpercent=0;
4746: my $maxuserload=$perlvar{'lonUserLoadLim'};
4747: if ($maxuserload) {
4748: $userloadpercent=100*$numusers/$maxuserload;
4749: }
4750: $userloadpercent=sprintf("%.2f",$userloadpercent);
4751: return $userloadpercent;
4752: }
4753:
4754: # Routines for serializing arrays and hashes (copies from lonnet)
4755:
4756: sub array2str {
4757: my (@array) = @_;
4758: my $result=&arrayref2str(\@array);
4759: $result=~s/^__ARRAY_REF__//;
4760: $result=~s/__END_ARRAY_REF__$//;
4761: return $result;
4762: }
4763:
4764: sub arrayref2str {
4765: my ($arrayref) = @_;
4766: my $result='__ARRAY_REF__';
4767: foreach my $elem (@$arrayref) {
4768: if(ref($elem) eq 'ARRAY') {
4769: $result.=&arrayref2str($elem).'&';
4770: } elsif(ref($elem) eq 'HASH') {
4771: $result.=&hashref2str($elem).'&';
4772: } elsif(ref($elem)) {
4773: #print("Got a ref of ".(ref($elem))." skipping.");
4774: } else {
4775: $result.=&escape($elem).'&';
4776: }
4777: }
4778: $result=~s/\&$//;
4779: $result .= '__END_ARRAY_REF__';
4780: return $result;
4781: }
4782:
4783: sub hash2str {
4784: my (%hash) = @_;
4785: my $result=&hashref2str(\%hash);
4786: $result=~s/^__HASH_REF__//;
4787: $result=~s/__END_HASH_REF__$//;
4788: return $result;
4789: }
4790:
4791: sub hashref2str {
4792: my ($hashref)=@_;
4793: my $result='__HASH_REF__';
4794: foreach (sort(keys(%$hashref))) {
4795: if (ref($_) eq 'ARRAY') {
4796: $result.=&arrayref2str($_).'=';
4797: } elsif (ref($_) eq 'HASH') {
4798: $result.=&hashref2str($_).'=';
4799: } elsif (ref($_)) {
4800: $result.='=';
4801: #print("Got a ref of ".(ref($_))." skipping.");
4802: } else {
4803: if ($_) {$result.=&escape($_).'=';} else { last; }
4804: }
4805:
4806: if(ref($hashref->{$_}) eq 'ARRAY') {
4807: $result.=&arrayref2str($hashref->{$_}).'&';
4808: } elsif(ref($hashref->{$_}) eq 'HASH') {
4809: $result.=&hashref2str($hashref->{$_}).'&';
4810: } elsif(ref($hashref->{$_})) {
4811: $result.='&';
4812: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
4813: } else {
4814: $result.=&escape($hashref->{$_}).'&';
4815: }
4816: }
4817: $result=~s/\&$//;
4818: $result .= '__END_HASH_REF__';
4819: return $result;
4820: }
4821:
4822: # ----------------------------------- POD (plain old documentation, CPAN style)
4823:
4824: =head1 NAME
4825:
4826: lond - "LON Daemon" Server (port "LOND" 5663)
4827:
4828: =head1 SYNOPSIS
4829:
4830: Usage: B<lond>
4831:
4832: Should only be run as user=www. This is a command-line script which
4833: is invoked by B<loncron>. There is no expectation that a typical user
4834: will manually start B<lond> from the command-line. (In other words,
4835: DO NOT START B<lond> YOURSELF.)
4836:
4837: =head1 DESCRIPTION
4838:
4839: There are two characteristics associated with the running of B<lond>,
4840: PROCESS MANAGEMENT (starting, stopping, handling child processes)
4841: and SERVER-SIDE ACTIVITIES (password authentication, user creation,
4842: subscriptions, etc). These are described in two large
4843: sections below.
4844:
4845: B<PROCESS MANAGEMENT>
4846:
4847: Preforker - server who forks first. Runs as a daemon. HUPs.
4848: Uses IDEA encryption
4849:
4850: B<lond> forks off children processes that correspond to the other servers
4851: in the network. Management of these processes can be done at the
4852: parent process level or the child process level.
4853:
4854: B<logs/lond.log> is the location of log messages.
4855:
4856: The process management is now explained in terms of linux shell commands,
4857: subroutines internal to this code, and signal assignments:
4858:
4859: =over 4
4860:
4861: =item *
4862:
4863: PID is stored in B<logs/lond.pid>
4864:
4865: This is the process id number of the parent B<lond> process.
4866:
4867: =item *
4868:
4869: SIGTERM and SIGINT
4870:
4871: Parent signal assignment:
4872: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
4873:
4874: Child signal assignment:
4875: $SIG{INT} = 'DEFAULT'; (and SIGTERM is DEFAULT also)
4876: (The child dies and a SIGALRM is sent to parent, awaking parent from slumber
4877: to restart a new child.)
4878:
4879: Command-line invocations:
4880: B<kill> B<-s> SIGTERM I<PID>
4881: B<kill> B<-s> SIGINT I<PID>
4882:
4883: Subroutine B<HUNTSMAN>:
4884: This is only invoked for the B<lond> parent I<PID>.
4885: This kills all the children, and then the parent.
4886: The B<lonc.pid> file is cleared.
4887:
4888: =item *
4889:
4890: SIGHUP
4891:
4892: Current bug:
4893: This signal can only be processed the first time
4894: on the parent process. Subsequent SIGHUP signals
4895: have no effect.
4896:
4897: Parent signal assignment:
4898: $SIG{HUP} = \&HUPSMAN;
4899:
4900: Child signal assignment:
4901: none (nothing happens)
4902:
4903: Command-line invocations:
4904: B<kill> B<-s> SIGHUP I<PID>
4905:
4906: Subroutine B<HUPSMAN>:
4907: This is only invoked for the B<lond> parent I<PID>,
4908: This kills all the children, and then the parent.
4909: The B<lond.pid> file is cleared.
4910:
4911: =item *
4912:
4913: SIGUSR1
4914:
4915: Parent signal assignment:
4916: $SIG{USR1} = \&USRMAN;
4917:
4918: Child signal assignment:
4919: $SIG{USR1}= \&logstatus;
4920:
4921: Command-line invocations:
4922: B<kill> B<-s> SIGUSR1 I<PID>
4923:
4924: Subroutine B<USRMAN>:
4925: When invoked for the B<lond> parent I<PID>,
4926: SIGUSR1 is sent to all the children, and the status of
4927: each connection is logged.
4928:
4929: =item *
4930:
4931: SIGUSR2
4932:
4933: Parent Signal assignment:
4934: $SIG{USR2} = \&UpdateHosts
4935:
4936: Child signal assignment:
4937: NONE
4938:
4939:
4940: =item *
4941:
4942: SIGCHLD
4943:
4944: Parent signal assignment:
4945: $SIG{CHLD} = \&REAPER;
4946:
4947: Child signal assignment:
4948: none
4949:
4950: Command-line invocations:
4951: B<kill> B<-s> SIGCHLD I<PID>
4952:
4953: Subroutine B<REAPER>:
4954: This is only invoked for the B<lond> parent I<PID>.
4955: Information pertaining to the child is removed.
4956: The socket port is cleaned up.
4957:
4958: =back
4959:
4960: B<SERVER-SIDE ACTIVITIES>
4961:
4962: Server-side information can be accepted in an encrypted or non-encrypted
4963: method.
4964:
4965: =over 4
4966:
4967: =item ping
4968:
4969: Query a client in the hosts.tab table; "Are you there?"
4970:
4971: =item pong
4972:
4973: Respond to a ping query.
4974:
4975: =item ekey
4976:
4977: Read in encrypted key, make cipher. Respond with a buildkey.
4978:
4979: =item load
4980:
4981: Respond with CPU load based on a computation upon /proc/loadavg.
4982:
4983: =item currentauth
4984:
4985: Reply with current authentication information (only over an
4986: encrypted channel).
4987:
4988: =item auth
4989:
4990: Only over an encrypted channel, reply as to whether a user's
4991: authentication information can be validated.
4992:
4993: =item passwd
4994:
4995: Allow for a password to be set.
4996:
4997: =item makeuser
4998:
4999: Make a user.
5000:
5001: =item passwd
5002:
5003: Allow for authentication mechanism and password to be changed.
5004:
5005: =item home
5006:
5007: Respond to a question "are you the home for a given user?"
5008:
5009: =item update
5010:
5011: Update contents of a subscribed resource.
5012:
5013: =item unsubscribe
5014:
5015: The server is unsubscribing from a resource.
5016:
5017: =item subscribe
5018:
5019: The server is subscribing to a resource.
5020:
5021: =item log
5022:
5023: Place in B<logs/lond.log>
5024:
5025: =item put
5026:
5027: stores hash in namespace
5028:
5029: =item rolesputy
5030:
5031: put a role into a user's environment
5032:
5033: =item get
5034:
5035: returns hash with keys from array
5036: reference filled in from namespace
5037:
5038: =item eget
5039:
5040: returns hash with keys from array
5041: reference filled in from namesp (encrypts the return communication)
5042:
5043: =item rolesget
5044:
5045: get a role from a user's environment
5046:
5047: =item del
5048:
5049: deletes keys out of array from namespace
5050:
5051: =item keys
5052:
5053: returns namespace keys
5054:
5055: =item dump
5056:
5057: dumps the complete (or key matching regexp) namespace into a hash
5058:
5059: =item store
5060:
5061: stores hash permanently
5062: for this url; hashref needs to be given and should be a \%hashname; the
5063: remaining args aren't required and if they aren't passed or are '' they will
5064: be derived from the ENV
5065:
5066: =item restore
5067:
5068: returns a hash for a given url
5069:
5070: =item querysend
5071:
5072: Tells client about the lonsql process that has been launched in response
5073: to a sent query.
5074:
5075: =item queryreply
5076:
5077: Accept information from lonsql and make appropriate storage in temporary
5078: file space.
5079:
5080: =item idput
5081:
5082: Defines usernames as corresponding to IDs. (These "IDs" are unique identifiers
5083: for each student, defined perhaps by the institutional Registrar.)
5084:
5085: =item idget
5086:
5087: Returns usernames corresponding to IDs. (These "IDs" are unique identifiers
5088: for each student, defined perhaps by the institutional Registrar.)
5089:
5090: =item tmpput
5091:
5092: Accept and store information in temporary space.
5093:
5094: =item tmpget
5095:
5096: Send along temporarily stored information.
5097:
5098: =item ls
5099:
5100: List part of a user's directory.
5101:
5102: =item pushtable
5103:
5104: Pushes a file in /home/httpd/lonTab directory. Currently limited to:
5105: hosts.tab and domain.tab. The old file is copied to *.tab.backup but
5106: must be restored manually in case of a problem with the new table file.
5107: pushtable requires that the request be encrypted and validated via
5108: ValidateManager. The form of the command is:
5109: enc:pushtable tablename <tablecontents> \n
5110: where pushtable, tablename and <tablecontents> will be encrypted, but \n is a
5111: cleartext newline.
5112:
5113: =item Hanging up (exit or init)
5114:
5115: What to do when a client tells the server that they (the client)
5116: are leaving the network.
5117:
5118: =item unknown command
5119:
5120: If B<lond> is sent an unknown command (not in the list above),
5121: it replys to the client "unknown_cmd".
5122:
5123:
5124: =item UNKNOWN CLIENT
5125:
5126: If the anti-spoofing algorithm cannot verify the client,
5127: the client is rejected (with a "refused" message sent
5128: to the client, and the connection is closed.
5129:
5130: =back
5131:
5132: =head1 PREREQUISITES
5133:
5134: IO::Socket
5135: IO::File
5136: Apache::File
5137: Symbol
5138: POSIX
5139: Crypt::IDEA
5140: LWP::UserAgent()
5141: GDBM_File
5142: Authen::Krb4
5143: Authen::Krb5
5144:
5145: =head1 COREQUISITES
5146:
5147: =head1 OSNAMES
5148:
5149: linux
5150:
5151: =head1 SCRIPT CATEGORIES
5152:
5153: Server/Process
5154:
5155: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lond CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom