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-2009 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;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
26
use English;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
27 28
use XML::Simple;
use XML::LibXML;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
29
use Data::Dumper;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
30 31 32
use Date::Parse;
use POSIX qw(strftime);
use Time::Local;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
33
use File::Temp qw(tempfile);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
34
use overload ('""' => 'Stringify');
Leigh B. Stoller's avatar
Leigh B. Stoller committed
35 36 37 38 39 40 41 42 43

# 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
44
my $VERIFYCRED	   = "$TB/sbin/verifygenicred";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
45
my $NFREE	   = "$TB/bin/nfree";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
46
my $CMCERT	   = "$TB/etc/genicm.pem";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
47

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

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

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

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

76 77 78 79 80 81 82 83
    if (GeniHRN::IsValid($token)) {
	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+$/) {
84 85 86 87 88 89 90 91 92 93 94 95 96 97
	$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
98 99 100
    return $tickets{"$idx"}
        if (exists($tickets{"$idx"}));

101
    $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
102 103 104 105 106 107 108 109 110
	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;
111 112
    if ($row->{'component_uuid'}) {
	$component = GeniComponent->Lookup($row->{'component_uuid'});
Leigh B. Stoller's avatar
Leigh B. Stoller committed
113 114 115 116 117 118 119 120
	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
121 122 123 124
    # 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'};

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

    # Cache.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
131 132 133 134
    $tickets{"$idx"} = $ticket;
    return $ticket;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
135
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
136
# Create an unsigned ticket object, to be populated and signed and returned.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
137
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
138
sub Create($$$$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
139
{
140
    my ($class, $target, $owner, $rspec) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
141

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
145
    my $self = {};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
146
    $self->{'rspec'}         = $rspec;
147
    $self->{'ticket_uuid'}   = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
148
    $self->{'owner_uuid'}    = $owner->uuid();
149
    $self->{'owner_hrn'}     = $owner->hrn();
150
    $self->{'owner_cert'}    = $owner->GetCertificate();
151 152 153
    $self->{'target_uuid'}   = $target->uuid();
    $self->{'target_hrn'}    = $target->hrn();
    $self->{'target_cert'}   = $target->GetCertificate();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
154
    $self->{'seqno'}         = $seqno;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
155 156
    $self->{'ticket_string'} = undef;
    $self->{'component'}     = undef;
157
    $self->{'slice'}         = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
158
    $self->{'stored'}        = 0;	# Stored to the DB.
159
    $self->{'LOCKED'}        = 0;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
160

Leigh B. Stoller's avatar
Leigh B. Stoller committed
161 162 163 164
    #
    # For now, all tickets expire very quickly ...
    #
    $self->{'redeem_before'} =
165
	POSIX::strftime("20%y-%m-%dT%H:%M:%S", localtime(time() + (5*60)));
Leigh B. Stoller's avatar
Leigh B. Stoller committed
166

Leigh B. Stoller's avatar
Leigh B. Stoller committed
167 168 169 170 171 172 173 174
    #
    # 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
175 176 177 178 179 180
    bless($self, $class);

    return $self;
}
# accessors
sub field($$)           { return ($_[0]->{$_[1]}); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
181
sub idx($)		{ return field($_[0], "idx"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
182
sub seqno($)		{ return field($_[0], "seqno"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
183
sub rspec($)		{ return field($_[0], "rspec"); }
184
sub target_uuid($)	{ return field($_[0], "target_uuid"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
185
sub owner_uuid($)	{ return field($_[0], "owner_uuid"); }
186
sub target_hrn($)	{ return field($_[0], "target_hrn"); }
187
sub owner_hrn($)	{ return field($_[0], "owner_hrn"); }
188
sub target_cert($)	{ return field($_[0], "target_cert"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
189
sub owner_cert($)	{ return field($_[0], "owner_cert"); }
190
sub uuid($)		{ return field($_[0], "ticket_uuid"); }
191
sub ticket_uuid($)	{ return field($_[0], "ticket_uuid"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
192
sub ticket($)		{ return field($_[0], "ticket"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
193
sub asString($)		{ return field($_[0], "ticket_string"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
194
sub ticket_string($)	{ return field($_[0], "ticket_string"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
195
sub redeem_before($)	{ return field($_[0], "redeem_before"); }
196
sub expires($)	        { return field($_[0], "expires"); }
197
sub redeemed($   )	{ return field($_[0], "redeemed"); }
198
sub component_uuid($)	{ return field($_[0], "component_uuid"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
199
sub component($)	{ return field($_[0], "component"); }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
200
sub stored($)		{ return field($_[0], "stored"); }
201 202 203 204
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(); }
205
sub LOCKED($)           { return $_[0]->{'LOCKED'}; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
206

207 208 209 210 211 212 213 214 215

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

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
216 217 218 219 220 221 222 223 224 225 226 227
#
# Stringify for output.
#
sub Stringify($)
{
    my ($self) = @_;
    
    my $idx = $self->idx();
    if (!defined($idx)) {
	my $seqno = $self->seqno();
	$idx = "S$seqno";
    }
228 229
    my $owner_hrn   = $self->owner_hrn();
    my $target_uuid = $self->target_uuid();
230
    
231
    return "[GeniTicket: $idx, owner:$owner_hrn, target_uuid:$target_uuid]";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
232
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
233

Leigh B. Stoller's avatar
Leigh B. Stoller committed
234 235 236 237 238 239 240 241 242 243
#
# 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
244 245 246
#
# Create a ticket object from a signed ticket string.
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
247
sub CreateFromSignedTicket($$;$$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
248
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
249
    my ($class, $ticket_string, $component, $nosig) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
250

Leigh B. Stoller's avatar
Leigh B. Stoller committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
    #
    # 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
271 272
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
273 274
    # Use XML::Simple to convert to something we can mess with.
    my $parser = XML::LibXML->new;
275 276 277 278 279 280 281 282
    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
283 284 285

    # Dig out the rspec.
    my ($rspec_node) = $doc->getElementsByTagName("rspec");
286 287 288 289 290
    if (!defined($rspec_node)) {
	print STDERR "Ticket is missing rspec node\n";
	return undef;
    }
    
291 292 293 294 295 296 297 298
    my $rspec =
	eval { XMLin($rspec_node->toString(), KeyAttr => [],
		     ForceArray => ["node", "link", "interface",
				    "interface_ref", "linkendpoints"]) };
    if ($@) {
	print STDERR "XMLin error on ticket rspec: $@\n";
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
299

300 301
    # Dig out the ticket uuid.
    my ($uuid_node) = $doc->getElementsByTagName("uuid");
302 303 304 305
    if (!defined($uuid_node)) {
	print STDERR "Ticket is missing uuid node\n";
	return undef;
    }
306
    my $ticket_uuid = $uuid_node->to_literal();
307 308 309 310 311 312

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

313 314
    # Dig out the target certificate.
    my ($cert_node) = $doc->getElementsByTagName("target_gid");
315 316 317 318
    if (!defined($cert_node)) {
	print STDERR "Ticket is missing target gid node\n";
	return undef;
    }
319 320
    my $target_certificate =
	GeniCertificate->LoadFromString($cert_node->to_literal());
321 322 323 324
    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
325

326 327 328 329 330 331
    if (!($target_certificate->uuid() =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	print STDERR "Invalid target_uuid in credential\n";
	return undef;
    }
    if (!($target_certificate->hrn() =~ /^[\w\.]+$/)) {
	print STDERR "Invalid hrn in credential\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
332 333 334
	return undef;
    }

335 336
    # Dig out the owner certificate.
    ($cert_node) = $doc->getElementsByTagName("owner_gid");
337 338 339 340
    if (!defined($cert_node)) {
	print STDERR "Ticket is missing owner gid node\n";
	return undef;
    }
341 342
    my $owner_certificate =
	GeniCertificate->LoadFromString($cert_node->to_literal());
343 344 345 346
    if (!defined($target_certificate)) {
	print STDERR "Could not get owner certificate from string\n";
	return undef;
    }
347 348 349 350 351 352
    if (!($owner_certificate->uuid() =~ /^\w+\-\w+\-\w+\-\w+\-\w+$/)) {
	print STDERR "Invalid target_uuid in credential\n";
	return undef;
    }
    if (!($owner_certificate->hrn() =~ /^[\w\.]+$/)) {
	print STDERR "Invalid hrn in credential\n";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
353 354 355
	return undef;
    }

356
    # Sequence number
Leigh B. Stoller's avatar
Leigh B. Stoller committed
357
    my ($seqno_node) = $doc->getElementsByTagName("serial");
358 359 360 361
    if (!defined($seqno_node)) {
	print STDERR "Ticket is missing seqno node\n";
	return undef;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
362
    my $seqno = $seqno_node->to_literal();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
363

Leigh B. Stoller's avatar
Leigh B. Stoller committed
364 365 366
    if (! ($seqno =~ /^\w+$/)) {
	print STDERR "Invalid sequence number in ticket\n";
	return undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
367 368
    }

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
    # 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
388
    my $self = {};
Leigh B. Stoller's avatar
Leigh B. Stoller committed
389
    $self->{'idx'}           = undef;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
390
    $self->{'rspec'}         = $rspec;
391
    $self->{'ticket_uuid'}   = $ticket_uuid;
392
    $self->{'target_uuid'}   = $target_certificate->uuid();
393
    $self->{'owner_uuid'}    = $owner_certificate->uuid();
394
    $self->{'target_hrn'}    = $target_certificate->hrn();
395
    $self->{'owner_hrn'}     = $owner_certificate->hrn();
396
    $self->{'target_cert'}   = $target_certificate;
397
    $self->{'owner_cert'}    = $owner_certificate;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
398 399
    $self->{'ticket_string'} = $ticket_string;
    $self->{'xmlref'}        = $doc;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
400
    $self->{'component'}     = $component;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
401
    $self->{'seqno'}         = $seqno;
402
    $self->{'expires'}       = $expires;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
403
    $self->{'stored'}        = 0;
404
    $self->{'slice'}         = undef;
405
    $self->{'LOCKED'}        = 0;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
406 407
    
    #
408 409
    # 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
410
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
411 412 413 414 415 416 417 418
    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;
419 420 421 422 423 424 425 426 427 428 429 430 431 432
	#
	# 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
433
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
434 435 436
    bless($self, $class);
    return $self;
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
437

Leigh B. Stoller's avatar
Leigh B. Stoller committed
438
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
439 440
# 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
441
#
442
sub Delete($$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
443
{
444
    my ($self, $flag) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
445 446 447 448

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
449
    if ($self->stored()) {
450 451
	my $idx  = $self->idx();
	my $uuid = $self->ticket_uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
452 453 454
	
	DBQueryWarn("delete from geni_tickets where idx='$idx'")
	    or return -1;
455

456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
	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";
	}
471 472 473 474 475 476 477 478 479
	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
480
	delete($tickets{"$idx"});
Leigh B. Stoller's avatar
Leigh B. Stoller committed
481 482 483 484
    }
    return 0;
}

485 486 487 488 489 490 491 492 493 494 495 496 497 498 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
#
# 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;
}

535 536
sub SetSlice($$)
{
537
    my ($self, $slice) = @_;
538
    
539
    $self->{'slice'} = $slice;
540 541 542
    return 0;
}

543 544 545
#
# Return the outstanding ticket for a slice.
#
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
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);
}

564 565 566 567 568 569 570 571 572 573 574 575
#
# Return the rspec in XML for the ticket.
#
sub rspecXML($)
{
    my ($self) = @_;

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

576 577 578 579 580 581 582
    my $rspec_xml =
	eval { XMLout($self->rspec(),
		      "NoAttr" => 1, RootName => "rspec") };
    if ($@) {
	print STDERR "XMLout error on rspec: $@\n";
	return undef;
    }
583 584 585
    return $rspec_xml;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
586 587 588 589 590 591 592 593
#
# 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
594
    return -1
Leigh B. Stoller's avatar
Leigh B. Stoller committed
595 596 597 598 599 600
	if (! ref($self));

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

Leigh B. Stoller's avatar
Leigh B. Stoller committed
601
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
602 603 604
# 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
605
#
606
sub Store($;$)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
607
{
608
    my ($self, $flags) = @_;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
609 610
    my @insert_data  = ();

611 612 613
    $flags = 0
	if (!defined($flags));

614 615 616 617 618
    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();
619 620
    my $expires     = $self->redeem_before() || $self->expires();
    my $slice_uuid  = $self->slice_uuid();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
621

Leigh B. Stoller's avatar
Leigh B. Stoller committed
622 623 624 625 626
    #
    # 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
627 628 629 630
    if (!defined($idx)) {
	$idx = TBGetUniqueIndex('next_ticket', 1);
	$self->{'idx'} = $idx;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
631
    # A locally generated ticket will not have a component. Might change that.
632
    push(@insert_data, "component_uuid='" . $self->component()->uuid() . "'")
Leigh B. Stoller's avatar
Leigh B. Stoller committed
633 634
	if (defined($self->component()));

Leigh B. Stoller's avatar
Leigh B. Stoller committed
635 636 637
    # 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
638
    push(@insert_data, "seqno='$seqno'");
639
    push(@insert_data, "ticket_uuid='$ticket_uuid'");
640
    push(@insert_data, "target_uuid='$target_uuid'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
641
    push(@insert_data, "owner_uuid='$owner_uuid'");
642
    push(@insert_data, "slice_uuid='$slice_uuid'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
643
    push(@insert_data, "redeem_before='$expires'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
644 645 646 647 648 649 650 651
    
    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;

652 653 654 655 656
    if (! ($flags & TICKET_NOSTATS)) {
	if (GeniUsage->NewTicket($self)) {
	    print STDERR
		"GeniTicket::Store: GeniUsage->NewTicket($self) failed\n";
	}
657 658
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
659 660
    $tickets{"$idx"}  = $self;
    $self->{'stored'} = 1;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
661 662 663
    return 0;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
664
#
665
# When we redeem a ticket, we update the history file and delete it.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
666
#
667
sub Redeem($)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
668 669 670 671 672
{
    my ($self) = @_;

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

674 675 676 677 678 679 680 681 682 683 684 685
    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
686

687
    #
688
    # Every ticket/credential gets its own uuid.
689
    #
690
    my $ticket_uuid = NewUUID();
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
    $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'};
    my $rspec_xml   = $self->rspec();

    # Allow for the rspec to be in XML already.
    if (ref($rspec_xml)) {
719 720 721 722 723 724 725
	$rspec_xml =
	    eval { XMLout($rspec_xml,
			  "NoAttr" => 1, RootName => "rspec") };
	if ($@) {
	    print STDERR "XMLout error on ticket rspec: $@\n";
	    return -1;
	}
726
    }
727

Leigh B. Stoller's avatar
Leigh B. Stoller committed
728 729 730 731
    # 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
732 733 734 735 736
    #
    # 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
737
	"<credential xml:id=\"ref1\">\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
738
	" <type>ticket</type>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
739
	" <serial>$idx</serial>\n".
740
	" <owner_gid>$owner_cert</owner_gid>\n".
741
	" <target_gid>$target_cert</target_gid>\n".
742
	" <uuid>$ticket_uuid</uuid>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
743
	" <expires>$expires</expires>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
744 745
	" <ticket>\n".
	"  <can_delegate>1</can_delegate>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
746
	"  <redeem_before>$expires</redeem_before>\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
747
	"  $rspec_xml\n".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
748 749 750 751 752 753 754 755 756 757 758 759 760 761
	" </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
762
    if (! open(SIGNER, "$SIGNCRED -c $CMCERT $filename |")) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
763 764 765 766 767 768 769
	print STDERR "Could not sign $filename\n";
	return -1;
    }
    my $ticket = "";
    while (<SIGNER>) {
	$ticket .= $_;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
770 771 772 773
    if (!close(SIGNER)) {
	print STDERR "Could not sign $filename\n";
	return -1;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
774
    $self->{'ticket_string'} = $ticket;
775 776 777
    return 0;
}

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

786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
    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   = ();

    foreach my $ref (@{$self->rspec()->{'node'}}) {
807 808 809 810 811 812
	# Skip lan nodes; they are fake.
	next
	    if (exists($ref->{'node_type'}) &&
		exists($ref->{'node_type'}->{'type_name'}) &&
		$ref->{'node_type'}->{'type_name'} eq "lan");
	
813 814 815 816 817 818 819
	# Skip remote nodes.
	my $manager_uuid  = $ref->{'component_manager_uuid'};
	next
	    if (defined($manager_uuid) &&
		!GeniHRN::Equal($manager_uuid, $ENV{'MYURN'}) &&
		$manager_uuid ne $ENV{'MYUUID'});
	
820
	my $resource_uuid = $ref->{'component_uuid'} || $ref->{'uuid'};
821 822 823 824 825
	if (!defined($resource_uuid)) {
	    print STDERR "No resource id for node in ticket\n";
	    print Dumper($ref);
	    return -1;
	}
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869

	# Virtual nodes not created until ticket redeemed.
	my $node = Node->Lookup($resource_uuid);
	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) &&
		!defined($restable->{'genisliver_idx'})) {
		push(@nodeids, $node->node_id());
		push(@nodes, $node);
	    }
	}
    }
    if (@nodeids) {
	system("export NORELOAD=1; $NFREE -x -q $pid $eid @nodeids");
    }
    foreach my $node (@nodes) {
	$node->Refresh();
    }
    $self->Delete($flag);
    return 0;
}

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

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

873
    my $experiment = Experiment->Lookup("GeniSlices", "reservations");
874 875
    if (!defined($experiment)) {
	#
876
	print STDERR "Could not find Geni reservations experiment!";
877
	return 0;
878
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
879 880 881
    my $pid     = $experiment->pid();
    my $eid     = $experiment->eid();
    my @nodeids = ();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
882
    my @nodes   = ();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
883

884
    foreach my $ref (@{$self->rspec()->{'node'}}) {
885 886 887 888 889 890
	# Skip lan nodes; they are fake.
	next
	    if (exists($ref->{'node_type'}) &&
		exists($ref->{'node_type'}->{'type_name'}) &&
		$ref->{'node_type'}->{'type_name'} eq "lan");
	
891 892 893 894 895 896 897
	# Skip remote nodes.
	my $manager_uuid  = $ref->{'component_manager_uuid'};
	next
	    if (defined($manager_uuid) &&
		!GeniHRN::Equal($manager_uuid, $ENV{'MYURN'}) &&
		$manager_uuid ne $ENV{'MYUUID'});
	
898
	my $resource_uuid = $ref->{'component_uuid'} || $ref->{'uuid'};
899 900 901 902 903
	if (!defined($resource_uuid)) {
	    print STDERR "No resource id for node in ticket\n";
	    print Dumper($ref);
	    return -1;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
904 905 906 907 908
	my $node = Node->Lookup($resource_uuid);
	next
	    if (!defined($node));

	my $reservation = $node->Reservation();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
909 910
	next
	    if (!defined($reservation));
911 912 913 914

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

	#
	# 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
920
	if ($reservation->SameExperiment($experiment)) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
921
	    push(@nodeids, $node->node_id());
Leigh B. Stoller's avatar
Leigh B. Stoller committed
922
	    push(@nodes, $node);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
923 924 925
	}
    }
    if (@nodeids) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
926
	system("export NORELOAD=1; $NFREE -x -q $pid $eid @nodeids");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
927
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
928 929 930
    foreach my $node (@nodes) {
	$node->Refresh();
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
931 932 933
    return 0;
}

934 935 936 937 938 939 940 941 942 943 944 945 946 947
#
# 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
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
#
# 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;
}

965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
#
# 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
990 991
# _Always_ make sure that this 1 is at the end of the file...
1;