Annotation of loncom/lond, revision 1.178.2.19
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.19! foxr 5: # $Id: lond,v 1.178.2.18 2004/04/19 11:32:35 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.19! foxr 56: my $VERSION='$Revision: 1.178.2.18 $'; #' 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:
1.178.2.19! foxr 1413: my ( $exedom, $exeuser, $udom, $uname, $what) = split(/:/,$tail);
! 1414:
! 1415:
1.178.2.4 albertel 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.17 foxr 2224: logthis(" Looking for $description since $since");
1.178.2.9 foxr 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);
1.178.2.17 foxr 2229: logthis("Got: key = $key descr = $descr time: $lasttime");
1.178.2.4 albertel 2230: if ($lasttime<$since) {
1.178.2.17 foxr 2231: logthis("Skipping .. too early");
1.178.2.4 albertel 2232: next;
2233: }
2234: if ($description eq '.') {
1.178.2.17 foxr 2235: logthis("Adding wildcard match");
1.178.2.4 albertel 2236: $qresult.=$key.'='.$descr.'&';
2237: } else {
2238: my $unescapeVal = &unescape($descr);
1.178.2.17 foxr 2239: logthis("Matching with $unescapeVal");
1.178.2.4 albertel 2240: if (eval('$unescapeVal=~/$description/i')) {
1.178.2.17 foxr 2241: logthis("Adding on match");
1.178.2.4 albertel 2242: $qresult.="$key=$descr&";
2243: }
2244: }
2245: }
1.178.2.9 foxr 2246: if (untie(%$hashref)) {
1.178.2.4 albertel 2247: chop($qresult);
2248: Reply($client, "$qresult\n", $userinput);
2249: } else {
2250: Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2251: "while attempting courseiddump\n", $userinput);
2252: }
2253: } else {
2254: Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2255: "while attempting courseiddump\n", $userinput);
2256: }
1.178.2.1 foxr 2257:
2258:
1.178.2.4 albertel 2259: return 1;
1.178.2.1 foxr 2260: }
2261: RegisterHandler("courseiddump", \&DumpCourseIdHandler, 0, 1, 0);
2262: #
2263: # Puts an id to a domains id database.
2264: #
2265: # Parameters:
2266: # $cmd - The command that triggered us.
2267: # $tail - Remainder of the request other than the command. This is a
2268: # colon separated list containing:
2269: # $domain - The domain for which we are writing the id.
2270: # $pairs - The id info to write... this is and & separated list
2271: # of keyword=value.
2272: # $client - Socket open on the client.
2273: # Returns:
2274: # 1 - Continue processing.
2275: # Side effects:
2276: # reply is written to $client.
2277: #
2278: sub PutIdHandler {
1.178.2.4 albertel 2279: my $cmd = shift;
2280: my $tail = shift;
2281: my $client = shift;
2282:
2283: my $userinput = "$cmd:$tail";
2284:
2285: my ($udom,$what)=split(/:/,$tail);
2286: chomp($what);
2287: my @pairs=split(/\&/,$what);
1.178.2.9 foxr 2288: my $hashref = TieDomainHash($udom, "ids", &GDBM_WRCREAT(),
2289: "P", $what);
2290: if ($hashref) {
1.178.2.4 albertel 2291: foreach my $pair (@pairs) {
2292: my ($key,$value)=split(/=/,$pair);
1.178.2.9 foxr 2293: $hashref->{$key}=$value;
1.178.2.4 albertel 2294: }
1.178.2.9 foxr 2295: if (untie(%$hashref)) {
1.178.2.4 albertel 2296: Reply($client, "ok\n", $userinput);
2297: } else {
2298: Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2299: "while attempting idput\n", $userinput);
2300: }
2301: } else {
2302: Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2303: "while attempting idput\n", $userinput);
1.178.2.1 foxr 2304: }
2305:
1.178.2.4 albertel 2306: return 1;
1.178.2.1 foxr 2307: }
2308:
2309: RegisterHandler("idput", \&PutIdHandler, 0, 1, 0);
2310: #
2311: # Retrieves a set of id values from the id database.
2312: # Returns an & separated list of results, one for each requested id to the
2313: # client.
2314: #
2315: # Parameters:
2316: # $cmd - Command keyword that caused us to be dispatched.
2317: # $tail - Tail of the command. Consists of a colon separated:
2318: # domain - the domain whose id table we dump
2319: # ids Consists of an & separated list of
2320: # id keywords whose values will be fetched.
2321: # nonexisting keywords will have an empty value.
2322: # $client - Socket open on the client.
2323: #
2324: # Returns:
2325: # 1 - indicating processing should continue.
2326: # Side effects:
2327: # An & separated list of results is written to $client.
2328: #
2329: sub GetIdHandler {
1.178.2.4 albertel 2330: my $cmd = shift;
2331: my $tail = shift;
2332: my $client = shift;
1.178.2.10 foxr 2333:
1.178.2.4 albertel 2334: my $userinput = "$client:$tail";
1.178.2.10 foxr 2335:
1.178.2.4 albertel 2336: my ($udom,$what)=split(/:/,$tail);
2337: chomp($what);
2338: my @queries=split(/\&/,$what);
2339: my $qresult='';
1.178.2.9 foxr 2340: my $hashref = TieDomainHash($udom, "ids", &GDBM_READER());
2341: if ($hashref) {
1.178.2.4 albertel 2342: for (my $i=0;$i<=$#queries;$i++) {
1.178.2.9 foxr 2343: $qresult.="$hashref->{$queries[$i]}&";
1.178.2.4 albertel 2344: }
1.178.2.9 foxr 2345: if (untie(%$hashref)) {
1.178.2.4 albertel 2346: $qresult=~s/\&$//;
2347: Reply($client, "$qresult\n", $userinput);
2348: } else {
2349: Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2350: "while attempting idget\n",$userinput);
2351: }
2352: } else {
2353: Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2354: "while attempting idget\n",$userinput);
2355: }
1.178.2.10 foxr 2356:
1.178.2.4 albertel 2357: return 1;
1.178.2.1 foxr 2358: }
1.178.2.3 foxr 2359:
1.178.2.1 foxr 2360: RegisterHandler("idget", \&GetIdHandler, 0, 1, 0);
1.178.2.3 foxr 2361: #
2362: # Process the tmpput command I'm not sure what this does.. Seems to
2363: # create a file in the lonDaemons/tmp directory of the form $id.tmp
2364: # where Id is the client's ip concatenated with a sequence number.
2365: # The file will contain some value that is passed in. Is this e.g.
2366: # a login token?
2367: #
2368: # Parameters:
2369: # $cmd - The command that got us dispatched.
2370: # $tail - The remainder of the request following $cmd:
2371: # In this case this will be the contents of the file.
2372: # $client - Socket connected to the client.
2373: # Returns:
2374: # 1 indicating processing can continue.
2375: # Side effects:
2376: # A file is created in the local filesystem.
2377: # A reply is sent to the client.
2378: sub TmpPutHandler {
1.178.2.4 albertel 2379: my $cmd = shift;
2380: my $what = shift;
2381: my $client = shift;
2382:
2383: my $userinput = "$cmd:$what"; # Reconstruct for logging.
2384:
2385:
2386: my $store;
2387: $tmpsnum++;
1.178.2.18 foxr 2388: my $id=$$.'_'.$clientip.'_'.$tmpsnum;
1.178.2.4 albertel 2389: $id=~s/\W/\_/g;
2390: $what=~s/\n//g;
2391: my $execdir=$perlvar{'lonDaemons'};
2392: if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
2393: print $store $what;
2394: close $store;
2395: Reply($client, "$id\n", $userinput);
2396: } else {
2397: Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
2398: "while attempting tmpput\n", $userinput);
2399: }
2400: return 1;
1.178.2.3 foxr 2401:
2402: }
2403: RegisterHandler("tmpput", \&TmpPutHandler, 0, 1, 0);
2404:
2405: # Processes the tmpget command. This command returns the contents
2406: # of a temporary resource file(?) created via tmpput.
2407: #
2408: # Paramters:
2409: # $cmd - Command that got us dispatched.
2410: # $id - Tail of the command, contain the id of the resource
2411: # we want to fetch.
2412: # $client - socket open on the client.
2413: # Return:
2414: # 1 - Inidcating processing can continue.
2415: # Side effects:
2416: # A reply is sent to the client.
2417:
2418: #
2419: sub TmpGetHandler {
1.178.2.4 albertel 2420: my $cmd = shift;
2421: my $id = shift;
2422: my $client = shift;
2423: my $userinput = "$cmd:$id";
1.178.2.10 foxr 2424:
1.178.2.4 albertel 2425: chomp($id);
2426: $id=~s/\W/\_/g;
2427: my $store;
2428: my $execdir=$perlvar{'lonDaemons'};
2429: if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
2430: my $reply=<$store>;
2431: Reply( $client, "$reply\n", $userinput);
2432: close $store;
2433: } else {
2434: Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
2435: "while attempting tmpget\n", $userinput);
2436: }
1.178.2.3 foxr 2437:
1.178.2.4 albertel 2438: return 1;
1.178.2.3 foxr 2439: }
2440: RegisterHandler("tmpget", \&TmpGetHandler, 0, 1, 0);
2441: #
2442: # Process the tmpdel command. This command deletes a temp resource
2443: # created by the tmpput command.
2444: #
2445: # Parameters:
2446: # $cmd - Command that got us here.
2447: # $id - Id of the temporary resource created.
2448: # $client - socket open on the client process.
2449: #
2450: # Returns:
2451: # 1 - Indicating processing should continue.
2452: # Side Effects:
2453: # A file is deleted
2454: # A reply is sent to the client.
2455: sub TmpDelHandler {
1.178.2.4 albertel 2456: my $cmd = shift;
2457: my $id = shift;
2458: my $client = shift;
1.178.2.10 foxr 2459:
1.178.2.4 albertel 2460: my $userinput= "$cmd:$id";
1.178.2.10 foxr 2461:
1.178.2.4 albertel 2462: chomp($id);
2463: $id=~s/\W/\_/g;
2464: my $execdir=$perlvar{'lonDaemons'};
2465: if (unlink("$execdir/tmp/$id.tmp")) {
2466: Reply($client, "ok\n", $userinput);
2467: } else {
2468: Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
2469: "while attempting tmpdel\n", $userinput);
2470: }
1.178.2.10 foxr 2471:
1.178.2.4 albertel 2472: return 1;
1.178.2.3 foxr 2473:
2474: }
2475: RegisterHandler("tmpdel", \&TmpDelHandler, 0, 1, 0);
2476: #
2477: # ls - list the contents of a directory. For each file in the
2478: # selected directory the filename followed by the full output of
2479: # the stat function is returned. The returned info for each
2480: # file are separated by ':'. The stat fields are separated by &'s.
2481: # Parameters:
2482: # $cmd - The command that dispatched us (ls).
2483: # $ulsdir - The directory path to list... I'm not sure what this
2484: # is relative as things like ls:. return e.g.
2485: # no_such_dir.
2486: # $client - Socket open on the client.
2487: # Returns:
2488: # 1 - indicating that the daemon should not disconnect.
2489: # Side Effects:
2490: # The reply is written to $client.
2491: #
2492: sub LsHandler {
1.178.2.4 albertel 2493: my $cmd = shift;
2494: my $ulsdir = shift;
2495: my $client = shift;
1.178.2.3 foxr 2496:
1.178.2.4 albertel 2497: my $userinput = "$cmd:$ulsdir";
1.178.2.3 foxr 2498:
1.178.2.19! foxr 2499: chomp($ulsdir);
! 2500:
1.178.2.4 albertel 2501: my $ulsout='';
2502: my $ulsfn;
1.178.2.19! foxr 2503: logthis("ls for '$ulsdir'");
1.178.2.4 albertel 2504: if (-e $ulsdir) {
1.178.2.19! foxr 2505: logthis("ls - directory exists");
1.178.2.4 albertel 2506: if(-d $ulsdir) {
1.178.2.19! foxr 2507: logthis("ls $ulsdir is a file");
1.178.2.4 albertel 2508: if (opendir(LSDIR,$ulsdir)) {
2509: while ($ulsfn=readdir(LSDIR)) {
2510: my @ulsstats=stat($ulsdir.'/'.$ulsfn);
2511: $ulsout.=$ulsfn.'&'.
2512: join('&',@ulsstats).':';
2513: }
2514: closedir(LSDIR);
2515: }
2516: } else {
2517: my @ulsstats=stat($ulsdir);
2518: $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
2519: }
2520: } else {
2521: $ulsout='no_such_dir';
2522: }
2523: if ($ulsout eq '') { $ulsout='empty'; }
2524: Reply($client, "$ulsout\n", $userinput);
2525:
2526:
2527: return 1;
1.178.2.3 foxr 2528: }
2529: RegisterHandler("ls", \&LsHandler, 0, 1, 0);
2530:
2531:
2532: #
2533: # Processes the setannounce command. This command
2534: # creates a file named announce.txt in the top directory of
2535: # the documentn root and sets its contents. The announce.txt file is
2536: # printed in its entirety at the LonCAPA login page. Note:
2537: # once the announcement.txt fileis created it cannot be deleted.
2538: # However, setting the contents of the file to empty removes the
2539: # announcement from the login page of loncapa so who cares.
2540: #
2541: # Parameters:
2542: # $cmd - The command that got us dispatched.
2543: # $announcement - The text of the announcement.
2544: # $client - Socket open on the client process.
2545: # Retunrns:
2546: # 1 - Indicating request processing should continue
2547: # Side Effects:
2548: # The file {DocRoot}/announcement.txt is created.
2549: # A reply is sent to $client.
2550: #
2551: sub SetAnnounceHandler {
1.178.2.4 albertel 2552: my $cmd = shift;
2553: my $announcement = shift;
2554: my $client = shift;
1.178.2.3 foxr 2555:
1.178.2.4 albertel 2556: my $userinput = "$cmd:$announcement";
1.178.2.3 foxr 2557:
1.178.2.4 albertel 2558: chomp($announcement);
2559: $announcement=&unescape($announcement);
2560: if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
2561: '/announcement.txt')) {
2562: print $store $announcement;
2563: close $store;
2564: Reply($client, "ok\n", $userinput);
2565: } else {
2566: Failure($client, "error: ".($!+0)."\n", $userinput);
2567: }
1.178.2.3 foxr 2568:
1.178.2.4 albertel 2569: return 1;
1.178.2.3 foxr 2570: }
2571: RegisterHandler("setannounce", \&SetAnnounceHandler, 0, 1, 0);
2572:
2573: #
2574: # Return the version of the daemon. This can be used to determine
2575: # the compatibility of cross version installations or, alternatively to
2576: # simply know who's out of date and who isn't. Note that the version
2577: # is returned concatenated with the tail.
2578: # Parameters:
2579: # $cmd - the request that dispatched to us.
2580: # $tail - Tail of the request (client's version?).
2581: # $client - Socket open on the client.
2582: #Returns:
2583: # 1 - continue processing requests.
2584: # Side Effects:
2585: # Replies with version to $client.
2586: sub GetVersionHandler {
1.178.2.4 albertel 2587: my $client = shift;
2588: my $tail = shift;
2589: my $client = shift;
2590: my $userinput = $client;
2591:
2592: Reply($client, &version($userinput)."\n", $userinput);
1.178.2.3 foxr 2593:
2594:
1.178.2.4 albertel 2595: return 1;
1.178.2.3 foxr 2596: }
2597: RegisterHandler("version", \&GetVersionHandler, 0, 1, 0);
2598:
2599: # Set the current host and domain. This is used to support
2600: # multihomed systems. Each IP of the system, or even separate daemons
2601: # on the same IP can be treated as handling a separate lonCAPA virtual
2602: # machine. This command selects the virtual lonCAPA. The client always
2603: # knows the right one since it is lonc and it is selecting the domain/system
2604: # from the hosts.tab file.
2605: # Parameters:
2606: # $cmd - Command that dispatched us.
2607: # $tail - Tail of the command (domain/host requested).
2608: # $socket - Socket open on the client.
2609: #
2610: # Returns:
2611: # 1 - Indicates the program should continue to process requests.
2612: # Side-effects:
2613: # The default domain/system context is modified for this daemon.
2614: # a reply is sent to the client.
2615: #
2616: sub SelectHostHandler {
1.178.2.4 albertel 2617: my $cmd = shift;
2618: my $tail = shift;
2619: my $socket = shift;
1.178.2.3 foxr 2620:
1.178.2.4 albertel 2621: my $userinput ="$cmd:$tail";
1.178.2.3 foxr 2622:
1.178.2.4 albertel 2623: Reply($client, &sethost($userinput)."\n", $userinput);
1.178.2.3 foxr 2624:
2625:
1.178.2.4 albertel 2626: return 1;
1.178.2.3 foxr 2627: }
2628: RegisterHandler("sethost", \&SelectHostHandler, 0, 1, 0);
2629:
2630: # Process a request to exit:
2631: # - "bye" is sent to the client.
2632: # - The client socket is shutdown and closed.
2633: # - We indicate to the caller that we should exit.
2634: # Formal Parameters:
2635: # $cmd - The command that got us here.
2636: # $tail - Tail of the command (empty).
2637: # $client - Socket open on the tail.
2638: # Returns:
2639: # 0 - Indicating the program should exit!!
2640: #
2641: sub ExitHandler {
1.178.2.4 albertel 2642: my $cmd = shift;
2643: my $tail = shift;
2644: my $client = shift;
2645:
2646: my $userinput = "$cmd:$tail";
2647:
2648: &logthis("Client $clientip ($clientname) hanging up: $userinput");
2649: Reply($client, "bye\n", $userinput);
2650: $client->shutdown(2); # shutdown the socket forcibly.
2651: $client->close();
1.178.2.3 foxr 2652:
1.178.2.4 albertel 2653: return 0;
1.178.2.3 foxr 2654: }
2655: RegisterHandler("exit", \&ExitHandler, 0, 1,1);
2656: RegisterHandler("init", \&ExitHandler, 0, 1,1); # RE-init is like exit.
2657: RegisterHandler("quit", \&ExitHandler, 0, 1,1); # I like this too!
1.178.2.1 foxr 2658: #------------------------------------------------------------------------------------
2659: #
2660: # Process a Request. Takes a request from the client validates
2661: # it and performs the operation requested by it. Returns
2662: # a response to the client.
2663: #
2664: # Parameters:
2665: # request - A string containing the user's request.
2666: # Returns:
2667: # 0 - Requested to exit, caller should shut down.
2668: # 1 - Accept additional requests from the client.
2669: #
2670: sub ProcessRequest {
1.178.2.4 albertel 2671: my $Request = shift;
2672: my $KeepGoing = 1; # Assume we're not asked to stop.
1.178.2.1 foxr 2673:
1.178.2.4 albertel 2674: my $wasenc=0;
2675: my $userinput = $Request; # for compatibility with oldcode <yeach>
1.178.2.1 foxr 2676:
2677:
2678: # ------------------------------------------------------------ See if encrypted
2679:
1.178.2.4 albertel 2680: if($userinput =~ /^enc/) {
2681: $wasenc = 1;
2682: $userinput = Decipher($userinput);
2683: if(! $userinput) {
2684: Failure($client,"error:Encrypted data without negotiating key");
2685: return 0; # Break off with this imposter.
2686: }
2687: }
2688: # Split off the request keyword from the rest of the stuff.
1.178.2.1 foxr 2689:
1.178.2.4 albertel 2690: my ($command, $tail) = split(/:/, $userinput, 2);
1.178.2.19! foxr 2691: chomp($command);
! 2692: chomp($tail);
1.178.2.2 foxr 2693:
1.178.2.4 albertel 2694: Debug("Command received: $command, encoded = $wasenc");
1.178.2.2 foxr 2695:
1.178.2.1 foxr 2696:
2697: # ------------------------------------------------------------- Normal commands
2698:
1.178.2.4 albertel 2699: #
2700: # If the command is in the hash, then execute it via the hash dispatch:
2701: #
2702: if(defined $Dispatcher{$command}) {
2703:
2704: my $DispatchInfo = $Dispatcher{$command};
2705: my $Handler = $$DispatchInfo[0];
2706: my $NeedEncode = $$DispatchInfo[1];
2707: my $ClientTypes = $$DispatchInfo[2];
2708: Debug("Matched dispatch hash: mustencode: $NeedEncode ClientType $ClientTypes");
1.178.2.1 foxr 2709:
1.178.2.4 albertel 2710: # Validate the request:
1.178.2.1 foxr 2711:
1.178.2.4 albertel 2712: my $ok = 1;
2713: my $requesterprivs = 0;
2714: if(isClient()) {
2715: $requesterprivs |= $CLIENT_OK;
2716: }
2717: if(isManager()) {
2718: $requesterprivs |= $MANAGER_OK;
2719: }
2720: if($NeedEncode && (!$wasenc)) {
2721: Debug("Must encode but wasn't: $NeedEncode $wasenc");
2722: $ok = 0;
2723: }
2724: if(($ClientTypes & $requesterprivs) == 0) {
2725: Debug("Client not privileged to do this operation");
2726: $ok = 0;
2727: }
2728:
2729: if($ok) {
2730: Debug("Dispatching to handler $command $tail");
2731: $KeepGoing = &$Handler($command, $tail, $client);
2732: } else {
2733: Debug("Refusing to dispatch because ok is false");
1.178.2.19! foxr 2734: Failure($client, "refused\n", $userinput);
1.178.2.4 albertel 2735: }
1.161 foxr 2736:
2737:
1.178.2.1 foxr 2738: # ------------------------------------------------------------- unknown command
1.97 foxr 2739:
1.178.2.4 albertel 2740: } else {
1.178.2.1 foxr 2741: # unknown command
1.178.2.4 albertel 2742: Failure($client, "unknown_cmd\n", $userinput);
2743: }
1.97 foxr 2744:
1.178.2.1 foxr 2745: return $KeepGoing;
2746: }
1.97 foxr 2747:
1.96 foxr 2748:
2749: #
1.140 foxr 2750: # GetCertificate: Given a transaction that requires a certificate,
2751: # this function will extract the certificate from the transaction
2752: # request. Note that at this point, the only concept of a certificate
2753: # is the hostname to which we are connected.
2754: #
2755: # Parameter:
2756: # request - The request sent by our client (this parameterization may
2757: # need to change when we really use a certificate granting
2758: # authority.
2759: #
2760: sub GetCertificate {
2761: my $request = shift;
2762:
2763: return $clientip;
2764: }
1.161 foxr 2765:
2766:
2767:
1.156 foxr 2768: #
2769: # ReadManagerTable: Reads in the current manager table. For now this is
2770: # done on each manager authentication because:
2771: # - These authentications are not frequent
2772: # - This allows dynamic changes to the manager table
2773: # without the need to signal to the lond.
2774: #
2775:
2776: sub ReadManagerTable {
2777:
2778: # Clean out the old table first..
2779:
1.178.2.4 albertel 2780: foreach my $key (keys %managers) {
2781: delete $managers{$key};
2782: }
2783:
2784: my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
2785: if (!open (MANAGERS, $tablename)) {
2786: logthis('<font color="red">No manager table. Nobody can manage!!</font>');
2787: return;
2788: }
2789: while(my $host = <MANAGERS>) {
2790: chomp($host);
2791: if ($host =~ "^#") { # Comment line.
2792: logthis('<font color="green"> Skipping line: '. "$host</font>\n");
2793: next;
2794: }
2795: if (!defined $hostip{$host}) { # This is a non cluster member
1.161 foxr 2796: # The entry is of the form:
2797: # cluname:hostname
2798: # cluname - A 'cluster hostname' is needed in order to negotiate
2799: # the host key.
2800: # hostname- The dns name of the host.
2801: #
1.178.2.4 albertel 2802: my($cluname, $dnsname) = split(/:/, $host);
2803:
2804: my $ip = gethostbyname($dnsname);
2805: if(defined($ip)) { # bad names don't deserve entry.
2806: my $hostip = inet_ntoa($ip);
2807: $managers{$hostip} = $cluname;
2808: logthis('<font color="green"> registering manager '.
2809: "$dnsname as $cluname with $hostip </font>\n");
2810: }
2811: } else {
2812: logthis('<font color="green"> existing host'." $host</font>\n");
2813: $managers{$hostip{$host}} = $host; # Use info from cluster tab if clumemeber
2814: }
2815: }
1.156 foxr 2816: }
1.140 foxr 2817:
2818: #
2819: # ValidManager: Determines if a given certificate represents a valid manager.
2820: # in this primitive implementation, the 'certificate' is
2821: # just the connecting loncapa client name. This is checked
2822: # against a valid client list in the configuration.
2823: #
2824: #
2825: sub ValidManager {
2826: my $certificate = shift;
2827:
1.163 foxr 2828: return isManager;
1.140 foxr 2829: }
2830: #
1.143 foxr 2831: # CopyFile: Called as part of the process of installing a
2832: # new configuration file. This function copies an existing
2833: # file to a backup file.
2834: # Parameters:
2835: # oldfile - Name of the file to backup.
2836: # newfile - Name of the backup file.
2837: # Return:
2838: # 0 - Failure (errno has failure reason).
2839: # 1 - Success.
2840: #
2841: sub CopyFile {
2842: my $oldfile = shift;
2843: my $newfile = shift;
2844:
2845: # The file must exist:
2846:
2847: if(-e $oldfile) {
2848:
1.178.2.4 albertel 2849: # Read the old file.
1.143 foxr 2850:
2851: my $oldfh = IO::File->new("< $oldfile");
2852: if(!$oldfh) {
2853: return 0;
2854: }
2855: my @contents = <$oldfh>; # Suck in the entire file.
2856:
2857: # write the backup file:
2858:
2859: my $newfh = IO::File->new("> $newfile");
2860: if(!(defined $newfh)){
2861: return 0;
2862: }
2863: my $lines = scalar @contents;
2864: for (my $i =0; $i < $lines; $i++) {
2865: print $newfh ($contents[$i]);
2866: }
2867:
2868: $oldfh->close;
2869: $newfh->close;
2870:
2871: chmod(0660, $newfile);
2872:
2873: return 1;
2874:
2875: } else {
2876: return 0;
2877: }
2878: }
1.157 foxr 2879: #
2880: # Host files are passed out with externally visible host IPs.
2881: # If, for example, we are behind a fire-wall or NAT host, our
2882: # internally visible IP may be different than the externally
2883: # visible IP. Therefore, we always adjust the contents of the
2884: # host file so that the entry for ME is the IP that we believe
2885: # we have. At present, this is defined as the entry that
2886: # DNS has for us. If by some chance we are not able to get a
2887: # DNS translation for us, then we assume that the host.tab file
2888: # is correct.
2889: # BUGBUGBUG - in the future, we really should see if we can
2890: # easily query the interface(s) instead.
2891: # Parameter(s):
2892: # contents - The contents of the host.tab to check.
2893: # Returns:
2894: # newcontents - The adjusted contents.
2895: #
2896: #
2897: sub AdjustHostContents {
2898: my $contents = shift;
2899: my $adjusted;
2900: my $me = $perlvar{'lonHostID'};
2901:
1.178.2.4 albertel 2902: foreach my $line (split(/\n/,$contents)) {
1.157 foxr 2903: if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {
2904: chomp($line);
2905: my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
2906: if ($id eq $me) {
1.178.2.4 albertel 2907: my $ip = gethostbyname($name);
2908: my $ipnew = inet_ntoa($ip);
2909: $ip = $ipnew;
1.157 foxr 2910: # Reconstruct the host line and append to adjusted:
2911:
1.178.2.4 albertel 2912: my $newline = "$id:$domain:$role:$name:$ip";
2913: if($maxcon ne "") { # Not all hosts have loncnew tuning params
2914: $newline .= ":$maxcon:$idleto:$mincon";
2915: }
2916: $adjusted .= $newline."\n";
1.157 foxr 2917:
1.178.2.4 albertel 2918: } else { # Not me, pass unmodified.
2919: $adjusted .= $line."\n";
2920: }
1.157 foxr 2921: } else { # Blank or comment never re-written.
2922: $adjusted .= $line."\n"; # Pass blanks and comments as is.
2923: }
1.178.2.4 albertel 2924: }
2925: return $adjusted;
1.157 foxr 2926: }
1.143 foxr 2927: #
2928: # InstallFile: Called to install an administrative file:
2929: # - The file is created with <name>.tmp
2930: # - The <name>.tmp file is then mv'd to <name>
2931: # This lugubrious procedure is done to ensure that we are never without
2932: # a valid, even if dated, version of the file regardless of who crashes
2933: # and when the crash occurs.
2934: #
2935: # Parameters:
2936: # Name of the file
2937: # File Contents.
2938: # Return:
2939: # nonzero - success.
2940: # 0 - failure and $! has an errno.
2941: #
2942: sub InstallFile {
2943: my $Filename = shift;
2944: my $Contents = shift;
2945: my $TempFile = $Filename.".tmp";
2946:
2947: # Open the file for write:
1.178.2.4 albertel 2948:
1.143 foxr 2949: my $fh = IO::File->new("> $TempFile"); # Write to temp.
2950: if(!(defined $fh)) {
2951: &logthis('<font color="red"> Unable to create '.$TempFile."</font>");
2952: return 0;
2953: }
2954: # write the contents of the file:
1.178.2.4 albertel 2955:
1.143 foxr 2956: print $fh ($Contents);
2957: $fh->close; # In case we ever have a filesystem w. locking
2958:
2959: chmod(0660, $TempFile);
2960:
2961: # Now we can move install the file in position.
2962:
2963: move($TempFile, $Filename);
2964:
2965: return 1;
2966: }
1.169 foxr 2967: #
2968: # ConfigFileFromSelector: converts a configuration file selector
2969: # (one of host or domain at this point) into a
2970: # configuration file pathname.
2971: #
2972: # Parameters:
2973: # selector - Configuration file selector.
2974: # Returns:
2975: # Full path to the file or undef if the selector is invalid.
2976: #
2977: sub ConfigFileFromSelector {
2978: my $selector = shift;
2979: my $tablefile;
2980:
2981: my $tabledir = $perlvar{'lonTabDir'}.'/';
2982: if ($selector eq "hosts") {
2983: $tablefile = $tabledir."hosts.tab";
2984: } elsif ($selector eq "domain") {
2985: $tablefile = $tabledir."domain.tab";
2986: } else {
2987: return undef;
2988: }
2989: return $tablefile;
1.143 foxr 2990:
1.169 foxr 2991: }
1.143 foxr 2992: #
1.141 foxr 2993: # PushFile: Called to do an administrative push of a file.
2994: # - Ensure the file being pushed is one we support.
2995: # - Backup the old file to <filename.saved>
2996: # - Separate the contents of the new file out from the
2997: # rest of the request.
2998: # - Write the new file.
2999: # Parameter:
3000: # Request - The entire user request. This consists of a : separated
3001: # string pushfile:tablename:contents.
3002: # NOTE: The contents may have :'s in it as well making things a bit
3003: # more interesting... but not much.
3004: # Returns:
3005: # String to send to client ("ok" or "refused" if bad file).
3006: #
3007: sub PushFile {
3008: my $request = shift;
3009: my ($command, $filename, $contents) = split(":", $request, 3);
3010:
3011: # At this point in time, pushes for only the following tables are
3012: # supported:
3013: # hosts.tab ($filename eq host).
3014: # domain.tab ($filename eq domain).
3015: # Construct the destination filename or reject the request.
3016: #
3017: # lonManage is supposed to ensure this, however this session could be
3018: # part of some elaborate spoof that managed somehow to authenticate.
3019: #
3020:
1.169 foxr 3021:
3022: my $tablefile = ConfigFileFromSelector($filename);
3023: if(! (defined $tablefile)) {
1.141 foxr 3024: return "refused";
3025: }
3026: #
3027: # >copy< the old table to the backup table
3028: # don't rename in case system crashes/reboots etc. in the time
3029: # window between a rename and write.
3030: #
3031: my $backupfile = $tablefile;
3032: $backupfile =~ s/\.tab$/.old/;
1.143 foxr 3033: if(!CopyFile($tablefile, $backupfile)) {
3034: &logthis('<font color="green"> CopyFile from '.$tablefile." to ".$backupfile." failed </font>");
3035: return "error:$!";
3036: }
1.141 foxr 3037: &logthis('<font color="green"> Pushfile: backed up '
1.178.2.4 albertel 3038: .$tablefile." to $backupfile</font>");
1.141 foxr 3039:
1.157 foxr 3040: # If the file being pushed is the host file, we adjust the entry for ourself so that the
3041: # IP will be our current IP as looked up in dns. Note this is only 99% good as it's possible
3042: # to conceive of conditions where we don't have a DNS entry locally. This is possible in a
3043: # network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
3044: # that possibilty.
3045:
3046: if($filename eq "host") {
3047: $contents = AdjustHostContents($contents);
3048: }
3049:
1.141 foxr 3050: # Install the new file:
3051:
1.143 foxr 3052: if(!InstallFile($tablefile, $contents)) {
3053: &logthis('<font color="red"> Pushfile: unable to install '
1.178.2.4 albertel 3054: .$tablefile." $! </font>");
1.143 foxr 3055: return "error:$!";
1.178.2.4 albertel 3056: } else {
1.143 foxr 3057: &logthis('<font color="green"> Installed new '.$tablefile
3058: ."</font>");
1.178.2.4 albertel 3059:
1.143 foxr 3060: }
3061:
1.141 foxr 3062:
3063: # Indicate success:
3064:
3065: return "ok";
3066:
3067: }
1.145 foxr 3068:
3069: #
3070: # Called to re-init either lonc or lond.
3071: #
3072: # Parameters:
3073: # request - The full request by the client. This is of the form
3074: # reinit:<process>
3075: # where <process> is allowed to be either of
3076: # lonc or lond
3077: #
3078: # Returns:
3079: # The string to be sent back to the client either:
3080: # ok - Everything worked just fine.
3081: # error:why - There was a failure and why describes the reason.
3082: #
3083: #
3084: sub ReinitProcess {
3085: my $request = shift;
3086:
1.146 foxr 3087:
3088: # separate the request (reinit) from the process identifier and
3089: # validate it producing the name of the .pid file for the process.
3090: #
3091: #
3092: my ($junk, $process) = split(":", $request);
1.147 foxr 3093: my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
1.146 foxr 3094: if($process eq 'lonc') {
3095: $processpidfile = $processpidfile."lonc.pid";
1.147 foxr 3096: if (!open(PIDFILE, "< $processpidfile")) {
3097: return "error:Open failed for $processpidfile";
3098: }
3099: my $loncpid = <PIDFILE>;
3100: close(PIDFILE);
3101: logthis('<font color="red"> Reinitializing lonc pid='.$loncpid
3102: ."</font>");
3103: kill("USR2", $loncpid);
1.146 foxr 3104: } elsif ($process eq 'lond') {
1.147 foxr 3105: logthis('<font color="red"> Reinitializing self (lond) </font>');
3106: &UpdateHosts; # Lond is us!!
1.146 foxr 3107: } else {
3108: &logthis('<font color="yellow" Invalid reinit request for '.$process
3109: ."</font>");
3110: return "error:Invalid process identifier $process";
3111: }
1.145 foxr 3112: return 'ok';
3113: }
1.168 foxr 3114: # Validate a line in a configuration file edit script:
3115: # Validation includes:
3116: # - Ensuring the command is valid.
3117: # - Ensuring the command has sufficient parameters
3118: # Parameters:
3119: # scriptline - A line to validate (\n has been stripped for what it's worth).
1.167 foxr 3120: #
1.168 foxr 3121: # Return:
3122: # 0 - Invalid scriptline.
3123: # 1 - Valid scriptline
3124: # NOTE:
3125: # Only the command syntax is checked, not the executability of the
3126: # command.
3127: #
3128: sub isValidEditCommand {
3129: my $scriptline = shift;
3130:
3131: # Line elements are pipe separated:
3132:
3133: my ($command, $key, $newline) = split(/\|/, $scriptline);
3134: &logthis('<font color="green"> isValideditCommand checking: '.
3135: "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");
3136:
3137: if ($command eq "delete") {
3138: #
3139: # key with no newline.
3140: #
3141: if( ($key eq "") || ($newline ne "")) {
3142: return 0; # Must have key but no newline.
3143: } else {
3144: return 1; # Valid syntax.
3145: }
1.169 foxr 3146: } elsif ($command eq "replace") {
1.168 foxr 3147: #
3148: # key and newline:
3149: #
3150: if (($key eq "") || ($newline eq "")) {
3151: return 0;
3152: } else {
3153: return 1;
3154: }
1.169 foxr 3155: } elsif ($command eq "append") {
3156: if (($key ne "") && ($newline eq "")) {
3157: return 1;
3158: } else {
3159: return 0;
3160: }
1.168 foxr 3161: } else {
3162: return 0; # Invalid command.
3163: }
3164: return 0; # Should not get here!!!
3165: }
1.169 foxr 3166: #
3167: # ApplyEdit - Applies an edit command to a line in a configuration
3168: # file. It is the caller's responsiblity to validate the
3169: # edit line.
3170: # Parameters:
3171: # $directive - A single edit directive to apply.
3172: # Edit directives are of the form:
3173: # append|newline - Appends a new line to the file.
3174: # replace|key|newline - Replaces the line with key value 'key'
3175: # delete|key - Deletes the line with key value 'key'.
3176: # $editor - A config file editor object that contains the
3177: # file being edited.
3178: #
3179: sub ApplyEdit {
3180: my $directive = shift;
3181: my $editor = shift;
3182:
3183: # Break the directive down into its command and its parameters
3184: # (at most two at this point. The meaning of the parameters, if in fact
3185: # they exist depends on the command).
3186:
3187: my ($command, $p1, $p2) = split(/\|/, $directive);
3188:
3189: if($command eq "append") {
3190: $editor->Append($p1); # p1 - key p2 null.
3191: } elsif ($command eq "replace") {
3192: $editor->ReplaceLine($p1, $p2); # p1 - key p2 = newline.
3193: } elsif ($command eq "delete") {
3194: $editor->DeleteLine($p1); # p1 - key p2 null.
3195: } else { # Should not get here!!!
1.178.2.4 albertel 3196: die "Invalid command given to ApplyEdit $command";
1.169 foxr 3197: }
3198: }
3199: #
3200: # AdjustOurHost:
3201: # Adjusts a host file stored in a configuration file editor object
3202: # for the true IP address of this host. This is necessary for hosts
3203: # that live behind a firewall.
3204: # Those hosts have a publicly distributed IP of the firewall, but
3205: # internally must use their actual IP. We assume that a given
3206: # host only has a single IP interface for now.
3207: # Formal Parameters:
3208: # editor - The configuration file editor to adjust. This
3209: # editor is assumed to contain a hosts.tab file.
3210: # Strategy:
3211: # - Figure out our hostname.
3212: # - Lookup the entry for this host.
3213: # - Modify the line to contain our IP
3214: # - Do a replace for this host.
3215: sub AdjustOurHost {
3216: my $editor = shift;
3217:
3218: # figure out who I am.
3219:
3220: my $myHostName = $perlvar{'lonHostID'}; # LonCAPA hostname.
3221:
3222: # Get my host file entry.
3223:
3224: my $ConfigLine = $editor->Find($myHostName);
3225: if(! (defined $ConfigLine)) {
3226: die "AdjustOurHost - no entry for me in hosts file $myHostName";
3227: }
3228: # figure out my IP:
3229: # Use the config line to get my hostname.
3230: # Use gethostbyname to translate that into an IP address.
3231: #
3232: my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
3233: my $BinaryIp = gethostbyname($name);
3234: my $ip = inet_ntoa($ip);
3235: #
3236: # Reassemble the config line from the elements in the list.
3237: # Note that if the loncnew items were not present before, they will
3238: # be now even if they would be empty
3239: #
3240: my $newConfigLine = $id;
3241: foreach my $item ($domain, $role, $name, $ip, $maxcon, $idleto, $mincon) {
3242: $newConfigLine .= ":".$item;
3243: }
3244: # Replace the line:
3245:
3246: $editor->ReplaceLine($id, $newConfigLine);
3247:
3248: }
3249: #
3250: # ReplaceConfigFile:
3251: # Replaces a configuration file with the contents of a
3252: # configuration file editor object.
3253: # This is done by:
3254: # - Copying the target file to <filename>.old
3255: # - Writing the new file to <filename>.tmp
3256: # - Moving <filename.tmp> -> <filename>
3257: # This laborious process ensures that the system is never without
3258: # a configuration file that's at least valid (even if the contents
3259: # may be dated).
3260: # Parameters:
3261: # filename - Name of the file to modify... this is a full path.
3262: # editor - Editor containing the file.
3263: #
3264: sub ReplaceConfigFile {
3265: my $filename = shift;
3266: my $editor = shift;
1.168 foxr 3267:
1.169 foxr 3268: CopyFile ($filename, $filename.".old");
3269:
3270: my $contents = $editor->Get(); # Get the contents of the file.
3271:
3272: InstallFile($filename, $contents);
3273: }
1.168 foxr 3274: #
3275: #
3276: # Called to edit a configuration table file
1.167 foxr 3277: # Parameters:
3278: # request - The entire command/request sent by lonc or lonManage
3279: # Return:
3280: # The reply to send to the client.
1.168 foxr 3281: #
1.167 foxr 3282: sub EditFile {
3283: my $request = shift;
3284:
3285: # Split the command into it's pieces: edit:filetype:script
3286:
1.168 foxr 3287: my ($request, $filetype, $script) = split(/:/, $request,3); # : in script
1.167 foxr 3288:
3289: # Check the pre-coditions for success:
3290:
3291: if($request != "edit") { # Something is amiss afoot alack.
3292: return "error:edit request detected, but request != 'edit'\n";
3293: }
3294: if( ($filetype ne "hosts") &&
3295: ($filetype ne "domain")) {
3296: return "error:edit requested with invalid file specifier: $filetype \n";
3297: }
3298:
3299: # Split the edit script and check it's validity.
1.168 foxr 3300:
3301: my @scriptlines = split(/\n/, $script); # one line per element.
3302: my $linecount = scalar(@scriptlines);
3303: for(my $i = 0; $i < $linecount; $i++) {
3304: chomp($scriptlines[$i]);
3305: if(!isValidEditCommand($scriptlines[$i])) {
3306: return "error:edit with bad script line: '$scriptlines[$i]' \n";
3307: }
3308: }
1.145 foxr 3309:
1.167 foxr 3310: # Execute the edit operation.
1.169 foxr 3311: # - Create a config file editor for the appropriate file and
3312: # - execute each command in the script:
3313: #
3314: my $configfile = ConfigFileFromSelector($filetype);
3315: if (!(defined $configfile)) {
3316: return "refused\n";
3317: }
3318: my $editor = ConfigFileEdit->new($configfile);
1.167 foxr 3319:
1.169 foxr 3320: for (my $i = 0; $i < $linecount; $i++) {
3321: ApplyEdit($scriptlines[$i], $editor);
3322: }
3323: # If the file is the host file, ensure that our host is
3324: # adjusted to have our ip:
3325: #
3326: if($filetype eq "host") {
3327: AdjustOurHost($editor);
3328: }
3329: # Finally replace the current file with our file.
3330: #
3331: ReplaceConfigFile($configfile, $editor);
1.167 foxr 3332:
3333: return "ok\n";
3334: }
1.141 foxr 3335: #
1.96 foxr 3336: # Convert an error return code from lcpasswd to a string value.
3337: #
3338: sub lcpasswdstrerror {
3339: my $ErrorCode = shift;
1.97 foxr 3340: if(($ErrorCode < 0) || ($ErrorCode > $lastpwderror)) {
1.96 foxr 3341: return "lcpasswd Unrecognized error return value ".$ErrorCode;
3342: } else {
1.98 foxr 3343: return $passwderrors[$ErrorCode];
1.96 foxr 3344: }
3345: }
3346:
1.97 foxr 3347: #
3348: # Convert an error return code from lcuseradd to a string value:
3349: #
3350: sub lcuseraddstrerror {
3351: my $ErrorCode = shift;
3352: if(($ErrorCode < 0) || ($ErrorCode > $lastadderror)) {
3353: return "lcuseradd - Unrecognized error code: ".$ErrorCode;
3354: } else {
1.98 foxr 3355: return $adderrors[$ErrorCode];
1.97 foxr 3356: }
3357: }
3358:
1.23 harris41 3359: # grabs exception and records it to log before exiting
3360: sub catchexception {
1.27 albertel 3361: my ($error)=@_;
1.25 www 3362: $SIG{'QUIT'}='DEFAULT';
3363: $SIG{__DIE__}='DEFAULT';
1.165 albertel 3364: &status("Catching exception");
1.23 harris41 3365: &logthis("<font color=red>CRITICAL: "
1.178.2.4 albertel 3366: ."ABNORMAL EXIT. Child $$ for server $thisserver died through "
3367: ."a crash with this error msg->[$error]</font>");
1.57 www 3368: &logthis('Famous last words: '.$status.' - '.$lastlog);
1.27 albertel 3369: if ($client) { print $client "error: $error\n"; }
1.59 www 3370: $server->close();
1.27 albertel 3371: die($error);
1.23 harris41 3372: }
3373:
1.63 www 3374: sub timeout {
1.165 albertel 3375: &status("Handling Timeout");
1.63 www 3376: &logthis("<font color=ref>CRITICAL: TIME OUT ".$$."</font>");
3377: &catchexception('Timeout');
3378: }
1.22 harris41 3379: # -------------------------------- Set signal handlers to record abnormal exits
3380:
3381: $SIG{'QUIT'}=\&catchexception;
3382: $SIG{__DIE__}=\&catchexception;
3383:
1.81 matthew 3384: # ---------------------------------- Read loncapa_apache.conf and loncapa.conf
1.95 harris41 3385: &status("Read loncapa.conf and loncapa_apache.conf");
3386: my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');
1.141 foxr 3387: %perlvar=%{$perlvarref};
1.80 harris41 3388: undef $perlvarref;
1.19 www 3389:
1.35 harris41 3390: # ----------------------------- Make sure this process is running from user=www
3391: my $wwwid=getpwnam('www');
3392: if ($wwwid!=$<) {
1.178.2.4 albertel 3393: my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
3394: my $subj="LON: $currenthostid User ID mismatch";
3395: system("echo 'User ID mismatch. lond must be run as user www.' |\
1.35 harris41 3396: mailto $emailto -s '$subj' > /dev/null");
1.178.2.4 albertel 3397: exit 1;
1.35 harris41 3398: }
3399:
1.19 www 3400: # --------------------------------------------- Check if other instance running
3401:
3402: my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
3403:
3404: if (-e $pidfile) {
1.178.2.4 albertel 3405: my $lfh=IO::File->new("$pidfile");
3406: my $pide=<$lfh>;
3407: chomp($pide);
3408: if (kill 0 => $pide) { die "already running"; }
1.19 www 3409: }
1.1 albertel 3410:
3411: # ------------------------------------------------------------- Read hosts file
3412:
3413:
3414:
3415: # establish SERVER socket, bind and listen.
3416: $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},
3417: Type => SOCK_STREAM,
3418: Proto => 'tcp',
3419: Reuse => 1,
3420: Listen => 10 )
1.178.2.4 albertel 3421: or die "making socket: $@\n";
1.1 albertel 3422:
3423: # --------------------------------------------------------- Do global variables
3424:
3425: # global variables
3426:
1.134 albertel 3427: my %children = (); # keys are current child process IDs
1.178.2.1 foxr 3428: my $children = 0; # current number of children
1.1 albertel 3429:
3430: sub REAPER { # takes care of dead children
3431: $SIG{CHLD} = \&REAPER;
1.165 albertel 3432: &status("Handling child death");
1.178.2.1 foxr 3433: my $pid = wait;
3434: if (defined($children{$pid})) {
3435: &logthis("Child $pid died");
3436: $children --;
3437: delete $children{$pid};
3438: } else {
3439: &logthis("Unknown Child $pid died");
1.176 albertel 3440: }
1.165 albertel 3441: &status("Finished Handling child death");
1.1 albertel 3442: }
3443:
3444: sub HUNTSMAN { # signal handler for SIGINT
1.165 albertel 3445: &status("Killing children (INT)");
1.1 albertel 3446: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
3447: kill 'INT' => keys %children;
1.59 www 3448: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.1 albertel 3449: my $execdir=$perlvar{'lonDaemons'};
3450: unlink("$execdir/logs/lond.pid");
1.9 www 3451: &logthis("<font color=red>CRITICAL: Shutting down</font>");
1.165 albertel 3452: &status("Done killing children");
1.1 albertel 3453: exit; # clean up with dignity
3454: }
3455:
3456: sub HUPSMAN { # signal handler for SIGHUP
3457: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
1.165 albertel 3458: &status("Killing children for restart (HUP)");
1.1 albertel 3459: kill 'INT' => keys %children;
1.59 www 3460: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.9 www 3461: &logthis("<font color=red>CRITICAL: Restarting</font>");
1.134 albertel 3462: my $execdir=$perlvar{'lonDaemons'};
1.30 harris41 3463: unlink("$execdir/logs/lond.pid");
1.165 albertel 3464: &status("Restarting self (HUP)");
1.1 albertel 3465: exec("$execdir/lond"); # here we go again
3466: }
3467:
1.144 foxr 3468: #
1.148 foxr 3469: # Kill off hashes that describe the host table prior to re-reading it.
3470: # Hashes affected are:
3471: # %hostid, %hostdom %hostip
3472: #
3473: sub KillHostHashes {
3474: foreach my $key (keys %hostid) {
3475: delete $hostid{$key};
3476: }
3477: foreach my $key (keys %hostdom) {
3478: delete $hostdom{$key};
3479: }
3480: foreach my $key (keys %hostip) {
3481: delete $hostip{$key};
3482: }
3483: }
3484: #
3485: # Read in the host table from file and distribute it into the various hashes:
3486: #
3487: # - %hostid - Indexed by IP, the loncapa hostname.
3488: # - %hostdom - Indexed by loncapa hostname, the domain.
3489: # - %hostip - Indexed by hostid, the Ip address of the host.
3490: sub ReadHostTable {
3491:
3492: open (CONFIG,"$perlvar{'lonTabDir'}/hosts.tab") || die "Can't read host file";
3493:
3494: while (my $configline=<CONFIG>) {
1.178.2.1 foxr 3495: my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
3496: chomp($ip); $ip=~s/\D+$//;
3497: $hostid{$ip}=$id;
3498: $hostdom{$id}=$domain;
3499: $hostip{$id}=$ip;
3500: if ($id eq $perlvar{'lonHostID'}) { $thisserver=$name; }
1.148 foxr 3501: }
3502: close(CONFIG);
3503: }
3504: #
3505: # Reload the Apache daemon's state.
1.150 foxr 3506: # This is done by invoking /home/httpd/perl/apachereload
3507: # a setuid perl script that can be root for us to do this job.
1.148 foxr 3508: #
3509: sub ReloadApache {
1.150 foxr 3510: my $execdir = $perlvar{'lonDaemons'};
3511: my $script = $execdir."/apachereload";
3512: system($script);
1.148 foxr 3513: }
3514:
3515: #
1.144 foxr 3516: # Called in response to a USR2 signal.
3517: # - Reread hosts.tab
3518: # - All children connected to hosts that were removed from hosts.tab
3519: # are killed via SIGINT
3520: # - All children connected to previously existing hosts are sent SIGUSR1
3521: # - Our internal hosts hash is updated to reflect the new contents of
3522: # hosts.tab causing connections from hosts added to hosts.tab to
3523: # now be honored.
3524: #
3525: sub UpdateHosts {
1.165 albertel 3526: &status("Reload hosts.tab");
1.147 foxr 3527: logthis('<font color="blue"> Updating connections </font>');
1.148 foxr 3528: #
3529: # The %children hash has the set of IP's we currently have children
3530: # on. These need to be matched against records in the hosts.tab
3531: # Any ip's no longer in the table get killed off they correspond to
3532: # either dropped or changed hosts. Note that the re-read of the table
3533: # will take care of new and changed hosts as connections come into being.
3534:
3535:
3536: KillHostHashes;
3537: ReadHostTable;
3538:
3539: foreach my $child (keys %children) {
3540: my $childip = $children{$child};
3541: if(!$hostid{$childip}) {
1.149 foxr 3542: logthis('<font color="blue"> UpdateHosts killing child '
3543: ." $child for ip $childip </font>");
1.148 foxr 3544: kill('INT', $child);
1.149 foxr 3545: } else {
3546: logthis('<font color="green"> keeping child for ip '
3547: ." $childip (pid=$child) </font>");
1.148 foxr 3548: }
3549: }
3550: ReloadApache;
1.165 albertel 3551: &status("Finished reloading hosts.tab");
1.144 foxr 3552: }
3553:
1.148 foxr 3554:
1.57 www 3555: sub checkchildren {
1.165 albertel 3556: &status("Checking on the children (sending signals)");
1.57 www 3557: &initnewstatus();
3558: &logstatus();
3559: &logthis('Going to check on the children');
1.134 albertel 3560: my $docdir=$perlvar{'lonDocRoot'};
1.61 harris41 3561: foreach (sort keys %children) {
1.57 www 3562: sleep 1;
3563: unless (kill 'USR1' => $_) {
3564: &logthis ('Child '.$_.' is dead');
3565: &logstatus($$.' is dead');
3566: }
1.61 harris41 3567: }
1.63 www 3568: sleep 5;
1.113 albertel 3569: $SIG{ALRM} = sub { die "timeout" };
3570: $SIG{__DIE__} = 'DEFAULT';
1.165 albertel 3571: &status("Checking on the children (waiting for reports)");
1.63 www 3572: foreach (sort keys %children) {
3573: unless (-e "$docdir/lon-status/londchld/$_.txt") {
1.178.2.4 albertel 3574: eval {
3575: alarm(300);
3576: &logthis('Child '.$_.' did not respond');
3577: kill 9 => $_;
3578: #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
3579: #$subj="LON: $currenthostid killed lond process $_";
3580: #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
3581: #$execdir=$perlvar{'lonDaemons'};
3582: #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
3583: alarm(0);
3584: }
1.63 www 3585: }
3586: }
1.113 albertel 3587: $SIG{ALRM} = 'DEFAULT';
1.155 albertel 3588: $SIG{__DIE__} = \&catchexception;
1.165 albertel 3589: &status("Finished checking children");
1.57 www 3590: }
3591:
1.1 albertel 3592: # --------------------------------------------------------------------- Logging
3593:
3594: sub logthis {
3595: my $message=shift;
3596: my $execdir=$perlvar{'lonDaemons'};
3597: my $fh=IO::File->new(">>$execdir/logs/lond.log");
3598: my $now=time;
3599: my $local=localtime($now);
1.58 www 3600: $lastlog=$local.': '.$message;
1.1 albertel 3601: print $fh "$local ($$): $message\n";
3602: }
3603:
1.77 foxr 3604: # ------------------------- Conditional log if $DEBUG true.
3605: sub Debug {
3606: my $message = shift;
3607: if($DEBUG) {
3608: &logthis($message);
3609: }
3610: }
1.161 foxr 3611:
3612: #
3613: # Sub to do replies to client.. this gives a hook for some
3614: # debug tracing too:
3615: # Parameters:
3616: # fd - File open on client.
3617: # reply - Text to send to client.
3618: # request - Original request from client.
3619: #
1.178.2.1 foxr 3620: # Note: This increments Transactions
3621: #
1.161 foxr 3622: sub Reply {
1.178.2.1 foxr 3623: alarm(120);
1.161 foxr 3624: my $fd = shift;
3625: my $reply = shift;
3626: my $request = shift;
3627:
3628: print $fd $reply;
3629: Debug("Request was $request Reply was $reply");
3630:
1.178.2.1 foxr 3631: $Transactions++;
3632: alarm(0);
3633:
3634:
3635: }
3636: #
3637: # Sub to report a failure.
3638: # This function:
3639: # - Increments the failure statistic counters.
3640: # - Invokes Reply to send the error message to the client.
3641: # Parameters:
3642: # fd - File descriptor open on the client
3643: # reply - Reply text to emit.
3644: # request - The original request message (used by Reply
3645: # to debug if that's enabled.
3646: # Implicit outputs:
3647: # $Failures- The number of failures is incremented.
3648: # Reply (invoked here) sends a message to the
3649: # client:
3650: #
3651: sub Failure {
1.178.2.4 albertel 3652: my $fd = shift;
3653: my $reply = shift;
3654: my $request = shift;
1.178.2.1 foxr 3655:
1.178.2.4 albertel 3656: $Failures++;
3657: Reply($fd, $reply, $request); # That's simple eh?
1.161 foxr 3658: }
1.57 www 3659: # ------------------------------------------------------------------ Log status
3660:
3661: sub logstatus {
1.178.2.4 albertel 3662: &status("Doing logging");
3663: my $docdir=$perlvar{'lonDocRoot'};
3664: {
3665: my $fh=IO::File->new(">>$docdir/lon-status/londstatus.txt");
3666: print $fh $$."\t".$currenthostid."\t".$status."\t".$lastlog."\n";
3667: $fh->close();
3668: }
3669: &status("Finished londstatus.txt");
3670: {
3671: my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
3672: print $fh $status."\n".$lastlog."\n".time;
3673: $fh->close();
3674: }
3675: ResetStatistics;
3676: &status("Finished logging");
1.178.2.1 foxr 3677:
1.57 www 3678: }
3679:
3680: sub initnewstatus {
3681: my $docdir=$perlvar{'lonDocRoot'};
3682: my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");
3683: my $now=time;
3684: my $local=localtime($now);
3685: print $fh "LOND status $local - parent $$\n\n";
1.64 www 3686: opendir(DIR,"$docdir/lon-status/londchld");
1.134 albertel 3687: while (my $filename=readdir(DIR)) {
1.64 www 3688: unlink("$docdir/lon-status/londchld/$filename");
3689: }
3690: closedir(DIR);
1.57 www 3691: }
3692:
3693: # -------------------------------------------------------------- Status setting
3694:
3695: sub status {
3696: my $what=shift;
3697: my $now=time;
3698: my $local=localtime($now);
1.178.2.1 foxr 3699: my $status = "lond: $what $local ";
3700: if($Transactions) {
1.178.2.4 albertel 3701: $status .= " Transactions: $Transactions Failed; $Failures";
1.178.2.1 foxr 3702: }
3703: $0=$status;
1.57 www 3704: }
1.11 www 3705:
3706: # -------------------------------------------------------- Escape Special Chars
3707:
3708: sub escape {
3709: my $str=shift;
3710: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
3711: return $str;
3712: }
3713:
3714: # ----------------------------------------------------- Un-Escape Special Chars
3715:
3716: sub unescape {
3717: my $str=shift;
3718: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3719: return $str;
3720: }
3721:
1.1 albertel 3722: # ----------------------------------------------------------- Send USR1 to lonc
3723:
3724: sub reconlonc {
3725: my $peerfile=shift;
3726: &logthis("Trying to reconnect for $peerfile");
3727: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
3728: if (my $fh=IO::File->new("$loncfile")) {
3729: my $loncpid=<$fh>;
3730: chomp($loncpid);
3731: if (kill 0 => $loncpid) {
3732: &logthis("lonc at pid $loncpid responding, sending USR1");
3733: kill USR1 => $loncpid;
3734: } else {
1.178.2.4 albertel 3735: &logthis("<font color=red>CRITICAL: "
3736: ."lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 3737: }
3738: } else {
1.178.2.4 albertel 3739: &logthis('<font color=red>CRITICAL: lonc not running, giving up</font>');
1.1 albertel 3740: }
3741: }
3742:
3743: # -------------------------------------------------- Non-critical communication
1.11 www 3744:
1.1 albertel 3745: sub subreply {
3746: my ($cmd,$server)=@_;
3747: my $peerfile="$perlvar{'lonSockDir'}/$server";
3748: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
3749: Type => SOCK_STREAM,
3750: Timeout => 10)
1.178.2.4 albertel 3751: or return "con_lost";
1.1 albertel 3752: print $sclient "$cmd\n";
3753: my $answer=<$sclient>;
3754: chomp($answer);
3755: if (!$answer) { $answer="con_lost"; }
3756: return $answer;
3757: }
3758:
3759: sub reply {
1.178.2.4 albertel 3760: my ($cmd,$server)=@_;
3761: my $answer;
3762: if ($server ne $currenthostid) {
3763: $answer=subreply($cmd,$server);
3764: if ($answer eq 'con_lost') {
3765: $answer=subreply("ping",$server);
3766: if ($answer ne $server) {
3767: &logthis("sub reply: answer != server answer is $answer, server is $server");
3768: &reconlonc("$perlvar{'lonSockDir'}/$server");
3769: }
3770: $answer=subreply($cmd,$server);
3771: }
3772: } else {
3773: $answer='self_reply';
3774: }
3775: return $answer;
1.1 albertel 3776: }
3777:
1.13 www 3778: # -------------------------------------------------------------- Talk to lonsql
3779:
1.12 harris41 3780: sub sqlreply {
3781: my ($cmd)=@_;
3782: my $answer=subsqlreply($cmd);
3783: if ($answer eq 'con_lost') { $answer=subsqlreply($cmd); }
3784: return $answer;
3785: }
3786:
3787: sub subsqlreply {
3788: my ($cmd)=@_;
3789: my $unixsock="mysqlsock";
3790: my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
3791: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
3792: Type => SOCK_STREAM,
3793: Timeout => 10)
1.178.2.4 albertel 3794: or return "con_lost";
1.12 harris41 3795: print $sclient "$cmd\n";
3796: my $answer=<$sclient>;
3797: chomp($answer);
3798: if (!$answer) { $answer="con_lost"; }
3799: return $answer;
3800: }
3801:
1.1 albertel 3802: # -------------------------------------------- Return path to profile directory
1.11 www 3803:
1.1 albertel 3804: sub propath {
3805: my ($udom,$uname)=@_;
1.178.2.11 foxr 3806: Debug("Propath:$udom:$uname");
1.1 albertel 3807: $udom=~s/\W//g;
3808: $uname=~s/\W//g;
1.178.2.11 foxr 3809: Debug("Propath2:$udom:$uname");
1.16 www 3810: my $subdir=$uname.'__';
1.1 albertel 3811: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
3812: my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
1.178.2.11 foxr 3813: Debug("Propath returning $proname");
1.1 albertel 3814: return $proname;
3815: }
3816:
3817: # --------------------------------------- Is this the home server of an author?
1.11 www 3818:
1.1 albertel 3819: sub ishome {
3820: my $author=shift;
3821: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3822: my ($udom,$uname)=split(/\//,$author);
3823: my $proname=propath($udom,$uname);
3824: if (-e $proname) {
3825: return 'owner';
3826: } else {
3827: return 'not_owner';
3828: }
3829: }
3830:
3831: # ======================================================= Continue main program
3832: # ---------------------------------------------------- Fork once and dissociate
3833:
1.134 albertel 3834: my $fpid=fork;
1.1 albertel 3835: exit if $fpid;
1.29 harris41 3836: die "Couldn't fork: $!" unless defined ($fpid);
1.1 albertel 3837:
1.29 harris41 3838: POSIX::setsid() or die "Can't start new session: $!";
1.1 albertel 3839:
3840: # ------------------------------------------------------- Write our PID on disk
3841:
1.134 albertel 3842: my $execdir=$perlvar{'lonDaemons'};
1.1 albertel 3843: open (PIDSAVE,">$execdir/logs/lond.pid");
3844: print PIDSAVE "$$\n";
3845: close(PIDSAVE);
1.9 www 3846: &logthis("<font color=red>CRITICAL: ---------- Starting ----------</font>");
1.57 www 3847: &status('Starting');
1.1 albertel 3848:
1.106 foxr 3849:
1.1 albertel 3850:
3851: # ----------------------------------------------------- Install signal handlers
3852:
1.57 www 3853:
1.1 albertel 3854: $SIG{CHLD} = \&REAPER;
3855: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
3856: $SIG{HUP} = \&HUPSMAN;
1.57 www 3857: $SIG{USR1} = \&checkchildren;
1.144 foxr 3858: $SIG{USR2} = \&UpdateHosts;
1.106 foxr 3859:
1.148 foxr 3860: # Read the host hashes:
3861:
3862: ReadHostTable;
1.106 foxr 3863:
1.178.2.1 foxr 3864:
1.106 foxr 3865: # --------------------------------------------------------------
3866: # Accept connections. When a connection comes in, it is validated
3867: # and if good, a child process is created to process transactions
3868: # along the connection.
3869:
1.1 albertel 3870: while (1) {
1.165 albertel 3871: &status('Starting accept');
1.106 foxr 3872: $client = $server->accept() or next;
1.165 albertel 3873: &status('Accepted '.$client.' off to spawn');
1.106 foxr 3874: make_new_child($client);
1.165 albertel 3875: &status('Finished spawning');
1.1 albertel 3876: }
3877:
3878: sub make_new_child {
3879: my $pid;
3880: my $sigset;
1.106 foxr 3881:
3882: $client = shift;
1.165 albertel 3883: &status('Starting new child '.$client);
1.161 foxr 3884: &logthis('<font color="green"> Attempting to start child ('.$client.
3885: ")</font>");
1.1 albertel 3886: # block signal for fork
3887: $sigset = POSIX::SigSet->new(SIGINT);
3888: sigprocmask(SIG_BLOCK, $sigset)
1.29 harris41 3889: or die "Can't block SIGINT for fork: $!\n";
1.178.2.4 albertel 3890:
1.29 harris41 3891: die "fork: $!" unless defined ($pid = fork);
1.148 foxr 3892:
3893: $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
3894: # connection liveness.
3895:
3896: #
3897: # Figure out who we're talking to so we can record the peer in
3898: # the pid hash.
3899: #
3900: my $caller = getpeername($client);
3901: my ($port,$iaddr)=unpack_sockaddr_in($caller);
3902: $clientip=inet_ntoa($iaddr);
1.1 albertel 3903:
3904: if ($pid) {
3905: # Parent records the child's birth and returns.
3906: sigprocmask(SIG_UNBLOCK, $sigset)
1.29 harris41 3907: or die "Can't unblock SIGINT for fork: $!\n";
1.148 foxr 3908: $children{$pid} = $clientip;
1.178.2.1 foxr 3909: $children++;
1.57 www 3910: &status('Started child '.$pid);
1.1 albertel 3911: return;
3912: } else {
3913: # Child can *not* return from this subroutine.
3914: $SIG{INT} = 'DEFAULT'; # make SIGINT kill us as it did before
1.126 albertel 3915: $SIG{CHLD} = 'DEFAULT'; #make this default so that pwauth returns
3916: #don't get intercepted
1.57 www 3917: $SIG{USR1}= \&logstatus;
1.63 www 3918: $SIG{ALRM}= \&timeout;
1.57 www 3919: $lastlog='Forked ';
3920: $status='Forked';
3921:
1.1 albertel 3922: # unblock signals
3923: sigprocmask(SIG_UNBLOCK, $sigset)
1.29 harris41 3924: or die "Can't unblock SIGINT for fork: $!\n";
1.13 www 3925:
1.178.2.1 foxr 3926:
3927:
1.91 albertel 3928: &Authen::Krb5::init_context();
3929: &Authen::Krb5::init_ets();
1.178.2.4 albertel 3930:
1.161 foxr 3931: &status('Accepted connection');
1.1 albertel 3932: # =============================================================================
3933: # do something with the connection
3934: # -----------------------------------------------------------------------------
1.148 foxr 3935: # see if we know client and check for spoof IP by challenge
3936:
1.161 foxr 3937: ReadManagerTable; # May also be a manager!!
3938:
3939: my $clientrec=($hostid{$clientip} ne undef);
3940: my $ismanager=($managers{$clientip} ne undef);
3941: $clientname = "[unknonwn]";
3942: if($clientrec) { # Establish client type.
3943: $ConnectionType = "client";
3944: $clientname = $hostid{$clientip};
3945: if($ismanager) {
3946: $ConnectionType = "both";
3947: }
3948: } else {
3949: $ConnectionType = "manager";
3950: $clientname = $managers{$clientip};
3951: }
3952: my $clientok;
3953: if ($clientrec || $ismanager) {
3954: &status("Waiting for init from $clientip $clientname");
3955: &logthis('<font color="yellow">INFO: Connection, '.
3956: $clientip.
1.178.2.4 albertel 3957: " ($clientname) connection type = $ConnectionType </font>" );
1.161 foxr 3958: &status("Connecting $clientip ($clientname))");
3959: my $remotereq=<$client>;
3960: $remotereq=~s/[^\w:]//g;
3961: if ($remotereq =~ /^init/) {
3962: &sethost("sethost:$perlvar{'lonHostID'}");
3963: my $challenge="$$".time;
3964: print $client "$challenge\n";
1.178.2.4 albertel 3965: &status("Waiting for challenge reply from $clientip ($clientname)");
1.161 foxr 3966: $remotereq=<$client>;
3967: $remotereq=~s/\W//g;
3968: if ($challenge eq $remotereq) {
3969: $clientok=1;
3970: print $client "ok\n";
3971: } else {
1.178.2.4 albertel 3972: &logthis("<font color=blue>WARNING: $clientip did not reply challenge</font>");
1.161 foxr 3973: &status('No challenge reply '.$clientip);
3974: }
1.2 www 3975: } else {
1.178.2.4 albertel 3976: &logthis("<font color=blue>WARNING: "
1.161 foxr 3977: ."$clientip failed to initialize: >$remotereq< </font>");
3978: &status('No init '.$clientip);
3979: }
3980: } else {
1.178.2.4 albertel 3981: &logthis("<font color=blue>WARNING: Unknown client $clientip</font>");
1.161 foxr 3982: &status('Hung up on '.$clientip);
3983: }
3984: if ($clientok) {
1.1 albertel 3985: # ---------------- New known client connecting, could mean machine online again
1.161 foxr 3986:
3987: foreach my $id (keys(%hostip)) {
3988: if ($hostip{$id} ne $clientip ||
3989: $hostip{$currenthostid} eq $clientip) {
3990: # no need to try to do recon's to myself
3991: next;
1.115 albertel 3992: }
1.161 foxr 3993: &reconlonc("$perlvar{'lonSockDir'}/$id");
3994: }
3995: &logthis("<font color=green>Established connection: $clientname</font>");
3996: &status('Will listen to '.$clientname);
3997:
1.178.2.1 foxr 3998: ResetStatistics();
1.161 foxr 3999:
1.178.2.1 foxr 4000: # ------------------------------------------------------------ Process requests
4001: my $KeepGoing = 1;
4002: while ((my $userinput=GetRequest) && $KeepGoing) {
4003: $KeepGoing = ProcessRequest($userinput);
1.177 foxr 4004: # -------------------------------------------------------------------- complete
1.178.2.1 foxr 4005:
1.161 foxr 4006: &status('Listening to '.$clientname);
4007: }
1.59 www 4008: # --------------------------------------------- client unknown or fishy, refuse
1.161 foxr 4009: } else {
4010: print $client "refused\n";
4011: $client->close();
4012: &logthis("<font color=blue>WARNING: "
4013: ."Rejected client $clientip, closing connection</font>");
4014: }
4015: }
4016:
1.1 albertel 4017: # =============================================================================
1.161 foxr 4018:
4019: &logthis("<font color=red>CRITICAL: "
4020: ."Disconnect from $clientip ($clientname)</font>");
4021:
4022:
4023: # this exit is VERY important, otherwise the child will become
4024: # a producer of more and more children, forking yourself into
4025: # process death.
4026: exit;
1.106 foxr 4027:
1.78 foxr 4028: }
4029:
4030:
4031: #
4032: # Checks to see if the input roleput request was to set
4033: # an author role. If so, invokes the lchtmldir script to set
4034: # up a correct public_html
4035: # Parameters:
4036: # request - The request sent to the rolesput subchunk.
4037: # We're looking for /domain/_au
4038: # domain - The domain in which the user is having roles doctored.
4039: # user - Name of the user for which the role is being put.
4040: # authtype - The authentication type associated with the user.
4041: #
1.178.2.4 albertel 4042: sub ManagePermissions {
1.78 foxr 4043: my $request = shift;
4044: my $domain = shift;
4045: my $user = shift;
4046: my $authtype= shift;
4047:
4048: # See if the request is of the form /$domain/_au
1.178.2.19! foxr 4049: &logthis("request is $request");
1.78 foxr 4050: if($request =~ /^(\/$domain\/_au)$/) { # It's an author rolesput...
4051: my $execdir = $perlvar{'lonDaemons'};
4052: my $userhome= "/home/$user" ;
1.134 albertel 4053: &logthis("system $execdir/lchtmldir $userhome $user $authtype");
1.78 foxr 4054: system("$execdir/lchtmldir $userhome $user $authtype");
4055: }
4056: }
1.178.2.8 foxr 4057:
4058: #
4059: # Return the full path of a user password file, whether it exists or not.
4060: # Parameters:
4061: # domain - Domain in which the password file lives.
4062: # user - name of the user.
4063: # Returns:
4064: # Full passwd path:
4065: #
4066: sub PasswordPath {
4067: my $domain = shift;
4068: my $user = shift;
4069:
4070: my $path = &propath($domain, $user);
1.178.2.11 foxr 4071: $path .= "/passwd";
1.178.2.8 foxr 4072:
4073: return $path;
4074: }
4075:
4076: # Password Filename
4077: # Returns the path to a passwd file given domain and user... only if
4078: # it exists.
4079: # Parameters:
4080: # domain - Domain in which to search.
4081: # user - username.
4082: # Returns:
4083: # - If the password file exists returns its path.
4084: # - If the password file does not exist, returns undefined.
4085: #
4086: sub PasswordFilename {
4087: my $domain = shift;
4088: my $user = shift;
4089:
1.178.2.11 foxr 4090: Debug ("PasswordFilename called: dom = $domain user = $user");
1.178.2.8 foxr 4091:
1.178.2.11 foxr 4092: my $path = PasswordPath($domain, $user);
4093: Debug("PasswordFilename got path: $path");
1.178.2.8 foxr 4094: if(-e $path) {
4095: return $path;
4096: } else {
4097: return undef;
4098: }
4099: }
4100:
4101: #
4102: # Rewrite the contents of the user's passwd file.
4103: # Parameters:
4104: # domain - domain of the user.
4105: # name - User's name.
4106: # contents - New contents of the file.
4107: # Returns:
4108: # 0 - Failed.
4109: # 1 - Success.
4110: #
4111: sub RewritePwFile {
4112: my $domain = shift;
4113: my $user = shift;
4114: my $contents = shift;
4115:
4116: my $file = PasswordFilename($domain, $user);
4117: if (defined $file) {
4118: my $pf = IO::File->new(">$file");
4119: if($pf) {
4120: print $pf "$contents\n";
4121: return 1;
4122: } else {
4123: return 0;
4124: }
4125: } else {
4126: return 0;
4127: }
4128:
4129: }
1.78 foxr 4130: #
4131: # GetAuthType - Determines the authorization type of a user in a domain.
4132:
4133: # Returns the authorization type or nouser if there is no such user.
4134: #
1.178.2.4 albertel 4135: sub GetAuthType {
1.78 foxr 4136: my $domain = shift;
4137: my $user = shift;
4138:
1.79 foxr 4139: Debug("GetAuthType( $domain, $user ) \n");
1.178.2.8 foxr 4140: my $passwdfile = PasswordFilename($domain, $user);
4141: if( defined $passwdfile ) {
1.78 foxr 4142: my $pf = IO::File->new($passwdfile);
4143: my $realpassword = <$pf>;
4144: chomp($realpassword);
1.79 foxr 4145: Debug("Password info = $realpassword\n");
1.178.2.8 foxr 4146: return $realpassword;
1.178.2.4 albertel 4147: } else {
1.79 foxr 4148: Debug("Returning nouser");
1.78 foxr 4149: return "nouser";
4150: }
1.1 albertel 4151: }
4152:
1.178.2.13 foxr 4153: #
4154: # Validate a user given their domain, name and password. This utility
4155: # function is used by both AuthenticateHandler and ChangePasswordHandler
4156: # to validate the login credentials of a user.
4157: # Parameters:
4158: # $domain - The domain being logged into (this is required due to
4159: # the capability for multihomed systems.
4160: # $user - The name of the user being validated.
4161: # $password - The user's propoposed password.
4162: #
4163: # Returns:
4164: # 1 - The domain,user,pasword triplet corresponds to a valid
4165: # user.
4166: # 0 - The domain,user,password triplet is not a valid user.
4167: #
4168: sub ValidateUser {
4169: my $domain = shift;
4170: my $user = shift;
4171: my $password= shift;
4172:
4173: # Why negative ~pi you may well ask? Well this function is about
4174: # authentication, and therefore very important to get right.
4175: # I've initialized the flag that determines whether or not I've
4176: # validated correctly to a value it's not supposed to get.
4177: # At the end of this function. I'll ensure that it's not still that
4178: # value so we don't just wind up returning some accidental value
4179: # as a result of executing an unforseen code path that
4180: # did not set $validated.
4181:
4182: my $validated = -3.14159;
4183:
4184: # How we authenticate is determined by the type of authentication
4185: # the user has been assigned. If the authentication type is
4186: # "nouser", the user does not exist so we will return 0.
4187:
4188: my $contents = GetAuthType($domain, $user);
4189: my ($howpwd, $contentpwd) = split(/:/, $contents);
4190:
4191: my $null = pack("C",0); # Used by kerberos auth types.
4192:
4193: if ($howpwd ne 'nouser') {
4194:
4195: if($howpwd eq "internal") { # Encrypted is in local password file.
4196: $validated = (crypt($password, $contentpwd) eq $contentpwd);
4197: }
4198: elsif ($howpwd eq "unix") { # User is a normal unix user.
1.178.2.14 foxr 4199: $contentpwd = (getpwnam($user))[1];
1.178.2.13 foxr 4200: if($contentpwd) {
4201: if($contentpwd eq 'x') { # Shadow password file...
4202: my $pwauth_path = "/usr/local/sbin/pwauth";
4203: open PWAUTH, "|$pwauth_path" or
4204: die "Cannot invoke authentication";
4205: print PWAUTH "$user\n$password\n";
4206: close PWAUTH;
4207: $validated = ! $?;
4208:
4209: } else { # Passwords in /etc/passwd.
4210: $validated = (crypt($password,
4211: $contentpwd) eq $contentpwd);
4212: }
4213: } else {
4214: $validated = 0;
4215: }
4216: }
4217: elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
4218: if(! ($password =~ /$null/) ) {
4219: my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
4220: "",
4221: $contentpwd,,
4222: 'krbtgt',
4223: $contentpwd,
4224: 1,
4225: $password);
4226: if(!$k4error) {
4227: $validated = 1;
4228: }
4229: else {
4230: $validated = 0;
4231: &logthis('krb4: '.$user.', '.$contentpwd.', '.
4232: &Authen::Krb4::get_err_txt($Authen::Krb4::error));
4233: }
4234: }
4235: else {
4236: $validated = 0; # Password has a match with null.
4237: }
4238: }
4239: elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
4240: if(!($password =~ /$null/)) { # Null password not allowed.
4241: my $krbclient = &Authen::Krb5::parse_name($user.'@'
4242: .$contentpwd);
4243: my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
4244: my $krbserver = &Authen::Krb5::parse_name($krbservice);
4245: my $credentials= &Authen::Krb5::cc_default();
4246: $credentials->initialize($krbclient);
4247: my $krbreturn = &Authen::KRb5::get_in_tkt_with_password($krbclient,
4248: $krbserver,
4249: $password,
4250: $credentials);
4251: $validated = ($krbreturn == 1);
4252: }
4253: else {
4254: $validated = 0;
4255: }
4256: }
4257: elsif ($howpwd eq "localauth") {
4258: # Authenticate via installation specific authentcation method:
4259: $validated = &localauth::localauth($user,
4260: $password,
4261: $contentpwd);
4262: }
4263: else { # Unrecognized auth is also bad.
4264: $validated = 0;
4265: }
4266: } else {
4267: $validated = 0;
4268: }
4269: #
4270: # $validated has the correct stat of the authentication:
4271: #
4272:
4273: unless ($validated != -3.14159) {
4274: die "ValidateUser - failed to set the value of validated";
4275: }
4276: return $validated;
4277: }
4278:
4279: #
4280: # Add a line to the subscription list?
4281: #
1.84 albertel 4282: sub addline {
4283: my ($fname,$hostid,$ip,$newline)=@_;
4284: my $contents;
4285: my $found=0;
4286: my $expr='^'.$hostid.':'.$ip.':';
4287: $expr =~ s/\./\\\./g;
1.134 albertel 4288: my $sh;
1.84 albertel 4289: if ($sh=IO::File->new("$fname.subscription")) {
4290: while (my $subline=<$sh>) {
4291: if ($subline !~ /$expr/) {$contents.= $subline;} else {$found=1;}
4292: }
4293: $sh->close();
4294: }
4295: $sh=IO::File->new(">$fname.subscription");
4296: if ($contents) { print $sh $contents; }
4297: if ($newline) { print $sh $newline; }
4298: $sh->close();
4299: return $found;
1.86 www 4300: }
1.178.2.13 foxr 4301: #
4302: # Get chat messages.
4303: #
1.86 www 4304: sub getchat {
1.122 www 4305: my ($cdom,$cname,$udom,$uname)=@_;
1.87 www 4306: my %hash;
4307: my $proname=&propath($cdom,$cname);
4308: my @entries=();
1.88 albertel 4309: if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",
4310: &GDBM_READER(),0640)) {
4311: @entries=map { $_.':'.$hash{$_} } sort keys %hash;
4312: untie %hash;
1.123 www 4313: }
1.124 www 4314: my @participants=();
1.134 albertel 4315: my $cutoff=time-60;
1.123 www 4316: if (tie(%hash,'GDBM_File',"$proname/nohist_inchatroom.db",
1.124 www 4317: &GDBM_WRCREAT(),0640)) {
4318: $hash{$uname.':'.$udom}=time;
1.123 www 4319: foreach (sort keys %hash) {
4320: if ($hash{$_}>$cutoff) {
1.124 www 4321: $participants[$#participants+1]='active_participant:'.$_;
1.123 www 4322: }
4323: }
4324: untie %hash;
1.86 www 4325: }
1.124 www 4326: return (@participants,@entries);
1.86 www 4327: }
1.178.2.13 foxr 4328: #
4329: # Add a chat message
4330: #
1.86 www 4331: sub chatadd {
1.88 albertel 4332: my ($cdom,$cname,$newchat)=@_;
4333: my %hash;
4334: my $proname=&propath($cdom,$cname);
4335: my @entries=();
1.142 www 4336: my $time=time;
1.88 albertel 4337: if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",
4338: &GDBM_WRCREAT(),0640)) {
4339: @entries=map { $_.':'.$hash{$_} } sort keys %hash;
4340: my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
4341: my ($thentime,$idnum)=split(/\_/,$lastid);
4342: my $newid=$time.'_000000';
4343: if ($thentime==$time) {
4344: $idnum=~s/^0+//;
4345: $idnum++;
4346: $idnum=substr('000000'.$idnum,-6,6);
4347: $newid=$time.'_'.$idnum;
4348: }
4349: $hash{$newid}=$newchat;
4350: my $expired=$time-3600;
4351: foreach (keys %hash) {
4352: my ($thistime)=($_=~/(\d+)\_/);
4353: if ($thistime<$expired) {
1.89 www 4354: delete $hash{$_};
1.88 albertel 4355: }
4356: }
4357: untie %hash;
1.142 www 4358: }
4359: {
4360: my $hfh;
4361: if ($hfh=IO::File->new(">>$proname/chatroom.log")) {
4362: print $hfh "$time:".&unescape($newchat)."\n";
4363: }
1.86 www 4364: }
1.84 albertel 4365: }
4366:
4367: sub unsub {
4368: my ($fname,$clientip)=@_;
4369: my $result;
1.161 foxr 4370: if (unlink("$fname.$clientname")) {
1.84 albertel 4371: $result="ok\n";
4372: } else {
4373: $result="not_subscribed\n";
4374: }
4375: if (-e "$fname.subscription") {
1.161 foxr 4376: my $found=&addline($fname,$clientname,$clientip,'');
1.84 albertel 4377: if ($found) { $result="ok\n"; }
4378: } else {
4379: if ($result != "ok\n") { $result="not_subscribed\n"; }
4380: }
4381: return $result;
4382: }
4383:
1.101 www 4384: sub currentversion {
4385: my $fname=shift;
4386: my $version=-1;
4387: my $ulsdir='';
4388: if ($fname=~/^(.+)\/[^\/]+$/) {
1.178.2.4 albertel 4389: $ulsdir=$1;
1.101 www 4390: }
1.114 albertel 4391: my ($fnamere1,$fnamere2);
4392: # remove version if already specified
1.101 www 4393: $fname=~s/\.\d+\.(\w+(?:\.meta)*)$/\.$1/;
1.114 albertel 4394: # get the bits that go before and after the version number
4395: if ( $fname=~/^(.*\.)(\w+(?:\.meta)*)$/ ) {
4396: $fnamere1=$1;
4397: $fnamere2='.'.$2;
4398: }
1.101 www 4399: if (-e $fname) { $version=1; }
4400: if (-e $ulsdir) {
1.134 albertel 4401: if(-d $ulsdir) {
4402: if (opendir(LSDIR,$ulsdir)) {
4403: my $ulsfn;
4404: while ($ulsfn=readdir(LSDIR)) {
1.101 www 4405: # see if this is a regular file (ignore links produced earlier)
1.134 albertel 4406: my $thisfile=$ulsdir.'/'.$ulsfn;
4407: unless (-l $thisfile) {
1.160 www 4408: if ($thisfile=~/\Q$fnamere1\E(\d+)\Q$fnamere2\E$/) {
1.134 albertel 4409: if ($1>$version) { $version=$1; }
4410: }
4411: }
4412: }
4413: closedir(LSDIR);
4414: $version++;
4415: }
4416: }
4417: }
4418: return $version;
1.101 www 4419: }
4420:
4421: sub thisversion {
4422: my $fname=shift;
4423: my $version=-1;
4424: if ($fname=~/\.(\d+)\.\w+(?:\.meta)*$/) {
4425: $version=$1;
4426: }
4427: return $version;
4428: }
4429:
1.84 albertel 4430: sub subscribe {
4431: my ($userinput,$clientip)=@_;
4432: my $result;
4433: my ($cmd,$fname)=split(/:/,$userinput);
4434: my $ownership=&ishome($fname);
4435: if ($ownership eq 'owner') {
1.101 www 4436: # explitly asking for the current version?
4437: unless (-e $fname) {
4438: my $currentversion=¤tversion($fname);
4439: if (&thisversion($fname)==$currentversion) {
4440: if ($fname=~/^(.+)\.\d+\.(\w+(?:\.meta)*)$/) {
4441: my $root=$1;
4442: my $extension=$2;
4443: symlink($root.'.'.$extension,
4444: $root.'.'.$currentversion.'.'.$extension);
1.102 www 4445: unless ($extension=~/\.meta$/) {
1.178.2.4 albertel 4446: symlink($root.'.'.$extension.'.meta',
4447: $root.'.'.$currentversion.'.'.$extension.'.meta');
1.102 www 4448: }
1.101 www 4449: }
4450: }
4451: }
1.84 albertel 4452: if (-e $fname) {
4453: if (-d $fname) {
4454: $result="directory\n";
4455: } else {
1.161 foxr 4456: if (-e "$fname.$clientname") {&unsub($fname,$clientip);}
1.134 albertel 4457: my $now=time;
1.161 foxr 4458: my $found=&addline($fname,$clientname,$clientip,
4459: "$clientname:$clientip:$now\n");
1.84 albertel 4460: if ($found) { $result="$fname\n"; }
4461: # if they were subscribed to only meta data, delete that
4462: # subscription, when you subscribe to a file you also get
4463: # the metadata
4464: unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
4465: $fname=~s/\/home\/httpd\/html\/res/raw/;
4466: $fname="http://$thisserver/".$fname;
4467: $result="$fname\n";
4468: }
4469: } else {
4470: $result="not_found\n";
4471: }
4472: } else {
4473: $result="rejected\n";
4474: }
4475: return $result;
4476: }
1.91 albertel 4477:
4478: sub make_passwd_file {
1.98 foxr 4479: my ($uname, $umode,$npass,$passfilename)=@_;
1.91 albertel 4480: my $result="ok\n";
4481: if ($umode eq 'krb4' or $umode eq 'krb5') {
4482: {
4483: my $pf = IO::File->new(">$passfilename");
4484: print $pf "$umode:$npass\n";
4485: }
4486: } elsif ($umode eq 'internal') {
4487: my $salt=time;
4488: $salt=substr($salt,6,2);
4489: my $ncpass=crypt($npass,$salt);
4490: {
4491: &Debug("Creating internal auth");
4492: my $pf = IO::File->new(">$passfilename");
4493: print $pf "internal:$ncpass\n";
4494: }
4495: } elsif ($umode eq 'localauth') {
4496: {
4497: my $pf = IO::File->new(">$passfilename");
4498: print $pf "localauth:$npass\n";
4499: }
4500: } elsif ($umode eq 'unix') {
1.178.2.14 foxr 4501: #
4502: # Don't allow the creation of privileged accounts!!! that would
4503: # be real bad!!!
4504: #
4505: my $uid = getpwnam($uname);
4506: if((defined $uid) && ($uid == 0)) {
1.178.2.15 foxr 4507: &logthis(">>>Attempted add of privileged account blocked<<<");
1.178.2.14 foxr 4508: return "no_priv_account_error\n";
1.91 albertel 4509: }
1.178.2.14 foxr 4510:
4511: #
4512: my $execpath="$perlvar{'lonDaemons'}/"."lcuseradd";
4513:
4514: &Debug("Executing external: ".$execpath);
4515: &Debug("user = ".$uname.", Password =". $npass);
4516: my $se = IO::File->new("|$execpath > $perlvar{'lonDaemons'}/logs/lcuseradd.log");
4517: print $se "$uname\n";
4518: print $se "$npass\n";
4519: print $se "$npass\n";
4520:
4521: my $useraddok = $?;
4522: if($useraddok > 0) {
1.178.2.16 foxr 4523: my $lcstring = lcuseraddstrerror($useraddok);
4524: &logthis("Failed lcuseradd: $lcstring");
4525: return "error: lcuseradd failed: $lcstring\n";
1.178.2.14 foxr 4526: }
4527: my $pf = IO::File->new(">$passfilename");
4528: print $pf "unix:\n";
4529:
1.91 albertel 4530: } elsif ($umode eq 'none') {
4531: {
4532: my $pf = IO::File->new(">$passfilename");
4533: print $pf "none:\n";
4534: }
4535: } else {
4536: $result="auth_mode_error\n";
4537: }
4538: return $result;
1.121 albertel 4539: }
4540:
4541: sub sethost {
4542: my ($remotereq) = @_;
1.178.2.19! foxr 4543: Debug("sethost got $remotereq");
1.121 albertel 4544: my (undef,$hostid)=split(/:/,$remotereq);
4545: if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
1.178.2.19! foxr 4546: Debug("sethost attempting to set host $hostid");
1.121 albertel 4547: if ($hostip{$perlvar{'lonHostID'}} eq $hostip{$hostid}) {
4548: $currenthostid=$hostid;
4549: $currentdomainid=$hostdom{$hostid};
4550: &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
4551: } else {
4552: &logthis("Requested host id $hostid not an alias of ".
4553: $perlvar{'lonHostID'}." refusing connection");
4554: return 'unable_to_set';
4555: }
4556: return 'ok';
4557: }
4558:
4559: sub version {
4560: my ($userinput)=@_;
4561: $remoteVERSION=(split(/:/,$userinput))[1];
4562: return "version:$VERSION";
1.127 albertel 4563: }
1.178.2.1 foxr 4564: ############## >>>>>>>>>>>>>>>>>>>>>>>>>> FUTUREWORK <<<<<<<<<<<<<<<<<<<<<<<<<<<<
1.128 albertel 4565: #There is a copy of this in lonnet.pm
1.178.2.1 foxr 4566: # Can we hoist these lil' things out into common places?
4567: #
1.127 albertel 4568: sub userload {
4569: my $numusers=0;
4570: {
4571: opendir(LONIDS,$perlvar{'lonIDsDir'});
4572: my $filename;
4573: my $curtime=time;
4574: while ($filename=readdir(LONIDS)) {
4575: if ($filename eq '.' || $filename eq '..') {next;}
1.138 albertel 4576: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.159 albertel 4577: if ($curtime-$mtime < 1800) { $numusers++; }
1.127 albertel 4578: }
4579: closedir(LONIDS);
4580: }
4581: my $userloadpercent=0;
4582: my $maxuserload=$perlvar{'lonUserLoadLim'};
4583: if ($maxuserload) {
1.129 albertel 4584: $userloadpercent=100*$numusers/$maxuserload;
1.127 albertel 4585: }
1.130 albertel 4586: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.127 albertel 4587: return $userloadpercent;
1.91 albertel 4588: }
4589:
1.61 harris41 4590: # ----------------------------------- POD (plain old documentation, CPAN style)
4591:
4592: =head1 NAME
4593:
4594: lond - "LON Daemon" Server (port "LOND" 5663)
4595:
4596: =head1 SYNOPSIS
4597:
1.74 harris41 4598: Usage: B<lond>
4599:
4600: Should only be run as user=www. This is a command-line script which
4601: is invoked by B<loncron>. There is no expectation that a typical user
4602: will manually start B<lond> from the command-line. (In other words,
4603: DO NOT START B<lond> YOURSELF.)
1.61 harris41 4604:
4605: =head1 DESCRIPTION
4606:
1.74 harris41 4607: There are two characteristics associated with the running of B<lond>,
4608: PROCESS MANAGEMENT (starting, stopping, handling child processes)
4609: and SERVER-SIDE ACTIVITIES (password authentication, user creation,
4610: subscriptions, etc). These are described in two large
4611: sections below.
4612:
4613: B<PROCESS MANAGEMENT>
4614:
1.61 harris41 4615: Preforker - server who forks first. Runs as a daemon. HUPs.
4616: Uses IDEA encryption
4617:
1.74 harris41 4618: B<lond> forks off children processes that correspond to the other servers
4619: in the network. Management of these processes can be done at the
4620: parent process level or the child process level.
4621:
4622: B<logs/lond.log> is the location of log messages.
4623:
4624: The process management is now explained in terms of linux shell commands,
4625: subroutines internal to this code, and signal assignments:
4626:
4627: =over 4
4628:
4629: =item *
4630:
4631: PID is stored in B<logs/lond.pid>
4632:
4633: This is the process id number of the parent B<lond> process.
4634:
4635: =item *
4636:
4637: SIGTERM and SIGINT
4638:
4639: Parent signal assignment:
4640: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
4641:
4642: Child signal assignment:
4643: $SIG{INT} = 'DEFAULT'; (and SIGTERM is DEFAULT also)
4644: (The child dies and a SIGALRM is sent to parent, awaking parent from slumber
4645: to restart a new child.)
4646:
4647: Command-line invocations:
4648: B<kill> B<-s> SIGTERM I<PID>
4649: B<kill> B<-s> SIGINT I<PID>
4650:
4651: Subroutine B<HUNTSMAN>:
4652: This is only invoked for the B<lond> parent I<PID>.
4653: This kills all the children, and then the parent.
4654: The B<lonc.pid> file is cleared.
4655:
4656: =item *
4657:
4658: SIGHUP
4659:
4660: Current bug:
4661: This signal can only be processed the first time
4662: on the parent process. Subsequent SIGHUP signals
4663: have no effect.
4664:
4665: Parent signal assignment:
4666: $SIG{HUP} = \&HUPSMAN;
4667:
4668: Child signal assignment:
4669: none (nothing happens)
4670:
4671: Command-line invocations:
4672: B<kill> B<-s> SIGHUP I<PID>
4673:
4674: Subroutine B<HUPSMAN>:
4675: This is only invoked for the B<lond> parent I<PID>,
4676: This kills all the children, and then the parent.
4677: The B<lond.pid> file is cleared.
4678:
4679: =item *
4680:
4681: SIGUSR1
4682:
4683: Parent signal assignment:
4684: $SIG{USR1} = \&USRMAN;
4685:
4686: Child signal assignment:
4687: $SIG{USR1}= \&logstatus;
4688:
4689: Command-line invocations:
4690: B<kill> B<-s> SIGUSR1 I<PID>
4691:
4692: Subroutine B<USRMAN>:
4693: When invoked for the B<lond> parent I<PID>,
4694: SIGUSR1 is sent to all the children, and the status of
4695: each connection is logged.
1.144 foxr 4696:
4697: =item *
4698:
4699: SIGUSR2
4700:
4701: Parent Signal assignment:
4702: $SIG{USR2} = \&UpdateHosts
4703:
4704: Child signal assignment:
4705: NONE
4706:
1.74 harris41 4707:
4708: =item *
4709:
4710: SIGCHLD
4711:
4712: Parent signal assignment:
4713: $SIG{CHLD} = \&REAPER;
4714:
4715: Child signal assignment:
4716: none
4717:
4718: Command-line invocations:
4719: B<kill> B<-s> SIGCHLD I<PID>
4720:
4721: Subroutine B<REAPER>:
4722: This is only invoked for the B<lond> parent I<PID>.
4723: Information pertaining to the child is removed.
4724: The socket port is cleaned up.
4725:
4726: =back
4727:
4728: B<SERVER-SIDE ACTIVITIES>
4729:
4730: Server-side information can be accepted in an encrypted or non-encrypted
4731: method.
4732:
4733: =over 4
4734:
4735: =item ping
4736:
4737: Query a client in the hosts.tab table; "Are you there?"
4738:
4739: =item pong
4740:
4741: Respond to a ping query.
4742:
4743: =item ekey
4744:
4745: Read in encrypted key, make cipher. Respond with a buildkey.
4746:
4747: =item load
4748:
4749: Respond with CPU load based on a computation upon /proc/loadavg.
4750:
4751: =item currentauth
4752:
4753: Reply with current authentication information (only over an
4754: encrypted channel).
4755:
4756: =item auth
4757:
4758: Only over an encrypted channel, reply as to whether a user's
4759: authentication information can be validated.
4760:
4761: =item passwd
4762:
4763: Allow for a password to be set.
4764:
4765: =item makeuser
4766:
4767: Make a user.
4768:
4769: =item passwd
4770:
4771: Allow for authentication mechanism and password to be changed.
4772:
4773: =item home
1.61 harris41 4774:
1.74 harris41 4775: Respond to a question "are you the home for a given user?"
4776:
4777: =item update
4778:
4779: Update contents of a subscribed resource.
4780:
4781: =item unsubscribe
4782:
4783: The server is unsubscribing from a resource.
4784:
4785: =item subscribe
4786:
4787: The server is subscribing to a resource.
4788:
4789: =item log
4790:
4791: Place in B<logs/lond.log>
4792:
4793: =item put
4794:
4795: stores hash in namespace
4796:
4797: =item rolesput
4798:
4799: put a role into a user's environment
4800:
4801: =item get
4802:
4803: returns hash with keys from array
4804: reference filled in from namespace
4805:
4806: =item eget
4807:
4808: returns hash with keys from array
4809: reference filled in from namesp (encrypts the return communication)
4810:
4811: =item rolesget
4812:
4813: get a role from a user's environment
4814:
4815: =item del
4816:
4817: deletes keys out of array from namespace
4818:
4819: =item keys
4820:
4821: returns namespace keys
4822:
4823: =item dump
4824:
4825: dumps the complete (or key matching regexp) namespace into a hash
4826:
4827: =item store
4828:
4829: stores hash permanently
4830: for this url; hashref needs to be given and should be a \%hashname; the
4831: remaining args aren't required and if they aren't passed or are '' they will
4832: be derived from the ENV
4833:
4834: =item restore
4835:
4836: returns a hash for a given url
4837:
4838: =item querysend
4839:
4840: Tells client about the lonsql process that has been launched in response
4841: to a sent query.
4842:
4843: =item queryreply
4844:
4845: Accept information from lonsql and make appropriate storage in temporary
4846: file space.
4847:
4848: =item idput
4849:
4850: Defines usernames as corresponding to IDs. (These "IDs" are unique identifiers
4851: for each student, defined perhaps by the institutional Registrar.)
4852:
4853: =item idget
4854:
4855: Returns usernames corresponding to IDs. (These "IDs" are unique identifiers
4856: for each student, defined perhaps by the institutional Registrar.)
4857:
4858: =item tmpput
4859:
4860: Accept and store information in temporary space.
4861:
4862: =item tmpget
4863:
4864: Send along temporarily stored information.
4865:
4866: =item ls
4867:
4868: List part of a user's directory.
4869:
1.135 foxr 4870: =item pushtable
4871:
4872: Pushes a file in /home/httpd/lonTab directory. Currently limited to:
4873: hosts.tab and domain.tab. The old file is copied to *.tab.backup but
4874: must be restored manually in case of a problem with the new table file.
4875: pushtable requires that the request be encrypted and validated via
4876: ValidateManager. The form of the command is:
4877: enc:pushtable tablename <tablecontents> \n
4878: where pushtable, tablename and <tablecontents> will be encrypted, but \n is a
4879: cleartext newline.
4880:
1.74 harris41 4881: =item Hanging up (exit or init)
4882:
4883: What to do when a client tells the server that they (the client)
4884: are leaving the network.
4885:
4886: =item unknown command
4887:
4888: If B<lond> is sent an unknown command (not in the list above),
4889: it replys to the client "unknown_cmd".
1.135 foxr 4890:
1.74 harris41 4891:
4892: =item UNKNOWN CLIENT
4893:
4894: If the anti-spoofing algorithm cannot verify the client,
4895: the client is rejected (with a "refused" message sent
4896: to the client, and the connection is closed.
4897:
4898: =back
1.61 harris41 4899:
4900: =head1 PREREQUISITES
4901:
4902: IO::Socket
4903: IO::File
4904: Apache::File
4905: Symbol
4906: POSIX
4907: Crypt::IDEA
4908: LWP::UserAgent()
4909: GDBM_File
4910: Authen::Krb4
1.91 albertel 4911: Authen::Krb5
1.61 harris41 4912:
4913: =head1 COREQUISITES
4914:
4915: =head1 OSNAMES
4916:
4917: linux
4918:
4919: =head1 SCRIPT CATEGORIES
4920:
4921: Server/Process
4922:
4923: =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