2 from __future__ import with_statement
4 # sfi -- slice-based facility interface
9 from types import StringTypes, ListType
10 from optparse import OptionParser
12 from geni.trust.certificate import Keypair, Certificate
13 from geni.trust.credential import Credential
14 from geni.trust.gid import create_uuid
16 from geni.util.geniclient import GeniClient, ServerException
17 from geni.util.record import *
18 from geni.util.rspec import Rspec
20 # xxx todo xxx auto-load ~/.sfi/sfi_config
22 sfi_dir = os.path.expanduser("~/.sfi/")
30 # Establish Connection to SliceMgr and Registry Servers
32 def set_servers(options):
39 if (options.sm is not None):
41 elif ("SFI_SM" in os.environ):
42 sm_url = os.environ["SFI_SM"]
44 print "No Known Slice Manager"
46 print " export SFI_SM=http://your.slicemanager.url:12347/"
47 print "Or add this argument to the command line:"
48 print " --slicemgr=http://your.slicemanager.url:12347/"
52 if (options.registry is not None):
53 reg_url = options.registry
54 elif ("SFI_REGISTRY" in os.environ):
55 reg_url = os.environ["SFI_REGISTRY"]
57 print "No Known Registry Server"
59 print " export SFI_REGISTRY=http://your.registry.url:12345/"
60 print "Or add this argument to the command line:"
61 print " --registry=http://your.registry.url:12345/"
65 print "Contacting Slice Manager at:", sm_url
66 print "Contacting Registry at:", reg_url
69 if (options.user is not None):
71 elif ("SFI_USER" in os.environ):
72 user = os.environ["SFI_USER"]
74 print "No Known User Name"
76 print " export SFI_USER=$SFI_AUTH.username"
77 print "Or add this argument to the command line:"
78 print " --user=username"
82 if (options.auth is not None):
83 authority = options.auth
84 elif ("SFI_AUTH" in os.environ):
85 authority = os.environ["SFI_AUTH"]
89 # Get key and certificate
90 key_file = get_key_file()
91 cert_file = get_cert_file(key_file)
93 # Establish connection to server(s)
94 slicemgr = GeniClient(sm_url, key_file, cert_file)
95 registry = GeniClient(reg_url, key_file, cert_file)
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
112 parts = name.split(".")
116 file = os.path.join(sfi_dir, get_leaf(user) + ".pkey")
117 if (os.path.isfile(file)):
120 print "Key file", file, "does not exist"
124 def get_cert_file(key_file):
127 file = os.path.join(sfi_dir, get_leaf(user) + ".cert")
128 if (os.path.isfile(file)):
131 k = Keypair(filename = key_file)
132 cert = Certificate(subject=user)
134 cert.set_issuer(k, user)
137 print "Writing self-signed certificate to", file
138 cert.save_to_file(file)
144 file = os.path.join(sfi_dir, get_leaf(user) + ".cred")
145 if (os.path.isfile(file)):
146 user_cred = Credential(filename=file)
149 # bootstrap user credential
150 user_cred = registry.get_credential(None, "user", user)
152 user_cred.save_to_file(file, save_parents=True)
154 print "Writing user credential to", file
157 print "Failed to get user credential"
164 print "no authority specified. Use -a or set SF_AUTH"
167 file = os.path.join(sfi_dir, get_leaf("authority") +".cred")
168 if (os.path.isfile(file)):
169 auth_cred = Credential(filename=file)
172 # bootstrap authority credential from user credential
173 user_cred = get_user_cred()
174 auth_cred = registry.get_credential(user_cred, "sa", authority)
176 auth_cred.save_to_file(file, save_parents=True)
178 print "Writing authority credential to", file
181 print "Failed to get authority credential"
184 def get_slice_cred(name):
185 file = os.path.join(sfi_dir, "slice_" + get_leaf(name) + ".cred")
186 if (os.path.isfile(file)):
187 slice_cred = Credential(filename=file)
190 # bootstrap slice credential from user credential
191 user_cred = get_user_cred()
192 slice_cred = registry.get_credential(user_cred, "slice", name)
194 slice_cred.save_to_file(file, save_parents=True)
196 print "Writing slice credential to", file
199 print "Failed to get slice credential"
202 def delegate_cred(cred, hrn, type = 'authority'):
203 # the gid and hrn of the object we are delegating
204 object_gid = cred.get_gid_object()
205 object_hrn = object_gid.get_hrn()
206 cred.set_delegate(True)
207 if not cred.get_delegate():
208 raise Exception, "Error: Object credential %(object_hrn)s does not have delegate bit set" % locals()
211 records = registry.resolve(cred, hrn)
212 records = filter_records(type, records)
215 raise Exception, "Error: Didn't find a %(type)s record for %(hrn)s" % locals()
217 # the gid of the user who will be delegated too
218 delegee_gid = records[0].get_gid_object()
219 delegee_hrn = delegee_gid.get_hrn()
221 # the key and hrn of the user who will be delegating
222 user_key = Keypair(filename = get_key_file())
223 user_hrn = cred.get_gid_caller().get_hrn()
225 dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
226 dcred.set_gid_caller(delegee_gid)
227 dcred.set_gid_object(object_gid)
228 dcred.set_privileges(cred.get_privileges())
229 dcred.set_delegate(True)
230 dcred.set_pubkey(object_gid.get_pubkey())
231 dcred.set_issuer(user_key, user_hrn)
232 dcred.set_parent(cred)
238 def get_rspec_file(rspec):
239 if (os.path.isabs(rspec)):
242 file = os.path.join(sfi_dir, rspec)
243 if (os.path.isfile(file)):
246 print "No such rspec file", rspec
249 def get_record_file(record):
250 if (os.path.isabs(record)):
253 file = os.path.join(sfi_dir, record)
254 if (os.path.isfile(file)):
257 print "No such registry record file", record
260 def load_publickey_string(fn):
262 key_string = f.read()
264 # if the filename is a private key file, then extract the public key
265 if "PRIVATE KEY" in key_string:
266 outfn = tempfile.mktemp()
267 cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
270 key_string = f.read()
275 # Generate sub-command parser
277 def create_cmd_parser(command, additional_cmdargs = None):
278 cmdargs = {"list": "name",
284 "resources": "[name]",
285 "create": "name rspec",
293 if additional_cmdargs:
294 cmdargs.update(additional_cmdargs)
296 if command not in cmdargs:
297 print "Invalid command\n"
299 for key in cmdargs.keys():
304 parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
305 % (command, cmdargs[command]))
306 if command in ("resources"):
307 parser.add_option("-f", "--format", dest="format",type="choice",
308 help="display format (dns|ip|rspec)",default="rspec",
309 choices=("dns","ip","rspec"))
310 if command in ("list", "show", "remove"):
311 parser.add_option("-t", "--type", dest="type",type="choice",
312 help="type filter (user|slice|sa|ma|node|aggregate)",
313 choices=("user","slice","sa","ma","node","aggregate", "all"),
315 if command in ("show", "list", "resources"):
316 parser.add_option("-o", "--output", dest="file",
317 help="output XML to file", metavar="FILE", default=None)
318 if command in ("delegate"):
319 parser.add_option("-u", "--user",
320 action="store_true", dest="delegate_user", default=False,
321 help="delegate user credential")
322 parser.add_option("-s", "--slice", dest="delegate_slice",
323 help="delegate slice credential", metavar="HRN", default=None)
327 # Generate command line parser
328 parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
329 description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
330 parser.add_option("-r", "--registry", dest="registry",
331 help="root registry", metavar="URL", default=None)
332 parser.add_option("-s", "--slicemgr", dest="sm",
333 help="slice manager", metavar="URL", default=None)
334 parser.add_option("-d", "--dir", dest="dir",
335 help="working directory", metavar="PATH", default = sfi_dir)
336 parser.add_option("-u", "--user", dest="user",
337 help="user name", metavar="HRN", default=None)
338 parser.add_option("-a", "--auth", dest="auth",
339 help="authority name", metavar="HRN", default=None)
340 parser.add_option("-v", "--verbose",
341 action="store_true", dest="verbose", default=False,
343 parser.disable_interspersed_args()
347 def dispatch(command, cmd_opts, cmd_args):
348 globals()[command](cmd_opts, cmd_args)
351 # Main: parse arguments and dispatch to command
356 parser = create_parser()
357 (options, args) = parser.parse_args()
360 print "No command given. Use -h for help."
364 (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
365 verbose = options.verbose
367 print "Resgistry %s, sm %s, dir %s, user %s, auth %s" % (options.registry,
372 print "Command %s" %command
373 if command in ("resources"):
374 print "resources cmd_opts %s" %cmd_opts.format
375 elif command in ("list","show","remove"):
376 print "cmd_opts.type %s" %cmd_opts.type
377 print "cmd_args %s" %cmd_args
382 dispatch(command, cmd_opts, cmd_args)
385 print "Command not found:", command
391 # Following functions implement the commands
393 # Registry-related commands
396 # list entires in named authority registry
397 def list(opts, args):
399 user_cred = get_user_cred()
400 list = registry.list(user_cred, args[0])
401 # filter on person, slice, site, node, etc.
402 # THis really should be in the filter_records funct def comment...
403 list = filter_records(opts.type, list)
405 print "%s (%s)" % (record['hrn'], record['type'])
407 save_records_to_file(opts.file, list)
410 # show named registry record
411 def show(opts, args):
413 user_cred = get_user_cred()
414 records = registry.resolve(user_cred, args[0])
415 records = filter_records(opts.type, records)
417 print "No record of type", opts.type
418 for record in records:
419 if record['type'] in ['user']:
420 record = UserRecord(dict = record)
421 elif record['type'] in ['slice']:
422 record = SliceRecord(dict = record)
423 elif record['type'] in ['node']:
424 record = NodeRecord(dict = record)
425 elif record['type'] in ['authority', 'ma', 'sa']:
426 record = AuthorityRecord(dict = record)
428 record = GeniRecord(dict = record)
432 save_records_to_file(opts.file, records)
435 def delegate(opts, args):
437 user_cred = get_user_cred()
438 if opts.delegate_user:
439 object_cred = user_cred
440 elif opts.delegate_slice:
441 object_cred = get_slice_cred(opts.delegate_slice)
443 print "Must specify either --user or --slice <hrn>"
446 # the gid and hrn of the object we are delegating
447 object_gid = object_cred.get_gid_object()
448 object_hrn = object_gid.get_hrn()
450 if not object_cred.get_delegate():
451 print "Error: Object credential", object_hrn, "does not have delegate bit set"
454 records = registry.resolve(user_cred, args[0])
455 records = filter_records("user", records)
458 print "Error: Didn't find a user record for", args[0]
461 # the gid of the user who will be delegated too
462 delegee_gid = records[0].get_gid_object()
463 delegee_hrn = delegee_gid.get_hrn()
465 # the key and hrn of the user who will be delegating
466 user_key = Keypair(filename = get_key_file())
467 user_hrn = user_cred.get_gid_caller().get_hrn()
469 dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
470 dcred.set_gid_caller(delegee_gid)
471 dcred.set_gid_object(object_gid)
472 dcred.set_privileges(object_cred.get_privileges())
473 dcred.set_delegate(True)
474 dcred.set_pubkey(object_gid.get_pubkey())
475 dcred.set_issuer(user_key, user_hrn)
476 dcred.set_parent(object_cred)
480 if opts.delegate_user:
481 dest_fn = os.path.join(sfi_dir, get_leaf(delegee_hrn) + "_" + get_leaf(object_hrn) + ".cred")
482 elif opts.delegate_slice:
483 dest_fn = os.path_join(sfi_dir, get_leaf(delegee_hrn) + "_slice_" + get_leaf(object_hrn) + ".cred")
485 dcred.save_to_file(dest_fn, save_parents = True)
487 print "delegated credential for", object_hrn, "to", delegee_hrn, "and wrote to", dest_fn
489 # removed named registry record
490 # - have to first retrieve the record to be removed
491 def remove(opts, args):
493 auth_cred = get_auth_cred()
494 return registry.remove(auth_cred, opts.type, args[0])
496 # add named registry record
499 auth_cred = get_auth_cred()
500 rec_file = get_record_file(args[0])
501 record = load_record_from_file(rec_file)
503 return registry.register(auth_cred, record)
505 # update named registry entry
506 def update(opts, args):
508 user_cred = get_user_cred()
509 rec_file = get_record_file(args[0])
510 record = load_record_from_file(rec_file)
511 if record.get_type() == "user":
512 if record.get_name() == user_cred.get_gid_object().get_hrn():
515 cred = get_auth_cred()
516 elif record.get_type() in ["slice"]:
518 cred = get_slice_cred(record.get_name())
519 except ServerException, e:
520 # XXX smbaker -- once we have better error return codes, update this
521 # to do something better than a string compare
522 if "Permission error" in e.args[0]:
523 cred = get_auth_cred()
526 elif record.get_type() in ["authority"]:
527 cred = get_auth_cred()
528 elif record.get_type() == 'node':
529 cred = get_auth_cred()
531 raise "unknown record type" + record.get_type()
532 return registry.update(cred, record)
535 # Slice-related commands
538 # list available nodes -- now use 'resources' w/ no argument instead
539 #def nodes(opts, args):
541 # user_cred = get_user_cred()
542 # if not opts.format:
545 # context = opts.format
546 # results = slicemgr.list_nodes(user_cred)
547 # if opts.format in ['rspec']:
548 # display_rspec(results)
550 # display_list(results)
551 # if (opts.file is not None):
552 # rspec = slicemgr.list_nodes(user_cred)
553 # save_rspec_to_file(rspec, opts.file)
556 # list instantiated slices
557 def slices(opts, args):
559 user_cred = get_user_cred()
560 results = slicemgr.get_slices(user_cred)
561 display_list(results)
564 # show rspec for named slice
565 def resources(opts, args):
568 slice_cred = get_slice_cred(args[0])
569 result = slicemgr.get_resources(slice_cred, args[0])
571 user_cred = get_user_cred()
572 result = slicemgr.get_resources(user_cred)
574 display_rspec(result, format)
575 if (opts.file is not None):
576 save_rspec_to_file(result, opts.file)
579 # created named slice with given rspec
580 def create(opts, args):
583 slice_cred = get_slice_cred(slice_hrn)
584 rspec_file = get_rspec_file(args[1])
585 with open(rspec_file) as f:
587 return slicemgr.create_slice(slice_cred, slice_hrn, rspec)
590 def delete(opts, args):
593 slice_cred = get_slice_cred(slice_hrn)
595 return slicemgr.delete_slice(slice_cred, slice_hrn)
598 def start(opts, args):
601 slice_cred = get_slice_cred(args[0])
602 return slicemgr.start_slice(slice_cred, slice_hrn)
605 def stop(opts, args):
608 slice_cred = get_slice_cred(args[0])
609 return slicemgr.stop_slice(slice_cred, slice_hrn)
612 def reset(opts, args):
615 slice_cred = get_slice_cred(args[0])
616 return slicemgr.reset_slice(slice_cred, slice_hrn)
620 # Display, Save, and Filter RSpecs and Records
621 # - to be replace by EMF-generated routines
625 def display_rspec(rspec, format = 'rspec'):
626 if format in ['dns']:
628 spec.parseString(rspec)
630 nodespecs = spec.getDictsByTagName('NodeSpec')
631 for nodespec in nodespecs:
632 if nodespec.has_key('name') and nodespec['name']:
633 if isinstance(nodespec['name'], ListType):
634 hostnames.extend(nodespec['name'])
635 elif isinstance(nodespec['name'], StringTypes):
636 hostnames.append(nodespec['name'])
638 elif format in ['ip']:
640 spec.parseString(rspec)
642 ifspecs = spec.getDictsByTagName('IfSpec')
643 for ifspec in ifspecs:
644 if ifspec.has_key('addr') and ifspec['addr']:
645 ips.append(ifspec['addr'])
653 def display_list(results):
654 for result in results:
657 def save_rspec_to_file(rspec, filename):
658 if not filename.startswith(os.sep):
659 filename = sfi_dir + filename
660 if not filename.endswith(".rspec"):
661 filename = filename + ".rspec"
663 f = open(filename, 'w')
668 def display_records(recordList, dump = False):
669 ''' Print all fields in the record'''
670 for record in recordList:
671 display_record(record, dump)
673 def display_record(record, dump = False):
677 info = record.getdict()
678 print "%s (%s)" % (info['hrn'], info['type'])
681 def filter_records(type, records):
682 filtered_records = []
683 for record in records:
684 if (record.get_type() == type) or (type == "all"):
685 filtered_records.append(record)
686 return filtered_records
688 def save_records_to_file(filename, recordList):
690 for record in recordList:
692 save_record_to_file(filename + "." + str(index), record)
694 save_record_to_file(filename, record)
697 def save_record_to_file(filename, record):
698 if not filename.startswith(os.sep):
699 filename = sfi_dir + filename
700 str = record.save_to_string()
701 file(filename, "w").write(str)
704 def load_record_from_file(filename):
705 str = file(filename, "r").read()
706 record = GeniRecord(string=str)
709 if __name__=="__main__":