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