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
15 from sfa.util.geniclient import GeniClient
16 from sfa.util.record import *
17 from sfa.util.rspec import Rspec
18 from sfa.util.xmlrpcprotocol import ServerException
19 from sfa.util.config import Config
30 # Establish Connection to SliceMgr and Registry Servers
32 def set_servers(self):
33 config_file = self.options.sfi_dir + os.sep + "sfi_config"
35 config = Config (config_file)
37 print "Failed to read configuration file",config_file
38 print "Make sure to remove the export clauses and to add quotes"
39 if not self.options.verbose:
40 print "Re-run with -v for more details"
47 if (self.options.sm is not None):
48 sm_url = self.options.sm
49 elif hasattr(config,"SFI_SM"):
50 sm_url = config.SFI_SM
52 print "You need to set e.g. SFI_SM='http://your.slicemanager.url:12347/' in %s"%config_file
56 if (self.options.registry is not None):
57 reg_url = self.options.registry
58 elif hasattr(config,"SFI_REGISTRY"):
59 reg_url = config.SFI_REGISTRY
61 print "You need to set e.g. SFI_REGISTRY='http://your.registry.url:12345/' in %s"%config_file
65 if (self.options.user is not None):
66 self.user = self.options.user
67 elif hasattr(config,"SFI_USER"):
68 self.user = config.SFI_USER
70 print "You need to set e.g. SFI_USER='plc.princeton.username' in %s"%config_file
74 if (self.options.auth is not None):
75 self.authority = self.options.auth
76 elif hasattr(config,"SFI_AUTH"):
77 self.authority = config.SFI_AUTH
79 print "You need to set e.g. SFI_AUTH='plc.princeton' in %s"%config_file
85 if self.options.verbose :
86 print "Contacting Slice Manager at:", sm_url
87 print "Contacting Registry at:", reg_url
89 # Get key and certificate
90 key_file = self.get_key_file()
91 cert_file = self.get_cert_file(key_file)
93 # Establish connection to server(s)
94 self.slicemgr = GeniClient(sm_url, key_file, cert_file, self.options.protocol)
95 self.registry = GeniClient(reg_url, key_file, cert_file, self.options.protocol)
99 # Get various credential and spec files
101 # Establishes limiting conventions
102 # - conflates MAs and SAs
103 # - assumes last token in slice name is unique
105 # Bootstraps credentials
106 # - bootstrap user credential from self-signed certificate
107 # - bootstrap authority credential from user credential
108 # - bootstrap slice credential from user credential
111 def get_leaf(self,name):
112 parts = name.split(".")
115 def get_key_file(self):
116 file = os.path.join(self.options.sfi_dir, self.get_leaf(self.user) + ".pkey")
117 if (os.path.isfile(file)):
120 print "Key file", file, "does not exist"
124 def get_cert_file(self,key_file):
126 file = os.path.join(self.options.sfi_dir, self.get_leaf(self.user) + ".cert")
127 if (os.path.isfile(file)):
130 k = Keypair(filename = key_file)
131 cert = Certificate(subject=self.user)
133 cert.set_issuer(k, self.user)
135 if self.options.verbose :
136 print "Writing self-signed certificate to", file
137 cert.save_to_file(file)
140 def get_user_cred(self):
141 file = os.path.join(self.options.sfi_dir, self.get_leaf(self.user) + ".cred")
142 if (os.path.isfile(file)):
143 user_cred = Credential(filename=file)
146 # bootstrap user credential
147 user_cred = self.registry.get_credential(None, "user", self.user)
149 user_cred.save_to_file(file, save_parents=True)
150 if self.options.verbose:
151 print "Writing user credential to", file
154 print "Failed to get user credential"
157 def get_auth_cred(self):
159 if not self.authority:
160 print "no authority specified. Use -a or set SF_AUTH"
163 file = os.path.join(self.options.sfi_dir, self.get_leaf("authority") +".cred")
164 if (os.path.isfile(file)):
165 auth_cred = Credential(filename=file)
168 # bootstrap authority credential from user credential
169 user_cred = self.get_user_cred()
170 auth_cred = self.registry.get_credential(user_cred, "authority", self.authority)
172 auth_cred.save_to_file(file, save_parents=True)
173 if self.options.verbose:
174 print "Writing authority credential to", file
177 print "Failed to get authority credential"
180 def get_slice_cred(self,name):
181 file = os.path.join(self.options.sfi_dir, "slice_" + self.get_leaf(name) + ".cred")
182 if (os.path.isfile(file)):
183 slice_cred = Credential(filename=file)
186 # bootstrap slice credential from user credential
187 user_cred = self.get_user_cred()
188 slice_cred = self.registry.get_credential(user_cred, "slice", name)
190 slice_cred.save_to_file(file, save_parents=True)
191 if self.options.verbose:
192 print "Writing slice credential to", file
195 print "Failed to get slice credential"
198 def delegate_cred(self,cred, hrn, type = 'authority'):
199 # the gid and hrn of the object we are delegating
200 object_gid = cred.get_gid_object()
201 object_hrn = object_gid.get_hrn()
202 cred.set_delegate(True)
203 if not cred.get_delegate():
204 raise Exception, "Error: Object credential %(object_hrn)s does not have delegate bit set" % locals()
207 records = self.registry.resolve(cred, hrn)
208 records = self.filter_records(type, records)
211 raise Exception, "Error: Didn't find a %(type)s record for %(hrn)s" % locals()
213 # the gid of the user who will be delegated too
214 delegee_gid = records[0].get_gid_object()
215 delegee_hrn = delegee_gid.get_hrn()
217 # the key and hrn of the user who will be delegating
218 user_key = Keypair(filename = self.get_key_file())
219 user_hrn = cred.get_gid_caller().get_hrn()
221 dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
222 dcred.set_gid_caller(delegee_gid)
223 dcred.set_gid_object(object_gid)
224 dcred.set_privileges(cred.get_privileges())
225 dcred.set_delegate(True)
226 dcred.set_pubkey(object_gid.get_pubkey())
227 dcred.set_issuer(user_key, user_hrn)
228 dcred.set_parent(cred)
234 def get_rspec_file(self,rspec):
235 if (os.path.isabs(rspec)):
238 file = os.path.join(self.options.sfi_dir, rspec)
239 if (os.path.isfile(file)):
242 print "No such rspec file", rspec
245 def get_record_file(self,record):
246 if (os.path.isabs(record)):
249 file = os.path.join(self.options.sfi_dir, record)
250 if (os.path.isfile(file)):
253 print "No such registry record file", record
256 def load_publickey_string(self,fn):
258 key_string = f.read()
260 # if the filename is a private key file, then extract the public key
261 if "PRIVATE KEY" in key_string:
262 outfn = tempfile.mktemp()
263 cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
266 key_string = f.read()
271 # Generate sub-command parser
273 def create_cmd_parser(self,command, additional_cmdargs = None):
274 cmdargs = {"list": "name",
279 "aggregates": "[name]",
280 "registries": "[name]",
282 "resources": "[name]",
283 "create": "name rspec",
291 if additional_cmdargs:
292 cmdargs.update(additional_cmdargs)
294 if command not in cmdargs:
295 print "Invalid command\n"
297 for key in cmdargs.keys():
302 parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
303 % (command, cmdargs[command]))
305 if command in ("resources"):
306 parser.add_option("-f", "--format", dest="format",type="choice",
307 help="display format ([xml]|dns|ip)",default="xml",
308 choices=("xml","dns","ip"))
310 if command in ("list", "show", "remove"):
311 parser.add_option("-t", "--type", dest="type",type="choice",
312 help="type filter ([all]|user|slice|sa|ma|node|aggregate)",
313 choices=("all","user","slice","sa","ma","node","aggregate"),
316 if command in ("resources", "show", "list"):
317 parser.add_option("-o", "--output", dest="file",
318 help="output XML to file", metavar="FILE", default=None)
320 if command in ("show", "list"):
321 parser.add_option("-f", "--format", dest="format", type="choice",
322 help="display format ([text]|xml)",default="text",
323 choices=("text","xml"))
325 if command in ("delegate"):
326 parser.add_option("-u", "--user",
327 action="store_true", dest="delegate_user", default=False,
328 help="delegate user credential")
329 parser.add_option("-s", "--slice", dest="delegate_slice",
330 help="delegate slice credential", metavar="HRN", default=None)
333 def create_parser(self):
335 # Generate command line parser
336 parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
337 description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
338 parser.add_option("-r", "--registry", dest="registry",
339 help="root registry", metavar="URL", default=None)
340 parser.add_option("-s", "--slicemgr", dest="sm",
341 help="slice manager", metavar="URL", default=None)
342 default_sfi_dir=os.path.expanduser("~/.sfi/")
343 parser.add_option("-d", "--dir", dest="sfi_dir",
344 help="config & working directory - default is " + default_sfi_dir,
345 metavar="PATH", default = default_sfi_dir)
346 parser.add_option("-u", "--user", dest="user",
347 help="user name", metavar="HRN", default=None)
348 parser.add_option("-a", "--auth", dest="auth",
349 help="authority name", metavar="HRN", default=None)
350 parser.add_option("-v", "--verbose",
351 action="store_true", dest="verbose", default=False,
353 parser.add_option("-p", "--protocol",
354 dest="protocol", default="xmlrpc",
355 help="RPC protocol (xmlrpc or soap)")
356 parser.disable_interspersed_args()
360 def dispatch(self,command, cmd_opts, cmd_args):
361 getattr(self,command)(cmd_opts, cmd_args)
364 # Following functions implement the commands
366 # Registry-related commands
369 # list entires in named authority registry
370 def list(self,opts, args):
371 user_cred = self.get_user_cred()
373 list = self.registry.list(user_cred, args[0])
375 raise Exception, "Not enough parameters for the 'list' command"
377 # filter on person, slice, site, node, etc.
378 # THis really should be in the self.filter_records funct def comment...
379 list = self.filter_records(opts.type, list)
381 print "%s (%s)" % (record['hrn'], record['type'])
383 self.save_records_to_file(opts.file, list)
386 # show named registry record
387 def show(self,opts, args):
388 user_cred = self.get_user_cred()
389 records = self.registry.resolve(user_cred, args[0])
390 records = self.filter_records(opts.type, records)
392 print "No record of type", opts.type
393 for record in records:
394 if record['type'] in ['user']:
395 record = UserRecord(dict = record)
396 elif record['type'] in ['slice']:
397 record = SliceRecord(dict = record)
398 elif record['type'] in ['node']:
399 record = NodeRecord(dict = record)
400 elif record['type'] in ['authority', 'ma', 'sa']:
401 record = AuthorityRecord(dict = record)
403 record = GeniRecord(dict = record)
404 if (opts.format=="text"):
407 print record.save_to_string()
410 self.save_records_to_file(opts.file, records)
413 def delegate(self,opts, args):
414 user_cred = self.get_user_cred()
415 if opts.delegate_user:
416 object_cred = user_cred
417 elif opts.delegate_slice:
418 object_cred = self.get_slice_cred(opts.delegate_slice)
420 print "Must specify either --user or --slice <hrn>"
423 # the gid and hrn of the object we are delegating
424 object_gid = object_cred.get_gid_object()
425 object_hrn = object_gid.get_hrn()
427 if not object_cred.get_delegate():
428 print "Error: Object credential", object_hrn, "does not have delegate bit set"
431 records = self.registry.resolve(user_cred, args[0])
432 records = self.filter_records("user", records)
435 print "Error: Didn't find a user record for", args[0]
438 # the gid of the user who will be delegated too
439 delegee_gid = records[0].get_gid_object()
440 delegee_hrn = delegee_gid.get_hrn()
442 # the key and hrn of the user who will be delegating
443 user_key = Keypair(filename = self.get_key_file())
444 user_hrn = user_cred.get_gid_caller().get_hrn()
446 dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
447 dcred.set_gid_caller(delegee_gid)
448 dcred.set_gid_object(object_gid)
449 dcred.set_privileges(object_cred.get_privileges())
450 dcred.set_delegate(True)
451 dcred.set_pubkey(object_gid.get_pubkey())
452 dcred.set_issuer(user_key, user_hrn)
453 dcred.set_parent(object_cred)
457 if opts.delegate_user:
458 dest_fn = os.path.join(self.options.sfi_dir, self.get_leaf(delegee_hrn) + "_"
459 + self.get_leaf(object_hrn) + ".cred")
460 elif opts.delegate_slice:
461 dest_fn = os.path_join(self.options.sfi_dir, self.get_leaf(delegee_hrn) + "_slice_"
462 + self.get_leaf(object_hrn) + ".cred")
464 dcred.save_to_file(dest_fn, save_parents = True)
466 print "delegated credential for", object_hrn, "to", delegee_hrn, "and wrote to", dest_fn
468 # removed named registry record
469 # - have to first retrieve the record to be removed
470 def remove(self,opts, args):
471 auth_cred = self.get_auth_cred()
475 return self.registry.remove(auth_cred, type, args[0])
477 # add named registry record
478 def add(self,opts, args):
479 auth_cred = self.get_auth_cred()
480 rec_file = self.get_record_file(args[0])
481 record = self.load_record_from_file(rec_file)
483 return self.registry.register(auth_cred, record)
485 # update named registry entry
486 def update(self,opts, args):
487 user_cred = self.get_user_cred()
488 rec_file = self.get_record_file(args[0])
489 record = self.load_record_from_file(rec_file)
490 if record.get_type() == "user":
491 if record.get_name() == user_cred.get_gid_object().get_hrn():
494 cred = self.get_auth_cred()
495 elif record.get_type() in ["slice"]:
497 cred = self.get_slice_cred(record.get_name())
498 except ServerException, e:
499 # XXX smbaker -- once we have better error return codes, update this
500 # to do something better than a string compare
501 if "Permission error" in e.args[0]:
502 cred = self.get_auth_cred()
505 elif record.get_type() in ["authority"]:
506 cred = self.get_auth_cred()
507 elif record.get_type() == 'node':
508 cred = self.get_auth_cred()
510 raise "unknown record type" + record.get_type()
511 return self.registry.update(cred, record)
514 def aggregates(self, opts, args):
515 user_cred = self.get_user_cred()
520 result = self.registry.get_aggregates(user_cred, hrn)
521 self.display_list(result)
524 def registries(self, opts, args):
525 user_cred = self.get_user_cred()
530 result = self.registry.get_registries(user_cred, hrn)
531 self.display_list(result)
535 # Slice-related commands
538 # list available nodes -- use 'resources' w/ no argument instead
540 # list instantiated slices
541 def slices(self,opts, args):
542 user_cred = self.get_user_cred()
543 results = self.slicemgr.get_slices(user_cred)
544 self.display_list(results)
547 # show rspec for named slice
548 def resources(self,opts, args):
550 slice_cred = self.get_slice_cred(args[0])
551 result = self.slicemgr.get_resources(slice_cred, args[0])
553 user_cred = self.get_user_cred()
554 result = self.slicemgr.get_resources(user_cred)
556 self.display_rspec(result, format)
557 if (opts.file is not None):
558 self.save_rspec_to_file(result, opts.file)
561 # created named slice with given rspec
562 def create(self,opts, args):
564 slice_cred = self.get_slice_cred(slice_hrn)
565 rspec_file = self.get_rspec_file(args[1])
566 rspec=open(rspec_file).read()
567 return self.slicemgr.create_slice(slice_cred, slice_hrn, rspec)
570 def delete(self,opts, args):
572 slice_cred = self.get_slice_cred(slice_hrn)
574 return self.slicemgr.delete_slice(slice_cred, slice_hrn)
577 def start(self,opts, args):
579 slice_cred = self.get_slice_cred(args[0])
580 return self.slicemgr.start_slice(slice_cred, slice_hrn)
583 def stop(self,opts, args):
585 slice_cred = self.get_slice_cred(args[0])
586 return self.slicemgr.stop_slice(slice_cred, slice_hrn)
589 def reset(self,opts, args):
591 slice_cred = self.get_slice_cred(args[0])
592 return self.slicemgr.reset_slice(slice_cred, slice_hrn)
596 # Display, Save, and Filter RSpecs and Records
597 # - to be replace by EMF-generated routines
601 def display_rspec(self,rspec, format = 'rspec'):
602 if format in ['dns']:
604 spec.parseString(rspec)
606 nodespecs = spec.getDictsByTagName('NodeSpec')
607 for nodespec in nodespecs:
608 if nodespec.has_key('name') and nodespec['name']:
609 if isinstance(nodespec['name'], ListType):
610 hostnames.extend(nodespec['name'])
611 elif isinstance(nodespec['name'], StringTypes):
612 hostnames.append(nodespec['name'])
614 elif format in ['ip']:
616 spec.parseString(rspec)
618 ifspecs = spec.getDictsByTagName('IfSpec')
619 for ifspec in ifspecs:
620 if ifspec.has_key('addr') and ifspec['addr']:
621 ips.append(ifspec['addr'])
629 def display_list(self,results):
630 for result in results:
633 def save_rspec_to_file(self,rspec, filename):
634 if not filename.startswith(os.sep):
635 filename = self.options.sfi_dir + filename
636 if not filename.endswith(".rspec"):
637 filename = filename + ".rspec"
639 f = open(filename, 'w')
644 def display_records(self,recordList, dump = False):
645 ''' Print all fields in the record'''
646 for record in recordList:
647 self.display_record(record, dump)
649 def display_record(self,record, dump = False):
653 info = record.getdict()
654 print "%s (%s)" % (info['hrn'], info['type'])
657 def filter_records(self,type, records):
658 filtered_records = []
659 for record in records:
660 if (record.get_type() == type) or (type == "all"):
661 filtered_records.append(record)
662 return filtered_records
664 def save_records_to_file(self,filename, recordList):
666 for record in recordList:
668 self.save_record_to_file(filename + "." + str(index), record)
670 self.save_record_to_file(filename, record)
673 def save_record_to_file(self,filename, record):
674 if not filename.startswith(os.sep):
675 filename = self.options.sfi_dir + filename
676 str = record.save_to_string()
677 file(filename, "w").write(str)
680 def load_record_from_file(self,filename):
681 str = file(filename, "r").read()
682 record = GeniRecord(string=str)
686 # Main: parse arguments and dispatch to command
690 parser = self.create_parser()
691 (options, args) = parser.parse_args()
692 self.options = options
695 print "No command given. Use -h for help."
699 (cmd_opts, cmd_args) = self.create_cmd_parser(command).parse_args(args[1:])
700 if self.options.verbose :
701 print "Registry %s, sm %s, dir %s, user %s, auth %s" % (options.registry,
706 print "Command %s" %command
707 if command in ("resources"):
708 print "resources cmd_opts %s" %cmd_opts.format
709 elif command in ("list","show","remove"):
710 print "cmd_opts.type %s" %cmd_opts.type
711 print "cmd_args %s" %cmd_args
716 self.dispatch(command, cmd_opts, cmd_args)
719 print "Command not found:", command
724 if __name__=="__main__":