2 from __future__ import with_statement
4 # sfi -- slice-based facility interface
9 from optparse import OptionParser
10 from geni.util.cert import Keypair, Certificate
11 from geni.util.credential import Credential
12 from geni.util.geniclient import GeniClient, ServerException
13 from geni.util.gid import create_uuid
14 from geni.util.record import *
15 from geni.util.rspec import Rspec
16 from types import StringTypes, ListType
18 # xxx todo xxx auto-load ~/.sfi/sfi_config
20 sfi_dir = os.path.expanduser("~/.sfi/")
28 # Establish Connection to SliceMgr and Registry Servers
30 def set_servers(options):
37 if (options.sm is not None):
39 elif ("SFI_SM" in os.environ):
40 sm_url = os.environ["SFI_SM"]
42 print "No Known Slice Manager"
46 if (options.registry is not None):
47 reg_url = options.registry
48 elif ("SFI_REGISTRY" in os.environ):
49 reg_url = os.environ["SFI_REGISTRY"]
51 print "No Known Registry Server"
55 print "Contacting Slice Manager at:", sm_url
56 print "Contacting Registry at:", reg_url
59 if (options.user is not None):
61 elif ("SFI_USER" in os.environ):
62 user = os.environ["SFI_USER"]
64 print "No Known User Name"
68 if (options.auth is not None):
69 authority = options.auth
70 elif ("SFI_AUTH" in os.environ):
71 authority = os.environ["SFI_AUTH"]
75 # Get key and certificate
76 key_file = get_key_file()
77 cert_file = get_cert_file(key_file)
79 # Establish connection to server(s)
80 slicemgr = GeniClient(sm_url, key_file, cert_file)
81 registry = GeniClient(reg_url, key_file, cert_file)
85 # Get various credential and spec files
87 # Establishes limiting conventions
88 # - conflates MAs and SAs
89 # - assumes last token in slice name is unique
91 # Bootstraps credentials
92 # - bootstrap user credential from self-signed certificate
93 # - bootstrap authority credential from user credential
94 # - bootstrap slice credential from user credential
98 parts = name.split(".")
102 file = os.path.join(sfi_dir, get_leaf(user) + ".pkey")
103 if (os.path.isfile(file)):
106 print "Key file", file, "does not exist"
110 def get_cert_file(key_file):
113 file = os.path.join(sfi_dir, get_leaf(user) + ".cert")
114 if (os.path.isfile(file)):
117 k = Keypair(filename = key_file)
118 cert = Certificate(subject=user)
120 cert.set_issuer(k, user)
123 print "Writing self-signed certificate to", file
124 cert.save_to_file(file)
130 file = os.path.join(sfi_dir, get_leaf(user) + ".cred")
131 if (os.path.isfile(file)):
132 user_cred = Credential(filename=file)
135 # bootstrap user credential
136 user_cred = registry.get_credential(None, "user", user)
138 user_cred.save_to_file(file, save_parents=True)
140 print "Writing user credential to", file
143 print "Failed to get user credential"
150 print "no authority specified. Use -a or set SF_AUTH"
153 file = os.path.join(sfi_dir, get_leaf("authority") +".cred")
154 if (os.path.isfile(file)):
155 auth_cred = Credential(filename=file)
158 # bootstrap authority credential from user credential
159 user_cred = get_user_cred()
160 auth_cred = registry.get_credential(user_cred, "sa", authority)
162 auth_cred.save_to_file(file, save_parents=True)
164 print "Writing authority credential to", file
167 print "Failed to get authority credential"
170 def get_slice_cred(name):
171 file = os.path.join(sfi_dir, "slice_" + get_leaf(name) + ".cred")
172 if (os.path.isfile(file)):
173 slice_cred = Credential(filename=file)
176 # bootstrap slice credential from user credential
177 user_cred = get_user_cred()
178 slice_cred = registry.get_credential(user_cred, "slice", name)
180 slice_cred.save_to_file(file, save_parents=True)
182 print "Writing slice credential to", file
185 print "Failed to get slice credential"
188 def delegate_cred(cred, hrn, type = 'authority'):
189 # the gid and hrn of the object we are delegating
190 object_gid = cred.get_gid_object()
191 object_hrn = object_gid.get_hrn()
192 cred.set_delegate(True)
193 if not cred.get_delegate():
194 raise Exception, "Error: Object credential %(object_hrn)s does not have delegate bit set" % locals()
197 records = registry.resolve(cred, hrn)
198 records = filter_records(type, records)
201 raise Exception, "Error: Didn't find a %(type)s record for %(hrn)s" % locals()
203 # the gid of the user who will be delegated too
204 delegee_gid = records[0].get_gid_object()
205 delegee_hrn = delegee_gid.get_hrn()
207 # the key and hrn of the user who will be delegating
208 user_key = Keypair(filename = get_key_file())
209 user_hrn = cred.get_gid_caller().get_hrn()
211 dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
212 dcred.set_gid_caller(delegee_gid)
213 dcred.set_gid_object(object_gid)
214 dcred.set_privileges(cred.get_privileges())
215 dcred.set_delegate(True)
216 dcred.set_pubkey(object_gid.get_pubkey())
217 dcred.set_issuer(user_key, user_hrn)
218 dcred.set_parent(cred)
224 def get_rspec_file(rspec):
225 if (os.path.isabs(rspec)):
228 file = os.path.join(sfi_dir, rspec)
229 if (os.path.isfile(file)):
232 print "No such rspec file", rspec
235 def get_record_file(record):
236 if (os.path.isabs(record)):
239 file = os.path.join(sfi_dir, record)
240 if (os.path.isfile(file)):
243 print "No such registry record file", record
246 def load_publickey_string(fn):
248 key_string = f.read()
250 # if the filename is a private key file, then extract the public key
251 if "PRIVATE KEY" in key_string:
252 outfn = tempfile.mktemp()
253 cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
256 key_string = f.read()
261 # Generate sub-command parser
263 def create_cmd_parser(command, additional_cmdargs = None):
264 cmdargs = {"list": "name",
270 "resources": "[name]",
271 "create": "name rspec",
279 if additional_cmdargs:
280 cmdargs.update(additional_cmdargs)
282 if command not in cmdargs:
283 print "Invalid command\n"
285 for key in cmdargs.keys():
290 parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
291 % (command, cmdargs[command]))
292 if command in ("resources"):
293 parser.add_option("-f", "--format", dest="format",type="choice",
294 help="display format (dns|ip|rspec)",default="rspec",
295 choices=("dns","ip","rspec"))
296 if command in ("list", "show", "remove"):
297 parser.add_option("-t", "--type", dest="type",type="choice",
298 help="type filter (user|slice|sa|ma|node|aggregate)",
299 choices=("user","slice","sa","ma","node","aggregate", "all"),
301 if command in ("show", "list", "resources"):
302 parser.add_option("-o", "--output", dest="file",
303 help="output XML to file", metavar="FILE", default=None)
304 if command in ("delegate"):
305 parser.add_option("-u", "--user",
306 action="store_true", dest="delegate_user", default=False,
307 help="delegate user credential")
308 parser.add_option("-s", "--slice", dest="delegate_slice",
309 help="delegate slice credential", metavar="HRN", default=None)
313 # Generate command line parser
314 parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
315 description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
316 parser.add_option("-r", "--registry", dest="registry",
317 help="root registry", metavar="URL", default=None)
318 parser.add_option("-s", "--slicemgr", dest="sm",
319 help="slice manager", metavar="URL", default=None)
320 parser.add_option("-d", "--dir", dest="dir",
321 help="working directory", metavar="PATH", default = sfi_dir)
322 parser.add_option("-u", "--user", dest="user",
323 help="user name", metavar="HRN", default=None)
324 parser.add_option("-a", "--auth", dest="auth",
325 help="authority name", metavar="HRN", default=None)
326 parser.add_option("-v", "--verbose",
327 action="store_true", dest="verbose", default=False,
329 parser.disable_interspersed_args()
333 def dispatch(command, cmd_opts, cmd_args):
334 globals()[command](cmd_opts, cmd_args)
337 # Main: parse arguments and dispatch to command
342 parser = create_parser()
343 (options, args) = parser.parse_args()
346 print "No command given. Use -h for help."
350 (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
351 verbose = options.verbose
353 print "Resgistry %s, sm %s, dir %s, user %s, auth %s" % (options.registry,
358 print "Command %s" %command
359 if command in ("resources"):
360 print "resources cmd_opts %s" %cmd_opts.format
361 elif command in ("list","show","remove"):
362 print "cmd_opts.type %s" %cmd_opts.type
363 print "cmd_args %s" %cmd_args
368 dispatch(command, cmd_opts, cmd_args)
371 print "Command not found:", command
377 # Following functions implement the commands
379 # Registry-related commands
382 # list entires in named authority registry
383 def list(opts, args):
385 user_cred = get_user_cred()
386 list = registry.list(user_cred, args[0])
387 # filter on person, slice, site, node, etc.
388 # THis really should be in the filter_records funct def comment...
389 list = filter_records(opts.type, list)
391 print "%s (%s)" % (record['hrn'], record['type'])
393 save_records_to_file(opts.file, list)
396 # show named registry record
397 def show(opts, args):
399 user_cred = get_user_cred()
400 records = registry.resolve(user_cred, args[0])
401 records = filter_records(opts.type, records)
403 print "No record of type", opts.type
404 for record in records:
405 if record['type'] in ['user']:
406 record = UserRecord(dict = record)
407 elif record['type'] in ['slice']:
408 record = SliceRecord(dict = record)
409 elif record['type'] in ['node']:
410 record = NodeRecord(dict = record)
411 elif record['type'] in ['authority', 'ma', 'sa']:
412 record = AuthorityRecord(dict = record)
414 record = GeniRecord(dict = record)
418 save_records_to_file(opts.file, records)
421 def delegate(opts, args):
423 user_cred = get_user_cred()
424 if opts.delegate_user:
425 object_cred = user_cred
426 elif opts.delegate_slice:
427 object_cred = get_slice_cred(opts.delegate_slice)
429 print "Must specify either --user or --slice <hrn>"
432 # the gid and hrn of the object we are delegating
433 object_gid = object_cred.get_gid_object()
434 object_hrn = object_gid.get_hrn()
436 if not object_cred.get_delegate():
437 print "Error: Object credential", object_hrn, "does not have delegate bit set"
440 records = registry.resolve(user_cred, args[0])
441 records = filter_records("user", records)
444 print "Error: Didn't find a user record for", args[0]
447 # the gid of the user who will be delegated too
448 delegee_gid = records[0].get_gid_object()
449 delegee_hrn = delegee_gid.get_hrn()
451 # the key and hrn of the user who will be delegating
452 user_key = Keypair(filename = get_key_file())
453 user_hrn = user_cred.get_gid_caller().get_hrn()
455 dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
456 dcred.set_gid_caller(delegee_gid)
457 dcred.set_gid_object(object_gid)
458 dcred.set_privileges(object_cred.get_privileges())
459 dcred.set_delegate(True)
460 dcred.set_pubkey(object_gid.get_pubkey())
461 dcred.set_issuer(user_key, user_hrn)
462 dcred.set_parent(object_cred)
466 if opts.delegate_user:
467 dest_fn = os.path.join(sfi_dir, get_leaf(delegee_hrn) + "_" + get_leaf(object_hrn) + ".cred")
468 elif opts.delegate_slice:
469 dest_fn = os.path_join(sfi_dir, get_leaf(delegee_hrn) + "_slice_" + get_leaf(object_hrn) + ".cred")
471 dcred.save_to_file(dest_fn, save_parents = True)
473 print "delegated credential for", object_hrn, "to", delegee_hrn, "and wrote to", dest_fn
475 # removed named registry record
476 # - have to first retrieve the record to be removed
477 def remove(opts, args):
479 auth_cred = get_auth_cred()
480 return registry.remove(auth_cred, opts.type, args[0])
482 # add named registry record
485 auth_cred = get_auth_cred()
486 rec_file = get_record_file(args[0])
487 record = load_record_from_file(rec_file)
489 return registry.register(auth_cred, record)
491 # update named registry entry
492 def update(opts, args):
494 user_cred = get_user_cred()
495 rec_file = get_record_file(args[0])
496 record = load_record_from_file(rec_file)
497 if record.get_type() == "user":
498 if record.get_name() == user_cred.get_gid_object().get_hrn():
501 cred = get_auth_cred()
502 elif record.get_type() in ["slice"]:
504 cred = get_slice_cred(record.get_name())
505 except ServerException, e:
506 # XXX smbaker -- once we have better error return codes, update this
507 # to do something better than a string compare
508 if "Permission error" in e.args[0]:
509 cred = get_auth_cred()
512 elif record.get_type() in ["authority"]:
513 cred = get_auth_cred()
514 elif record.get_type() == 'node':
515 cred = get_auth_cred()
517 raise "unknown record type" + record.get_type()
518 return registry.update(cred, record)
521 # Slice-related commands
524 # list available nodes -- now use 'resources' w/ no argument instead
525 #def nodes(opts, args):
527 # user_cred = get_user_cred()
528 # if not opts.format:
531 # context = opts.format
532 # results = slicemgr.list_nodes(user_cred)
533 # if opts.format in ['rspec']:
534 # display_rspec(results)
536 # display_list(results)
537 # if (opts.file is not None):
538 # rspec = slicemgr.list_nodes(user_cred)
539 # save_rspec_to_file(rspec, opts.file)
542 # list instantiated slices
543 def slices(opts, args):
545 user_cred = get_user_cred()
546 results = slicemgr.get_slices(user_cred)
547 display_list(results)
550 # show rspec for named slice
551 def resources(opts, args):
554 slice_cred = get_slice_cred(args[0])
555 result = slicemgr.get_resources(slice_cred, args[0])
557 user_cred = get_user_cred()
558 result = slicemgr.get_resources(user_cred)
560 display_rspec(result, format)
561 if (opts.file is not None):
562 save_rspec_to_file(result, opts.file)
565 # created named slice with given rspec
566 def create(opts, args):
569 slice_cred = get_slice_cred(slice_hrn)
570 rspec_file = get_rspec_file(args[1])
571 with open(rspec_file) as f:
573 return slicemgr.create_slice(slice_cred, slice_hrn, rspec)
576 def delete(opts, args):
579 slice_cred = get_slice_cred(slice_hrn)
581 return slicemgr.delete_slice(slice_cred, slice_hrn)
584 def start(opts, args):
587 slice_cred = get_slice_cred(args[0])
588 return slicemgr.start_slice(slice_cred, slice_hrn)
591 def stop(opts, args):
594 slice_cred = get_slice_cred(args[0])
595 return slicemgr.stop_slice(slice_cred, slice_hrn)
598 def reset(opts, args):
601 slice_cred = get_slice_cred(args[0])
602 return slicemgr.reset_slice(slice_cred, slice_hrn)
606 # Display, Save, and Filter RSpecs and Records
607 # - to be replace by EMF-generated routines
611 def display_rspec(rspec, format = 'rspec'):
612 if format in ['dns']:
614 spec.parseString(rspec)
616 nodespecs = spec.getDictsByTagName('NodeSpec')
617 for nodespec in nodespecs:
618 if nodespec.has_key('name') and nodespec['name']:
619 if isinstance(nodespec['name'], ListType):
620 hostnames.extend(nodespec['name'])
621 elif isinstance(nodespec['name'], StringTypes):
622 hostnames.append(nodespec['name'])
624 elif format in ['ip']:
626 spec.parseString(rspec)
628 ifspecs = spec.getDictsByTagName('IfSpec')
629 for ifspec in ifspecs:
630 if ifspec.has_key('addr') and ifspec['addr']:
631 ips.append(ifspec['addr'])
639 def display_list(results):
640 for result in results:
643 def save_rspec_to_file(rspec, filename):
644 if not filename.startswith(os.sep):
645 filename = sfi_dir + filename
646 if not filename.endswith(".rspec"):
647 filename = filename + ".rspec"
649 f = open(filename, 'w')
654 def display_records(recordList, dump = False):
655 ''' Print all fields in the record'''
656 for record in recordList:
657 display_record(record, dump)
659 def display_record(record, dump = False):
663 info = record.getdict()
664 print "%s (%s)" % (info['hrn'], info['type'])
667 def filter_records(type, records):
668 filtered_records = []
669 for record in records:
670 if (record.get_type() == type) or (type == "all"):
671 filtered_records.append(record)
672 return filtered_records
674 def save_records_to_file(filename, recordList):
676 for record in recordList:
678 save_record_to_file(filename + "." + str(index), record)
680 save_record_to_file(filename, record)
683 def save_record_to_file(filename, record):
684 if not filename.startswith(os.sep):
685 filename = sfi_dir + filename
686 str = record.save_to_string()
687 file(filename, "w").write(str)
690 def load_record_from_file(filename):
691 str = file(filename, "r").read()
692 record = GeniRecord(string=str)
695 if __name__=="__main__":