GeniTicket.pm.in 24.6 KB
Newer Older
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1 2
#!/usr/bin/perl -wT
#
3
# GENIPUBLIC-COPYRIGHT
4
# Copyright (c) 2008-2010 University of Utah and the Flux Group.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
5 6 7 8 9 10 11 12 13 14 15 16
# All rights reserved.
#
package GeniTicket;

#
# Some simple ticket stuff.
#
use strict;
use Exporter;
use vars qw(@ISA @EXPORT);

@ISA    = "Exporter";
17
@EXPORT = qw (TICKET_PURGED TICKET_EXPIRED TICKET_REDEEMED
18
	      TICKET_RELEASED TICKET_DELETED TICKET_NOSTATS);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
19 20

use GeniDB;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
21
use GeniCredential;
22
use GeniCertificate;
23 24
use emutil qw(TBGetUniqueIndex);
use GeniUtil;
25
use GeniHRN;
26
use GeniXML;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
27
use English;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
28 29
use XML::Simple;
use XML::LibXML;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
30
use Data::Dumper;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
31 32 33
use Date::Parse;
use POSIX qw(strftime);
use Time::Local;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
34
use File::Temp qw(tempfile);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
35
use overload ('""' => 'Stringify');
Leigh B. Stoller's avatar
Leigh B. Stoller committed
36 37 38 39 40 41 42 43 44

# Configure variables
my $TB		   = "@prefix@";
my $TBOPS          = "@TBOPSEMAIL@";
my $TBAPPROVAL     = "@TBAPPROVALEMAIL@";
my $TBAUDIT   	   = "@TBAUDITEMAIL@";
my $BOSSNODE       = "@BOSSNODE@";
my $OURDOMAIN      = "@OURDOMAIN@";
my $SIGNCRED	   = "$TB/sbin/signgenicred";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
45
my $VERIFYCRED	   = "$TB/sbin/verifygenicred";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
46
my $NFREE	   = "$TB/bin/nfree";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
47
my $CMCERT	   = "$TB/etc/genicm.pem";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
48

49 50 51 52 53
# Ticket release flags
sub TICKET_PURGED()	{ return 1; }
sub TICKET_REDEEMED()	{ return 2; }
sub TICKET_EXPIRED()	{ return 3; }
sub TICKET_RELEASED()	{ return 4; }
54
sub TICKET_DELETED()	{ return 5; }
55
sub TICKET_NOSTATS()	{ return 0x1; }
56

Leigh B. Stoller's avatar
Leigh B. Stoller committed
57 58
# Cache of tickets.
my %tickets = ();
59 60 61 62 63 64
BEGIN { use GeniUtil; GeniUtil::AddCache(\%tickets); }

# Do not load this for the Clearinghouse XML server.
BEGIN { 
    if (! defined($main::GENI_ISCLRHOUSE)) {
	require Experiment;
65
	require Node;
66 67
    }
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
68 69 70 71 72 73

#
# Lookup by local idx.
#
sub Lookup($$)
{
74 75 76
    my ($class, $token) = @_;
    my $idx;
    my $query_result;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
77

78
    if (GeniHRN::IsValid($token)) {
79
	# We don't attempt to handle tickets for foreign authorities.
80 81 82 83 84 85 86
	return undef if !GeniHRN::Authoritative($token, "@OURDOMAIN@");

	my ($authority, $type, $id) = GeniHRN::Parse($token);
	return undef if $type ne "ticket";
	$idx = $id;
    }
    elsif ($token =~ /^\d+$/) {
87 88 89 90 91 92 93 94 95 96 97 98 99 100
	$idx = $token;
    }
    elsif ($token =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/) {
	$query_result =
	    DBQueryWarn("select idx from geni_tickets ".
			"where ticket_uuid='$token'");
	    return undef
		if (! $query_result || !$query_result->numrows);

	    ($idx) = $query_result->fetchrow_array();
    }
    else {
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
101 102 103
    return $tickets{"$idx"}
        if (exists($tickets{"$idx"}));

104
    $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
105 106 107 108 109 110 111 112 113
	DBQueryWarn("select * from geni_tickets where idx='$idx'");

    return undef
	if (!defined($query_result) || !$query_result->numrows);

    my $row = $query_result->fetchrow_hashref();

    # Map the component
    my $component;
114 115
    if ($row->{'component_uuid'}) {
	$component = GeniComponent->Lookup($row->{'component_uuid'});
Leigh B. Stoller's avatar
Leigh B. Stoller committed
116 117 118 119 120 121 122 123
	return undef
	    if (!defined($component));
    }
    my $ticket = GeniTicket->CreateFromSignedTicket($row->{'ticket_string'},
						    $component, 1);
    return undef
	if (!defined($ticket));

Leigh B. Stoller's avatar
Leigh B. Stoller committed
124 125 126 127
    # We ignore this in the ticket. In fact, we need to change how we bring
    # tickets back into the system.
    $ticket->{'redeem_before'} = $row->{'redeem_before'};

128 129 130
    # Mark as coming from the DB.
    $ticket->{'idx'}    = $idx;
    $ticket->{'stored'} = 1;
131
    $ticket->{'LOCKED'}   = 0;
132 133

    # Cache.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
134 135 136 137
    $tickets{"$idx"} = $ticket;
    return $ticket;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
138
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
139
# Create an unsigned ticket object, to be populated and signed and returned.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
140
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
141
sub Create($$$$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
142
{
143
    # $rspec is an XML string.
144
    my ($class, $target, $owner, $rspec) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
145

146 147 148 149 150 151 152 153 154 155
    my $parser = XML::LibXML->new;
    my $doc;
    eval {
	$doc = $parser->parse_string($rspec);
    };
    if ($@) {
	print STDERR "Failed to parse ticket string: $@\n";
	return undef;
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
156 157
    # Every Ticket gets a new unique index (sequence number).
    my $seqno = TBGetUniqueIndex('next_ticket', 1);
158

Leigh B. Stoller's avatar
Leigh B. Stoller committed
159
    my $self = {};
160
    $self->{'rspec'}         = $doc->documentElement();
161
    $self->{'ticket_uuid'}   = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
162
    $self->{'owner_uuid'}    = $owner->uuid();
163
    $self->{'owner_hrn'}     = $owner->hrn();
164
    $self->{'owner_urn'}     = $owner->urn();
165
    $self->{'owner_cert'}    = $owner->GetCertificate();
166 167
    $self->{'target_uuid'}   = $target->uuid();
    $self->{'target_hrn'}    = $target->hrn();
168
    $self->{'target_urn'}    = $target->urn();
169
    $self->{'target_cert'}   = $target->GetCertificate();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
170
    $self->{'seqno'}         = $seqno;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
171 172
    $self->{'ticket_string'} = undef;
    $self->{'component'}     = undef;
173
    $self->{'slice'}         = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
174
    $self->{'stored'}        = 0;	# Stored to the DB.
175
    $self->{'LOCKED'}        = 0;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
176

Leigh B. Stoller's avatar
Leigh B. Stoller committed
177 178 179 180
    #
    # For now, all tickets expire very quickly ...
    #
    $self->{'redeem_before'} =
181
	POSIX::strftime("20%y-%m-%dT%H:%M:%S", localtime(time() + (5*60)));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
182

Leigh B. Stoller's avatar
Leigh B. Stoller committed
183 184 185 186 187 188 189 190
    #
    # Locally generated tickets need a local DB index, which can be the
    # same as the sequence number. A ticket from a remote component will
    # have it own seqno, and so we will generate a locally valid idx for
    # those when when(if) we store them in the DB.
    #
    $self->{'idx'}           = $seqno;
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
191 192 193 194 195 196
    bless($self, $class);

    return $self;
}
# accessors
sub field($$)           { return ($_[0]->{$_[1]}); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
197
sub idx($)		{ return field($_[0], "idx"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
198
sub seqno($)		{ return field($_[0], "seqno"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
199
sub rspec($)		{ return field($_[0], "rspec"); }
200
sub target_uuid($)	{ return field($_[0], "target_uuid"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
201
sub owner_uuid($)	{ return field($_[0], "owner_uuid"); }
202
sub target_hrn($)	{ return field($_[0], "target_hrn"); }
203
sub owner_hrn($)	{ return field($_[0], "owner_hrn"); }
204 205
sub target_urn($)	{ return field($_[0], "target_urn"); }
sub owner_urn($)	{ return field($_[0], "owner_urn"); }
206
sub target_cert($)	{ return field($_[0], "target_cert"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
207
sub owner_cert($)	{ return field($_[0], "owner_cert"); }
208
sub uuid($)		{ return field($_[0], "ticket_uuid"); }
209
sub ticket_uuid($)	{ return field($_[0], "ticket_uuid"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
210
sub ticket($)		{ return field($_[0], "ticket"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
211
sub asString($)		{ return field($_[0], "ticket_string"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
212
sub ticket_string($)	{ return field($_[0], "ticket_string"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
213
sub redeem_before($)	{ return field($_[0], "redeem_before"); }
214
sub expires($)	        { return field($_[0], "expires"); }
215
sub redeemed($   )	{ return field($_[0], "redeemed"); }
216
sub component_uuid($)	{ return field($_[0], "component_uuid"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
217
sub component($)	{ return field($_[0], "component"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
218
sub stored($)		{ return field($_[0], "stored"); }
219 220 221 222
sub slice($)            { return $_[0]->{'slice'}; }
sub slice_uuid($)	{ return $_[0]->slice()->uuid(); }
sub slice_hrn($)	{ return $_[0]->slice()->hrn(); }
sub slice_urn($)	{ return $_[0]->slice()->urn(); }
223
sub LOCKED($)           { return $_[0]->{'LOCKED'}; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
224

225 226 227 228 229 230 231 232 233

# Return the URN.
sub urn($)
{
    my ($self) = @_;

    return GeniHRN::Generate("@OURDOMAIN@", "ticket", $self->idx());
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
234 235 236 237 238 239 240 241 242 243 244 245
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $idx = $self->idx();
    if (!defined($idx)) {
	my $seqno = $self->seqno();
	$idx = "S$seqno";
    }
246
    my $owner_hrn   = $self->owner_hrn();
247
    my $target_urn  = $self->target_urn();
248
    
249
    return "[GeniTicket: $idx, owner:$owner_hrn, target:$target_urn]";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
250
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
251

Leigh B. Stoller's avatar
Leigh B. Stoller committed
252 253 254 255 256 257 258 259 260 261
#
# Flush from our little cache, as for the expire daemon.
#
sub Flush($)
{
    my ($self) = @_;

    delete($tickets{$self->idx()});
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
262 263 264
#
# Create a ticket object from a signed ticket string.
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
265
sub CreateFromSignedTicket($$;$$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
266
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
267
    my ($class, $ticket_string, $component, $nosig) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
268

Leigh B. Stoller's avatar
Leigh B. Stoller committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
    #
    # This flag is used to avoid verifying the signature since I do not
    # really care if the component gives me a bad ticket; I am not using
    # it locally, just passing it back to the component at some point.
    #
    $nosig = 0
	if (!defined($nosig));

    if (! $nosig) {
	my ($fh, $filename) = tempfile(UNLINK => 0);
	return undef
	    if (!defined($fh));
	print $fh $ticket_string;
	close($fh);
	system("$VERIFYCRED $filename");
	if ($?) {
	    print STDERR "Ticket in $filename did not verify\n";
	    return undef;
	}
	unlink($filename);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
289 290
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
291 292
    # Use XML::Simple to convert to something we can mess with.
    my $parser = XML::LibXML->new;
293 294 295 296 297 298 299 300
    my $doc;
    eval {
	$doc = $parser->parse_string($ticket_string);
    };
    if ($@) {
	print STDERR "Failed to parse ticket string: $@\n";
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
301 302

    # Dig out the rspec.
303 304 305
    my $rspec = GeniXML::FindFirst("//*[local-name()='rspec']",
				   $doc->documentElement());
    if (!defined($rspec)) {
306 307 308 309
	print STDERR "Ticket is missing rspec node\n";
	return undef;
    }
    
310 311
    # Dig out the ticket uuid.
    my ($uuid_node) = $doc->getElementsByTagName("uuid");
312 313 314 315
    if (!defined($uuid_node)) {
	print STDERR "Ticket is missing uuid node\n";
	return undef;
    }
316
    my $ticket_uuid = $uuid_node->to_literal();
317 318 319 320 321 322

    if (! ($ticket_uuid =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	print STDERR "Invalid uuid in ticket\n";
	return undef;
    }

323 324
    # Dig out the target certificate.
    my ($cert_node) = $doc->getElementsByTagName("target_gid");
325 326 327 328
    if (!defined($cert_node)) {
	print STDERR "Ticket is missing target gid node\n";
	return undef;
    }
329 330
    my $target_certificate =
	GeniCertificate->LoadFromString($cert_node->to_literal());
331 332 333 334
    if (!defined($target_certificate)) {
	print STDERR "Could not get target certificate from string\n";
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
335

336 337 338 339
    if (!($target_certificate->uuid() =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	print STDERR "Invalid target_uuid in credential\n";
	return undef;
    }
340 341 342
    if (!($target_certificate->hrn() =~ /^[-\w\.]+$/)) {
	my $hrn = $target_certificate->hrn();
	print STDERR "Invalid hrn $hrn in target of ticket\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
343 344 345
	return undef;
    }

346 347
    # Dig out the owner certificate.
    ($cert_node) = $doc->getElementsByTagName("owner_gid");
348 349 350 351
    if (!defined($cert_node)) {
	print STDERR "Ticket is missing owner gid node\n";
	return undef;
    }
352 353
    my $owner_certificate =
	GeniCertificate->LoadFromString($cert_node->to_literal());
354 355 356 357
    if (!defined($target_certificate)) {
	print STDERR "Could not get owner certificate from string\n";
	return undef;
    }
358 359 360 361
    if (!($owner_certificate->uuid() =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	print STDERR "Invalid target_uuid in credential\n";
	return undef;
    }
362 363 364
    if (!($owner_certificate->hrn() =~ /^[-\w\.]+$/)) {
	my $hrn = $owner_certificate->hrn();
	print STDERR "Invalid hrn $hrn in owner of ticket\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
365 366 367
	return undef;
    }

368
    # Sequence number
Leigh B. Stoller's avatar
Leigh B. Stoller committed
369
    my ($seqno_node) = $doc->getElementsByTagName("serial");
370 371 372 373
    if (!defined($seqno_node)) {
	print STDERR "Ticket is missing seqno node\n";
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
374
    my $seqno = $seqno_node->to_literal();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
375

Leigh B. Stoller's avatar
Leigh B. Stoller committed
376 377 378
    if (! ($seqno =~ /^\w+$/)) {
	print STDERR "Invalid sequence number in ticket\n";
	return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
379 380
    }

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
    # Expiration
    my ($expires_node) = $doc->getElementsByTagName("expires");
    if (!defined($expires_node)) {
	print STDERR "Ticket is missing expires node\n";
	return undef;
    }
    my $expires = $expires_node->to_literal();

    if (! ($expires =~ /^[-\w:.\/]+/)) {
	print STDERR "Invalid expires date in ticket\n";
	return undef;
    }
    # Convert to a localtime.
    my $when = timegm(strptime($expires));
    if (!defined($when)) {
	print STDERR "Could not parse expires: '$expires'\n";
	return undef;
    }
    
Leigh B. Stoller's avatar
Leigh B. Stoller committed
400
    my $self = {};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
401
    $self->{'idx'}           = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
402
    $self->{'rspec'}         = $rspec;
403
    $self->{'ticket_uuid'}   = $ticket_uuid;
404
    $self->{'target_uuid'}   = $target_certificate->uuid();
405
    $self->{'owner_uuid'}    = $owner_certificate->uuid();
406
    $self->{'target_hrn'}    = $target_certificate->hrn();
407
    $self->{'owner_hrn'}     = $owner_certificate->hrn();
408 409
    $self->{'target_urn'}    = $target_certificate->urn();
    $self->{'owner_urn'}     = $owner_certificate->urn();
410
    $self->{'target_cert'}   = $target_certificate;
411
    $self->{'owner_cert'}    = $owner_certificate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
412 413
    $self->{'ticket_string'} = $ticket_string;
    $self->{'xmlref'}        = $doc;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
414
    $self->{'component'}     = $component;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
415
    $self->{'seqno'}         = $seqno;
416
    $self->{'expires'}       = $expires;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
417
    $self->{'stored'}        = 0;
418
    $self->{'slice'}         = undef;
419
    $self->{'LOCKED'}        = 0;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
420 421
    
    #
422 423
    # We save copies of the tickets we hand out, but delete them
    # when redeemed. If we still have it, mark it.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
424
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
425 426 427 428 429 430 431 432
    my $query_result =
	DBQueryWarn("select * from geni_tickets where idx='$seqno'");

    if ($query_result && $query_result->numrows) {
	my $row = $query_result->fetchrow_hashref();
	$self->{'redeem_before'} = $row->{'redeem_before'};
	$self->{'idx'}    = $seqno;
	$self->{'stored'} = 1;
433 434 435 436 437 438 439 440 441 442 443 444 445 446
	#
	# Older tickets might not have the slice set. The CM will
	# set it later though.
	#
	if (defined($row->{'slice_uuid'})) {
	    my $slice_uuid = $row->{'slice_uuid'};
	    my $slice = GeniSlice->Lookup($slice_uuid);
	    if (!defined($slice)) {
		print STDERR
		    "Could not locate slice for ticket from $slice_uuid\n";
		return undef;
	    }
	    $self->{'slice'} = $slice;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
447
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
448 449 450
    bless($self, $class);
    return $self;
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
451

Leigh B. Stoller's avatar
Leigh B. Stoller committed
452
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
453 454
# Might have to delete this from the DB, as with an error handing out
# a ticket.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
455
#
456
sub Delete($$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
457
{
458
    my ($self, $flag) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
459 460 461 462

    return -1
	if (! ref($self));

Leigh B. Stoller's avatar
Leigh B. Stoller committed
463
    if ($self->stored()) {
464 465
	my $idx  = $self->idx();
	my $uuid = $self->ticket_uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
466 467 468
	
	DBQueryWarn("delete from geni_tickets where idx='$idx'")
	    or return -1;
469

470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
	if ($flag == TICKET_PURGED) {
	    GeniUsage->DeleteTicket($self) == 0 
		or print STDERR "GeniTicket::Delete: ".
		    "GeniUsage->DeleteTicket($self) failed\n";
	}
	elsif ($flag == TICKET_RELEASED) {
	    GeniUsage->ReleaseTicket($self) == 0 
		or print STDERR "GeniTicket::Delete: ".
		    "GeniUsage->ReleaseTicket($self) failed\n";
	}
	elsif ($flag == TICKET_EXPIRED) {
	    GeniUsage->ExpireTicket($self) == 0 
		or print STDERR "GeniTicket::Delete: ".
		    "GeniUsage->ExpireTicket($self) failed\n";
	}
485 486 487 488 489 490 491 492 493
	elsif ($flag == TICKET_REDEEMED) {
	    GeniUsage->RedeemTicket($self) == 0 
		or print STDERR "GeniTicket::Delete: ".
		"GeniUsage->RedeemTicket($self) failed\n";
	}
	elsif ($flag == TICKET_DELETED) {
	    # Do nothing for this. Just removing from the tickets table,
	    # but want to leave it in the history.
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
494
	delete($tickets{"$idx"});
Leigh B. Stoller's avatar
Leigh B. Stoller committed
495 496 497 498
    }
    return 0;
}

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
#
# We lock at a very coarse grain, mostly in the CM. 
#
sub Lock($)
{
    my ($self) = @_;
    my $idx    = $self->idx();

    # We already have it locked.
    return 0
	if ($self->LOCKED());

    # Not in the DB, so does not matter.
    return 0
	if (!$self->stored());

    DBQueryWarn("lock tables geni_tickets write")
	or return -1;

    my $query_result =
	DBQueryWarn("select locked from geni_tickets ".
		    "where idx='$idx' and locked is null");
    if (!$query_result || !$query_result->numrows) {
	DBQueryWarn("unlock tables");
	return 1;
    }
    $query_result =
	DBQueryWarn("update geni_tickets set locked=now() where idx='$idx'");
    DBQueryWarn("unlock tables");

    return 1
	if (!$query_result);
    $self->{'LOCKED'} = $$;
    return 0;
}
sub UnLock($)
{
    my ($self) = @_;
    my $idx    = $self->idx();

    return 1
	if (!$self->LOCKED());

    DBQueryWarn("update geni_tickets set locked=NULL where idx='$idx'")
	or return -1;
    
    $self->{'LOCKED'} = 0;
    return 0;
}

549 550
sub SetSlice($$)
{
551
    my ($self, $slice) = @_;
552
    
553
    $self->{'slice'} = $slice;
554 555 556
    return 0;
}

557 558 559
#
# Return the outstanding ticket for a slice.
#
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
sub SliceTicket($$)
{
    my ($class, $slice) = @_;

    my $slice_uuid = $slice->uuid();

    my $query_result =
	DBQueryWarn("select idx from geni_tickets ".
		    "where slice_uuid='$slice_uuid'");
    return undef
	if (!$query_result);
    return undef
	if ($query_result->numrows != 1);

    my ($idx) = $query_result->fetchrow_array();
    return GeniTicket->Lookup($idx);
}

578 579 580 581 582 583 584 585 586 587 588 589
#
# Return the rspec in XML for the ticket.
#
sub rspecXML($)
{
    my ($self) = @_;

    return undef
	if (! ref($self));
    return undef
	if (!defined($self->rspec()));

590
    return GeniXML::Serialize($self->rspec());
591 592
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
593 594 595 596 597 598 599 600
#
# Populate the ticket with some stuff, which right now is just the
# number of node we are willing to grant.
#
sub Grant($$)
{
    my ($self, $count) = @_;

Leigh B. Stoller's avatar
Leigh B. Stoller committed
601
    return -1
Leigh B. Stoller's avatar
Leigh B. Stoller committed
602 603 604 605 606 607
	if (! ref($self));

    $self->{'count'} = $count;
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
608
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
609 610 611
# Store the given ticket in the DB. We only do this for signed tickets,
# so we have a record of them. We store them on the server and the client
# side.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
612
#
613
sub Store($;$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
614
{
615
    my ($self, $flags) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
616 617
    my @insert_data  = ();

618 619 620
    $flags = 0
	if (!defined($flags));

621 622 623 624 625
    my $idx         = $self->idx();
    my $seqno       = $self->seqno();
    my $target_uuid = $self->target_uuid();
    my $owner_uuid  = $self->owner_uuid();
    my $ticket_uuid = $self->ticket_uuid();
626 627
    my $expires     = $self->redeem_before() || $self->expires();
    my $slice_uuid  = $self->slice_uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
628

Leigh B. Stoller's avatar
Leigh B. Stoller committed
629 630 631 632 633
    #
    # For a locally created/signed ticket, seqno=idx. For a ticket from
    # another component, we have to generate a locally unique idx for
    # the DB insertion.
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
634 635 636 637
    if (!defined($idx)) {
	$idx = TBGetUniqueIndex('next_ticket', 1);
	$self->{'idx'} = $idx;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
638
    # A locally generated ticket will not have a component. Might change that.
639
    push(@insert_data, "component_uuid='" . $self->component()->uuid() . "'")
Leigh B. Stoller's avatar
Leigh B. Stoller committed
640 641
	if (defined($self->component()));

Leigh B. Stoller's avatar
Leigh B. Stoller committed
642 643 644
    # Now tack on other stuff we need.
    push(@insert_data, "created=now()");
    push(@insert_data, "idx='$idx'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
645
    push(@insert_data, "seqno='$seqno'");
646
    push(@insert_data, "ticket_uuid='$ticket_uuid'");
647
    push(@insert_data, "target_uuid='$target_uuid'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
648
    push(@insert_data, "owner_uuid='$owner_uuid'");
649
    push(@insert_data, "slice_uuid='$slice_uuid'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
650
    push(@insert_data, "redeem_before='$expires'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
651 652 653 654 655 656 657 658
    
    my $safe_ticket = DBQuoteSpecial($self->ticket_string());
    push(@insert_data, "ticket_string=$safe_ticket");

    # Insert into DB.
    DBQueryWarn("insert into geni_tickets set " . join(",", @insert_data))
	or return -1;

659 660 661 662 663
    if (! ($flags & TICKET_NOSTATS)) {
	if (GeniUsage->NewTicket($self)) {
	    print STDERR
		"GeniTicket::Store: GeniUsage->NewTicket($self) failed\n";
	}
664 665
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
666 667
    $tickets{"$idx"}  = $self;
    $self->{'stored'} = 1;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
668 669 670
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
671
#
672
# When we redeem a ticket, we update the history file and delete it.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
673
#
674
sub Redeem($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
675 676 677 678 679
{
    my ($self) = @_;

    return -1
	if (!ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
680

681 682 683 684 685 686 687 688 689 690 691 692
    return $self->Delete(TICKET_REDEEMED);
}

#
# Sign the ticket before returning it.
#
sub Sign($)
{
    my ($self) = @_;

    return -1
	if (!ref($self));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
693

694
    #
695
    # Every ticket/credential gets its own uuid.
696
    #
697
    my $ticket_uuid = NewUUID();
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
    $self->{'ticket_uuid'} = GeniUtil::NewUUID();

    $self->RunSigner() == 0
	or return -1;

    return 0;
}

#
# Sign the ticket before returning it. We capture the output, which is
# in XML. 
#
sub RunSigner($$)
{
    my ($self) = @_;

    return -1
	if (!ref($self));

    my $idx         = $self->seqno();
    my $expires     = $self->redeem_before();
    my $target_cert = $self->target_cert()->cert();
    my $owner_cert  = $self->owner_cert()->cert();
    my $ticket_uuid = $self->{'ticket_uuid'};
722
    my $rspec_xml   = GeniXML::Serialize($self->rspec());
723

Leigh B. Stoller's avatar
Leigh B. Stoller committed
724 725 726 727
    # Convert to GMT.
    $expires = POSIX::strftime("20%y-%m-%dT%H:%M:%S",
			       gmtime(str2time($expires)));

Leigh B. Stoller's avatar
Leigh B. Stoller committed
728 729 730 731 732
    #
    # Create a template xml file to sign.
    #
    my $template =
	"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
733
	"<credential xml:id=\"ref1\">\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
734
	" <type>ticket</type>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
735
	" <serial>$idx</serial>\n".
736
	" <owner_gid>$owner_cert</owner_gid>\n".
737
	" <target_gid>$target_cert</target_gid>\n".
738
	" <uuid>$ticket_uuid</uuid>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
739
	" <expires>$expires</expires>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
740 741
	" <ticket>\n".
	"  <can_delegate>1</can_delegate>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
742
	"  <redeem_before>$expires</redeem_before>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
743
	"  $rspec_xml\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
744 745 746 747 748 749 750 751 752 753 754 755 756 757
	" </ticket>\n".	
        "</credential>\n";

    my ($fh, $filename) = tempfile(UNLINK => 0);
    return -1
	if (!defined($fh));

    print $fh $template;
    close($fh);

    #
    # Fire up the signer and capture the output. This is the signed ticket
    # that is returned. 
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
758
    if (! open(SIGNER, "$SIGNCRED -c $CMCERT $filename |")) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
759 760 761 762 763 764 765
	print STDERR "Could not sign $filename\n";
	return -1;
    }
    my $ticket = "";
    while (<SIGNER>) {
	$ticket .= $_;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
766 767 768 769
    if (!close(SIGNER)) {
	print STDERR "Could not sign $filename\n";
	return -1;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
770
    $self->{'ticket_string'} = $ticket;
771 772 773
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
774 775
#
# Release a ticket. Need to release the nodes ...
776
# Used by the CM.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
777
#
778
sub Release($$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
779
{
780
    my ($self, $flag) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
781

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
    return -1
	if (! ref($self));

    $self->ReleaseHolding($flag) == 0
	or return -1;

    # Older tickets do not have this, but handled in ReleaseHolding.
    return 0
	if (!defined($self->slice_uuid()) || $self->slice_uuid() eq "");

    my $experiment = Experiment->Lookup($self->slice_uuid());
    if (!defined($experiment)) {
	$self->Delete($flag);
	return 0;
    }
    my $pid     = $experiment->pid();
    my $eid     = $experiment->eid();
    my @nodeids = ();
    my @nodes   = ();

802
    foreach my $ref (GeniXML::FindNodes("n:node",
803
					$self->rspec())->get_nodelist()) {
804 805
	# Skip lan nodes; they are fake.
	next
806
	    if (GeniXML::IsLanNode($ref));
807
	
808 809
	# Skip remote nodes.
	next
810
	    if (!GeniXML::IsLocalNode($ref));
811
	
812
	my $resource_uuid = GeniXML::GetNodeId($ref);
813 814
	if (!defined($resource_uuid)) {
	    print STDERR "No resource id for node in ticket\n";
815
	    print GeniXML::Serialize($ref);
816 817
	    return -1;
	}
818 819

	# Virtual nodes not created until ticket redeemed.
820
	my $node = GeniUtil::LookupNode($resource_uuid);
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
	next
	    if (!defined($node));

	my $reservation = $node->Reservation();
	next
	    if (!defined($reservation));

	# Watch for duplicates, as in multiple vnodes on a pnode.
	next
	    if (grep {$_ eq $node->node_id()} @nodeids);

	#
	# If the node is still in the experiment and not incorporated,
	# release it. genisliver_idx is not defined until ticket redeemed.
	#
	if ($reservation->SameExperiment($experiment)) {
	    my $restable = $node->ReservedTableEntry();
	    if (defined($restable) &&
839 840
		(!defined($restable->{'genisliver_idx'}) ||
		 $restable->{'genisliver_idx'} == 0)) {
841 842 843 844 845 846
		push(@nodeids, $node->node_id());
		push(@nodes, $node);
	    }
	}
    }
    if (@nodeids) {
847 848 849 850 851
	#
	# XXX Need to determine when a node needs to be reloaded.
	#
	#system("export NORELOAD=1; $NFREE -x -q $pid $eid @nodeids");
	system("$NFREE -x -q $pid $eid @nodeids");
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
    }
    foreach my $node (@nodes) {
	$node->Refresh();
    }
    $self->Delete($flag);
    return 0;
}

#
# Retained for backwards compatability.
#
sub ReleaseHolding($$)
{
    my ($self, $flag) = @_;

867
    return -1
Leigh B. Stoller's avatar
Leigh B. Stoller committed
868 869
	if (! ref($self));

870
    my $experiment = Experiment->Lookup("GeniSlices", "reservations");
871
    if (!defined($experiment)) {
872
	return 0;
873
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
874 875 876
    my $pid     = $experiment->pid();
    my $eid     = $experiment->eid();
    my @nodeids = ();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
877
    my @nodes   = ();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
878

879
    foreach my $ref (GeniXML::FindNodes("n:node",
880
					$self->rspec())->get_nodelist()) {
881 882
	# Skip lan nodes; they are fake.
	next
883
	    if (GeniXML::IsLanNode($ref));
884
	
885 886
	# Skip remote nodes.
	next
887
	    if (!GeniXML::IsLocalNode($ref));
888
	
889
	my $resource_uuid = GeniXML::GetNodeId($ref);
890 891
	if (!defined($resource_uuid)) {
	    print STDERR "No resource id for node in ticket\n";
892
	    print GeniXML::Serialize($ref);
893 894
	    return -1;
	}
895

Leigh B. Stoller's avatar
Leigh B. Stoller committed
896 897 898 899 900
	my $node = Node->Lookup($resource_uuid);
	next
	    if (!defined($node));

	my $reservation = $node->Reservation();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
901 902
	next
	    if (!defined($reservation));
903 904 905 906

	# Watch for duplicates, as in multiple vnodes on a pnode.
	next
	    if (grep {$_ eq $node->node_id()} @nodeids);
907 908 909 910 911

	#
	# If the node is still in the reservations experiment, it
	# is by definition, not in use by a slice. 
	#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
912
	if ($reservation->SameExperiment($experiment)) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
913
	    push(@nodeids, $node->node_id());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
914
	    push(@nodes, $node);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
915 916 917
	}
    }
    if (@nodeids) {
918 919 920 921 922
	#
	# XXX Need to determine when a node needs to be reloaded.
	#
	#system("export NORELOAD=1; $NFREE -x -q $pid $eid @nodeids");
	system("$NFREE -x -q $pid $eid @nodeids");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
923
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
924 925 926
    foreach my $node (@nodes) {
	$node->Refresh();
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
927 928 929
    return 0;
}

930 931 932 933 934 935 936 937 938 939 940 941 942 943
#
# Equality test for two tickets.
#
sub SameTicket($$)
{
    my ($self, $other) = @_;

    # Must be a real reference. 
    return 0
	if (! (ref($self) && ref($other)));

    return $self->idx() == $other->idx();
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
#
# Check if ticket has expired. Use the DB directly.
#
sub Expired($)
{
    my ($self) = @_;
    my $idx    = $self->idx();

    my $query_result =
	DBQueryWarn("select idx from geni_tickets ".
		    "where idx='$idx' and ".
		    "      (UNIX_TIMESTAMP(now()) > ".
		    "       UNIX_TIMESTAMP(redeem_before))");
    
    return $query_result->numrows;
}

961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
#
# List all tickets for a user.
#
sub ListUserTickets($$$)
{
    my ($class, $user, $pref) = @_;
    my @result = ();

    my $user_uuid = $user->uuid();
    my $query_result = DBQueryWarn("select idx from geni_tickets ".
				   "where owner_uuid='$user_uuid'");
    return -1
	if (!$query_result);

    while (my ($idx) = $query_result->fetchrow_array()) {
	my $ticket = GeniTicket->Lookup($idx);
	return -1
	    if (!defined($ticket));
	push(@result, $ticket);
    }

    @$pref = @result;
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
986 987
# _Always_ make sure that this 1 is at the end of the file...
1;