Annotation of loncom/lond, revision 1.245
1.1 albertel 1: #!/usr/bin/perl
2: # The LearningOnline Network
3: # lond "LON Daemon" Server (port "LOND" 5663)
1.60 www 4: #
1.245 ! albertel 5: # $Id: lond,v 1.244 2004/08/28 15:52:51 banghart Exp $
1.60 www 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
1.167 foxr 13: # the Free Software Foundation; either version 2 of the License, or
1.60 www 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
1.178 foxr 23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1.60 www 24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
1.161 foxr 27:
28:
1.60 www 29: # http://www.lon-capa.org/
30: #
1.54 harris41 31:
1.134 albertel 32: use strict;
1.80 harris41 33: use lib '/home/httpd/lib/perl/';
34: use LONCAPA::Configuration;
35:
1.1 albertel 36: use IO::Socket;
37: use IO::File;
1.126 albertel 38: #use Apache::File;
1.1 albertel 39: use Symbol;
40: use POSIX;
41: use Crypt::IDEA;
42: use LWP::UserAgent();
1.3 www 43: use GDBM_File;
44: use Authen::Krb4;
1.91 albertel 45: use Authen::Krb5;
1.49 albertel 46: use lib '/home/httpd/lib/perl/';
47: use localauth;
1.193 raeburn 48: use localenroll;
1.143 foxr 49: use File::Copy;
1.169 foxr 50: use LONCAPA::ConfigFileEdit;
1.200 matthew 51: use LONCAPA::lonlocal;
52: use LONCAPA::lonssl;
1.221 albertel 53: use Fcntl qw(:flock);
1.1 albertel 54:
1.239 foxr 55: my $DEBUG = 0; # Non zero to enable debug log entries.
1.77 foxr 56:
1.57 www 57: my $status='';
58: my $lastlog='';
59:
1.245 ! albertel 60: my $VERSION='$Revision: 1.244 $'; #' stupid emacs
1.121 albertel 61: my $remoteVERSION;
1.214 foxr 62: my $currenthostid="default";
1.115 albertel 63: my $currentdomainid;
1.134 albertel 64:
65: my $client;
1.200 matthew 66: my $clientip; # IP address of client.
67: my $clientdns; # DNS name of client.
68: my $clientname; # LonCAPA name of client.
1.140 foxr 69:
1.134 albertel 70: my $server;
1.200 matthew 71: my $thisserver; # DNS of us.
72:
73: my $keymode;
1.198 foxr 74:
1.207 foxr 75: my $cipher; # Cipher key negotiated with client
76: my $tmpsnum = 0; # Id of tmpputs.
77:
1.178 foxr 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: #
1.161 foxr 84:
1.178 foxr 85: my $ConnectionType;
1.161 foxr 86:
1.200 matthew 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.
1.161 foxr 91:
1.178 foxr 92: my %managers; # Ip -> manager names
1.161 foxr 93:
1.178 foxr 94: my %perlvar; # Will have the apache conf defined perl vars.
1.134 albertel 95:
1.178 foxr 96: #
1.207 foxr 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: #
1.178 foxr 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",
1.223 foxr 125: "lcpasswd User already exists",
126: "lcpasswd Something went wrong with user addition.",
127: "lcpasswd Password mismatch",
128: "lcpasswd Error filename is invalid");
1.97 foxr 129:
130:
1.178 foxr 131: # The array below are lcuseradd error strings.:
1.97 foxr 132:
1.178 foxr 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");
1.97 foxr 148:
1.96 foxr 149:
1.207 foxr 150:
151: #
152: # Statistics that are maintained and dislayed in the status line.
153: #
1.212 foxr 154: my $Transactions = 0; # Number of attempted transactions.
155: my $Failures = 0; # Number of transcations failed.
1.207 foxr 156:
157: # ResetStatistics:
158: # Resets the statistics counters:
159: #
160: sub ResetStatistics {
161: $Transactions = 0;
162: $Failures = 0;
163: }
164:
1.200 matthew 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;
1.224 foxr 195: } else {
1.200 matthew 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;
1.224 foxr 326: } else {
1.200 matthew 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:
1.96 foxr 335: #
1.140 foxr 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: }
1.161 foxr 351:
1.178 foxr 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: }
1.161 foxr 364:
365:
1.156 foxr 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:
1.166 foxr 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
1.161 foxr 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: #
1.166 foxr 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: }
1.156 foxr 412: }
1.140 foxr 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:
1.163 foxr 424: return isManager;
1.140 foxr 425: }
426: #
1.143 foxr 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 {
1.192 foxr 438:
439: my ($oldfile, $newfile) = @_;
1.143 foxr 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: }
1.157 foxr 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:
1.166 foxr 498: foreach my $line (split(/\n/,$contents)) {
1.157 foxr 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) {
1.166 foxr 503: my $ip = gethostbyname($name);
504: my $ipnew = inet_ntoa($ip);
505: $ip = $ipnew;
1.157 foxr 506: # Reconstruct the host line and append to adjusted:
507:
1.166 foxr 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";
1.157 foxr 513:
1.166 foxr 514: } else { # Not me, pass unmodified.
515: $adjusted .= $line."\n";
516: }
1.157 foxr 517: } else { # Blank or comment never re-written.
518: $adjusted .= $line."\n"; # Pass blanks and comments as is.
519: }
1.166 foxr 520: }
521: return $adjusted;
1.157 foxr 522: }
1.143 foxr 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 {
1.192 foxr 539:
540: my ($Filename, $Contents) = @_;
1.143 foxr 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: }
1.200 matthew 563:
564:
1.169 foxr 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;
1.143 foxr 588:
1.169 foxr 589: }
1.143 foxr 590: #
1.141 foxr 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:
1.169 foxr 619:
620: my $tablefile = ConfigFileFromSelector($filename);
621: if(! (defined $tablefile)) {
1.141 foxr 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/;
1.143 foxr 631: if(!CopyFile($tablefile, $backupfile)) {
632: &logthis('<font color="green"> CopyFile from '.$tablefile." to ".$backupfile." failed </font>");
633: return "error:$!";
634: }
1.141 foxr 635: &logthis('<font color="green"> Pushfile: backed up '
636: .$tablefile." to $backupfile</font>");
637:
1.157 foxr 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:
1.141 foxr 648: # Install the new file:
649:
1.143 foxr 650: if(!InstallFile($tablefile, $contents)) {
651: &logthis('<font color="red"> Pushfile: unable to install '
1.145 foxr 652: .$tablefile." $! </font>");
1.143 foxr 653: return "error:$!";
1.224 foxr 654: } else {
1.143 foxr 655: &logthis('<font color="green"> Installed new '.$tablefile
656: ."</font>");
657:
658: }
659:
1.141 foxr 660:
661: # Indicate success:
662:
663: return "ok";
664:
665: }
1.145 foxr 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:
1.146 foxr 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);
1.147 foxr 691: my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
1.146 foxr 692: if($process eq 'lonc') {
693: $processpidfile = $processpidfile."lonc.pid";
1.147 foxr 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);
1.146 foxr 702: } elsif ($process eq 'lond') {
1.147 foxr 703: logthis('<font color="red"> Reinitializing self (lond) </font>');
704: &UpdateHosts; # Lond is us!!
1.146 foxr 705: } else {
706: &logthis('<font color="yellow" Invalid reinit request for '.$process
707: ."</font>");
708: return "error:Invalid process identifier $process";
709: }
1.145 foxr 710: return 'ok';
711: }
1.168 foxr 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).
1.167 foxr 718: #
1.168 foxr 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: }
1.169 foxr 744: } elsif ($command eq "replace") {
1.168 foxr 745: #
746: # key and newline:
747: #
748: if (($key eq "") || ($newline eq "")) {
749: return 0;
750: } else {
751: return 1;
752: }
1.169 foxr 753: } elsif ($command eq "append") {
754: if (($key ne "") && ($newline eq "")) {
755: return 1;
756: } else {
757: return 0;
758: }
1.168 foxr 759: } else {
760: return 0; # Invalid command.
761: }
762: return 0; # Should not get here!!!
763: }
1.169 foxr 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 {
1.192 foxr 778:
779: my ($directive, $editor) = @_;
1.169 foxr 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 {
1.192 foxr 863:
864: my ($filename, $editor) = @_;
1.168 foxr 865:
1.169 foxr 866: CopyFile ($filename, $filename.".old");
867:
868: my $contents = $editor->Get(); # Get the contents of the file.
869:
870: InstallFile($filename, $contents);
871: }
1.168 foxr 872: #
873: #
874: # Called to edit a configuration table file
1.167 foxr 875: # Parameters:
876: # request - The entire command/request sent by lonc or lonManage
877: # Return:
878: # The reply to send to the client.
1.168 foxr 879: #
1.167 foxr 880: sub EditFile {
881: my $request = shift;
882:
883: # Split the command into it's pieces: edit:filetype:script
884:
1.168 foxr 885: my ($request, $filetype, $script) = split(/:/, $request,3); # : in script
1.167 foxr 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.
1.168 foxr 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: }
1.145 foxr 907:
1.167 foxr 908: # Execute the edit operation.
1.169 foxr 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);
1.167 foxr 917:
1.169 foxr 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);
1.167 foxr 930:
931: return "ok\n";
932: }
1.207 foxr 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: #
1.209 albertel 955: sub tie_domain_hash {
1.210 albertel 956: my ($domain,$namespace,$how,$loghead,$logtail) = @_;
1.207 foxr 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)) {
1.211 albertel 969: if (defined($loghead)) { # Need to log the operation.
1.210 albertel 970: my $logFh = IO::File->new(">>$domain_dir/$namespace.hist");
1.207 foxr 971: if($logFh) {
972: my $timestamp = time;
973: print $logFh "$loghead:$timestamp:$logtail\n";
974: }
1.210 albertel 975: $logFh->close;
1.207 foxr 976: }
977: return \%hash; # Return the tied hash.
1.210 albertel 978: } else {
1.207 foxr 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: #
1.210 albertel 1002: sub tie_user_hash {
1003: my ($domain,$user,$namespace,$how,$loghead,$what) = @_;
1.207 foxr 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)) {
1.209 albertel 1014: # If this is a namespace for which a history is kept,
1015: # make the history log entry:
1.211 albertel 1016: if (($namespace =~/^nohist\_/) && (defined($loghead))) {
1.209 albertel 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: }
1.210 albertel 1024: $hfh->close;
1.209 albertel 1025: }
1.207 foxr 1026: return \%hash;
1.209 albertel 1027: } else {
1.207 foxr 1028: return undef;
1029: }
1030:
1031: }
1.214 foxr 1032:
1033: #--------------------- Request Handlers --------------------------------------------
1034: #
1.215 foxr 1035: # By convention each request handler registers itself prior to the sub
1036: # declaration:
1.214 foxr 1037: #
1038:
1.216 foxr 1039: #++
1040: #
1.214 foxr 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:
1.216 foxr 1065: #++
1.215 foxr 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:
1.216 foxr 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:
1.215 foxr 1137:
1.217 foxr 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:
1.218 foxr 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.
1.222 foxr 1223: # and call get_auth_type to determine the authentication type.
1.218 foxr 1224:
1225: my ($udom,$uname)=split(/:/,$tail);
1.222 foxr 1226: my $result = &get_auth_type($udom, $uname);
1.218 foxr 1227: if($result eq "nouser") {
1228: &Failure( $replyfd, "unknown_user\n", $userinput);
1229: } else {
1230: #
1.222 foxr 1231: # We only want to pass the second field from get_auth_type
1.218 foxr 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: }
1.222 foxr 1239: &Reply( $replyfd, "$type:\n", $userinput);
1.218 foxr 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: }
1.219 foxr 1281: return 1;
1.218 foxr 1282: }
1283: ®ister_handler("pushfile", \&push_file_handler, 1, 0, 1);
1284:
1.243 banghart 1285: #
1286: # du - list the disk usuage of a directory recursively.
1287: #
1288: # note: stolen code from the ls file handler
1289: # under construction by Rick Banghart
1290: # .
1291: # Parameters:
1292: # $cmd - The command that dispatched us (du).
1293: # $ududir - The directory path to list... I'm not sure what this
1294: # is relative as things like ls:. return e.g.
1295: # no_such_dir.
1296: # $client - Socket open on the client.
1297: # Returns:
1298: # 1 - indicating that the daemon should not disconnect.
1299: # Side Effects:
1300: # The reply is written to $client.
1301: #
1.244 banghart 1302:
1.243 banghart 1303: sub du_handler {
1304: my ($cmd, $ududir, $client) = @_;
1.245 ! albertel 1305: if ($ududir=~/\.\./ || $ududir!~m|^/home/httpd/|) {
! 1306: &Failure($client,"refused\n","$cmd:$ududir");
! 1307: return 1;
! 1308: }
! 1309: my $duout = `du -ks $ududir 2>/dev/null`;
! 1310: $duout=~s/[^\d]//g; #preserve only the numbers
! 1311: &Reply($client,"$duout\n","$cmd:$ududir");
1.243 banghart 1312: return 1;
1313: }
1314: ®ister_handler("du", \&du_handler, 0, 1, 0);
1.218 foxr 1315:
1316:
1.239 foxr 1317: #
1318: # ls - list the contents of a directory. For each file in the
1319: # selected directory the filename followed by the full output of
1320: # the stat function is returned. The returned info for each
1321: # file are separated by ':'. The stat fields are separated by &'s.
1322: # Parameters:
1323: # $cmd - The command that dispatched us (ls).
1324: # $ulsdir - The directory path to list... I'm not sure what this
1325: # is relative as things like ls:. return e.g.
1326: # no_such_dir.
1327: # $client - Socket open on the client.
1328: # Returns:
1329: # 1 - indicating that the daemon should not disconnect.
1330: # Side Effects:
1331: # The reply is written to $client.
1332: #
1333: sub ls_handler {
1334: my ($cmd, $ulsdir, $client) = @_;
1335:
1336: my $userinput = "$cmd:$ulsdir";
1337:
1338: my $obs;
1339: my $rights;
1340: my $ulsout='';
1341: my $ulsfn;
1342: if (-e $ulsdir) {
1343: if(-d $ulsdir) {
1344: if (opendir(LSDIR,$ulsdir)) {
1345: while ($ulsfn=readdir(LSDIR)) {
1346: undef $obs, $rights;
1347: my @ulsstats=stat($ulsdir.'/'.$ulsfn);
1348: #We do some obsolete checking here
1349: if(-e $ulsdir.'/'.$ulsfn.".meta") {
1350: open(FILE, $ulsdir.'/'.$ulsfn.".meta");
1351: my @obsolete=<FILE>;
1352: foreach my $obsolete (@obsolete) {
1353: if($obsolete =~ m|(<obsolete>)(on)|) { $obs = 1; }
1354: if($obsolete =~ m|(<copyright>)(default)|) { $rights = 1; }
1355: }
1356: }
1357: $ulsout.=$ulsfn.'&'.join('&',@ulsstats);
1358: if($obs eq '1') { $ulsout.="&1"; }
1359: else { $ulsout.="&0"; }
1360: if($rights eq '1') { $ulsout.="&1:"; }
1361: else { $ulsout.="&0:"; }
1362: }
1363: closedir(LSDIR);
1364: }
1365: } else {
1366: my @ulsstats=stat($ulsdir);
1367: $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
1368: }
1369: } else {
1370: $ulsout='no_such_dir';
1371: }
1372: if ($ulsout eq '') { $ulsout='empty'; }
1373: print $client "$ulsout\n";
1374:
1375: return 1;
1376:
1377: }
1378: ®ister_handler("ls", \&ls_handler, 0, 1, 0);
1379:
1.238 foxr 1380:
1.243 banghart 1381:
1382:
1.218 foxr 1383: # Process a reinit request. Reinit requests that either
1384: # lonc or lond be reinitialized so that an updated
1385: # host.tab or domain.tab can be processed.
1386: #
1387: # Parameters:
1388: # $cmd - the actual keyword that invoked us.
1389: # $tail - the tail of the request that invoked us.
1390: # $client - File descriptor connected to the client
1391: # Returns:
1392: # 1 - Ok to continue processing.
1393: # 0 - Program should exit
1394: # Implicit output:
1395: # a reply is sent to the client.
1396: #
1397: sub reinit_process_handler {
1398: my ($cmd, $tail, $client) = @_;
1399:
1400: my $userinput = "$cmd:$tail";
1401:
1402: my $cert = &GetCertificate($userinput);
1403: if(&ValidManager($cert)) {
1404: chomp($userinput);
1405: my $reply = &ReinitProcess($userinput);
1406: &Reply( $client, "$reply\n", $userinput);
1407: } else {
1408: &Failure( $client, "refused\n", $userinput);
1409: }
1410: return 1;
1411: }
1412:
1413: ®ister_handler("reinit", \&reinit_process_handler, 1, 0, 1);
1414:
1415: # Process the editing script for a table edit operation.
1416: # the editing operation must be encrypted and requested by
1417: # a manager host.
1418: #
1419: # Parameters:
1420: # $cmd - the actual keyword that invoked us.
1421: # $tail - the tail of the request that invoked us.
1422: # $client - File descriptor connected to the client
1423: # Returns:
1424: # 1 - Ok to continue processing.
1425: # 0 - Program should exit
1426: # Implicit output:
1427: # a reply is sent to the client.
1428: #
1429: sub edit_table_handler {
1430: my ($command, $tail, $client) = @_;
1431:
1432: my $userinput = "$command:$tail";
1433:
1434: my $cert = &GetCertificate($userinput);
1435: if(&ValidManager($cert)) {
1436: my($filetype, $script) = split(/:/, $tail);
1437: if (($filetype eq "hosts") ||
1438: ($filetype eq "domain")) {
1439: if($script ne "") {
1440: &Reply($client, # BUGBUG - EditFile
1441: &EditFile($userinput), # could fail.
1442: $userinput);
1443: } else {
1444: &Failure($client,"refused\n",$userinput);
1445: }
1446: } else {
1447: &Failure($client,"refused\n",$userinput);
1448: }
1449: } else {
1450: &Failure($client,"refused\n",$userinput);
1451: }
1452: return 1;
1453: }
1454: register_handler("edit", \&edit_table_handler, 1, 0, 1);
1455:
1456:
1.220 foxr 1457: #
1458: # Authenticate a user against the LonCAPA authentication
1459: # database. Note that there are several authentication
1460: # possibilities:
1461: # - unix - The user can be authenticated against the unix
1462: # password file.
1463: # - internal - The user can be authenticated against a purely
1464: # internal per user password file.
1465: # - kerberos - The user can be authenticated against either a kerb4 or kerb5
1466: # ticket granting authority.
1467: # - user - The person tailoring LonCAPA can supply a user authentication
1468: # mechanism that is per system.
1469: #
1470: # Parameters:
1471: # $cmd - The command that got us here.
1472: # $tail - Tail of the command (remaining parameters).
1473: # $client - File descriptor connected to client.
1474: # Returns
1475: # 0 - Requested to exit, caller should shut down.
1476: # 1 - Continue processing.
1477: # Implicit inputs:
1478: # The authentication systems describe above have their own forms of implicit
1479: # input into the authentication process that are described above.
1480: #
1481: sub authenticate_handler {
1482: my ($cmd, $tail, $client) = @_;
1483:
1484:
1485: # Regenerate the full input line
1486:
1487: my $userinput = $cmd.":".$tail;
1488:
1489: # udom - User's domain.
1490: # uname - Username.
1491: # upass - User's password.
1492:
1493: my ($udom,$uname,$upass)=split(/:/,$tail);
1494: &Debug(" Authenticate domain = $udom, user = $uname, password = $upass");
1495: chomp($upass);
1496: $upass=&unescape($upass);
1497:
1498: my $pwdcorrect = &validate_user($udom, $uname, $upass);
1499: if($pwdcorrect) {
1500: &Reply( $client, "authorized\n", $userinput);
1501: #
1502: # Bad credentials: Failed to authorize
1503: #
1504: } else {
1505: &Failure( $client, "non_authorized\n", $userinput);
1506: }
1507:
1508: return 1;
1509: }
1.218 foxr 1510:
1.220 foxr 1511: register_handler("auth", \&authenticate_handler, 1, 1, 0);
1.214 foxr 1512:
1.222 foxr 1513: #
1514: # Change a user's password. Note that this function is complicated by
1515: # the fact that a user may be authenticated in more than one way:
1516: # At present, we are not able to change the password for all types of
1517: # authentication methods. Only for:
1518: # unix - unix password or shadow passoword style authentication.
1519: # local - Locally written authentication mechanism.
1520: # For now, kerb4 and kerb5 password changes are not supported and result
1521: # in an error.
1522: # FUTURE WORK:
1523: # Support kerberos passwd changes?
1524: # Parameters:
1525: # $cmd - The command that got us here.
1526: # $tail - Tail of the command (remaining parameters).
1527: # $client - File descriptor connected to client.
1528: # Returns
1529: # 0 - Requested to exit, caller should shut down.
1530: # 1 - Continue processing.
1531: # Implicit inputs:
1532: # The authentication systems describe above have their own forms of implicit
1533: # input into the authentication process that are described above.
1534: sub change_password_handler {
1535: my ($cmd, $tail, $client) = @_;
1536:
1537: my $userinput = $cmd.":".$tail; # Reconstruct client's string.
1538:
1539: #
1540: # udom - user's domain.
1541: # uname - Username.
1542: # upass - Current password.
1543: # npass - New password.
1544:
1545: my ($udom,$uname,$upass,$npass)=split(/:/,$tail);
1546:
1547: $upass=&unescape($upass);
1548: $npass=&unescape($npass);
1549: &Debug("Trying to change password for $uname");
1550:
1551: # First require that the user can be authenticated with their
1552: # old password:
1553:
1554: my $validated = &validate_user($udom, $uname, $upass);
1555: if($validated) {
1556: my $realpasswd = &get_auth_type($udom, $uname); # Defined since authd.
1557:
1558: my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
1559: if ($howpwd eq 'internal') {
1560: &Debug("internal auth");
1561: my $salt=time;
1562: $salt=substr($salt,6,2);
1563: my $ncpass=crypt($npass,$salt);
1564: if(&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
1565: &logthis("Result of password change for "
1566: ."$uname: pwchange_success");
1567: &Reply($client, "ok\n", $userinput);
1568: } else {
1569: &logthis("Unable to open $uname passwd "
1570: ."to change password");
1571: &Failure( $client, "non_authorized\n",$userinput);
1572: }
1573: } elsif ($howpwd eq 'unix') {
1574: # Unix means we have to access /etc/password
1575: &Debug("auth is unix");
1576: my $execdir=$perlvar{'lonDaemons'};
1577: &Debug("Opening lcpasswd pipeline");
1578: my $pf = IO::File->new("|$execdir/lcpasswd > "
1579: ."$perlvar{'lonDaemons'}"
1580: ."/logs/lcpasswd.log");
1581: print $pf "$uname\n$npass\n$npass\n";
1582: close $pf;
1583: my $err = $?;
1584: my $result = ($err>0 ? 'pwchange_failure' : 'ok');
1585: &logthis("Result of password change for $uname: ".
1586: &lcpasswdstrerror($?));
1587: &Reply($client, "$result\n", $userinput);
1588: } else {
1589: # this just means that the current password mode is not
1590: # one we know how to change (e.g the kerberos auth modes or
1591: # locally written auth handler).
1592: #
1593: &Failure( $client, "auth_mode_error\n", $userinput);
1594: }
1595:
1.224 foxr 1596: } else {
1.222 foxr 1597: &Failure( $client, "non_authorized\n", $userinput);
1598: }
1599:
1600: return 1;
1601: }
1602: register_handler("passwd", \&change_password_handler, 1, 1, 0);
1603:
1604:
1.225 foxr 1605: #
1606: # Create a new user. User in this case means a lon-capa user.
1607: # The user must either already exist in some authentication realm
1608: # like kerberos or the /etc/passwd. If not, a user completely local to
1609: # this loncapa system is created.
1610: #
1611: # Parameters:
1612: # $cmd - The command that got us here.
1613: # $tail - Tail of the command (remaining parameters).
1614: # $client - File descriptor connected to client.
1615: # Returns
1616: # 0 - Requested to exit, caller should shut down.
1617: # 1 - Continue processing.
1618: # Implicit inputs:
1619: # The authentication systems describe above have their own forms of implicit
1620: # input into the authentication process that are described above.
1621: sub add_user_handler {
1622:
1623: my ($cmd, $tail, $client) = @_;
1624:
1625:
1626: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1627: my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
1628:
1629: &Debug("cmd =".$cmd." $udom =".$udom." uname=".$uname);
1630:
1631:
1632: if($udom eq $currentdomainid) { # Reject new users for other domains...
1633:
1634: my $oldumask=umask(0077);
1635: chomp($npass);
1636: $npass=&unescape($npass);
1637: my $passfilename = &password_path($udom, $uname);
1638: &Debug("Password file created will be:".$passfilename);
1639: if (-e $passfilename) {
1640: &Failure( $client, "already_exists\n", $userinput);
1641: } else {
1642: my @fpparts=split(/\//,$passfilename);
1643: my $fpnow=$fpparts[0].'/'.$fpparts[1].'/'.$fpparts[2];
1644: my $fperror='';
1645: for (my $i=3;$i<= ($#fpparts-1);$i++) {
1646: $fpnow.='/'.$fpparts[$i];
1647: unless (-e $fpnow) {
1648: &logthis("mkdir $fpnow");
1649: unless (mkdir($fpnow,0777)) {
1650: $fperror="error: ".($!+0)." mkdir failed while attempting "
1651: ."makeuser";
1652: }
1653: }
1654: }
1655: unless ($fperror) {
1656: my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);
1657: &Reply($client, $result, $userinput); #BUGBUG - could be fail
1658: } else {
1659: &Failure($client, "$fperror\n", $userinput);
1660: }
1661: }
1662: umask($oldumask);
1663: } else {
1664: &Failure($client, "not_right_domain\n",
1665: $userinput); # Even if we are multihomed.
1666:
1667: }
1668: return 1;
1669:
1670: }
1671: ®ister_handler("makeuser", \&add_user_handler, 1, 1, 0);
1672:
1673: #
1674: # Change the authentication method of a user. Note that this may
1675: # also implicitly change the user's password if, for example, the user is
1676: # joining an existing authentication realm. Known authentication realms at
1677: # this time are:
1678: # internal - Purely internal password file (only loncapa knows this user)
1679: # local - Institutionally written authentication module.
1680: # unix - Unix user (/etc/passwd with or without /etc/shadow).
1681: # kerb4 - kerberos version 4
1682: # kerb5 - kerberos version 5
1683: #
1684: # Parameters:
1685: # $cmd - The command that got us here.
1686: # $tail - Tail of the command (remaining parameters).
1687: # $client - File descriptor connected to client.
1688: # Returns
1689: # 0 - Requested to exit, caller should shut down.
1690: # 1 - Continue processing.
1691: # Implicit inputs:
1692: # The authentication systems describe above have their own forms of implicit
1693: # input into the authentication process that are described above.
1694: #
1695: sub change_authentication_handler {
1696:
1697: my ($cmd, $tail, $client) = @_;
1698:
1699: my $userinput = "$cmd:$tail"; # Reconstruct user input.
1700:
1701: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1702: &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
1703: if ($udom ne $currentdomainid) {
1704: &Failure( $client, "not_right_domain\n", $client);
1705: } else {
1706:
1707: chomp($npass);
1708:
1709: $npass=&unescape($npass);
1710: my $passfilename = &password_path($udom, $uname);
1711: if ($passfilename) { # Not allowed to create a new user!!
1712: my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
1713: &Reply($client, $result, $userinput);
1714: } else {
1715: &Failure($client, "non_authorized", $userinput); # Fail the user now.
1716: }
1717: }
1718: return 1;
1719: }
1720: ®ister_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
1721:
1722: #
1723: # Determines if this is the home server for a user. The home server
1724: # for a user will have his/her lon-capa passwd file. Therefore all we need
1725: # to do is determine if this file exists.
1726: #
1727: # Parameters:
1728: # $cmd - The command that got us here.
1729: # $tail - Tail of the command (remaining parameters).
1730: # $client - File descriptor connected to client.
1731: # Returns
1732: # 0 - Requested to exit, caller should shut down.
1733: # 1 - Continue processing.
1734: # Implicit inputs:
1735: # The authentication systems describe above have their own forms of implicit
1736: # input into the authentication process that are described above.
1737: #
1738: sub is_home_handler {
1739: my ($cmd, $tail, $client) = @_;
1740:
1741: my $userinput = "$cmd:$tail";
1742:
1743: my ($udom,$uname)=split(/:/,$tail);
1744: chomp($uname);
1745: my $passfile = &password_filename($udom, $uname);
1746: if($passfile) {
1747: &Reply( $client, "found\n", $userinput);
1748: } else {
1749: &Failure($client, "not_found\n", $userinput);
1750: }
1751: return 1;
1752: }
1753: ®ister_handler("home", \&is_home_handler, 0,1,0);
1754:
1755: #
1756: # Process an update request for a resource?? I think what's going on here is
1757: # that a resource has been modified that we hold a subscription to.
1758: # If the resource is not local, then we must update, or at least invalidate our
1759: # cached copy of the resource.
1760: # FUTURE WORK:
1761: # I need to look at this logic carefully. My druthers would be to follow
1762: # typical caching logic, and simple invalidate the cache, drop any subscription
1763: # an let the next fetch start the ball rolling again... however that may
1764: # actually be more difficult than it looks given the complex web of
1765: # proxy servers.
1766: # Parameters:
1767: # $cmd - The command that got us here.
1768: # $tail - Tail of the command (remaining parameters).
1769: # $client - File descriptor connected to client.
1770: # Returns
1771: # 0 - Requested to exit, caller should shut down.
1772: # 1 - Continue processing.
1773: # Implicit inputs:
1774: # The authentication systems describe above have their own forms of implicit
1775: # input into the authentication process that are described above.
1776: #
1777: sub update_resource_handler {
1778:
1779: my ($cmd, $tail, $client) = @_;
1780:
1781: my $userinput = "$cmd:$tail";
1782:
1783: my $fname= $tail; # This allows interactive testing
1784:
1785:
1786: my $ownership=ishome($fname);
1787: if ($ownership eq 'not_owner') {
1788: if (-e $fname) {
1789: my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
1790: $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);
1791: my $now=time;
1792: my $since=$now-$atime;
1793: if ($since>$perlvar{'lonExpire'}) {
1794: my $reply=&reply("unsub:$fname","$clientname");
1795: unlink("$fname");
1796: } else {
1797: my $transname="$fname.in.transfer";
1798: my $remoteurl=&reply("sub:$fname","$clientname");
1799: my $response;
1800: alarm(120);
1801: {
1802: my $ua=new LWP::UserAgent;
1803: my $request=new HTTP::Request('GET',"$remoteurl");
1804: $response=$ua->request($request,$transname);
1805: }
1806: alarm(0);
1807: if ($response->is_error()) {
1808: unlink($transname);
1809: my $message=$response->status_line;
1810: &logthis("LWP GET: $message for $fname ($remoteurl)");
1811: } else {
1812: if ($remoteurl!~/\.meta$/) {
1813: alarm(120);
1814: {
1815: my $ua=new LWP::UserAgent;
1816: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1817: my $mresponse=$ua->request($mrequest,$fname.'.meta');
1818: if ($mresponse->is_error()) {
1819: unlink($fname.'.meta');
1820: }
1821: }
1822: alarm(0);
1823: }
1824: rename($transname,$fname);
1825: }
1826: }
1827: &Reply( $client, "ok\n", $userinput);
1828: } else {
1829: &Failure($client, "not_found\n", $userinput);
1830: }
1831: } else {
1832: &Failure($client, "rejected\n", $userinput);
1833: }
1834: return 1;
1835: }
1836: ®ister_handler("update", \&update_resource_handler, 0 ,1, 0);
1837:
1838: #
1.226 foxr 1839: # Fetch a user file from a remote server to the user's home directory
1840: # userfiles subdir.
1.225 foxr 1841: # Parameters:
1842: # $cmd - The command that got us here.
1843: # $tail - Tail of the command (remaining parameters).
1844: # $client - File descriptor connected to client.
1845: # Returns
1846: # 0 - Requested to exit, caller should shut down.
1847: # 1 - Continue processing.
1848: #
1849: sub fetch_user_file_handler {
1850:
1851: my ($cmd, $tail, $client) = @_;
1852:
1853: my $userinput = "$cmd:$tail";
1854: my $fname = $tail;
1.232 foxr 1855: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
1.225 foxr 1856: my $udir=&propath($udom,$uname).'/userfiles';
1857: unless (-e $udir) {
1858: mkdir($udir,0770);
1859: }
1.232 foxr 1860: Debug("fetch user file for $fname");
1.225 foxr 1861: if (-e $udir) {
1862: $ufile=~s/^[\.\~]+//;
1.232 foxr 1863:
1864: # IF necessary, create the path right down to the file.
1865: # Note that any regular files in the way of this path are
1866: # wiped out to deal with some earlier folly of mine.
1867:
1868: my $path = $udir;
1869: if ($ufile =~m|(.+)/([^/]+)$|) {
1870: my @parts=split('/',$1);
1871: foreach my $part (@parts) {
1872: $path .= '/'.$part;
1873: if( -f $path) {
1874: unlink($path);
1875: }
1876: if ((-e $path)!=1) {
1877: mkdir($path,0770);
1878: }
1879: }
1880: }
1881:
1882:
1.225 foxr 1883: my $destname=$udir.'/'.$ufile;
1884: my $transname=$udir.'/'.$ufile.'.in.transit';
1885: my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;
1886: my $response;
1.232 foxr 1887: Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
1.225 foxr 1888: alarm(120);
1889: {
1890: my $ua=new LWP::UserAgent;
1891: my $request=new HTTP::Request('GET',"$remoteurl");
1892: $response=$ua->request($request,$transname);
1893: }
1894: alarm(0);
1895: if ($response->is_error()) {
1896: unlink($transname);
1897: my $message=$response->status_line;
1898: &logthis("LWP GET: $message for $fname ($remoteurl)");
1899: &Failure($client, "failed\n", $userinput);
1900: } else {
1.232 foxr 1901: Debug("Renaming $transname to $destname");
1.225 foxr 1902: if (!rename($transname,$destname)) {
1903: &logthis("Unable to move $transname to $destname");
1904: unlink($transname);
1905: &Failure($client, "failed\n", $userinput);
1906: } else {
1907: &Reply($client, "ok\n", $userinput);
1908: }
1909: }
1910: } else {
1911: &Failure($client, "not_home\n", $userinput);
1912: }
1913: return 1;
1914: }
1915: ®ister_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
1916:
1.226 foxr 1917: #
1918: # Remove a file from a user's home directory userfiles subdirectory.
1919: # Parameters:
1920: # cmd - the Lond request keyword that got us here.
1921: # tail - the part of the command past the keyword.
1922: # client- File descriptor connected with the client.
1923: #
1924: # Returns:
1925: # 1 - Continue processing.
1926:
1927: sub remove_user_file_handler {
1928: my ($cmd, $tail, $client) = @_;
1929:
1930: my ($fname) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
1931:
1932: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
1933: if ($ufile =~m|/\.\./|) {
1934: # any files paths with /../ in them refuse
1935: # to deal with
1936: &Failure($client, "refused\n", "$cmd:$tail");
1937: } else {
1938: my $udir = &propath($udom,$uname);
1939: if (-e $udir) {
1940: my $file=$udir.'/userfiles/'.$ufile;
1941: if (-e $file) {
1.240 banghart 1942: if (-f $file){
1.241 albertel 1943: unlink($file);
1944: } elsif(-d $file) {
1945: rmdir($file);
1.240 banghart 1946: }
1.226 foxr 1947: if (-e $file) {
1948: &Failure($client, "failed\n", "$cmd:$tail");
1949: } else {
1950: &Reply($client, "ok\n", "$cmd:$tail");
1951: }
1952: } else {
1953: &Failure($client, "not_found\n", "$cmd:$tail");
1954: }
1955: } else {
1956: &Failure($client, "not_home\n", "$cmd:$tail");
1957: }
1958: }
1959: return 1;
1960: }
1961: ®ister_handler("removeuserfile", \&remove_user_file_handler, 0,1,0);
1962:
1.236 albertel 1963: #
1964: # make a directory in a user's home directory userfiles subdirectory.
1965: # Parameters:
1966: # cmd - the Lond request keyword that got us here.
1967: # tail - the part of the command past the keyword.
1968: # client- File descriptor connected with the client.
1969: #
1970: # Returns:
1971: # 1 - Continue processing.
1972:
1973: sub mkdir_user_file_handler {
1974: my ($cmd, $tail, $client) = @_;
1975:
1976: my ($dir) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
1977: $dir=&unescape($dir);
1978: my ($udom,$uname,$ufile) = ($dir =~ m|^([^/]+)/([^/]+)/(.+)$|);
1979: if ($ufile =~m|/\.\./|) {
1980: # any files paths with /../ in them refuse
1981: # to deal with
1982: &Failure($client, "refused\n", "$cmd:$tail");
1983: } else {
1984: my $udir = &propath($udom,$uname);
1985: if (-e $udir) {
1986: my $newdir=$udir.'/userfiles/'.$ufile;
1987: if (!-e $newdir) {
1988: mkdir($newdir);
1989: if (!-e $newdir) {
1990: &Failure($client, "failed\n", "$cmd:$tail");
1991: } else {
1992: &Reply($client, "ok\n", "$cmd:$tail");
1993: }
1994: } else {
1995: &Failure($client, "not_found\n", "$cmd:$tail");
1996: }
1997: } else {
1998: &Failure($client, "not_home\n", "$cmd:$tail");
1999: }
2000: }
2001: return 1;
2002: }
2003: ®ister_handler("mkdiruserfile", \&mkdir_user_file_handler, 0,1,0);
2004:
1.237 albertel 2005: #
2006: # rename a file in a user's home directory userfiles subdirectory.
2007: # Parameters:
2008: # cmd - the Lond request keyword that got us here.
2009: # tail - the part of the command past the keyword.
2010: # client- File descriptor connected with the client.
2011: #
2012: # Returns:
2013: # 1 - Continue processing.
2014:
2015: sub rename_user_file_handler {
2016: my ($cmd, $tail, $client) = @_;
2017:
2018: my ($udom,$uname,$old,$new) = split(/:/, $tail);
2019: $old=&unescape($old);
2020: $new=&unescape($new);
2021: if ($new =~m|/\.\./| || $old =~m|/\.\./|) {
2022: # any files paths with /../ in them refuse to deal with
2023: &Failure($client, "refused\n", "$cmd:$tail");
2024: } else {
2025: my $udir = &propath($udom,$uname);
2026: if (-e $udir) {
2027: my $oldfile=$udir.'/userfiles/'.$old;
2028: my $newfile=$udir.'/userfiles/'.$new;
2029: if (-e $newfile) {
2030: &Failure($client, "exists\n", "$cmd:$tail");
2031: } elsif (! -e $oldfile) {
2032: &Failure($client, "not_found\n", "$cmd:$tail");
2033: } else {
2034: if (!rename($oldfile,$newfile)) {
2035: &Failure($client, "failed\n", "$cmd:$tail");
2036: } else {
2037: &Reply($client, "ok\n", "$cmd:$tail");
2038: }
2039: }
2040: } else {
2041: &Failure($client, "not_home\n", "$cmd:$tail");
2042: }
2043: }
2044: return 1;
2045: }
2046: ®ister_handler("renameuserfile", \&rename_user_file_handler, 0,1,0);
2047:
1.227 foxr 2048:
2049: #
2050: # Authenticate access to a user file by checking the user's
2051: # session token(?)
2052: #
2053: # Parameters:
2054: # cmd - The request keyword that dispatched to tus.
2055: # tail - The tail of the request (colon separated parameters).
2056: # client - Filehandle open on the client.
2057: # Return:
2058: # 1.
2059:
2060: sub token_auth_user_file_handler {
2061: my ($cmd, $tail, $client) = @_;
2062:
2063: my ($fname, $session) = split(/:/, $tail);
2064:
2065: chomp($session);
2066: my $reply='non_auth';
2067: if (open(ENVIN,$perlvar{'lonIDsDir'}.'/'.
2068: $session.'.id')) {
2069: while (my $line=<ENVIN>) {
2070: if ($line=~ m|userfile\.\Q$fname\E\=|) { $reply='ok'; }
2071: }
2072: close(ENVIN);
2073: &Reply($client, $reply);
2074: } else {
2075: &Failure($client, "invalid_token\n", "$cmd:$tail");
2076: }
2077: return 1;
2078:
2079: }
2080:
2081: ®ister_handler("tokenauthuserfile", \&token_auth_user_file_handler, 0,1,0);
1.229 foxr 2082:
2083:
2084: #
2085: # Unsubscribe from a resource.
2086: #
2087: # Parameters:
2088: # $cmd - The command that got us here.
2089: # $tail - Tail of the command (remaining parameters).
2090: # $client - File descriptor connected to client.
2091: # Returns
2092: # 0 - Requested to exit, caller should shut down.
2093: # 1 - Continue processing.
2094: #
2095: sub unsubscribe_handler {
2096: my ($cmd, $tail, $client) = @_;
2097:
2098: my $userinput= "$cmd:$tail";
2099:
2100: my ($fname) = split(/:/,$tail); # Split in case there's extrs.
2101:
2102: &Debug("Unsubscribing $fname");
2103: if (-e $fname) {
2104: &Debug("Exists");
2105: &Reply($client, &unsub($fname,$clientip), $userinput);
2106: } else {
2107: &Failure($client, "not_found\n", $userinput);
2108: }
2109: return 1;
2110: }
2111: ®ister_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
1.230 foxr 2112: # Subscribe to a resource
2113: #
2114: # Parameters:
2115: # $cmd - The command that got us here.
2116: # $tail - Tail of the command (remaining parameters).
2117: # $client - File descriptor connected to client.
2118: # Returns
2119: # 0 - Requested to exit, caller should shut down.
2120: # 1 - Continue processing.
2121: #
2122: sub subscribe_handler {
2123: my ($cmd, $tail, $client)= @_;
2124:
2125: my $userinput = "$cmd:$tail";
2126:
2127: &Reply( $client, &subscribe($userinput,$clientip), $userinput);
2128:
2129: return 1;
2130: }
2131: ®ister_handler("sub", \&subscribe_handler, 0, 1, 0);
2132:
2133: #
2134: # Determine the version of a resource (?) Or is it return
2135: # the top version of the resource? Not yet clear from the
2136: # code in currentversion.
2137: #
2138: # Parameters:
2139: # $cmd - The command that got us here.
2140: # $tail - Tail of the command (remaining parameters).
2141: # $client - File descriptor connected to client.
2142: # Returns
2143: # 0 - Requested to exit, caller should shut down.
2144: # 1 - Continue processing.
2145: #
2146: sub current_version_handler {
2147: my ($cmd, $tail, $client) = @_;
2148:
2149: my $userinput= "$cmd:$tail";
2150:
2151: my $fname = $tail;
2152: &Reply( $client, ¤tversion($fname)."\n", $userinput);
2153: return 1;
2154:
2155: }
2156: ®ister_handler("currentversion", \¤t_version_handler, 0, 1, 0);
2157:
2158: # Make an entry in a user's activity log.
2159: #
2160: # Parameters:
2161: # $cmd - The command that got us here.
2162: # $tail - Tail of the command (remaining parameters).
2163: # $client - File descriptor connected to client.
2164: # Returns
2165: # 0 - Requested to exit, caller should shut down.
2166: # 1 - Continue processing.
2167: #
2168: sub activity_log_handler {
2169: my ($cmd, $tail, $client) = @_;
2170:
2171:
2172: my $userinput= "$cmd:$tail";
2173:
2174: my ($udom,$uname,$what)=split(/:/,$tail);
2175: chomp($what);
2176: my $proname=&propath($udom,$uname);
2177: my $now=time;
2178: my $hfh;
2179: if ($hfh=IO::File->new(">>$proname/activity.log")) {
2180: print $hfh "$now:$clientname:$what\n";
2181: &Reply( $client, "ok\n", $userinput);
2182: } else {
2183: &Failure($client, "error: ".($!+0)." IO::File->new Failed "
2184: ."while attempting log\n",
2185: $userinput);
2186: }
2187:
2188: return 1;
2189: }
2190: register_handler("log", \&activity_log_handler, 0, 1, 0);
2191:
2192: #
2193: # Put a namespace entry in a user profile hash.
2194: # My druthers would be for this to be an encrypted interaction too.
2195: # anything that might be an inadvertent covert channel about either
2196: # user authentication or user personal information....
2197: #
2198: # Parameters:
2199: # $cmd - The command that got us here.
2200: # $tail - Tail of the command (remaining parameters).
2201: # $client - File descriptor connected to client.
2202: # Returns
2203: # 0 - Requested to exit, caller should shut down.
2204: # 1 - Continue processing.
2205: #
2206: sub put_user_profile_entry {
2207: my ($cmd, $tail, $client) = @_;
1.229 foxr 2208:
1.230 foxr 2209: my $userinput = "$cmd:$tail";
2210:
1.242 raeburn 2211: my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
1.230 foxr 2212: if ($namespace ne 'roles') {
2213: chomp($what);
2214: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2215: &GDBM_WRCREAT(),"P",$what);
2216: if($hashref) {
2217: my @pairs=split(/\&/,$what);
2218: foreach my $pair (@pairs) {
2219: my ($key,$value)=split(/=/,$pair);
2220: $hashref->{$key}=$value;
2221: }
2222: if (untie(%$hashref)) {
2223: &Reply( $client, "ok\n", $userinput);
2224: } else {
2225: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2226: "while attempting put\n",
2227: $userinput);
2228: }
2229: } else {
2230: &Failure( $client, "error: ".($!)." tie(GDBM) Failed ".
2231: "while attempting put\n", $userinput);
2232: }
2233: } else {
2234: &Failure( $client, "refused\n", $userinput);
2235: }
2236:
2237: return 1;
2238: }
2239: ®ister_handler("put", \&put_user_profile_entry, 0, 1, 0);
2240:
2241: #
2242: # Increment a profile entry in the user history file.
2243: # The history contains keyword value pairs. In this case,
2244: # The value itself is a pair of numbers. The first, the current value
2245: # the second an increment that this function applies to the current
2246: # value.
2247: #
2248: # Parameters:
2249: # $cmd - The command that got us here.
2250: # $tail - Tail of the command (remaining parameters).
2251: # $client - File descriptor connected to client.
2252: # Returns
2253: # 0 - Requested to exit, caller should shut down.
2254: # 1 - Continue processing.
2255: #
2256: sub increment_user_value_handler {
2257: my ($cmd, $tail, $client) = @_;
2258:
2259: my $userinput = "$cmd:$tail";
2260:
2261: my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
2262: if ($namespace ne 'roles') {
2263: chomp($what);
2264: my $hashref = &tie_user_hash($udom, $uname,
2265: $namespace, &GDBM_WRCREAT(),
2266: "P",$what);
2267: if ($hashref) {
2268: my @pairs=split(/\&/,$what);
2269: foreach my $pair (@pairs) {
2270: my ($key,$value)=split(/=/,$pair);
2271: # We could check that we have a number...
2272: if (! defined($value) || $value eq '') {
2273: $value = 1;
2274: }
2275: $hashref->{$key}+=$value;
2276: }
2277: if (untie(%$hashref)) {
2278: &Reply( $client, "ok\n", $userinput);
2279: } else {
2280: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2281: "while attempting inc\n", $userinput);
2282: }
2283: } else {
2284: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2285: "while attempting inc\n", $userinput);
2286: }
2287: } else {
2288: &Failure($client, "refused\n", $userinput);
2289: }
2290:
2291: return 1;
2292: }
2293: ®ister_handler("inc", \&increment_user_value_handler, 0, 1, 0);
2294:
2295:
2296: #
2297: # Put a new role for a user. Roles are LonCAPA's packaging of permissions.
2298: # Each 'role' a user has implies a set of permissions. Adding a new role
2299: # for a person grants the permissions packaged with that role
2300: # to that user when the role is selected.
2301: #
2302: # Parameters:
2303: # $cmd - The command string (rolesput).
2304: # $tail - The remainder of the request line. For rolesput this
2305: # consists of a colon separated list that contains:
2306: # The domain and user that is granting the role (logged).
2307: # The domain and user that is getting the role.
2308: # The roles being granted as a set of & separated pairs.
2309: # each pair a key value pair.
2310: # $client - File descriptor connected to the client.
2311: # Returns:
2312: # 0 - If the daemon should exit
2313: # 1 - To continue processing.
2314: #
2315: #
2316: sub roles_put_handler {
2317: my ($cmd, $tail, $client) = @_;
2318:
2319: my $userinput = "$cmd:$tail";
2320:
2321: my ( $exedom, $exeuser, $udom, $uname, $what) = split(/:/,$tail);
2322:
2323:
2324: my $namespace='roles';
2325: chomp($what);
2326: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2327: &GDBM_WRCREAT(), "P",
2328: "$exedom:$exeuser:$what");
2329: #
2330: # Log the attempt to set a role. The {}'s here ensure that the file
2331: # handle is open for the minimal amount of time. Since the flush
2332: # is done on close this improves the chances the log will be an un-
2333: # corrupted ordered thing.
2334: if ($hashref) {
2335: my @pairs=split(/\&/,$what);
2336: foreach my $pair (@pairs) {
2337: my ($key,$value)=split(/=/,$pair);
2338: &manage_permissions($key, $udom, $uname,
2339: &get_auth_type( $udom, $uname));
2340: $hashref->{$key}=$value;
2341: }
2342: if (untie($hashref)) {
2343: &Reply($client, "ok\n", $userinput);
2344: } else {
2345: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2346: "while attempting rolesput\n", $userinput);
2347: }
2348: } else {
2349: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2350: "while attempting rolesput\n", $userinput);
2351: }
2352: return 1;
2353: }
2354: ®ister_handler("rolesput", \&roles_put_handler, 1,1,0); # Encoded client only.
2355:
2356: #
1.231 foxr 2357: # Deletes (removes) a role for a user. This is equivalent to removing
2358: # a permissions package associated with the role from the user's profile.
2359: #
2360: # Parameters:
2361: # $cmd - The command (rolesdel)
2362: # $tail - The remainder of the request line. This consists
2363: # of:
2364: # The domain and user requesting the change (logged)
2365: # The domain and user being changed.
2366: # The roles being revoked. These are shipped to us
2367: # as a bunch of & separated role name keywords.
2368: # $client - The file handle open on the client.
2369: # Returns:
2370: # 1 - Continue processing
2371: # 0 - Exit.
2372: #
2373: sub roles_delete_handler {
2374: my ($cmd, $tail, $client) = @_;
2375:
2376: my $userinput = "$cmd:$tail";
2377:
2378: my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
2379: &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.
2380: "what = ".$what);
2381: my $namespace='roles';
2382: chomp($what);
2383: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2384: &GDBM_WRCREAT(), "D",
2385: "$exedom:$exeuser:$what");
2386:
2387: if ($hashref) {
2388: my @rolekeys=split(/\&/,$what);
2389:
2390: foreach my $key (@rolekeys) {
2391: delete $hashref->{$key};
2392: }
2393: if (untie(%$hashref)) {
2394: &Reply($client, "ok\n", $userinput);
2395: } else {
2396: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2397: "while attempting rolesdel\n", $userinput);
2398: }
2399: } else {
2400: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2401: "while attempting rolesdel\n", $userinput);
2402: }
2403:
2404: return 1;
2405: }
2406: ®ister_handler("rolesdel", \&roles_delete_handler, 1,1, 0); # Encoded client only
2407:
2408: # Unencrypted get from a user's profile database. See
2409: # GetProfileEntryEncrypted for a version that does end-to-end encryption.
2410: # This function retrieves a keyed item from a specific named database in the
2411: # user's directory.
2412: #
2413: # Parameters:
2414: # $cmd - Command request keyword (get).
2415: # $tail - Tail of the command. This is a colon separated list
2416: # consisting of the domain and username that uniquely
2417: # identifies the profile,
2418: # The 'namespace' which selects the gdbm file to
2419: # do the lookup in,
2420: # & separated list of keys to lookup. Note that
2421: # the values are returned as an & separated list too.
2422: # $client - File descriptor open on the client.
2423: # Returns:
2424: # 1 - Continue processing.
2425: # 0 - Exit.
2426: #
2427: sub get_profile_entry {
2428: my ($cmd, $tail, $client) = @_;
2429:
2430: my $userinput= "$cmd:$tail";
2431:
2432: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2433: chomp($what);
2434: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2435: &GDBM_READER());
2436: if ($hashref) {
2437: my @queries=split(/\&/,$what);
2438: my $qresult='';
2439:
2440: for (my $i=0;$i<=$#queries;$i++) {
2441: $qresult.="$hashref->{$queries[$i]}&"; # Presumably failure gives empty string.
2442: }
2443: $qresult=~s/\&$//; # Remove trailing & from last lookup.
2444: if (untie(%$hashref)) {
2445: &Reply($client, "$qresult\n", $userinput);
2446: } else {
2447: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2448: "while attempting get\n", $userinput);
2449: }
2450: } else {
2451: if ($!+0 == 2) { # +0 coerces errno -> number 2 is ENOENT
2452: &Failure($client, "error:No such file or ".
2453: "GDBM reported bad block error\n", $userinput);
2454: } else { # Some other undifferentiated err.
2455: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2456: "while attempting get\n", $userinput);
2457: }
2458: }
2459: return 1;
2460: }
2461: ®ister_handler("get", \&get_profile_entry, 0,1,0);
2462:
2463: #
2464: # Process the encrypted get request. Note that the request is sent
2465: # in clear, but the reply is encrypted. This is a small covert channel:
2466: # information about the sensitive keys is given to the snooper. Just not
2467: # information about the values of the sensitive key. Hmm if I wanted to
2468: # know these I'd snoop for the egets. Get the profile item names from them
2469: # and then issue a get for them since there's no enforcement of the
2470: # requirement of an encrypted get for particular profile items. If I
2471: # were re-doing this, I'd force the request to be encrypted as well as the
2472: # reply. I'd also just enforce encrypted transactions for all gets since
2473: # that would prevent any covert channel snooping.
2474: #
2475: # Parameters:
2476: # $cmd - Command keyword of request (eget).
2477: # $tail - Tail of the command. See GetProfileEntry
# for more information about this.
2478: # $client - File open on the client.
2479: # Returns:
2480: # 1 - Continue processing
2481: # 0 - server should exit.
2482: sub get_profile_entry_encrypted {
2483: my ($cmd, $tail, $client) = @_;
2484:
2485: my $userinput = "$cmd:$tail";
2486:
2487: my ($cmd,$udom,$uname,$namespace,$what) = split(/:/,$userinput);
2488: chomp($what);
2489: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2490: &GDBM_READER());
2491: if ($hashref) {
2492: my @queries=split(/\&/,$what);
2493: my $qresult='';
2494: for (my $i=0;$i<=$#queries;$i++) {
2495: $qresult.="$hashref->{$queries[$i]}&";
2496: }
2497: if (untie(%$hashref)) {
2498: $qresult=~s/\&$//;
2499: if ($cipher) {
2500: my $cmdlength=length($qresult);
2501: $qresult.=" ";
2502: my $encqresult='';
2503: for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
2504: $encqresult.= unpack("H16",
2505: $cipher->encrypt(substr($qresult,
2506: $encidx,
2507: 8)));
2508: }
2509: &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
2510: } else {
2511: &Failure( $client, "error:no_key\n", $userinput);
2512: }
2513: } else {
2514: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2515: "while attempting eget\n", $userinput);
2516: }
2517: } else {
2518: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2519: "while attempting eget\n", $userinput);
2520: }
2521:
2522: return 1;
2523: }
2524: ®ister_handler("eget", \&GetProfileEntryEncrypted, 0, 1, 0);
2525: #
2526: # Deletes a key in a user profile database.
2527: #
2528: # Parameters:
2529: # $cmd - Command keyword (del).
2530: # $tail - Command tail. IN this case a colon
2531: # separated list containing:
2532: # The domain and user that identifies uniquely
2533: # the identity of the user.
2534: # The profile namespace (name of the profile
2535: # database file).
2536: # & separated list of keywords to delete.
2537: # $client - File open on client socket.
2538: # Returns:
2539: # 1 - Continue processing
2540: # 0 - Exit server.
2541: #
2542: #
2543:
2544: sub delete_profile_entry {
2545: my ($cmd, $tail, $client) = @_;
2546:
2547: my $userinput = "cmd:$tail";
2548:
2549: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2550: chomp($what);
2551: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2552: &GDBM_WRCREAT(),
2553: "D",$what);
2554: if ($hashref) {
2555: my @keys=split(/\&/,$what);
2556: foreach my $key (@keys) {
2557: delete($hashref->{$key});
2558: }
2559: if (untie(%$hashref)) {
2560: &Reply($client, "ok\n", $userinput);
2561: } else {
2562: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2563: "while attempting del\n", $userinput);
2564: }
2565: } else {
2566: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2567: "while attempting del\n", $userinput);
2568: }
2569: return 1;
2570: }
2571: ®ister_handler("del", \&delete_profile_entry, 0, 1, 0);
2572: #
2573: # List the set of keys that are defined in a profile database file.
2574: # A successful reply from this will contain an & separated list of
2575: # the keys.
2576: # Parameters:
2577: # $cmd - Command request (keys).
2578: # $tail - Remainder of the request, a colon separated
2579: # list containing domain/user that identifies the
2580: # user being queried, and the database namespace
2581: # (database filename essentially).
2582: # $client - File open on the client.
2583: # Returns:
2584: # 1 - Continue processing.
2585: # 0 - Exit the server.
2586: #
2587: sub get_profile_keys {
2588: my ($cmd, $tail, $client) = @_;
2589:
2590: my $userinput = "$cmd:$tail";
2591:
2592: my ($udom,$uname,$namespace)=split(/:/,$tail);
2593: my $qresult='';
2594: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2595: &GDBM_READER());
2596: if ($hashref) {
2597: foreach my $key (keys %$hashref) {
2598: $qresult.="$key&";
2599: }
2600: if (untie(%$hashref)) {
2601: $qresult=~s/\&$//;
2602: &Reply($client, "$qresult\n", $userinput);
2603: } else {
2604: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2605: "while attempting keys\n", $userinput);
2606: }
2607: } else {
2608: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2609: "while attempting keys\n", $userinput);
2610: }
2611:
2612: return 1;
2613: }
2614: ®ister_handler("keys", \&get_profile_keys, 0, 1, 0);
2615:
2616: #
2617: # Dump the contents of a user profile database.
2618: # Note that this constitutes a very large covert channel too since
2619: # the dump will return sensitive information that is not encrypted.
2620: # The naive security assumption is that the session negotiation ensures
2621: # our client is trusted and I don't believe that's assured at present.
2622: # Sure want badly to go to ssl or tls. Of course if my peer isn't really
2623: # a LonCAPA node they could have negotiated an encryption key too so >sigh<.
2624: #
2625: # Parameters:
2626: # $cmd - The command request keyword (currentdump).
2627: # $tail - Remainder of the request, consisting of a colon
2628: # separated list that has the domain/username and
2629: # the namespace to dump (database file).
2630: # $client - file open on the remote client.
2631: # Returns:
2632: # 1 - Continue processing.
2633: # 0 - Exit the server.
2634: #
2635: sub dump_profile_database {
2636: my ($cmd, $tail, $client) = @_;
2637:
2638: my $userinput = "$cmd:$tail";
2639:
2640: my ($udom,$uname,$namespace) = split(/:/,$tail);
2641: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2642: &GDBM_READER());
2643: if ($hashref) {
2644: # Structure of %data:
2645: # $data{$symb}->{$parameter}=$value;
2646: # $data{$symb}->{'v.'.$parameter}=$version;
2647: # since $parameter will be unescaped, we do not
2648: # have to worry about silly parameter names...
2649:
2650: my $qresult='';
2651: my %data = (); # A hash of anonymous hashes..
2652: while (my ($key,$value) = each(%$hashref)) {
2653: my ($v,$symb,$param) = split(/:/,$key);
2654: next if ($v eq 'version' || $symb eq 'keys');
2655: next if (exists($data{$symb}) &&
2656: exists($data{$symb}->{$param}) &&
2657: $data{$symb}->{'v.'.$param} > $v);
2658: $data{$symb}->{$param}=$value;
2659: $data{$symb}->{'v.'.$param}=$v;
2660: }
2661: if (untie(%$hashref)) {
2662: while (my ($symb,$param_hash) = each(%data)) {
2663: while(my ($param,$value) = each (%$param_hash)){
2664: next if ($param =~ /^v\./); # Ignore versions...
2665: #
2666: # Just dump the symb=value pairs separated by &
2667: #
2668: $qresult.=$symb.':'.$param.'='.$value.'&';
2669: }
2670: }
2671: chop($qresult);
2672: &Reply($client , "$qresult\n", $userinput);
2673: } else {
2674: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2675: "while attempting currentdump\n", $userinput);
2676: }
2677: } else {
2678: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2679: "while attempting currentdump\n", $userinput);
2680: }
2681:
2682: return 1;
2683: }
2684: ®ister_handler("currentdump", \&dump_profile_database, 0, 1, 0);
2685:
2686: #
2687: # Dump a profile database with an optional regular expression
2688: # to match against the keys. In this dump, no effort is made
2689: # to separate symb from version information. Presumably the
2690: # databases that are dumped by this command are of a different
2691: # structure. Need to look at this and improve the documentation of
2692: # both this and the currentdump handler.
2693: # Parameters:
2694: # $cmd - The command keyword.
2695: # $tail - All of the characters after the $cmd:
2696: # These are expected to be a colon
2697: # separated list containing:
2698: # domain/user - identifying the user.
2699: # namespace - identifying the database.
2700: # regexp - optional regular expression
2701: # that is matched against
2702: # database keywords to do
2703: # selective dumps.
2704: # $client - Channel open on the client.
2705: # Returns:
2706: # 1 - Continue processing.
2707: # Side effects:
2708: # response is written to $client.
2709: #
2710: sub dump_with_regexp {
2711: my ($cmd, $tail, $client) = @_;
2712:
2713:
2714: my $userinput = "$cmd:$tail";
2715:
2716: my ($udom,$uname,$namespace,$regexp)=split(/:/,$tail);
2717: if (defined($regexp)) {
2718: $regexp=&unescape($regexp);
2719: } else {
2720: $regexp='.';
2721: }
2722: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2723: &GDBM_READER());
2724: if ($hashref) {
2725: my $qresult='';
2726: while (my ($key,$value) = each(%$hashref)) {
2727: if ($regexp eq '.') {
2728: $qresult.=$key.'='.$value.'&';
2729: } else {
2730: my $unescapeKey = &unescape($key);
2731: if (eval('$unescapeKey=~/$regexp/')) {
2732: $qresult.="$key=$value&";
2733: }
2734: }
2735: }
2736: if (untie(%$hashref)) {
2737: chop($qresult);
2738: &Reply($client, "$qresult\n", $userinput);
2739: } else {
2740: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2741: "while attempting dump\n", $userinput);
2742: }
2743: } else {
2744: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2745: "while attempting dump\n", $userinput);
2746: }
2747:
2748: return 1;
2749: }
2750:
2751: ®ister_handler("dump", \&dump_with_regexp, 0, 1, 0);
2752:
2753: # Store a set of key=value pairs associated with a versioned name.
2754: #
2755: # Parameters:
2756: # $cmd - Request command keyword.
2757: # $tail - Tail of the request. This is a colon
2758: # separated list containing:
2759: # domain/user - User and authentication domain.
2760: # namespace - Name of the database being modified
2761: # rid - Resource keyword to modify.
2762: # what - new value associated with rid.
2763: #
2764: # $client - Socket open on the client.
2765: #
2766: #
2767: # Returns:
2768: # 1 (keep on processing).
2769: # Side-Effects:
2770: # Writes to the client
2771: sub store_handler {
2772: my ($cmd, $tail, $client) = @_;
2773:
2774: my $userinput = "$cmd:$tail";
2775:
2776: my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);
2777: if ($namespace ne 'roles') {
2778:
2779: chomp($what);
2780: my @pairs=split(/\&/,$what);
2781: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2782: &GDBM_WRCREAT(), "P",
2783: "$rid:$what");
2784: if ($hashref) {
2785: my $now = time;
2786: my @previouskeys=split(/&/,$hashref->{"keys:$rid"});
2787: my $key;
2788: $hashref->{"version:$rid"}++;
2789: my $version=$hashref->{"version:$rid"};
2790: my $allkeys='';
2791: foreach my $pair (@pairs) {
2792: my ($key,$value)=split(/=/,$pair);
2793: $allkeys.=$key.':';
2794: $hashref->{"$version:$rid:$key"}=$value;
2795: }
2796: $hashref->{"$version:$rid:timestamp"}=$now;
2797: $allkeys.='timestamp';
2798: $hashref->{"$version:keys:$rid"}=$allkeys;
2799: if (untie($hashref)) {
2800: &Reply($client, "ok\n", $userinput);
2801: } else {
2802: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2803: "while attempting store\n", $userinput);
2804: }
2805: } else {
2806: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2807: "while attempting store\n", $userinput);
2808: }
2809: } else {
2810: &Failure($client, "refused\n", $userinput);
2811: }
2812:
2813: return 1;
2814: }
2815: ®ister_handler("store", \&store_handler, 0, 1, 0);
2816: #
2817: # Dump out all versions of a resource that has key=value pairs associated
2818: # with it for each version. These resources are built up via the store
2819: # command.
2820: #
2821: # Parameters:
2822: # $cmd - Command keyword.
2823: # $tail - Remainder of the request which consists of:
2824: # domain/user - User and auth. domain.
2825: # namespace - name of resource database.
2826: # rid - Resource id.
2827: # $client - socket open on the client.
2828: #
2829: # Returns:
2830: # 1 indicating the caller should not yet exit.
2831: # Side-effects:
2832: # Writes a reply to the client.
2833: # The reply is a string of the following shape:
2834: # version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
2835: # Where the 1 above represents version 1.
2836: # this continues for all pairs of keys in all versions.
2837: #
2838: #
2839: #
2840: #
2841: sub restore_handler {
2842: my ($cmd, $tail, $client) = @_;
2843:
2844: my $userinput = "$cmd:$tail"; # Only used for logging purposes.
2845:
2846: my ($cmd,$udom,$uname,$namespace,$rid) = split(/:/,$userinput);
2847: $namespace=~s/\//\_/g;
2848: $namespace=~s/\W//g;
2849: chomp($rid);
2850: my $proname=&propath($udom,$uname);
2851: my $qresult='';
2852: my %hash;
2853: if (tie(%hash,'GDBM_File',"$proname/$namespace.db",
2854: &GDBM_READER(),0640)) {
2855: my $version=$hash{"version:$rid"};
2856: $qresult.="version=$version&";
2857: my $scope;
2858: for ($scope=1;$scope<=$version;$scope++) {
2859: my $vkeys=$hash{"$scope:keys:$rid"};
2860: my @keys=split(/:/,$vkeys);
2861: my $key;
2862: $qresult.="$scope:keys=$vkeys&";
2863: foreach $key (@keys) {
2864: $qresult.="$scope:$key=".$hash{"$scope:$rid:$key"}."&";
2865: }
2866: }
2867: if (untie(%hash)) {
2868: $qresult=~s/\&$//;
2869: &Reply( $client, "$qresult\n", $userinput);
2870: } else {
2871: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2872: "while attempting restore\n", $userinput);
2873: }
2874: } else {
2875: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2876: "while attempting restore\n", $userinput);
2877: }
2878:
2879: return 1;
2880:
2881:
2882: }
2883: ®ister_handler("restore", \&restore_handler, 0,1,0);
1.234 foxr 2884:
2885: #
2886: # Add a chat message to to a discussion board.
2887: #
2888: # Parameters:
2889: # $cmd - Request keyword.
2890: # $tail - Tail of the command. A colon separated list
2891: # containing:
2892: # cdom - Domain on which the chat board lives
2893: # cnum - Identifier of the discussion group.
2894: # post - Body of the posting.
2895: # $client - Socket open on the client.
2896: # Returns:
2897: # 1 - Indicating caller should keep on processing.
2898: #
2899: # Side-effects:
2900: # writes a reply to the client.
2901: #
2902: #
2903: sub send_chat_handler {
2904: my ($cmd, $tail, $client) = @_;
2905:
2906:
2907: my $userinput = "$cmd:$tail";
2908:
2909: my ($cdom,$cnum,$newpost)=split(/\:/,$tail);
2910: &chat_add($cdom,$cnum,$newpost);
2911: &Reply($client, "ok\n", $userinput);
2912:
2913: return 1;
2914: }
2915: ®ister_handler("chatsend", \&send_chat_handler, 0, 1, 0);
2916: #
2917: # Retrieve the set of chat messagss from a discussion board.
2918: #
2919: # Parameters:
2920: # $cmd - Command keyword that initiated the request.
2921: # $tail - Remainder of the request after the command
2922: # keyword. In this case a colon separated list of
2923: # chat domain - Which discussion board.
2924: # chat id - Discussion thread(?)
2925: # domain/user - Authentication domain and username
2926: # of the requesting person.
2927: # $client - Socket open on the client program.
2928: # Returns:
2929: # 1 - continue processing
2930: # Side effects:
2931: # Response is written to the client.
2932: #
2933: sub retrieve_chat_handler {
2934: my ($cmd, $tail, $client) = @_;
2935:
2936:
2937: my $userinput = "$cmd:$tail";
2938:
2939: my ($cdom,$cnum,$udom,$uname)=split(/\:/,$tail);
2940: my $reply='';
2941: foreach (&get_chat($cdom,$cnum,$udom,$uname)) {
2942: $reply.=&escape($_).':';
2943: }
2944: $reply=~s/\:$//;
2945: &Reply($client, $reply."\n", $userinput);
2946:
2947:
2948: return 1;
2949: }
2950: ®ister_handler("chatretr", \&retrieve_chat_handler, 0, 1, 0);
2951:
2952: #
2953: # Initiate a query of an sql database. SQL query repsonses get put in
2954: # a file for later retrieval. This prevents sql query results from
2955: # bottlenecking the system. Note that with loncnew, perhaps this is
2956: # less of an issue since multiple outstanding requests can be concurrently
2957: # serviced.
2958: #
2959: # Parameters:
2960: # $cmd - COmmand keyword that initiated the request.
2961: # $tail - Remainder of the command after the keyword.
2962: # For this function, this consists of a query and
2963: # 3 arguments that are self-documentingly labelled
2964: # in the original arg1, arg2, arg3.
2965: # $client - Socket open on the client.
2966: # Return:
2967: # 1 - Indicating processing should continue.
2968: # Side-effects:
2969: # a reply is written to $client.
2970: #
2971: sub send_query_handler {
2972: my ($cmd, $tail, $client) = @_;
2973:
2974:
2975: my $userinput = "$cmd:$tail";
2976:
2977: my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
2978: $query=~s/\n*$//g;
2979: &Reply($client, "". &sql_reply("$clientname\&$query".
2980: "\&$arg1"."\&$arg2"."\&$arg3")."\n",
2981: $userinput);
2982:
2983: return 1;
2984: }
2985: ®ister_handler("querysend", \&send_query_handler, 0, 1, 0);
2986:
2987: #
2988: # Add a reply to an sql query. SQL queries are done asyncrhonously.
2989: # The query is submitted via a "querysend" transaction.
2990: # There it is passed on to the lonsql daemon, queued and issued to
2991: # mysql.
2992: # This transaction is invoked when the sql transaction is complete
2993: # it stores the query results in flie and indicates query completion.
2994: # presumably local software then fetches this response... I'm guessing
2995: # the sequence is: lonc does a querysend, we ask lonsql to do it.
2996: # lonsql on completion of the query interacts with the lond of our
2997: # client to do a query reply storing two files:
2998: # - id - The results of the query.
2999: # - id.end - Indicating the transaction completed.
3000: # NOTE: id is a unique id assigned to the query and querysend time.
3001: # Parameters:
3002: # $cmd - Command keyword that initiated this request.
3003: # $tail - Remainder of the tail. In this case that's a colon
3004: # separated list containing the query Id and the
3005: # results of the query.
3006: # $client - Socket open on the client.
3007: # Return:
3008: # 1 - Indicating that we should continue processing.
3009: # Side effects:
3010: # ok written to the client.
3011: #
3012: sub reply_query_handler {
3013: my ($cmd, $tail, $client) = @_;
3014:
3015:
3016: my $userinput = "$cmd:$tail";
3017:
3018: my ($cmd,$id,$reply)=split(/:/,$userinput);
3019: my $store;
3020: my $execdir=$perlvar{'lonDaemons'};
3021: if ($store=IO::File->new(">$execdir/tmp/$id")) {
3022: $reply=~s/\&/\n/g;
3023: print $store $reply;
3024: close $store;
3025: my $store2=IO::File->new(">$execdir/tmp/$id.end");
3026: print $store2 "done\n";
3027: close $store2;
3028: &Reply($client, "ok\n", $userinput);
3029: } else {
3030: &Failure($client, "error: ".($!+0)
3031: ." IO::File->new Failed ".
3032: "while attempting queryreply\n", $userinput);
3033: }
3034:
3035:
3036: return 1;
3037: }
3038: ®ister_handler("queryreply", \&reply_query_handler, 0, 1, 0);
3039:
3040: #
3041: # Process the courseidput request. Not quite sure what this means
3042: # at the system level sense. It appears a gdbm file in the
3043: # /home/httpd/lonUsers/$domain/nohist_courseids is tied and
3044: # a set of entries made in that database.
3045: #
3046: # Parameters:
3047: # $cmd - The command keyword that initiated this request.
3048: # $tail - Tail of the command. In this case consists of a colon
3049: # separated list contaning the domain to apply this to and
3050: # an ampersand separated list of keyword=value pairs.
3051: # $client - Socket open on the client.
3052: # Returns:
3053: # 1 - indicating that processing should continue
3054: #
3055: # Side effects:
3056: # reply is written to the client.
3057: #
3058: sub put_course_id_handler {
3059: my ($cmd, $tail, $client) = @_;
3060:
3061:
3062: my $userinput = "$cmd:$tail";
3063:
3064: my ($udom, $what) = split(/:/, $tail);
3065: chomp($what);
3066: my $now=time;
3067: my @pairs=split(/\&/,$what);
3068:
3069: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3070: if ($hashref) {
3071: foreach my $pair (@pairs) {
3072: my ($key,$value)=split(/=/,$pair);
3073: $hashref->{$key}=$value.':'.$now;
3074: }
3075: if (untie(%$hashref)) {
3076: &Reply($client, "ok\n", $userinput);
3077: } else {
3078: &Failure( $client, "error: ".($!+0)
3079: ." untie(GDBM) Failed ".
3080: "while attempting courseidput\n", $userinput);
3081: }
3082: } else {
3083: &Failure( $client, "error: ".($!+0)
3084: ." tie(GDBM) Failed ".
3085: "while attempting courseidput\n", $userinput);
3086: }
3087:
3088: return 1;
3089: }
3090: ®ister_handler("courseidput", \&put_course_id_handler, 0, 1, 0);
3091:
3092: # Retrieves the value of a course id resource keyword pattern
3093: # defined since a starting date. Both the starting date and the
3094: # keyword pattern are optional. If the starting date is not supplied it
3095: # is treated as the beginning of time. If the pattern is not found,
3096: # it is treatred as "." matching everything.
3097: #
3098: # Parameters:
3099: # $cmd - Command keyword that resulted in us being dispatched.
3100: # $tail - The remainder of the command that, in this case, consists
3101: # of a colon separated list of:
3102: # domain - The domain in which the course database is
3103: # defined.
3104: # since - Optional parameter describing the minimum
3105: # time of definition(?) of the resources that
3106: # will match the dump.
3107: # description - regular expression that is used to filter
3108: # the dump. Only keywords matching this regexp
3109: # will be used.
3110: # $client - The socket open on the client.
3111: # Returns:
3112: # 1 - Continue processing.
3113: # Side Effects:
3114: # a reply is written to $client.
3115: sub dump_course_id_handler {
3116: my ($cmd, $tail, $client) = @_;
3117:
3118: my $userinput = "$cmd:$tail";
3119:
3120: my ($udom,$since,$description) =split(/:/,$tail);
3121: if (defined($description)) {
3122: $description=&unescape($description);
3123: } else {
3124: $description='.';
3125: }
3126: unless (defined($since)) { $since=0; }
3127: my $qresult='';
3128: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3129: if ($hashref) {
3130: while (my ($key,$value) = each(%$hashref)) {
3131: my ($descr,$lasttime,$inst_code);
3132: if ($value =~ m/^([^\:]*):([^\:]*):(\d+)$/) {
3133: ($descr,$inst_code,$lasttime)=($1,$2,$3);
3134: } else {
3135: ($descr,$lasttime) = split(/\:/,$value);
3136: }
3137: if ($lasttime<$since) { next; }
3138: if ($description eq '.') {
3139: $qresult.=$key.'='.$descr.':'.$inst_code.'&';
3140: } else {
3141: my $unescapeVal = &unescape($descr);
3142: if (eval('$unescapeVal=~/\Q$description\E/i')) {
3143: $qresult.=$key.'='.$descr.':'.$inst_code.'&';
3144: }
3145: }
3146: }
3147: if (untie(%$hashref)) {
3148: chop($qresult);
3149: &Reply($client, "$qresult\n", $userinput);
3150: } else {
3151: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3152: "while attempting courseiddump\n", $userinput);
3153: }
3154: } else {
3155: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3156: "while attempting courseiddump\n", $userinput);
3157: }
3158:
3159:
3160: return 1;
3161: }
3162: ®ister_handler("courseiddump", \&dump_course_id_handler, 0, 1, 0);
1.238 foxr 3163:
3164: #
3165: # Puts an id to a domains id database.
3166: #
3167: # Parameters:
3168: # $cmd - The command that triggered us.
3169: # $tail - Remainder of the request other than the command. This is a
3170: # colon separated list containing:
3171: # $domain - The domain for which we are writing the id.
3172: # $pairs - The id info to write... this is and & separated list
3173: # of keyword=value.
3174: # $client - Socket open on the client.
3175: # Returns:
3176: # 1 - Continue processing.
3177: # Side effects:
3178: # reply is written to $client.
3179: #
3180: sub put_id_handler {
3181: my ($cmd,$tail,$client) = @_;
3182:
3183:
3184: my $userinput = "$cmd:$tail";
3185:
3186: my ($udom,$what)=split(/:/,$tail);
3187: chomp($what);
3188: my @pairs=split(/\&/,$what);
3189: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
3190: "P", $what);
3191: if ($hashref) {
3192: foreach my $pair (@pairs) {
3193: my ($key,$value)=split(/=/,$pair);
3194: $hashref->{$key}=$value;
3195: }
3196: if (untie(%$hashref)) {
3197: &Reply($client, "ok\n", $userinput);
3198: } else {
3199: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3200: "while attempting idput\n", $userinput);
3201: }
3202: } else {
3203: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3204: "while attempting idput\n", $userinput);
3205: }
3206:
3207: return 1;
3208: }
3209:
3210: ®ister_handler("idput", \&put_id_handler, 0, 1, 0);
3211: #
3212: # Retrieves a set of id values from the id database.
3213: # Returns an & separated list of results, one for each requested id to the
3214: # client.
3215: #
3216: # Parameters:
3217: # $cmd - Command keyword that caused us to be dispatched.
3218: # $tail - Tail of the command. Consists of a colon separated:
3219: # domain - the domain whose id table we dump
3220: # ids Consists of an & separated list of
3221: # id keywords whose values will be fetched.
3222: # nonexisting keywords will have an empty value.
3223: # $client - Socket open on the client.
3224: #
3225: # Returns:
3226: # 1 - indicating processing should continue.
3227: # Side effects:
3228: # An & separated list of results is written to $client.
3229: #
3230: sub get_id_handler {
3231: my ($cmd, $tail, $client) = @_;
3232:
3233:
3234: my $userinput = "$client:$tail";
3235:
3236: my ($udom,$what)=split(/:/,$tail);
3237: chomp($what);
3238: my @queries=split(/\&/,$what);
3239: my $qresult='';
3240: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_READER());
3241: if ($hashref) {
3242: for (my $i=0;$i<=$#queries;$i++) {
3243: $qresult.="$hashref->{$queries[$i]}&";
3244: }
3245: if (untie(%$hashref)) {
3246: $qresult=~s/\&$//;
3247: &Reply($client, "$qresult\n", $userinput);
3248: } else {
3249: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
3250: "while attempting idget\n",$userinput);
3251: }
3252: } else {
3253: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3254: "while attempting idget\n",$userinput);
3255: }
3256:
3257: return 1;
3258: }
3259:
3260: register_handler("idget", \&get_id_handler, 0, 1, 0);
3261:
3262: #
3263: # Process the tmpput command I'm not sure what this does.. Seems to
3264: # create a file in the lonDaemons/tmp directory of the form $id.tmp
3265: # where Id is the client's ip concatenated with a sequence number.
3266: # The file will contain some value that is passed in. Is this e.g.
3267: # a login token?
3268: #
3269: # Parameters:
3270: # $cmd - The command that got us dispatched.
3271: # $tail - The remainder of the request following $cmd:
3272: # In this case this will be the contents of the file.
3273: # $client - Socket connected to the client.
3274: # Returns:
3275: # 1 indicating processing can continue.
3276: # Side effects:
3277: # A file is created in the local filesystem.
3278: # A reply is sent to the client.
3279: sub tmp_put_handler {
3280: my ($cmd, $what, $client) = @_;
3281:
3282: my $userinput = "$cmd:$what"; # Reconstruct for logging.
3283:
3284:
3285: my $store;
3286: $tmpsnum++;
3287: my $id=$$.'_'.$clientip.'_'.$tmpsnum;
3288: $id=~s/\W/\_/g;
3289: $what=~s/\n//g;
3290: my $execdir=$perlvar{'lonDaemons'};
3291: if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
3292: print $store $what;
3293: close $store;
3294: &Reply($client, "$id\n", $userinput);
3295: } else {
3296: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
3297: "while attempting tmpput\n", $userinput);
3298: }
3299: return 1;
3300:
3301: }
3302: ®ister_handler("tmpput", \&tmp_put_handler, 0, 1, 0);
3303: # Processes the tmpget command. This command returns the contents
3304: # of a temporary resource file(?) created via tmpput.
3305: #
3306: # Paramters:
3307: # $cmd - Command that got us dispatched.
3308: # $id - Tail of the command, contain the id of the resource
3309: # we want to fetch.
3310: # $client - socket open on the client.
3311: # Return:
3312: # 1 - Inidcating processing can continue.
3313: # Side effects:
3314: # A reply is sent to the client.
3315:
3316: #
3317: sub tmp_get_handler {
3318: my ($cmd, $id, $client) = @_;
3319:
3320: my $userinput = "$cmd:$id";
3321:
3322:
3323: $id=~s/\W/\_/g;
3324: my $store;
3325: my $execdir=$perlvar{'lonDaemons'};
3326: if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
3327: my $reply=<$store>;
3328: &Reply( $client, "$reply\n", $userinput);
3329: close $store;
3330: } else {
3331: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
3332: "while attempting tmpget\n", $userinput);
3333: }
3334:
3335: return 1;
3336: }
3337: ®ister_handler("tmpget", \&tmp_get_handler, 0, 1, 0);
3338: #
3339: # Process the tmpdel command. This command deletes a temp resource
3340: # created by the tmpput command.
3341: #
3342: # Parameters:
3343: # $cmd - Command that got us here.
3344: # $id - Id of the temporary resource created.
3345: # $client - socket open on the client process.
3346: #
3347: # Returns:
3348: # 1 - Indicating processing should continue.
3349: # Side Effects:
3350: # A file is deleted
3351: # A reply is sent to the client.
3352: sub tmp_del_handler {
3353: my ($cmd, $id, $client) = @_;
3354:
3355: my $userinput= "$cmd:$id";
3356:
3357: chomp($id);
3358: $id=~s/\W/\_/g;
3359: my $execdir=$perlvar{'lonDaemons'};
3360: if (unlink("$execdir/tmp/$id.tmp")) {
3361: &Reply($client, "ok\n", $userinput);
3362: } else {
3363: &Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
3364: "while attempting tmpdel\n", $userinput);
3365: }
3366:
3367: return 1;
3368:
3369: }
3370: ®ister_handler("tmpdel", \&tmp_del_handler, 0, 1, 0);
3371: #
1.234 foxr 3372: #
1.231 foxr 3373: #
3374: #
1.207 foxr 3375: #---------------------------------------------------------------
3376: #
3377: # Getting, decoding and dispatching requests:
3378: #
3379:
3380: #
3381: # Get a Request:
3382: # Gets a Request message from the client. The transaction
3383: # is defined as a 'line' of text. We remove the new line
3384: # from the text line.
1.226 foxr 3385: #
1.211 albertel 3386: sub get_request {
1.207 foxr 3387: my $input = <$client>;
3388: chomp($input);
1.226 foxr 3389:
1.234 foxr 3390: &Debug("get_request: Request = $input\n");
1.207 foxr 3391:
3392: &status('Processing '.$clientname.':'.$input);
3393:
3394: return $input;
3395: }
1.212 foxr 3396: #---------------------------------------------------------------
3397: #
3398: # Process a request. This sub should shrink as each action
3399: # gets farmed out into a separat sub that is registered
3400: # with the dispatch hash.
3401: #
3402: # Parameters:
3403: # user_input - The request received from the client (lonc).
3404: # Returns:
3405: # true to keep processing, false if caller should exit.
3406: #
3407: sub process_request {
3408: my ($userinput) = @_; # Easier for now to break style than to
3409: # fix all the userinput -> user_input.
3410: my $wasenc = 0; # True if request was encrypted.
3411: # ------------------------------------------------------------ See if encrypted
3412: if ($userinput =~ /^enc/) {
3413: $userinput = decipher($userinput);
3414: $wasenc=1;
3415: if(!$userinput) { # Cipher not defined.
3416: &Failure($client, "error: Encrypted data without negotated key");
3417: return 0;
3418: }
3419: }
3420: Debug("process_request: $userinput\n");
3421:
1.213 foxr 3422: #
3423: # The 'correct way' to add a command to lond is now to
3424: # write a sub to execute it and Add it to the command dispatch
3425: # hash via a call to register_handler.. The comments to that
3426: # sub should give you enough to go on to show how to do this
3427: # along with the examples that are building up as this code
3428: # is getting refactored. Until all branches of the
3429: # if/elseif monster below have been factored out into
3430: # separate procesor subs, if the dispatch hash is missing
3431: # the command keyword, we will fall through to the remainder
3432: # of the if/else chain below in order to keep this thing in
3433: # working order throughout the transmogrification.
3434:
3435: my ($command, $tail) = split(/:/, $userinput, 2);
3436: chomp($command);
3437: chomp($tail);
3438: $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
1.214 foxr 3439: $command =~ s/(\r)//; # And this too for parameterless commands.
3440: if(!$tail) {
3441: $tail =""; # defined but blank.
3442: }
1.213 foxr 3443:
3444: &Debug("Command received: $command, encoded = $wasenc");
3445:
3446: if(defined $Dispatcher{$command}) {
3447:
3448: my $dispatch_info = $Dispatcher{$command};
3449: my $handler = $$dispatch_info[0];
3450: my $need_encode = $$dispatch_info[1];
3451: my $client_types = $$dispatch_info[2];
3452: Debug("Matched dispatch hash: mustencode: $need_encode "
3453: ."ClientType $client_types");
3454:
3455: # Validate the request:
3456:
3457: my $ok = 1;
3458: my $requesterprivs = 0;
3459: if(&isClient()) {
3460: $requesterprivs |= $CLIENT_OK;
3461: }
3462: if(&isManager()) {
3463: $requesterprivs |= $MANAGER_OK;
3464: }
3465: if($need_encode && (!$wasenc)) {
3466: Debug("Must encode but wasn't: $need_encode $wasenc");
3467: $ok = 0;
3468: }
3469: if(($client_types & $requesterprivs) == 0) {
3470: Debug("Client not privileged to do this operation");
3471: $ok = 0;
3472: }
3473:
3474: if($ok) {
3475: Debug("Dispatching to handler $command $tail");
3476: my $keep_going = &$handler($command, $tail, $client);
3477: return $keep_going;
3478: } else {
3479: Debug("Refusing to dispatch because client did not match requirements");
3480: Failure($client, "refused\n", $userinput);
3481: return 1;
3482: }
3483:
3484: }
3485:
1.215 foxr 3486: #------------------- Commands not yet in spearate handlers. --------------
3487:
1.218 foxr 3488:
1.239 foxr 3489:
1.212 foxr 3490: # ----------------------------------------------------------------- setannounce
1.239 foxr 3491: if ($userinput =~ /^setannounce/) {
1.212 foxr 3492: if (isClient) {
3493: my ($cmd,$announcement)=split(/:/,$userinput);
3494: chomp($announcement);
3495: $announcement=&unescape($announcement);
3496: if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
3497: '/announcement.txt')) {
3498: print $store $announcement;
3499: close $store;
3500: print $client "ok\n";
3501: } else {
3502: print $client "error: ".($!+0)."\n";
3503: }
3504: } else {
3505: Reply($client, "refused\n", $userinput);
3506:
3507: }
3508: # ------------------------------------------------------------------ Hanging up
3509: } elsif (($userinput =~ /^exit/) ||
3510: ($userinput =~ /^init/)) { # no restrictions.
3511: &logthis(
3512: "Client $clientip ($clientname) hanging up: $userinput");
3513: print $client "bye\n";
3514: $client->shutdown(2); # shutdown the socket forcibly.
3515: $client->close();
3516: return 0;
3517:
3518: # ---------------------------------- set current host/domain
1.231 foxr 3519: } elsif ($userinput =~ /^sethost/) {
1.212 foxr 3520: if (isClient) {
3521: print $client &sethost($userinput)."\n";
3522: } else {
3523: print $client "refused\n";
3524: }
3525: #---------------------------------- request file (?) version.
1.231 foxr 3526: } elsif ($userinput =~/^version/) {
1.212 foxr 3527: if (isClient) {
3528: print $client &version($userinput)."\n";
3529: } else {
3530: print $client "refused\n";
3531: }
3532: #------------------------------- is auto-enrollment enabled?
1.231 foxr 3533: } elsif ($userinput =~/^autorun/) {
1.212 foxr 3534: if (isClient) {
3535: my ($cmd,$cdom) = split(/:/,$userinput);
3536: my $outcome = &localenroll::run($cdom);
3537: print $client "$outcome\n";
3538: } else {
3539: print $client "0\n";
3540: }
3541: #------------------------------- get official sections (for auto-enrollment).
1.231 foxr 3542: } elsif ($userinput =~/^autogetsections/) {
1.212 foxr 3543: if (isClient) {
3544: my ($cmd,$coursecode,$cdom)=split(/:/,$userinput);
3545: my @secs = &localenroll::get_sections($coursecode,$cdom);
3546: my $seclist = &escape(join(':',@secs));
3547: print $client "$seclist\n";
3548: } else {
3549: print $client "refused\n";
3550: }
3551: #----------------------- validate owner of new course section (for auto-enrollment).
1.231 foxr 3552: } elsif ($userinput =~/^autonewcourse/) {
1.212 foxr 3553: if (isClient) {
3554: my ($cmd,$inst_course_id,$owner,$cdom)=split(/:/,$userinput);
3555: my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom);
3556: print $client "$outcome\n";
3557: } else {
3558: print $client "refused\n";
3559: }
3560: #-------------- validate course section in schedule of classes (for auto-enrollment).
1.231 foxr 3561: } elsif ($userinput =~/^autovalidatecourse/) {
1.212 foxr 3562: if (isClient) {
3563: my ($cmd,$inst_course_id,$cdom)=split(/:/,$userinput);
3564: my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
3565: print $client "$outcome\n";
3566: } else {
3567: print $client "refused\n";
3568: }
3569: #--------------------------- create password for new user (for auto-enrollment).
1.231 foxr 3570: } elsif ($userinput =~/^autocreatepassword/) {
1.212 foxr 3571: if (isClient) {
3572: my ($cmd,$authparam,$cdom)=split(/:/,$userinput);
3573: my ($create_passwd,$authchk);
3574: ($authparam,$create_passwd,$authchk) = &localenroll::create_password($authparam,$cdom);
3575: print $client &escape($authparam.':'.$create_passwd.':'.$authchk)."\n";
3576: } else {
3577: print $client "refused\n";
3578: }
3579: #--------------------------- read and remove temporary files (for auto-enrollment).
1.231 foxr 3580: } elsif ($userinput =~/^autoretrieve/) {
1.212 foxr 3581: if (isClient) {
3582: my ($cmd,$filename) = split(/:/,$userinput);
3583: my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
3584: if ( (-e $source) && ($filename ne '') ) {
3585: my $reply = '';
3586: if (open(my $fh,$source)) {
3587: while (<$fh>) {
3588: chomp($_);
3589: $_ =~ s/^\s+//g;
3590: $_ =~ s/\s+$//g;
3591: $reply .= $_;
3592: }
3593: close($fh);
3594: print $client &escape($reply)."\n";
3595: # unlink($source);
3596: } else {
3597: print $client "error\n";
3598: }
3599: } else {
3600: print $client "error\n";
3601: }
3602: } else {
3603: print $client "refused\n";
3604: }
3605: #--------------------- read and retrieve institutional code format (for support form).
1.231 foxr 3606: } elsif ($userinput =~/^autoinstcodeformat/) {
1.212 foxr 3607: if (isClient) {
3608: my $reply;
3609: my($cmd,$cdom,$course) = split(/:/,$userinput);
3610: my @pairs = split/\&/,$course;
3611: my %instcodes = ();
3612: my %codes = ();
3613: my @codetitles = ();
3614: my %cat_titles = ();
3615: my %cat_order = ();
3616: foreach (@pairs) {
3617: my ($key,$value) = split/=/,$_;
3618: $instcodes{&unescape($key)} = &unescape($value);
3619: }
3620: my $formatreply = &localenroll::instcode_format($cdom,\%instcodes,\%codes,\@codetitles,\%cat_titles,\%cat_order);
3621: if ($formatreply eq 'ok') {
3622: my $codes_str = &hash2str(%codes);
3623: my $codetitles_str = &array2str(@codetitles);
3624: my $cat_titles_str = &hash2str(%cat_titles);
3625: my $cat_order_str = &hash2str(%cat_order);
3626: print $client $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'.$cat_order_str."\n";
3627: }
3628: } else {
3629: print $client "refused\n";
3630: }
3631: # ------------------------------------------------------------- unknown command
3632:
3633: } else {
3634: # unknown command
3635: print $client "unknown_cmd\n";
3636: }
3637: # -------------------------------------------------------------------- complete
3638: Debug("process_request - returning 1");
3639: return 1;
3640: }
1.207 foxr 3641: #
3642: # Decipher encoded traffic
3643: # Parameters:
3644: # input - Encoded data.
3645: # Returns:
3646: # Decoded data or undef if encryption key was not yet negotiated.
3647: # Implicit input:
3648: # cipher - This global holds the negotiated encryption key.
3649: #
1.211 albertel 3650: sub decipher {
1.207 foxr 3651: my ($input) = @_;
3652: my $output = '';
1.212 foxr 3653:
3654:
1.207 foxr 3655: if($cipher) {
3656: my($enc, $enclength, $encinput) = split(/:/, $input);
3657: for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
3658: $output .=
3659: $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
3660: }
3661: return substr($output, 0, $enclength);
3662: } else {
3663: return undef;
3664: }
3665: }
3666:
3667: #
3668: # Register a command processor. This function is invoked to register a sub
3669: # to process a request. Once registered, the ProcessRequest sub can automatically
3670: # dispatch requests to an appropriate sub, and do the top level validity checking
3671: # as well:
3672: # - Is the keyword recognized.
3673: # - Is the proper client type attempting the request.
3674: # - Is the request encrypted if it has to be.
3675: # Parameters:
3676: # $request_name - Name of the request being registered.
3677: # This is the command request that will match
3678: # against the hash keywords to lookup the information
3679: # associated with the dispatch information.
3680: # $procedure - Reference to a sub to call to process the request.
3681: # All subs get called as follows:
3682: # Procedure($cmd, $tail, $replyfd, $key)
3683: # $cmd - the actual keyword that invoked us.
3684: # $tail - the tail of the request that invoked us.
3685: # $replyfd- File descriptor connected to the client
3686: # $must_encode - True if the request must be encoded to be good.
3687: # $client_ok - True if it's ok for a client to request this.
3688: # $manager_ok - True if it's ok for a manager to request this.
3689: # Side effects:
3690: # - On success, the Dispatcher hash has an entry added for the key $RequestName
3691: # - On failure, the program will die as it's a bad internal bug to try to
3692: # register a duplicate command handler.
3693: #
1.211 albertel 3694: sub register_handler {
1.212 foxr 3695: my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok) = @_;
1.207 foxr 3696:
3697: # Don't allow duplication#
3698:
3699: if (defined $Dispatcher{$request_name}) {
3700: die "Attempting to define a duplicate request handler for $request_name\n";
3701: }
3702: # Build the client type mask:
3703:
3704: my $client_type_mask = 0;
3705: if($client_ok) {
3706: $client_type_mask |= $CLIENT_OK;
3707: }
3708: if($manager_ok) {
3709: $client_type_mask |= $MANAGER_OK;
3710: }
3711:
3712: # Enter the hash:
3713:
3714: my @entry = ($procedure, $must_encode, $client_type_mask);
3715:
3716: $Dispatcher{$request_name} = \@entry;
3717:
3718: }
3719:
3720:
3721: #------------------------------------------------------------------
3722:
3723:
3724:
3725:
1.141 foxr 3726: #
1.96 foxr 3727: # Convert an error return code from lcpasswd to a string value.
3728: #
3729: sub lcpasswdstrerror {
3730: my $ErrorCode = shift;
1.97 foxr 3731: if(($ErrorCode < 0) || ($ErrorCode > $lastpwderror)) {
1.96 foxr 3732: return "lcpasswd Unrecognized error return value ".$ErrorCode;
3733: } else {
1.98 foxr 3734: return $passwderrors[$ErrorCode];
1.96 foxr 3735: }
3736: }
3737:
1.97 foxr 3738: #
3739: # Convert an error return code from lcuseradd to a string value:
3740: #
3741: sub lcuseraddstrerror {
3742: my $ErrorCode = shift;
3743: if(($ErrorCode < 0) || ($ErrorCode > $lastadderror)) {
3744: return "lcuseradd - Unrecognized error code: ".$ErrorCode;
3745: } else {
1.98 foxr 3746: return $adderrors[$ErrorCode];
1.97 foxr 3747: }
3748: }
3749:
1.23 harris41 3750: # grabs exception and records it to log before exiting
3751: sub catchexception {
1.27 albertel 3752: my ($error)=@_;
1.25 www 3753: $SIG{'QUIT'}='DEFAULT';
3754: $SIG{__DIE__}='DEFAULT';
1.165 albertel 3755: &status("Catching exception");
1.190 albertel 3756: &logthis("<font color='red'>CRITICAL: "
1.134 albertel 3757: ."ABNORMAL EXIT. Child $$ for server $thisserver died through "
1.27 albertel 3758: ."a crash with this error msg->[$error]</font>");
1.57 www 3759: &logthis('Famous last words: '.$status.' - '.$lastlog);
1.27 albertel 3760: if ($client) { print $client "error: $error\n"; }
1.59 www 3761: $server->close();
1.27 albertel 3762: die($error);
1.23 harris41 3763: }
1.63 www 3764: sub timeout {
1.165 albertel 3765: &status("Handling Timeout");
1.190 albertel 3766: &logthis("<font color='red'>CRITICAL: TIME OUT ".$$."</font>");
1.63 www 3767: &catchexception('Timeout');
3768: }
1.22 harris41 3769: # -------------------------------- Set signal handlers to record abnormal exits
3770:
1.226 foxr 3771:
1.22 harris41 3772: $SIG{'QUIT'}=\&catchexception;
3773: $SIG{__DIE__}=\&catchexception;
3774:
1.81 matthew 3775: # ---------------------------------- Read loncapa_apache.conf and loncapa.conf
1.95 harris41 3776: &status("Read loncapa.conf and loncapa_apache.conf");
3777: my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');
1.141 foxr 3778: %perlvar=%{$perlvarref};
1.80 harris41 3779: undef $perlvarref;
1.19 www 3780:
1.35 harris41 3781: # ----------------------------- Make sure this process is running from user=www
3782: my $wwwid=getpwnam('www');
3783: if ($wwwid!=$<) {
1.134 albertel 3784: my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
3785: my $subj="LON: $currenthostid User ID mismatch";
1.37 harris41 3786: system("echo 'User ID mismatch. lond must be run as user www.' |\
1.35 harris41 3787: mailto $emailto -s '$subj' > /dev/null");
3788: exit 1;
3789: }
3790:
1.19 www 3791: # --------------------------------------------- Check if other instance running
3792:
3793: my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
3794:
3795: if (-e $pidfile) {
3796: my $lfh=IO::File->new("$pidfile");
3797: my $pide=<$lfh>;
3798: chomp($pide);
1.29 harris41 3799: if (kill 0 => $pide) { die "already running"; }
1.19 www 3800: }
1.1 albertel 3801:
3802: # ------------------------------------------------------------- Read hosts file
3803:
3804:
3805:
3806: # establish SERVER socket, bind and listen.
3807: $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},
3808: Type => SOCK_STREAM,
3809: Proto => 'tcp',
3810: Reuse => 1,
3811: Listen => 10 )
1.29 harris41 3812: or die "making socket: $@\n";
1.1 albertel 3813:
3814: # --------------------------------------------------------- Do global variables
3815:
3816: # global variables
3817:
1.134 albertel 3818: my %children = (); # keys are current child process IDs
1.1 albertel 3819:
3820: sub REAPER { # takes care of dead children
3821: $SIG{CHLD} = \&REAPER;
1.165 albertel 3822: &status("Handling child death");
1.178 foxr 3823: my $pid;
3824: do {
3825: $pid = waitpid(-1,&WNOHANG());
3826: if (defined($children{$pid})) {
3827: &logthis("Child $pid died");
3828: delete($children{$pid});
1.183 albertel 3829: } elsif ($pid > 0) {
1.178 foxr 3830: &logthis("Unknown Child $pid died");
3831: }
3832: } while ( $pid > 0 );
3833: foreach my $child (keys(%children)) {
3834: $pid = waitpid($child,&WNOHANG());
3835: if ($pid > 0) {
3836: &logthis("Child $child - $pid looks like we missed it's death");
3837: delete($children{$pid});
3838: }
1.176 albertel 3839: }
1.165 albertel 3840: &status("Finished Handling child death");
1.1 albertel 3841: }
3842:
3843: sub HUNTSMAN { # signal handler for SIGINT
1.165 albertel 3844: &status("Killing children (INT)");
1.1 albertel 3845: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
3846: kill 'INT' => keys %children;
1.59 www 3847: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.1 albertel 3848: my $execdir=$perlvar{'lonDaemons'};
3849: unlink("$execdir/logs/lond.pid");
1.190 albertel 3850: &logthis("<font color='red'>CRITICAL: Shutting down</font>");
1.165 albertel 3851: &status("Done killing children");
1.1 albertel 3852: exit; # clean up with dignity
3853: }
3854:
3855: sub HUPSMAN { # signal handler for SIGHUP
3856: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
1.165 albertel 3857: &status("Killing children for restart (HUP)");
1.1 albertel 3858: kill 'INT' => keys %children;
1.59 www 3859: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.190 albertel 3860: &logthis("<font color='red'>CRITICAL: Restarting</font>");
1.134 albertel 3861: my $execdir=$perlvar{'lonDaemons'};
1.30 harris41 3862: unlink("$execdir/logs/lond.pid");
1.165 albertel 3863: &status("Restarting self (HUP)");
1.1 albertel 3864: exec("$execdir/lond"); # here we go again
3865: }
3866:
1.144 foxr 3867: #
1.148 foxr 3868: # Kill off hashes that describe the host table prior to re-reading it.
3869: # Hashes affected are:
1.200 matthew 3870: # %hostid, %hostdom %hostip %hostdns.
1.148 foxr 3871: #
3872: sub KillHostHashes {
3873: foreach my $key (keys %hostid) {
3874: delete $hostid{$key};
3875: }
3876: foreach my $key (keys %hostdom) {
3877: delete $hostdom{$key};
3878: }
3879: foreach my $key (keys %hostip) {
3880: delete $hostip{$key};
3881: }
1.200 matthew 3882: foreach my $key (keys %hostdns) {
3883: delete $hostdns{$key};
3884: }
1.148 foxr 3885: }
3886: #
3887: # Read in the host table from file and distribute it into the various hashes:
3888: #
3889: # - %hostid - Indexed by IP, the loncapa hostname.
3890: # - %hostdom - Indexed by loncapa hostname, the domain.
3891: # - %hostip - Indexed by hostid, the Ip address of the host.
3892: sub ReadHostTable {
3893:
3894: open (CONFIG,"$perlvar{'lonTabDir'}/hosts.tab") || die "Can't read host file";
1.200 matthew 3895: my $myloncapaname = $perlvar{'lonHostID'};
3896: Debug("My loncapa name is : $myloncapaname");
1.148 foxr 3897: while (my $configline=<CONFIG>) {
1.178 foxr 3898: if (!($configline =~ /^\s*\#/)) {
3899: my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
3900: chomp($ip); $ip=~s/\D+$//;
1.200 matthew 3901: $hostid{$ip}=$id; # LonCAPA name of host by IP.
3902: $hostdom{$id}=$domain; # LonCAPA domain name of host.
3903: $hostip{$id}=$ip; # IP address of host.
3904: $hostdns{$name} = $id; # LonCAPA name of host by DNS.
3905:
3906: if ($id eq $perlvar{'lonHostID'}) {
3907: Debug("Found me in the host table: $name");
3908: $thisserver=$name;
3909: }
1.178 foxr 3910: }
1.148 foxr 3911: }
3912: close(CONFIG);
3913: }
3914: #
3915: # Reload the Apache daemon's state.
1.150 foxr 3916: # This is done by invoking /home/httpd/perl/apachereload
3917: # a setuid perl script that can be root for us to do this job.
1.148 foxr 3918: #
3919: sub ReloadApache {
1.150 foxr 3920: my $execdir = $perlvar{'lonDaemons'};
3921: my $script = $execdir."/apachereload";
3922: system($script);
1.148 foxr 3923: }
3924:
3925: #
1.144 foxr 3926: # Called in response to a USR2 signal.
3927: # - Reread hosts.tab
3928: # - All children connected to hosts that were removed from hosts.tab
3929: # are killed via SIGINT
3930: # - All children connected to previously existing hosts are sent SIGUSR1
3931: # - Our internal hosts hash is updated to reflect the new contents of
3932: # hosts.tab causing connections from hosts added to hosts.tab to
3933: # now be honored.
3934: #
3935: sub UpdateHosts {
1.165 albertel 3936: &status("Reload hosts.tab");
1.147 foxr 3937: logthis('<font color="blue"> Updating connections </font>');
1.148 foxr 3938: #
3939: # The %children hash has the set of IP's we currently have children
3940: # on. These need to be matched against records in the hosts.tab
3941: # Any ip's no longer in the table get killed off they correspond to
3942: # either dropped or changed hosts. Note that the re-read of the table
3943: # will take care of new and changed hosts as connections come into being.
3944:
3945:
3946: KillHostHashes;
3947: ReadHostTable;
3948:
3949: foreach my $child (keys %children) {
3950: my $childip = $children{$child};
3951: if(!$hostid{$childip}) {
1.149 foxr 3952: logthis('<font color="blue"> UpdateHosts killing child '
3953: ." $child for ip $childip </font>");
1.148 foxr 3954: kill('INT', $child);
1.149 foxr 3955: } else {
3956: logthis('<font color="green"> keeping child for ip '
3957: ." $childip (pid=$child) </font>");
1.148 foxr 3958: }
3959: }
3960: ReloadApache;
1.165 albertel 3961: &status("Finished reloading hosts.tab");
1.144 foxr 3962: }
3963:
1.148 foxr 3964:
1.57 www 3965: sub checkchildren {
1.165 albertel 3966: &status("Checking on the children (sending signals)");
1.57 www 3967: &initnewstatus();
3968: &logstatus();
3969: &logthis('Going to check on the children');
1.134 albertel 3970: my $docdir=$perlvar{'lonDocRoot'};
1.61 harris41 3971: foreach (sort keys %children) {
1.221 albertel 3972: #sleep 1;
1.57 www 3973: unless (kill 'USR1' => $_) {
3974: &logthis ('Child '.$_.' is dead');
3975: &logstatus($$.' is dead');
1.221 albertel 3976: delete($children{$_});
1.57 www 3977: }
1.61 harris41 3978: }
1.63 www 3979: sleep 5;
1.212 foxr 3980: $SIG{ALRM} = sub { Debug("timeout");
3981: die "timeout"; };
1.113 albertel 3982: $SIG{__DIE__} = 'DEFAULT';
1.165 albertel 3983: &status("Checking on the children (waiting for reports)");
1.63 www 3984: foreach (sort keys %children) {
3985: unless (-e "$docdir/lon-status/londchld/$_.txt") {
1.113 albertel 3986: eval {
3987: alarm(300);
1.63 www 3988: &logthis('Child '.$_.' did not respond');
1.67 albertel 3989: kill 9 => $_;
1.131 albertel 3990: #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
3991: #$subj="LON: $currenthostid killed lond process $_";
3992: #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
3993: #$execdir=$perlvar{'lonDaemons'};
3994: #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
1.221 albertel 3995: delete($children{$_});
1.113 albertel 3996: alarm(0);
3997: }
1.63 www 3998: }
3999: }
1.113 albertel 4000: $SIG{ALRM} = 'DEFAULT';
1.155 albertel 4001: $SIG{__DIE__} = \&catchexception;
1.165 albertel 4002: &status("Finished checking children");
1.221 albertel 4003: &logthis('Finished Checking children');
1.57 www 4004: }
4005:
1.1 albertel 4006: # --------------------------------------------------------------------- Logging
4007:
4008: sub logthis {
4009: my $message=shift;
4010: my $execdir=$perlvar{'lonDaemons'};
4011: my $fh=IO::File->new(">>$execdir/logs/lond.log");
4012: my $now=time;
4013: my $local=localtime($now);
1.58 www 4014: $lastlog=$local.': '.$message;
1.1 albertel 4015: print $fh "$local ($$): $message\n";
4016: }
4017:
1.77 foxr 4018: # ------------------------- Conditional log if $DEBUG true.
4019: sub Debug {
4020: my $message = shift;
4021: if($DEBUG) {
4022: &logthis($message);
4023: }
4024: }
1.161 foxr 4025:
4026: #
4027: # Sub to do replies to client.. this gives a hook for some
4028: # debug tracing too:
4029: # Parameters:
4030: # fd - File open on client.
4031: # reply - Text to send to client.
4032: # request - Original request from client.
4033: #
4034: sub Reply {
1.192 foxr 4035: my ($fd, $reply, $request) = @_;
1.161 foxr 4036: print $fd $reply;
4037: Debug("Request was $request Reply was $reply");
4038:
1.212 foxr 4039: $Transactions++;
4040:
4041:
4042: }
4043:
4044:
4045: #
4046: # Sub to report a failure.
4047: # This function:
4048: # - Increments the failure statistic counters.
4049: # - Invokes Reply to send the error message to the client.
4050: # Parameters:
4051: # fd - File descriptor open on the client
4052: # reply - Reply text to emit.
4053: # request - The original request message (used by Reply
4054: # to debug if that's enabled.
4055: # Implicit outputs:
4056: # $Failures- The number of failures is incremented.
4057: # Reply (invoked here) sends a message to the
4058: # client:
4059: #
4060: sub Failure {
4061: my $fd = shift;
4062: my $reply = shift;
4063: my $request = shift;
4064:
4065: $Failures++;
4066: Reply($fd, $reply, $request); # That's simple eh?
1.161 foxr 4067: }
1.57 www 4068: # ------------------------------------------------------------------ Log status
4069:
4070: sub logstatus {
1.178 foxr 4071: &status("Doing logging");
4072: my $docdir=$perlvar{'lonDocRoot'};
4073: {
4074: my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
1.200 matthew 4075: print $fh $status."\n".$lastlog."\n".time."\n$keymode";
1.178 foxr 4076: $fh->close();
4077: }
1.221 albertel 4078: &status("Finished $$.txt");
4079: {
4080: open(LOG,">>$docdir/lon-status/londstatus.txt");
4081: flock(LOG,LOCK_EX);
4082: print LOG $$."\t".$clientname."\t".$currenthostid."\t"
4083: .$status."\t".$lastlog."\t $keymode\n";
4084: flock(DB,LOCK_UN);
4085: close(LOG);
4086: }
1.178 foxr 4087: &status("Finished logging");
1.57 www 4088: }
4089:
4090: sub initnewstatus {
4091: my $docdir=$perlvar{'lonDocRoot'};
4092: my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");
4093: my $now=time;
4094: my $local=localtime($now);
4095: print $fh "LOND status $local - parent $$\n\n";
1.64 www 4096: opendir(DIR,"$docdir/lon-status/londchld");
1.134 albertel 4097: while (my $filename=readdir(DIR)) {
1.64 www 4098: unlink("$docdir/lon-status/londchld/$filename");
4099: }
4100: closedir(DIR);
1.57 www 4101: }
4102:
4103: # -------------------------------------------------------------- Status setting
4104:
4105: sub status {
4106: my $what=shift;
4107: my $now=time;
4108: my $local=localtime($now);
1.178 foxr 4109: $status=$local.': '.$what;
4110: $0='lond: '.$what.' '.$local;
1.57 www 4111: }
1.11 www 4112:
4113: # -------------------------------------------------------- Escape Special Chars
4114:
4115: sub escape {
4116: my $str=shift;
4117: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
4118: return $str;
4119: }
4120:
4121: # ----------------------------------------------------- Un-Escape Special Chars
4122:
4123: sub unescape {
4124: my $str=shift;
4125: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
4126: return $str;
4127: }
4128:
1.1 albertel 4129: # ----------------------------------------------------------- Send USR1 to lonc
4130:
4131: sub reconlonc {
4132: my $peerfile=shift;
4133: &logthis("Trying to reconnect for $peerfile");
4134: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
4135: if (my $fh=IO::File->new("$loncfile")) {
4136: my $loncpid=<$fh>;
4137: chomp($loncpid);
4138: if (kill 0 => $loncpid) {
4139: &logthis("lonc at pid $loncpid responding, sending USR1");
4140: kill USR1 => $loncpid;
4141: } else {
1.9 www 4142: &logthis(
1.190 albertel 4143: "<font color='red'>CRITICAL: "
1.9 www 4144: ."lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 4145: }
4146: } else {
1.190 albertel 4147: &logthis('<font color="red">CRITICAL: lonc not running, giving up</font>');
1.1 albertel 4148: }
4149: }
4150:
4151: # -------------------------------------------------- Non-critical communication
1.11 www 4152:
1.1 albertel 4153: sub subreply {
4154: my ($cmd,$server)=@_;
4155: my $peerfile="$perlvar{'lonSockDir'}/$server";
4156: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
4157: Type => SOCK_STREAM,
4158: Timeout => 10)
4159: or return "con_lost";
4160: print $sclient "$cmd\n";
4161: my $answer=<$sclient>;
4162: chomp($answer);
4163: if (!$answer) { $answer="con_lost"; }
4164: return $answer;
4165: }
4166:
4167: sub reply {
4168: my ($cmd,$server)=@_;
4169: my $answer;
1.115 albertel 4170: if ($server ne $currenthostid) {
1.1 albertel 4171: $answer=subreply($cmd,$server);
4172: if ($answer eq 'con_lost') {
4173: $answer=subreply("ping",$server);
4174: if ($answer ne $server) {
1.115 albertel 4175: &logthis("sub reply: answer != server answer is $answer, server is $server");
1.1 albertel 4176: &reconlonc("$perlvar{'lonSockDir'}/$server");
4177: }
4178: $answer=subreply($cmd,$server);
4179: }
4180: } else {
4181: $answer='self_reply';
4182: }
4183: return $answer;
4184: }
4185:
1.13 www 4186: # -------------------------------------------------------------- Talk to lonsql
4187:
1.234 foxr 4188: sub sql_reply {
1.12 harris41 4189: my ($cmd)=@_;
1.234 foxr 4190: my $answer=&sub_sql_reply($cmd);
4191: if ($answer eq 'con_lost') { $answer=&sub_sql_reply($cmd); }
1.12 harris41 4192: return $answer;
4193: }
4194:
1.234 foxr 4195: sub sub_sql_reply {
1.12 harris41 4196: my ($cmd)=@_;
4197: my $unixsock="mysqlsock";
4198: my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
4199: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
4200: Type => SOCK_STREAM,
4201: Timeout => 10)
4202: or return "con_lost";
4203: print $sclient "$cmd\n";
4204: my $answer=<$sclient>;
4205: chomp($answer);
4206: if (!$answer) { $answer="con_lost"; }
4207: return $answer;
4208: }
4209:
1.1 albertel 4210: # -------------------------------------------- Return path to profile directory
1.11 www 4211:
1.1 albertel 4212: sub propath {
4213: my ($udom,$uname)=@_;
4214: $udom=~s/\W//g;
4215: $uname=~s/\W//g;
1.16 www 4216: my $subdir=$uname.'__';
1.1 albertel 4217: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
4218: my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
4219: return $proname;
4220: }
4221:
4222: # --------------------------------------- Is this the home server of an author?
1.11 www 4223:
1.1 albertel 4224: sub ishome {
4225: my $author=shift;
4226: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
4227: my ($udom,$uname)=split(/\//,$author);
4228: my $proname=propath($udom,$uname);
4229: if (-e $proname) {
4230: return 'owner';
4231: } else {
4232: return 'not_owner';
4233: }
4234: }
4235:
4236: # ======================================================= Continue main program
4237: # ---------------------------------------------------- Fork once and dissociate
4238:
1.134 albertel 4239: my $fpid=fork;
1.1 albertel 4240: exit if $fpid;
1.29 harris41 4241: die "Couldn't fork: $!" unless defined ($fpid);
1.1 albertel 4242:
1.29 harris41 4243: POSIX::setsid() or die "Can't start new session: $!";
1.1 albertel 4244:
4245: # ------------------------------------------------------- Write our PID on disk
4246:
1.134 albertel 4247: my $execdir=$perlvar{'lonDaemons'};
1.1 albertel 4248: open (PIDSAVE,">$execdir/logs/lond.pid");
4249: print PIDSAVE "$$\n";
4250: close(PIDSAVE);
1.190 albertel 4251: &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
1.57 www 4252: &status('Starting');
1.1 albertel 4253:
1.106 foxr 4254:
1.1 albertel 4255:
4256: # ----------------------------------------------------- Install signal handlers
4257:
1.57 www 4258:
1.1 albertel 4259: $SIG{CHLD} = \&REAPER;
4260: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
4261: $SIG{HUP} = \&HUPSMAN;
1.57 www 4262: $SIG{USR1} = \&checkchildren;
1.144 foxr 4263: $SIG{USR2} = \&UpdateHosts;
1.106 foxr 4264:
1.148 foxr 4265: # Read the host hashes:
4266:
4267: ReadHostTable;
1.106 foxr 4268:
4269: # --------------------------------------------------------------
4270: # Accept connections. When a connection comes in, it is validated
4271: # and if good, a child process is created to process transactions
4272: # along the connection.
4273:
1.1 albertel 4274: while (1) {
1.165 albertel 4275: &status('Starting accept');
1.106 foxr 4276: $client = $server->accept() or next;
1.165 albertel 4277: &status('Accepted '.$client.' off to spawn');
1.106 foxr 4278: make_new_child($client);
1.165 albertel 4279: &status('Finished spawning');
1.1 albertel 4280: }
4281:
1.212 foxr 4282: sub make_new_child {
4283: my $pid;
4284: # my $cipher; # Now global
4285: my $sigset;
1.178 foxr 4286:
1.212 foxr 4287: $client = shift;
4288: &status('Starting new child '.$client);
4289: &logthis('<font color="green"> Attempting to start child ('.$client.
4290: ")</font>");
4291: # block signal for fork
4292: $sigset = POSIX::SigSet->new(SIGINT);
4293: sigprocmask(SIG_BLOCK, $sigset)
4294: or die "Can't block SIGINT for fork: $!\n";
1.178 foxr 4295:
1.212 foxr 4296: die "fork: $!" unless defined ($pid = fork);
1.178 foxr 4297:
1.212 foxr 4298: $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
4299: # connection liveness.
1.178 foxr 4300:
1.212 foxr 4301: #
4302: # Figure out who we're talking to so we can record the peer in
4303: # the pid hash.
4304: #
4305: my $caller = getpeername($client);
4306: my ($port,$iaddr);
4307: if (defined($caller) && length($caller) > 0) {
4308: ($port,$iaddr)=unpack_sockaddr_in($caller);
4309: } else {
4310: &logthis("Unable to determine who caller was, getpeername returned nothing");
4311: }
4312: if (defined($iaddr)) {
4313: $clientip = inet_ntoa($iaddr);
4314: Debug("Connected with $clientip");
4315: $clientdns = gethostbyaddr($iaddr, AF_INET);
4316: Debug("Connected with $clientdns by name");
4317: } else {
4318: &logthis("Unable to determine clientip");
4319: $clientip='Unavailable';
4320: }
4321:
4322: if ($pid) {
4323: # Parent records the child's birth and returns.
4324: sigprocmask(SIG_UNBLOCK, $sigset)
4325: or die "Can't unblock SIGINT for fork: $!\n";
4326: $children{$pid} = $clientip;
4327: &status('Started child '.$pid);
4328: return;
4329: } else {
4330: # Child can *not* return from this subroutine.
4331: $SIG{INT} = 'DEFAULT'; # make SIGINT kill us as it did before
4332: $SIG{CHLD} = 'DEFAULT'; #make this default so that pwauth returns
4333: #don't get intercepted
4334: $SIG{USR1}= \&logstatus;
4335: $SIG{ALRM}= \&timeout;
4336: $lastlog='Forked ';
4337: $status='Forked';
1.178 foxr 4338:
1.212 foxr 4339: # unblock signals
4340: sigprocmask(SIG_UNBLOCK, $sigset)
4341: or die "Can't unblock SIGINT for fork: $!\n";
1.178 foxr 4342:
1.212 foxr 4343: # my $tmpsnum=0; # Now global
4344: #---------------------------------------------------- kerberos 5 initialization
4345: &Authen::Krb5::init_context();
4346: &Authen::Krb5::init_ets();
1.209 albertel 4347:
1.212 foxr 4348: &status('Accepted connection');
4349: # =============================================================================
4350: # do something with the connection
4351: # -----------------------------------------------------------------------------
4352: # see if we know client and 'check' for spoof IP by ineffective challenge
1.178 foxr 4353:
1.212 foxr 4354: ReadManagerTable; # May also be a manager!!
4355:
4356: my $clientrec=($hostid{$clientip} ne undef);
4357: my $ismanager=($managers{$clientip} ne undef);
4358: $clientname = "[unknonwn]";
4359: if($clientrec) { # Establish client type.
4360: $ConnectionType = "client";
4361: $clientname = $hostid{$clientip};
4362: if($ismanager) {
4363: $ConnectionType = "both";
4364: }
4365: } else {
4366: $ConnectionType = "manager";
4367: $clientname = $managers{$clientip};
4368: }
4369: my $clientok;
1.178 foxr 4370:
1.212 foxr 4371: if ($clientrec || $ismanager) {
4372: &status("Waiting for init from $clientip $clientname");
4373: &logthis('<font color="yellow">INFO: Connection, '.
4374: $clientip.
4375: " ($clientname) connection type = $ConnectionType </font>" );
4376: &status("Connecting $clientip ($clientname))");
4377: my $remotereq=<$client>;
4378: chomp($remotereq);
4379: Debug("Got init: $remotereq");
4380: my $inikeyword = split(/:/, $remotereq);
4381: if ($remotereq =~ /^init/) {
4382: &sethost("sethost:$perlvar{'lonHostID'}");
4383: #
4384: # If the remote is attempting a local init... give that a try:
4385: #
4386: my ($i, $inittype) = split(/:/, $remotereq);
1.209 albertel 4387:
1.212 foxr 4388: # If the connection type is ssl, but I didn't get my
4389: # certificate files yet, then I'll drop back to
4390: # insecure (if allowed).
4391:
4392: if($inittype eq "ssl") {
4393: my ($ca, $cert) = lonssl::CertificateFile;
4394: my $kfile = lonssl::KeyFile;
4395: if((!$ca) ||
4396: (!$cert) ||
4397: (!$kfile)) {
4398: $inittype = ""; # This forces insecure attempt.
4399: &logthis("<font color=\"blue\"> Certificates not "
4400: ."installed -- trying insecure auth</font>");
1.224 foxr 4401: } else { # SSL certificates are in place so
1.212 foxr 4402: } # Leave the inittype alone.
4403: }
4404:
4405: if($inittype eq "local") {
4406: my $key = LocalConnection($client, $remotereq);
4407: if($key) {
4408: Debug("Got local key $key");
4409: $clientok = 1;
4410: my $cipherkey = pack("H32", $key);
4411: $cipher = new IDEA($cipherkey);
4412: print $client "ok:local\n";
4413: &logthis('<font color="green"'
4414: . "Successful local authentication </font>");
4415: $keymode = "local"
1.178 foxr 4416: } else {
1.212 foxr 4417: Debug("Failed to get local key");
4418: $clientok = 0;
4419: shutdown($client, 3);
4420: close $client;
1.178 foxr 4421: }
1.212 foxr 4422: } elsif ($inittype eq "ssl") {
4423: my $key = SSLConnection($client);
4424: if ($key) {
4425: $clientok = 1;
4426: my $cipherkey = pack("H32", $key);
4427: $cipher = new IDEA($cipherkey);
4428: &logthis('<font color="green">'
4429: ."Successfull ssl authentication with $clientname </font>");
4430: $keymode = "ssl";
4431:
1.178 foxr 4432: } else {
1.212 foxr 4433: $clientok = 0;
4434: close $client;
1.178 foxr 4435: }
1.212 foxr 4436:
4437: } else {
4438: my $ok = InsecureConnection($client);
4439: if($ok) {
4440: $clientok = 1;
4441: &logthis('<font color="green">'
4442: ."Successful insecure authentication with $clientname </font>");
4443: print $client "ok\n";
4444: $keymode = "insecure";
1.178 foxr 4445: } else {
1.212 foxr 4446: &logthis('<font color="yellow">'
4447: ."Attempted insecure connection disallowed </font>");
4448: close $client;
4449: $clientok = 0;
1.178 foxr 4450:
4451: }
4452: }
1.212 foxr 4453: } else {
4454: &logthis(
4455: "<font color='blue'>WARNING: "
4456: ."$clientip failed to initialize: >$remotereq< </font>");
4457: &status('No init '.$clientip);
4458: }
4459:
4460: } else {
4461: &logthis(
4462: "<font color='blue'>WARNING: Unknown client $clientip</font>");
4463: &status('Hung up on '.$clientip);
4464: }
4465:
4466: if ($clientok) {
4467: # ---------------- New known client connecting, could mean machine online again
4468:
4469: foreach my $id (keys(%hostip)) {
4470: if ($hostip{$id} ne $clientip ||
4471: $hostip{$currenthostid} eq $clientip) {
4472: # no need to try to do recon's to myself
4473: next;
4474: }
4475: &reconlonc("$perlvar{'lonSockDir'}/$id");
4476: }
4477: &logthis("<font color='green'>Established connection: $clientname</font>");
4478: &status('Will listen to '.$clientname);
4479: # ------------------------------------------------------------ Process requests
4480: my $keep_going = 1;
4481: my $user_input;
4482: while(($user_input = get_request) && $keep_going) {
4483: alarm(120);
4484: Debug("Main: Got $user_input\n");
4485: $keep_going = &process_request($user_input);
1.178 foxr 4486: alarm(0);
1.212 foxr 4487: &status('Listening to '.$clientname." ($keymode)");
1.161 foxr 4488: }
1.212 foxr 4489:
1.59 www 4490: # --------------------------------------------- client unknown or fishy, refuse
1.212 foxr 4491: } else {
1.161 foxr 4492: print $client "refused\n";
4493: $client->close();
1.190 albertel 4494: &logthis("<font color='blue'>WARNING: "
1.161 foxr 4495: ."Rejected client $clientip, closing connection</font>");
4496: }
1.212 foxr 4497: }
1.161 foxr 4498:
1.1 albertel 4499: # =============================================================================
1.161 foxr 4500:
1.190 albertel 4501: &logthis("<font color='red'>CRITICAL: "
1.161 foxr 4502: ."Disconnect from $clientip ($clientname)</font>");
4503:
4504:
4505: # this exit is VERY important, otherwise the child will become
4506: # a producer of more and more children, forking yourself into
4507: # process death.
4508: exit;
1.106 foxr 4509:
1.78 foxr 4510: }
4511:
4512:
4513: #
4514: # Checks to see if the input roleput request was to set
4515: # an author role. If so, invokes the lchtmldir script to set
4516: # up a correct public_html
4517: # Parameters:
4518: # request - The request sent to the rolesput subchunk.
4519: # We're looking for /domain/_au
4520: # domain - The domain in which the user is having roles doctored.
4521: # user - Name of the user for which the role is being put.
4522: # authtype - The authentication type associated with the user.
4523: #
1.230 foxr 4524: sub manage_permissions
1.78 foxr 4525: {
1.192 foxr 4526:
4527: my ($request, $domain, $user, $authtype) = @_;
1.78 foxr 4528:
4529: # See if the request is of the form /$domain/_au
4530: if($request =~ /^(\/$domain\/_au)$/) { # It's an author rolesput...
4531: my $execdir = $perlvar{'lonDaemons'};
4532: my $userhome= "/home/$user" ;
1.134 albertel 4533: &logthis("system $execdir/lchtmldir $userhome $user $authtype");
1.78 foxr 4534: system("$execdir/lchtmldir $userhome $user $authtype");
4535: }
4536: }
1.222 foxr 4537:
4538:
4539: #
4540: # Return the full path of a user password file, whether it exists or not.
4541: # Parameters:
4542: # domain - Domain in which the password file lives.
4543: # user - name of the user.
4544: # Returns:
4545: # Full passwd path:
4546: #
4547: sub password_path {
4548: my ($domain, $user) = @_;
4549:
4550:
4551: my $path = &propath($domain, $user);
4552: $path .= "/passwd";
4553:
4554: return $path;
4555: }
4556:
4557: # Password Filename
4558: # Returns the path to a passwd file given domain and user... only if
4559: # it exists.
4560: # Parameters:
4561: # domain - Domain in which to search.
4562: # user - username.
4563: # Returns:
4564: # - If the password file exists returns its path.
4565: # - If the password file does not exist, returns undefined.
4566: #
4567: sub password_filename {
4568: my ($domain, $user) = @_;
4569:
4570: Debug ("PasswordFilename called: dom = $domain user = $user");
4571:
4572: my $path = &password_path($domain, $user);
4573: Debug("PasswordFilename got path: $path");
4574: if(-e $path) {
4575: return $path;
4576: } else {
4577: return undef;
4578: }
4579: }
4580:
4581: #
4582: # Rewrite the contents of the user's passwd file.
4583: # Parameters:
4584: # domain - domain of the user.
4585: # name - User's name.
4586: # contents - New contents of the file.
4587: # Returns:
4588: # 0 - Failed.
4589: # 1 - Success.
4590: #
4591: sub rewrite_password_file {
4592: my ($domain, $user, $contents) = @_;
4593:
4594: my $file = &password_filename($domain, $user);
4595: if (defined $file) {
4596: my $pf = IO::File->new(">$file");
4597: if($pf) {
4598: print $pf "$contents\n";
4599: return 1;
4600: } else {
4601: return 0;
4602: }
4603: } else {
4604: return 0;
4605: }
4606:
4607: }
4608:
1.78 foxr 4609: #
1.222 foxr 4610: # get_auth_type - Determines the authorization type of a user in a domain.
1.78 foxr 4611:
4612: # Returns the authorization type or nouser if there is no such user.
4613: #
1.222 foxr 4614: sub get_auth_type
1.78 foxr 4615: {
1.192 foxr 4616:
4617: my ($domain, $user) = @_;
1.78 foxr 4618:
1.222 foxr 4619: Debug("get_auth_type( $domain, $user ) \n");
1.78 foxr 4620: my $proname = &propath($domain, $user);
4621: my $passwdfile = "$proname/passwd";
4622: if( -e $passwdfile ) {
4623: my $pf = IO::File->new($passwdfile);
4624: my $realpassword = <$pf>;
4625: chomp($realpassword);
1.79 foxr 4626: Debug("Password info = $realpassword\n");
1.78 foxr 4627: my ($authtype, $contentpwd) = split(/:/, $realpassword);
1.79 foxr 4628: Debug("Authtype = $authtype, content = $contentpwd\n");
1.78 foxr 4629: my $availinfo = '';
1.91 albertel 4630: if($authtype eq 'krb4' or $authtype eq 'krb5') {
1.78 foxr 4631: $availinfo = $contentpwd;
4632: }
1.79 foxr 4633:
1.78 foxr 4634: return "$authtype:$availinfo";
1.224 foxr 4635: } else {
1.79 foxr 4636: Debug("Returning nouser");
1.78 foxr 4637: return "nouser";
4638: }
1.1 albertel 4639: }
4640:
1.220 foxr 4641: #
4642: # Validate a user given their domain, name and password. This utility
4643: # function is used by both AuthenticateHandler and ChangePasswordHandler
4644: # to validate the login credentials of a user.
4645: # Parameters:
4646: # $domain - The domain being logged into (this is required due to
4647: # the capability for multihomed systems.
4648: # $user - The name of the user being validated.
4649: # $password - The user's propoposed password.
4650: #
4651: # Returns:
4652: # 1 - The domain,user,pasword triplet corresponds to a valid
4653: # user.
4654: # 0 - The domain,user,password triplet is not a valid user.
4655: #
4656: sub validate_user {
4657: my ($domain, $user, $password) = @_;
4658:
4659:
4660: # Why negative ~pi you may well ask? Well this function is about
4661: # authentication, and therefore very important to get right.
4662: # I've initialized the flag that determines whether or not I've
4663: # validated correctly to a value it's not supposed to get.
4664: # At the end of this function. I'll ensure that it's not still that
4665: # value so we don't just wind up returning some accidental value
4666: # as a result of executing an unforseen code path that
4667: # did not set $validated.
4668:
4669: my $validated = -3.14159;
4670:
4671: # How we authenticate is determined by the type of authentication
4672: # the user has been assigned. If the authentication type is
4673: # "nouser", the user does not exist so we will return 0.
4674:
1.222 foxr 4675: my $contents = &get_auth_type($domain, $user);
1.220 foxr 4676: my ($howpwd, $contentpwd) = split(/:/, $contents);
4677:
4678: my $null = pack("C",0); # Used by kerberos auth types.
4679:
4680: if ($howpwd ne 'nouser') {
4681:
4682: if($howpwd eq "internal") { # Encrypted is in local password file.
4683: $validated = (crypt($password, $contentpwd) eq $contentpwd);
4684: }
4685: elsif ($howpwd eq "unix") { # User is a normal unix user.
4686: $contentpwd = (getpwnam($user))[1];
4687: if($contentpwd) {
4688: if($contentpwd eq 'x') { # Shadow password file...
4689: my $pwauth_path = "/usr/local/sbin/pwauth";
4690: open PWAUTH, "|$pwauth_path" or
4691: die "Cannot invoke authentication";
4692: print PWAUTH "$user\n$password\n";
4693: close PWAUTH;
4694: $validated = ! $?;
4695:
4696: } else { # Passwords in /etc/passwd.
4697: $validated = (crypt($password,
4698: $contentpwd) eq $contentpwd);
4699: }
4700: } else {
4701: $validated = 0;
4702: }
4703: }
4704: elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
4705: if(! ($password =~ /$null/) ) {
4706: my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
4707: "",
4708: $contentpwd,,
4709: 'krbtgt',
4710: $contentpwd,
4711: 1,
4712: $password);
4713: if(!$k4error) {
4714: $validated = 1;
1.224 foxr 4715: } else {
1.220 foxr 4716: $validated = 0;
4717: &logthis('krb4: '.$user.', '.$contentpwd.', '.
4718: &Authen::Krb4::get_err_txt($Authen::Krb4::error));
4719: }
1.224 foxr 4720: } else {
1.220 foxr 4721: $validated = 0; # Password has a match with null.
4722: }
1.224 foxr 4723: } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
1.220 foxr 4724: if(!($password =~ /$null/)) { # Null password not allowed.
4725: my $krbclient = &Authen::Krb5::parse_name($user.'@'
4726: .$contentpwd);
4727: my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
4728: my $krbserver = &Authen::Krb5::parse_name($krbservice);
4729: my $credentials= &Authen::Krb5::cc_default();
4730: $credentials->initialize($krbclient);
4731: my $krbreturn = &Authen::KRb5::get_in_tkt_with_password($krbclient,
4732: $krbserver,
4733: $password,
4734: $credentials);
4735: $validated = ($krbreturn == 1);
1.224 foxr 4736: } else {
1.220 foxr 4737: $validated = 0;
4738: }
1.224 foxr 4739: } elsif ($howpwd eq "localauth") {
1.220 foxr 4740: # Authenticate via installation specific authentcation method:
4741: $validated = &localauth::localauth($user,
4742: $password,
4743: $contentpwd);
1.224 foxr 4744: } else { # Unrecognized auth is also bad.
1.220 foxr 4745: $validated = 0;
4746: }
4747: } else {
4748: $validated = 0;
4749: }
4750: #
4751: # $validated has the correct stat of the authentication:
4752: #
4753:
4754: unless ($validated != -3.14159) {
4755: die "ValidateUser - failed to set the value of validated";
4756: }
4757: return $validated;
4758: }
4759:
4760:
1.84 albertel 4761: sub addline {
4762: my ($fname,$hostid,$ip,$newline)=@_;
4763: my $contents;
4764: my $found=0;
4765: my $expr='^'.$hostid.':'.$ip.':';
4766: $expr =~ s/\./\\\./g;
1.134 albertel 4767: my $sh;
1.84 albertel 4768: if ($sh=IO::File->new("$fname.subscription")) {
4769: while (my $subline=<$sh>) {
4770: if ($subline !~ /$expr/) {$contents.= $subline;} else {$found=1;}
4771: }
4772: $sh->close();
4773: }
4774: $sh=IO::File->new(">$fname.subscription");
4775: if ($contents) { print $sh $contents; }
4776: if ($newline) { print $sh $newline; }
4777: $sh->close();
4778: return $found;
1.86 www 4779: }
4780:
1.234 foxr 4781: sub get_chat {
1.122 www 4782: my ($cdom,$cname,$udom,$uname)=@_;
1.87 www 4783: my %hash;
4784: my $proname=&propath($cdom,$cname);
4785: my @entries=();
1.88 albertel 4786: if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",
4787: &GDBM_READER(),0640)) {
4788: @entries=map { $_.':'.$hash{$_} } sort keys %hash;
4789: untie %hash;
1.123 www 4790: }
1.124 www 4791: my @participants=();
1.134 albertel 4792: my $cutoff=time-60;
1.123 www 4793: if (tie(%hash,'GDBM_File',"$proname/nohist_inchatroom.db",
1.124 www 4794: &GDBM_WRCREAT(),0640)) {
4795: $hash{$uname.':'.$udom}=time;
1.123 www 4796: foreach (sort keys %hash) {
4797: if ($hash{$_}>$cutoff) {
1.124 www 4798: $participants[$#participants+1]='active_participant:'.$_;
1.123 www 4799: }
4800: }
4801: untie %hash;
1.86 www 4802: }
1.124 www 4803: return (@participants,@entries);
1.86 www 4804: }
4805:
1.234 foxr 4806: sub chat_add {
1.88 albertel 4807: my ($cdom,$cname,$newchat)=@_;
4808: my %hash;
4809: my $proname=&propath($cdom,$cname);
4810: my @entries=();
1.142 www 4811: my $time=time;
1.88 albertel 4812: if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",
4813: &GDBM_WRCREAT(),0640)) {
4814: @entries=map { $_.':'.$hash{$_} } sort keys %hash;
4815: my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
4816: my ($thentime,$idnum)=split(/\_/,$lastid);
4817: my $newid=$time.'_000000';
4818: if ($thentime==$time) {
4819: $idnum=~s/^0+//;
4820: $idnum++;
4821: $idnum=substr('000000'.$idnum,-6,6);
4822: $newid=$time.'_'.$idnum;
4823: }
4824: $hash{$newid}=$newchat;
4825: my $expired=$time-3600;
4826: foreach (keys %hash) {
4827: my ($thistime)=($_=~/(\d+)\_/);
4828: if ($thistime<$expired) {
1.89 www 4829: delete $hash{$_};
1.88 albertel 4830: }
4831: }
4832: untie %hash;
1.142 www 4833: }
4834: {
4835: my $hfh;
4836: if ($hfh=IO::File->new(">>$proname/chatroom.log")) {
4837: print $hfh "$time:".&unescape($newchat)."\n";
4838: }
1.86 www 4839: }
1.84 albertel 4840: }
4841:
4842: sub unsub {
4843: my ($fname,$clientip)=@_;
4844: my $result;
1.188 foxr 4845: my $unsubs = 0; # Number of successful unsubscribes:
4846:
4847:
4848: # An old way subscriptions were handled was to have a
4849: # subscription marker file:
4850:
4851: Debug("Attempting unlink of $fname.$clientname");
1.161 foxr 4852: if (unlink("$fname.$clientname")) {
1.188 foxr 4853: $unsubs++; # Successful unsub via marker file.
4854: }
4855:
4856: # The more modern way to do it is to have a subscription list
4857: # file:
4858:
1.84 albertel 4859: if (-e "$fname.subscription") {
1.161 foxr 4860: my $found=&addline($fname,$clientname,$clientip,'');
1.188 foxr 4861: if ($found) {
4862: $unsubs++;
4863: }
4864: }
4865:
4866: # If either or both of these mechanisms succeeded in unsubscribing a
4867: # resource we can return ok:
4868:
4869: if($unsubs) {
4870: $result = "ok\n";
1.84 albertel 4871: } else {
1.188 foxr 4872: $result = "not_subscribed\n";
1.84 albertel 4873: }
1.188 foxr 4874:
1.84 albertel 4875: return $result;
4876: }
4877:
1.101 www 4878: sub currentversion {
4879: my $fname=shift;
4880: my $version=-1;
4881: my $ulsdir='';
4882: if ($fname=~/^(.+)\/[^\/]+$/) {
4883: $ulsdir=$1;
4884: }
1.114 albertel 4885: my ($fnamere1,$fnamere2);
4886: # remove version if already specified
1.101 www 4887: $fname=~s/\.\d+\.(\w+(?:\.meta)*)$/\.$1/;
1.114 albertel 4888: # get the bits that go before and after the version number
4889: if ( $fname=~/^(.*\.)(\w+(?:\.meta)*)$/ ) {
4890: $fnamere1=$1;
4891: $fnamere2='.'.$2;
4892: }
1.101 www 4893: if (-e $fname) { $version=1; }
4894: if (-e $ulsdir) {
1.134 albertel 4895: if(-d $ulsdir) {
4896: if (opendir(LSDIR,$ulsdir)) {
4897: my $ulsfn;
4898: while ($ulsfn=readdir(LSDIR)) {
1.101 www 4899: # see if this is a regular file (ignore links produced earlier)
1.134 albertel 4900: my $thisfile=$ulsdir.'/'.$ulsfn;
4901: unless (-l $thisfile) {
1.160 www 4902: if ($thisfile=~/\Q$fnamere1\E(\d+)\Q$fnamere2\E$/) {
1.134 albertel 4903: if ($1>$version) { $version=$1; }
4904: }
4905: }
4906: }
4907: closedir(LSDIR);
4908: $version++;
4909: }
4910: }
4911: }
4912: return $version;
1.101 www 4913: }
4914:
4915: sub thisversion {
4916: my $fname=shift;
4917: my $version=-1;
4918: if ($fname=~/\.(\d+)\.\w+(?:\.meta)*$/) {
4919: $version=$1;
4920: }
4921: return $version;
4922: }
4923:
1.84 albertel 4924: sub subscribe {
4925: my ($userinput,$clientip)=@_;
4926: my $result;
4927: my ($cmd,$fname)=split(/:/,$userinput);
4928: my $ownership=&ishome($fname);
4929: if ($ownership eq 'owner') {
1.101 www 4930: # explitly asking for the current version?
4931: unless (-e $fname) {
4932: my $currentversion=¤tversion($fname);
4933: if (&thisversion($fname)==$currentversion) {
4934: if ($fname=~/^(.+)\.\d+\.(\w+(?:\.meta)*)$/) {
4935: my $root=$1;
4936: my $extension=$2;
4937: symlink($root.'.'.$extension,
4938: $root.'.'.$currentversion.'.'.$extension);
1.102 www 4939: unless ($extension=~/\.meta$/) {
4940: symlink($root.'.'.$extension.'.meta',
4941: $root.'.'.$currentversion.'.'.$extension.'.meta');
4942: }
1.101 www 4943: }
4944: }
4945: }
1.84 albertel 4946: if (-e $fname) {
4947: if (-d $fname) {
4948: $result="directory\n";
4949: } else {
1.161 foxr 4950: if (-e "$fname.$clientname") {&unsub($fname,$clientip);}
1.134 albertel 4951: my $now=time;
1.161 foxr 4952: my $found=&addline($fname,$clientname,$clientip,
4953: "$clientname:$clientip:$now\n");
1.84 albertel 4954: if ($found) { $result="$fname\n"; }
4955: # if they were subscribed to only meta data, delete that
4956: # subscription, when you subscribe to a file you also get
4957: # the metadata
4958: unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
4959: $fname=~s/\/home\/httpd\/html\/res/raw/;
4960: $fname="http://$thisserver/".$fname;
4961: $result="$fname\n";
4962: }
4963: } else {
4964: $result="not_found\n";
4965: }
4966: } else {
4967: $result="rejected\n";
4968: }
4969: return $result;
4970: }
1.91 albertel 4971:
4972: sub make_passwd_file {
1.98 foxr 4973: my ($uname, $umode,$npass,$passfilename)=@_;
1.91 albertel 4974: my $result="ok\n";
4975: if ($umode eq 'krb4' or $umode eq 'krb5') {
4976: {
4977: my $pf = IO::File->new(">$passfilename");
4978: print $pf "$umode:$npass\n";
4979: }
4980: } elsif ($umode eq 'internal') {
4981: my $salt=time;
4982: $salt=substr($salt,6,2);
4983: my $ncpass=crypt($npass,$salt);
4984: {
4985: &Debug("Creating internal auth");
4986: my $pf = IO::File->new(">$passfilename");
4987: print $pf "internal:$ncpass\n";
4988: }
4989: } elsif ($umode eq 'localauth') {
4990: {
4991: my $pf = IO::File->new(">$passfilename");
4992: print $pf "localauth:$npass\n";
4993: }
4994: } elsif ($umode eq 'unix') {
4995: {
1.186 foxr 4996: #
4997: # Don't allow the creation of privileged accounts!!! that would
4998: # be real bad!!!
4999: #
5000: my $uid = getpwnam($uname);
5001: if((defined $uid) && ($uid == 0)) {
5002: &logthis(">>>Attempted to create privilged account blocked");
5003: return "no_priv_account_error\n";
5004: }
5005:
1.223 foxr 5006: my $execpath ="$perlvar{'lonDaemons'}/"."lcuseradd";
1.224 foxr 5007:
5008: my $lc_error_file = $execdir."/tmp/lcuseradd".$$.".status";
1.91 albertel 5009: {
5010: &Debug("Executing external: ".$execpath);
1.98 foxr 5011: &Debug("user = ".$uname.", Password =". $npass);
1.132 matthew 5012: my $se = IO::File->new("|$execpath > $perlvar{'lonDaemons'}/logs/lcuseradd.log");
1.91 albertel 5013: print $se "$uname\n";
5014: print $se "$npass\n";
5015: print $se "$npass\n";
1.223 foxr 5016: print $se "$lc_error_file\n"; # Status -> unique file.
1.97 foxr 5017: }
1.223 foxr 5018: my $error = IO::File->new("< $lc_error_file");
5019: my $useraddok = <$error>;
5020: $error->close;
5021: unlink($lc_error_file);
5022:
5023: chomp $useraddok;
5024:
1.97 foxr 5025: if($useraddok > 0) {
1.223 foxr 5026: my $error_text = &lcuseraddstrerror($useraddok);
5027: &logthis("Failed lcuseradd: $error_text");
5028: $result = "lcuseradd_failed:$error_text\n";
1.224 foxr 5029: } else {
1.223 foxr 5030: my $pf = IO::File->new(">$passfilename");
5031: print $pf "unix:\n";
1.91 albertel 5032: }
5033: }
5034: } elsif ($umode eq 'none') {
5035: {
1.223 foxr 5036: my $pf = IO::File->new("> $passfilename");
1.91 albertel 5037: print $pf "none:\n";
5038: }
5039: } else {
5040: $result="auth_mode_error\n";
5041: }
5042: return $result;
1.121 albertel 5043: }
5044:
5045: sub sethost {
5046: my ($remotereq) = @_;
5047: my (undef,$hostid)=split(/:/,$remotereq);
5048: if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
5049: if ($hostip{$perlvar{'lonHostID'}} eq $hostip{$hostid}) {
1.200 matthew 5050: $currenthostid =$hostid;
1.121 albertel 5051: $currentdomainid=$hostdom{$hostid};
5052: &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
5053: } else {
5054: &logthis("Requested host id $hostid not an alias of ".
5055: $perlvar{'lonHostID'}." refusing connection");
5056: return 'unable_to_set';
5057: }
5058: return 'ok';
5059: }
5060:
5061: sub version {
5062: my ($userinput)=@_;
5063: $remoteVERSION=(split(/:/,$userinput))[1];
5064: return "version:$VERSION";
1.127 albertel 5065: }
1.178 foxr 5066:
1.128 albertel 5067: #There is a copy of this in lonnet.pm
1.127 albertel 5068: sub userload {
5069: my $numusers=0;
5070: {
5071: opendir(LONIDS,$perlvar{'lonIDsDir'});
5072: my $filename;
5073: my $curtime=time;
5074: while ($filename=readdir(LONIDS)) {
5075: if ($filename eq '.' || $filename eq '..') {next;}
1.138 albertel 5076: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.159 albertel 5077: if ($curtime-$mtime < 1800) { $numusers++; }
1.127 albertel 5078: }
5079: closedir(LONIDS);
5080: }
5081: my $userloadpercent=0;
5082: my $maxuserload=$perlvar{'lonUserLoadLim'};
5083: if ($maxuserload) {
1.129 albertel 5084: $userloadpercent=100*$numusers/$maxuserload;
1.127 albertel 5085: }
1.130 albertel 5086: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.127 albertel 5087: return $userloadpercent;
1.91 albertel 5088: }
5089:
1.205 raeburn 5090: # Routines for serializing arrays and hashes (copies from lonnet)
5091:
5092: sub array2str {
5093: my (@array) = @_;
5094: my $result=&arrayref2str(\@array);
5095: $result=~s/^__ARRAY_REF__//;
5096: $result=~s/__END_ARRAY_REF__$//;
5097: return $result;
5098: }
5099:
5100: sub arrayref2str {
5101: my ($arrayref) = @_;
5102: my $result='__ARRAY_REF__';
5103: foreach my $elem (@$arrayref) {
5104: if(ref($elem) eq 'ARRAY') {
5105: $result.=&arrayref2str($elem).'&';
5106: } elsif(ref($elem) eq 'HASH') {
5107: $result.=&hashref2str($elem).'&';
5108: } elsif(ref($elem)) {
5109: #print("Got a ref of ".(ref($elem))." skipping.");
5110: } else {
5111: $result.=&escape($elem).'&';
5112: }
5113: }
5114: $result=~s/\&$//;
5115: $result .= '__END_ARRAY_REF__';
5116: return $result;
5117: }
5118:
5119: sub hash2str {
5120: my (%hash) = @_;
5121: my $result=&hashref2str(\%hash);
5122: $result=~s/^__HASH_REF__//;
5123: $result=~s/__END_HASH_REF__$//;
5124: return $result;
5125: }
5126:
5127: sub hashref2str {
5128: my ($hashref)=@_;
5129: my $result='__HASH_REF__';
5130: foreach (sort(keys(%$hashref))) {
5131: if (ref($_) eq 'ARRAY') {
5132: $result.=&arrayref2str($_).'=';
5133: } elsif (ref($_) eq 'HASH') {
5134: $result.=&hashref2str($_).'=';
5135: } elsif (ref($_)) {
5136: $result.='=';
5137: #print("Got a ref of ".(ref($_))." skipping.");
5138: } else {
5139: if ($_) {$result.=&escape($_).'=';} else { last; }
5140: }
5141:
5142: if(ref($hashref->{$_}) eq 'ARRAY') {
5143: $result.=&arrayref2str($hashref->{$_}).'&';
5144: } elsif(ref($hashref->{$_}) eq 'HASH') {
5145: $result.=&hashref2str($hashref->{$_}).'&';
5146: } elsif(ref($hashref->{$_})) {
5147: $result.='&';
5148: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
5149: } else {
5150: $result.=&escape($hashref->{$_}).'&';
5151: }
5152: }
5153: $result=~s/\&$//;
5154: $result .= '__END_HASH_REF__';
5155: return $result;
5156: }
1.200 matthew 5157:
1.61 harris41 5158: # ----------------------------------- POD (plain old documentation, CPAN style)
5159:
5160: =head1 NAME
5161:
5162: lond - "LON Daemon" Server (port "LOND" 5663)
5163:
5164: =head1 SYNOPSIS
5165:
1.74 harris41 5166: Usage: B<lond>
5167:
5168: Should only be run as user=www. This is a command-line script which
5169: is invoked by B<loncron>. There is no expectation that a typical user
5170: will manually start B<lond> from the command-line. (In other words,
5171: DO NOT START B<lond> YOURSELF.)
1.61 harris41 5172:
5173: =head1 DESCRIPTION
5174:
1.74 harris41 5175: There are two characteristics associated with the running of B<lond>,
5176: PROCESS MANAGEMENT (starting, stopping, handling child processes)
5177: and SERVER-SIDE ACTIVITIES (password authentication, user creation,
5178: subscriptions, etc). These are described in two large
5179: sections below.
5180:
5181: B<PROCESS MANAGEMENT>
5182:
1.61 harris41 5183: Preforker - server who forks first. Runs as a daemon. HUPs.
5184: Uses IDEA encryption
5185:
1.74 harris41 5186: B<lond> forks off children processes that correspond to the other servers
5187: in the network. Management of these processes can be done at the
5188: parent process level or the child process level.
5189:
5190: B<logs/lond.log> is the location of log messages.
5191:
5192: The process management is now explained in terms of linux shell commands,
5193: subroutines internal to this code, and signal assignments:
5194:
5195: =over 4
5196:
5197: =item *
5198:
5199: PID is stored in B<logs/lond.pid>
5200:
5201: This is the process id number of the parent B<lond> process.
5202:
5203: =item *
5204:
5205: SIGTERM and SIGINT
5206:
5207: Parent signal assignment:
5208: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
5209:
5210: Child signal assignment:
5211: $SIG{INT} = 'DEFAULT'; (and SIGTERM is DEFAULT also)
5212: (The child dies and a SIGALRM is sent to parent, awaking parent from slumber
5213: to restart a new child.)
5214:
5215: Command-line invocations:
5216: B<kill> B<-s> SIGTERM I<PID>
5217: B<kill> B<-s> SIGINT I<PID>
5218:
5219: Subroutine B<HUNTSMAN>:
5220: This is only invoked for the B<lond> parent I<PID>.
5221: This kills all the children, and then the parent.
5222: The B<lonc.pid> file is cleared.
5223:
5224: =item *
5225:
5226: SIGHUP
5227:
5228: Current bug:
5229: This signal can only be processed the first time
5230: on the parent process. Subsequent SIGHUP signals
5231: have no effect.
5232:
5233: Parent signal assignment:
5234: $SIG{HUP} = \&HUPSMAN;
5235:
5236: Child signal assignment:
5237: none (nothing happens)
5238:
5239: Command-line invocations:
5240: B<kill> B<-s> SIGHUP I<PID>
5241:
5242: Subroutine B<HUPSMAN>:
5243: This is only invoked for the B<lond> parent I<PID>,
5244: This kills all the children, and then the parent.
5245: The B<lond.pid> file is cleared.
5246:
5247: =item *
5248:
5249: SIGUSR1
5250:
5251: Parent signal assignment:
5252: $SIG{USR1} = \&USRMAN;
5253:
5254: Child signal assignment:
5255: $SIG{USR1}= \&logstatus;
5256:
5257: Command-line invocations:
5258: B<kill> B<-s> SIGUSR1 I<PID>
5259:
5260: Subroutine B<USRMAN>:
5261: When invoked for the B<lond> parent I<PID>,
5262: SIGUSR1 is sent to all the children, and the status of
5263: each connection is logged.
1.144 foxr 5264:
5265: =item *
5266:
5267: SIGUSR2
5268:
5269: Parent Signal assignment:
5270: $SIG{USR2} = \&UpdateHosts
5271:
5272: Child signal assignment:
5273: NONE
5274:
1.74 harris41 5275:
5276: =item *
5277:
5278: SIGCHLD
5279:
5280: Parent signal assignment:
5281: $SIG{CHLD} = \&REAPER;
5282:
5283: Child signal assignment:
5284: none
5285:
5286: Command-line invocations:
5287: B<kill> B<-s> SIGCHLD I<PID>
5288:
5289: Subroutine B<REAPER>:
5290: This is only invoked for the B<lond> parent I<PID>.
5291: Information pertaining to the child is removed.
5292: The socket port is cleaned up.
5293:
5294: =back
5295:
5296: B<SERVER-SIDE ACTIVITIES>
5297:
5298: Server-side information can be accepted in an encrypted or non-encrypted
5299: method.
5300:
5301: =over 4
5302:
5303: =item ping
5304:
5305: Query a client in the hosts.tab table; "Are you there?"
5306:
5307: =item pong
5308:
5309: Respond to a ping query.
5310:
5311: =item ekey
5312:
5313: Read in encrypted key, make cipher. Respond with a buildkey.
5314:
5315: =item load
5316:
5317: Respond with CPU load based on a computation upon /proc/loadavg.
5318:
5319: =item currentauth
5320:
5321: Reply with current authentication information (only over an
5322: encrypted channel).
5323:
5324: =item auth
5325:
5326: Only over an encrypted channel, reply as to whether a user's
5327: authentication information can be validated.
5328:
5329: =item passwd
5330:
5331: Allow for a password to be set.
5332:
5333: =item makeuser
5334:
5335: Make a user.
5336:
5337: =item passwd
5338:
5339: Allow for authentication mechanism and password to be changed.
5340:
5341: =item home
1.61 harris41 5342:
1.74 harris41 5343: Respond to a question "are you the home for a given user?"
5344:
5345: =item update
5346:
5347: Update contents of a subscribed resource.
5348:
5349: =item unsubscribe
5350:
5351: The server is unsubscribing from a resource.
5352:
5353: =item subscribe
5354:
5355: The server is subscribing to a resource.
5356:
5357: =item log
5358:
5359: Place in B<logs/lond.log>
5360:
5361: =item put
5362:
5363: stores hash in namespace
5364:
1.230 foxr 5365: =item rolesputy
1.74 harris41 5366:
5367: put a role into a user's environment
5368:
5369: =item get
5370:
5371: returns hash with keys from array
5372: reference filled in from namespace
5373:
5374: =item eget
5375:
5376: returns hash with keys from array
5377: reference filled in from namesp (encrypts the return communication)
5378:
5379: =item rolesget
5380:
5381: get a role from a user's environment
5382:
5383: =item del
5384:
5385: deletes keys out of array from namespace
5386:
5387: =item keys
5388:
5389: returns namespace keys
5390:
5391: =item dump
5392:
5393: dumps the complete (or key matching regexp) namespace into a hash
5394:
5395: =item store
5396:
5397: stores hash permanently
5398: for this url; hashref needs to be given and should be a \%hashname; the
5399: remaining args aren't required and if they aren't passed or are '' they will
5400: be derived from the ENV
5401:
5402: =item restore
5403:
5404: returns a hash for a given url
5405:
5406: =item querysend
5407:
5408: Tells client about the lonsql process that has been launched in response
5409: to a sent query.
5410:
5411: =item queryreply
5412:
5413: Accept information from lonsql and make appropriate storage in temporary
5414: file space.
5415:
5416: =item idput
5417:
5418: Defines usernames as corresponding to IDs. (These "IDs" are unique identifiers
5419: for each student, defined perhaps by the institutional Registrar.)
5420:
5421: =item idget
5422:
5423: Returns usernames corresponding to IDs. (These "IDs" are unique identifiers
5424: for each student, defined perhaps by the institutional Registrar.)
5425:
5426: =item tmpput
5427:
5428: Accept and store information in temporary space.
5429:
5430: =item tmpget
5431:
5432: Send along temporarily stored information.
5433:
5434: =item ls
5435:
5436: List part of a user's directory.
5437:
1.135 foxr 5438: =item pushtable
5439:
5440: Pushes a file in /home/httpd/lonTab directory. Currently limited to:
5441: hosts.tab and domain.tab. The old file is copied to *.tab.backup but
5442: must be restored manually in case of a problem with the new table file.
5443: pushtable requires that the request be encrypted and validated via
5444: ValidateManager. The form of the command is:
5445: enc:pushtable tablename <tablecontents> \n
5446: where pushtable, tablename and <tablecontents> will be encrypted, but \n is a
5447: cleartext newline.
5448:
1.74 harris41 5449: =item Hanging up (exit or init)
5450:
5451: What to do when a client tells the server that they (the client)
5452: are leaving the network.
5453:
5454: =item unknown command
5455:
5456: If B<lond> is sent an unknown command (not in the list above),
5457: it replys to the client "unknown_cmd".
1.135 foxr 5458:
1.74 harris41 5459:
5460: =item UNKNOWN CLIENT
5461:
5462: If the anti-spoofing algorithm cannot verify the client,
5463: the client is rejected (with a "refused" message sent
5464: to the client, and the connection is closed.
5465:
5466: =back
1.61 harris41 5467:
5468: =head1 PREREQUISITES
5469:
5470: IO::Socket
5471: IO::File
5472: Apache::File
5473: Symbol
5474: POSIX
5475: Crypt::IDEA
5476: LWP::UserAgent()
5477: GDBM_File
5478: Authen::Krb4
1.91 albertel 5479: Authen::Krb5
1.61 harris41 5480:
5481: =head1 COREQUISITES
5482:
5483: =head1 OSNAMES
5484:
5485: linux
5486:
5487: =head1 SCRIPT CATEGORIES
5488:
5489: Server/Process
5490:
5491: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lond CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom