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