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