--- loncom/lond 2004/02/24 16:51:40 1.178.2.4
+++ loncom/lond 2004/08/18 11:31:50 1.232
@@ -2,7 +2,7 @@
# The LearningOnline Network
# lond "LON Daemon" Server (port "LOND" 5663)
#
-# $Id: lond,v 1.178.2.4 2004/02/24 16:51:40 albertel Exp $
+# $Id: lond,v 1.232 2004/08/18 11:31:50 foxr Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -20,7 +20,7 @@
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
@@ -45,28 +45,35 @@ use Authen::Krb4;
use Authen::Krb5;
use lib '/home/httpd/lib/perl/';
use localauth;
+use localenroll;
use File::Copy;
use LONCAPA::ConfigFileEdit;
+use LONCAPA::lonlocal;
+use LONCAPA::lonssl;
+use Fcntl qw(:flock);
my $DEBUG = 1; # Non zero to enable debug log entries.
my $status='';
my $lastlog='';
-my $VERSION='$Revision: 1.178.2.4 $'; #' stupid emacs
+my $VERSION='$Revision: 1.232 $'; #' stupid emacs
my $remoteVERSION;
-my $currenthostid;
+my $currenthostid="default";
my $currentdomainid;
my $client;
-my $clientip;
-my $clientname;
-
-my $cipher; # Cipher key negotiated with client.
-my $tmpsnum = 0;; # Id of tmpputs.
+my $clientip; # IP address of client.
+my $clientdns; # DNS name of client.
+my $clientname; # LonCAPA name of client.
my $server;
-my $thisserver;
+my $thisserver; # DNS of us.
+
+my $keymode;
+
+my $cipher; # Cipher key negotiated with client
+my $tmpsnum = 0; # Id of tmpputs.
#
# Connection type is:
@@ -77,9 +84,10 @@ my $thisserver;
my $ConnectionType;
-my %hostid;
-my %hostdom;
-my %hostip;
+my %hostid; # ID's for hosts in cluster by ip.
+my %hostdom; # LonCAPA domain for hosts in cluster.
+my %hostip; # IPs for hosts in cluster.
+my %hostdns; # ID's of hosts looked up by DNS name.
my %managers; # Ip -> manager names
@@ -98,6 +106,7 @@ my $CLIENT_OK = 1;
my $MANAGER_OK = 2;
my %Dispatcher;
+
#
# The array below are password error strings."
#
@@ -113,8 +122,10 @@ my @passwderrors = ("ok",
"lcpasswd Cannot set new passwd.",
"lcpasswd Username has invalid characters",
"lcpasswd Invalid characters in password",
- "11", "12",
- "lcpasswd Password mismatch");
+ "lcpasswd User already exists",
+ "lcpasswd Something went wrong with user addition.",
+ "lcpasswd Password mismatch",
+ "lcpasswd Error filename is invalid");
# The array below are lcuseradd error strings.:
@@ -135,11 +146,13 @@ my @adderrors = ("ok",
"lcuseradd Could not add user.",
"lcuseradd Password mismatch");
+
+
#
# Statistics that are maintained and dislayed in the status line.
#
-my $Transactions; # Number of attempted transactions.
-my $Failures; # Number of transcations failed.
+my $Transactions = 0; # Number of attempted transactions.
+my $Failures = 0; # Number of transcations failed.
# ResetStatistics:
# Resets the statistics counters:
@@ -149,6 +162,193 @@ sub ResetStatistics {
$Failures = 0;
}
+#------------------------------------------------------------------------
+#
+# LocalConnection
+# Completes the formation of a locally authenticated connection.
+# This function will ensure that the 'remote' client is really the
+# local host. If not, the connection is closed, and the function fails.
+# If so, initcmd is parsed for the name of a file containing the
+# IDEA session key. The fie is opened, read, deleted and the session
+# key returned to the caller.
+#
+# Parameters:
+# $Socket - Socket open on client.
+# $initcmd - The full text of the init command.
+#
+# Implicit inputs:
+# $clientdns - The DNS name of the remote client.
+# $thisserver - Our DNS name.
+#
+# Returns:
+# IDEA session key on success.
+# undef on failure.
+#
+sub LocalConnection {
+ my ($Socket, $initcmd) = @_;
+ Debug("Attempting local connection: $initcmd client: $clientdns me: $thisserver");
+ if($clientdns ne $thisserver) {
+ &logthis(' LocalConnection rejecting non local: '
+ ."$clientdns ne $thisserver ");
+ close $Socket;
+ return undef;
+ } else {
+ chomp($initcmd); # Get rid of \n in filename.
+ my ($init, $type, $name) = split(/:/, $initcmd);
+ Debug(" Init command: $init $type $name ");
+
+ # Require that $init = init, and $type = local: Otherwise
+ # the caller is insane:
+
+ if(($init ne "init") && ($type ne "local")) {
+ &logthis(' LocalConnection: caller is insane! '
+ ."init = $init, and type = $type ");
+ close($Socket);;
+ return undef;
+
+ }
+ # Now get the key filename:
+
+ my $IDEAKey = lonlocal::ReadKeyFile($name);
+ return $IDEAKey;
+ }
+}
+#------------------------------------------------------------------------------
+#
+# SSLConnection
+# Completes the formation of an ssh authenticated connection. The
+# socket is promoted to an ssl socket. If this promotion and the associated
+# certificate exchange are successful, the IDEA key is generated and sent
+# to the remote peer via the SSL tunnel. The IDEA key is also returned to
+# the caller after the SSL tunnel is torn down.
+#
+# Parameters:
+# Name Type Purpose
+# $Socket IO::Socket::INET Plaintext socket.
+#
+# Returns:
+# IDEA key on success.
+# undef on failure.
+#
+sub SSLConnection {
+ my $Socket = shift;
+
+ Debug("SSLConnection: ");
+ my $KeyFile = lonssl::KeyFile();
+ if(!$KeyFile) {
+ my $err = lonssl::LastError();
+ &logthis(" CRITICAL"
+ ."Can't get key file $err ");
+ return undef;
+ }
+ my ($CACertificate,
+ $Certificate) = lonssl::CertificateFile();
+
+
+ # If any of the key, certificate or certificate authority
+ # certificate filenames are not defined, this can't work.
+
+ if((!$Certificate) || (!$CACertificate)) {
+ my $err = lonssl::LastError();
+ &logthis(" CRITICAL"
+ ."Can't get certificates: $err ");
+
+ return undef;
+ }
+ Debug("Key: $KeyFile CA: $CACertificate Cert: $Certificate");
+
+ # Indicate to our peer that we can procede with
+ # a transition to ssl authentication:
+
+ print $Socket "ok:ssl\n";
+
+ Debug("Approving promotion -> ssl");
+ # And do so:
+
+ my $SSLSocket = lonssl::PromoteServerSocket($Socket,
+ $CACertificate,
+ $Certificate,
+ $KeyFile);
+ if(! ($SSLSocket) ) { # SSL socket promotion failed.
+ my $err = lonssl::LastError();
+ &logthis(" CRITICAL "
+ ."SSL Socket promotion failed: $err ");
+ return undef;
+ }
+ Debug("SSL Promotion successful");
+
+ #
+ # The only thing we'll use the socket for is to send the IDEA key
+ # to the peer:
+
+ my $Key = lonlocal::CreateCipherKey();
+ print $SSLSocket "$Key\n";
+
+ lonssl::Close($SSLSocket);
+
+ Debug("Key exchange complete: $Key");
+
+ return $Key;
+}
+#
+# InsecureConnection:
+# If insecure connections are allowd,
+# exchange a challenge with the client to 'validate' the
+# client (not really, but that's the protocol):
+# We produce a challenge string that's sent to the client.
+# The client must then echo the challenge verbatim to us.
+#
+# Parameter:
+# Socket - Socket open on the client.
+# Returns:
+# 1 - success.
+# 0 - failure (e.g.mismatch or insecure not allowed).
+#
+sub InsecureConnection {
+ my $Socket = shift;
+
+ # Don't even start if insecure connections are not allowed.
+
+ if(! $perlvar{londAllowInsecure}) { # Insecure connections not allowed.
+ return 0;
+ }
+
+ # Fabricate a challenge string and send it..
+
+ my $challenge = "$$".time; # pid + time.
+ print $Socket "$challenge\n";
+ &status("Waiting for challenge reply");
+
+ my $answer = <$Socket>;
+ $answer =~s/\W//g;
+ if($challenge eq $answer) {
+ return 1;
+ } else {
+ logthis("WARNING client did not respond to challenge");
+ &status("No challenge reqply");
+ return 0;
+ }
+
+
+}
+
+#
+# GetCertificate: Given a transaction that requires a certificate,
+# this function will extract the certificate from the transaction
+# request. Note that at this point, the only concept of a certificate
+# is the hostname to which we are connected.
+#
+# Parameter:
+# request - The request sent by our client (this parameterization may
+# need to change when we really use a certificate granting
+# authority.
+#
+sub GetCertificate {
+ my $request = shift;
+
+ return $clientip;
+}
+
#
# Return true if client is a manager.
#
@@ -164,110 +364,680 @@ sub isClient {
#
-# Get a Request:
-# Gets a Request message from the client. The transaction
-# is defined as a 'line' of text. We remove the new line
-# from the text line.
-#
-sub GetRequest {
- my $input = <$client>;
- chomp($input);
+# ReadManagerTable: Reads in the current manager table. For now this is
+# done on each manager authentication because:
+# - These authentications are not frequent
+# - This allows dynamic changes to the manager table
+# without the need to signal to the lond.
+#
+sub ReadManagerTable {
- Debug("Request = $input\n");
+ # Clean out the old table first..
- &status('Processing '.$clientname.':'.$input);
+ foreach my $key (keys %managers) {
+ delete $managers{$key};
+ }
+
+ my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
+ if (!open (MANAGERS, $tablename)) {
+ logthis('No manager table. Nobody can manage!!');
+ return;
+ }
+ while(my $host = ) {
+ chomp($host);
+ if ($host =~ "^#") { # Comment line.
+ next;
+ }
+ if (!defined $hostip{$host}) { # This is a non cluster member
+ # The entry is of the form:
+ # cluname:hostname
+ # cluname - A 'cluster hostname' is needed in order to negotiate
+ # the host key.
+ # hostname- The dns name of the host.
+ #
+ my($cluname, $dnsname) = split(/:/, $host);
+
+ my $ip = gethostbyname($dnsname);
+ if(defined($ip)) { # bad names don't deserve entry.
+ my $hostip = inet_ntoa($ip);
+ $managers{$hostip} = $cluname;
+ logthis(' registering manager '.
+ "$dnsname as $cluname with $hostip \n");
+ }
+ } else {
+ logthis(' existing host'." $host\n");
+ $managers{$hostip{$host}} = $host; # Use info from cluster tab if clumemeber
+ }
+ }
+}
- return $input;
+#
+# ValidManager: Determines if a given certificate represents a valid manager.
+# in this primitive implementation, the 'certificate' is
+# just the connecting loncapa client name. This is checked
+# against a valid client list in the configuration.
+#
+#
+sub ValidManager {
+ my $certificate = shift;
+
+ return isManager;
}
#
-# Decipher encoded traffic
+# CopyFile: Called as part of the process of installing a
+# new configuration file. This function copies an existing
+# file to a backup file.
+# Parameters:
+# oldfile - Name of the file to backup.
+# newfile - Name of the backup file.
+# Return:
+# 0 - Failure (errno has failure reason).
+# 1 - Success.
+#
+sub CopyFile {
+
+ my ($oldfile, $newfile) = @_;
+
+ # The file must exist:
+
+ if(-e $oldfile) {
+
+ # Read the old file.
+
+ my $oldfh = IO::File->new("< $oldfile");
+ if(!$oldfh) {
+ return 0;
+ }
+ my @contents = <$oldfh>; # Suck in the entire file.
+
+ # write the backup file:
+
+ my $newfh = IO::File->new("> $newfile");
+ if(!(defined $newfh)){
+ return 0;
+ }
+ my $lines = scalar @contents;
+ for (my $i =0; $i < $lines; $i++) {
+ print $newfh ($contents[$i]);
+ }
+
+ $oldfh->close;
+ $newfh->close;
+
+ chmod(0660, $newfile);
+
+ return 1;
+
+ } else {
+ return 0;
+ }
+}
+#
+# Host files are passed out with externally visible host IPs.
+# If, for example, we are behind a fire-wall or NAT host, our
+# internally visible IP may be different than the externally
+# visible IP. Therefore, we always adjust the contents of the
+# host file so that the entry for ME is the IP that we believe
+# we have. At present, this is defined as the entry that
+# DNS has for us. If by some chance we are not able to get a
+# DNS translation for us, then we assume that the host.tab file
+# is correct.
+# BUGBUGBUG - in the future, we really should see if we can
+# easily query the interface(s) instead.
+# Parameter(s):
+# contents - The contents of the host.tab to check.
+# Returns:
+# newcontents - The adjusted contents.
+#
+#
+sub AdjustHostContents {
+ my $contents = shift;
+ my $adjusted;
+ my $me = $perlvar{'lonHostID'};
+
+ foreach my $line (split(/\n/,$contents)) {
+ if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {
+ chomp($line);
+ my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
+ if ($id eq $me) {
+ my $ip = gethostbyname($name);
+ my $ipnew = inet_ntoa($ip);
+ $ip = $ipnew;
+ # Reconstruct the host line and append to adjusted:
+
+ my $newline = "$id:$domain:$role:$name:$ip";
+ if($maxcon ne "") { # Not all hosts have loncnew tuning params
+ $newline .= ":$maxcon:$idleto:$mincon";
+ }
+ $adjusted .= $newline."\n";
+
+ } else { # Not me, pass unmodified.
+ $adjusted .= $line."\n";
+ }
+ } else { # Blank or comment never re-written.
+ $adjusted .= $line."\n"; # Pass blanks and comments as is.
+ }
+ }
+ return $adjusted;
+}
+#
+# InstallFile: Called to install an administrative file:
+# - The file is created with .tmp
+# - The .tmp file is then mv'd to
+# This lugubrious procedure is done to ensure that we are never without
+# a valid, even if dated, version of the file regardless of who crashes
+# and when the crash occurs.
+#
# Parameters:
-# input - Encoded data.
+# Name of the file
+# File Contents.
+# Return:
+# nonzero - success.
+# 0 - failure and $! has an errno.
+#
+sub InstallFile {
+
+ my ($Filename, $Contents) = @_;
+ my $TempFile = $Filename.".tmp";
+
+ # Open the file for write:
+
+ my $fh = IO::File->new("> $TempFile"); # Write to temp.
+ if(!(defined $fh)) {
+ &logthis(' Unable to create '.$TempFile."");
+ return 0;
+ }
+ # write the contents of the file:
+
+ print $fh ($Contents);
+ $fh->close; # In case we ever have a filesystem w. locking
+
+ chmod(0660, $TempFile);
+
+ # Now we can move install the file in position.
+
+ move($TempFile, $Filename);
+
+ return 1;
+}
+
+
+#
+# ConfigFileFromSelector: converts a configuration file selector
+# (one of host or domain at this point) into a
+# configuration file pathname.
+#
+# Parameters:
+# selector - Configuration file selector.
# Returns:
-# Decoded data or undef if encryption key was not yet negotiated.
-# Implicit input:
-# cipher - This global holds the negotiated encryption key.
+# Full path to the file or undef if the selector is invalid.
#
-sub Decipher {
- my $input = shift;
- my $output = '';
-
-
- if($cipher) {
- my($enc, $enclength, $encinput) = split(/:/, $input);
- for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
- $output .=
- $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
- }
- return substr($output, 0, $enclength);
+sub ConfigFileFromSelector {
+ my $selector = shift;
+ my $tablefile;
+
+ my $tabledir = $perlvar{'lonTabDir'}.'/';
+ if ($selector eq "hosts") {
+ $tablefile = $tabledir."hosts.tab";
+ } elsif ($selector eq "domain") {
+ $tablefile = $tabledir."domain.tab";
} else {
return undef;
}
+ return $tablefile;
+
+}
+#
+# PushFile: Called to do an administrative push of a file.
+# - Ensure the file being pushed is one we support.
+# - Backup the old file to
+# - Separate the contents of the new file out from the
+# rest of the request.
+# - Write the new file.
+# Parameter:
+# Request - The entire user request. This consists of a : separated
+# string pushfile:tablename:contents.
+# NOTE: The contents may have :'s in it as well making things a bit
+# more interesting... but not much.
+# Returns:
+# String to send to client ("ok" or "refused" if bad file).
+#
+sub PushFile {
+ my $request = shift;
+ my ($command, $filename, $contents) = split(":", $request, 3);
+
+ # At this point in time, pushes for only the following tables are
+ # supported:
+ # hosts.tab ($filename eq host).
+ # domain.tab ($filename eq domain).
+ # Construct the destination filename or reject the request.
+ #
+ # lonManage is supposed to ensure this, however this session could be
+ # part of some elaborate spoof that managed somehow to authenticate.
+ #
+
+
+ my $tablefile = ConfigFileFromSelector($filename);
+ if(! (defined $tablefile)) {
+ return "refused";
+ }
+ #
+ # >copy< the old table to the backup table
+ # don't rename in case system crashes/reboots etc. in the time
+ # window between a rename and write.
+ #
+ my $backupfile = $tablefile;
+ $backupfile =~ s/\.tab$/.old/;
+ if(!CopyFile($tablefile, $backupfile)) {
+ &logthis(' CopyFile from '.$tablefile." to ".$backupfile." failed ");
+ return "error:$!";
+ }
+ &logthis(' Pushfile: backed up '
+ .$tablefile." to $backupfile");
+
+ # If the file being pushed is the host file, we adjust the entry for ourself so that the
+ # IP will be our current IP as looked up in dns. Note this is only 99% good as it's possible
+ # to conceive of conditions where we don't have a DNS entry locally. This is possible in a
+ # network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
+ # that possibilty.
+
+ if($filename eq "host") {
+ $contents = AdjustHostContents($contents);
+ }
+
+ # Install the new file:
+
+ if(!InstallFile($tablefile, $contents)) {
+ &logthis(' Pushfile: unable to install '
+ .$tablefile." $! ");
+ return "error:$!";
+ } else {
+ &logthis(' Installed new '.$tablefile
+ ."");
+
+ }
+
+
+ # Indicate success:
+
+ return "ok";
+
}
#
-# Register a command processor. This function is invoked to register a sub
-# to process a request. Once registered, the ProcessRequest sub can automatically
-# dispatch requests to an appropriate sub, and do the top level validity checking
-# as well:
-# - Is the keyword recognized.
-# - Is the proper client type attempting the request.
-# - Is the request encrypted if it has to be.
+# Called to re-init either lonc or lond.
+#
+# Parameters:
+# request - The full request by the client. This is of the form
+# reinit:
+# where is allowed to be either of
+# lonc or lond
+#
+# Returns:
+# The string to be sent back to the client either:
+# ok - Everything worked just fine.
+# error:why - There was a failure and why describes the reason.
+#
+#
+sub ReinitProcess {
+ my $request = shift;
+
+
+ # separate the request (reinit) from the process identifier and
+ # validate it producing the name of the .pid file for the process.
+ #
+ #
+ my ($junk, $process) = split(":", $request);
+ my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
+ if($process eq 'lonc') {
+ $processpidfile = $processpidfile."lonc.pid";
+ if (!open(PIDFILE, "< $processpidfile")) {
+ return "error:Open failed for $processpidfile";
+ }
+ my $loncpid = ;
+ close(PIDFILE);
+ logthis(' Reinitializing lonc pid='.$loncpid
+ ."");
+ kill("USR2", $loncpid);
+ } elsif ($process eq 'lond') {
+ logthis(' Reinitializing self (lond) ');
+ &UpdateHosts; # Lond is us!!
+ } else {
+ &logthis('");
+ return "error:Invalid process identifier $process";
+ }
+ return 'ok';
+}
+# Validate a line in a configuration file edit script:
+# Validation includes:
+# - Ensuring the command is valid.
+# - Ensuring the command has sufficient parameters
# Parameters:
-# $RequestName - Name of the request being registered.
-# This is the command request that will match
-# against the hash keywords to lookup the information
-# associated with the dispatch information.
-# $Procedure - Reference to a sub to call to process the request.
-# All subs get called as follows:
-# Procedure($cmd, $tail, $replyfd, $key)
-# $cmd - the actual keyword that invoked us.
-# $tail - the tail of the request that invoked us.
-# $replyfd- File descriptor connected to the client
-# $MustEncode - True if the request must be encoded to be good.
-# $ClientOk - True if it's ok for a client to request this.
-# $ManagerOk - True if it's ok for a manager to request this.
-# Side effects:
-# - On success, the Dispatcher hash has an entry added for the key $RequestName
-# - On failure, the program will die as it's a bad internal bug to try to
-# register a duplicate command handler.
+# scriptline - A line to validate (\n has been stripped for what it's worth).
#
-sub RegisterHandler {
- my $RequestName = shift;
- my $Procedure = shift;
- my $MustEncode = shift;
- my $ClientOk = shift;
- my $ManagerOk = shift;
-
- # Don't allow duplication#
-
- if (defined $Dispatcher{$RequestName}) {
- die "Attempting to define a duplicate request handler for $RequestName\n";
+# Return:
+# 0 - Invalid scriptline.
+# 1 - Valid scriptline
+# NOTE:
+# Only the command syntax is checked, not the executability of the
+# command.
+#
+sub isValidEditCommand {
+ my $scriptline = shift;
+
+ # Line elements are pipe separated:
+
+ my ($command, $key, $newline) = split(/\|/, $scriptline);
+ &logthis(' isValideditCommand checking: '.
+ "Command = '$command', Key = '$key', Newline = '$newline' \n");
+
+ if ($command eq "delete") {
+ #
+ # key with no newline.
+ #
+ if( ($key eq "") || ($newline ne "")) {
+ return 0; # Must have key but no newline.
+ } else {
+ return 1; # Valid syntax.
+ }
+ } elsif ($command eq "replace") {
+ #
+ # key and newline:
+ #
+ if (($key eq "") || ($newline eq "")) {
+ return 0;
+ } else {
+ return 1;
+ }
+ } elsif ($command eq "append") {
+ if (($key ne "") && ($newline eq "")) {
+ return 1;
+ } else {
+ return 0;
+ }
+ } else {
+ return 0; # Invalid command.
}
- # Build the client type mask:
+ return 0; # Should not get here!!!
+}
+#
+# ApplyEdit - Applies an edit command to a line in a configuration
+# file. It is the caller's responsiblity to validate the
+# edit line.
+# Parameters:
+# $directive - A single edit directive to apply.
+# Edit directives are of the form:
+# append|newline - Appends a new line to the file.
+# replace|key|newline - Replaces the line with key value 'key'
+# delete|key - Deletes the line with key value 'key'.
+# $editor - A config file editor object that contains the
+# file being edited.
+#
+sub ApplyEdit {
+
+ my ($directive, $editor) = @_;
+
+ # Break the directive down into its command and its parameters
+ # (at most two at this point. The meaning of the parameters, if in fact
+ # they exist depends on the command).
+
+ my ($command, $p1, $p2) = split(/\|/, $directive);
+
+ if($command eq "append") {
+ $editor->Append($p1); # p1 - key p2 null.
+ } elsif ($command eq "replace") {
+ $editor->ReplaceLine($p1, $p2); # p1 - key p2 = newline.
+ } elsif ($command eq "delete") {
+ $editor->DeleteLine($p1); # p1 - key p2 null.
+ } else { # Should not get here!!!
+ die "Invalid command given to ApplyEdit $command"
+ }
+}
+#
+# AdjustOurHost:
+# Adjusts a host file stored in a configuration file editor object
+# for the true IP address of this host. This is necessary for hosts
+# that live behind a firewall.
+# Those hosts have a publicly distributed IP of the firewall, but
+# internally must use their actual IP. We assume that a given
+# host only has a single IP interface for now.
+# Formal Parameters:
+# editor - The configuration file editor to adjust. This
+# editor is assumed to contain a hosts.tab file.
+# Strategy:
+# - Figure out our hostname.
+# - Lookup the entry for this host.
+# - Modify the line to contain our IP
+# - Do a replace for this host.
+sub AdjustOurHost {
+ my $editor = shift;
+
+ # figure out who I am.
+
+ my $myHostName = $perlvar{'lonHostID'}; # LonCAPA hostname.
+
+ # Get my host file entry.
+
+ my $ConfigLine = $editor->Find($myHostName);
+ if(! (defined $ConfigLine)) {
+ die "AdjustOurHost - no entry for me in hosts file $myHostName";
+ }
+ # figure out my IP:
+ # Use the config line to get my hostname.
+ # Use gethostbyname to translate that into an IP address.
+ #
+ my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
+ my $BinaryIp = gethostbyname($name);
+ my $ip = inet_ntoa($ip);
+ #
+ # Reassemble the config line from the elements in the list.
+ # Note that if the loncnew items were not present before, they will
+ # be now even if they would be empty
+ #
+ my $newConfigLine = $id;
+ foreach my $item ($domain, $role, $name, $ip, $maxcon, $idleto, $mincon) {
+ $newConfigLine .= ":".$item;
+ }
+ # Replace the line:
+
+ $editor->ReplaceLine($id, $newConfigLine);
+
+}
+#
+# ReplaceConfigFile:
+# Replaces a configuration file with the contents of a
+# configuration file editor object.
+# This is done by:
+# - Copying the target file to .old
+# - Writing the new file to .tmp
+# - Moving ->
+# This laborious process ensures that the system is never without
+# a configuration file that's at least valid (even if the contents
+# may be dated).
+# Parameters:
+# filename - Name of the file to modify... this is a full path.
+# editor - Editor containing the file.
+#
+sub ReplaceConfigFile {
- my $ClientTypeMask = 0;
- if($ClientOk) {
- $ClientTypeMask |= $CLIENT_OK;
+ my ($filename, $editor) = @_;
+
+ CopyFile ($filename, $filename.".old");
+
+ my $contents = $editor->Get(); # Get the contents of the file.
+
+ InstallFile($filename, $contents);
+}
+#
+#
+# Called to edit a configuration table file
+# Parameters:
+# request - The entire command/request sent by lonc or lonManage
+# Return:
+# The reply to send to the client.
+#
+sub EditFile {
+ my $request = shift;
+
+ # Split the command into it's pieces: edit:filetype:script
+
+ my ($request, $filetype, $script) = split(/:/, $request,3); # : in script
+
+ # Check the pre-coditions for success:
+
+ if($request != "edit") { # Something is amiss afoot alack.
+ return "error:edit request detected, but request != 'edit'\n";
}
- if($ManagerOk) {
- $ClientTypeMask |= $MANAGER_OK;
+ if( ($filetype ne "hosts") &&
+ ($filetype ne "domain")) {
+ return "error:edit requested with invalid file specifier: $filetype \n";
}
+
+ # Split the edit script and check it's validity.
+
+ my @scriptlines = split(/\n/, $script); # one line per element.
+ my $linecount = scalar(@scriptlines);
+ for(my $i = 0; $i < $linecount; $i++) {
+ chomp($scriptlines[$i]);
+ if(!isValidEditCommand($scriptlines[$i])) {
+ return "error:edit with bad script line: '$scriptlines[$i]' \n";
+ }
+ }
+
+ # Execute the edit operation.
+ # - Create a config file editor for the appropriate file and
+ # - execute each command in the script:
+ #
+ my $configfile = ConfigFileFromSelector($filetype);
+ if (!(defined $configfile)) {
+ return "refused\n";
+ }
+ my $editor = ConfigFileEdit->new($configfile);
+
+ for (my $i = 0; $i < $linecount; $i++) {
+ ApplyEdit($scriptlines[$i], $editor);
+ }
+ # If the file is the host file, ensure that our host is
+ # adjusted to have our ip:
+ #
+ if($filetype eq "host") {
+ AdjustOurHost($editor);
+ }
+ # Finally replace the current file with our file.
+ #
+ ReplaceConfigFile($configfile, $editor);
+
+ return "ok\n";
+}
+
+#---------------------------------------------------------------
+#
+# Manipulation of hash based databases (factoring out common code
+# for later use as we refactor.
+#
+# Ties a domain level resource file to a hash.
+# If requested a history entry is created in the associated hist file.
+#
+# Parameters:
+# domain - Name of the domain in which the resource file lives.
+# namespace - Name of the hash within that domain.
+# how - How to tie the hash (e.g. GDBM_WRCREAT()).
+# loghead - Optional parameter, if present a log entry is created
+# in the associated history file and this is the first part
+# of that entry.
+# logtail - Goes along with loghead, The actual logentry is of the
+# form $loghead::logtail.
+# Returns:
+# Reference to a hash bound to the db file or alternatively undef
+# if the tie failed.
+#
+sub tie_domain_hash {
+ my ($domain,$namespace,$how,$loghead,$logtail) = @_;
+
+ # Filter out any whitespace in the domain name:
+
+ $domain =~ s/\W//g;
+
+ # We have enough to go on to tie the hash:
+
+ my $user_top_dir = $perlvar{'lonUsersDir'};
+ my $domain_dir = $user_top_dir."/$domain";
+ my $resource_file = $domain_dir."/$namespace.db";
+ my %hash;
+ if(tie(%hash, 'GDBM_File', $resource_file, $how, 0640)) {
+ if (defined($loghead)) { # Need to log the operation.
+ my $logFh = IO::File->new(">>$domain_dir/$namespace.hist");
+ if($logFh) {
+ my $timestamp = time;
+ print $logFh "$loghead:$timestamp:$logtail\n";
+ }
+ $logFh->close;
+ }
+ return \%hash; # Return the tied hash.
+ } else {
+ return undef; # Tie failed.
+ }
+}
+
+#
+# Ties a user's resource file to a hash.
+# If necessary, an appropriate history
+# log file entry is made as well.
+# This sub factors out common code from the subs that manipulate
+# the various gdbm files that keep keyword value pairs.
+# Parameters:
+# domain - Name of the domain the user is in.
+# user - Name of the 'current user'.
+# namespace - Namespace representing the file to tie.
+# how - What the tie is done to (e.g. GDBM_WRCREAT().
+# loghead - Optional first part of log entry if there may be a
+# history file.
+# what - Optional tail of log entry if there may be a history
+# file.
+# Returns:
+# hash to which the database is tied. It's up to the caller to untie.
+# undef if the has could not be tied.
+#
+sub tie_user_hash {
+ my ($domain,$user,$namespace,$how,$loghead,$what) = @_;
+
+ $namespace=~s/\//\_/g; # / -> _
+ $namespace=~s/\W//g; # whitespace eliminated.
+ my $proname = propath($domain, $user);
- # Enter the hash:
-
- my @entry = ($Procedure, $MustEncode, $ClientTypeMask);
-
- $Dispatcher{$RequestName} = \@entry;
-
-
+ # Tie the database.
+
+ my %hash;
+ if(tie(%hash, 'GDBM_File', "$proname/$namespace.db",
+ $how, 0640)) {
+ # If this is a namespace for which a history is kept,
+ # make the history log entry:
+ if (($namespace =~/^nohist\_/) && (defined($loghead))) {
+ my $args = scalar @_;
+ Debug(" Opening history: $namespace $args");
+ my $hfh = IO::File->new(">>$proname/$namespace.hist");
+ if($hfh) {
+ my $now = time;
+ print $hfh "$loghead:$now:$what\n";
+ }
+ $hfh->close;
+ }
+ return \%hash;
+ } else {
+ return undef;
+ }
+
}
#--------------------- Request Handlers --------------------------------------------
#
-# By convention each request handler registers itself prior to the sub declaration:
+# By convention each request handler registers itself prior to the sub
+# declaration:
#
+#++
+#
# Handles ping requests.
# Parameters:
# $cmd - the actual keyword that invoked us.
@@ -282,18 +1052,21 @@ sub RegisterHandler {
# Side effects:
# Reply information is sent to the client.
-sub PingHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub ping_handler {
+ my ($cmd, $tail, $client) = @_;
+ Debug("$cmd $tail $client .. $currenthostid:");
Reply( $client,"$currenthostid\n","$cmd:$tail");
return 1;
}
-RegisterHandler("ping", \&PingHandler, 0, 1, 1); # Ping unencoded, client or manager.
+®ister_handler("ping", \&ping_handler, 0, 1, 1); # Ping unencoded, client or manager.
+
+#++
+#
+# Handles pong requests. Pong replies with our current host id, and
+# the results of a ping sent to us via our lonc.
#
-# Handles pong reequests:
# Parameters:
# $cmd - the actual keyword that invoked us.
# $tail - the tail of the request that invoked us.
@@ -307,21 +1080,24 @@ RegisterHandler("ping", \&PingHandler, 0
# Side effects:
# Reply information is sent to the client.
-sub PongHandler {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub pong_handler {
+ my ($cmd, $tail, $replyfd) = @_;
my $reply=&reply("ping",$clientname);
- Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");
+ &Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");
return 1;
}
-RegisterHandler("pong", \&PongHandler, 0, 1, 1); # Pong unencoded, client or manager
+®ister_handler("pong", \&pong_handler, 0, 1, 1); # Pong unencoded, client or manager
-#
-# EstablishKeyHandler:
+#++
# Called to establish an encrypted session key with the remote client.
-#
+# Note that with secure lond, in most cases this function is never
+# invoked. Instead, the secure session key is established either
+# via a local file that's locked down tight and only lives for a short
+# time, or via an ssl tunnel...and is generated from a bunch-o-random
+# bits from /dev/urandom, rather than the predictable pattern used by
+# by this sub. This sub is only used in the old-style insecure
+# key negotiation.
# Parameters:
# $cmd - the actual keyword that invoked us.
# $tail - the tail of the request that invoked us.
@@ -337,10 +1113,8 @@ RegisterHandler("pong", \&PongHandler, 0
# Reply information is sent to the client.
# $cipher is set with a reference to a new IDEA encryption object.
#
-sub EstablishKeyHandler {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub establish_key_handler {
+ my ($cmd, $tail, $replyfd) = @_;
my $buildkey=time.$$.int(rand 100000);
$buildkey=~tr/1-6/A-F/;
@@ -353,14 +1127,14 @@ sub EstablishKeyHandler {
$key=substr($key,0,32);
my $cipherkey=pack("H32",$key);
$cipher=new IDEA $cipherkey;
- Reply($replyfd, "$buildkey\n", "$cmd:$tail");
+ &Reply($replyfd, "$buildkey\n", "$cmd:$tail");
return 1;
}
-RegisterHandler("ekey", \&EstablishKeyHandler, 0, 1,1);
+®ister_handler("ekey", \&establish_key_handler, 0, 1,1);
+
-# LoadHandler:
# Handler for the load command. Returns the current system load average
# to the requestor.
#
@@ -377,10 +1151,8 @@ RegisterHandler("ekey", \&EstablishKeyHa
# 0 - Program should exit.
# Side effects:
# Reply information is sent to the client.
-sub LoadHandler {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub load_handler {
+ my ($cmd, $tail, $replyfd) = @_;
# Get the load average from /proc/loadavg and calculate it as a percentage of
# the allowed load limit as set by the perl global variable lonLoadLim
@@ -393,12 +1165,11 @@ sub LoadHandler {
my $loadpercent=100*$loadavg/$perlvar{'lonLoadLim'};
- Reply( $replyfd, "$loadpercent\n", "$cmd:$tail");
+ &Reply( $replyfd, "$loadpercent\n", "$cmd:$tail");
return 1;
}
-RegisterHandler("load", \&LoadHandler, 0, 1, 0);
-
+register_handler("load", \&load_handler, 0, 1, 0);
#
# Process the userload request. This sub returns to the client the current
@@ -420,17 +1191,15 @@ RegisterHandler("load", \&LoadHandler, 0
# Implicit outputs:
# the reply is written to the client.
#
-sub UserLoadHandler {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub user_load_handler {
+ my ($cmd, $tail, $replyfd) = @_;
my $userloadpercent=&userload();
- Reply($replyfd, "$userloadpercent\n", "$cmd:$tail");
+ &Reply($replyfd, "$userloadpercent\n", "$cmd:$tail");
return 1;
}
-RegisterHandler("userload", \&UserLoadHandler, 0, 1, 0);
+register_handler("userload", \&user_load_handler, 0, 1, 0);
# Process a request for the authorization type of a user:
# (userauth).
@@ -445,28 +1214,35 @@ RegisterHandler("userload", \&UserLoadHa
# Implicit outputs:
# The user authorization type is written to the client.
#
-sub UserAuthorizationType {
- my $cmd = shift;
- my $tail = shift;
- my $replyfd = shift;
+sub user_authorization_type {
+ my ($cmd, $tail, $replyfd) = @_;
my $userinput = "$cmd:$tail";
# Pull the domain and username out of the command tail.
- # and call GetAuthType to determine the authentication type.
+ # and call get_auth_type to determine the authentication type.
my ($udom,$uname)=split(/:/,$tail);
- my $result = GetAuthType($udom, $uname);
+ my $result = &get_auth_type($udom, $uname);
if($result eq "nouser") {
- Failure( $replyfd, "unknown_user\n", $userinput);
+ &Failure( $replyfd, "unknown_user\n", $userinput);
} else {
- Reply( $replyfd, "$result\n", $userinput);
+ #
+ # We only want to pass the second field from get_auth_type
+ # for ^krb.. otherwise we'll be handing out the encrypted
+ # password for internals e.g.
+ #
+ my ($type,$otherinfo) = split(/:/,$result);
+ if($type =~ /^krb/) {
+ $type = $result;
+ }
+ &Reply( $replyfd, "$type:\n", $userinput);
}
return 1;
}
-RegisterHandler("currentauth", \&UserAuthorizationType, 1, 1, 0);
-#
+®ister_handler("currentauth", \&user_authorization_type, 1, 1, 0);
+
# Process a request by a manager to push a hosts or domain table
# to us. We pick apart the command and pass it on to the subs
# that already exist to do this.
@@ -481,10 +1257,8 @@ RegisterHandler("currentauth", \&UserAut
# Implicit Output:
# a reply is written to the client.
-sub PushFileHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub push_file_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
@@ -492,20 +1266,21 @@ sub PushFileHandler {
# the code below is a hook to do further authentication (e.g. to resolve
# spoofing).
- my $cert = GetCertificate($userinput);
- if(ValidManager($cert)) {
+ my $cert = &GetCertificate($userinput);
+ if(&ValidManager($cert)) {
# Now presumably we have the bona fides of both the peer host and the
# process making the request.
- my $reply = PushFile($userinput);
- Reply($client, "$reply\n", $userinput);
+ my $reply = &PushFile($userinput);
+ &Reply($client, "$reply\n", $userinput);
} else {
- Failure( $client, "refused\n", $userinput);
+ &Failure( $client, "refused\n", $userinput);
}
+ return 1;
}
-RegisterHandler("pushfile", \&PushFileHandler, 1, 0, 1);
+®ister_handler("pushfile", \&push_file_handler, 1, 0, 1);
@@ -523,25 +1298,23 @@ RegisterHandler("pushfile", \&PushFileHa
# Implicit output:
# a reply is sent to the client.
#
-sub ReinitProcessHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub reinit_process_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
- my $cert = GetCertificate($userinput);
- if(ValidManager($cert)) {
+ my $cert = &GetCertificate($userinput);
+ if(&ValidManager($cert)) {
chomp($userinput);
- my $reply = ReinitProcess($userinput);
- Reply( $client, "$reply\n", $userinput);
+ my $reply = &ReinitProcess($userinput);
+ &Reply( $client, "$reply\n", $userinput);
} else {
- Failure( $client, "refused\n", $userinput);
+ &Failure( $client, "refused\n", $userinput);
}
return 1;
}
-RegisterHandler("reinit", \&ReinitProcessHandler, 1, 0, 1);
+®ister_handler("reinit", \&reinit_process_handler, 1, 0, 1);
# Process the editing script for a table edit operation.
# the editing operation must be encrypted and requested by
@@ -557,34 +1330,32 @@ RegisterHandler("reinit", \&ReinitProces
# Implicit output:
# a reply is sent to the client.
#
-sub EditTableHandler {
- my $command = shift;
- my $tail = shift;
- my $client = shift;
+sub edit_table_handler {
+ my ($command, $tail, $client) = @_;
my $userinput = "$command:$tail";
- my $cert = GetCertificate($userinput);
- if(ValidManager($cert)) {
+ my $cert = &GetCertificate($userinput);
+ if(&ValidManager($cert)) {
my($filetype, $script) = split(/:/, $tail);
if (($filetype eq "hosts") ||
($filetype eq "domain")) {
if($script ne "") {
- Reply($client, # BUGBUG - EditFile
- EditFile($userinput), # could fail.
+ &Reply($client, # BUGBUG - EditFile
+ &EditFile($userinput), # could fail.
$userinput);
} else {
- Failure($client,"refused\n",$userinput);
+ &Failure($client,"refused\n",$userinput);
}
} else {
- Failure($client,"refused\n",$userinput);
+ &Failure($client,"refused\n",$userinput);
}
} else {
- Failure($client,"refused\n",$userinput);
+ &Failure($client,"refused\n",$userinput);
}
return 1;
}
-RegisterHandler("edit", \&EditTableHandler, 1, 0, 1);
+register_handler("edit", \&edit_table_handler, 1, 0, 1);
#
@@ -611,136 +1382,37 @@ RegisterHandler("edit", \&EditTableHandl
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
#
-sub AuthenticateHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
+sub authenticate_handler {
+ my ($cmd, $tail, $client) = @_;
+
+
# Regenerate the full input line
-
+
my $userinput = $cmd.":".$tail;
-
+
# udom - User's domain.
# uname - Username.
# upass - User's password.
-
+
my ($udom,$uname,$upass)=split(/:/,$tail);
- Debug(" Authenticate domain = $udom, user = $uname, password = $upass");
+ &Debug(" Authenticate domain = $udom, user = $uname, password = $upass");
chomp($upass);
- $upass=unescape($upass);
- my $proname=propath($udom,$uname);
- my $passfilename="$proname/passwd";
-
- # The user's 'personal' loncapa passworrd file describes how to authenticate:
-
- if (-e $passfilename) {
- Debug("Located password file: $passfilename");
+ $upass=&unescape($upass);
- my $pf = IO::File->new($passfilename);
- my $realpasswd=<$pf>;
- chomp($realpasswd);
- my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
- my $pwdcorrect=0;
+ my $pwdcorrect = &validate_user($udom, $uname, $upass);
+ if($pwdcorrect) {
+ &Reply( $client, "authorized\n", $userinput);
#
- # Authenticate against password stored in the internal file.
- #
- Debug("Authenticating via $howpwd");
- if ($howpwd eq 'internal') {
- &Debug("Internal auth");
- $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);
- #
- # Authenticate against the unix password file.
- #
- } elsif ($howpwd eq 'unix') {
- &Debug("Unix auth");
- if((getpwnam($uname))[1] eq "") { #no such user!
- $pwdcorrect = 0;
- } else {
- $contentpwd=(getpwnam($uname))[1];
- my $pwauth_path="/usr/local/sbin/pwauth";
- unless ($contentpwd eq 'x') {
- $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);
- } elsif (-e $pwauth_path) {
- open PWAUTH, "|$pwauth_path" or
- die "Cannot invoke authentication";
- print PWAUTH "$uname\n$upass\n";
- close PWAUTH;
- $pwdcorrect=!$?;
- }
- }
- #
- # Authenticate against a Kerberos 4 server:
- #
- } elsif ($howpwd eq 'krb4') {
- my $null=pack("C",0);
- unless ($upass=~/$null/) {
- my $krb4_error = &Authen::Krb4::get_pw_in_tkt($uname,
- "",
- $contentpwd,
- 'krbtgt',
- $contentpwd,
- 1,
- $upass);
- if (!$krb4_error) {
- $pwdcorrect = 1;
- } else {
- $pwdcorrect=0;
- # log error if it is not a bad password
- if ($krb4_error != 62) {
- &logthis('krb4:'.$uname.','.$contentpwd.','.
- &Authen::Krb4::get_err_txt($Authen::Krb4::error));
- }
- }
- }
- #
- # Authenticate against a Kerberos 5 server:
- #
- } elsif ($howpwd eq 'krb5') {
- my $null=pack("C",0);
- unless ($upass=~/$null/) {
- my $krbclient=&Authen::Krb5::parse_name($uname.'@'.$contentpwd);
- my $krbservice="krbtgt/".$contentpwd."\@".$contentpwd;
- my $krbserver=&Authen::Krb5::parse_name($krbservice);
- my $credentials=&Authen::Krb5::cc_default();
- $credentials->initialize($krbclient);
- my $krbreturn = &Authen::Krb5::get_in_tkt_with_password($krbclient,
- $krbserver,
- $upass,
- $credentials);
- $pwdcorrect = ($krbreturn == 1);
- } else {
- $pwdcorrect=0;
- }
- #
- # Finally, the user may have written in an authentication module.
- # in that case, if requested, authenticate against it.
- #
- } elsif ($howpwd eq 'localauth') {
- $pwdcorrect=&localauth::localauth($uname,$upass,$contentpwd);
- }
- #
- # Successfully authorized.
- #
- if ($pwdcorrect) {
- Reply( $client, "authorized\n", $userinput);
- #
- # Bad credentials: Failed to authorize
- #
- } else {
- Failure( $client, "non_authorized\n", $userinput);
- }
- #
- # User bad... note it may be bad security practice to
- # differntiate to the caller a bad user from a bad
- # passwd... since that supplies covert channel information
- # (you have a good user but bad password e.g.) to guessers.
+ # Bad credentials: Failed to authorize
#
} else {
- Failure( $client, "unknown_user\n", $userinput);
+ &Failure( $client, "non_authorized\n", $userinput);
}
+
return 1;
}
-RegisterHandler("auth", \&AuthenticateHandler, 1, 1, 0);
+
+register_handler("auth", \&authenticate_handler, 1, 1, 0);
#
# Change a user's password. Note that this function is complicated by
@@ -763,11 +1435,9 @@ RegisterHandler("auth", \&AuthenticateHa
# Implicit inputs:
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
-sub ChangePasswordHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
+sub change_password_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = $cmd.":".$tail; # Reconstruct client's string.
#
@@ -777,86 +1447,64 @@ sub ChangePasswordHandler {
# npass - New password.
my ($udom,$uname,$upass,$npass)=split(/:/,$tail);
- chomp($npass);
+
$upass=&unescape($upass);
$npass=&unescape($npass);
&Debug("Trying to change password for $uname");
- my $proname=propath($udom,$uname);
- my $passfilename="$proname/passwd";
- if (-e $passfilename) {
- my $realpasswd;
- {
- my $pf = IO::File->new($passfilename);
- $realpasswd=<$pf>;
- }
- chomp($realpasswd);
+
+ # First require that the user can be authenticated with their
+ # old password:
+
+ my $validated = &validate_user($udom, $uname, $upass);
+ if($validated) {
+ my $realpasswd = &get_auth_type($udom, $uname); # Defined since authd.
+
my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
if ($howpwd eq 'internal') {
&Debug("internal auth");
- if (crypt($upass,$contentpwd) eq $contentpwd) {
- my $salt=time;
- $salt=substr($salt,6,2);
- my $ncpass=crypt($npass,$salt);
- {
- my $pf = IO::File->new(">$passfilename");
- if ($pf) {
- print $pf "internal:$ncpass\n";
- &logthis("Result of password change for "
- ."$uname: pwchange_success");
- Reply($client, "ok\n", $userinput);
- } else {
- &logthis("Unable to open $uname passwd "
- ."to change password");
- Failure( $client, "non_authorized\n",$userinput);
- }
- }
+ my $salt=time;
+ $salt=substr($salt,6,2);
+ my $ncpass=crypt($npass,$salt);
+ if(&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
+ &logthis("Result of password change for "
+ ."$uname: pwchange_success");
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure($client, "non_authorized\n", $userinput);
+ &logthis("Unable to open $uname passwd "
+ ."to change password");
+ &Failure( $client, "non_authorized\n",$userinput);
}
} elsif ($howpwd eq 'unix') {
# Unix means we have to access /etc/password
- # one way or another.
- # First: Make sure the current password is
- # correct
&Debug("auth is unix");
- $contentpwd=(getpwnam($uname))[1];
- my $pwdcorrect = "0";
- my $pwauth_path="/usr/local/sbin/pwauth";
- unless ($contentpwd eq 'x') {
- $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);
- } elsif (-e $pwauth_path) {
- open PWAUTH, "|$pwauth_path" or
- die "Cannot invoke authentication";
- print PWAUTH "$uname\n$upass\n";
- close PWAUTH;
- &Debug("exited pwauth with $? ($uname,$upass) ");
- $pwdcorrect=($? == 0);
- }
- if ($pwdcorrect) {
- my $execdir=$perlvar{'lonDaemons'};
- &Debug("Opening lcpasswd pipeline");
- my $pf = IO::File->new("|$execdir/lcpasswd > "
- ."$perlvar{'lonDaemons'}"
- ."/logs/lcpasswd.log");
- print $pf "$uname\n$npass\n$npass\n";
- close $pf;
- my $err = $?;
- my $result = ($err>0 ? 'pwchange_failure' : 'ok');
- &logthis("Result of password change for $uname: ".
- &lcpasswdstrerror($?));
- Reply($client, "$result\n", $userinput);
- } else {
- Reply($client, "non_authorized\n", $userinput);
- }
+ my $execdir=$perlvar{'lonDaemons'};
+ &Debug("Opening lcpasswd pipeline");
+ my $pf = IO::File->new("|$execdir/lcpasswd > "
+ ."$perlvar{'lonDaemons'}"
+ ."/logs/lcpasswd.log");
+ print $pf "$uname\n$npass\n$npass\n";
+ close $pf;
+ my $err = $?;
+ my $result = ($err>0 ? 'pwchange_failure' : 'ok');
+ &logthis("Result of password change for $uname: ".
+ &lcpasswdstrerror($?));
+ &Reply($client, "$result\n", $userinput);
} else {
- Reply( $client, "auth_mode_error\n", $userinput);
+ # this just means that the current password mode is not
+ # one we know how to change (e.g the kerberos auth modes or
+ # locally written auth handler).
+ #
+ &Failure( $client, "auth_mode_error\n", $userinput);
}
+
} else {
- Reply( $client, "unknown_user\n", $userinput);
+ &Failure( $client, "non_authorized\n", $userinput);
}
+
return 1;
}
-RegisterHandler("passwd", \&ChangePasswordHandler, 1, 1, 0);
+register_handler("passwd", \&change_password_handler, 1, 1, 0);
+
#
# Create a new user. User in this case means a lon-capa user.
@@ -874,50 +1522,57 @@ RegisterHandler("passwd", \&ChangePasswo
# Implicit inputs:
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
-sub AddUserHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = $cmd.":".$tail;
+sub add_user_handler {
+
+ my ($cmd, $tail, $client) = @_;
+
- my $oldumask=umask(0077);
my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
+ my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
+
&Debug("cmd =".$cmd." $udom =".$udom." uname=".$uname);
- chomp($npass);
- $npass=&unescape($npass);
- my $proname=propath($udom,$uname);
- my $passfilename="$proname/passwd";
- &Debug("Password file created will be:".$passfilename);
- if (-e $passfilename) {
- Failure( $client, "already_exists\n", $userinput);
- } elsif ($udom ne $currentdomainid) {
- Failure($client, "not_right_domain\n", $userinput);
- } else {
- my @fpparts=split(/\//,$proname);
- my $fpnow=$fpparts[0].'/'.$fpparts[1].'/'.$fpparts[2];
- my $fperror='';
- for (my $i=3;$i<=$#fpparts;$i++) {
- $fpnow.='/'.$fpparts[$i];
- unless (-e $fpnow) {
- unless (mkdir($fpnow,0777)) {
- $fperror="error: ".($!+0)." mkdir failed while attempting "
- ."makeuser";
+
+
+ if($udom eq $currentdomainid) { # Reject new users for other domains...
+
+ my $oldumask=umask(0077);
+ chomp($npass);
+ $npass=&unescape($npass);
+ my $passfilename = &password_path($udom, $uname);
+ &Debug("Password file created will be:".$passfilename);
+ if (-e $passfilename) {
+ &Failure( $client, "already_exists\n", $userinput);
+ } else {
+ my @fpparts=split(/\//,$passfilename);
+ my $fpnow=$fpparts[0].'/'.$fpparts[1].'/'.$fpparts[2];
+ my $fperror='';
+ for (my $i=3;$i<= ($#fpparts-1);$i++) {
+ $fpnow.='/'.$fpparts[$i];
+ unless (-e $fpnow) {
+ &logthis("mkdir $fpnow");
+ unless (mkdir($fpnow,0777)) {
+ $fperror="error: ".($!+0)." mkdir failed while attempting "
+ ."makeuser";
+ }
}
}
+ unless ($fperror) {
+ my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);
+ &Reply($client, $result, $userinput); #BUGBUG - could be fail
+ } else {
+ &Failure($client, "$fperror\n", $userinput);
+ }
}
- unless ($fperror) {
- my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);
- Reply($client, $result, $userinput); #BUGBUG - could be fail
- } else {
- Failure($client, "$fperror\n", $userinput);
- }
+ umask($oldumask);
+ } else {
+ &Failure($client, "not_right_domain\n",
+ $userinput); # Even if we are multihomed.
+
}
- umask($oldumask);
return 1;
}
-RegisterHandler("makeuser", \&AddUserHandler, 1, 1, 0);
+®ister_handler("makeuser", \&add_user_handler, 1, 1, 0);
#
# Change the authentication method of a user. Note that this may
@@ -941,28 +1596,32 @@ RegisterHandler("makeuser", \&AddUserHan
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
#
-sub ChangeAuthenticationHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub change_authentication_handler {
+
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail"; # Reconstruct user input.
my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
- chomp($npass);
&Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
- $npass=&unescape($npass);
- my $proname=&propath($udom,$uname);
- my $passfilename="$proname/passwd";
if ($udom ne $currentdomainid) {
- Failure( $client, "not_right_domain\n", $client);
+ &Failure( $client, "not_right_domain\n", $client);
} else {
- my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
- Reply($client, $result, $userinput);
+
+ chomp($npass);
+
+ $npass=&unescape($npass);
+ my $passfilename = &password_path($udom, $uname);
+ if ($passfilename) { # Not allowed to create a new user!!
+ my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
+ &Reply($client, $result, $userinput);
+ } else {
+ &Failure($client, "non_authorized", $userinput); # Fail the user now.
+ }
}
return 1;
}
-RegisterHandler("changeuserauth", \&ChangeAuthenticationHandler, 1,1, 0);
+®ister_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
#
# Determines if this is the home server for a user. The home server
@@ -980,24 +1639,23 @@ RegisterHandler("changeuserauth", \&Chan
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
#
-sub IsHomeHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub is_home_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
my ($udom,$uname)=split(/:/,$tail);
chomp($uname);
- my $proname=propath($udom,$uname);
- if (-e $proname) {
- Reply( $client, "found\n", $userinput);
+ my $passfile = &password_filename($udom, $uname);
+ if($passfile) {
+ &Reply( $client, "found\n", $userinput);
} else {
- Failure($client, "not_found\n", $userinput);
+ &Failure($client, "not_found\n", $userinput);
}
return 1;
}
-RegisterHandler("home", \&IsHomeHandler, 0,1,0);
+®ister_handler("home", \&is_home_handler, 0,1,0);
+
#
# Process an update request for a resource?? I think what's going on here is
# that a resource has been modified that we hold a subscription to.
@@ -1020,14 +1678,15 @@ RegisterHandler("home", \&IsHomeHandler,
# The authentication systems describe above have their own forms of implicit
# input into the authentication process that are described above.
#
-sub UpdateResourceHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub update_resource_handler {
+
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
- my $fname=$tail;
+ my $fname= $tail; # This allows interactive testing
+
+
my $ownership=ishome($fname);
if ($ownership eq 'not_owner') {
if (-e $fname) {
@@ -1069,19 +1728,20 @@ sub UpdateResourceHandler {
rename($transname,$fname);
}
}
- Reply( $client, "ok\n", $userinput);
+ &Reply( $client, "ok\n", $userinput);
} else {
- Failure($client, "not_found\n", $userinput);
+ &Failure($client, "not_found\n", $userinput);
}
} else {
- Failure($client, "rejected\n", $userinput);
+ &Failure($client, "rejected\n", $userinput);
}
return 1;
}
-RegisterHandler("update", \&UpdateResourceHandler, 0 ,1, 0);
+®ister_handler("update", \&update_resource_handler, 0 ,1, 0);
#
-# Fetch a user file from a remote server:
+# Fetch a user file from a remote server to the user's home directory
+# userfiles subdir.
# Parameters:
# $cmd - The command that got us here.
# $tail - Tail of the command (remaining parameters).
@@ -1090,25 +1750,45 @@ RegisterHandler("update", \&UpdateResour
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub FetchUserFileHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
+sub fetch_user_file_handler {
+
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my $fname = $tail;
- my ($udom,$uname,$ufile)=split(/\//,$fname);
- my $udir=propath($udom,$uname).'/userfiles';
+ my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
+ my $udir=&propath($udom,$uname).'/userfiles';
unless (-e $udir) {
mkdir($udir,0770);
}
+ Debug("fetch user file for $fname");
if (-e $udir) {
$ufile=~s/^[\.\~]+//;
- $ufile=~s/\///g;
+
+ # IF necessary, create the path right down to the file.
+ # Note that any regular files in the way of this path are
+ # wiped out to deal with some earlier folly of mine.
+
+ my $path = $udir;
+ if ($ufile =~m|(.+)/([^/]+)$|) {
+ my @parts=split('/',$1);
+ foreach my $part (@parts) {
+ $path .= '/'.$part;
+ if( -f $path) {
+ unlink($path);
+ }
+ if ((-e $path)!=1) {
+ mkdir($path,0770);
+ }
+ }
+ }
+
+
my $destname=$udir.'/'.$ufile;
my $transname=$udir.'/'.$ufile.'.in.transit';
my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;
my $response;
+ Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
alarm(120);
{
my $ua=new LWP::UserAgent;
@@ -1120,58 +1800,102 @@ sub FetchUserFileHandler {
unlink($transname);
my $message=$response->status_line;
&logthis("LWP GET: $message for $fname ($remoteurl)");
- Failure($client, "failed\n", $userinput);
+ &Failure($client, "failed\n", $userinput);
} else {
+ Debug("Renaming $transname to $destname");
if (!rename($transname,$destname)) {
&logthis("Unable to move $transname to $destname");
unlink($transname);
- Failure($client, "failed\n", $userinput);
+ &Failure($client, "failed\n", $userinput);
} else {
- Reply($client, "ok\n", $userinput);
+ &Reply($client, "ok\n", $userinput);
}
}
} else {
- Failure($client, "not_home\n", $userinput);
+ &Failure($client, "not_home\n", $userinput);
+ }
+ return 1;
+}
+®ister_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
+
+#
+# Remove a file from a user's home directory userfiles subdirectory.
+# Parameters:
+# cmd - the Lond request keyword that got us here.
+# tail - the part of the command past the keyword.
+# client- File descriptor connected with the client.
+#
+# Returns:
+# 1 - Continue processing.
+
+sub remove_user_file_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my ($fname) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
+
+ my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
+ if ($ufile =~m|/\.\./|) {
+ # any files paths with /../ in them refuse
+ # to deal with
+ &Failure($client, "refused\n", "$cmd:$tail");
+ } else {
+ my $udir = &propath($udom,$uname);
+ if (-e $udir) {
+ my $file=$udir.'/userfiles/'.$ufile;
+ if (-e $file) {
+ unlink($file);
+ if (-e $file) {
+ &Failure($client, "failed\n", "$cmd:$tail");
+ } else {
+ &Reply($client, "ok\n", "$cmd:$tail");
+ }
+ } else {
+ &Failure($client, "not_found\n", "$cmd:$tail");
+ }
+ } else {
+ &Failure($client, "not_home\n", "$cmd:$tail");
+ }
}
return 1;
}
-RegisterHandler("fetchuserfile", \&FetchUserFileHandler, 0, 1, 0);
+®ister_handler("removeuserfile", \&remove_user_file_handler, 0,1,0);
+
+
#
-# Authenticate access to a user file. Question? The token for athentication
-# is allowed to be sent as cleartext is this really what we want? This token
-# represents the user's session id. Once it is forged does this allow too much access??
+# Authenticate access to a user file by checking the user's
+# session token(?)
#
# Parameters:
-# $cmd - The command that got us here.
-# $tail - Tail of the command (remaining parameters).
-# $client - File descriptor connected to client.
-# Returns
-# 0 - Requested to exit, caller should shut down.
-# 1 - Continue processing.
-sub AuthenticateUserFileAccess {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
- my $userinput = "$cmd:$tail";
+# cmd - The request keyword that dispatched to tus.
+# tail - The tail of the request (colon separated parameters).
+# client - Filehandle open on the client.
+# Return:
+# 1.
+
+sub token_auth_user_file_handler {
+ my ($cmd, $tail, $client) = @_;
- my ($fname,$session)=split(/:/,$tail);
+ my ($fname, $session) = split(/:/, $tail);
+
chomp($session);
my $reply='non_auth';
- if (open(ENVIN,$perlvar{'lonIDsDir'}.'/'.$session.'.id')) {
+ if (open(ENVIN,$perlvar{'lonIDsDir'}.'/'.
+ $session.'.id')) {
while (my $line=) {
- if ($line=~/userfile\.$fname\=/) {
- $reply='ok';
- }
+ if ($line=~ m|userfile\.\Q$fname\E\=|) { $reply='ok'; }
}
close(ENVIN);
- Reply($client, $reply."\n", $userinput);
+ &Reply($client, $reply);
} else {
- Failure($client, "invalid_token\n", $userinput);
+ &Failure($client, "invalid_token\n", "$cmd:$tail");
}
return 1;
-
+
}
-RegisterHandler("tokenauthuserfile", \&AuthenticateUserFileAccess, 0, 1, 0);
+
+®ister_handler("tokenauthuserfile", \&token_auth_user_file_handler, 0,1,0);
+
+
#
# Unsubscribe from a resource.
#
@@ -1183,23 +1907,24 @@ RegisterHandler("tokenauthuserfile", \&A
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub UnsubscribeHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub unsubscribe_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput= "$cmd:$tail";
- my $fname = $tail;
+ my ($fname) = split(/:/,$tail); # Split in case there's extrs.
+
+ &Debug("Unsubscribing $fname");
if (-e $fname) {
- Reply($client, &unsub($client,$fname,$clientip), $userinput);
+ &Debug("Exists");
+ &Reply($client, &unsub($fname,$clientip), $userinput);
} else {
- Failure($client, "not_found\n", $userinput);
+ &Failure($client, "not_found\n", $userinput);
}
return 1;
}
-RegisterHandler("unusb", \&UnsubscribeHandler, 0, 1, 0);
-
-# Subscribe to a resource.
+®ister_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
+# Subscribe to a resource
#
# Parameters:
# $cmd - The command that got us here.
@@ -1209,17 +1934,16 @@ RegisterHandler("unusb", \&UnsubscribeHa
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub SubscribeHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub subscribe_handler {
+ my ($cmd, $tail, $client)= @_;
+
my $userinput = "$cmd:$tail";
- Reply( $client, &subscribe($userinput,$clientip), $userinput);
+ &Reply( $client, &subscribe($userinput,$clientip), $userinput);
return 1;
}
-RegisterHandler("sub", \&SubscribeHandler, 0, 1, 0);
+®ister_handler("sub", \&subscribe_handler, 0, 1, 0);
#
# Determine the version of a resource (?) Or is it return
@@ -1234,19 +1958,17 @@ RegisterHandler("sub", \&SubscribeHandle
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub CurrentVersionHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub current_version_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput= "$cmd:$tail";
my $fname = $tail;
- Reply( $client, ¤tversion($fname)."\n", $userinput);
+ &Reply( $client, ¤tversion($fname)."\n", $userinput);
return 1;
}
-RegisterHandler("currentversion", \&CurrentVersionHandler, 0, 1, 0);
-
+®ister_handler("currentversion", \¤t_version_handler, 0, 1, 0);
# Make an entry in a user's activity log.
#
@@ -1258,29 +1980,30 @@ RegisterHandler("currentversion", \&Curr
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub ActivityLogEntryHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub activity_log_handler {
+ my ($cmd, $tail, $client) = @_;
+
+
my $userinput= "$cmd:$tail";
my ($udom,$uname,$what)=split(/:/,$tail);
chomp($what);
- my $proname=propath($udom,$uname);
+ my $proname=&propath($udom,$uname);
my $now=time;
my $hfh;
if ($hfh=IO::File->new(">>$proname/activity.log")) {
print $hfh "$now:$clientname:$what\n";
- Reply( $client, "ok\n", $userinput);
+ &Reply( $client, "ok\n", $userinput);
} else {
- Reply($client, "error: ".($!+0)." IO::File->new Failed "
- ."while attempting log\n",
- $userinput);
+ &Failure($client, "error: ".($!+0)." IO::File->new Failed "
+ ."while attempting log\n",
+ $userinput);
}
return 1;
}
-RegisterHandler("log", \&ActivityLogEntryHandler, 0, 1, 0);
+register_handler("log", \&activity_log_handler, 0, 1, 0);
+
#
# Put a namespace entry in a user profile hash.
# My druthers would be for this to be an encrypted interaction too.
@@ -1295,51 +2018,40 @@ RegisterHandler("log", \&ActivityLogEntr
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub PutUserProfileEntry {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
- my $userinput = "$cmd:$tail";
+sub put_user_profile_entry {
+ my ($cmd, $tail, $client) = @_;
+ my $userinput = "$cmd:$tail";
+
my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
if ($namespace ne 'roles') {
chomp($what);
- my $proname=propath($udom,$uname);
- my $now=time;
- unless ($namespace=~/^nohist\_/) {
- my $hfh;
- if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {
- print $hfh "P:$now:$what\n";
- }
- }
- my @pairs=split(/\&/,$what);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db",
- &GDBM_WRCREAT(),0640)) {
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(),"P",$what);
+ if($hashref) {
+ my @pairs=split(/\&/,$what);
foreach my $pair (@pairs) {
my ($key,$value)=split(/=/,$pair);
- $hash{$key}=$value;
+ $hashref->{$key}=$value;
}
- if (untie(%hash)) {
- Reply( $client, "ok\n", $userinput);
+ if (untie(%$hashref)) {
+ &Reply( $client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
"while attempting put\n",
$userinput);
}
} else {
- Failure( $client, "error: ".($!)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!)." tie(GDBM) Failed ".
"while attempting put\n", $userinput);
}
} else {
- Failure( $client, "refused\n", $userinput);
+ &Failure( $client, "refused\n", $userinput);
}
-
+
return 1;
}
-RegisterHandler("put", \&PutUserProfileEntry, 0, 1, 0);
+®ister_handler("put", \&put_user_profile_entry, 0, 1, 0);
#
# Increment a profile entry in the user history file.
@@ -1356,54 +2068,46 @@ RegisterHandler("put", \&PutUserProfileE
# 0 - Requested to exit, caller should shut down.
# 1 - Continue processing.
#
-sub IncrementUserValueHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
- my $userinput = shift;
-
+sub increment_user_value_handler {
+ my ($cmd, $tail, $client) = @_;
+
+ my $userinput = "$cmd:$tail";
+
my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
if ($namespace ne 'roles') {
- chomp($what);
- my $proname=propath($udom,$uname);
- my $now=time;
- unless ($namespace=~/^nohist\_/) {
- my $hfh;
- if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {
- print $hfh "P:$now:$what\n";
- }
- }
- my @pairs=split(/\&/,$what);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db",&GDBM_WRCREAT(),
- 0640)) {
+ chomp($what);
+ my $hashref = &tie_user_hash($udom, $uname,
+ $namespace, &GDBM_WRCREAT(),
+ "P",$what);
+ if ($hashref) {
+ my @pairs=split(/\&/,$what);
foreach my $pair (@pairs) {
my ($key,$value)=split(/=/,$pair);
# We could check that we have a number...
if (! defined($value) || $value eq '') {
$value = 1;
}
- $hash{$key}+=$value;
+ $hashref->{$key}+=$value;
}
- if (untie(%hash)) {
- Reply( $client, "ok\n", $userinput);
+ if (untie(%$hashref)) {
+ &Reply( $client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
- "while attempting put\n", $userinput);
+ &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
+ "while attempting inc\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting put\n", $userinput);
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ "while attempting inc\n", $userinput);
}
} else {
- Failure($client, "refused\n", $userinput);
+ &Failure($client, "refused\n", $userinput);
}
-
+
return 1;
}
-RegisterHandler("inc", \&IncrementUserValueHandler, 0, 1, 0);
+®ister_handler("inc", \&increment_user_value_handler, 0, 1, 0);
+
+
#
# Put a new role for a user. Roles are LonCAPA's packaging of permissions.
# Each 'role' a user has implies a set of permissions. Adding a new role
@@ -1424,52 +2128,46 @@ RegisterHandler("inc", \&IncrementUserVa
# 1 - To continue processing.
#
#
-sub RolesPutHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub roles_put_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
- my ($exedom,$exeuser,$udom,$uname,$what) =split(/:/,$tail);
- &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.
- "what = ".$what);
+ my ( $exedom, $exeuser, $udom, $uname, $what) = split(/:/,$tail);
+
+
my $namespace='roles';
chomp($what);
- my $proname=propath($udom,$uname);
- my $now=time;
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(), "P",
+ "$exedom:$exeuser:$what");
#
# Log the attempt to set a role. The {}'s here ensure that the file
# handle is open for the minimal amount of time. Since the flush
# is done on close this improves the chances the log will be an un-
# corrupted ordered thing.
- {
- my $hfh;
- if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {
- print $hfh "P:$now:$exedom:$exeuser:$what\n";
- }
- }
- my @pairs=split(/\&/,$what);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db", &GDBM_WRCREAT(),0640)) {
+ if ($hashref) {
+ my @pairs=split(/\&/,$what);
foreach my $pair (@pairs) {
my ($key,$value)=split(/=/,$pair);
- &ManagePermissions($key, $udom, $uname,
- &GetAuthType( $udom, $uname));
- $hash{$key}=$value;
+ &manage_permissions($key, $udom, $uname,
+ &get_auth_type( $udom, $uname));
+ $hashref->{$key}=$value;
}
- if (untie(%hash)) {
- Reply($client, "ok\n", $userinput);
+ if (untie($hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting rolesput\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting rolesput\n", $userinput);
}
return 1;
}
-RegisterHandler("rolesput", \&RolesPutHandler, 1,1,0); # Encoded client only.
+®ister_handler("rolesput", \&roles_put_handler, 1,1,0); # Encoded client only.
+
#
# Deletes (removes) a role for a user. This is equivalent to removing
# a permissions package associated with the role from the user's profile.
@@ -1487,10 +2185,9 @@ RegisterHandler("rolesput", \&RolesPutHa
# 1 - Continue processing
# 0 - Exit.
#
-sub RolesDeleteHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub roles_delete_handler {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
@@ -1498,40 +2195,30 @@ sub RolesDeleteHandler {
"what = ".$what);
my $namespace='roles';
chomp($what);
- my $proname=propath($udom,$uname);
- my $now=time;
- #
- # Log the attempt. This {}'ing is done to ensure that the
- # logfile is flushed and closed as quickly as possible. Hopefully
- # this preserves both time ordering and reduces the probability that
- # messages will be interleaved.
- #
- {
- my $hfh;
- if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {
- print $hfh "D:$now:$exedom:$exeuser:$what\n";
- }
- }
- my @rolekeys=split(/\&/,$what);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db", &GDBM_WRCREAT(),0640)) {
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(), "D",
+ "$exedom:$exeuser:$what");
+
+ if ($hashref) {
+ my @rolekeys=split(/\&/,$what);
+
foreach my $key (@rolekeys) {
- delete $hash{$key};
+ delete $hashref->{$key};
}
- if (untie(%hash)) {
- Reply($client, "ok\n", $userinput);
+ if (untie(%$hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting rolesdel\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting rolesdel\n", $userinput);
}
return 1;
}
-RegisterHandler("rolesdel", \&RolesDeleteHandler, 1,1, 0); # Encoded client only
+®ister_handler("rolesdel", \&roles_delete_handler, 1,1, 0); # Encoded client only
# Unencrypted get from a user's profile database. See
# GetProfileEntryEncrypted for a version that does end-to-end encryption.
@@ -1552,43 +2239,42 @@ RegisterHandler("rolesdel", \&RolesDelet
# 1 - Continue processing.
# 0 - Exit.
#
-sub GetProfileEntry {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub get_profile_entry {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput= "$cmd:$tail";
my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
chomp($what);
- my @queries=split(/\&/,$what);
- my $proname=propath($udom,$uname);
- my $qresult='';
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db", &GDBM_READER(),0640)) {
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_READER());
+ if ($hashref) {
+ my @queries=split(/\&/,$what);
+ my $qresult='';
+
for (my $i=0;$i<=$#queries;$i++) {
- $qresult.="$hash{$queries[$i]}&"; # Presumably failure gives empty string.
+ $qresult.="$hashref->{$queries[$i]}&"; # Presumably failure gives empty string.
}
- if (untie(%hash)) {
- $qresult=~s/\&$//; # Remove trailing & from last lookup.
- Reply($client, "$qresult\n", $userinput);
+ $qresult=~s/\&$//; # Remove trailing & from last lookup.
+ if (untie(%$hashref)) {
+ &Reply($client, "$qresult\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting get\n", $userinput);
}
} else {
if ($!+0 == 2) { # +0 coerces errno -> number 2 is ENOENT
- Failure($client, "error:No such file or ".
+ &Failure($client, "error:No such file or ".
"GDBM reported bad block error\n", $userinput);
} else { # Some other undifferentiated err.
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting get\n", $userinput);
}
}
return 1;
}
-RegisterHandler("get", \&GetProfileEntry, 0,1,0);
+®ister_handler("get", \&get_profile_entry, 0,1,0);
+
#
# Process the encrypted get request. Note that the request is sent
# in clear, but the reply is encrypted. This is a small covert channel:
@@ -1608,52 +2294,49 @@ RegisterHandler("get", \&GetProfileEntry
# Returns:
# 1 - Continue processing
# 0 - server should exit.
-sub GetProfileEntryEncrypted {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub get_profile_entry_encrypted {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($cmd,$udom,$uname,$namespace,$what) = split(/:/,$userinput);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
chomp($what);
- my @queries=split(/\&/,$what);
- my $proname=propath($udom,$uname);
- my $qresult='';
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db",&GDBM_READER(),0640)) {
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_READER());
+ if ($hashref) {
+ my @queries=split(/\&/,$what);
+ my $qresult='';
for (my $i=0;$i<=$#queries;$i++) {
- $qresult.="$hash{$queries[$i]}&";
+ $qresult.="$hashref->{$queries[$i]}&";
}
- if (untie(%hash)) {
+ if (untie(%$hashref)) {
$qresult=~s/\&$//;
if ($cipher) {
my $cmdlength=length($qresult);
$qresult.=" ";
my $encqresult='';
for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
- $encqresult.= unpack("H16", $cipher->encrypt(substr($qresult,
- $encidx,
- 8)));
+ $encqresult.= unpack("H16",
+ $cipher->encrypt(substr($qresult,
+ $encidx,
+ 8)));
}
- Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
+ &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
} else {
- Failure( $client, "error:no_key\n", $userinput);
+ &Failure( $client, "error:no_key\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting eget\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting eget\n", $userinput);
}
return 1;
}
-RegisterHandler("eget", \&GetProfileEncrypted, 0, 1, 0);
-
+®ister_handler("eget", \&GetProfileEntryEncrypted, 0, 1, 0);
#
# Deletes a key in a user profile database.
#
@@ -1672,43 +2355,35 @@ RegisterHandler("eget", \&GetProfileEncr
# 0 - Exit server.
#
#
-sub DeletProfileEntry {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+
+sub delete_profile_entry {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "cmd:$tail";
my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
chomp($what);
- my $proname=propath($udom,$uname);
- my $now=time;
- unless ($namespace=~/^nohist\_/) {
- my $hfh;
- if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {
- print $hfh "D:$now:$what\n";
- }
- }
- my @keys=split(/\&/,$what);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db",&GDBM_WRCREAT(),0640)) {
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(),
+ "D",$what);
+ if ($hashref) {
+ my @keys=split(/\&/,$what);
foreach my $key (@keys) {
- delete($hash{$key});
+ delete($hashref->{$key});
}
- if (untie(%hash)) {
- Reply($client, "ok\n", $userinput);
+ if (untie(%$hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting del\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting del\n", $userinput);
}
return 1;
}
-RegisterHandler("del", \&DeleteProfileEntry, 0, 1, 0);
+®ister_handler("del", \&delete_profile_entry, 0, 1, 0);
#
# List the set of keys that are defined in a profile database file.
# A successful reply from this will contain an & separated list of
@@ -1724,37 +2399,35 @@ RegisterHandler("del", \&DeleteProfileEn
# 1 - Continue processing.
# 0 - Exit the server.
#
-sub GetProfileKeys {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub get_profile_keys {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($udom,$uname,$namespace)=split(/:/,$tail);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
- my $proname=propath($udom,$uname);
my $qresult='';
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db",&GDBM_READER(),0640)) {
- foreach my $key (keys %hash) {
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_READER());
+ if ($hashref) {
+ foreach my $key (keys %$hashref) {
$qresult.="$key&";
}
- if (untie(%hash)) {
+ if (untie(%$hashref)) {
$qresult=~s/\&$//;
- Reply($client, "$qresult\n", $userinput);
+ &Reply($client, "$qresult\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting keys\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting keys\n", $userinput);
}
return 1;
}
-RegisterHandler("keys", \&GetProfileKeys, 0, 1, 0);
+®ister_handler("keys", \&get_profile_keys, 0, 1, 0);
+
#
# Dump the contents of a user profile database.
# Note that this constitutes a very large covert channel too since
@@ -1774,26 +2447,24 @@ RegisterHandler("keys", \&GetProfileKeys
# 1 - Continue processing.
# 0 - Exit the server.
#
-sub DumpProfileDatabase {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub dump_profile_database {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($udom,$uname,$namespace) = split(/:/,$tail);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
- my $qresult='';
- my $proname=propath($udom,$uname);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db", &GDBM_READER(),0640)) {
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_READER());
+ if ($hashref) {
# Structure of %data:
# $data{$symb}->{$parameter}=$value;
# $data{$symb}->{'v.'.$parameter}=$version;
# since $parameter will be unescaped, we do not
- # have to worry about silly parameter names...
+ # have to worry about silly parameter names...
+
+ my $qresult='';
my %data = (); # A hash of anonymous hashes..
- while (my ($key,$value) = each(%hash)) {
+ while (my ($key,$value) = each(%$hashref)) {
my ($v,$symb,$param) = split(/:/,$key);
next if ($v eq 'version' || $symb eq 'keys');
next if (exists($data{$symb}) &&
@@ -1802,7 +2473,7 @@ sub DumpProfileDatabase {
$data{$symb}->{$param}=$value;
$data{$symb}->{'v.'.$param}=$v;
}
- if (untie(%hash)) {
+ if (untie(%$hashref)) {
while (my ($symb,$param_hash) = each(%data)) {
while(my ($param,$value) = each (%$param_hash)){
next if ($param =~ /^v\./); # Ignore versions...
@@ -1813,19 +2484,20 @@ sub DumpProfileDatabase {
}
}
chop($qresult);
- Reply($client , "$qresult\n", $userinput);
+ &Reply($client , "$qresult\n", $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting currentdump\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting currentdump\n", $userinput);
}
return 1;
}
-RegisterHandler("currentdump", \&DumpProfileDatabase, 0, 1, 0);
+®ister_handler("currentdump", \&dump_profile_database, 0, 1, 0);
+
#
# Dump a profile database with an optional regular expression
# to match against the keys. In this dump, no effort is made
@@ -1850,28 +2522,23 @@ RegisterHandler("currentdump", \&DumpPro
# Side effects:
# response is written to $client.
#
-sub DumpWithRegexp {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub dump_with_regexp {
+ my ($cmd, $tail, $client) = @_;
+
my $userinput = "$cmd:$tail";
my ($udom,$uname,$namespace,$regexp)=split(/:/,$tail);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
if (defined($regexp)) {
$regexp=&unescape($regexp);
} else {
$regexp='.';
}
- my $qresult='';
- my $proname=propath($udom,$uname);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db",
- &GDBM_READER(),0640)) {
- study($regexp);
- while (my ($key,$value) = each(%hash)) {
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_READER());
+ if ($hashref) {
+ my $qresult='';
+ while (my ($key,$value) = each(%$hashref)) {
if ($regexp eq '.') {
$qresult.=$key.'='.$value.'&';
} else {
@@ -1881,23 +2548,24 @@ sub DumpWithRegexp {
}
}
}
- if (untie(%hash)) {
+ if (untie(%$hashref)) {
chop($qresult);
- Reply($client, "$qresult\n", $userinput);
+ &Reply($client, "$qresult\n", $userinput);
} else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting dump\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting dump\n", $userinput);
}
return 1;
}
-RegisterHandler("dump", \&DumpWithRegexp, 0, 1, 0);
-# Store an aitem in any database but the roles database.
+®ister_handler("dump", \&dump_with_regexp, 0, 1, 0);
+
+# Store a set of key=value pairs associated with a versioned name.
#
# Parameters:
# $cmd - Request command keyword.
@@ -1915,62 +2583,55 @@ RegisterHandler("dump", \&DumpWithRegexp
# 1 (keep on processing).
# Side-Effects:
# Writes to the client
-sub StoreHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+sub store_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail";
my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);
- $namespace=~s/\//\_/g;
- $namespace=~s/\W//g;
if ($namespace ne 'roles') {
+
chomp($what);
- my $proname=propath($udom,$uname);
- my $now=time;
- unless ($namespace=~/^nohist\_/) {
- my $hfh;
- if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {
- print $hfh "P:$now:$rid:$what\n";
- }
- }
my @pairs=split(/\&/,$what);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname/$namespace.db",
- &GDBM_WRCREAT(),0640)) {
- my @previouskeys=split(/&/,$hash{"keys:$rid"});
+ my $hashref = &tie_user_hash($udom, $uname, $namespace,
+ &GDBM_WRCREAT(), "P",
+ "$rid:$what");
+ if ($hashref) {
+ my $now = time;
+ my @previouskeys=split(/&/,$hashref->{"keys:$rid"});
my $key;
- $hash{"version:$rid"}++;
- my $version=$hash{"version:$rid"};
+ $hashref->{"version:$rid"}++;
+ my $version=$hashref->{"version:$rid"};
my $allkeys='';
foreach my $pair (@pairs) {
my ($key,$value)=split(/=/,$pair);
$allkeys.=$key.':';
- $hash{"$version:$rid:$key"}=$value;
+ $hashref->{"$version:$rid:$key"}=$value;
}
- $hash{"$version:$rid:timestamp"}=$now;
+ $hashref->{"$version:$rid:timestamp"}=$now;
$allkeys.='timestamp';
- $hash{"$version:keys:$rid"}=$allkeys;
- if (untie(%hash)) {
- Reply($client, "ok\n", $userinput);
+ $hashref->{"$version:keys:$rid"}=$allkeys;
+ if (untie($hashref)) {
+ &Reply($client, "ok\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting store\n", $userinput);
}
} else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting store\n", $userinput);
}
} else {
- Failure($client, "refused\n", $userinput);
+ &Failure($client, "refused\n", $userinput);
}
return 1;
}
-RegisterHandler("store", \&StoreHandler, 0, 1, 0);
+®ister_handler("store", \&store_handler, 0, 1, 0);
#
-# Restore a prior version of a resource.
+# Dump out all versions of a resource that has key=value pairs associated
+# with it for each version. These resources are built up via the store
+# command.
#
# Parameters:
# $cmd - Command keyword.
@@ -1984,11 +2645,16 @@ RegisterHandler("store", \&StoreHandler,
# 1 indicating the caller should not yet exit.
# Side-effects:
# Writes a reply to the client.
+# The reply is a string of the following shape:
+# version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
+# Where the 1 above represents version 1.
+# this continues for all pairs of keys in all versions.
+#
#
-sub RestoreHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
+#
+#
+sub restore_handler {
+ my ($cmd, $tail, $client) = @_;
my $userinput = "$cmd:$tail"; # Only used for logging purposes.
@@ -1996,7 +2662,7 @@ sub RestoreHandler {
$namespace=~s/\//\_/g;
$namespace=~s/\W//g;
chomp($rid);
- my $proname=propath($udom,$uname);
+ my $proname=&propath($udom,$uname);
my $qresult='';
my %hash;
if (tie(%hash,'GDBM_File',"$proname/$namespace.db",
@@ -2015,13 +2681,13 @@ sub RestoreHandler {
}
if (untie(%hash)) {
$qresult=~s/\&$//;
- Reply( $client, "$qresult\n", $userinput);
+ &Reply( $client, "$qresult\n", $userinput);
} else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
"while attempting restore\n", $userinput);
}
} else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
+ &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
"while attempting restore\n", $userinput);
}
@@ -2029,1367 +2695,698 @@ sub RestoreHandler {
}
-RegisterHandler("restor", \&RestoreHandler, 0,1,0);
-
-#
-# Add a chat message to to a discussion board.
-#
-# Parameters:
-# $cmd - Request keyword.
-# $tail - Tail of the command. A colon separated list
-# containing:
-# cdom - Domain on which the chat board lives
-# cnum - Identifier of the discussion group.
-# post - Body of the posting.
-# $client - Socket open on the client.
-# Returns:
-# 1 - Indicating caller should keep on processing.
-#
-# Side-effects:
-# writes a reply to the client.
-#
-#
-sub SendChatHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$tail";
-
- my ($cdom,$cnum,$newpost)=split(/\:/,$tail);
- &chatadd($cdom,$cnum,$newpost);
- Reply($client, "ok\n", $userinput);
-
- return 1;
-}
-RegisterHandler("chatsend", \&SendChatHandler, 0, 1, 0);
-#
-# Retrieve the set of chat messagss from a discussion board.
-#
-# Parameters:
-# $cmd - Command keyword that initiated the request.
-# $tail - Remainder of the request after the command
-# keyword. In this case a colon separated list of
-# chat domain - Which discussion board.
-# chat id - Discussion thread(?)
-# domain/user - Authentication domain and username
-# of the requesting person.
-# $client - Socket open on the client program.
-# Returns:
-# 1 - continue processing
-# Side effects:
-# Response is written to the client.
-#
-sub RetrieveChatHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$tail";
-
- my ($cdom,$cnum,$udom,$uname)=split(/\:/,$tail);
- my $reply='';
- foreach (&getchat($cdom,$cnum,$udom,$uname)) {
- $reply.=&escape($_).':';
- }
- $reply=~s/\:$//;
- Reply($client, $reply."\n", $userinput);
-
-
- return 1;
-}
-RegisterHandler("chatretr", \&RetrieveChatHandler, 0, 1, 0);
-#
-# Initiate a query of an sql database. SQL query repsonses get put in
-# a file for later retrieval. This prevents sql query results from
-# bottlenecking the system. Note that with loncnew, perhaps this is
-# less of an issue since multiple outstanding requests can be concurrently
-# serviced.
-#
-# Parameters:
-# $cmd - COmmand keyword that initiated the request.
-# $tail - Remainder of the command after the keyword.
-# For this function, this consists of a query and
-# 3 arguments that are self-documentingly labelled
-# in the original arg1, arg2, arg3.
-# $client - Socket open on the client.
-# Return:
-# 1 - Indicating processing should continue.
-# Side-effects:
-# a reply is written to $client.
-#
-sub SendQueryHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$tail";
-
- my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
- $query=~s/\n*$//g;
- Reply($client, "". sqlreply("$clientname\&$query".
- "\&$arg1"."\&$arg2"."\&$arg3")."\n",
- $userinput);
-
- return 1;
-}
-RegisterHandler("querysend", \&SendQueryHandler, 0, 1, 0);
-
-#
-# Add a reply to an sql query. SQL queries are done asyncrhonously.
-# The query is submitted via a "querysend" transaction.
-# There it is passed on to the lonsql daemon, queued and issued to
-# mysql.
-# This transaction is invoked when the sql transaction is complete
-# it stores the query results in flie and indicates query completion.
-# presumably local software then fetches this response... I'm guessing
-# the sequence is: lonc does a querysend, we ask lonsql to do it.
-# lonsql on completion of the query interacts with the lond of our
-# client to do a query reply storing two files:
-# - id - The results of the query.
-# - id.end - Indicating the transaction completed.
-# NOTE: id is a unique id assigned to the query and querysend time.
-# Parameters:
-# $cmd - Command keyword that initiated this request.
-# $tail - Remainder of the tail. In this case that's a colon
-# separated list containing the query Id and the
-# results of the query.
-# $client - Socket open on the client.
-# Return:
-# 1 - Indicating that we should continue processing.
-# Side effects:
-# ok written to the client.
-#
-sub ReplyQueryHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$tail";
-
- my ($cmd,$id,$reply)=split(/:/,$userinput);
- my $store;
- my $execdir=$perlvar{'lonDaemons'};
- if ($store=IO::File->new(">$execdir/tmp/$id")) {
- $reply=~s/\&/\n/g;
- print $store $reply;
- close $store;
- my $store2=IO::File->new(">$execdir/tmp/$id.end");
- print $store2 "done\n";
- close $store2;
- Reply($client, "ok\n", $userinput);
- } else {
- Failure($client, "error: ".($!+0)
- ." IO::File->new Failed ".
- "while attempting queryreply\n", $userinput);
- }
-
-
- return 1;
-}
-RegisterHandler("queryreply", \&ReplyQueryHandler, 0, 1, 0);
-#
-# Process the courseidput query. Not quite sure what this means
-# at the system level sense. It appears a gdbm file in the
-# /home/httpd/lonUsers/$domain/nohist_courseids is tied and
-# a set of entries made in that database.
-#
-# Parameters:
-# $cmd - The command keyword that initiated this request.
-# $tail - Tail of the command. In this case consists of a colon
-# separated list contaning the domain to apply this to and
-# an ampersand separated list of keyword=value pairs.
-# $client - Socket open on the client.
-# Returns:
-# 1 - indicating that processing should continue
-#
-# Side effects:
-# reply is written to the client.
-#
-sub PutCourseIdHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$tail";
-
- my ($udom,$what)=split(/:/,$tail);
- chomp($what);
- $udom=~s/\W//g;
- my $proname=
- "$perlvar{'lonUsersDir'}/$udom/nohist_courseids";
- my $now=time;
- my @pairs=split(/\&/,$what);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_WRCREAT(),0640)) {
- foreach my $pair (@pairs) {
- my ($key,$value)=split(/=/,$pair);
- $hash{$key}=$value.':'.$now;
- }
- if (untie(%hash)) {
- Reply($client, "ok\n", $userinput);
- } else {
- Failure( $client, "error: ".($!+0)
- ." untie(GDBM) Failed ".
- "while attempting courseidput\n", $userinput);
- }
- } else {
- Failure( $client, "error: ".($!+0)
- ." tie(GDBM) Failed ".
- "while attempting courseidput\n", $userinput);
- }
-
- return 1;
-}
-RegisterHandler("courseidput", \&PutCourseIdHandler, 0, 1, 0);
-
-# Retrieves the value of a course id resource keyword pattern
-# defined since a starting date. Both the starting date and the
-# keyword pattern are optional. If the starting date is not supplied it
-# is treated as the beginning of time. If the pattern is not found,
-# it is treatred as "." matching everything.
-#
-# Parameters:
-# $cmd - Command keyword that resulted in us being dispatched.
-# $tail - The remainder of the command that, in this case, consists
-# of a colon separated list of:
-# domain - The domain in which the course database is
-# defined.
-# since - Optional parameter describing the minimum
-# time of definition(?) of the resources that
-# will match the dump.
-# description - regular expression that is used to filter
-# the dump. Only keywords matching this regexp
-# will be used.
-# $client - The socket open on the client.
-# Returns:
-# 1 - Continue processing.
-# Side Effects:
-# a reply is written to $client.
-sub DumpCourseIdHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$tail";
-
- my ($udom,$since,$description) =split(/:/,$tail);
- if (defined($description)) {
- $description=&unescape($description);
- } else {
- $description='.';
- }
- unless (defined($since)) { $since=0; }
- my $qresult='';
- my $proname = "$perlvar{'lonUsersDir'}/$udom/nohist_courseids";
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_READER(),0640)) {
- while (my ($key,$value) = each(%hash)) {
- my ($descr,$lasttime)=split(/\:/,$value);
- if ($lasttime<$since) {
- next;
- }
- if ($description eq '.') {
- $qresult.=$key.'='.$descr.'&';
- } else {
- my $unescapeVal = &unescape($descr);
- if (eval('$unescapeVal=~/$description/i')) {
- $qresult.="$key=$descr&";
- }
- }
- }
- if (untie(%hash)) {
- chop($qresult);
- Reply($client, "$qresult\n", $userinput);
- } else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
- "while attempting courseiddump\n", $userinput);
- }
- } else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting courseiddump\n", $userinput);
- }
-
-
- return 1;
-}
-RegisterHandler("courseiddump", \&DumpCourseIdHandler, 0, 1, 0);
-#
-# Puts an id to a domains id database.
-#
-# Parameters:
-# $cmd - The command that triggered us.
-# $tail - Remainder of the request other than the command. This is a
-# colon separated list containing:
-# $domain - The domain for which we are writing the id.
-# $pairs - The id info to write... this is and & separated list
-# of keyword=value.
-# $client - Socket open on the client.
-# Returns:
-# 1 - Continue processing.
-# Side effects:
-# reply is written to $client.
-#
-sub PutIdHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$tail";
-
- my ($udom,$what)=split(/:/,$tail);
- chomp($what);
- $udom=~s/\W//g;
- my $proname="$perlvar{'lonUsersDir'}/$udom/ids";
- my $now=time;
- {
- my $hfh;
- if ($hfh=IO::File->new(">>$proname.hist")) {
- print $hfh "P:$now:$what\n";
- }
- }
- my @pairs=split(/\&/,$what);
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_WRCREAT(),0640)) {
- foreach my $pair (@pairs) {
- my ($key,$value)=split(/=/,$pair);
- $hash{$key}=$value;
- }
- if (untie(%hash)) {
- Reply($client, "ok\n", $userinput);
- } else {
- Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
- "while attempting idput\n", $userinput);
- }
- } else {
- Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting idput\n", $userinput);
- }
-
- return 1;
-}
-
-RegisterHandler("idput", \&PutIdHandler, 0, 1, 0);
+®ister_handler("restore", \&restore_handler, 0,1,0);
#
-# Retrieves a set of id values from the id database.
-# Returns an & separated list of results, one for each requested id to the
-# client.
#
-# Parameters:
-# $cmd - Command keyword that caused us to be dispatched.
-# $tail - Tail of the command. Consists of a colon separated:
-# domain - the domain whose id table we dump
-# ids Consists of an & separated list of
-# id keywords whose values will be fetched.
-# nonexisting keywords will have an empty value.
-# $client - Socket open on the client.
+#---------------------------------------------------------------
#
-# Returns:
-# 1 - indicating processing should continue.
-# Side effects:
-# An & separated list of results is written to $client.
+# Getting, decoding and dispatching requests:
#
-sub GetIdHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$client:$tail";
-
- my ($udom,$what)=split(/:/,$tail);
- chomp($what);
- $udom=~s/\W//g;
- my $proname="$perlvar{'lonUsersDir'}/$udom/ids";
- my @queries=split(/\&/,$what);
- my $qresult='';
- my %hash;
- if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_READER(),0640)) {
- for (my $i=0;$i<=$#queries;$i++) {
- $qresult.="$hash{$queries[$i]}&";
- }
- if (untie(%hash)) {
- $qresult=~s/\&$//;
- Reply($client, "$qresult\n", $userinput);
- } else {
- Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
- "while attempting idget\n",$userinput);
- }
- } else {
- Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
- "while attempting idget\n",$userinput);
- }
-
- return 1;
-}
-RegisterHandler("idget", \&GetIdHandler, 0, 1, 0);
#
-# Process the tmpput command I'm not sure what this does.. Seems to
-# create a file in the lonDaemons/tmp directory of the form $id.tmp
-# where Id is the client's ip concatenated with a sequence number.
-# The file will contain some value that is passed in. Is this e.g.
-# a login token?
+# Get a Request:
+# Gets a Request message from the client. The transaction
+# is defined as a 'line' of text. We remove the new line
+# from the text line.
#
-# Parameters:
-# $cmd - The command that got us dispatched.
-# $tail - The remainder of the request following $cmd:
-# In this case this will be the contents of the file.
-# $client - Socket connected to the client.
-# Returns:
-# 1 indicating processing can continue.
-# Side effects:
-# A file is created in the local filesystem.
-# A reply is sent to the client.
-sub TmpPutHandler {
- my $cmd = shift;
- my $what = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$what"; # Reconstruct for logging.
-
-
- my $store;
- $tmpsnum++;
- my $id=$$.'_'.$clientip.'_'.$tmpsnum;
- $id=~s/\W/\_/g;
- $what=~s/\n//g;
- my $execdir=$perlvar{'lonDaemons'};
- if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
- print $store $what;
- close $store;
- Reply($client, "$id\n", $userinput);
- } else {
- Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
- "while attempting tmpput\n", $userinput);
- }
- return 1;
-
-}
-RegisterHandler("tmpput", \&TmpPutHandler, 0, 1, 0);
+sub get_request {
+ my $input = <$client>;
+ chomp($input);
-# Processes the tmpget command. This command returns the contents
-# of a temporary resource file(?) created via tmpput.
-#
-# Paramters:
-# $cmd - Command that got us dispatched.
-# $id - Tail of the command, contain the id of the resource
-# we want to fetch.
-# $client - socket open on the client.
-# Return:
-# 1 - Inidcating processing can continue.
-# Side effects:
-# A reply is sent to the client.
+ Debug("get_request: Request = $input\n");
-#
-sub TmpGetHandler {
- my $cmd = shift;
- my $id = shift;
- my $client = shift;
- my $userinput = "$cmd:$id";
-
- chomp($id);
- $id=~s/\W/\_/g;
- my $store;
- my $execdir=$perlvar{'lonDaemons'};
- if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
- my $reply=<$store>;
- Reply( $client, "$reply\n", $userinput);
- close $store;
- } else {
- Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
- "while attempting tmpget\n", $userinput);
- }
+ &status('Processing '.$clientname.':'.$input);
- return 1;
+ return $input;
}
-RegisterHandler("tmpget", \&TmpGetHandler, 0, 1, 0);
+#---------------------------------------------------------------
#
-# Process the tmpdel command. This command deletes a temp resource
-# created by the tmpput command.
+# Process a request. This sub should shrink as each action
+# gets farmed out into a separat sub that is registered
+# with the dispatch hash.
#
# Parameters:
-# $cmd - Command that got us here.
-# $id - Id of the temporary resource created.
-# $client - socket open on the client process.
-#
+# user_input - The request received from the client (lonc).
# Returns:
-# 1 - Indicating processing should continue.
-# Side Effects:
-# A file is deleted
-# A reply is sent to the client.
-sub TmpDelHandler {
- my $cmd = shift;
- my $id = shift;
- my $client = shift;
-
- my $userinput= "$cmd:$id";
-
- chomp($id);
- $id=~s/\W/\_/g;
- my $execdir=$perlvar{'lonDaemons'};
- if (unlink("$execdir/tmp/$id.tmp")) {
- Reply($client, "ok\n", $userinput);
- } else {
- Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
- "while attempting tmpdel\n", $userinput);
- }
-
- return 1;
-
-}
-RegisterHandler("tmpdel", \&TmpDelHandler, 0, 1, 0);
+# true to keep processing, false if caller should exit.
#
-# ls - list the contents of a directory. For each file in the
-# selected directory the filename followed by the full output of
-# the stat function is returned. The returned info for each
-# file are separated by ':'. The stat fields are separated by &'s.
-# Parameters:
-# $cmd - The command that dispatched us (ls).
-# $ulsdir - The directory path to list... I'm not sure what this
-# is relative as things like ls:. return e.g.
-# no_such_dir.
-# $client - Socket open on the client.
-# Returns:
-# 1 - indicating that the daemon should not disconnect.
-# Side Effects:
-# The reply is written to $client.
-#
-sub LsHandler {
- my $cmd = shift;
- my $ulsdir = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$ulsdir";
-
- my $ulsout='';
- my $ulsfn;
- if (-e $ulsdir) {
- if(-d $ulsdir) {
- if (opendir(LSDIR,$ulsdir)) {
- while ($ulsfn=readdir(LSDIR)) {
- my @ulsstats=stat($ulsdir.'/'.$ulsfn);
- $ulsout.=$ulsfn.'&'.
- join('&',@ulsstats).':';
- }
- closedir(LSDIR);
- }
- } else {
- my @ulsstats=stat($ulsdir);
- $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
+sub process_request {
+ my ($userinput) = @_; # Easier for now to break style than to
+ # fix all the userinput -> user_input.
+ my $wasenc = 0; # True if request was encrypted.
+# ------------------------------------------------------------ See if encrypted
+ if ($userinput =~ /^enc/) {
+ $userinput = decipher($userinput);
+ $wasenc=1;
+ if(!$userinput) { # Cipher not defined.
+ &Failure($client, "error: Encrypted data without negotated key");
+ return 0;
}
- } else {
- $ulsout='no_such_dir';
}
- if ($ulsout eq '') { $ulsout='empty'; }
- Reply($client, "$ulsout\n", $userinput);
-
-
- return 1;
-}
-RegisterHandler("ls", \&LsHandler, 0, 1, 0);
-
-
-#
-# Processes the setannounce command. This command
-# creates a file named announce.txt in the top directory of
-# the documentn root and sets its contents. The announce.txt file is
-# printed in its entirety at the LonCAPA login page. Note:
-# once the announcement.txt fileis created it cannot be deleted.
-# However, setting the contents of the file to empty removes the
-# announcement from the login page of loncapa so who cares.
-#
-# Parameters:
-# $cmd - The command that got us dispatched.
-# $announcement - The text of the announcement.
-# $client - Socket open on the client process.
-# Retunrns:
-# 1 - Indicating request processing should continue
-# Side Effects:
-# The file {DocRoot}/announcement.txt is created.
-# A reply is sent to $client.
-#
-sub SetAnnounceHandler {
- my $cmd = shift;
- my $announcement = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$announcement";
-
- chomp($announcement);
- $announcement=&unescape($announcement);
- if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
- '/announcement.txt')) {
- print $store $announcement;
- close $store;
- Reply($client, "ok\n", $userinput);
- } else {
- Failure($client, "error: ".($!+0)."\n", $userinput);
- }
-
- return 1;
-}
-RegisterHandler("setannounce", \&SetAnnounceHandler, 0, 1, 0);
-
-#
-# Return the version of the daemon. This can be used to determine
-# the compatibility of cross version installations or, alternatively to
-# simply know who's out of date and who isn't. Note that the version
-# is returned concatenated with the tail.
-# Parameters:
-# $cmd - the request that dispatched to us.
-# $tail - Tail of the request (client's version?).
-# $client - Socket open on the client.
-#Returns:
-# 1 - continue processing requests.
-# Side Effects:
-# Replies with version to $client.
-sub GetVersionHandler {
- my $client = shift;
- my $tail = shift;
- my $client = shift;
- my $userinput = $client;
-
- Reply($client, &version($userinput)."\n", $userinput);
-
-
- return 1;
-}
-RegisterHandler("version", \&GetVersionHandler, 0, 1, 0);
-
-# Set the current host and domain. This is used to support
-# multihomed systems. Each IP of the system, or even separate daemons
-# on the same IP can be treated as handling a separate lonCAPA virtual
-# machine. This command selects the virtual lonCAPA. The client always
-# knows the right one since it is lonc and it is selecting the domain/system
-# from the hosts.tab file.
-# Parameters:
-# $cmd - Command that dispatched us.
-# $tail - Tail of the command (domain/host requested).
-# $socket - Socket open on the client.
-#
-# Returns:
-# 1 - Indicates the program should continue to process requests.
-# Side-effects:
-# The default domain/system context is modified for this daemon.
-# a reply is sent to the client.
-#
-sub SelectHostHandler {
- my $cmd = shift;
- my $tail = shift;
- my $socket = shift;
-
- my $userinput ="$cmd:$tail";
-
- Reply($client, &sethost($userinput)."\n", $userinput);
-
-
- return 1;
-}
-RegisterHandler("sethost", \&SelectHostHandler, 0, 1, 0);
-
-# Process a request to exit:
-# - "bye" is sent to the client.
-# - The client socket is shutdown and closed.
-# - We indicate to the caller that we should exit.
-# Formal Parameters:
-# $cmd - The command that got us here.
-# $tail - Tail of the command (empty).
-# $client - Socket open on the tail.
-# Returns:
-# 0 - Indicating the program should exit!!
-#
-sub ExitHandler {
- my $cmd = shift;
- my $tail = shift;
- my $client = shift;
-
- my $userinput = "$cmd:$tail";
-
- &logthis("Client $clientip ($clientname) hanging up: $userinput");
- Reply($client, "bye\n", $userinput);
- $client->shutdown(2); # shutdown the socket forcibly.
- $client->close();
-
- return 0;
-}
-RegisterHandler("exit", \&ExitHandler, 0, 1,1);
-RegisterHandler("init", \&ExitHandler, 0, 1,1); # RE-init is like exit.
-RegisterHandler("quit", \&ExitHandler, 0, 1,1); # I like this too!
-#------------------------------------------------------------------------------------
-#
-# Process a Request. Takes a request from the client validates
-# it and performs the operation requested by it. Returns
-# a response to the client.
-#
-# Parameters:
-# request - A string containing the user's request.
-# Returns:
-# 0 - Requested to exit, caller should shut down.
-# 1 - Accept additional requests from the client.
-#
-sub ProcessRequest {
- my $Request = shift;
- my $KeepGoing = 1; # Assume we're not asked to stop.
+ Debug("process_request: $userinput\n");
- my $wasenc=0;
- my $userinput = $Request; # for compatibility with oldcode
+ #
+ # The 'correct way' to add a command to lond is now to
+ # write a sub to execute it and Add it to the command dispatch
+ # hash via a call to register_handler.. The comments to that
+ # sub should give you enough to go on to show how to do this
+ # along with the examples that are building up as this code
+ # is getting refactored. Until all branches of the
+ # if/elseif monster below have been factored out into
+ # separate procesor subs, if the dispatch hash is missing
+ # the command keyword, we will fall through to the remainder
+ # of the if/else chain below in order to keep this thing in
+ # working order throughout the transmogrification.
-
-# ------------------------------------------------------------ See if encrypted
-
- if($userinput =~ /^enc/) {
- $wasenc = 1;
- $userinput = Decipher($userinput);
- if(! $userinput) {
- Failure($client,"error:Encrypted data without negotiating key");
- return 0; # Break off with this imposter.
- }
- }
- # Split off the request keyword from the rest of the stuff.
-
my ($command, $tail) = split(/:/, $userinput, 2);
+ chomp($command);
+ chomp($tail);
+ $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
+ $command =~ s/(\r)//; # And this too for parameterless commands.
+ if(!$tail) {
+ $tail =""; # defined but blank.
+ }
- Debug("Command received: $command, encoded = $wasenc");
-
-
-# ------------------------------------------------------------- Normal commands
+ &Debug("Command received: $command, encoded = $wasenc");
- #
- # If the command is in the hash, then execute it via the hash dispatch:
- #
if(defined $Dispatcher{$command}) {
- my $DispatchInfo = $Dispatcher{$command};
- my $Handler = $$DispatchInfo[0];
- my $NeedEncode = $$DispatchInfo[1];
- my $ClientTypes = $$DispatchInfo[2];
- Debug("Matched dispatch hash: mustencode: $NeedEncode ClientType $ClientTypes");
+ my $dispatch_info = $Dispatcher{$command};
+ my $handler = $$dispatch_info[0];
+ my $need_encode = $$dispatch_info[1];
+ my $client_types = $$dispatch_info[2];
+ Debug("Matched dispatch hash: mustencode: $need_encode "
+ ."ClientType $client_types");
# Validate the request:
my $ok = 1;
my $requesterprivs = 0;
- if(isClient()) {
+ if(&isClient()) {
$requesterprivs |= $CLIENT_OK;
}
- if(isManager()) {
+ if(&isManager()) {
$requesterprivs |= $MANAGER_OK;
}
- if($NeedEncode && (!$wasenc)) {
- Debug("Must encode but wasn't: $NeedEncode $wasenc");
+ if($need_encode && (!$wasenc)) {
+ Debug("Must encode but wasn't: $need_encode $wasenc");
$ok = 0;
}
- if(($ClientTypes & $requesterprivs) == 0) {
+ if(($client_types & $requesterprivs) == 0) {
Debug("Client not privileged to do this operation");
$ok = 0;
}
if($ok) {
Debug("Dispatching to handler $command $tail");
- $KeepGoing = &$Handler($command, $tail, $client);
+ my $keep_going = &$handler($command, $tail, $client);
+ return $keep_going;
} else {
- Debug("Refusing to dispatch because ok is false");
- Failure($client, "refused", $userinput);
+ Debug("Refusing to dispatch because client did not match requirements");
+ Failure($client, "refused\n", $userinput);
+ return 1;
}
+ }
-# ------------------------------------------------------------- unknown command
-
- } else {
- # unknown command
- Failure($client, "unknown_cmd\n", $userinput);
- }
+#------------------- Commands not yet in spearate handlers. --------------
- return $KeepGoing;
-}
-#
-# GetCertificate: Given a transaction that requires a certificate,
-# this function will extract the certificate from the transaction
-# request. Note that at this point, the only concept of a certificate
-# is the hostname to which we are connected.
-#
-# Parameter:
-# request - The request sent by our client (this parameterization may
-# need to change when we really use a certificate granting
-# authority.
-#
-sub GetCertificate {
- my $request = shift;
-
- return $clientip;
-}
-
-
-
-#
-# ReadManagerTable: Reads in the current manager table. For now this is
-# done on each manager authentication because:
-# - These authentications are not frequent
-# - This allows dynamic changes to the manager table
-# without the need to signal to the lond.
-#
-
-sub ReadManagerTable {
-
- # Clean out the old table first..
-
- foreach my $key (keys %managers) {
- delete $managers{$key};
- }
-
- my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
- if (!open (MANAGERS, $tablename)) {
- logthis('No manager table. Nobody can manage!!');
- return;
- }
- while(my $host = ) {
- chomp($host);
- if ($host =~ "^#") { # Comment line.
- logthis(' Skipping line: '. "$host\n");
- next;
+# -------------------------------------------------------------------- chatsend
+ if ($userinput =~ /^chatsend/) {
+ if(isClient) {
+ my ($cmd,$cdom,$cnum,$newpost)=split(/\:/,$userinput);
+ &chatadd($cdom,$cnum,$newpost);
+ print $client "ok\n";
+ } else {
+ Reply($client, "refused\n", $userinput);
+
}
- if (!defined $hostip{$host}) { # This is a non cluster member
- # The entry is of the form:
- # cluname:hostname
- # cluname - A 'cluster hostname' is needed in order to negotiate
- # the host key.
- # hostname- The dns name of the host.
- #
- my($cluname, $dnsname) = split(/:/, $host);
+# -------------------------------------------------------------------- chatretr
+ } elsif ($userinput =~ /^chatretr/) {
+ if(isClient) {
+ my
+ ($cmd,$cdom,$cnum,$udom,$uname)=split(/\:/,$userinput);
+ my $reply='';
+ foreach (&getchat($cdom,$cnum,$udom,$uname)) {
+ $reply.=&escape($_).':';
+ }
+ $reply=~s/\:$//;
+ print $client $reply."\n";
+ } else {
+ Reply($client, "refused\n", $userinput);
+
+ }
+# ------------------------------------------------------------------- querysend
+ } elsif ($userinput =~ /^querysend/) {
+ if (isClient) {
+ my ($cmd,$query,
+ $arg1,$arg2,$arg3)=split(/\:/,$userinput);
+ $query=~s/\n*$//g;
+ print $client "".
+ sqlreply("$clientname\&$query".
+ "\&$arg1"."\&$arg2"."\&$arg3")."\n";
+ } else {
+ Reply($client, "refused\n", $userinput);
- my $ip = gethostbyname($dnsname);
- if(defined($ip)) { # bad names don't deserve entry.
- my $hostip = inet_ntoa($ip);
- $managers{$hostip} = $cluname;
- logthis(' registering manager '.
- "$dnsname as $cluname with $hostip \n");
+ }
+# ------------------------------------------------------------------ queryreply
+ } elsif ($userinput =~ /^queryreply/) {
+ if(isClient) {
+ my ($cmd,$id,$reply)=split(/:/,$userinput);
+ my $store;
+ my $execdir=$perlvar{'lonDaemons'};
+ if ($store=IO::File->new(">$execdir/tmp/$id")) {
+ $reply=~s/\&/\n/g;
+ print $store $reply;
+ close $store;
+ my $store2=IO::File->new(">$execdir/tmp/$id.end");
+ print $store2 "done\n";
+ close $store2;
+ print $client "ok\n";
+ } else {
+ print $client "error: ".($!+0)
+ ." IO::File->new Failed ".
+ "while attempting queryreply\n";
}
} else {
- logthis(' existing host'." $host\n");
- $managers{$hostip{$host}} = $host; # Use info from cluster tab if clumemeber
+ Reply($client, "refused\n", $userinput);
+
}
- }
-}
-
-#
-# ValidManager: Determines if a given certificate represents a valid manager.
-# in this primitive implementation, the 'certificate' is
-# just the connecting loncapa client name. This is checked
-# against a valid client list in the configuration.
-#
-#
-sub ValidManager {
- my $certificate = shift;
-
- return isManager;
-}
-#
-# CopyFile: Called as part of the process of installing a
-# new configuration file. This function copies an existing
-# file to a backup file.
-# Parameters:
-# oldfile - Name of the file to backup.
-# newfile - Name of the backup file.
-# Return:
-# 0 - Failure (errno has failure reason).
-# 1 - Success.
-#
-sub CopyFile {
- my $oldfile = shift;
- my $newfile = shift;
-
- # The file must exist:
-
- if(-e $oldfile) {
-
- # Read the old file.
-
- my $oldfh = IO::File->new("< $oldfile");
- if(!$oldfh) {
- return 0;
+# ----------------------------------------------------------------- courseidput
+ } elsif ($userinput =~ /^courseidput/) {
+ if(isClient) {
+ my ($cmd,$udom,$what)=split(/:/,$userinput);
+ chomp($what);
+ $udom=~s/\W//g;
+ my $proname=
+ "$perlvar{'lonUsersDir'}/$udom/nohist_courseids";
+ my $now=time;
+ my @pairs=split(/\&/,$what);
+ my %hash;
+ if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_WRCREAT(),0640)) {
+ foreach my $pair (@pairs) {
+ my ($key,$descr,$inst_code)=split(/=/,$pair);
+ $hash{$key}=$descr.':'.$inst_code.':'.$now;
+ }
+ if (untie(%hash)) {
+ print $client "ok\n";
+ } else {
+ print $client "error: ".($!+0)
+ ." untie(GDBM) Failed ".
+ "while attempting courseidput\n";
+ }
+ } else {
+ print $client "error: ".($!+0)
+ ." tie(GDBM) Failed ".
+ "while attempting courseidput\n";
+ }
+ } else {
+ Reply($client, "refused\n", $userinput);
+
}
- my @contents = <$oldfh>; # Suck in the entire file.
-
- # write the backup file:
-
- my $newfh = IO::File->new("> $newfile");
- if(!(defined $newfh)){
- return 0;
+# ---------------------------------------------------------------- courseiddump
+ } elsif ($userinput =~ /^courseiddump/) {
+ if(isClient) {
+ my ($cmd,$udom,$since,$description)
+ =split(/:/,$userinput);
+ if (defined($description)) {
+ $description=&unescape($description);
+ } else {
+ $description='.';
+ }
+ unless (defined($since)) { $since=0; }
+ my $qresult='';
+ my $proname=
+ "$perlvar{'lonUsersDir'}/$udom/nohist_courseids";
+ my %hash;
+ if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_READER(),0640)) {
+ while (my ($key,$value) = each(%hash)) {
+ my ($descr,$lasttime,$inst_code);
+ if ($value =~ m/^([^\:]*):([^\:]*):(\d+)$/) {
+ ($descr,$inst_code,$lasttime)=($1,$2,$3);
+ } else {
+ ($descr,$lasttime) = split(/\:/,$value);
+ }
+ if ($lasttime<$since) { next; }
+ if ($description eq '.') {
+ $qresult.=$key.'='.$descr.':'.$inst_code.'&';
+ } else {
+ my $unescapeVal = &unescape($descr);
+ if (eval('$unescapeVal=~/\Q$description\E/i')) {
+ $qresult.=$key.'='.$descr.':'.$inst_code.'&';
+ }
+ }
+ }
+ if (untie(%hash)) {
+ chop($qresult);
+ print $client "$qresult\n";
+ } else {
+ print $client "error: ".($!+0)
+ ." untie(GDBM) Failed ".
+ "while attempting courseiddump\n";
+ }
+ } else {
+ print $client "error: ".($!+0)
+ ." tie(GDBM) Failed ".
+ "while attempting courseiddump\n";
+ }
+ } else {
+ Reply($client, "refused\n", $userinput);
+
}
- my $lines = scalar @contents;
- for (my $i =0; $i < $lines; $i++) {
- print $newfh ($contents[$i]);
+# ----------------------------------------------------------------------- idput
+ } elsif ($userinput =~ /^idput/) {
+ if(isClient) {
+ my ($cmd,$udom,$what)=split(/:/,$userinput);
+ chomp($what);
+ $udom=~s/\W//g;
+ my $proname="$perlvar{'lonUsersDir'}/$udom/ids";
+ my $now=time;
+ my @pairs=split(/\&/,$what);
+ my %hash;
+ if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_WRCREAT(),0640)) {
+ {
+ my $hfh;
+ if ($hfh=IO::File->new(">>$proname.hist")) {
+ print $hfh "P:$now:$what\n";
+ }
+ }
+ foreach my $pair (@pairs) {
+ my ($key,$value)=split(/=/,$pair);
+ $hash{$key}=$value;
+ }
+ if (untie(%hash)) {
+ print $client "ok\n";
+ } else {
+ print $client "error: ".($!+0)
+ ." untie(GDBM) Failed ".
+ "while attempting idput\n";
+ }
+ } else {
+ print $client "error: ".($!+0)
+ ." tie(GDBM) Failed ".
+ "while attempting idput\n";
+ }
+ } else {
+ Reply($client, "refused\n", $userinput);
+
}
-
- $oldfh->close;
- $newfh->close;
-
- chmod(0660, $newfile);
-
- return 1;
+# ----------------------------------------------------------------------- idget
+ } elsif ($userinput =~ /^idget/) {
+ if(isClient) {
+ my ($cmd,$udom,$what)=split(/:/,$userinput);
+ chomp($what);
+ $udom=~s/\W//g;
+ my $proname="$perlvar{'lonUsersDir'}/$udom/ids";
+ my @queries=split(/\&/,$what);
+ my $qresult='';
+ my %hash;
+ if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_READER(),0640)) {
+ for (my $i=0;$i<=$#queries;$i++) {
+ $qresult.="$hash{$queries[$i]}&";
+ }
+ if (untie(%hash)) {
+ $qresult=~s/\&$//;
+ print $client "$qresult\n";
+ } else {
+ print $client "error: ".($!+0)
+ ." untie(GDBM) Failed ".
+ "while attempting idget\n";
+ }
+ } else {
+ print $client "error: ".($!+0)
+ ." tie(GDBM) Failed ".
+ "while attempting idget\n";
+ }
+ } else {
+ Reply($client, "refused\n", $userinput);
- } else {
- return 0;
- }
-}
-#
-# Host files are passed out with externally visible host IPs.
-# If, for example, we are behind a fire-wall or NAT host, our
-# internally visible IP may be different than the externally
-# visible IP. Therefore, we always adjust the contents of the
-# host file so that the entry for ME is the IP that we believe
-# we have. At present, this is defined as the entry that
-# DNS has for us. If by some chance we are not able to get a
-# DNS translation for us, then we assume that the host.tab file
-# is correct.
-# BUGBUGBUG - in the future, we really should see if we can
-# easily query the interface(s) instead.
-# Parameter(s):
-# contents - The contents of the host.tab to check.
-# Returns:
-# newcontents - The adjusted contents.
-#
-#
-sub AdjustHostContents {
- my $contents = shift;
- my $adjusted;
- my $me = $perlvar{'lonHostID'};
-
- foreach my $line (split(/\n/,$contents)) {
- if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {
- chomp($line);
- my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
- if ($id eq $me) {
- my $ip = gethostbyname($name);
- my $ipnew = inet_ntoa($ip);
- $ip = $ipnew;
- # Reconstruct the host line and append to adjusted:
-
- my $newline = "$id:$domain:$role:$name:$ip";
- if($maxcon ne "") { # Not all hosts have loncnew tuning params
- $newline .= ":$maxcon:$idleto:$mincon";
+ }
+# ---------------------------------------------------------------------- tmpput
+ } elsif ($userinput =~ /^tmpput/) {
+ if(isClient) {
+ my ($cmd,$what)=split(/:/,$userinput);
+ my $store;
+ $tmpsnum++;
+ my $id=$$.'_'.$clientip.'_'.$tmpsnum;
+ $id=~s/\W/\_/g;
+ $what=~s/\n//g;
+ my $execdir=$perlvar{'lonDaemons'};
+ if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
+ print $store $what;
+ close $store;
+ print $client "$id\n";
+ }
+ else {
+ print $client "error: ".($!+0)
+ ."IO::File->new Failed ".
+ "while attempting tmpput\n";
+ }
+ } else {
+ Reply($client, "refused\n", $userinput);
+
+ }
+
+# ---------------------------------------------------------------------- tmpget
+ } elsif ($userinput =~ /^tmpget/) {
+ if(isClient) {
+ my ($cmd,$id)=split(/:/,$userinput);
+ chomp($id);
+ $id=~s/\W/\_/g;
+ my $store;
+ my $execdir=$perlvar{'lonDaemons'};
+ if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
+ my $reply=<$store>;
+ print $client "$reply\n";
+ close $store;
+ }
+ else {
+ print $client "error: ".($!+0)
+ ."IO::File->new Failed ".
+ "while attempting tmpget\n";
+ }
+ } else {
+ Reply($client, "refused\n", $userinput);
+
+ }
+# ---------------------------------------------------------------------- tmpdel
+ } elsif ($userinput =~ /^tmpdel/) {
+ if(isClient) {
+ my ($cmd,$id)=split(/:/,$userinput);
+ chomp($id);
+ $id=~s/\W/\_/g;
+ my $execdir=$perlvar{'lonDaemons'};
+ if (unlink("$execdir/tmp/$id.tmp")) {
+ print $client "ok\n";
+ } else {
+ print $client "error: ".($!+0)
+ ."Unlink tmp Failed ".
+ "while attempting tmpdel\n";
+ }
+ } else {
+ Reply($client, "refused\n", $userinput);
+
+ }
+# ----------------------------------------- portfolio directory list (portls)
+ } elsif ($userinput =~ /^portls/) {
+ if(isClient) {
+ my ($cmd,$uname,$udom)=split(/:/,$userinput);
+ my $udir=propath($udom,$uname).'/userfiles/portfolio';
+ my $dirLine='';
+ my $dirContents='';
+ if (opendir(LSDIR,$udir.'/')){
+ while ($dirLine = readdir(LSDIR)){
+ $dirContents = $dirContents.$dirLine.'
';
}
- $adjusted .= $newline."\n";
-
- } else { # Not me, pass unmodified.
- $adjusted .= $line."\n";
+ } else {
+ $dirContents = "No directory found\n";
}
- } else { # Blank or comment never re-written.
- $adjusted .= $line."\n"; # Pass blanks and comments as is.
+ print $client $dirContents."\n";
+ } else {
+ Reply($client, "refused\n", $userinput);
}
- }
- return $adjusted;
-}
-#
-# InstallFile: Called to install an administrative file:
-# - The file is created with .tmp
-# - The .tmp file is then mv'd to
-# This lugubrious procedure is done to ensure that we are never without
-# a valid, even if dated, version of the file regardless of who crashes
-# and when the crash occurs.
-#
-# Parameters:
-# Name of the file
-# File Contents.
-# Return:
-# nonzero - success.
-# 0 - failure and $! has an errno.
-#
-sub InstallFile {
- my $Filename = shift;
- my $Contents = shift;
- my $TempFile = $Filename.".tmp";
-
- # Open the file for write:
-
- my $fh = IO::File->new("> $TempFile"); # Write to temp.
- if(!(defined $fh)) {
- &logthis(' Unable to create '.$TempFile."");
+# -------------------------------------------------------------------------- ls
+ } elsif ($userinput =~ /^ls/) {
+ if(isClient) {
+ my $obs;
+ my $rights;
+ my ($cmd,$ulsdir)=split(/:/,$userinput);
+ my $ulsout='';
+ my $ulsfn;
+ if (-e $ulsdir) {
+ if(-d $ulsdir) {
+ if (opendir(LSDIR,$ulsdir)) {
+ while ($ulsfn=readdir(LSDIR)) {
+ undef $obs, $rights;
+ my @ulsstats=stat($ulsdir.'/'.$ulsfn);
+ #We do some obsolete checking here
+ if(-e $ulsdir.'/'.$ulsfn.".meta") {
+ open(FILE, $ulsdir.'/'.$ulsfn.".meta");
+ my @obsolete=;
+ foreach my $obsolete (@obsolete) {
+ if($obsolete =~ m|()(on)|) { $obs = 1; }
+ if($obsolete =~ m|()(default)|) { $rights = 1; }
+ }
+ }
+ $ulsout.=$ulsfn.'&'.join('&',@ulsstats);
+ if($obs eq '1') { $ulsout.="&1"; }
+ else { $ulsout.="&0"; }
+ if($rights eq '1') { $ulsout.="&1:"; }
+ else { $ulsout.="&0:"; }
+ }
+ closedir(LSDIR);
+ }
+ } else {
+ my @ulsstats=stat($ulsdir);
+ $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
+ }
+ } else {
+ $ulsout='no_such_dir';
+ }
+ if ($ulsout eq '') { $ulsout='empty'; }
+ print $client "$ulsout\n";
+ } else {
+ Reply($client, "refused\n", $userinput);
+
+ }
+# ----------------------------------------------------------------- setannounce
+ } elsif ($userinput =~ /^setannounce/) {
+ if (isClient) {
+ my ($cmd,$announcement)=split(/:/,$userinput);
+ chomp($announcement);
+ $announcement=&unescape($announcement);
+ if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
+ '/announcement.txt')) {
+ print $store $announcement;
+ close $store;
+ print $client "ok\n";
+ } else {
+ print $client "error: ".($!+0)."\n";
+ }
+ } else {
+ Reply($client, "refused\n", $userinput);
+
+ }
+# ------------------------------------------------------------------ Hanging up
+ } elsif (($userinput =~ /^exit/) ||
+ ($userinput =~ /^init/)) { # no restrictions.
+ &logthis(
+ "Client $clientip ($clientname) hanging up: $userinput");
+ print $client "bye\n";
+ $client->shutdown(2); # shutdown the socket forcibly.
+ $client->close();
return 0;
+
+# ---------------------------------- set current host/domain
+ } elsif ($userinput =~ /^sethost/) {
+ if (isClient) {
+ print $client &sethost($userinput)."\n";
+ } else {
+ print $client "refused\n";
+ }
+#---------------------------------- request file (?) version.
+ } elsif ($userinput =~/^version/) {
+ if (isClient) {
+ print $client &version($userinput)."\n";
+ } else {
+ print $client "refused\n";
+ }
+#------------------------------- is auto-enrollment enabled?
+ } elsif ($userinput =~/^autorun/) {
+ if (isClient) {
+ my ($cmd,$cdom) = split(/:/,$userinput);
+ my $outcome = &localenroll::run($cdom);
+ print $client "$outcome\n";
+ } else {
+ print $client "0\n";
+ }
+#------------------------------- get official sections (for auto-enrollment).
+ } elsif ($userinput =~/^autogetsections/) {
+ if (isClient) {
+ my ($cmd,$coursecode,$cdom)=split(/:/,$userinput);
+ my @secs = &localenroll::get_sections($coursecode,$cdom);
+ my $seclist = &escape(join(':',@secs));
+ print $client "$seclist\n";
+ } else {
+ print $client "refused\n";
+ }
+#----------------------- validate owner of new course section (for auto-enrollment).
+ } elsif ($userinput =~/^autonewcourse/) {
+ if (isClient) {
+ my ($cmd,$inst_course_id,$owner,$cdom)=split(/:/,$userinput);
+ my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom);
+ print $client "$outcome\n";
+ } else {
+ print $client "refused\n";
+ }
+#-------------- validate course section in schedule of classes (for auto-enrollment).
+ } elsif ($userinput =~/^autovalidatecourse/) {
+ if (isClient) {
+ my ($cmd,$inst_course_id,$cdom)=split(/:/,$userinput);
+ my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
+ print $client "$outcome\n";
+ } else {
+ print $client "refused\n";
+ }
+#--------------------------- create password for new user (for auto-enrollment).
+ } elsif ($userinput =~/^autocreatepassword/) {
+ if (isClient) {
+ my ($cmd,$authparam,$cdom)=split(/:/,$userinput);
+ my ($create_passwd,$authchk);
+ ($authparam,$create_passwd,$authchk) = &localenroll::create_password($authparam,$cdom);
+ print $client &escape($authparam.':'.$create_passwd.':'.$authchk)."\n";
+ } else {
+ print $client "refused\n";
+ }
+#--------------------------- read and remove temporary files (for auto-enrollment).
+ } elsif ($userinput =~/^autoretrieve/) {
+ if (isClient) {
+ my ($cmd,$filename) = split(/:/,$userinput);
+ my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
+ if ( (-e $source) && ($filename ne '') ) {
+ my $reply = '';
+ if (open(my $fh,$source)) {
+ while (<$fh>) {
+ chomp($_);
+ $_ =~ s/^\s+//g;
+ $_ =~ s/\s+$//g;
+ $reply .= $_;
+ }
+ close($fh);
+ print $client &escape($reply)."\n";
+# unlink($source);
+ } else {
+ print $client "error\n";
+ }
+ } else {
+ print $client "error\n";
+ }
+ } else {
+ print $client "refused\n";
+ }
+#--------------------- read and retrieve institutional code format (for support form).
+ } elsif ($userinput =~/^autoinstcodeformat/) {
+ if (isClient) {
+ my $reply;
+ my($cmd,$cdom,$course) = split(/:/,$userinput);
+ my @pairs = split/\&/,$course;
+ my %instcodes = ();
+ my %codes = ();
+ my @codetitles = ();
+ my %cat_titles = ();
+ my %cat_order = ();
+ foreach (@pairs) {
+ my ($key,$value) = split/=/,$_;
+ $instcodes{&unescape($key)} = &unescape($value);
+ }
+ my $formatreply = &localenroll::instcode_format($cdom,\%instcodes,\%codes,\@codetitles,\%cat_titles,\%cat_order);
+ if ($formatreply eq 'ok') {
+ my $codes_str = &hash2str(%codes);
+ my $codetitles_str = &array2str(@codetitles);
+ my $cat_titles_str = &hash2str(%cat_titles);
+ my $cat_order_str = &hash2str(%cat_order);
+ print $client $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'.$cat_order_str."\n";
+ }
+ } else {
+ print $client "refused\n";
+ }
+# ------------------------------------------------------------- unknown command
+
+ } else {
+ # unknown command
+ print $client "unknown_cmd\n";
}
- # write the contents of the file:
-
- print $fh ($Contents);
- $fh->close; # In case we ever have a filesystem w. locking
-
- chmod(0660, $TempFile);
-
- # Now we can move install the file in position.
-
- move($TempFile, $Filename);
-
+# -------------------------------------------------------------------- complete
+ Debug("process_request - returning 1");
return 1;
}
#
-# ConfigFileFromSelector: converts a configuration file selector
-# (one of host or domain at this point) into a
-# configuration file pathname.
-#
+# Decipher encoded traffic
# Parameters:
-# selector - Configuration file selector.
-# Returns:
-# Full path to the file or undef if the selector is invalid.
-#
-sub ConfigFileFromSelector {
- my $selector = shift;
- my $tablefile;
-
- my $tabledir = $perlvar{'lonTabDir'}.'/';
- if ($selector eq "hosts") {
- $tablefile = $tabledir."hosts.tab";
- } elsif ($selector eq "domain") {
- $tablefile = $tabledir."domain.tab";
- } else {
- return undef;
- }
- return $tablefile;
-
-}
-#
-# PushFile: Called to do an administrative push of a file.
-# - Ensure the file being pushed is one we support.
-# - Backup the old file to
-# - Separate the contents of the new file out from the
-# rest of the request.
-# - Write the new file.
-# Parameter:
-# Request - The entire user request. This consists of a : separated
-# string pushfile:tablename:contents.
-# NOTE: The contents may have :'s in it as well making things a bit
-# more interesting... but not much.
+# input - Encoded data.
# Returns:
-# String to send to client ("ok" or "refused" if bad file).
+# Decoded data or undef if encryption key was not yet negotiated.
+# Implicit input:
+# cipher - This global holds the negotiated encryption key.
#
-sub PushFile {
- my $request = shift;
- my ($command, $filename, $contents) = split(":", $request, 3);
+sub decipher {
+ my ($input) = @_;
+ my $output = '';
- # At this point in time, pushes for only the following tables are
- # supported:
- # hosts.tab ($filename eq host).
- # domain.tab ($filename eq domain).
- # Construct the destination filename or reject the request.
- #
- # lonManage is supposed to ensure this, however this session could be
- # part of some elaborate spoof that managed somehow to authenticate.
- #
-
-
- my $tablefile = ConfigFileFromSelector($filename);
- if(! (defined $tablefile)) {
- return "refused";
- }
- #
- # >copy< the old table to the backup table
- # don't rename in case system crashes/reboots etc. in the time
- # window between a rename and write.
- #
- my $backupfile = $tablefile;
- $backupfile =~ s/\.tab$/.old/;
- if(!CopyFile($tablefile, $backupfile)) {
- &logthis(' CopyFile from '.$tablefile." to ".$backupfile." failed ");
- return "error:$!";
- }
- &logthis(' Pushfile: backed up '
- .$tablefile." to $backupfile");
- # If the file being pushed is the host file, we adjust the entry for ourself so that the
- # IP will be our current IP as looked up in dns. Note this is only 99% good as it's possible
- # to conceive of conditions where we don't have a DNS entry locally. This is possible in a
- # network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
- # that possibilty.
-
- if($filename eq "host") {
- $contents = AdjustHostContents($contents);
- }
-
- # Install the new file:
-
- if(!InstallFile($tablefile, $contents)) {
- &logthis(' Pushfile: unable to install '
- .$tablefile." $! ");
- return "error:$!";
- } else {
- &logthis(' Installed new '.$tablefile
- ."");
-
- }
-
-
- # Indicate success:
-
- return "ok";
-
-}
-
-#
-# Called to re-init either lonc or lond.
-#
-# Parameters:
-# request - The full request by the client. This is of the form
-# reinit:
-# where is allowed to be either of
-# lonc or lond
-#
-# Returns:
-# The string to be sent back to the client either:
-# ok - Everything worked just fine.
-# error:why - There was a failure and why describes the reason.
-#
-#
-sub ReinitProcess {
- my $request = shift;
-
-
- # separate the request (reinit) from the process identifier and
- # validate it producing the name of the .pid file for the process.
- #
- #
- my ($junk, $process) = split(":", $request);
- my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
- if($process eq 'lonc') {
- $processpidfile = $processpidfile."lonc.pid";
- if (!open(PIDFILE, "< $processpidfile")) {
- return "error:Open failed for $processpidfile";
+ if($cipher) {
+ my($enc, $enclength, $encinput) = split(/:/, $input);
+ for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
+ $output .=
+ $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
}
- my $loncpid = ;
- close(PIDFILE);
- logthis(' Reinitializing lonc pid='.$loncpid
- ."");
- kill("USR2", $loncpid);
- } elsif ($process eq 'lond') {
- logthis(' Reinitializing self (lond) ');
- &UpdateHosts; # Lond is us!!
+ return substr($output, 0, $enclength);
} else {
- &logthis('");
- return "error:Invalid process identifier $process";
+ return undef;
}
- return 'ok';
}
-# Validate a line in a configuration file edit script:
-# Validation includes:
-# - Ensuring the command is valid.
-# - Ensuring the command has sufficient parameters
-# Parameters:
-# scriptline - A line to validate (\n has been stripped for what it's worth).
-#
-# Return:
-# 0 - Invalid scriptline.
-# 1 - Valid scriptline
-# NOTE:
-# Only the command syntax is checked, not the executability of the
-# command.
-#
-sub isValidEditCommand {
- my $scriptline = shift;
- # Line elements are pipe separated:
-
- my ($command, $key, $newline) = split(/\|/, $scriptline);
- &logthis(' isValideditCommand checking: '.
- "Command = '$command', Key = '$key', Newline = '$newline' \n");
-
- if ($command eq "delete") {
- #
- # key with no newline.
- #
- if( ($key eq "") || ($newline ne "")) {
- return 0; # Must have key but no newline.
- } else {
- return 1; # Valid syntax.
- }
- } elsif ($command eq "replace") {
- #
- # key and newline:
- #
- if (($key eq "") || ($newline eq "")) {
- return 0;
- } else {
- return 1;
- }
- } elsif ($command eq "append") {
- if (($key ne "") && ($newline eq "")) {
- return 1;
- } else {
- return 0;
- }
- } else {
- return 0; # Invalid command.
- }
- return 0; # Should not get here!!!
-}
#
-# ApplyEdit - Applies an edit command to a line in a configuration
-# file. It is the caller's responsiblity to validate the
-# edit line.
+# Register a command processor. This function is invoked to register a sub
+# to process a request. Once registered, the ProcessRequest sub can automatically
+# dispatch requests to an appropriate sub, and do the top level validity checking
+# as well:
+# - Is the keyword recognized.
+# - Is the proper client type attempting the request.
+# - Is the request encrypted if it has to be.
# Parameters:
-# $directive - A single edit directive to apply.
-# Edit directives are of the form:
-# append|newline - Appends a new line to the file.
-# replace|key|newline - Replaces the line with key value 'key'
-# delete|key - Deletes the line with key value 'key'.
-# $editor - A config file editor object that contains the
-# file being edited.
+# $request_name - Name of the request being registered.
+# This is the command request that will match
+# against the hash keywords to lookup the information
+# associated with the dispatch information.
+# $procedure - Reference to a sub to call to process the request.
+# All subs get called as follows:
+# Procedure($cmd, $tail, $replyfd, $key)
+# $cmd - the actual keyword that invoked us.
+# $tail - the tail of the request that invoked us.
+# $replyfd- File descriptor connected to the client
+# $must_encode - True if the request must be encoded to be good.
+# $client_ok - True if it's ok for a client to request this.
+# $manager_ok - True if it's ok for a manager to request this.
+# Side effects:
+# - On success, the Dispatcher hash has an entry added for the key $RequestName
+# - On failure, the program will die as it's a bad internal bug to try to
+# register a duplicate command handler.
#
-sub ApplyEdit {
- my $directive = shift;
- my $editor = shift;
-
- # Break the directive down into its command and its parameters
- # (at most two at this point. The meaning of the parameters, if in fact
- # they exist depends on the command).
-
- my ($command, $p1, $p2) = split(/\|/, $directive);
+sub register_handler {
+ my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok) = @_;
- if($command eq "append") {
- $editor->Append($p1); # p1 - key p2 null.
- } elsif ($command eq "replace") {
- $editor->ReplaceLine($p1, $p2); # p1 - key p2 = newline.
- } elsif ($command eq "delete") {
- $editor->DeleteLine($p1); # p1 - key p2 null.
- } else { # Should not get here!!!
- die "Invalid command given to ApplyEdit $command";
+ # Don't allow duplication#
+
+ if (defined $Dispatcher{$request_name}) {
+ die "Attempting to define a duplicate request handler for $request_name\n";
}
-}
-#
-# AdjustOurHost:
-# Adjusts a host file stored in a configuration file editor object
-# for the true IP address of this host. This is necessary for hosts
-# that live behind a firewall.
-# Those hosts have a publicly distributed IP of the firewall, but
-# internally must use their actual IP. We assume that a given
-# host only has a single IP interface for now.
-# Formal Parameters:
-# editor - The configuration file editor to adjust. This
-# editor is assumed to contain a hosts.tab file.
-# Strategy:
-# - Figure out our hostname.
-# - Lookup the entry for this host.
-# - Modify the line to contain our IP
-# - Do a replace for this host.
-sub AdjustOurHost {
- my $editor = shift;
-
- # figure out who I am.
-
- my $myHostName = $perlvar{'lonHostID'}; # LonCAPA hostname.
-
- # Get my host file entry.
-
- my $ConfigLine = $editor->Find($myHostName);
- if(! (defined $ConfigLine)) {
- die "AdjustOurHost - no entry for me in hosts file $myHostName";
+ # Build the client type mask:
+
+ my $client_type_mask = 0;
+ if($client_ok) {
+ $client_type_mask |= $CLIENT_OK;
}
- # figure out my IP:
- # Use the config line to get my hostname.
- # Use gethostbyname to translate that into an IP address.
- #
- my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
- my $BinaryIp = gethostbyname($name);
- my $ip = inet_ntoa($ip);
- #
- # Reassemble the config line from the elements in the list.
- # Note that if the loncnew items were not present before, they will
- # be now even if they would be empty
- #
- my $newConfigLine = $id;
- foreach my $item ($domain, $role, $name, $ip, $maxcon, $idleto, $mincon) {
- $newConfigLine .= ":".$item;
+ if($manager_ok) {
+ $client_type_mask |= $MANAGER_OK;
}
- # Replace the line:
-
- $editor->ReplaceLine($id, $newConfigLine);
-
-}
-#
-# ReplaceConfigFile:
-# Replaces a configuration file with the contents of a
-# configuration file editor object.
-# This is done by:
-# - Copying the target file to .old
-# - Writing the new file to .tmp
-# - Moving ->
-# This laborious process ensures that the system is never without
-# a configuration file that's at least valid (even if the contents
-# may be dated).
-# Parameters:
-# filename - Name of the file to modify... this is a full path.
-# editor - Editor containing the file.
-#
-sub ReplaceConfigFile {
- my $filename = shift;
- my $editor = shift;
-
- CopyFile ($filename, $filename.".old");
-
- my $contents = $editor->Get(); # Get the contents of the file.
-
- InstallFile($filename, $contents);
+
+ # Enter the hash:
+
+ my @entry = ($procedure, $must_encode, $client_type_mask);
+
+ $Dispatcher{$request_name} = \@entry;
+
}
-#
-#
-# Called to edit a configuration table file
-# Parameters:
-# request - The entire command/request sent by lonc or lonManage
-# Return:
-# The reply to send to the client.
-#
-sub EditFile {
- my $request = shift;
- # Split the command into it's pieces: edit:filetype:script
- my ($request, $filetype, $script) = split(/:/, $request,3); # : in script
+#------------------------------------------------------------------
- # Check the pre-coditions for success:
- if($request != "edit") { # Something is amiss afoot alack.
- return "error:edit request detected, but request != 'edit'\n";
- }
- if( ($filetype ne "hosts") &&
- ($filetype ne "domain")) {
- return "error:edit requested with invalid file specifier: $filetype \n";
- }
- # Split the edit script and check it's validity.
- my @scriptlines = split(/\n/, $script); # one line per element.
- my $linecount = scalar(@scriptlines);
- for(my $i = 0; $i < $linecount; $i++) {
- chomp($scriptlines[$i]);
- if(!isValidEditCommand($scriptlines[$i])) {
- return "error:edit with bad script line: '$scriptlines[$i]' \n";
- }
- }
-
- # Execute the edit operation.
- # - Create a config file editor for the appropriate file and
- # - execute each command in the script:
- #
- my $configfile = ConfigFileFromSelector($filetype);
- if (!(defined $configfile)) {
- return "refused\n";
- }
- my $editor = ConfigFileEdit->new($configfile);
-
- for (my $i = 0; $i < $linecount; $i++) {
- ApplyEdit($scriptlines[$i], $editor);
- }
- # If the file is the host file, ensure that our host is
- # adjusted to have our ip:
- #
- if($filetype eq "host") {
- AdjustOurHost($editor);
- }
- # Finally replace the current file with our file.
- #
- ReplaceConfigFile($configfile, $editor);
-
- return "ok\n";
-}
#
# Convert an error return code from lcpasswd to a string value.
#
@@ -3420,22 +3417,22 @@ sub catchexception {
$SIG{'QUIT'}='DEFAULT';
$SIG{__DIE__}='DEFAULT';
&status("Catching exception");
- &logthis("CRITICAL: "
- ."ABNORMAL EXIT. Child $$ for server $thisserver died through "
- ."a crash with this error msg->[$error]");
+ &logthis("CRITICAL: "
+ ."ABNORMAL EXIT. Child $$ for server $thisserver died through "
+ ."a crash with this error msg->[$error]");
&logthis('Famous last words: '.$status.' - '.$lastlog);
if ($client) { print $client "error: $error\n"; }
$server->close();
die($error);
}
-
sub timeout {
&status("Handling Timeout");
- &logthis("CRITICAL: TIME OUT ".$$."");
+ &logthis("CRITICAL: TIME OUT ".$$."");
&catchexception('Timeout');
}
# -------------------------------- Set signal handlers to record abnormal exits
+
$SIG{'QUIT'}=\&catchexception;
$SIG{__DIE__}=\&catchexception;
@@ -3448,11 +3445,11 @@ undef $perlvarref;
# ----------------------------- Make sure this process is running from user=www
my $wwwid=getpwnam('www');
if ($wwwid!=$<) {
- my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
- my $subj="LON: $currenthostid User ID mismatch";
- system("echo 'User ID mismatch. lond must be run as user www.' |\
+ my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
+ my $subj="LON: $currenthostid User ID mismatch";
+ system("echo 'User ID mismatch. lond must be run as user www.' |\
mailto $emailto -s '$subj' > /dev/null");
- exit 1;
+ exit 1;
}
# --------------------------------------------- Check if other instance running
@@ -3460,10 +3457,10 @@ if ($wwwid!=$<) {
my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
if (-e $pidfile) {
- my $lfh=IO::File->new("$pidfile");
- my $pide=<$lfh>;
- chomp($pide);
- if (kill 0 => $pide) { die "already running"; }
+ my $lfh=IO::File->new("$pidfile");
+ my $pide=<$lfh>;
+ chomp($pide);
+ if (kill 0 => $pide) { die "already running"; }
}
# ------------------------------------------------------------- Read hosts file
@@ -3476,25 +3473,33 @@ $server = IO::Socket::INET->new(LocalPor
Proto => 'tcp',
Reuse => 1,
Listen => 10 )
- or die "making socket: $@\n";
+ or die "making socket: $@\n";
# --------------------------------------------------------- Do global variables
# global variables
my %children = (); # keys are current child process IDs
-my $children = 0; # current number of children
sub REAPER { # takes care of dead children
$SIG{CHLD} = \&REAPER;
&status("Handling child death");
- my $pid = wait;
- if (defined($children{$pid})) {
- &logthis("Child $pid died");
- $children --;
- delete $children{$pid};
- } else {
- &logthis("Unknown Child $pid died");
+ my $pid;
+ do {
+ $pid = waitpid(-1,&WNOHANG());
+ if (defined($children{$pid})) {
+ &logthis("Child $pid died");
+ delete($children{$pid});
+ } elsif ($pid > 0) {
+ &logthis("Unknown Child $pid died");
+ }
+ } while ( $pid > 0 );
+ foreach my $child (keys(%children)) {
+ $pid = waitpid($child,&WNOHANG());
+ if ($pid > 0) {
+ &logthis("Child $child - $pid looks like we missed it's death");
+ delete($children{$pid});
+ }
}
&status("Finished Handling child death");
}
@@ -3506,7 +3511,7 @@ sub HUNTSMAN { # si
&logthis("Free socket: ".shutdown($server,2)); # free up socket
my $execdir=$perlvar{'lonDaemons'};
unlink("$execdir/logs/lond.pid");
- &logthis("CRITICAL: Shutting down");
+ &logthis("CRITICAL: Shutting down");
&status("Done killing children");
exit; # clean up with dignity
}
@@ -3516,7 +3521,7 @@ sub HUPSMAN { # sig
&status("Killing children for restart (HUP)");
kill 'INT' => keys %children;
&logthis("Free socket: ".shutdown($server,2)); # free up socket
- &logthis("CRITICAL: Restarting");
+ &logthis("CRITICAL: Restarting");
my $execdir=$perlvar{'lonDaemons'};
unlink("$execdir/logs/lond.pid");
&status("Restarting self (HUP)");
@@ -3526,7 +3531,7 @@ sub HUPSMAN { # sig
#
# Kill off hashes that describe the host table prior to re-reading it.
# Hashes affected are:
-# %hostid, %hostdom %hostip
+# %hostid, %hostdom %hostip %hostdns.
#
sub KillHostHashes {
foreach my $key (keys %hostid) {
@@ -3538,6 +3543,9 @@ sub KillHostHashes {
foreach my $key (keys %hostip) {
delete $hostip{$key};
}
+ foreach my $key (keys %hostdns) {
+ delete $hostdns{$key};
+ }
}
#
# Read in the host table from file and distribute it into the various hashes:
@@ -3548,14 +3556,22 @@ sub KillHostHashes {
sub ReadHostTable {
open (CONFIG,"$perlvar{'lonTabDir'}/hosts.tab") || die "Can't read host file";
-
+ my $myloncapaname = $perlvar{'lonHostID'};
+ Debug("My loncapa name is : $myloncapaname");
while (my $configline=) {
- my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
- chomp($ip); $ip=~s/\D+$//;
- $hostid{$ip}=$id;
- $hostdom{$id}=$domain;
- $hostip{$id}=$ip;
- if ($id eq $perlvar{'lonHostID'}) { $thisserver=$name; }
+ if (!($configline =~ /^\s*\#/)) {
+ my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
+ chomp($ip); $ip=~s/\D+$//;
+ $hostid{$ip}=$id; # LonCAPA name of host by IP.
+ $hostdom{$id}=$domain; # LonCAPA domain name of host.
+ $hostip{$id}=$ip; # IP address of host.
+ $hostdns{$name} = $id; # LonCAPA name of host by DNS.
+
+ if ($id eq $perlvar{'lonHostID'}) {
+ Debug("Found me in the host table: $name");
+ $thisserver=$name;
+ }
+ }
}
close(CONFIG);
}
@@ -3617,34 +3633,38 @@ sub checkchildren {
&logthis('Going to check on the children');
my $docdir=$perlvar{'lonDocRoot'};
foreach (sort keys %children) {
- sleep 1;
+ #sleep 1;
unless (kill 'USR1' => $_) {
&logthis ('Child '.$_.' is dead');
&logstatus($$.' is dead');
+ delete($children{$_});
}
}
sleep 5;
- $SIG{ALRM} = sub { die "timeout" };
+ $SIG{ALRM} = sub { Debug("timeout");
+ die "timeout"; };
$SIG{__DIE__} = 'DEFAULT';
&status("Checking on the children (waiting for reports)");
foreach (sort keys %children) {
unless (-e "$docdir/lon-status/londchld/$_.txt") {
- eval {
- alarm(300);
- &logthis('Child '.$_.' did not respond');
- kill 9 => $_;
- #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
- #$subj="LON: $currenthostid killed lond process $_";
- #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
- #$execdir=$perlvar{'lonDaemons'};
- #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
- alarm(0);
- }
+ eval {
+ alarm(300);
+ &logthis('Child '.$_.' did not respond');
+ kill 9 => $_;
+ #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
+ #$subj="LON: $currenthostid killed lond process $_";
+ #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
+ #$execdir=$perlvar{'lonDaemons'};
+ #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
+ delete($children{$_});
+ alarm(0);
+ }
}
}
$SIG{ALRM} = 'DEFAULT';
$SIG{__DIE__} = \&catchexception;
&status("Finished checking children");
+ &logthis('Finished Checking children');
}
# --------------------------------------------------------------------- Logging
@@ -3675,22 +3695,17 @@ sub Debug {
# reply - Text to send to client.
# request - Original request from client.
#
-# Note: This increments Transactions
-#
sub Reply {
- alarm(120);
- my $fd = shift;
- my $reply = shift;
- my $request = shift;
-
+ my ($fd, $reply, $request) = @_;
print $fd $reply;
Debug("Request was $request Reply was $reply");
$Transactions++;
- alarm(0);
}
+
+
#
# Sub to report a failure.
# This function:
@@ -3720,19 +3735,20 @@ sub logstatus {
&status("Doing logging");
my $docdir=$perlvar{'lonDocRoot'};
{
- my $fh=IO::File->new(">>$docdir/lon-status/londstatus.txt");
- print $fh $$."\t".$currenthostid."\t".$status."\t".$lastlog."\n";
- $fh->close();
+ my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
+ print $fh $status."\n".$lastlog."\n".time."\n$keymode";
+ $fh->close();
}
- &status("Finished londstatus.txt");
+ &status("Finished $$.txt");
{
- my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
- print $fh $status."\n".$lastlog."\n".time;
- $fh->close();
+ open(LOG,">>$docdir/lon-status/londstatus.txt");
+ flock(LOG,LOCK_EX);
+ print LOG $$."\t".$clientname."\t".$currenthostid."\t"
+ .$status."\t".$lastlog."\t $keymode\n";
+ flock(DB,LOCK_UN);
+ close(LOG);
}
- ResetStatistics;
&status("Finished logging");
-
}
sub initnewstatus {
@@ -3754,11 +3770,8 @@ sub status {
my $what=shift;
my $now=time;
my $local=localtime($now);
- my $status = "lond: $what $local ";
- if($Transactions) {
- $status .= " Transactions: $Transactions Failed; $Failures";
- }
- $0=$status;
+ $status=$local.': '.$what;
+ $0='lond: '.$what.' '.$local;
}
# -------------------------------------------------------- Escape Special Chars
@@ -3790,11 +3803,12 @@ sub reconlonc {
&logthis("lonc at pid $loncpid responding, sending USR1");
kill USR1 => $loncpid;
} else {
- &logthis("CRITICAL: "
- ."lonc at pid $loncpid not responding, giving up");
+ &logthis(
+ "CRITICAL: "
+ ."lonc at pid $loncpid not responding, giving up");
}
} else {
- &logthis('CRITICAL: lonc not running, giving up');
+ &logthis('CRITICAL: lonc not running, giving up');
}
}
@@ -3806,7 +3820,7 @@ sub subreply {
my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
Type => SOCK_STREAM,
Timeout => 10)
- or return "con_lost";
+ or return "con_lost";
print $sclient "$cmd\n";
my $answer=<$sclient>;
chomp($answer);
@@ -3815,22 +3829,22 @@ sub subreply {
}
sub reply {
- my ($cmd,$server)=@_;
- my $answer;
- if ($server ne $currenthostid) {
- $answer=subreply($cmd,$server);
- if ($answer eq 'con_lost') {
- $answer=subreply("ping",$server);
- if ($answer ne $server) {
- &logthis("sub reply: answer != server answer is $answer, server is $server");
- &reconlonc("$perlvar{'lonSockDir'}/$server");
- }
- $answer=subreply($cmd,$server);
- }
- } else {
- $answer='self_reply';
- }
- return $answer;
+ my ($cmd,$server)=@_;
+ my $answer;
+ if ($server ne $currenthostid) {
+ $answer=subreply($cmd,$server);
+ if ($answer eq 'con_lost') {
+ $answer=subreply("ping",$server);
+ if ($answer ne $server) {
+ &logthis("sub reply: answer != server answer is $answer, server is $server");
+ &reconlonc("$perlvar{'lonSockDir'}/$server");
+ }
+ $answer=subreply($cmd,$server);
+ }
+ } else {
+ $answer='self_reply';
+ }
+ return $answer;
}
# -------------------------------------------------------------- Talk to lonsql
@@ -3849,7 +3863,7 @@ sub subsqlreply {
my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
Type => SOCK_STREAM,
Timeout => 10)
- or return "con_lost";
+ or return "con_lost";
print $sclient "$cmd\n";
my $answer=<$sclient>;
chomp($answer);
@@ -3898,7 +3912,7 @@ my $execdir=$perlvar{'lonDaemons'};
open (PIDSAVE,">$execdir/logs/lond.pid");
print PIDSAVE "$$\n";
close(PIDSAVE);
-&logthis("CRITICAL: ---------- Starting ----------");
+&logthis("CRITICAL: ---------- Starting ----------");
&status('Starting');
@@ -3916,7 +3930,6 @@ $SIG{USR2} = \&UpdateHosts;
ReadHostTable;
-
# --------------------------------------------------------------
# Accept connections. When a connection comes in, it is validated
# and if good, a child process is created to process transactions
@@ -3932,6 +3945,7 @@ while (1) {
sub make_new_child {
my $pid;
+# my $cipher; # Now global
my $sigset;
$client = shift;
@@ -3942,7 +3956,7 @@ sub make_new_child {
$sigset = POSIX::SigSet->new(SIGINT);
sigprocmask(SIG_BLOCK, $sigset)
or die "Can't block SIGINT for fork: $!\n";
-
+
die "fork: $!" unless defined ($pid = fork);
$client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
@@ -3953,15 +3967,27 @@ sub make_new_child {
# the pid hash.
#
my $caller = getpeername($client);
- my ($port,$iaddr)=unpack_sockaddr_in($caller);
- $clientip=inet_ntoa($iaddr);
+ my ($port,$iaddr);
+ if (defined($caller) && length($caller) > 0) {
+ ($port,$iaddr)=unpack_sockaddr_in($caller);
+ } else {
+ &logthis("Unable to determine who caller was, getpeername returned nothing");
+ }
+ if (defined($iaddr)) {
+ $clientip = inet_ntoa($iaddr);
+ Debug("Connected with $clientip");
+ $clientdns = gethostbyaddr($iaddr, AF_INET);
+ Debug("Connected with $clientdns by name");
+ } else {
+ &logthis("Unable to determine clientip");
+ $clientip='Unavailable';
+ }
if ($pid) {
# Parent records the child's birth and returns.
sigprocmask(SIG_UNBLOCK, $sigset)
or die "Can't unblock SIGINT for fork: $!\n";
$children{$pid} = $clientip;
- $children++;
&status('Started child '.$pid);
return;
} else {
@@ -3978,16 +4004,16 @@ sub make_new_child {
sigprocmask(SIG_UNBLOCK, $sigset)
or die "Can't unblock SIGINT for fork: $!\n";
-
-
+# my $tmpsnum=0; # Now global
+#---------------------------------------------------- kerberos 5 initialization
&Authen::Krb5::init_context();
&Authen::Krb5::init_ets();
-
+
&status('Accepted connection');
# =============================================================================
# do something with the connection
# -----------------------------------------------------------------------------
- # see if we know client and check for spoof IP by challenge
+ # see if we know client and 'check' for spoof IP by ineffective challenge
ReadManagerTable; # May also be a manager!!
@@ -4005,37 +4031,102 @@ sub make_new_child {
$clientname = $managers{$clientip};
}
my $clientok;
+
if ($clientrec || $ismanager) {
&status("Waiting for init from $clientip $clientname");
&logthis('INFO: Connection, '.
$clientip.
- " ($clientname) connection type = $ConnectionType " );
+ " ($clientname) connection type = $ConnectionType " );
&status("Connecting $clientip ($clientname))");
my $remotereq=<$client>;
- $remotereq=~s/[^\w:]//g;
+ chomp($remotereq);
+ Debug("Got init: $remotereq");
+ my $inikeyword = split(/:/, $remotereq);
if ($remotereq =~ /^init/) {
&sethost("sethost:$perlvar{'lonHostID'}");
- my $challenge="$$".time;
- print $client "$challenge\n";
- &status("Waiting for challenge reply from $clientip ($clientname)");
- $remotereq=<$client>;
- $remotereq=~s/\W//g;
- if ($challenge eq $remotereq) {
- $clientok=1;
- print $client "ok\n";
+ #
+ # If the remote is attempting a local init... give that a try:
+ #
+ my ($i, $inittype) = split(/:/, $remotereq);
+
+ # If the connection type is ssl, but I didn't get my
+ # certificate files yet, then I'll drop back to
+ # insecure (if allowed).
+
+ if($inittype eq "ssl") {
+ my ($ca, $cert) = lonssl::CertificateFile;
+ my $kfile = lonssl::KeyFile;
+ if((!$ca) ||
+ (!$cert) ||
+ (!$kfile)) {
+ $inittype = ""; # This forces insecure attempt.
+ &logthis(" Certificates not "
+ ."installed -- trying insecure auth");
+ } else { # SSL certificates are in place so
+ } # Leave the inittype alone.
+ }
+
+ if($inittype eq "local") {
+ my $key = LocalConnection($client, $remotereq);
+ if($key) {
+ Debug("Got local key $key");
+ $clientok = 1;
+ my $cipherkey = pack("H32", $key);
+ $cipher = new IDEA($cipherkey);
+ print $client "ok:local\n";
+ &logthis('");
+ $keymode = "local"
+ } else {
+ Debug("Failed to get local key");
+ $clientok = 0;
+ shutdown($client, 3);
+ close $client;
+ }
+ } elsif ($inittype eq "ssl") {
+ my $key = SSLConnection($client);
+ if ($key) {
+ $clientok = 1;
+ my $cipherkey = pack("H32", $key);
+ $cipher = new IDEA($cipherkey);
+ &logthis(''
+ ."Successfull ssl authentication with $clientname ");
+ $keymode = "ssl";
+
+ } else {
+ $clientok = 0;
+ close $client;
+ }
+
} else {
- &logthis("WARNING: $clientip did not reply challenge");
- &status('No challenge reply '.$clientip);
+ my $ok = InsecureConnection($client);
+ if($ok) {
+ $clientok = 1;
+ &logthis(''
+ ."Successful insecure authentication with $clientname ");
+ print $client "ok\n";
+ $keymode = "insecure";
+ } else {
+ &logthis(''
+ ."Attempted insecure connection disallowed ");
+ close $client;
+ $clientok = 0;
+
+ }
}
} else {
- &logthis("WARNING: "
+ &logthis(
+ "WARNING: "
."$clientip failed to initialize: >$remotereq< ");
&status('No init '.$clientip);
}
+
} else {
- &logthis("WARNING: Unknown client $clientip");
+ &logthis(
+ "WARNING: Unknown client $clientip");
&status('Hung up on '.$clientip);
}
+
if ($clientok) {
# ---------------- New known client connecting, could mean machine online again
@@ -4047,31 +4138,31 @@ sub make_new_child {
}
&reconlonc("$perlvar{'lonSockDir'}/$id");
}
- &logthis("Established connection: $clientname");
+ &logthis("Established connection: $clientname");
&status('Will listen to '.$clientname);
-
- ResetStatistics();
-
# ------------------------------------------------------------ Process requests
- my $KeepGoing = 1;
- while ((my $userinput=GetRequest) && $KeepGoing) {
- $KeepGoing = ProcessRequest($userinput);
-# -------------------------------------------------------------------- complete
-
- &status('Listening to '.$clientname);
+ my $keep_going = 1;
+ my $user_input;
+ while(($user_input = get_request) && $keep_going) {
+ alarm(120);
+ Debug("Main: Got $user_input\n");
+ $keep_going = &process_request($user_input);
+ alarm(0);
+ &status('Listening to '.$clientname." ($keymode)");
}
+
# --------------------------------------------- client unknown or fishy, refuse
- } else {
+ } else {
print $client "refused\n";
$client->close();
- &logthis("WARNING: "
+ &logthis("WARNING: "
."Rejected client $clientip, closing connection");
}
- }
+ }
# =============================================================================
- &logthis("CRITICAL: "
+ &logthis("CRITICAL: "
."Disconnect from $clientip ($clientname)");
@@ -4094,14 +4185,12 @@ sub make_new_child {
# user - Name of the user for which the role is being put.
# authtype - The authentication type associated with the user.
#
-sub ManagePermissions {
- my $request = shift;
- my $domain = shift;
- my $user = shift;
- my $authtype= shift;
+sub manage_permissions
+{
+
+ my ($request, $domain, $user, $authtype) = @_;
# See if the request is of the form /$domain/_au
- &logthis("ruequest is $request");
if($request =~ /^(\/$domain\/_au)$/) { # It's an author rolesput...
my $execdir = $perlvar{'lonDaemons'};
my $userhome= "/home/$user" ;
@@ -4109,16 +4198,89 @@ sub ManagePermissions {
system("$execdir/lchtmldir $userhome $user $authtype");
}
}
+
+
+#
+# Return the full path of a user password file, whether it exists or not.
+# Parameters:
+# domain - Domain in which the password file lives.
+# user - name of the user.
+# Returns:
+# Full passwd path:
+#
+sub password_path {
+ my ($domain, $user) = @_;
+
+
+ my $path = &propath($domain, $user);
+ $path .= "/passwd";
+
+ return $path;
+}
+
+# Password Filename
+# Returns the path to a passwd file given domain and user... only if
+# it exists.
+# Parameters:
+# domain - Domain in which to search.
+# user - username.
+# Returns:
+# - If the password file exists returns its path.
+# - If the password file does not exist, returns undefined.
+#
+sub password_filename {
+ my ($domain, $user) = @_;
+
+ Debug ("PasswordFilename called: dom = $domain user = $user");
+
+ my $path = &password_path($domain, $user);
+ Debug("PasswordFilename got path: $path");
+ if(-e $path) {
+ return $path;
+ } else {
+ return undef;
+ }
+}
+
+#
+# Rewrite the contents of the user's passwd file.
+# Parameters:
+# domain - domain of the user.
+# name - User's name.
+# contents - New contents of the file.
+# Returns:
+# 0 - Failed.
+# 1 - Success.
+#
+sub rewrite_password_file {
+ my ($domain, $user, $contents) = @_;
+
+ my $file = &password_filename($domain, $user);
+ if (defined $file) {
+ my $pf = IO::File->new(">$file");
+ if($pf) {
+ print $pf "$contents\n";
+ return 1;
+ } else {
+ return 0;
+ }
+ } else {
+ return 0;
+ }
+
+}
+
#
-# GetAuthType - Determines the authorization type of a user in a domain.
+# get_auth_type - Determines the authorization type of a user in a domain.
# Returns the authorization type or nouser if there is no such user.
#
-sub GetAuthType {
- my $domain = shift;
- my $user = shift;
+sub get_auth_type
+{
+
+ my ($domain, $user) = @_;
- Debug("GetAuthType( $domain, $user ) \n");
+ Debug("get_auth_type( $domain, $user ) \n");
my $proname = &propath($domain, $user);
my $passwdfile = "$proname/passwd";
if( -e $passwdfile ) {
@@ -4140,6 +4302,126 @@ sub GetAuthType {
}
}
+#
+# Validate a user given their domain, name and password. This utility
+# function is used by both AuthenticateHandler and ChangePasswordHandler
+# to validate the login credentials of a user.
+# Parameters:
+# $domain - The domain being logged into (this is required due to
+# the capability for multihomed systems.
+# $user - The name of the user being validated.
+# $password - The user's propoposed password.
+#
+# Returns:
+# 1 - The domain,user,pasword triplet corresponds to a valid
+# user.
+# 0 - The domain,user,password triplet is not a valid user.
+#
+sub validate_user {
+ my ($domain, $user, $password) = @_;
+
+
+ # Why negative ~pi you may well ask? Well this function is about
+ # authentication, and therefore very important to get right.
+ # I've initialized the flag that determines whether or not I've
+ # validated correctly to a value it's not supposed to get.
+ # At the end of this function. I'll ensure that it's not still that
+ # value so we don't just wind up returning some accidental value
+ # as a result of executing an unforseen code path that
+ # did not set $validated.
+
+ my $validated = -3.14159;
+
+ # How we authenticate is determined by the type of authentication
+ # the user has been assigned. If the authentication type is
+ # "nouser", the user does not exist so we will return 0.
+
+ my $contents = &get_auth_type($domain, $user);
+ my ($howpwd, $contentpwd) = split(/:/, $contents);
+
+ my $null = pack("C",0); # Used by kerberos auth types.
+
+ if ($howpwd ne 'nouser') {
+
+ if($howpwd eq "internal") { # Encrypted is in local password file.
+ $validated = (crypt($password, $contentpwd) eq $contentpwd);
+ }
+ elsif ($howpwd eq "unix") { # User is a normal unix user.
+ $contentpwd = (getpwnam($user))[1];
+ if($contentpwd) {
+ if($contentpwd eq 'x') { # Shadow password file...
+ my $pwauth_path = "/usr/local/sbin/pwauth";
+ open PWAUTH, "|$pwauth_path" or
+ die "Cannot invoke authentication";
+ print PWAUTH "$user\n$password\n";
+ close PWAUTH;
+ $validated = ! $?;
+
+ } else { # Passwords in /etc/passwd.
+ $validated = (crypt($password,
+ $contentpwd) eq $contentpwd);
+ }
+ } else {
+ $validated = 0;
+ }
+ }
+ elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
+ if(! ($password =~ /$null/) ) {
+ my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
+ "",
+ $contentpwd,,
+ 'krbtgt',
+ $contentpwd,
+ 1,
+ $password);
+ if(!$k4error) {
+ $validated = 1;
+ } else {
+ $validated = 0;
+ &logthis('krb4: '.$user.', '.$contentpwd.', '.
+ &Authen::Krb4::get_err_txt($Authen::Krb4::error));
+ }
+ } else {
+ $validated = 0; # Password has a match with null.
+ }
+ } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
+ if(!($password =~ /$null/)) { # Null password not allowed.
+ my $krbclient = &Authen::Krb5::parse_name($user.'@'
+ .$contentpwd);
+ my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
+ my $krbserver = &Authen::Krb5::parse_name($krbservice);
+ my $credentials= &Authen::Krb5::cc_default();
+ $credentials->initialize($krbclient);
+ my $krbreturn = &Authen::KRb5::get_in_tkt_with_password($krbclient,
+ $krbserver,
+ $password,
+ $credentials);
+ $validated = ($krbreturn == 1);
+ } else {
+ $validated = 0;
+ }
+ } elsif ($howpwd eq "localauth") {
+ # Authenticate via installation specific authentcation method:
+ $validated = &localauth::localauth($user,
+ $password,
+ $contentpwd);
+ } else { # Unrecognized auth is also bad.
+ $validated = 0;
+ }
+ } else {
+ $validated = 0;
+ }
+ #
+ # $validated has the correct stat of the authentication:
+ #
+
+ unless ($validated != -3.14159) {
+ die "ValidateUser - failed to set the value of validated";
+ }
+ return $validated;
+}
+
+
sub addline {
my ($fname,$hostid,$ip,$newline)=@_;
my $contents;
@@ -4224,17 +4506,36 @@ sub chatadd {
sub unsub {
my ($fname,$clientip)=@_;
my $result;
+ my $unsubs = 0; # Number of successful unsubscribes:
+
+
+ # An old way subscriptions were handled was to have a
+ # subscription marker file:
+
+ Debug("Attempting unlink of $fname.$clientname");
if (unlink("$fname.$clientname")) {
- $result="ok\n";
- } else {
- $result="not_subscribed\n";
- }
+ $unsubs++; # Successful unsub via marker file.
+ }
+
+ # The more modern way to do it is to have a subscription list
+ # file:
+
if (-e "$fname.subscription") {
my $found=&addline($fname,$clientname,$clientip,'');
- if ($found) { $result="ok\n"; }
+ if ($found) {
+ $unsubs++;
+ }
+ }
+
+ # If either or both of these mechanisms succeeded in unsubscribing a
+ # resource we can return ok:
+
+ if($unsubs) {
+ $result = "ok\n";
} else {
- if ($result != "ok\n") { $result="not_subscribed\n"; }
+ $result = "not_subscribed\n";
}
+
return $result;
}
@@ -4243,7 +4544,7 @@ sub currentversion {
my $version=-1;
my $ulsdir='';
if ($fname=~/^(.+)\/[^\/]+$/) {
- $ulsdir=$1;
+ $ulsdir=$1;
}
my ($fnamere1,$fnamere2);
# remove version if already specified
@@ -4300,8 +4601,8 @@ sub subscribe {
symlink($root.'.'.$extension,
$root.'.'.$currentversion.'.'.$extension);
unless ($extension=~/\.meta$/) {
- symlink($root.'.'.$extension.'.meta',
- $root.'.'.$currentversion.'.'.$extension.'.meta');
+ symlink($root.'.'.$extension.'.meta',
+ $root.'.'.$currentversion.'.'.$extension.'.meta');
}
}
}
@@ -4356,7 +4657,19 @@ sub make_passwd_file {
}
} elsif ($umode eq 'unix') {
{
- my $execpath="$perlvar{'lonDaemons'}/"."lcuseradd";
+ #
+ # Don't allow the creation of privileged accounts!!! that would
+ # be real bad!!!
+ #
+ my $uid = getpwnam($uname);
+ if((defined $uid) && ($uid == 0)) {
+ &logthis(">>>Attempted to create privilged account blocked");
+ return "no_priv_account_error\n";
+ }
+
+ my $execpath ="$perlvar{'lonDaemons'}/"."lcuseradd";
+
+ my $lc_error_file = $execdir."/tmp/lcuseradd".$$.".status";
{
&Debug("Executing external: ".$execpath);
&Debug("user = ".$uname.", Password =". $npass);
@@ -4364,17 +4677,27 @@ sub make_passwd_file {
print $se "$uname\n";
print $se "$npass\n";
print $se "$npass\n";
+ print $se "$lc_error_file\n"; # Status -> unique file.
}
- my $useraddok = $?;
+ my $error = IO::File->new("< $lc_error_file");
+ my $useraddok = <$error>;
+ $error->close;
+ unlink($lc_error_file);
+
+ chomp $useraddok;
+
if($useraddok > 0) {
- &logthis("Failed lcuseradd: ".&lcuseraddstrerror($useraddok));
+ my $error_text = &lcuseraddstrerror($useraddok);
+ &logthis("Failed lcuseradd: $error_text");
+ $result = "lcuseradd_failed:$error_text\n";
+ } else {
+ my $pf = IO::File->new(">$passfilename");
+ print $pf "unix:\n";
}
- my $pf = IO::File->new(">$passfilename");
- print $pf "unix:\n";
}
} elsif ($umode eq 'none') {
{
- my $pf = IO::File->new(">$passfilename");
+ my $pf = IO::File->new("> $passfilename");
print $pf "none:\n";
}
} else {
@@ -4388,7 +4711,7 @@ sub sethost {
my (undef,$hostid)=split(/:/,$remotereq);
if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
if ($hostip{$perlvar{'lonHostID'}} eq $hostip{$hostid}) {
- $currenthostid=$hostid;
+ $currenthostid =$hostid;
$currentdomainid=$hostdom{$hostid};
&logthis("Setting hostid to $hostid, and domain to $currentdomainid");
} else {
@@ -4404,10 +4727,8 @@ sub version {
$remoteVERSION=(split(/:/,$userinput))[1];
return "version:$VERSION";
}
-############## >>>>>>>>>>>>>>>>>>>>>>>>>> FUTUREWORK <<<<<<<<<<<<<<<<<<<<<<<<<<<<
+
#There is a copy of this in lonnet.pm
-# Can we hoist these lil' things out into common places?
-#
sub userload {
my $numusers=0;
{
@@ -4430,6 +4751,74 @@ sub userload {
return $userloadpercent;
}
+# Routines for serializing arrays and hashes (copies from lonnet)
+
+sub array2str {
+ my (@array) = @_;
+ my $result=&arrayref2str(\@array);
+ $result=~s/^__ARRAY_REF__//;
+ $result=~s/__END_ARRAY_REF__$//;
+ return $result;
+}
+
+sub arrayref2str {
+ my ($arrayref) = @_;
+ my $result='__ARRAY_REF__';
+ foreach my $elem (@$arrayref) {
+ if(ref($elem) eq 'ARRAY') {
+ $result.=&arrayref2str($elem).'&';
+ } elsif(ref($elem) eq 'HASH') {
+ $result.=&hashref2str($elem).'&';
+ } elsif(ref($elem)) {
+ #print("Got a ref of ".(ref($elem))." skipping.");
+ } else {
+ $result.=&escape($elem).'&';
+ }
+ }
+ $result=~s/\&$//;
+ $result .= '__END_ARRAY_REF__';
+ return $result;
+}
+
+sub hash2str {
+ my (%hash) = @_;
+ my $result=&hashref2str(\%hash);
+ $result=~s/^__HASH_REF__//;
+ $result=~s/__END_HASH_REF__$//;
+ return $result;
+}
+
+sub hashref2str {
+ my ($hashref)=@_;
+ my $result='__HASH_REF__';
+ foreach (sort(keys(%$hashref))) {
+ if (ref($_) eq 'ARRAY') {
+ $result.=&arrayref2str($_).'=';
+ } elsif (ref($_) eq 'HASH') {
+ $result.=&hashref2str($_).'=';
+ } elsif (ref($_)) {
+ $result.='=';
+ #print("Got a ref of ".(ref($_))." skipping.");
+ } else {
+ if ($_) {$result.=&escape($_).'=';} else { last; }
+ }
+
+ if(ref($hashref->{$_}) eq 'ARRAY') {
+ $result.=&arrayref2str($hashref->{$_}).'&';
+ } elsif(ref($hashref->{$_}) eq 'HASH') {
+ $result.=&hashref2str($hashref->{$_}).'&';
+ } elsif(ref($hashref->{$_})) {
+ $result.='&';
+ #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
+ } else {
+ $result.=&escape($hashref->{$_}).'&';
+ }
+ }
+ $result=~s/\&$//;
+ $result .= '__END_HASH_REF__';
+ return $result;
+}
+
# ----------------------------------- POD (plain old documentation, CPAN style)
=head1 NAME
@@ -4637,7 +5026,7 @@ Place in B
stores hash in namespace
-=item rolesput
+=item rolesputy
put a role into a user's environment