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 GeniRecord
15 from geni.util.rspec import Rspec
16 from types import StringTypes, ListType
18 sfi_dir = os.path.expanduser("~/.sfi/")
26 # Establish Connection to SliceMgr and Registry Servers
28 def set_servers(options):
35 if (options.sm is not None):
37 elif ("SFI_SM" in os.environ):
38 sm_url = os.environ["SFI_SM"]
40 print "No Known Slice Manager"
44 if (options.registry is not None):
45 reg_url = options.registry
46 elif ("SFI_REGISTRY" in os.environ):
47 reg_url = os.environ["SFI_REGISTRY"]
49 print "No Known Registry Server"
53 print "Contacting Slice Manager at:", sm_url
54 print "Contacting Registry at:", reg_url
57 if (options.user is not None):
59 elif ("SFI_USER" in os.environ):
60 user = os.environ["SFI_USER"]
62 print "No Known User Name"
66 if (options.auth is not None):
67 authority = options.auth
68 elif ("SFI_AUTH" in os.environ):
69 authority = os.environ["SFI_AUTH"]
73 # Get key and certificate
74 key_file = get_key_file()
75 cert_file = get_cert_file(key_file)
77 # Establish connection to server(s)
78 slicemgr = GeniClient(sm_url, key_file, cert_file)
79 registry = GeniClient(reg_url, key_file, cert_file)
83 # Get various credential and spec files
85 # Establishes limiting conventions
86 # - conflates MAs and SAs
87 # - assumes last token in slice name is unique
89 # Bootstraps credentials
90 # - bootstrap user credential from self-signed certificate
91 # - bootstrap authority credential from user credential
92 # - bootstrap slice credential from user credential
96 parts = name.split(".")
100 file = os.path.join(sfi_dir, get_leaf(user) + ".pkey")
101 if (os.path.isfile(file)):
104 print "Key file", file, "does not exist"
108 def get_cert_file(key_file):
111 file = os.path.join(sfi_dir, get_leaf(user) + ".cert")
112 if (os.path.isfile(file)):
115 k = Keypair(filename = key_file)
116 cert = Certificate(subject=user)
118 cert.set_issuer(k, user)
121 print "Writing self-signed certificate to", file
122 cert.save_to_file(file)
128 file = os.path.join(sfi_dir, get_leaf(user) + ".cred")
129 if (os.path.isfile(file)):
130 user_cred = Credential(filename=file)
133 # bootstrap user credential
134 user_cred = registry.get_credential(None, "user", user)
136 user_cred.save_to_file(file, save_parents=True)
138 print "Writing user credential to", file
141 print "Failed to get user credential"
148 print "no authority specified. Use -a or set SF_AUTH"
151 file = os.path.join(sfi_dir, get_leaf("authority") +".cred")
152 if (os.path.isfile(file)):
153 auth_cred = Credential(filename=file)
156 # bootstrap authority credential from user credential
157 user_cred = get_user_cred()
158 auth_cred = registry.get_credential(user_cred, "sa", authority)
160 auth_cred.save_to_file(file, save_parents=True)
162 print "Writing authority credential to", file
165 print "Failed to get authority credential"
168 def get_slice_cred(name):
169 file = os.path.join(sfi_dir, "slice_" + get_leaf(name) + ".cred")
170 if (os.path.isfile(file)):
171 slice_cred = Credential(filename=file)
174 # bootstrap slice credential from user credential
175 user_cred = get_user_cred()
176 slice_cred = registry.get_credential(user_cred, "slice", name)
178 slice_cred.save_to_file(file, save_parents=True)
180 print "Writing slice credential to", file
183 print "Failed to get slice credential"
186 def get_rspec_file(rspec):
187 if (os.path.isabs(rspec)):
190 file = os.path.join(sfi_dir, rspec)
191 if (os.path.isfile(file)):
194 print "No such rspec file", rspec
197 def get_record_file(record):
198 if (os.path.isabs(record)):
201 file = os.path.join(sfi_dir, record)
202 if (os.path.isfile(file)):
205 print "No such registry record file", record
208 def load_publickey_string(fn):
210 key_string = f.read()
212 # if the filename is a private key file, then extract the public key
213 if "PRIVATE KEY" in key_string:
214 outfn = tempfile.mktemp()
215 cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
218 key_string = f.read()
224 # Generate sub-command parser
226 def create_cmd_parser(command, additional_cmdargs = None):
227 cmdargs = {"list": "name",
233 "resources": "[name]",
234 "create": "name rspec",
241 if additional_cmdargs:
242 cmdargs.update(additional_cmdargs)
244 if command not in cmdargs:
245 print "Invalid command\n"
247 for key in cmdargs.keys():
252 parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
253 % (command, cmdargs[command]))
254 if command in ("resources"):
255 parser.add_option("-f", "--format", dest="format",type="choice",
256 help="display format (dns|ip|rspec)",default="rspec",
257 choices=("dns","ip","rspec"))
258 if command in ("list", "show", "remove"):
259 parser.add_option("-t", "--type", dest="type",type="choice",
260 help="type filter (user|slice|sa|ma|node|aggregate)",
261 choices=("user","slice","sa","ma","node","aggregate", "all"),
263 if command in ("show", "list", "resources"):
264 parser.add_option("-o", "--output", dest="file",
265 help="output XML to file", metavar="FILE", default=None)
269 # Generate command line parser
270 parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
271 description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
272 parser.add_option("-r", "--registry", dest="registry",
273 help="root registry", metavar="URL", default=None)
274 parser.add_option("-s", "--slicemgr", dest="sm",
275 help="slice manager", metavar="URL", default=None)
276 parser.add_option("-d", "--dir", dest="dir",
277 help="working directory", metavar="PATH", default = sfi_dir)
278 parser.add_option("-u", "--user", dest="user",
279 help="user name", metavar="HRN", default=None)
280 parser.add_option("-a", "--auth", dest="auth",
281 help="authority name", metavar="HRN", default=None)
282 parser.add_option("-v", "--verbose",
283 action="store_true", dest="verbose", default=False,
285 parser.disable_interspersed_args()
289 def dispatch(command, cmd_opts, cmd_args):
290 globals()[command](cmd_opts, cmd_args)
293 # Main: parse arguments and dispatch to command
298 parser = create_parser()
299 (options, args) = parser.parse_args()
302 print "No command given. Use -h for help."
306 (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
307 verbose = options.verbose
309 print "Resgistry %s, sm %s, dir %s, user %s, auth %s" % (options.registry,
314 print "Command %s" %command
315 if command in ("resources"):
316 print "resources cmd_opts %s" %cmd_opts.format
317 elif command in ("list","show","remove"):
318 print "cmd_opts.type %s" %cmd_opts.type
319 print "cmd_args %s" %cmd_args
324 dispatch(command, cmd_opts, cmd_args)
326 print "Command not found:", command
332 # Following functions implement the commands
334 # Registry-related commands
337 # list entires in named authority registry
338 def list(opts, args):
340 user_cred = get_user_cred()
341 list = registry.list(user_cred, args[0])
342 # filter on person, slice, site, node, etc.
343 # THis really should be in the filter_records funct def comment...
344 list = filter_records(opts.type, list)
345 display_records(list)
347 save_records_to_file(opts.file, list)
350 # show named registry record
351 def show(opts, args):
353 user_cred = get_user_cred()
354 records = registry.resolve(user_cred, args[0])
355 records = filter_records(opts.type, records)
357 print "No record of type", opts.type
358 display_records(records, True)
360 save_records_to_file(opts.file, records)
363 # removed named registry record
364 # - have to first retrieve the record to be removed
365 def remove(opts, args):
367 auth_cred = get_auth_cred()
368 return registry.remove(auth_cred, opts.type, args[0])
370 # add named registry record
373 auth_cred = get_auth_cred()
374 rec_file = get_record_file(args[0])
375 record = load_record_from_file(rec_file)
377 # check and see if we need to create a gid for this record. The creator
378 # of the record signals this by filling in the create_gid, create_gid_hrn,
379 # and create_gid_key members.
380 # (note: we'd use an unsigned GID in the record instead, but pyOpenSSL is
381 # broken and has no way for us to get the key back out of the gid)
382 geni_info = record.get_geni_info()
383 if "create_gid" in geni_info:
384 gid = registry.create_gid(auth_cred, geni_info["create_gid_hrn"], create_uuid(), geni_info["create_gid_key"])
387 del geni_info["create_gid"]
388 del geni_info["create_gid_hrn"]
389 del geni_info["create_gid_key"]
391 return registry.register(auth_cred, record)
393 # update named registry entry
394 def update(opts, args):
396 user_cred = get_user_cred()
397 rec_file = get_record_file(args[0])
398 record = load_record_from_file(rec_file)
399 if record.get_type() == "user":
400 if record.get_name() == user_cred.get_gid_object().get_hrn():
403 create = get_auth_cred()
404 elif record.get_type() in ["slice"]:
406 cred = get_slice_cred(record.get_name())
407 except ServerException, e:
408 if "PermissionError" in e.args[0]:
409 cred = get_auth_cred()
412 elif record.get_type() in ["sa", "ma", "node"]:
413 cred = get_auth_cred()
415 raise "unknown record type" + record.get_type()
416 return registry.update(cred, record)
419 # Slice-related commands
422 # list available nodes -- now use 'resources' w/ no argument instead
423 #def nodes(opts, args):
425 # user_cred = get_user_cred()
426 # if not opts.format:
429 # context = opts.format
430 # results = slicemgr.list_nodes(user_cred)
431 # if opts.format in ['rspec']:
432 # display_rspec(results)
434 # display_list(results)
435 # if (opts.file is not None):
436 # rspec = slicemgr.list_nodes(user_cred)
437 # save_rspec_to_file(rspec, opts.file)
440 # list instantiated slices
441 def slices(opts, args):
443 user_cred = get_user_cred()
444 results = slicemgr.slices(user_cred)
445 display_list(results)
448 # show rspec for named slice
449 def resources(opts, args):
452 slice_cred = get_slice_cred(args[0])
453 result = slicemgr.resources(slice_cred, args[0])
455 user_cred = get_user_cred()
456 result = slicemgr.resources(user_cred)
458 display_rspec(result, format)
459 if (opts.file is not None):
460 save_rspec_to_file(opts.file, result)
463 # created named slice with given rspec
464 def create(opts, args):
467 slice_cred = get_slice_cred(slice_hrn)
468 rspec_file = get_rspec_file(args[1])
469 with open(rspec_file) as f:
471 return slicemgr.create_slice(slice_cred, slice_hrn, rspec)
474 def delete(opts, args):
477 slice_cred = get_slice_cred(slice_hrn)
479 return slicemgr.delete_slice(slice_cred, slice_hrn)
482 def start(opts, args):
484 slice_cred = get_slice_cred(args[0])
485 return slicemgr.start_slice(slice_cred)
488 def stop(opts, args):
490 slice_cred = get_slice_cred(args[0])
491 return slicemgr.stop_slice(slice_cred)
494 def reset(opts, args):
496 slice_cred = get_slice_cred(args[0])
497 return slicemgr.reset_slice(slice_cred)
501 # Display, Save, and Filter RSpecs and Records
502 # - to be replace by EMF-generated routines
506 def display_rspec(rspec, format = 'rspec'):
507 if format in ['dns']:
509 spec.parseString(rspec)
511 nodespecs = spec.getDictsByTagName('NodeSpec')
512 for nodespec in nodespecs:
513 if nodespec.has_key('name') and nodespec['name']:
514 if isinstance(nodespec['name'], ListType):
515 hostnames.extend(nodespec['name'])
516 elif isinstance(nodespec['name'], StringTypes):
517 hostnames.append(nodespec['name'])
519 elif format in ['ip']:
521 spec.parseString(rspec)
523 ifspecs = spec.getDictsByTagName('IfSpec')
524 for ifspec in ifspecs:
525 if ifspec.has_key('addr') and ifspec['addr']:
526 ips.append(ifspec['addr'])
534 def display_list(results):
535 for result in results:
538 def save_rspec_to_file(rspec, filename):
539 if not filename.startswith(os.sep):
540 filename = sfi_dir + filename
541 if not filename.endswith(".rspec"):
542 filename = filename + ".rspec"
544 f = open(filename, 'w')
549 def display_records(recordList, dump = False):
550 ''' Print all fields in the record'''
551 for record in recordList:
552 display_record(record, dump)
554 def display_record(record, dump = False):
558 info = record.getdict()
559 print "%s (%s)" % (info['hrn'], info['type'])
562 def filter_records(type, records):
563 filtered_records = []
564 for record in records:
565 if (record.get_type() == type) or (type == "all"):
566 filtered_records.append(record)
567 return filtered_records
569 def save_records_to_file(filename, recordList):
571 for record in recordList:
573 save_record_to_file(filename + "." + str(index), record)
575 save_record_to_file(filename, record)
578 def save_record_to_file(filename, record):
579 if not filename.startswith(os.sep):
580 filename = sfi_dir + filename
581 str = record.save_to_string()
582 file(filename, "w").write(str)
585 def load_record_from_file(filename):
586 str = file(filename, "r").read()
587 record = GeniRecord(string=str)
590 if __name__=="__main__":