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
16 sfi_dir = os.path.expanduser("~/.sfi/")
24 # Establish Connection to SliceMgr and Registry Servers
26 def set_servers(options):
33 if (options.sm is not None):
35 elif ("SFI_SM" in os.environ):
36 sm_url = os.environ["SFI_SM"]
38 print "No Known Slice Manager"
42 if (options.registry is not None):
43 reg_url = options.registry
44 elif ("SFI_REGISTRY" in os.environ):
45 reg_url = os.environ["SFI_REGISTRY"]
47 print "No Known Registry Server"
51 print "Contacting Slice Manager at:", sm_url
52 print "Contacting Registry at:", reg_url
55 if (options.user is not None):
57 elif ("SFI_USER" in os.environ):
58 user = os.environ["SFI_USER"]
60 print "No Known User Name"
64 if (options.auth is not None):
65 authority = options.auth
66 elif ("SFI_AUTH" in os.environ):
67 authority = os.environ["SFI_AUTH"]
71 # Get key and certificate
72 key_file = get_key_file()
73 cert_file = get_cert_file(key_file)
75 # Establish connection to server(s)
76 slicemgr = GeniClient(sm_url, key_file, cert_file)
77 registry = GeniClient(reg_url, key_file, cert_file)
81 # Get various credential and spec files
83 # Establishes limiting conventions
84 # - conflates MAs and SAs
85 # - assumes last token in slice name is unique
87 # Bootstraps credentials
88 # - bootstrap user credential from self-signed certificate
89 # - bootstrap authority credential from user credential
90 # - bootstrap slice credential from user credential
94 parts = name.split(".")
98 file = os.path.join(sfi_dir, get_leaf(user) + ".pkey")
99 if (os.path.isfile(file)):
102 print "Key file", file, "does not exist"
106 def get_cert_file(key_file):
109 file = os.path.join(sfi_dir, get_leaf(user) + ".cert")
110 if (os.path.isfile(file)):
113 k = Keypair(filename = key_file)
114 cert = Certificate(subject=user)
116 cert.set_issuer(k, user)
119 print "Writing self-signed certificate to", file
120 cert.save_to_file(file)
126 file = os.path.join(sfi_dir, get_leaf(user) + ".cred")
127 if (os.path.isfile(file)):
128 user_cred = Credential(filename=file)
131 # bootstrap user credential
132 user_cred = registry.get_credential(None, "user", user)
134 user_cred.save_to_file(file, save_parents=True)
136 print "Writing user credential to", file
139 print "Failed to get user credential"
146 print "no authority specified. Use -a or set SF_AUTH"
149 file = os.path.join(sfi_dir, get_leaf("authority") +".cred")
150 if (os.path.isfile(file)):
151 auth_cred = Credential(filename=file)
154 # bootstrap authority credential from user credential
155 user_cred = get_user_cred()
156 auth_cred = registry.get_credential(user_cred, "sa", authority)
158 auth_cred.save_to_file(file, save_parents=True)
160 print "Writing authority credential to", file
163 print "Failed to get authority credential"
166 def get_slice_cred(name):
167 file = os.path.join(sfi_dir, "slice_" + get_leaf(name) + ".cred")
168 if (os.path.isfile(file)):
169 slice_cred = Credential(filename=file)
172 # bootstrap slice credential from user credential
173 user_cred = get_user_cred()
174 slice_cred = registry.get_credential(user_cred, "slice", name)
176 slice_cred.save_to_file(file, save_parents=True)
178 print "Writing slice credential to", file
181 print "Failed to get slice credential"
184 def get_rspec_file(rspec):
185 if (os.path.isabs(rspec)):
188 file = os.path.join(sfi_dir, rspec)
189 if (os.path.isfile(file)):
192 print "No such rspec file", rspec
195 def get_record_file(record):
196 if (os.path.isabs(record)):
199 file = os.path.join(sfi_dir, record)
200 if (os.path.isfile(file)):
203 print "No such registry record file", record
206 def load_publickey_string(fn):
208 key_string = f.read()
210 # if the filename is a private key file, then extract the public key
211 if "PRIVATE KEY" in key_string:
212 outfn = tempfile.mktemp()
213 cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
216 key_string = f.read()
222 # Generate sub-command parser
224 def create_cmd_parser(command, additional_cmdargs = None):
225 cmdargs = {"list": "name",
231 "resources": "[name]",
232 "create": "name rspec",
239 if additional_cmdargs:
240 cmdargs.update(additional_cmdargs)
242 if command not in cmdargs:
243 print "Invalid command\n"
245 for key in cmdargs.keys():
250 parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
251 % (command, cmdargs[command]))
252 if command in ("resources"):
253 parser.add_option("-f", "--format", dest="format",type="choice",
254 help="display format (dns|ip|rspec)",default="rspec",
255 choices=("dns","ip","rspec"))
256 if command in ("list", "show", "remove"):
257 parser.add_option("-t", "--type", dest="type",type="choice",
258 help="type filter (user|slice|sa|ma|node|aggregate)",
259 choices=("user","slice","sa","ma","node","aggregate", "all"),
261 if command in ("show", "list", "resources"):
262 parser.add_option("-o", "--output", dest="file",
263 help="output XML to file", metavar="FILE", default=None)
267 # Generate command line parser
268 parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
269 description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
270 parser.add_option("-r", "--registry", dest="registry",
271 help="root registry", metavar="URL", default=None)
272 parser.add_option("-s", "--slicemgr", dest="sm",
273 help="slice manager", metavar="URL", default=None)
274 parser.add_option("-d", "--dir", dest="dir",
275 help="working directory", metavar="PATH", default = sfi_dir)
276 parser.add_option("-u", "--user", dest="user",
277 help="user name", metavar="HRN", default=None)
278 parser.add_option("-a", "--auth", dest="auth",
279 help="authority name", metavar="HRN", default=None)
280 parser.add_option("-v", "--verbose",
281 action="store_true", dest="verbose", default=False,
283 parser.disable_interspersed_args()
287 def dispatch(command, cmd_opts, cmd_args):
288 globals()[command](cmd_opts, cmd_args)
291 # Main: parse arguments and dispatch to command
296 parser = create_parser()
297 (options, args) = parser.parse_args()
300 print "No command given. Use -h for help."
304 (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
305 verbose = options.verbose
307 print "Resgistry %s, sm %s, dir %s, user %s, auth %s" % (options.registry,
312 print "Command %s" %command
313 if command in ("resources"):
314 print "resources cmd_opts %s" %cmd_opts.format
315 elif command in ("list","show","remove"):
316 print "cmd_opts.type %s" %cmd_opts.type
317 print "cmd_args %s" %cmd_args
322 dispatch(command, cmd_opts, cmd_args)
324 print "Command not found:", command
330 # Following functions implement the commands
332 # Registry-related commands
335 # list entires in named authority registry
336 def list(opts, args):
338 user_cred = get_user_cred()
339 list = registry.list(user_cred, args[0])
340 # filter on person, slice, site, node, etc.
341 # THis really should be in the filter_records funct def comment...
342 list = filter_records(opts.type, list)
343 display_records(list)
345 save_records_to_file(opts.file, list)
348 # show named registry record
349 def show(opts, args):
351 user_cred = get_user_cred()
352 records = registry.resolve(user_cred, args[0])
353 records = filter_records(opts.type, records)
355 print "No record of type", opts.type
356 display_records(records, True)
358 save_records_to_file(opts.file, records)
361 # removed named registry record
362 # - have to first retrieve the record to be removed
363 def remove(opts, args):
365 auth_cred = get_auth_cred()
366 return registry.remove(auth_cred, opts.type, args[0])
368 # add named registry record
371 auth_cred = get_auth_cred()
372 rec_file = get_record_file(args[0])
373 record = load_record_from_file(rec_file)
375 # check and see if we need to create a gid for this record. The creator
376 # of the record signals this by filling in the create_gid, create_gid_hrn,
377 # and create_gid_key members.
378 # (note: we'd use an unsigned GID in the record instead, but pyOpenSSL is
379 # broken and has no way for us to get the key back out of the gid)
380 geni_info = record.get_geni_info()
381 if "create_gid" in geni_info:
382 gid = registry.create_gid(auth_cred, geni_info["create_gid_hrn"], create_uuid(), geni_info["create_gid_key"])
385 del geni_info["create_gid"]
386 del geni_info["create_gid_hrn"]
387 del geni_info["create_gid_key"]
389 return registry.register(auth_cred, record)
391 # update named registry entry
392 def update(opts, args):
394 user_cred = get_user_cred()
395 rec_file = get_record_file(args[0])
396 record = load_record_from_file(rec_file)
397 if record.get_type() == "user":
398 if record.get_name() == user_cred.get_gid_object().get_hrn():
401 create = get_auth_cred()
402 elif record.get_type() in ["slice"]:
404 cred = get_slice_cred(record.get_name())
405 except ServerException, e:
406 if "PermissionError" in e.args[0]:
407 cred = get_auth_cred()
410 elif record.get_type() in ["sa", "ma", "node"]:
411 cred = get_auth_cred()
413 raise "unknown record type" + record.get_type()
414 return registry.update(cred, record)
417 # Slice-related commands
420 # list available nodes -- now use 'resources' w/ no argument instead
421 #def nodes(opts, args):
423 # user_cred = get_user_cred()
424 # if not opts.format:
427 # context = opts.format
428 # results = slicemgr.list_nodes(user_cred)
429 # if opts.format in ['rspec']:
430 # display_rspec(results)
432 # display_list(results)
433 # if (opts.file is not None):
434 # rspec = slicemgr.list_nodes(user_cred)
435 # save_rspec_to_file(rspec, opts.file)
438 # list instantiated slices
439 def slices(opts, args):
441 user_cred = get_user_cred()
442 results = slicemgr.list_slices(user_cred)
443 display_list(results)
446 # show rspec for named slice
447 def resources(opts, args):
450 slice_cred = get_slice_cred(args[0])
451 result = slicemgr.get_resources(slice_cred, args[0])
453 user_cred = get_user_cred()
454 result = slicemgr.get_resources(user_cred)
455 display_rspec(result)
456 if (opts.file is not None):
457 save_rspec_to_file(opts.file, result)
460 # created named slice with given rspec
461 def create(opts, args):
464 slice_cred = get_slice_cred(slice_hrn)
465 rspec_file = get_rspec_file(args[1])
466 with open(rspec_file) as f:
468 return slicemgr.create_slice(slice_cred, slice_hrn, rspec)
471 def delete(opts, args):
474 slice_cred = get_slice_cred(slice_hrn)
476 return slicemgr.delete_slice(slice_cred, slice_hrn)
479 def start(opts, args):
481 slice_cred = get_slice_cred(args[0])
482 return slicemgr.start_slice(slice_cred)
485 def stop(opts, args):
487 slice_cred = get_slice_cred(args[0])
488 return slicemgr.stop_slice(slice_cred)
491 def reset(opts, args):
493 slice_cred = get_slice_cred(args[0])
494 return slicemgr.reset_slice(slice_cred)
498 # Display, Save, and Filter RSpecs and Records
499 # - to be replace by EMF-generated routines
503 def display_rspec(rspec):
507 def display_list(results):
508 for result in results:
511 def save_rspec_to_file(rspec, filename):
512 if not filename.startswith(os.sep):
513 filename = sfi_dir + filename
514 if not filename.endswith(".rspec"):
515 filename = filename + ".rspec"
517 f = open(filename, 'w')
522 def display_records(recordList, dump = False):
523 ''' Print all fields in the record'''
524 for record in recordList:
525 display_record(record, dump)
527 def display_record(record, dump = False):
531 info = record.getdict()
532 print "%s (%s)" % (info['hrn'], info['type'])
535 def filter_records(type, records):
536 filtered_records = []
537 for record in records:
538 if (record.get_type() == type) or (type == "all"):
539 filtered_records.append(record)
540 return filtered_records
542 def save_records_to_file(filename, recordList):
544 for record in recordList:
546 save_record_to_file(filename + "." + str(index), record)
548 save_record_to_file(filename, record)
551 def save_record_to_file(filename, record):
552 if not filename.startswith(os.sep):
553 filename = sfi_dir + filename
554 str = record.save_to_string()
555 file(filename, "w").write(str)
558 def load_record_from_file(filename):
559 str = file(filename, "r").read()
560 record = GeniRecord(string=str)
563 if __name__=="__main__":