mkproj.in 15.6 KB
Newer Older
1
#!/usr/bin/perl -wT
Leigh B. Stoller's avatar
Leigh B. Stoller committed
2
#
3
# Copyright (c) 2000-2014 University of Utah and the Flux Group.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
23
#
24
use English;
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
use Getopt::Std;

#
# Perform project approval. Does a lot of stuff, see below!
#
sub usage()
{
    print(STDERR
	  "Usage: mkproj [-s] [-h leader_uid] [-m <message> | -f <file>] ".
	  "<pid>\n".
	  "switches and arguments:\n".
	  "-s         - silent; do not send approval email to leader\n".
	  "-h <uid>   - switch project leader to specified uid\n".
	  "-m <text>  - Include text in approval email message\n".
	  "-f <file>  - Include text from file in approval email message\n".
	  "<pid>      - project to approve.\n");
    exit(-1);
}
my $optlist    = "qsh:m:f:";
my $quiet      = 0;
my $silent     = 0;
46
my $newleader_uid;
47 48 49 50 51
my $message;
my $mfilename;
my $pid;

# Protos
52 53
sub fatal($);

54 55 56
#
# Configure variables
#
57 58
my $TB            = "@prefix@";
my $TBOPS         = "@TBOPSEMAIL@";
59
my $TBAPPROVAL    = "@TBAPPROVALEMAIL@";
60
my $TBAUDIT	  = "@TBAUDITEMAIL@";
61
my $TBBASE        = "@TBBASE@";
62
my $TBWWW         = "@TBWWW@";
63 64 65 66 67 68
my $MKGROUP       = "$TB/sbin/mkgroup";
my $MODGROUPS     = "$TB/sbin/modgroups";
my $MKACCT        = "$TB/sbin/tbacct add";
my $CVSBIN        = "/usr/bin/cvs";
my $CHOWN         = "/usr/sbin/chown";
my $GRANTTYPE     = "$TB/sbin/grantnodetype -d";
69
my $UPDATEPERMS   = "$TB/sbin/update_permissions";
70
my $ELABINELAB    = @ELABINELAB@;
71
my $MAINSITE      = @TBMAINSITE@;
72 73
my $WIKISUPPORT   = @WIKISUPPORT@;
my $BUGDBSUPPORT  = @BUGDBSUPPORT@;
74
my $OPSDBSUPPORT  = @OPSDBSUPPORT@;
75 76
my $CVSSUPPORT    = @CVSSUPPORT@;
my $MAILMANSUPPORT= @MAILMANSUPPORT@;
77 78 79 80
my $ADDWIKIPROJ   = "$TB/sbin/addwikiproj";
my $ADDBUGDBPROJ  = "$TB/sbin/addbugdbproj";
my $ADDMMLIST     = "$TB/sbin/addmmlist";
my $OPSDBCONTROL  = "$TB/sbin/opsdb_control";
81
my $CLOSEPROJADMINLIST = "$TB/sbin/closeprojadminlist";
82
	  
83
my @DIRLIST  = ("exp", "images", "logs", "deltas", "tarfiles", "rpms",
84
		"groups", "tiplogs", "images/sigs", "templates");
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100

#
# Untaint the path
# 
$ENV{'PATH'} = "/bin:/usr/bin";
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

#
# Turn off line buffering on output
#
$| = 1;

#
# Load the Testbed support stuff. 
#
use lib "@prefix@/lib";
101
use libaudit;
102 103
use libdb;
use libtestbed;
104 105
use User;
use Project;
106

107 108 109 110 111 112 113 114 115 116
my $PROJROOT     = PROJROOT();
my $GRPROOT      = GROUPROOT();
my $SCRATCHROOT  = SCRATCHROOT();

#
# XXX semi-hardwired, oddball paths
#
my $TFTPDIR  = "/tftpboot/$PROJROOT";
my $CVSREPOS = "$PROJROOT/cvsrepos";

117 118
# Locals
my $leader;
119
my $oldleader;
120
my $isnonlocal;
121

122
#
123
# We do not want to run this script unless its the real version.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
#
if ($EUID != 0) {
    die("*** $0:\n".
	"    Must be setuid! Maybe its a development version?\n");
}

#
# This script is setuid, so please do not run it as root. Hard to track
# what has happened.
# 
if ($UID == 0) {
    die("*** $0:\n".
	"    Please do not run this as root! Its already setuid!\n");
}

#
# Check args.
#
142 143 144 145 146 147
my %options = ();
if (! getopts($optlist, \%options)) {
    usage();
}
if (defined($options{"q"})) {
    $quiet = 1;
148
}
149 150 151 152 153 154 155 156 157 158 159 160
if (defined($options{"s"})) {
    $silent = 1;
}
if (defined($options{"m"})) {
    $message = $options{"m"};
}
if (defined($options{"f"})) {
    $mfilename = $options{"f"};
    fatal("$mfilename does not exist!")
	if (! -e $mfilename);
}
if (defined($options{"h"})) {
161
    $newleader_uid = $options{"h"};
162 163 164 165 166
}
usage()
    if (! @ARGV);

$pid = $ARGV[0];
167 168 169 170

#
# Untaint the argument.
#
171
if ($pid =~ /^([-\w]+)$/) {
172 173 174 175 176 177
    $pid = $1;
}
else {
    die("Invalid pid '$pid' contains illegal characters.\n");
}

178 179 180 181
# Map invoking user to object.
my $this_user = User->ThisUser();
if (! defined($this_user)) {
    fatal("You ($UID) do not exist!");
182 183 184
}

#
185
# Figure out who called us. Must have admin status to do this.
186
#
187 188
if (!TBAdmin()) {
    fatal("You must be a TB administrator to run this script!");
189 190
}

191 192 193 194 195 196 197 198 199 200
#
# This script is always audited. Mail is sent automatically upon exit.
#
if (AuditStart(0)) {
    #
    # Parent exits normally
    #
    exit(0);
}

201 202 203 204 205 206 207
#
# Map project name to object.
#
my $target_project = Project->Lookup($pid);
if (! defined($target_project)) {
    fatal("Could not map project $pid to its object!");
}
208 209
my $pid_idx = $target_project->pid_idx();
my $gid_idx = $target_project->gid_idx();
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229

#
# The welcome message ...
#
if (defined($mfilename)) {
    open(MFILE, $mfilename) or
	fatal("Could not open $mfilename");

    $message = "";
    while (<MFILE>) {
	$message .= $_;
    }
    close(MFILE);
}

#
# If a leader uid was provided on the command line, we are changing the
# leader. Note that this is allowed *only* for projects that have not
# been approved yet. 
#
230 231
if (defined($newleader_uid)) {
    $leader = User->Lookup($newleader_uid);
232
    if (!defined($leader)) {
233
	fatal("Could not map user $newleader_uid to its object!");
234 235 236 237 238 239 240 241 242 243
    }
    # See if already did this; is so skip the following checks.
    my $curleader = $target_project->GetLeader();
    if (!defined($curleader)) {
	fatal("Could not map current leader of project $pid to its object!");
    }
    if (! $curleader->SameUser($leader)) {
	fatal("Not allowed to change the leader of an approved project!")
	    if ($target_project->approved());

244 245 246
	# Save for email below.
	$oldleader = $curleader;

247 248 249 250
	# Update the project structure with the new leader. We are going
	# to set the approved bit below, so this is the last chance to do
	# this until we have code in place to change it later.
	$target_project->ChangeLeader($leader) == 0 or
251
	    fatal("Could not change leader for $pid to $newleader_uid!");
252 253 254 255 256 257 258 259 260 261
    }
}
else {
    $leader = $target_project->GetLeader();
    if (!defined($leader)) {
	fatal("Could not map current leader of project $pid to its object!");
    }
}
# Avoid taint check problem.
$leader_uid = $leader->uid();
262 263
$isnonlocal = $target_project->IsNonLocal();
$wasactive  = ($leader->status() eq USERSTATUS_ACTIVE() ? 1 : 0);
264
$silent     = 1 if ($isnonlocal && !$MAINSITE);
265 266 267 268 269 270 271 272 273 274 275 276

# Approve the project; we are committed to the leader.
$target_project->SetApproved(1) == 0 or
    fatal("Could not set the approval bit on project $target_project!");

#
# Leader needs to have his approved bit set. Eventually this should be done
# in mkaccount when that code moves from the web interface.
#
$leader->SetStatus(USERSTATUS_ACTIVE()) == 0 or
    fatal("Could not change $leader to active!");

277 278 279 280
#
# Before we can proceed, we need to create the project (unix) group
# and then create an account for the project leader. We pass this off
# to sub scripts, but because they are also setuid, we need to flip
281
# our UID (perl sillyness).
282
#
283
$EUID = $UID;
284

285
system("$MKGROUP $gid_idx") == 0 or
286
    fatal("$MKGROUP $pid failed!");
287

288
if ($WIKISUPPORT && !$isnonlocal) {
289 290 291
    system("$ADDWIKIPROJ $pid") == 0 or
	fatal("$ADDWIKIPROJ $pid failed!");
}
292
if ($BUGDBSUPPORT && !$isnonlocal) {
293 294 295
    system("$ADDBUGDBPROJ $pid") == 0 or
	fatal("$ADDBUGDBPROJ $pid failed!");
}
296
if ($OPSDBSUPPORT && !$isnonlocal) {
297 298 299
    system("$OPSDBCONTROL addproj $pid") == 0 or
	fatal("$OPSDBCONTROL addproj $pid failed!");
}
300
if ($MAILMANSUPPORT && !$isnonlocal) {
301 302 303
    system("$ADDMMLIST -a ${pid}-users") == 0 or
	fatal("$ADDMMLIST -a ${pid}-users failed!");
}
304

305
#
306
# Skip if user was already an active user; lots of work avoided.
307 308 309 310 311 312 313 314
#
# XXX cannot do this for elabinelab since DB has been pre-loaded with
# state that will make it appear that the initial project leader is active
# when in fact the account has not been created. This is only during
# elabinelab setup and when the swapper is the project leader, so a more
# precise fix is possible.
#
if ($ELABINELAB || !$wasactive) {
315 316 317
    system("$MKACCT $leader_uid") == 0 or
	fatal("$MKACCT $leader_uid failed!");
}
318

319 320
system("$MODGROUPS -a $pid:$pid:project_root $leader_uid") == 0 or
    fatal("$MODGROUPS -a $pid:$pid:project_root $leader_uid failed!");
321

322
$EUID = 0;
323 324 325

#
# This acts as check (and we need the numeric uid) in case mkacct failed!
326 327 328
#
my $unix_name = $target_project->unix_name();

329 330
my (undef,undef,$uid) = getpwnam($leader_uid)
    or fatal("$leader_uid not in passwd file");
331

332
my (undef,undef,$gid) = getgrnam($unix_name)
333 334 335 336 337
    or fatal("$pid not in group file");

#
# Okay, do it.
#
338 339 340 341
if (! -e "$PROJROOT/$pid") {
    if (! mkdir("$PROJROOT/$pid", 0770)) {
	fatal("Could not make directory $PROJROOT/$pid: $!");
    }
342
}
343 344 345 346 347 348 349 350
if (! chmod(0770, "$PROJROOT/$pid")) {
    fatal("Could not chmod directory $PROJROOT/$pid: $!");
}
if (! chown($uid, $gid, "$PROJROOT/$pid")) {
    fatal("Could not chown $PROJROOT/$pid to $uid/$gid: $!");
}

if ($SCRATCHROOT) {
351 352 353 354 355
    if (! -e "$SCRATCHROOT") {
        if (! mkdir("$SCRATCHROOT", 0770)) {
            fatal("Could not make a directory $SCRATCHROOT: $!");
        }
    }
356 357 358 359
    if (! -e "$SCRATCHROOT/$pid") {
	if (! mkdir("$SCRATCHROOT/$pid", 0770)) {
	    fatal("Could not make directory $SCRATCHROOT/$pid: $!");
	}
360 361 362 363 364 365 366 367
    }
    if (! chmod(0770, "$SCRATCHROOT/$pid")) {
	fatal("Could not chmod directory $SCRATCHROOT/$pid: $!");
    }
    if (! chown($uid, $gid, "$SCRATCHROOT/$pid")) {
	fatal("Could not chown $SCRATCHROOT/$pid to $uid/$gid: $!");
    }
}
368 369 370 371 372

#
# Make project subdirs.
#
foreach my $dir (@DIRLIST) {
373 374 375 376
    if (! -e "$PROJROOT/$pid/$dir") {
	if (! mkdir("$PROJROOT/$pid/$dir", 0770)) {
	    fatal("Could not make directory $PROJROOT/$pid/$dir: $!");
	}
377 378 379 380 381 382
    }
    if (! chmod(0770, "$PROJROOT/$pid/$dir")) {
	fatal("Could not chmod directory $PROJROOT/$pid/$dir: $!");
    }
    if (! chown($uid, $gid, "$PROJROOT/$pid/$dir")) {
	fatal("Could not chown $PROJROOT/$pid/$dir to $uid/$gid: $!");
383 384 385 386 387
    }
}

#
# Create a tftp directory for oskit kernels.
388
#
389
if (-e "$TFTPDIR" && ! -e "$TFTPDIR/$pid" && !$isnonlocal) {
390 391
    if (! mkdir("$TFTPDIR/$pid", 0770)) {
	fatal("Could not make directory $TFTPDIR/$pid: $!");
392
    }
393 394
    if (! chmod(0777, "$TFTPDIR/$pid")) {
	fatal("Could not chmod directory $TFTPDIR/$pid: $!");
395
    }
396 397
    if (! chown($uid, $gid, "$TFTPDIR/$pid")) {
	fatal("Could not chown $TFTPDIR/$pid to $uid/$gid: $!");
398
    }
399 400
}

401 402 403
#
# Do the CVS stuff if its turned on.
#
404
if ($CVSSUPPORT && !$isnonlocal) {
405
    my $CVSDIR = "$CVSREPOS/$pid";
406

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
    if (! -e "$CVSDIR") {
	if (! mkdir("$CVSDIR", 0770)) {
	    fatal("Could not make directory $CVSDIR: $!");
	}
    }
    if (! chmod(0770, "$CVSDIR")) {
	fatal("Could not chmod directory $CVSDIR: $!");
    }
    if (! chown($uid, $gid, "$CVSDIR")) {
	fatal("Could not chown $CVSDIR to $uid/$gid: $!");
    }
    if (! -e "$CVSDIR/CVSROOT") {
	system("$CVSBIN -d $CVSDIR init");
	if ($?) {
	    fatal("Could not cvs init $CVSDIR!");
	}
423 424 425 426 427 428 429 430
    }
    # Chown the tree.
    system("$CHOWN -R ${uid}:${gid} $CVSDIR");
    if ($?) {
	fatal("Could not chown ${uid}:${gid} $CVSDIR!");
    }
}

431 432
#
# Create groups directory.
433 434 435 436 437
#
if (! -e "$GRPROOT/$pid") {
    if (! mkdir("$GRPROOT/$pid", 0770)) {
	fatal("Could not make directory $GRPROOT/$pid: $!");
    }
438 439 440 441 442 443 444 445 446 447 448
}
if (! chmod(0770, "$GRPROOT/$pid")) {
    fatal("Could not chmod directory $GRPROOT/$pid: $!");
}
if (! chown($uid, $gid, "$GRPROOT/$pid")) {
    fatal("Could not chown $GRPROOT/$pid to $uid/$gid: $!");
}
# Create a group link for the default group.
if (! -e "$GRPROOT/$pid/$pid") {    
    if (system("ln -s $PROJROOT/$pid $GRPROOT/$pid/$pid")) {
	fatal("Could not symlink $PROJROOT/$pid to $GRPROOT/$pid/$pid");
449
    }
450 451
}

452 453 454
#
# Create experiment working directory.
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
455
my $workdir = TBDB_EXPT_WORKDIR() . "/$pid";
456

457
if (! -e $workdir) {
458
    if (! mkdir("$workdir", 0775)) {
459 460
	fatal("Could not make directory $workdir: $!");
    }
461
    if (! chmod(0775, "$workdir")) {
462 463 464 465 466
	fatal("Could not chmod directory $workdir: $!");
    }
    if (! chown($uid, $gid, "$workdir")) {
	fatal("Could not chown $workdir to $uid/$gid: $!");
    }
467 468
}

469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
#
# Create experiment info (long term archive) directory.
#
my $infodir = "$TB/expinfo/$pid";

if (! -e $infodir) {
    if (! mkdir("$infodir", 0775)) {
	fatal("Could not make directory $infodir: $!");
    }
    if (! chmod(0775, "$infodir")) {
	fatal("Could not chmod directory $infodir: $!");
    }
    if (! chown($uid, $gid, "$infodir")) {
	fatal("Could not chown $infodir to $uid/$gid: $!");
    }
}

486 487 488 489 490 491 492 493
#
# If approved to use remote nodes, then grant permission to use the
# specific types of virtual nodes on those remote physical nodes.
# Unfortunately, the node_types table does not store a relationship
# between the phys type and the virtual types that are hosted on them.
# Need to add that I guess, but in the meantime we have just 3 remote
# phys types to worry about. 
#
494
if (! ($ELABINELAB || $isnonlocal)) {
495 496 497 498
    my $query_result =
	DBQueryFatal("select pcremote_ok from projects where pid='$pid'");
    if ($query_result->num_rows) {
	my ($pcremote) = $query_result->fetchrow_array();
499

500 501
	if (defined($pcremote)) {
	    print "$pcremote\n";
502
	
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
	    foreach my $type (split(",", $pcremote)) {
		print "$type\n";
		
		if ($type eq "pcplabphys") {
		    $type = "pcplab";
		}
		elsif ($type eq "pcron") {
		    $type = "pcvwa";
		}
		elsif ($type eq "pcwa") {
		    $type = "pcvwa";
		}
		else {
		    fatal("Unknown remote type $type!");
		}
		print "$type\n";

		$EUID = $UID;

		system("$GRANTTYPE -p $pid $type") == 0 or
		    fatal("Could not grant permission to use type $type!");
		
		$EUID = 0;
526 527 528
	    }
	}
    }
529 530 531 532 533 534 535 536

    #
    # Always need to update the permissions table on new projects.
    #
    $EUID = $UID;

    system("$UPDATEPERMS") == 0 or
	fatal("Could not update permissions table!");
537
		
538
    $EUID = 0;
539 540
}

541 542 543 544 545 546 547 548 549 550 551 552 553
#
# Close proj admin list and remove testbed-approval as a member
#
#
# XXX: DISABLED FOR NOW.
#
#if ($MAILMANSUPPORT) {
#    $EUID = $UID;
#    system("$CLOSEPROJADMINLIST $pid") == 0 or
#        fatal("$CLOSEPROJADMINLIST failed");
#    $EUID = 0;
#}

554 555 556 557
# Send email, unless silent option given.
if (!$silent) {
    my $leader_name  = $leader->name();
    my $leader_email = $leader->email();
558 559
    my $wwwbase      = $target_project->wwwBase();
    my $signupurl    = $target_project->SignupURL();
560
    
561
    SendProjAdminMail
562
	($target_project, "ADMIN", "$leader_name <$leader_email>",
563 564 565 566 567
	 "Project '$pid' Approval",
	 "\n".
	 "This message is to notify you that your project '$pid'\n".
	 "has been approved.  We recommend that you save this link so that\n".
	 "you can send it to people you wish to have join your project.\n".
568
	 "Otherwise, tell them to go to ${wwwbase} and join it.\n".
569
	 "\n".
570
	 "    $signupurl\n".
571 572
	 (defined($message) ? "\n${message}\n" : "") .
	 "\n".
573
	 "Thanks!\n",
574
	 "Bcc: $TBAPPROVAL");
575 576 577 578 579 580

    #
    # If the leader was switched, then generate a second message to the
    # new leader telling him to approve the original leader to the project.
    #
    if (defined($oldleader)) {
581 582 583
	my $oldleader_uid   = $oldleader->uid();
	my $oldleader_name  = $oldleader->name();
	my $oldleader_email = $oldleader->email();
584
	
585 586
	SENDMAIL
	    ("$leader_name <$leader_email>",
587 588 589 590 591 592 593 594
	     "$oldleader_uid $pid Project Join Request",
	     "$oldleader_name wants to join project $pid.\n".
	     "\n".
	     "Please return to $TBWWW,\n".
	     "log in, select the 'New User Approval' page, and enter\n".
	     "your decision regarding ${oldleader_name}'s membership.\n".
	     "\n".
	     "Thanks,\n".
595 596
	     "Testbed Operations\n",
	     "$oldleader_name <$oldleader_email>");
597
    }
598 599
}

600
print "Project Creation Completed!\n";
601 602
exit(0);

603 604
sub fatal($) {
    my($mesg) = $_[0];
605

606 607
    die("*** $0:\n".
	"    $mesg\n");
608
}