3 # sfi -- slice-based facility interface
9 from types import StringTypes, ListType
10 from optparse import OptionParser
12 from sfa.trust.certificate import Keypair, Certificate
13 from sfa.trust.credential import Credential
14 from sfa.util.geniclient import GeniClient
15 from sfa.util.record import *
16 from sfa.util.rspec import Rspec
17 from sfa.util.xmlrpcprotocol import ServerException
18 import sfa.util.xmlrpcprotocol as xmlrpcprotocol
19 import sfa.util.soapprotocol as soapprotocol
20 from sfa.util.config import Config
31 # Establish Connection to SliceMgr and Registry Servers
33 def set_servers(self):
34 config_file = self.options.sfi_dir + os.sep + "sfi_config"
36 config = Config (config_file)
38 print "Failed to read configuration file",config_file
39 print "Make sure to remove the export clauses and to add quotes"
40 if not self.options.verbose:
41 print "Re-run with -v for more details"
48 if (self.options.sm is not None):
49 sm_url = self.options.sm
50 elif hasattr(config,"SFI_SM"):
51 sm_url = config.SFI_SM
53 print "You need to set e.g. SFI_SM='http://your.slicemanager.url:12347/' in %s"%config_file
57 if (self.options.registry is not None):
58 reg_url = self.options.registry
59 elif hasattr(config,"SFI_REGISTRY"):
60 reg_url = config.SFI_REGISTRY
62 print "You need to set e.g. SFI_REGISTRY='http://your.registry.url:12345/' in %s"%config_file
66 if (self.options.user is not None):
67 self.user = self.options.user
68 elif hasattr(config,"SFI_USER"):
69 self.user = config.SFI_USER
71 print "You need to set e.g. SFI_USER='plc.princeton.username' in %s"%config_file
75 if (self.options.auth is not None):
76 self.authority = self.options.auth
77 elif hasattr(config,"SFI_AUTH"):
78 self.authority = config.SFI_AUTH
80 print "You need to set e.g. SFI_AUTH='plc.princeton' in %s"%config_file
86 if self.options.verbose :
87 print "Contacting Slice Manager at:", sm_url
88 print "Contacting Registry at:", reg_url
90 # Get key and certificate
91 key_file = self.get_key_file()
92 cert_file = self.get_cert_file(key_file)
93 self.key = Keypair(filename=key_file)
94 self.key_file = key_file
95 self.cert_file = cert_file
96 self.cert = Certificate(filename=cert_file)
97 # Establish connection to server(s)
98 #self.slicemgr = GeniClient(sm_url, key_file, cert_file, self.options.protocol)
99 #self.registry = GeniClient(reg_url, key_file, cert_file, self.options.protocol)
100 self.registry = xmlrpcprotocol.get_server(reg_url, key_file, cert_file)
101 self.slicemgr = xmlrpcprotocol.get_server(sm_url, key_file, cert_file)
105 # Get various credential and spec files
107 # Establishes limiting conventions
108 # - conflates MAs and SAs
109 # - assumes last token in slice name is unique
111 # Bootstraps credentials
112 # - bootstrap user credential from self-signed certificate
113 # - bootstrap authority credential from user credential
114 # - bootstrap slice credential from user credential
117 def get_leaf(self,name):
118 parts = name.split(".")
121 def get_key_file(self):
122 file = os.path.join(self.options.sfi_dir, self.get_leaf(self.user) + ".pkey")
123 if (os.path.isfile(file)):
126 print "Key file", file, "does not exist"
130 def get_cert_file(self,key_file):
132 file = os.path.join(self.options.sfi_dir, self.get_leaf(self.user) + ".cert")
133 if (os.path.isfile(file)):
136 k = Keypair(filename = key_file)
137 cert = Certificate(subject=self.user)
139 cert.set_issuer(k, self.user)
141 if self.options.verbose :
142 print "Writing self-signed certificate to", file
143 cert.save_to_file(file)
147 file = os.path.join(self.options.sfi_dir, self.get_leaf(self.user) + ".gid")
148 if (os.path.isfile(file)):
149 gid = GID(filename=file)
152 cert_str = self.cert.save_to_string(save_parents=True)
153 request_hash = self.key.compute_hash([cert_str, self.user, "user"])
154 gid_str = self.registry.get_gid(cert_str, self.user, "user", request_hash)
155 gid = GID(string=gid_str)
156 if self.options.verbose:
157 print "Writing user gid to", file
158 gid.save_to_file(file, save_parents=True)
161 def get_user_cred(self):
162 file = os.path.join(self.options.sfi_dir, self.get_leaf(self.user) + ".cred")
163 if (os.path.isfile(file)):
164 user_cred = Credential(filename=file)
167 # bootstrap user credential
168 request_hash = self.key.compute_hash([None, "user", self.user])
169 user_cred = self.registry.get_credential(None, "user", self.user, request_hash)
171 cred = Credential(string=user_cred)
172 cred.save_to_file(file, save_parents=True)
173 if self.options.verbose:
174 print "Writing user credential to", file
177 print "Failed to get user credential"
180 def get_auth_cred(self):
182 if not self.authority:
183 print "no authority specified. Use -a or set SF_AUTH"
186 file = os.path.join(self.options.sfi_dir, self.get_leaf("authority") +".cred")
187 if (os.path.isfile(file)):
188 auth_cred = Credential(filename=file)
191 # bootstrap authority credential from user credential
192 user_cred = self.get_user_cred().save_to_string(save_parents=True)
193 request_hash = self.key.compute_hash([user_cred, "authority", self.authority])
194 auth_cred = self.registry.get_credential(user_cred, "authority", self.authority, request_hash)
196 cred = Credential(string=auth_cred)
197 cred.save_to_file(file, save_parents=True)
198 if self.options.verbose:
199 print "Writing authority credential to", file
202 print "Failed to get authority credential"
205 def get_slice_cred(self,name):
206 file = os.path.join(self.options.sfi_dir, "slice_" + self.get_leaf(name) + ".cred")
207 if (os.path.isfile(file)):
208 slice_cred = Credential(filename=file)
211 # bootstrap slice credential from user credential
212 user_cred = self.get_user_cred()
213 slice_cred = self.registry.get_credential(user_cred, "slice", name)
215 slice_cred.save_to_file(file, save_parents=True)
216 if self.options.verbose:
217 print "Writing slice credential to", file
220 print "Failed to get slice credential"
223 def delegate_cred(self,cred, hrn, type = 'authority'):
224 # the gid and hrn of the object we are delegating
225 object_gid = cred.get_gid_object()
226 object_hrn = object_gid.get_hrn()
227 cred.set_delegate(True)
228 if not cred.get_delegate():
229 raise Exception, "Error: Object credential %(object_hrn)s does not have delegate bit set" % locals()
232 records = self.registry.resolve(cred, hrn)
233 records = self.filter_records(type, records)
236 raise Exception, "Error: Didn't find a %(type)s record for %(hrn)s" % locals()
238 # the gid of the user who will be delegated too
239 delegee_gid = records[0].get_gid_object()
240 delegee_hrn = delegee_gid.get_hrn()
242 # the key and hrn of the user who will be delegating
243 user_key = Keypair(filename = self.get_key_file())
244 user_hrn = cred.get_gid_caller().get_hrn()
246 dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
247 dcred.set_gid_caller(delegee_gid)
248 dcred.set_gid_object(object_gid)
249 dcred.set_privileges(cred.get_privileges())
250 dcred.set_delegate(True)
251 dcred.set_pubkey(object_gid.get_pubkey())
252 dcred.set_issuer(user_key, user_hrn)
253 dcred.set_parent(cred)
259 def get_rspec_file(self,rspec):
260 if (os.path.isabs(rspec)):
263 file = os.path.join(self.options.sfi_dir, rspec)
264 if (os.path.isfile(file)):
267 print "No such rspec file", rspec
270 def get_record_file(self,record):
271 if (os.path.isabs(record)):
274 file = os.path.join(self.options.sfi_dir, record)
275 if (os.path.isfile(file)):
278 print "No such registry record file", record
281 def load_publickey_string(self,fn):
283 key_string = f.read()
285 # if the filename is a private key file, then extract the public key
286 if "PRIVATE KEY" in key_string:
287 outfn = tempfile.mktemp()
288 cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
291 key_string = f.read()
296 # Generate sub-command parser
298 def create_cmd_parser(self,command, additional_cmdargs = None):
299 cmdargs = {"gid": "",
305 "aggregates": "[name]",
306 "registries": "[name]",
308 "resources": "[name]",
309 "create": "name rspec",
317 if additional_cmdargs:
318 cmdargs.update(additional_cmdargs)
320 if command not in cmdargs:
321 print "Invalid command\n"
323 for key in cmdargs.keys():
328 parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
329 % (command, cmdargs[command]))
331 if command in ("resources"):
332 parser.add_option("-f", "--format", dest="format",type="choice",
333 help="display format ([xml]|dns|ip)",default="xml",
334 choices=("xml","dns","ip"))
335 parser.add_option("-a", "--aggregate", dest="aggregate",
336 default=None, help="aggregate hrn")
338 if command in ("create"):
339 parser.add_option("-a", "--aggregate", dest="aggregate",default=None,
340 help="aggregate hrn")
342 if command in ("list", "show", "remove"):
343 parser.add_option("-t", "--type", dest="type",type="choice",
344 help="type filter ([all]|user|slice|sa|ma|node|aggregate)",
345 choices=("all","user","slice","sa","ma","node","aggregate"),
348 if command in ("resources", "show", "list"):
349 parser.add_option("-o", "--output", dest="file",
350 help="output XML to file", metavar="FILE", default=None)
352 if command in ("show", "list"):
353 parser.add_option("-f", "--format", dest="format", type="choice",
354 help="display format ([text]|xml)",default="text",
355 choices=("text","xml"))
357 if command in ("delegate"):
358 parser.add_option("-u", "--user",
359 action="store_true", dest="delegate_user", default=False,
360 help="delegate user credential")
361 parser.add_option("-s", "--slice", dest="delegate_slice",
362 help="delegate slice credential", metavar="HRN", default=None)
365 def create_parser(self):
367 # Generate command line parser
368 parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
369 description="Commands: gid,list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
370 parser.add_option("-r", "--registry", dest="registry",
371 help="root registry", metavar="URL", default=None)
372 parser.add_option("-s", "--slicemgr", dest="sm",
373 help="slice manager", metavar="URL", default=None)
374 default_sfi_dir=os.path.expanduser("~/.sfi/")
375 parser.add_option("-d", "--dir", dest="sfi_dir",
376 help="config & working directory - default is " + default_sfi_dir,
377 metavar="PATH", default = default_sfi_dir)
378 parser.add_option("-u", "--user", dest="user",
379 help="user name", metavar="HRN", default=None)
380 parser.add_option("-a", "--auth", dest="auth",
381 help="authority name", metavar="HRN", default=None)
382 parser.add_option("-v", "--verbose",
383 action="store_true", dest="verbose", default=False,
385 parser.add_option("-p", "--protocol",
386 dest="protocol", default="xmlrpc",
387 help="RPC protocol (xmlrpc or soap)")
388 parser.disable_interspersed_args()
392 def dispatch(self,command, cmd_opts, cmd_args):
393 getattr(self,command)(cmd_opts, cmd_args)
396 # Following functions implement the commands
398 # Registry-related commands
401 def gid(self, opts, args):
403 print "GID: %s" % (gid.save_to_string(save_parents=True))
406 # list entires in named authority registry
407 def list(self,opts, args):
408 user_cred = self.get_user_cred().save_to_string(save_parents=True)
410 request_hash = self.key.compute_hash([user_cred, hrn])
412 list = self.registry.list(user_cred, hrn, request_hash)
414 raise Exception, "Not enough parameters for the 'list' command"
416 # filter on person, slice, site, node, etc.
417 # THis really should be in the self.filter_records funct def comment...
418 list = self.filter_records(opts.type, list)
420 print "%s (%s)" % (record['hrn'], record['type'])
422 self.save_records_to_file(opts.file, list)
425 # show named registry record
426 def show(self,opts, args):
427 user_cred = self.get_user_cred().save_to_string(save_parents=True)
429 request_hash = self.key.compute_hash([user_cred, hrn])
430 records = self.registry.resolve(user_cred, hrn, request_hash)
431 records = self.filter_records(opts.type, records)
433 print "No record of type", opts.type
434 for record in records:
435 if record['type'] in ['user']:
436 record = UserRecord(dict = record)
437 elif record['type'] in ['slice']:
438 record = SliceRecord(dict = record)
439 elif record['type'] in ['node']:
440 record = NodeRecord(dict = record)
441 elif record['type'] in ['authority', 'ma', 'sa']:
442 record = AuthorityRecord(dict = record)
444 record = GeniRecord(dict = record)
445 if (opts.format=="text"):
448 print record.save_to_string()
451 self.save_records_to_file(opts.file, records)
454 def delegate(self,opts, args):
455 user_cred = self.get_user_cred()
456 if opts.delegate_user:
457 object_cred = user_cred
458 elif opts.delegate_slice:
459 object_cred = self.get_slice_cred(opts.delegate_slice)
461 print "Must specify either --user or --slice <hrn>"
464 # the gid and hrn of the object we are delegating
465 object_gid = object_cred.get_gid_object()
466 object_hrn = object_gid.get_hrn()
468 if not object_cred.get_delegate():
469 print "Error: Object credential", object_hrn, "does not have delegate bit set"
472 records = self.registry.resolve(user_cred, args[0])
473 records = self.filter_records("user", records)
476 print "Error: Didn't find a user record for", args[0]
479 # the gid of the user who will be delegated too
480 delegee_gid = records[0].get_gid_object()
481 delegee_hrn = delegee_gid.get_hrn()
483 # the key and hrn of the user who will be delegating
484 user_key = Keypair(filename = self.get_key_file())
485 user_hrn = user_cred.get_gid_caller().get_hrn()
487 dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
488 dcred.set_gid_caller(delegee_gid)
489 dcred.set_gid_object(object_gid)
490 dcred.set_privileges(object_cred.get_privileges())
491 dcred.set_delegate(True)
492 dcred.set_pubkey(object_gid.get_pubkey())
493 dcred.set_issuer(user_key, user_hrn)
494 dcred.set_parent(object_cred)
498 if opts.delegate_user:
499 dest_fn = os.path.join(self.options.sfi_dir, self.get_leaf(delegee_hrn) + "_"
500 + self.get_leaf(object_hrn) + ".cred")
501 elif opts.delegate_slice:
502 dest_fn = os.path_join(self.options.sfi_dir, self.get_leaf(delegee_hrn) + "_slice_"
503 + self.get_leaf(object_hrn) + ".cred")
505 dcred.save_to_file(dest_fn, save_parents = True)
507 print "delegated credential for", object_hrn, "to", delegee_hrn, "and wrote to", dest_fn
509 # removed named registry record
510 # - have to first retrieve the record to be removed
511 def remove(self,opts, args):
512 auth_cred = self.get_auth_cred().save_to_string(save_parents=True)
517 arg_list = [auth_cred, type, hrn]
518 request_hash = self.key.compute_hash(arg_list)
519 return self.registry.remove(auth_cred, type, hrn, request_hash)
521 # add named registry record
522 def add(self,opts, args):
523 auth_cred = self.get_auth_cred().save_to_string(save_parents=True)
524 record_filepath = args[0]
525 rec_file = self.get_record_file(record_filepath)
526 record = self.load_record_from_file(rec_file).as_dict()
527 arg_list = [auth_cred]
528 request_hash = self.key.compute_hash(arg_list)
529 return self.registry.register(auth_cred, record, request_hash)
531 # update named registry entry
532 def update(self,opts, args):
533 user_cred = self.get_user_cred()
534 rec_file = self.get_record_file(args[0])
535 record = self.load_record_from_file(rec_file)
536 if record['type'] == "user":
537 if record.get_name() == user_cred.get_gid_object().get_hrn():
538 cred = user_cred.save_to_string(save_parents=True)
540 cred = self.get_auth_cred().save_to_string(save_parents=True)
541 elif record['type'] in ["slice"]:
543 cred = self.get_slice_cred(record.get_name()).save_to_string(save_parents=True)
544 except ServerException, e:
545 # XXX smbaker -- once we have better error return codes, update this
546 # to do something better than a string compare
547 if "Permission error" in e.args[0]:
548 cred = self.get_auth_cred().save_to_string(save_parents=True)
551 elif record.get_type() in ["authority"]:
552 cred = self.get_auth_cred().save_to_string(save_parents=True)
553 elif record.get_type() == 'node':
554 cred = self.get_auth_cred().save_to_string(save_parents=True)
556 raise "unknown record type" + record.get_type()
557 record = record.as_dict()
559 request_hash = self.key.compute_hash(arg_list)
560 return self.registry.update(cred, record, request_hash)
563 def aggregates(self, opts, args):
564 user_cred = self.get_user_cred().save_to_string(save_parents=True)
568 arg_list = [user_cred, hrn]
569 request_hash = self.key.compute_hash(arg_list)
570 result = self.registry.get_aggregates(user_cred, hrn, request_hash)
571 self.display_list(result)
574 def registries(self, opts, args):
575 user_cred = self.get_user_cred().save_to_string(save_parents=True)
579 arg_list = [user_cred, hrn]
580 request_hash = self.key.compute_hash(arg_list)
581 result = self.registry.get_registries(user_cred, hrn, request_hash)
582 self.display_list(result)
586 # Slice-related commands
589 # list available nodes -- use 'resources' w/ no argument instead
591 # list instantiated slices
592 def slices(self,opts, args):
593 user_cred = self.get_user_cred().save_to_string(save_parents=True)
594 arg_list = [user_cred]
595 request_hash = self.key.compute_hash(arg_list)
596 results = self.slicemgr.get_slices(user_cred, request_hash)
597 self.display_list(results)
600 # show rspec for named slice
601 def resources(self,opts, args):
602 user_cred = self.get_user_cred().save_to_string(save_parents=True)
603 server = self.slicemgr
605 agg_hrn = opts.aggregate
606 arg_list = [user_cred, arg_hrn]
607 request_hash = self.key.compute_hash(arg_list)
608 aggregates = self.registry.get_aggregates(user_cred, agg_hrn, request_hash)
610 raise Exception, "No such aggregate %s" % agg_hrn
611 aggregate = aggregates[0]
612 url = "http://%s:%s" % (aggregate['addr'], aggregate['port'])
613 server = xmlrpcprotocol.get_server(url, self.key_file, self.cert_file)
615 cred = self.get_slice_cred(args[0]).save_to_string(save_parents=True)
621 arg_list = [cred, hrn]
622 request_hash = self.key.compute_hash(arg_list)
623 result = server.get_resources(cred, hrn, request_hash)
626 self.display_rspec(result, format)
627 if (opts.file is not None):
628 self.save_rspec_to_file(result, opts.file)
631 # created named slice with given rspec
632 def create(self,opts, args):
634 user_cred = self.get_user_cred()
635 slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True)
636 rspec_file = self.get_rspec_file(args[1])
637 rspec=open(rspec_file).read()
638 server = self.slicemgr
640 aggregates = self.registry.get_aggregates(user_cred, opts.aggregate)
642 raise Exception, "No such aggregate %s" % opts.aggregate
643 aggregate = aggregates[0]
644 url = "http://%s:%s" % (aggregate['addr'], aggregate['port'])
645 server = GeniClient(url, self.key_file, self.cert_file, self.options.protocol)
646 arg_list = [slice_cred, slice_hrn, rspec]
647 request_hash = self.key.compute_hash(arg_list)
648 return server.create_slice(slice_cred, slice_hrn, rspec, request_hash)
651 def delete(self,opts, args):
653 slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True)
654 arg_list = [slice_cred, slice_hrn]
655 request_hash = self.key.compute_hash(arg_list)
656 return self.slicemgr.delete_slice(slice_cred, slice_hrn, request_hash)
659 def start(self,opts, args):
661 slice_cred = self.get_slice_cred(args[0])
662 arg_list = [slice_cred, slice_hrn]
663 request_hash = self.key.compute_hash(arg_list)
664 return self.slicemgr.start_slice(slice_cred, slice_hrn, request_hash)
667 def stop(self,opts, args):
669 slice_cred = self.get_slice_cred(args[0]).save_to_string(save_parents=True)
670 arg_list = [slice_cred, slice_hrn]
671 request_hash = self.key.compute_hash(arg_list)
672 return self.slicemgr.stop_slice(slice_cred, slice_hrn, request_hash)
675 def reset(self,opts, args):
677 slice_cred = self.get_slice_cred(args[0]).save_to_string(save_parents=True)
678 arg_list = [slice_cred, slice_hrn]
679 request_hash = self.key.compute_hash(arg_list)
680 return self.slicemgr.reset_slice(slice_cred, slice_hrn, request_hash)
684 # Display, Save, and Filter RSpecs and Records
685 # - to be replace by EMF-generated routines
689 def display_rspec(self,rspec, format = 'rspec'):
690 if format in ['dns']:
692 spec.parseString(rspec)
694 nodespecs = spec.getDictsByTagName('NodeSpec')
695 for nodespec in nodespecs:
696 if nodespec.has_key('name') and nodespec['name']:
697 if isinstance(nodespec['name'], ListType):
698 hostnames.extend(nodespec['name'])
699 elif isinstance(nodespec['name'], StringTypes):
700 hostnames.append(nodespec['name'])
702 elif format in ['ip']:
704 spec.parseString(rspec)
706 ifspecs = spec.getDictsByTagName('IfSpec')
707 for ifspec in ifspecs:
708 if ifspec.has_key('addr') and ifspec['addr']:
709 ips.append(ifspec['addr'])
717 def display_list(self,results):
718 for result in results:
721 def save_rspec_to_file(self,rspec, filename):
722 if not filename.startswith(os.sep):
723 filename = self.options.sfi_dir + filename
724 if not filename.endswith(".rspec"):
725 filename = filename + ".rspec"
727 f = open(filename, 'w')
732 def display_records(self,recordList, dump = False):
733 ''' Print all fields in the record'''
734 for record in recordList:
735 self.display_record(record, dump)
737 def display_record(self,record, dump = False):
741 info = record.getdict()
742 print "%s (%s)" % (info['hrn'], info['type'])
745 def filter_records(self,type, records):
746 filtered_records = []
747 for record in records:
748 if (record['type'] == type) or (type == "all"):
749 filtered_records.append(record)
750 return filtered_records
752 def save_records_to_file(self,filename, recordList):
754 for record in recordList:
756 self.save_record_to_file(filename + "." + str(index), record)
758 self.save_record_to_file(filename, record)
761 def save_record_to_file(self,filename, record):
762 if record['type'] in ['user']:
763 record = UserRecord(dict = record)
764 elif record['type'] in ['slice']:
765 record = SliceRecord(dict = record)
766 elif record['type'] in ['node']:
767 record = NodeRecord(dict = record)
768 elif record['type'] in ['authority', 'ma', 'sa']:
769 record = AuthorityRecord(dict = record)
771 record = GeniRecord(dict = record)
772 if not filename.startswith(os.sep):
773 filename = self.options.sfi_dir + filename
774 str = record.save_to_string()
775 file(filename, "w").write(str)
778 def load_record_from_file(self,filename):
779 str = file(filename, "r").read()
780 record = GeniRecord(string=str)
784 # Main: parse arguments and dispatch to command
787 parser = self.create_parser()
788 (options, args) = parser.parse_args()
789 self.options = options
792 print "No command given. Use -h for help."
796 (cmd_opts, cmd_args) = self.create_cmd_parser(command).parse_args(args[1:])
797 if self.options.verbose :
798 print "Registry %s, sm %s, dir %s, user %s, auth %s" % (options.registry,
803 print "Command %s" %command
804 if command in ("resources"):
805 print "resources cmd_opts %s" %cmd_opts.format
806 elif command in ("list","show","remove"):
807 print "cmd_opts.type %s" %cmd_opts.type
808 print "cmd_args %s" %cmd_args
813 self.dispatch(command, cmd_opts, cmd_args)
816 print "Command not found:", command
821 if __name__=="__main__":