X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=sfa%2Fclient%2Fsfi.py;h=a77f258f0aea51ec7c6792b070d331d071b5c818;hb=5b82b6b9ec6cd3f9ce39b26a9802268789d2f56d;hp=21f0f8ffa986cb74920acf049d7054e1a7546121;hpb=2463c8dccf8e0720193646c28e3ca0f8d9193d37;p=sfa.git diff --git a/sfa/client/sfi.py b/sfa/client/sfi.py index 21f0f8ff..a77f258f 100644 --- a/sfa/client/sfi.py +++ b/sfa/client/sfi.py @@ -43,6 +43,7 @@ from sfa.client.sfaserverproxy import SfaServerProxy, ServerException from sfa.client.client_helper import pg_users_arg, sfa_users_arg from sfa.client.return_value import ReturnValue from sfa.client.candidates import Candidates +from sfa.client.manifolduploader import ManifoldUploader CM_PORT=12346 @@ -137,7 +138,7 @@ def save_rspec_to_file(rspec, filename): if not filename.endswith(".rspec"): filename = filename + ".rspec" f = open(filename, 'w') - f.write(rspec) + f.write("%s"%rspec) f.close() return @@ -224,6 +225,42 @@ def load_record_from_file(filename): import uuid def unique_call_id(): return uuid.uuid4().urn +########## a simple model for maintaing 3 doc attributes per command (instead of just one) +# essentially for the methods that implement a subcommand like sfi list +# we need to keep track of +# (*) doc a few lines that tell what it does, still located in __doc__ +# (*) args_string a simple one-liner that describes mandatory arguments +# (*) example well, one or several releant examples +# +# since __doc__ only accounts for one, we use this simple mechanism below +# however we keep doc in place for easier migration + +from functools import wraps + +# we use a list as well as a dict so we can keep track of the order +commands_list=[] +commands_dict={} + +def register_command (args_string, example,aliases=None): + def wrap(m): + name=getattr(m,'__name__') + doc=getattr(m,'__doc__',"-- missing doc --") + doc=doc.strip(" \t\n") + commands_list.append(name) + # last item is 'canonical' name, so we can know which commands are aliases + command_tuple=(doc, args_string, example,name) + commands_dict[name]=command_tuple + if aliases is not None: + for alias in aliases: + commands_list.append(alias) + commands_dict[alias]=command_tuple + @wraps(m) + def new_method (*args, **kwds): return m(*args, **kwds) + return new_method + return wrap + +########## + class Sfi: # dirty hack to make this class usable from the outside @@ -251,68 +288,132 @@ class Sfi: self.authority = None self.logger = sfi_logger self.logger.enable_console() - self.available_names = [ tuple[0] for tuple in Sfi.available ] - self.available_dict = dict (Sfi.available) - - # tuples command-name expected-args in the order in which they should appear in the help - available = [ - ("version", ""), - ("list", "authority"), - ("show", "name"), - ("add", "[record]"), - ("update", "[record]"), - ("remove", "name"), - ("resources", ""), - ("describe", "slice_hrn"), - ("allocate", "slice_hrn rspec"), - ("provision", "slice_hrn"), - ("action", "slice_hrn action"), - ("delete", "slice_hrn"), - ("status", "slice_hrn"), - ("renew", "slice_hrn time"), - ("shutdown", "slice_hrn"), - ("delegate", "to_hrn"), - ("gid", "[name]"), - ("trusted", "cred"), - ("config", ""), - ] - - def print_command_help (self, options): + ### various auxiliary material that we keep at hand + self.command=None + # need to call this other than just 'config' as we have a command/method with that name + self.config_instance=None + self.config_file=None + self.client_bootstrap=None + + ### suitable if no reasonable command has been provided + def print_commands_help (self, options): verbose=getattr(options,'verbose') - format3="%18s %-15s %s" + format3="%10s %-30s %s" + format3offset=42 line=80*'-' if not verbose: print format3%("command","cmd_args","description") print line else: print line - self.create_parser().print_help() - for command in self.available_names: - args=self.available_dict[command] - method=getattr(self,command,None) - doc="" - if method: doc=getattr(method,'__doc__',"") - if not doc: doc="*** no doc found ***" - doc=doc.strip(" \t\n") - doc=doc.replace("\n","\n"+35*' ') + self.create_parser_global().print_help() + # preserve order from the code + for command in commands_list: + try: + (doc, args_string, example, canonical) = commands_dict[command] + except: + print "Cannot find info on command %s - skipped"%command + continue if verbose: print line - print format3%(command,args,doc) - if verbose: - self.create_command_parser(command).print_help() + if command==canonical: + doc=doc.replace("\n","\n"+format3offset*' ') + print format3%(command,args_string,doc) + if verbose: + self.create_parser_command(command).print_help() + else: + print format3%(command,"<>"%canonical,"") + + ### now if a known command was found we can be more verbose on that one + def print_help (self): + print "==================== Generic sfi usage" + self.sfi_parser.print_help() + (doc,_,example,canonical)=commands_dict[self.command] + if canonical != self.command: + print "\n==================== NOTE: %s is an alias for genuine %s"%(self.command,canonical) + self.command=canonical + print "\n==================== Purpose of %s"%self.command + print doc + print "\n==================== Specific usage for %s"%self.command + self.command_parser.print_help() + if example: + print "\n==================== %s example(s)"%self.command + print example + + def create_parser_global(self): + # Generate command line parser + parser = OptionParser(add_help_option=False, + usage="sfi [sfi_options] command [cmd_options] [cmd_args]", + description="Commands: %s"%(" ".join(commands_list))) + parser.add_option("-r", "--registry", dest="registry", + help="root registry", metavar="URL", default=None) + parser.add_option("-s", "--sliceapi", dest="sm", default=None, metavar="URL", + help="slice API - in general a SM URL, but can be used to talk to an aggregate") + parser.add_option("-R", "--raw", dest="raw", default=None, + help="Save raw, unparsed server response to a file") + parser.add_option("", "--rawformat", dest="rawformat", type="choice", + help="raw file format ([text]|pickled|json)", default="text", + choices=("text","pickled","json")) + parser.add_option("", "--rawbanner", dest="rawbanner", default=None, + help="text string to write before and after raw output") + parser.add_option("-d", "--dir", dest="sfi_dir", + help="config & working directory - default is %default", + metavar="PATH", default=Sfi.default_sfi_dir()) + parser.add_option("-u", "--user", dest="user", + help="user name", metavar="HRN", default=None) + parser.add_option("-a", "--auth", dest="auth", + help="authority name", metavar="HRN", default=None) + parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0, + help="verbose mode - cumulative") + parser.add_option("-D", "--debug", + action="store_true", dest="debug", default=False, + help="Debug (xml-rpc) protocol messages") + # would it make sense to use ~/.ssh/id_rsa as a default here ? + parser.add_option("-k", "--private-key", + action="store", dest="user_private_key", default=None, + help="point to the private key file to use if not yet installed in sfi_dir") + parser.add_option("-t", "--timeout", dest="timeout", default=None, + help="Amout of time to wait before timing out the request") + parser.add_option("-h", "--help", + action="store_true", dest="help", default=False, + help="one page summary on commands & exit") + parser.disable_interspersed_args() + + return parser + - def create_command_parser(self, command): - if command not in self.available_dict: + def create_parser_command(self, command): + if command not in commands_dict: msg="Invalid command\n" msg+="Commands: " - msg += ','.join(self.available_names) + msg += ','.join(commands_list) self.logger.critical(msg) sys.exit(2) - parser = OptionParser(usage="sfi [sfi_options] %s [cmd_options] %s" \ - % (command, self.available_dict[command])) + # retrieve args_string + (_, args_string, __,___) = commands_dict[command] + + parser = OptionParser(add_help_option=False, + usage="sfi [sfi_options] %s [cmd_options] %s" + % (command, args_string)) + parser.add_option ("-h","--help",dest='help',action='store_true',default=False, + help="Summary of one command usage") + + if command in ("config"): + parser.add_option('-m', '--myslice', dest='myslice', action='store_true', default=False, + help='how myslice config variables as well') + + if command in ("version"): + parser.add_option("-l","--local", + action="store_true", dest="version_local", default=False, + help="display version of the local client") - if command in ("add", "update"): + if command in ("version", "trusted"): + parser.add_option("-R","--registry_interface", + action="store_true", dest="registry_interface", default=False, + help="target the registry interface instead of slice interface") + + if command in ("register", "update"): parser.add_option('-x', '--xrn', dest='xrn', metavar='', help='object hrn/urn (mandatory)') parser.add_option('-t', '--type', dest='type', metavar='', help='object type', default=None) parser.add_option('-e', '--email', dest='email', default="", help="email (mandatory for users)") @@ -338,7 +439,7 @@ class Sfi: "authority in set of credentials for this call") # show_credential option - if command in ("list","resources", "describe", "provision", "allocate", "add","update","remove","slices","delete","status","renew"): + if command in ("list","resources", "describe", "provision", "allocate", "register","update","remove","delete","status","renew"): parser.add_option("-C","--credential",dest='show_credential',action='store_true',default=False, help="show credential(s) used in human-readable form") # registy filter option @@ -352,7 +453,7 @@ class Sfi: help="specify specific keys to be displayed from record") if command in ("resources", "describe"): # rspec version - parser.add_option("-r", "--rspec-version", dest="rspec_version", default="SFA 1", + parser.add_option("-r", "--rspec-version", dest="rspec_version", default="GENI 3", help="schema type and version of resulting RSpec") # disable/enable cached rspecs parser.add_option("-c", "--current", dest="current", default=False, @@ -396,87 +497,41 @@ class Sfi: metavar="slice_hrn", help="delegate cred. for slice HRN") parser.add_option("-a", "--auths", dest='delegate_auths',action='append',default=[], metavar='auth_hrn', help="delegate cred for auth HRN") - # this primarily is a shorthand for -a my_hrn^ + # this primarily is a shorthand for -a my_hrn parser.add_option("-p", "--pi", dest='delegate_pi', default=None, action='store_true', help="delegate your PI credentials, so s.t. like -a your_hrn^") parser.add_option("-A","--to-authority",dest='delegate_to_authority',action='store_true',default=False, help="""by default the mandatory argument is expected to be a user, use this if you mean an authority instead""") - - if command in ("version"): - parser.add_option("-R","--registry-version", - action="store_true", dest="version_registry", default=False, - help="probe registry version instead of sliceapi") - parser.add_option("-l","--local", - action="store_true", dest="version_local", default=False, - help="display version of the local client") - - return parser + if command in ("myslice"): + parser.add_option("-p","--password",dest='password',action='store',default=None, + help="specify mainfold password on the command line") + parser.add_option("-s", "--slice", dest="delegate_slices",action='append',default=[], + metavar="slice_hrn", help="delegate cred. for slice HRN") + parser.add_option("-a", "--auths", dest='delegate_auths',action='append',default=[], + metavar='auth_hrn', help="delegate PI cred for auth HRN") + parser.add_option('-d', '--delegate', dest='delegate', help="Override 'delegate' from the config file") + parser.add_option('-b', '--backend', dest='backend', help="Override 'backend' from the config file") - def create_parser(self): - - # Generate command line parser - parser = OptionParser(usage="sfi [sfi_options] command [cmd_options] [cmd_args]", - description="Commands: %s"%(" ".join(self.available_names))) - parser.add_option("-r", "--registry", dest="registry", - help="root registry", metavar="URL", default=None) - parser.add_option("-s", "--sliceapi", dest="sm", default=None, metavar="URL", - help="slice API - in general a SM URL, but can be used to talk to an aggregate") - parser.add_option("-R", "--raw", dest="raw", default=None, - help="Save raw, unparsed server response to a file") - parser.add_option("", "--rawformat", dest="rawformat", type="choice", - help="raw file format ([text]|pickled|json)", default="text", - choices=("text","pickled","json")) - parser.add_option("", "--rawbanner", dest="rawbanner", default=None, - help="text string to write before and after raw output") - parser.add_option("-d", "--dir", dest="sfi_dir", - help="config & working directory - default is %default", - metavar="PATH", default=Sfi.default_sfi_dir()) - parser.add_option("-u", "--user", dest="user", - help="user name", metavar="HRN", default=None) - parser.add_option("-a", "--auth", dest="auth", - help="authority name", metavar="HRN", default=None) - parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0, - help="verbose mode - cumulative") - parser.add_option("-D", "--debug", - action="store_true", dest="debug", default=False, - help="Debug (xml-rpc) protocol messages") - # would it make sense to use ~/.ssh/id_rsa as a default here ? - parser.add_option("-k", "--private-key", - action="store", dest="user_private_key", default=None, - help="point to the private key file to use if not yet installed in sfi_dir") - parser.add_option("-t", "--timeout", dest="timeout", default=None, - help="Amout of time to wait before timing out the request") - parser.add_option("-?", "--commands", - action="store_true", dest="command_help", default=False, - help="one page summary on commands & exit") - parser.disable_interspersed_args() - return parser - - - def print_help (self): - print "==================== Generic sfi usage" - self.sfi_parser.print_help() - print "==================== Specific command usage" - self.command_parser.print_help() + # # Main: parse arguments and dispatch to command # def dispatch(self, command, command_options, command_args): - method=getattr(self, command,None) + method=getattr(self, command, None) if not method: print "Unknown command %s"%command return return method(command_options, command_args) def main(self): - self.sfi_parser = self.create_parser() + self.sfi_parser = self.create_parser_global() (options, args) = self.sfi_parser.parse_args() - if options.command_help: - self.print_command_help(options) + if options.help: + self.print_commands_help(options) sys.exit(1) self.options = options @@ -484,24 +539,28 @@ use this if you mean an authority instead""") if len(args) <= 0: self.logger.critical("No command given. Use -h for help.") - self.print_command_help(options) + self.print_commands_help(options) return -1 # complete / find unique match with command set - command_candidates = Candidates (self.available_names) + command_candidates = Candidates (commands_list) input = args[0] command = command_candidates.only_match(input) if not command: - self.print_command_help(options) + self.print_commands_help(options) sys.exit(1) # second pass options parsing - self.command_parser = self.create_command_parser(command) + self.command=command + self.command_parser = self.create_parser_command(command) (command_options, command_args) = self.command_parser.parse_args(args[1:]) + if command_options.help: + self.print_help() + sys.exit(1) self.command_options = command_options self.read_config () self.bootstrap () - self.logger.debug("Command=%s" % command) + self.logger.debug("Command=%s" % self.command) try: self.dispatch(command, command_options, command_args) @@ -527,7 +586,11 @@ use this if you mean an authority instead""") # we need to preload the sections we want parsed # from the shell config config.add_section('sfi') + # sface users should be able to use this same file to configure their stuff config.add_section('sface') + # manifold users should be able to specify the details + # of their backend server here for 'sfi myslice' + config.add_section('myslice') config.load(config_file) # back up old config shutil.move(config_file, shell_config_file) @@ -543,6 +606,7 @@ use this if you mean an authority instead""") self.logger.log_exc("Could not read config file %s"%config_file) sys.exit(1) + self.config_instance=config errors = 0 # Set SliceMgr URL if (self.options.sm is not None): @@ -584,17 +648,6 @@ use this if you mean an authority instead""") if errors: sys.exit(1) - def show_config (self): - print "From configuration file %s"%self.config_file - flags=[ - ('SFI_USER','user'), - ('SFI_AUTH','authority'), - ('SFI_SM','sm_url'), - ('SFI_REGISTRY','reg_url'), - ] - for (external_name, internal_name) in flags: - print "%s='%s'"%(external_name,getattr(self,internal_name)) - # # Get various credential and spec files # @@ -635,7 +688,7 @@ use this if you mean an authority instead""") self.private_key = client_bootstrap.private_key() self.my_credential_string = client_bootstrap.my_credential_string () self.my_credential = {'geni_type': 'geni_sfa', - 'geni_version': '3.0', + 'geni_version': '3', 'geni_value': self.my_credential_string} self.my_gid = client_bootstrap.my_gid () self.client_bootstrap = client_bootstrap @@ -655,7 +708,7 @@ use this if you mean an authority instead""") def slice_credential(self, name): return {'geni_type': 'geni_sfa', - 'geni_version': '3.0', + 'geni_version': '3', 'geni_value': self.slice_credential_string(name)} # xxx should be supported by sfaclientbootstrap as well @@ -811,15 +864,40 @@ use this if you mean an authority instead""") # Registry-related commands #========================================================================== + @register_command("","") + def config (self, options, args): + "Display contents of current config" + print "# From configuration file %s"%self.config_file + flags=[ ('sfi', [ ('registry','reg_url'), + ('auth','authority'), + ('user','user'), + ('sm','sm_url'), + ]), + ] + if options.myslice: + flags.append ( ('myslice', ['backend', 'delegate', 'platform', 'username'] ) ) + + for (section, tuples) in flags: + print "[%s]"%section + try: + for (external_name, internal_name) in tuples: + print "%-20s = %s"%(external_name,getattr(self,internal_name)) + except: + for name in tuples: + varname="%s_%s"%(section.upper(),name.upper()) + value=getattr(self.config_instance,varname) + print "%-20s = %s"%(name,value) + + @register_command("","") def version(self, options, args): """ display an SFA server version (GetVersion) -or version information about sfi itself + or version information about sfi itself """ if options.version_local: version=version_core() else: - if options.version_registry: + if options.registry_interface: server=self.registry() else: server = self.sliceapi() @@ -831,6 +909,7 @@ or version information about sfi itself pprinter = PrettyPrinter(indent=4) pprinter.pprint(version) + @register_command("authority","") def list(self, options, args): """ list entries in named authority registry (List) @@ -858,6 +937,7 @@ or version information about sfi itself save_records_to_file(options.file, list, options.fileformat) return + @register_command("name","") def show(self, options, args): """ show details about named registry record (Resolve) @@ -889,8 +969,13 @@ or version information about sfi itself save_records_to_file(options.file, record_dicts, options.fileformat) return - def add(self, options, args): - "add record into registry by using the command options (Recommended) or from xml file (Register)" + # this historically was named 'add', it is now 'register' with an alias for legacy + @register_command("[xml-filename]","",['add']) + def register(self, options, args): + """create new record in registry (Register) + from command line options (recommended) + old-school method involving an xml file still supported""" + auth_cred = self.my_authority_credential_string() if options.show_credential: show_credentials(auth_cred) @@ -921,8 +1006,11 @@ or version information about sfi itself record_dict['last_name'] = record_dict['hrn'] return self.registry().Register(record_dict, auth_cred) + @register_command("[xml-filename]","") def update(self, options, args): - "update record into registry by using the command options (Recommended) or from xml file (Update)" + """update record into registry (Update) + from command line options (recommended) + old-school method involving an xml file still supported""" record_dict = {} if len(args) > 0: record_filepath = args[0] @@ -962,6 +1050,7 @@ or version information about sfi itself show_credentials(cred) return self.registry().Update(record_dict, cred) + @register_command("hrn","") def remove(self, options, args): "remove registry record by name (Remove)" auth_cred = self.my_authority_credential_string() @@ -980,25 +1069,8 @@ or version information about sfi itself # Slice-related commands # ================================================================== - def slices(self, options, args): - "list instantiated slices (ListSlices) - returns urn's" - server = self.sliceapi() - # creds - creds = [self.my_credential_string] - # options and call_id when supported - api_options = {} - api_options['call_id']=unique_call_id() - if options.show_credential: - show_credentials(creds) - result = server.ListSlices(creds, *self.ois(server,api_options)) - value = ReturnValue.get_value(result) - if self.options.raw: - save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner) - else: - display_list(value) - return - # show rspec for named slice + @register_command("","") def resources(self, options, args): """ discover available resources (ListResources) @@ -1035,9 +1107,9 @@ or version information about sfi itself # just request the version the client wants api_options['geni_rspec_version'] = version_manager.get_version(options.rspec_version).to_dict() else: - api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'} + api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'} else: - api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'} + api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'} result = server.ListResources (creds, api_options) value = ReturnValue.get_value(result) if self.options.raw: @@ -1049,9 +1121,11 @@ or version information about sfi itself return + @register_command("slice_hrn","") def describe(self, options, args): """ - shows currently allocated/provisioned resources of the named slice or set of slivers (Describe) + shows currently allocated/provisioned resources + of the named slice or set of slivers (Describe) """ server = self.sliceapi() @@ -1064,10 +1138,13 @@ or version information about sfi itself api_options = {'call_id': unique_call_id(), 'cached': True, - 'info': options.info, + #'info': options.info, 'list_leases': options.list_leases, - 'geni_rspec_version': {'type': 'geni', 'version': '3.0'}, + 'geni_rspec_version': {'type': 'geni', 'version': '3'}, } + if options.info: + api_options['info'] = options.info + if options.rspec_version: version_manager = VersionManager() server_version = self.get_cached_server_version(server) @@ -1075,22 +1152,23 @@ or version information about sfi itself # just request the version the client wants api_options['geni_rspec_version'] = version_manager.get_version(options.rspec_version).to_dict() else: - api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'} + api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'} urn = Xrn(args[0], type='slice').get_urn() result = server.Describe([urn], creds, api_options) value = ReturnValue.get_value(result) if self.options.raw: save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner) if options.file is not None: - save_rspec_to_file(value, options.file) + save_rspec_to_file(value['geni_rspec'], options.file) if (self.options.raw is None) and (options.file is None): display_rspec(value, options.format) return + @register_command("slice_hrn [...]","") def delete(self, options, args): """ - de-allocate and de-provision all or named slivers of the slice (Delete) + de-allocate and de-provision all or named slivers of the named slice (Delete) """ server = self.sliceapi() @@ -1098,6 +1176,13 @@ or version information about sfi itself slice_hrn = args[0] slice_urn = hrn_to_urn(slice_hrn, 'slice') + if len(args) > 1: + # we have sliver urns + sliver_urns = args[1:] + else: + # we provision all the slivers of the slice + sliver_urns = [slice_urn] + # creds slice_cred = self.slice_credential(slice_hrn) creds = [slice_cred] @@ -1107,7 +1192,7 @@ or version information about sfi itself api_options ['call_id'] = unique_call_id() if options.show_credential: show_credentials(creds) - result = server.Delete([slice_urn], creds, *self.ois(server, api_options ) ) + result = server.Delete(sliver_urns, creds, *self.ois(server, api_options ) ) value = ReturnValue.get_value(result) if self.options.raw: save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner) @@ -1115,6 +1200,7 @@ or version information about sfi itself print value return value + @register_command("slice_hrn rspec","") def allocate(self, options, args): """ allocate resources to the named slice (Allocate) @@ -1145,26 +1231,47 @@ or version information about sfi itself rspec = open(rspec_file).read() api_options = {} api_options ['call_id'] = unique_call_id() + # users + sfa_users = [] + geni_users = [] + slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string]) + if slice_records and 'reg-researchers' in slice_records[0] and slice_records[0]['reg-researchers']!=[]: + slice_record = slice_records[0] + user_hrns = slice_record['reg-researchers'] + user_urns = [hrn_to_urn(hrn, 'user') for hrn in user_hrns] + user_records = self.registry().Resolve(user_urns, [self.my_credential_string]) + sfa_users = sfa_users_arg(user_records, slice_record) + geni_users = pg_users_arg(user_records) + + api_options['sfa_users'] = sfa_users + api_options['geni_users'] = geni_users + result = server.Allocate(slice_urn, creds, rspec, api_options) value = ReturnValue.get_value(result) if self.options.raw: save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner) if options.file is not None: - save_rspec_to_file (value, options.file) + save_rspec_to_file (value['geni_rspec'], options.file) if (self.options.raw is None) and (options.file is None): print value - return value + @register_command("slice_hrn [...]","") def provision(self, options, args): """ - provision already allocated resources of named slice (Provision) + provision all or named already allocated slivers of the named slice (Provision) """ server = self.sliceapi() server_version = self.get_cached_server_version(server) slice_hrn = args[0] slice_urn = Xrn(slice_hrn, type='slice').get_urn() + if len(args) > 1: + # we have sliver urns + sliver_urns = args[1:] + else: + # we provision all the slivers of the slice + sliver_urns = [slice_urn] # credentials creds = [self.slice_credential(slice_hrn)] @@ -1186,7 +1293,7 @@ or version information about sfi itself # set the requtested rspec version version_manager = VersionManager() - rspec_version = version_manager._get_version('geni', '3.0').to_dict() + rspec_version = version_manager._get_version('geni', '3').to_dict() api_options['geni_rspec_version'] = rspec_version # users @@ -1197,27 +1304,28 @@ or version information about sfi itself # }] users = [] slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string]) - if slice_records and 'researcher' in slice_records[0] and slice_records[0]['researcher']!=[]: + if slice_records and 'reg-researchers' in slice_records[0] and slice_records[0]['reg-researchers']!=[]: slice_record = slice_records[0] - user_hrns = slice_record['researcher'] + user_hrns = slice_record['reg-researchers'] user_urns = [hrn_to_urn(hrn, 'user') for hrn in user_hrns] user_records = self.registry().Resolve(user_urns, [self.my_credential_string]) users = pg_users_arg(user_records) api_options['geni_users'] = users - result = server.Provision([slice_urn], creds, api_options) + result = server.Provision(sliver_urns, creds, api_options) value = ReturnValue.get_value(result) if self.options.raw: save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner) if options.file is not None: - save_rspec_to_file (value, options.file) + save_rspec_to_file (value['geni_rspec'], options.file) if (self.options.raw is None) and (options.file is None): print value return value + @register_command("slice_hrn","") def status(self, options, args): """ - retrieve the status of the slivers belonging to tne named slice (Status) + retrieve the status of the slivers belonging to the named slice (Status) """ server = self.sliceapi() @@ -1240,18 +1348,26 @@ or version information about sfi itself save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner) else: print value + # Thierry: seemed to be missing + return value - # reset named slice + @register_command("slice_hrn [...] action","") def action(self, options, args): """ - Perform the named operational action on the named slivers + Perform the named operational action on all or named slivers of the named slice """ server = self.sliceapi() api_options = {} # slice urn slice_hrn = args[0] - action = args[1] - slice_urn = Xrn(slice_hrn, type='slice').get_urn() + slice_urn = Xrn(slice_hrn, type='slice').get_urn() + if len(args) > 2: + # we have sliver urns + sliver_urns = args[1:-1] + else: + # we provision all the slivers of the slice + sliver_urns = [slice_urn] + action = args[-1] # cred slice_cred = self.slice_credential(args[0]) creds = [slice_cred] @@ -1259,7 +1375,7 @@ or version information about sfi itself delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority)) creds.append(delegated_cred) - result = server.PerformOperationalAction([slice_urn], creds, action , api_options) + result = server.PerformOperationalAction(sliver_urns, creds, action , api_options) value = ReturnValue.get_value(result) if self.options.raw: save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner) @@ -1267,17 +1383,26 @@ or version information about sfi itself print value return value + @register_command("slice_hrn [...] time","") def renew(self, options, args): """ - renew slice (RenewSliver) + renew slice (Renew) """ server = self.sliceapi() - if len(args) != 2: + if len(args) < 2: self.print_help() sys.exit(1) - [ slice_hrn, input_time ] = args - # slice urn - slice_urn = hrn_to_urn(slice_hrn, 'slice') + slice_hrn = args[0] + slice_urn = Xrn(slice_hrn, type='slice').get_urn() + + if len(args) > 2: + # we have sliver urns + sliver_urns = args[1:-1] + else: + # we provision all the slivers of the slice + sliver_urns = [slice_urn] + input_time = args[-1] + # time: don't try to be smart on the time format, server-side will # creds slice_cred = self.slice_credential(args[0]) @@ -1287,7 +1412,7 @@ or version information about sfi itself api_options['call_id']=unique_call_id() if options.show_credential: show_credentials(creds) - result = server.Renew([slice_urn], creds, input_time, *self.ois(server,api_options)) + result = server.Renew(sliver_urns, creds, input_time, *self.ois(server,api_options)) value = ReturnValue.get_value(result) if self.options.raw: save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner) @@ -1296,6 +1421,7 @@ or version information about sfi itself return value + @register_command("slice_hrn","") def shutdown(self, options, args): """ shutdown named slice (Shutdown) @@ -1316,6 +1442,7 @@ or version information about sfi itself return value + @register_command("[name]","") def gid(self, options, args): """ Create a GID (CreateGid) @@ -1333,10 +1460,25 @@ or version information about sfi itself self.logger.info("writing %s gid to %s" % (target_hrn, filename)) GID(string=gid).save_to_file(filename) - + #################### + @register_command("to_hrn","""$ sfi delegate -u -p -s ple.inria.heartbeat -s ple.inria.omftest ple.upmc.slicebrowser + + will locally create a set of delegated credentials for the benefit of ple.upmc.slicebrowser + the set of credentials in the scope for this call would be + (*) ple.inria.thierry_parmentelat.user_for_ple.upmc.slicebrowser.user.cred + as per -u/--user + (*) ple.inria.pi_for_ple.upmc.slicebrowser.user.cred + as per -p/--pi + (*) ple.inria.heartbeat.slice_for_ple.upmc.slicebrowser.user.cred + (*) ple.inria.omftest.slice_for_ple.upmc.slicebrowser.user.cred + because of the two -s options + +""") def delegate (self, options, args): """ (locally) create delegate credential for use by given hrn + make sure to check for 'sfi myslice' instead if you plan + on using MySlice """ if len(args) != 1: self.print_help() @@ -1380,18 +1522,165 @@ or version information about sfi itself delegated_credential.save_to_file(filename, save_parents=True) self.logger.info("delegated credential for %s to %s and wrote to %s"%(message,to_hrn,filename)) + #################### + @register_command("","""$ less +/myslice sfi_config +[myslice] +backend = http://manifold.pl.sophia.inria.fr:7080 +# the HRN that myslice uses, so that we are delegating to +delegate = ple.upmc.slicebrowser +# platform - this is a myslice concept +platform = ple +# username - as of this writing (May 2013) a simple login name +username = thierry + +$ sfi myslice + will first collect the slices that you are part of, then make sure + all your credentials are up-to-date (read: refresh expired ones) + then compute delegated credentials for user 'ple.upmc.slicebrowser' + and upload them all on myslice backend, using 'platform' and 'user'. + A password will be prompted for the upload part. + +$ sfi -v myslice -- or sfi -vv myslice + same but with more and more verbosity + +$ sfi m -b http://mymanifold.foo.com:7080/ + is synonym to sfi myslice as no other command starts with an 'm' + and uses a custom backend for this one call +""" +) # register_command + def myslice (self, options, args): + + """ This helper is for refreshing your credentials at myslice; it will + * compute all the slices that you currently have credentials on + * refresh all your credentials (you as a user and pi, your slices) + * upload them to the manifold backend server + for last phase, sfi_config is read to look for the [myslice] section, + and namely the 'backend', 'delegate' and 'user' settings""" + + ########## + if len(args)>0: + self.print_help() + sys.exit(1) + # enable info by default + self.logger.setLevelFromOptVerbose(self.options.verbose+1) + ### the rough sketch goes like this + # (0) produce a p12 file + self.client_bootstrap.my_pkcs12() + + # (a) rain check for sufficient config in sfi_config + myslice_dict={} + myslice_keys=[ 'backend', 'delegate', 'platform', 'username'] + for key in myslice_keys: + value=None + # oct 2013 - I'm finding myself juggling with config files + # so a couple of command-line options can now override config + if hasattr(options,key) and getattr(options,key) is not None: + value=getattr(options,key) + else: + full_key="MYSLICE_" + key.upper() + value=getattr(self.config_instance,full_key,None) + if value: myslice_dict[key]=value + else: print "Unsufficient config, missing key %s in [myslice] section of sfi_config"%key + if len(myslice_dict) != len(myslice_keys): + sys.exit(1) + + # (b) figure whether we are PI for the authority where we belong + self.logger.info("Resolving our own id %s"%self.user) + my_records=self.registry().Resolve(self.user,self.my_credential_string) + if len(my_records)!=1: print "Cannot Resolve %s -- exiting"%self.user; sys.exit(1) + my_record=my_records[0] + my_auths_all = my_record['reg-pi-authorities'] + self.logger.info("Found %d authorities that we are PI for"%len(my_auths_all)) + self.logger.debug("They are %s"%(my_auths_all)) + + my_auths = my_auths_all + if options.delegate_auths: + my_auths = list(set(my_auths_all).intersection(set(options.delegate_auths))) + self.logger.debug("Restricted to user-provided auths"%(my_auths)) + + # (c) get the set of slices that we are in + my_slices_all=my_record['reg-slices'] + self.logger.info("Found %d slices that we are member of"%len(my_slices_all)) + self.logger.debug("They are: %s"%(my_slices_all)) + + my_slices = my_slices_all + # if user provided slices, deal only with these - if they are found + if options.delegate_slices: + my_slices = list(set(my_slices_all).intersection(set(options.delegate_slices))) + self.logger.debug("Restricted to user-provided slices: %s"%(my_slices)) + + # (d) make sure we have *valid* credentials for all these + hrn_credentials=[] + hrn_credentials.append ( (self.user, 'user', self.my_credential_string,) ) + for auth_hrn in my_auths: + hrn_credentials.append ( (auth_hrn, 'auth', self.authority_credential_string(auth_hrn),) ) + for slice_hrn in my_slices: + hrn_credentials.append ( (slice_hrn, 'slice', self.slice_credential_string (slice_hrn),) ) + + # (e) check for the delegated version of these + # xxx todo add an option -a/-A? like for 'sfi delegate' for when we ever + # switch to myslice using an authority instead of a user + delegatee_type='user' + delegatee_hrn=myslice_dict['delegate'] + hrn_delegated_credentials = [] + for (hrn, htype, credential) in hrn_credentials: + delegated_credential = self.client_bootstrap.delegate_credential_string (credential, delegatee_hrn, delegatee_type) + # save these so user can monitor what she's uploaded + filename = os.path.join ( self.options.sfi_dir, + "%s.%s_for_%s.%s.cred"%(hrn,htype,delegatee_hrn,delegatee_type)) + with file(filename,'w') as f: + f.write(delegated_credential) + self.logger.debug("(Over)wrote %s"%filename) + hrn_delegated_credentials.append ((hrn, htype, delegated_credential, filename, )) + + # (f) and finally upload them to manifold server + # xxx todo add an option so the password can be set on the command line + # (but *NOT* in the config file) so other apps can leverage this + self.logger.info("Uploading on backend at %s"%myslice_dict['backend']) + uploader = ManifoldUploader (logger=self.logger, + url=myslice_dict['backend'], + platform=myslice_dict['platform'], + username=myslice_dict['username'], + password=options.password) + uploader.prompt_all() + (count_all,count_success)=(0,0) + for (hrn,htype,delegated_credential,filename) in hrn_delegated_credentials: + # inspect + inspect=Credential(string=delegated_credential) + expire_datetime=inspect.get_expiration() + message="%s (%s) [exp:%s]"%(hrn,htype,expire_datetime) + if uploader.upload(delegated_credential,message=message): + count_success+=1 + count_all+=1 + self.logger.info("Successfully uploaded %d/%d credentials"%(count_success,count_all)) + + # at first I thought we would want to save these, + # like 'sfi delegate does' but on second thought + # it is probably not helpful as people would not + # need to run 'sfi delegate' at all anymore + if count_success != count_all: sys.exit(1) + return + + @register_command("cred","") def trusted(self, options, args): """ - return uhe trusted certs at this interface (get_trusted_certs) + return the trusted certs at this interface (get_trusted_certs) """ - trusted_certs = self.registry().get_trusted_certs() + if options.registry_interface: + server=self.registry() + else: + server = self.sliceapi() + cred = self.my_authority_credential_string() + trusted_certs = server.get_trusted_certs(cred) + if not options.registry_interface: + trusted_certs = ReturnValue.get_value(trusted_certs) + for trusted_cert in trusted_certs: + print "\n===========================================================\n" gid = GID(string=trusted_cert) gid.dump() cert = Certificate(string=trusted_cert) self.logger.debug('Sfi.trusted -> %r'%cert.get_subject()) + print "Certificate:\n%s\n\n"%trusted_cert return - def config (self, options, args): - "Display contents of current config" - self.show_config()