Annotation of loncom/lcuseradd, revision 1.35
1.1 harris41 1: #!/usr/bin/perl
1.16 harris41 2:
3: # The Learning Online Network with CAPA
1.1 harris41 4: #
1.16 harris41 5: # lcuseradd - LON-CAPA setuid script to coordinate all actions
6: # with adding a user with filesystem privileges (e.g. author)
1.1 harris41 7: #
1.16 harris41 8: #
1.35 ! foxr 9: # $Id: lcuseradd,v 1.34 2005/01/26 12:13:58 foxr Exp $
1.16 harris41 10: ###
1.15 harris41 11:
12: ###############################################################################
13: ## ##
14: ## ORGANIZATION OF THIS PERL SCRIPT ##
15: ## ##
16: ## 1. Description of script ##
17: ## 2. Invoking script (standard input) ##
18: ## 3. Example usage inside another piece of code ##
19: ## 4. Description of functions ##
20: ## 5. Exit codes ##
21: ## 6. Initializations ##
22: ## 7. Make sure this process is running from user=www ##
23: ## 8. Start running script with www permissions ##
24: ## 9. Handle case of another lcpasswd process (locking) ##
25: ## 10. Error-check input, need 3 values (user name, password 1, password 2) ##
26: ## 11. Start running script with root permissions ##
27: ## 12. Add user and make www a member of the user-specific group ##
28: ## 13. Set password ##
29: ## 14. Make final modifications to the user directory ##
30: ## 15. Exit script (unlock) ##
31: ## ##
32: ###############################################################################
1.1 harris41 33:
34: use strict;
1.35 ! foxr 35: use File::Find;
! 36:
1.1 harris41 37:
1.15 harris41 38: # ------------------------------------------------------- Description of script
39: #
1.1 harris41 40: # This script is a setuid script that should
1.20 foxr 41: # be run by user 'www'. It creates a /home/USERNAME directory.
1.15 harris41 42: # It adds a user to the unix system.
1.2 harris41 43: # Passwords are set with lcpasswd.
44: # www becomes a member of this user group.
1.1 harris41 45:
1.15 harris41 46: # -------------- Invoking script (standard input versus command-line arguments)
1.26 foxr 47: # Otherwise sensitive information will be available to ps-ers for
48: # a small but exploitable time window.
1.15 harris41 49: #
50: # Standard input (STDIN) usage
1.1 harris41 51: # First line is USERNAME
52: # Second line is PASSWORD
1.3 harris41 53: # Third line is PASSWORD
1.26 foxr 54: # Fouth line is the name of a file to which an error code will be written.
55: # If the fourth line is omitted, no error file will be written.
56: # In either case, the program Exits with the code as its Exit status.
57: # The error file will just be a single line containing an
58: # error code.
59: #
60: #
1.15 harris41 61: #
62: # Command-line arguments [USERNAME] [PASSWORD] [PASSWORD]
63: # Yes, but be very careful here (don't pass shell commands)
64: # and this is only supported to allow perl-system calls.
65: #
1.7 harris41 66: # Valid passwords must consist of the
67: # ascii characters within the inclusive
68: # range of 0x20 (32) to 0x7E (126).
69: # These characters are:
70: # SPACE and
71: # !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNO
72: # PQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
1.15 harris41 73: #
1.7 harris41 74: # Valid user names must consist of ascii
75: # characters that are alphabetical characters
76: # (A-Z,a-z), numeric (0-9), or the underscore
77: # mark (_). (Essentially, the perl regex \w).
1.15 harris41 78: # User names must begin with an alphabetical character
79: # (A-Z,a-z).
1.7 harris41 80:
1.15 harris41 81: # ---------------------------------- Example usage inside another piece of code
1.4 harris41 82: # Usage within code
83: #
1.26 foxr 84: # $Exitcode=
1.15 harris41 85: # system("/home/httpd/perl/lcuseradd","NAME","PASSWORD1","PASSWORD2")/256;
1.26 foxr 86: # print "uh-oh" if $Exitcode;
1.4 harris41 87:
1.15 harris41 88: # ---------------------------------------------------- Description of functions
89: # enable_root_capability() : have setuid script run as root
90: # disable_root_capability() : have setuid script run as www
91: # try_to_lock() : make sure that another lcpasswd process isn't running
92:
93: # ------------------------------------------------------------------ Exit codes
1.26 foxr 94: # These are the Exit codes.
1.13 harris41 95: # ( (0,"ok"),
96: # (1,"User ID mismatch. This program must be run as user 'www'"),
1.15 harris41 97: # (2,"Error. This program needs 3 command-line arguments (username, ".
98: # "password 1, password 2)."),
1.13 harris41 99: # (3,"Error. Three lines should be entered into standard input."),
1.15 harris41 100: # (4,"Error. Too many other simultaneous password change requests being ".
101: # "made."),
1.13 harris41 102: # (5,"Error. User $username does not exist."),
103: # (6,"Error. Could not make www a member of the group \"$safeusername\"."),
104: # (7,"Error. Root was not successfully enabled.),
1.15 harris41 105: # (8,"Error. Cannot set password."),
1.13 harris41 106: # (9,"Error. The user name specified has invalid characters."),
107: # (10,"Error. A password entry had an invalid character."),
108: # (11,"Error. User already exists.),
1.15 harris41 109: # (12,"Error. Something went wrong with the addition of user ".
110: # "\"$safeusername\"."),
1.13 harris41 111: # (13,"Error. Password mismatch."),
1.26 foxr 112: # (14, "Error filename is invalid")
1.4 harris41 113:
1.15 harris41 114: # ------------------------------------------------------------- Initializations
1.1 harris41 115: # Security
1.15 harris41 116: $ENV{'PATH'}='/bin/:/usr/bin:/usr/local/sbin:/home/httpd/perl'; # Nullify path
117: # information
1.16 harris41 118: delete @ENV{qw(IFS CDPATH ENV BASH_ENV)}; # nullify potential taints
1.2 harris41 119:
1.15 harris41 120: # Do not print error messages.
121: my $noprint=1;
122:
1.26 foxr 123: # Error file:
124:
125: my $error_file; # This is either the error file name or undef.
126:
1.23 foxr 127: print "In lcuseradd\n" unless $noprint;
128:
1.15 harris41 129: # ----------------------------- Make sure this process is running from user=www
130: my $wwwid=getpwnam('www');
131: &disable_root_capability;
132: if ($wwwid!=$>) {
133: print("User ID mismatch. This program must be run as user 'www'\n")
134: unless $noprint;
1.26 foxr 135: &Exit(1);
1.4 harris41 136: }
1.15 harris41 137:
138: # ----------------------------------- Start running script with www permissions
1.4 harris41 139: &disable_root_capability;
140:
1.15 harris41 141: # --------------------------- Handle case of another lcpasswd process (locking)
1.4 harris41 142: unless (&try_to_lock("/tmp/lock_lcpasswd")) {
1.15 harris41 143: print "Error. Too many other simultaneous password change requests being ".
144: "made.\n" unless $noprint;
1.26 foxr 145: &Exit(4);
1.4 harris41 146: }
147:
1.15 harris41 148: # ------- Error-check input, need 3 values (user name, password 1, password 2).
1.4 harris41 149: my @input;
1.26 foxr 150: if (@ARGV>=3) {
1.4 harris41 151: @input=@ARGV;
1.28 foxr 152: } elsif (@ARGV) {
1.26 foxr 153: print("Error. This program needs at least 3 command-line arguments (username, ".
154: "password 1, password 2 [errorfile]).\n") unless $noprint;
1.4 harris41 155: unlink('/tmp/lock_lcpasswd');
1.26 foxr 156: &Exit(2);
1.28 foxr 157: } else {
1.4 harris41 158: @input=<>;
1.26 foxr 159: if (@input < 3) {
160: print("Error. At least three lines should be entered into standard input.\n")
1.15 harris41 161: unless $noprint;
1.4 harris41 162: unlink('/tmp/lock_lcpasswd');
1.26 foxr 163: &Exit(3);
1.4 harris41 164: }
1.19 harris41 165: foreach (@input) {chomp;}
1.4 harris41 166: }
167:
1.26 foxr 168: my ($username,$password1,$password2, $error_file)=@input;
1.23 foxr 169: print "Username = ".$username."\n" unless $noprint;
1.4 harris41 170: $username=~/^(\w+)$/;
1.22 foxr 171: print "Username after substitution - ".$username unless $noprint;
1.4 harris41 172: my $safeusername=$1;
1.23 foxr 173: print "Safe username = $safeusername \n" unless $noprint;
1.22 foxr 174:
1.15 harris41 175: if (($username ne $safeusername) or ($safeusername!~/^[A-Za-z]/)) {
1.22 foxr 176: print "Error. The user name specified $username $safeusername has invalid characters.\n"
1.15 harris41 177: unless $noprint;
1.8 harris41 178: unlink('/tmp/lock_lcpasswd');
1.26 foxr 179: &Exit(9);
1.8 harris41 180: }
181: my $pbad=0;
1.19 harris41 182: foreach (split(//,$password1)) {if ((ord($_)<32)||(ord($_)>126)){$pbad=1;}}
183: foreach (split(//,$password2)) {if ((ord($_)<32)||(ord($_)>126)){$pbad=1;}}
1.8 harris41 184: if ($pbad) {
1.26 foxr 185: print "Error. A password entry had an invalid character.\n" unless $noprint;
1.8 harris41 186: unlink('/tmp/lock_lcpasswd');
1.26 foxr 187: &Exit(10);
1.8 harris41 188: }
1.5 harris41 189:
1.26 foxr 190: #
191: # Safe the filename. For our case, it must only have alpha, numeric, period
192: # and path sparators..
193: #
194:
195: print "Error file is $error_file \n" unless $noprint;
196:
197: if($error_file) {
198: if($error_file =~ /^([(\w)(\d)\.\/]+)$/) {
199: print "Error file matched pattern $error_file : $1\n" unless $noprint;
200: my $safe_error_file = $1; # Untainted I think.
201: print "Error file after transform $safe_error_file\n"
202: unless $noprint;
203: if($error_file == $safe_error_file) {
204: $error_file = $safe_error_file; # untainted error_file.
205: } else {
206: $error_file ="";
207: print "Invalid error filename\n" unless $noprint;
208: Exit(14);
209: }
210:
1.28 foxr 211: } else {
1.26 foxr 212: $error_file="";
213: print "Invalid error filename\n" unless $noprint;
214: Exit(14);
215: }
216: }
217:
218:
1.31 foxr 219: # -- Only add the user if they are >not< in /etc/passwd.
220: # Used to look for the ability to create a new directory for the
221: # user, however that disallows authentication changes from i
222: # internal->fs.. so just check the passwd file instead.
223: #
1.34 foxr 224: my $not_found = system("cut -d: -f1 /etc/passwd | grep -q \"^$safeusername\$\" ");
1.31 foxr 225: if (!$not_found) {
226: print "Error user already exists\n" unless $noprint;
1.7 harris41 227: unlink('/tmp/lock_lcpasswd');
1.26 foxr 228: &Exit(11);
1.7 harris41 229: }
230:
1.31 foxr 231:
232:
1.15 harris41 233: # -- Only add user if the two password arguments match.
1.23 foxr 234:
1.5 harris41 235: if ($password1 ne $password2) {
1.6 harris41 236: print "Error. Password mismatch.\n" unless $noprint;
1.5 harris41 237: unlink('/tmp/lock_lcpasswd');
1.26 foxr 238: &Exit(13);
1.5 harris41 239: }
1.23 foxr 240: print "enabling root\n" unless $noprint;
1.15 harris41 241: # ---------------------------------- Start running script with root permissions
1.4 harris41 242: &enable_root_capability;
243:
1.15 harris41 244: # ------------------- Add user and make www a member of the user-specific group
245: # -- Add user
1.23 foxr 246:
247: print "adding user: $safeusername \n" unless $noprint;
248: my $status = system('/usr/sbin/useradd','-c','LON-CAPA user',$safeusername);
249: if ($status) {
1.15 harris41 250: print "Error. Something went wrong with the addition of user ".
251: "\"$safeusername\".\n" unless $noprint;
1.23 foxr 252: print "Final status of useradd = $status";
1.4 harris41 253: unlink('/tmp/lock_lcpasswd');
1.26 foxr 254: &Exit(12);
1.4 harris41 255: }
1.23 foxr 256: print "Done adding user\n" unless $noprint;
1.7 harris41 257: # Make www a member of that user group.
1.26 foxr 258: my $groups=`/usr/bin/groups www` or &Exit(6);
1.27 albertel 259: # untaint
1.29 albertel 260: my ($safegroups)=($groups=~/:\s*([\s\w]+)/);
1.27 albertel 261: $groups=$safegroups;
1.17 harris41 262: chomp $groups; $groups=~s/^\S+\s+\:\s+//;
263: my @grouplist=split(/\s+/,$groups);
264: my @ugrouplist=grep {!/www|$safeusername/} @grouplist;
265: my $gl=join(',',(@ugrouplist,$safeusername));
1.23 foxr 266: print "Putting user in its own group\n" unless $noprint;
1.17 harris41 267: if (system('/usr/sbin/usermod','-G',$gl,'www')) {
1.15 harris41 268: print "Error. Could not make www a member of the group ".
269: "\"$safeusername\".\n" unless $noprint;
1.5 harris41 270: unlink('/tmp/lock_lcpasswd');
1.26 foxr 271: &Exit(6);
1.5 harris41 272: }
273:
1.15 harris41 274: # ---------------------------------------------------------------- Set password
275: # Set password with lcpasswd (which creates smbpasswd entry).
1.2 harris41 276:
1.15 harris41 277: unlink('/tmp/lock_lcpasswd');
278: &disable_root_capability;
1.16 harris41 279: ($>,$<)=($wwwid,$wwwid);
1.23 foxr 280: print "Opening lcpasswd pipeline\n" unless $noprint;
1.16 harris41 281: open OUT,"|/home/httpd/perl/lcpasswd";
1.15 harris41 282: print OUT $safeusername;
283: print OUT "\n";
284: print OUT $password1;
285: print OUT "\n";
286: print OUT $password1;
287: print OUT "\n";
288: close OUT;
289: if ($?) {
1.26 foxr 290: print "abnormal Exit from close lcpasswd\n" unless $noprint;
291: &Exit(8);
1.8 harris41 292: }
1.18 harris41 293: ($>,$<)=($wwwid,0);
1.15 harris41 294: &enable_root_capability;
1.8 harris41 295:
1.20 foxr 296: # -- Don't add public_html... that can be added either by the user
297: # or by lchtmldir when the user is granted an authorship role.
298:
1.15 harris41 299: # ------------------------------ Make final modifications to the user directory
300: # -- Add a public_html file with a stand-in index.html file
1.8 harris41 301:
1.21 foxr 302: system('/bin/chmod','-R','0660',"/home/$safeusername");
303: system('/bin/chmod','0710',"/home/$safeusername");
304: mkdir "/home/$safeusername/public_html",0755;
305: open OUT,">/home/$safeusername/public_html/index.html";
306: print OUT<<END;
307: <html>
308: <head>
309: <title>$safeusername</title>
310: </head>
311: <body>
1.24 www 312: <h1>Construction Space</h1>
313: <h3>$safeusername</h3>
1.21 foxr 314: </body>
315: </html>
316: END
317: close OUT;
1.35 ! foxr 318:
1.32 foxr 319: #
320: # In order to allow the loncapa daemons appropriate access
321: # to public_html, Top level and public_html directories should
1.34 foxr 322: # be owned by safeusername:safeusername as should the smaple index.html..
1.24 www 323: print "lcuseradd ownership\n" unless $noprint;
1.32 foxr 324: system('/bin/chown','-R',"$safeusername:$safeusername","/home/$safeusername"); # First set std ownership on everything.
1.35 ! foxr 325: &set_public_html_permissions("/home/$safeusername/public_html");
1.33 foxr 326: # system('/bin/chown',"$safeusername:www","/home/$safeusername"); # Now adust top level...
327: # system('/bin/chown','-R',"$safeusername:www","/home/$safeusername/public_html"); # And web dir.
1.24 www 328: # ---------------------------------------------------- Gracefull Apache Restart
329: if (-e '/var/run/httpd.pid') {
330: print "lcuseradd Apache restart\n" unless $noprint;
331: open(PID,'/var/run/httpd.pid');
332: my $pid=<PID>;
333: close(PID);
1.35 ! foxr 334: my $pid=~ /(\D+)/;
! 335: my $safepid = $1;
1.24 www 336: if ($pid) {
1.27 albertel 337: system('kill','-USR1',"$safepid");
1.24 www 338: }
339: }
1.15 harris41 340: # -------------------------------------------------------- Exit script
1.26 foxr 341: print "lcuseradd Exiting\n" unless $noprint;
1.8 harris41 342: &disable_root_capability;
1.26 foxr 343: &Exit(0);
1.1 harris41 344:
1.15 harris41 345: # ---------------------------------------------- Have setuid script run as root
1.5 harris41 346: sub enable_root_capability {
347: if ($wwwid==$>) {
1.23 foxr 348: ($<,$>)=($>,0);
349: ($(,$))=($),0);
1.28 foxr 350: } else {
1.5 harris41 351: # root capability is already enabled
352: }
353: return $>;
354: }
355:
1.15 harris41 356: # ----------------------------------------------- Have setuid script run as www
1.5 harris41 357: sub disable_root_capability {
358: if ($wwwid==$<) {
359: ($<,$>)=($>,$<);
360: ($(,$))=($),$();
1.28 foxr 361: } else {
1.5 harris41 362: # root capability is already disabled
363: }
364: }
365:
1.15 harris41 366: # ----------------------- Make sure that another lcpasswd process isn't running
1.5 harris41 367: sub try_to_lock {
368: my ($lockfile)=@_;
369: my $currentpid;
370: my $lastpid;
371: # Do not manipulate lock file as root
372: if ($>==0) {
373: return 0;
374: }
375: # Try to generate lock file.
376: # Wait 3 seconds. If same process id is in
377: # lock file, then assume lock file is stale, and
378: # go ahead. If process id's fluctuate, try
379: # for a maximum of 10 times.
380: for (0..10) {
381: if (-e $lockfile) {
382: open(LOCK,"<$lockfile");
383: $currentpid=<LOCK>;
384: close LOCK;
385: if ($currentpid==$lastpid) {
386: last;
387: }
388: sleep 3;
389: $lastpid=$currentpid;
1.28 foxr 390: } else {
1.5 harris41 391: last;
392: }
393: if ($_==10) {
394: return 0;
395: }
396: }
397: open(LOCK,">$lockfile");
398: print LOCK $$;
399: close LOCK;
400: return 1;
401: }
1.35 ! foxr 402: # Called by File::Find::find for each file examined.
! 403: #
! 404: # Untaint the file and, if it is a directory,
! 405: # chmod it to 02770
! 406: #
! 407: sub set_permission {
! 408: $File::Find::name =~ /^(.*)$/;
! 409: my $safe_name = $1; # Untainted filename...
! 410:
! 411: print "$safe_name" unless $noprint;
! 412: if(-d $safe_name) {
! 413: print " - directory" unless $noprint;
! 414: chmod(02770, $safe_name);
! 415: }
! 416: print "\n" unless $noprint;
! 417:
! 418: }
! 419: #
! 420: # Set up the correct permissions for all files in the
! 421: # user's public htmldir. We just do a chmod -R 0660 ... for
! 422: # the ordinary files. The we use File::Find
! 423: # to pop through the directory tree changing directories only
! 424: # to 02770:
! 425: #
! 426: sub set_public_html_permissions {
! 427: my ($topdir) = @_;
! 428:
! 429: # Set the top level dir permissions (I'm not sure if find
! 430: # will enumerate it specifically), correctly and all
! 431: # files and dirs to the 'ordinary' file permissions:
! 432:
! 433: system("chmod -R 0660 $topdir");
! 434: chmod(02770, $topdir);
! 435:
! 436: # Now use find to locate all directories under $topdir
! 437: # and set their modes to 02770...
! 438: #
! 439: print "Find file\n " unless $noprint;
! 440: File::Find::find({"untaint" => 1,
! 441: "untaint_pattern" => qr(/^(.*)$/),
! 442: "untaint_skip" => 1,
! 443: "no_chdir" => 1,
! 444: "wanted" => \&set_permission }, "$topdir");
! 445:
! 446:
! 447: }
! 448:
1.26 foxr 449: #-------------------------- Exit...
450: #
451: # Write the file if the error_file is defined. Regardless
452: # Exit with the status code.
453: #
454: sub Exit {
455: my ($code) = @_; # Status code.
456:
457: print "Exiting with status $code error file is $error_file\n" unless $noprint;
458: if($error_file) {
459: open(FH, ">$error_file");
460: print FH "$code\n";
461: close(FH);
462: }
463: exit $code;
464: }
1.16 harris41 465:
466: =head1 NAME
467:
468: lcuseradd - LON-CAPA setuid script to coordinate all actions
469: with adding a user with filesystem privileges (e.g. author)
470:
471: =head1 DESCRIPTION
472:
473: lcuseradd - LON-CAPA setuid script to coordinate all actions
474: with adding a user with filesystem privileges (e.g. author)
475:
476: =head1 README
477:
478: lcuseradd - LON-CAPA setuid script to coordinate all actions
479: with adding a user with filesystem privileges (e.g. author)
480:
481: =head1 PREREQUISITES
482:
483: =head1 COREQUISITES
484:
485: =pod OSNAMES
486:
487: linux
488:
489: =pod SCRIPT CATEGORIES
490:
491: LONCAPA/Administrative
492:
493: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lcuseradd CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom