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