X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=sfa%2Fclient%2Fsfi.py;h=c9bde73af92981745035ea9641ebda3f0ecf16e1;hb=935de64c2ed3a68566da471c68447a1ac384455d;hp=726138f84ceb10bfe6c513d08443e4aff75f042a;hpb=80d9d19e3769b69b92a5cba94013330c1c66c557;p=sfa.git diff --git a/sfa/client/sfi.py b/sfa/client/sfi.py old mode 100755 new mode 100644 index 726138f8..c9bde73a --- a/sfa/client/sfi.py +++ b/sfa/client/sfi.py @@ -1,35 +1,38 @@ -#! /usr/bin/env python -# sfi -- slice-based facility interface +# xxx NOTE this will soon be reviewed to take advantage of sfaclientlib import sys sys.path.append('.') + import os, os.path -import tempfile -import traceback import socket -import random import datetime -import zlib import codecs +import pickle from lxml import etree from StringIO import StringIO -from types import StringTypes, ListType from optparse import OptionParser -from sfa.util.sfalogging import sfi_logger from sfa.trust.certificate import Keypair, Certificate from sfa.trust.gid import GID from sfa.trust.credential import Credential -from sfa.util.sfaticket import SfaTicket -from sfa.util.record import SfaRecord, UserRecord, SliceRecord, NodeRecord, AuthorityRecord -from sfa.util.xrn import Xrn, get_leaf, get_authority, hrn_to_urn -import sfa.util.xmlrpcprotocol as xmlrpcprotocol +from sfa.trust.sfaticket import SfaTicket + +from sfa.util.sfalogging import sfi_logger +from sfa.util.xrn import get_leaf, get_authority, hrn_to_urn from sfa.util.config import Config from sfa.util.version import version_core from sfa.util.cache import Cache -from sfa.rspecs.rspec_version import RSpecVersion -from sfa.rspecs.pg_rspec import pg_rspec_request_version + +from sfa.storage.record import SfaRecord, UserRecord, SliceRecord, NodeRecord, AuthorityRecord + +from sfa.rspecs.rspec import RSpec +from sfa.rspecs.rspec_converter import RSpecConverter +from sfa.rspecs.version_manager import VersionManager +from sfa.client.return_value import ReturnValue + +from sfa.client.sfaserverproxy import SfaServerProxy, ServerException +from sfa.client.client_helper import pg_users_arg, sfa_users_arg AGGREGATE_PORT=12346 CM_PORT=12346 @@ -80,6 +83,17 @@ def filter_records(type, records): # save methods +def save_variable_to_file(var, filename, format="text"): + f = open(filename, "w") + if format == "text": + f.write(str(var)) + elif format == "pickled": + f.write(pickle.dumps(var)) + else: + # this should never happen + print "unknown output format", format + + def save_rspec_to_file(rspec, filename): if not filename.endswith(".rspec"): filename = filename + ".rspec" @@ -88,14 +102,32 @@ def save_rspec_to_file(rspec, filename): f.close() return -def save_records_to_file(filename, recordList): - index = 0 - for record in recordList: - if index > 0: - save_record_to_file(filename + "." + str(index), record) - else: - save_record_to_file(filename, record) - index = index + 1 +def save_records_to_file(filename, recordList, format="xml"): + if format == "xml": + index = 0 + for record in recordList: + if index > 0: + save_record_to_file(filename + "." + str(index), record) + else: + save_record_to_file(filename, record) + index = index + 1 + elif format == "xmllist": + f = open(filename, "w") + f.write("\n") + for record in recordList: + record = SfaRecord(dict=record) + f.write('\n') + f.write("\n") + f.close() + elif format == "hrnlist": + f = open(filename, "w") + for record in recordList: + record = SfaRecord(dict=record) + f.write(record.get_name() + "\n") + f.close() + else: + # this should never happen + print "unknown output format", format def save_record_to_file(filename, record): if record['type'] in ['user']: @@ -131,6 +163,13 @@ class Sfi: required_options=['verbose', 'debug', 'registry', 'sm', 'auth', 'user'] + @staticmethod + def default_sfi_dir (): + if os.path.isfile("./sfi_config"): + return os.getcwd() + else: + return os.path.expanduser("~/.sfi/") + # dummy to meet Sfi's expectations for its 'options' field # i.e. s/t we can do setattr on class DummyOptions: @@ -140,10 +179,7 @@ class Sfi: if options is None: options=Sfi.DummyOptions() for opt in Sfi.required_options: if not hasattr(options,opt): setattr(options,opt,None) - if not hasattr(options,'sfi_dir'): options.sfi_dir=os.path.expanduser("~/.sfi/") - # xxx oops, this is dangerous, sounds like ww sometimes have discrepency - # would be safer to remove self.sfi_dir altogether - self.sfi_dir = options.sfi_dir + if not hasattr(options,'sfi_dir'): options.sfi_dir=Sfi.default_sfi_dir() self.options = options self.slicemgr = None self.registry = None @@ -152,46 +188,68 @@ class Sfi: self.hashrequest = False self.logger = sfi_logger self.logger.enable_console() + self.available_names = [ tuple[0] for tuple in Sfi.available ] + self.available_dict = dict (Sfi.available) - def create_cmd_parser(self, command, additional_cmdargs=None): - cmdargs = {"list": "authority", - "show": "name", - "remove": "name", - "add": "record", - "update": "record", - "aggregates": "[name]", - "registries": "[name]", - "create_gid": "[name]", - "get_gid": [], - "get_trusted_certs": "cred", - "slices": "", - "resources": "[name]", - "create": "name rspec", - "get_ticket": "name rspec", - "redeem_ticket": "ticket", - "delete": "name", - "reset": "name", - "start": "name", - "stop": "name", - "delegate": "name", - "status": "name", - "renew": "name", - "shutdown": "name", - "version": "", - } - - if additional_cmdargs: - cmdargs.update(additional_cmdargs) - - if command not in cmdargs: + # 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"), + ("slices", ""), + ("resources", "[slice_hrn]"), + ("create", "slice_hrn rspec"), + ("delete", "slice_hrn"), + ("status", "slice_hrn"), + ("start", "slice_hrn"), + ("stop", "slice_hrn"), + ("reset", "slice_hrn"), + ("renew", "slice_hrn time"), + ("shutdown", "slice_hrn"), + ("get_ticket", "slice_hrn rspec"), + ("redeem_ticket", "ticket"), + ("delegate", "name"), + ("create_gid", "[name]"), + ("get_trusted_certs", "cred"), + ] + + def print_command_help (self, options): + verbose=getattr(options,'verbose') + format3="%18s %-15s %s" + 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*' ') + if verbose: + print line + print format3%(command,args,doc) + if verbose: + self.create_cmd_parser(command).print_help() + + def create_cmd_parser(self, command): + if command not in self.available_dict: msg="Invalid command\n" msg+="Commands: " - msg += ','.join(cmdargs.keys()) + msg += ','.join(self.available_names) self.logger.critical(msg) sys.exit(2) - parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \ - % (command, cmdargs[command])) + parser = OptionParser(usage="sfi [sfi_options] %s [cmd_options] %s" \ + % (command, self.available_dict[command])) # user specifies remote aggregate/sm/component if command in ("resources", "slices", "create", "delete", "start", "stop", @@ -205,9 +263,9 @@ class Sfi: parser.add_option("-d", "--delegate", dest="delegate", default=None, action="store_true", help="Include a credential delegated to the user's root"+\ - "authority in set of credentials for this call") - - # registy filter option + "authority in set of credentials for this call") + + # registy filter option if command in ("list", "show", "remove"): parser.add_option("-t", "--type", dest="type", type="choice", help="type filter ([all]|user|slice|authority|node|aggregate)", @@ -229,12 +287,23 @@ class Sfi: if command in ("resources", "show", "list", "create_gid", 'create'): parser.add_option("-o", "--output", dest="file", help="output XML to file", metavar="FILE", default=None) - + if command in ("show", "list"): parser.add_option("-f", "--format", dest="format", type="choice", help="display format ([text]|xml)", default="text", choices=("text", "xml")) + parser.add_option("-F", "--fileformat", dest="fileformat", type="choice", + help="output file format ([xml]|xmllist|hrnlist)", default="xml", + choices=("xml", "xmllist", "hrnlist")) + + if command in ("status", "version"): + parser.add_option("-o", "--output", dest="file", + help="output dictionary to file", metavar="FILE", default=None) + parser.add_option("-F", "--fileformat", dest="fileformat", type="choice", + help="output file format ([text]|pickled)", default="text", + choices=("text","pickled")) + if command in ("delegate"): parser.add_option("-u", "--user", action="store_true", dest="delegate_user", default=False, @@ -260,16 +329,15 @@ class Sfi: def create_parser(self): # Generate command line parser - parser = OptionParser(usage="sfi [options] command [command_options] [command_args]", - description="Commands: gid,list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset") + 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", "--slicemgr", dest="sm", help="slice manager", metavar="URL", default=None) - default_sfi_dir = os.path.expanduser("~/.sfi/") parser.add_option("-d", "--dir", dest="sfi_dir", - help="config & working directory - default is " + default_sfi_dir, - metavar="PATH", default=default_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", @@ -285,12 +353,64 @@ class Sfi: action="store_true", dest="hashrequest", default=False, help="Create a hash of the request that will be authenticated on the server") parser.add_option("-t", "--timeout", dest="timeout", default=None, - help="Amout of time tom wait before timing out the request") + 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): + self.sfi_parser.print_help() + self.cmd_parser.print_help() + + # + # Main: parse arguments and dispatch to command + # + def dispatch(self, command, cmd_opts, cmd_args): + return getattr(self, command)(cmd_opts, cmd_args) + + def main(self): + self.sfi_parser = self.create_parser() + (options, args) = self.sfi_parser.parse_args() + if options.command_help: + self.print_command_help(options) + sys.exit(1) + self.options = options + + self.logger.setLevelFromOptVerbose(self.options.verbose) + if options.hashrequest: + self.hashrequest = True + + if len(args) <= 0: + self.logger.critical("No command given. Use -h for help.") + self.print_command_help(options) + return -1 + + command = args[0] + self.cmd_parser = self.create_cmd_parser(command) + (cmd_opts, cmd_args) = self.cmd_parser.parse_args(args[1:]) + + self.set_servers() + self.logger.info("Command=%s" % command) + if command in ("resources"): + self.logger.debug("resources cmd_opts %s" % cmd_opts.format) + elif command in ("list", "show", "remove"): + self.logger.debug("cmd_opts.type %s" % cmd_opts.type) + self.logger.debug('cmd_args %s' % cmd_args) + + try: + self.dispatch(command, cmd_opts, cmd_args) + except KeyError: + self.logger.critical ("Unknown command %s"%command) + raise + sys.exit(1) + + return + + #################### def read_config(self): config_file = os.path.join(self.options.sfi_dir,"sfi_config") try: @@ -355,14 +475,13 @@ class Sfi: # Get key and certificate key_file = self.get_key_file() cert_file = self.get_cert_file(key_file) - self.key = Keypair(filename=key_file) self.key_file = key_file self.cert_file = cert_file self.cert = GID(filename=cert_file) self.logger.info("Contacting Registry at: %s"%self.reg_url) - self.registry = xmlrpcprotocol.get_server(self.reg_url, key_file, cert_file, timeout=self.options.timeout, verbose=self.options.debug) + self.registry = SfaServerProxy(self.reg_url, key_file, cert_file, timeout=self.options.timeout, verbose=self.options.debug) self.logger.info("Contacting Slice Manager at: %s"%self.sm_url) - self.slicemgr = xmlrpcprotocol.get_server(self.sm_url, key_file, cert_file, timeout=self.options.timeout, verbose=self.options.debug) + self.slicemgr = SfaServerProxy(self.sm_url, key_file, cert_file, timeout=self.options.timeout, verbose=self.options.debug) return def get_cached_server_version(self, server): @@ -379,35 +498,35 @@ class Sfi: if cache: version = cache.get(cache_key) - + if not version: - version = server.GetVersion() + result = server.GetVersion() + version= ReturnValue.get_value(result) # cache version for 24 hours cache.add(cache_key, version, ttl= 60*60*24) self.logger.info("Updating cache file %s" % cache_file) cache.save_to_file(cache_file) - return version - def server_supports_call_id_arg(self, server): + def server_supports_options_arg(self, server): """ Returns true if server support the optional call_id arg, false otherwise. """ server_version = self.get_cached_server_version(server) - if 'sfa' in server_version: + if 'sfa' in server_version and 'code_tag' in server_version: code_tag = server_version['code_tag'] code_tag_parts = code_tag.split("-") version_parts = code_tag_parts[0].split(".") major, minor = version_parts[0], version_parts[1] rev = code_tag_parts[1] - if int(major) > 1: - if int(minor) > 0 or int(rev) > 20: + if int(major) >= 1: + if int(minor) >= 2: return True return False - + # # Get various credential and spec files # @@ -454,8 +573,9 @@ class Sfi: try: self.logger.info("Getting Registry issued cert") self.read_config() - # *hack. need to set registyr before _get_gid() is called - self.registry = xmlrpcprotocol.get_server(self.reg_url, key_file, cert_file, timeout=self.options.timeout, verbose=self.options.debug) + # *hack. need to set registry before _get_gid() is called + self.registry = SfaServerProxy(self.reg_url, key_file, cert_file, + timeout=self.options.timeout, verbose=self.options.debug) gid = self._get_gid(type='user') self.registry = None self.logger.info("Writing certificate to %s"%cert_file) @@ -474,17 +594,16 @@ class Sfi: gid = GID(filename=file) return gid - # xxx opts unused - def get_gid(self, opts, args): - """ - Get the specify gid and save it to file - """ - hrn = None - if args: - hrn = args[0] - gid = self._get_gid(hrn) - self.logger.debug("Sfi.get_gid-> %s",gid.save_to_string(save_parents=True)) - return gid +# seems useless +# # xxx opts unused +# def get_gid(self, opts, args): +# """ Get the specify gid and save it to file """ +# hrn = None +# if args: +# hrn = args[0] +# gid = self._get_gid(hrn) +# self.logger.debug("Sfi.get_gid-> %s" % gid.save_to_string(save_parents=True)) +# return gid def _get_gid(self, hrn=None, type=None): """ @@ -495,7 +614,6 @@ class Sfi: hrn = self.user gidfile = os.path.join(self.options.sfi_dir, hrn + ".gid") - print gidfile gid = self.get_cached_gid(gidfile) if not gid: user_cred = self.get_user_cred() @@ -571,6 +689,30 @@ class Sfi: return cred + def delegate_cred(self, object_cred, hrn): + # the gid and hrn of the object we are delegating + if isinstance(object_cred, str): + object_cred = Credential(string=object_cred) + object_gid = object_cred.get_gid_object() + object_hrn = object_gid.get_hrn() + + if not object_cred.get_privileges().get_all_delegate(): + self.logger.error("Object credential %s does not have delegate bit set"%object_hrn) + return + + # the delegating user's gid + caller_gid = self._get_gid(self.user) + caller_gidfile = os.path.join(self.options.sfi_dir, self.user + ".gid") + + # the gid of the user who will be delegated to + delegee_gid = self._get_gid(hrn) + delegee_hrn = delegee_gid.get_hrn() + delegee_gidfile = os.path.join(self.options.sfi_dir, delegee_hrn + ".gid") + delegee_gid.save_to_file(filename=delegee_gidfile) + dcred = object_cred.delegate(delegee_gidfile, self.get_key_file(), caller_gidfile) + return dcred.save_to_string(save_parents=True) + + ######################################## miscell utilities def get_rspec_file(self, rspec): if (os.path.isabs(rspec)): file = rspec @@ -593,23 +735,8 @@ class Sfi: self.logger.critical("No such registry record file %s"%record) sys.exit(1) - def load_publickey_string(self, fn): - f = file(fn, "r") - key_string = f.read() - - # if the filename is a private key file, then extract the public key - if "PRIVATE KEY" in key_string: - outfn = tempfile.mktemp() - cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn - os.system(cmd) - f = file(outfn, "r") - key_string = f.read() - os.remove(outfn) - - return key_string - # xxx opts undefined - def get_component_server_from_hrn(self, hrn): + def get_component_proxy_from_hrn(self, hrn): # direct connection to the nodes component manager interface user_cred = self.get_user_cred().save_to_string(save_parents=True) records = self.registry.Resolve(hrn, user_cred) @@ -618,9 +745,9 @@ class Sfi: self.logger.warning("No such component:%r"% opts.component) record = records[0] - return self.get_server(record['hostname'], CM_PORT, self.key_file, self.cert_file) + return self.server_proxy(record['hostname'], CM_PORT, self.key_file, self.cert_file) - def get_server(self, host, port, keyfile, certfile): + def server_proxy(self, host, port, keyfile, certfile): """ Return an instance of an xmlrpc server connection """ @@ -629,10 +756,11 @@ class Sfi: host_parts = host.split('/') host_parts[0] = host_parts[0] + ":" + str(port) url = "http://%s" % "/".join(host_parts) - return xmlrpcprotocol.get_server(url, keyfile, certfile, timeout=self.options.timeout, verbose=self.options.debug) + return SfaServerProxy(url, keyfile, certfile, timeout=self.options.timeout, + verbose=self.options.debug) # xxx opts could be retrieved in self.options - def get_server_from_opts(self, opts): + def server_proxy_from_opts(self, opts): """ Return instance of an xmlrpc connection to a slice manager, aggregate or component server depending on the specified opts @@ -640,10 +768,10 @@ class Sfi: server = self.slicemgr # direct connection to an aggregate if hasattr(opts, 'aggregate') and opts.aggregate: - server = self.get_server(opts.aggregate, opts.port, self.key_file, self.cert_file) + server = self.server_proxy(opts.aggregate, opts.port, self.key_file, self.cert_file) # direct connection to the nodes component manager interface if hasattr(opts, 'component') and opts.component: - server = self.get_component_server_from_hrn(opts.component) + server = self.get_component_proxy_from_hrn(opts.component) return server #========================================================================== @@ -652,26 +780,29 @@ class Sfi: # Registry-related commands #========================================================================== - def dispatch(self, command, cmd_opts, cmd_args): - return getattr(self, command)(cmd_opts, cmd_args) - - def create_gid(self, opts, args): - if len(args) < 1: - self.print_help() - sys.exit(1) - target_hrn = args[0] - user_cred = self.get_user_cred().save_to_string(save_parents=True) - gid = self.registry.CreateGid(user_cred, target_hrn, self.cert.save_to_string()) - if opts.file: - filename = opts.file + def version(self, opts, args): + """ + display an SFA server version (GetVersion) +or version information about sfi itself + """ + if opts.version_local: + version=version_core() else: - filename = os.sep.join([self.sfi_dir, '%s.gid' % target_hrn]) - self.logger.info("writing %s gid to %s" % (target_hrn, filename)) - GID(string=gid).save_to_file(filename) - - - # list entires in named authority registry + if opts.version_registry: + server=self.registry + else: + server = self.server_proxy_from_opts(opts) + result = server.GetVersion() + version = ReturnValue.get_value(result) + for (k,v) in version.iteritems(): + print "%-20s: %s"%(k,v) + if opts.file: + save_variable_to_file(version, opts.file, opts.fileformat) + def list(self, opts, args): + """ + list entries in named authority registry (List) + """ if len(args)!= 1: self.print_help() sys.exit(1) @@ -681,28 +812,29 @@ class Sfi: list = self.registry.List(hrn, user_cred) except IndexError: raise Exception, "Not enough parameters for the 'list' command" - - # filter on person, slice, site, node, etc. + + # filter on person, slice, site, node, etc. # THis really should be in the self.filter_records funct def comment... list = filter_records(opts.type, list) for record in list: - print "%s (%s)" % (record['hrn'], record['type']) + print "%s (%s)" % (record['hrn'], record['type']) if opts.file: - save_records_to_file(opts.file, list) + save_records_to_file(opts.file, list, opts.fileformat) return - # show named registry record def show(self, opts, args): + """ + show details about named registry record (Resolve) + """ if len(args)!= 1: self.print_help() sys.exit(1) hrn = args[0] user_cred = self.get_user_cred().save_to_string(save_parents=True) records = self.registry.Resolve(hrn, user_cred) - print records records = filter_records(opts.type, records) if not records: - print "No record of type", opts.type + self.logger.error("No record of type %s"% opts.type) for record in records: if record['type'] in ['user']: record = UserRecord(dict=record) @@ -719,72 +851,11 @@ class Sfi: else: print record.save_to_string() if opts.file: - save_records_to_file(opts.file, records) + save_records_to_file(opts.file, records, opts.fileformat) return - def delegate(self, opts, args): - - delegee_hrn = args[0] - if opts.delegate_user: - user_cred = self.get_user_cred() - cred = self.delegate_cred(user_cred, delegee_hrn) - elif opts.delegate_slice: - slice_cred = self.get_slice_cred(opts.delegate_slice) - cred = self.delegate_cred(slice_cred, delegee_hrn) - else: - self.logger.warning("Must specify either --user or --slice ") - return - delegated_cred = Credential(string=cred) - object_hrn = delegated_cred.get_gid_object().get_hrn() - if opts.delegate_user: - dest_fn = os.path.join(self.options.sfi_dir, get_leaf(delegee_hrn) + "_" - + get_leaf(object_hrn) + ".cred") - elif opts.delegate_slice: - dest_fn = os.path.join(self.options.sfi_dir, get_leaf(delegee_hrn) + "_slice_" - + get_leaf(object_hrn) + ".cred") - - delegated_cred.save_to_file(dest_fn, save_parents=True) - - self.logger.info("delegated credential for %s to %s and wrote to %s"%(object_hrn, delegee_hrn,dest_fn)) - - def delegate_cred(self, object_cred, hrn): - # the gid and hrn of the object we are delegating - if isinstance(object_cred, str): - object_cred = Credential(string=object_cred) - object_gid = object_cred.get_gid_object() - object_hrn = object_gid.get_hrn() - - if not object_cred.get_privileges().get_all_delegate(): - self.logger.error("Object credential %s does not have delegate bit set"%object_hrn) - return - - # the delegating user's gid - caller_gid = self._get_gid(self.user) - caller_gidfile = os.path.join(self.options.sfi_dir, self.user + ".gid") - - # the gid of the user who will be delegated to - delegee_gid = self._get_gid(hrn) - delegee_hrn = delegee_gid.get_hrn() - delegee_gidfile = os.path.join(self.options.sfi_dir, delegee_hrn + ".gid") - delegee_gid.save_to_file(filename=delegee_gidfile) - dcred = object_cred.delegate(delegee_gidfile, self.get_key_file(), caller_gidfile) - return dcred.save_to_string(save_parents=True) - - # removed named registry record - # - have to first retrieve the record to be removed - def remove(self, opts, args): - auth_cred = self.get_auth_cred().save_to_string(save_parents=True) - if len(args)!=1: - self.print_help() - sys.exit(1) - hrn = args[0] - type = opts.type - if type in ['all']: - type = '*' - return self.registry.Remove(hrn, auth_cred, type) - - # add named registry record def add(self, opts, args): + "add record into registry from xml file (Register)" auth_cred = self.get_auth_cred().save_to_string(save_parents=True) if len(args)!=1: self.print_help() @@ -794,8 +865,8 @@ class Sfi: record = load_record_from_file(rec_file).as_dict() return self.registry.Register(record, auth_cred) - # update named registry entry def update(self, opts, args): + "update record into registry from xml file (Update)" user_cred = self.get_user_cred() if len(args)!=1: self.print_help() @@ -810,7 +881,7 @@ class Sfi: elif record['type'] in ["slice"]: try: cred = self.get_slice_cred(record.get_name()).save_to_string(save_parents=True) - except xmlrpcprotocol.ServerException, e: + except ServerException, e: # XXX smbaker -- once we have better error return codes, update this # to do something better than a string compare if "Permission error" in e.args[0]: @@ -826,236 +897,169 @@ class Sfi: record = record.as_dict() return self.registry.Update(record, cred) - def get_trusted_certs(self, opts, args): - """ - return uhe trusted certs at this interface - """ - trusted_certs = self.registry.get_trusted_certs() - for trusted_cert in trusted_certs: - gid = GID(string=trusted_cert) - gid.dump() - cert = Certificate(string=trusted_cert) - self.logger.debug('Sfi.get_trusted_certs -> %r'%cert.get_subject()) - return - - def aggregates(self, opts, args): - """ - return a list of details about known aggregates - """ - user_cred = self.get_user_cred().save_to_string(save_parents=True) - hrn = None - if args: - hrn = args[0] - - result = self.registry.get_aggregates(user_cred, hrn) - display_list(result) - return - - def registries(self, opts, args): - """ - return a list of details about known registries - """ - user_cred = self.get_user_cred().save_to_string(save_parents=True) - hrn = None - if args: - hrn = args[0] - result = self.registry.get_registries(user_cred, hrn) - display_list(result) - return - - + def remove(self, opts, args): + "remove registry record by name (Remove)" + auth_cred = self.get_auth_cred().save_to_string(save_parents=True) + if len(args)!=1: + self.print_help() + sys.exit(1) + hrn = args[0] + type = opts.type + if type in ['all']: + type = '*' + return self.registry.Remove(hrn, auth_cred, type) + # ================================================================== # Slice-related commands # ================================================================== - def version(self, opts, args): - if opts.version_local: - version=version_core() - else: - if opts.version_registry: - server=self.registry - else: - server = self.get_server_from_opts(opts) - version=server.GetVersion() - for (k,v) in version.iteritems(): - print "%-20s: %s"%(k,v) - - # list instantiated slices def slices(self, opts, args): - """ - list instantiated slices - """ + "list instantiated slices (ListSlices) - returns urn's" user_cred = self.get_user_cred().save_to_string(save_parents=True) creds = [user_cred] if opts.delegate: delegated_cred = self.delegate_cred(user_cred, get_authority(self.authority)) creds.append(delegated_cred) - server = self.get_server_from_opts(opts) - #results = server.ListSlices(creds, unique_call_id()) - results = server.ListSlices(creds) - display_list(results) + server = self.server_proxy_from_opts(opts) + call_args = [creds] + if self.server_supports_options_arg(server): + options = {'call_id': unique_call_id()} + call_args.append(options) + result = server.ListSlices(*call_args) + value = ReturnValue.get_value(result) + display_list(value) return # show rspec for named slice def resources(self, opts, args): + """ + with no arg, discover available resources, +or currently provisioned resources (ListResources) + """ user_cred = self.get_user_cred().save_to_string(save_parents=True) - server = self.slicemgr - call_options = {} - server = self.get_server_from_opts(opts) + server = self.server_proxy_from_opts(opts) + + options = {'call_id': unique_call_id()} + #panos add info options + if opts.info: + options['info'] = opts.info if args: cred = self.get_slice_cred(args[0]).save_to_string(save_parents=True) hrn = args[0] - call_options = {'geni_slice_urn': hrn_to_urn(hrn, 'slice')} + options['geni_slice_urn'] = hrn_to_urn(hrn, 'slice') else: cred = user_cred - hrn = None creds = [cred] if opts.delegate: delegated_cred = self.delegate_cred(cred, get_authority(self.authority)) creds.append(delegated_cred) if opts.rspec_version: + version_manager = VersionManager() server_version = self.get_cached_server_version(server) if 'sfa' in server_version: # just request the version the client wants - call_options['rspec_version'] = dict(RSpecVersion(opts.rspec_version)) + options['geni_rspec_version'] = version_manager.get_version(opts.rspec_version).to_dict() else: # this must be a protogeni aggregate. We should request a v2 ad rspec # regardless of what the client user requested - call_options['rspec_version'] = dict(pg_rspec_request_version) - #panos add info options - if opts.info: - call_options['info'] = opts.info - - call_args = [creds, call_options] - if self.server_supports_call_id_arg(server): - call_args.append(unique_call_id()) + options['geni_rspec_version'] = version_manager.get_version('ProtoGENI 2').to_dict() + else: + options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'} + + call_args = [creds, options] result = server.ListResources(*call_args) + value = ReturnValue.get_value(result) if opts.file is None: - display_rspec(result, opts.format) + display_rspec(value, opts.format) else: - save_rspec_to_file(result, opts.file) + save_rspec_to_file(value, opts.file) return - - # created named slice with given rspec + def create(self, opts, args): - server = self.get_server_from_opts(opts) + """ + create or update named slice with given rspec + """ + server = self.server_proxy_from_opts(opts) server_version = self.get_cached_server_version(server) slice_hrn = args[0] - slice_urn = hrn_to_urn(slice_hrn, 'slice') + slice_urn = hrn_to_urn(slice_hrn, 'slice') user_cred = self.get_user_cred() slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True) - creds = [slice_cred] - if opts.delegate: - delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority)) - creds.append(delegated_cred) + delegated_cred = None + if server_version.get('interface') == 'slicemgr': + # delegate our cred to the slice manager + # do not delegate cred to slicemgr...not working at the moment + pass + #if server_version.get('hrn'): + # delegated_cred = self.delegate_cred(slice_cred, server_version['hrn']) + #elif server_version.get('urn'): + # delegated_cred = self.delegate_cred(slice_cred, urn_to_hrn(server_version['urn'])) + rspec_file = self.get_rspec_file(args[1]) rspec = open(rspec_file).read() - # need to pass along user keys to the aggregate. + # need to pass along user keys to the aggregate. # users = [ # { urn: urn:publicid:IDN+emulab.net+user+alice - # keys: [, ] + # keys: [, ] # }] users = [] - all_keys = [] - all_key_ids = [] slice_records = self.registry.Resolve(slice_urn, [user_cred.save_to_string(save_parents=True)]) if slice_records and 'researcher' in slice_records[0] and slice_records[0]['researcher']!=[]: slice_record = slice_records[0] user_hrns = slice_record['researcher'] user_urns = [hrn_to_urn(hrn, 'user') for hrn in user_hrns] user_records = self.registry.Resolve(user_urns, [user_cred.save_to_string(save_parents=True)]) - for user_record in user_records: - if user_record['type'] != 'user': - continue - #user = {'urn': user_cred.get_gid_caller().get_urn(),'keys': []} - user = {'urn': user_cred.get_gid_caller().get_urn(), # - 'keys': user_record['keys'], - 'email': user_record['email'], # needed for MyPLC - 'person_id': user_record['person_id'], # needed for MyPLC - 'first_name': user_record['first_name'], # needed for MyPLC - 'last_name': user_record['last_name'], # needed for MyPLC - 'slice_record': slice_record, # needed for legacy refresh peer - 'key_ids': user_record['key_ids'] # needed for legacy refresh peer - } - users.append(user) - all_keys.extend(user_record['keys']) - all_key_ids.extend(user_record['key_ids']) - # ProtoGeni Aggregates will only install the keys of the user that is issuing the - # request. So we will add all to the current caller's list of keys + if 'sfa' not in server_version: - for user in users: - if user['urn'] == user_cred.get_gid_caller().get_urn(): - user['keys'] = all_keys - - call_args = [slice_urn, creds, rspec, users] - if self.server_supports_call_id_arg(server): - call_args.append(unique_call_id()) - + users = pg_users_arg(user_records) + rspec = RSpec(rspec) + rspec.filter({'component_manager_id': server_version['urn']}) + rspec = RSpecConverter.to_pg_rspec(rspec.toxml(), content_type='request') + creds = [slice_cred] + else: + users = sfa_users_arg(user_records, slice_record) + creds = [slice_cred] + if delegated_cred: + creds.append(delegated_cred) + # do not append users, keys, or slice tags. Anything + # not contained in this request will be removed from the slice + options = {'append': False} + if self.server_supports_options_arg(server): + options['call_id'] = unique_call_id() + call_args = [slice_urn, creds, rspec, users, options] result = server.CreateSliver(*call_args) + value = ReturnValue.get_value(result) if opts.file is None: - print result + print value else: - save_rspec_to_file (result, opts.file) - return result + save_rspec_to_file (value, opts.file) + return value - # get a ticket for the specified slice - def get_ticket(self, opts, args): - slice_hrn, rspec_path = args[0], args[1] - slice_urn = hrn_to_urn(slice_hrn, 'slice') - user_cred = self.get_user_cred() + def delete(self, opts, args): + """ + delete named slice (DeleteSliver) + """ + slice_hrn = args[0] + slice_urn = hrn_to_urn(slice_hrn, 'slice') slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True) creds = [slice_cred] if opts.delegate: delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority)) creds.append(delegated_cred) - rspec_file = self.get_rspec_file(rspec_path) - rspec = open(rspec_file).read() - server = self.get_server_from_opts(opts) - ticket_string = server.GetTicket(slice_urn, creds, rspec, []) - file = os.path.join(self.options.sfi_dir, get_leaf(slice_hrn) + ".ticket") - self.logger.info("writing ticket to %s"%file) - ticket = SfaTicket(string=ticket_string) - ticket.save_to_file(filename=file, save_parents=True) - - def redeem_ticket(self, opts, args): - ticket_file = args[0] - - # get slice hrn from the ticket - # use this to get the right slice credential - ticket = SfaTicket(filename=ticket_file) - ticket.decode() - slice_hrn = ticket.gidObject.get_hrn() - slice_urn = hrn_to_urn(slice_hrn, 'slice') - #slice_hrn = ticket.attributes['slivers'][0]['hrn'] - user_cred = self.get_user_cred() - slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True) - - # get a list of node hostnames from the RSpec - tree = etree.parse(StringIO(ticket.rspec)) - root = tree.getroot() - hostnames = root.xpath("./network/site/node/hostname/text()") - - # create an xmlrpc connection to the component manager at each of these - # components and gall redeem_ticket - connections = {} - for hostname in hostnames: - try: - self.logger.info("Calling redeem_ticket at %(hostname)s " % locals()) - server = self.get_server(hostname, CM_PORT, self.key_file, \ - self.cert_file, self.options.debug) - server.RedeemTicket(ticket.save_to_string(save_parents=True), slice_cred) - self.logger.info("Success") - except socket.gaierror: - self.logger.error("redeem_ticket failed: Component Manager not accepting requests") - except Exception, e: - self.logger.log_exc(e.message) - return - - # delete named slice - def delete(self, opts, args): + server = self.server_proxy_from_opts(opts) + call_args = [slice_urn, creds] + if self.server_supports_options_arg(server): + options = {'call_id': unique_call_id()} + call_args.append(options) + return server.DeleteSliver(*call_args) + + def status(self, opts, args): + """ + retrieve slice status (SliverStatus) + """ slice_hrn = args[0] slice_urn = hrn_to_urn(slice_hrn, 'slice') slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True) @@ -1063,15 +1067,21 @@ class Sfi: if opts.delegate: delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority)) creds.append(delegated_cred) - server = self.get_server_from_opts(opts) - + server = self.server_proxy_from_opts(opts) call_args = [slice_urn, creds] - if self.server_supports_call_id_arg(server): - call_args.append(unique_call_id()) - return server.DeleteSliver(*call_args) - - # start named slice + if self.server_supports_options_arg(server): + options = {'call_id': unique_call_id()} + call_args.append(options) + result = server.SliverStatus(*call_args) + value = ReturnValue.get_value(result) + print value + if opts.file: + save_variable_to_file(value, opts.file, opts.fileformat) + def start(self, opts, args): + """ + start named slice (Start) + """ slice_hrn = args[0] slice_urn = hrn_to_urn(slice_hrn, 'slice') slice_cred = self.get_slice_cred(args[0]).save_to_string(save_parents=True) @@ -1079,11 +1089,13 @@ class Sfi: if opts.delegate: delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority)) creds.append(delegated_cred) - server = self.get_server_from_opts(opts) + server = self.server_proxy_from_opts(opts) return server.Start(slice_urn, creds) - # stop named slice def stop(self, opts, args): + """ + stop named slice (Stop) + """ slice_hrn = args[0] slice_urn = hrn_to_urn(slice_hrn, 'slice') slice_cred = self.get_slice_cred(args[0]).save_to_string(save_parents=True) @@ -1091,14 +1103,17 @@ class Sfi: if opts.delegate: delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority)) creds.append(delegated_cred) - server = self.get_server_from_opts(opts) + server = self.server_proxy_from_opts(opts) return server.Stop(slice_urn, creds) # reset named slice def reset(self, opts, args): + """ + reset named slice (reset_slice) + """ slice_hrn = args[0] slice_urn = hrn_to_urn(slice_hrn, 'slice') - server = self.get_server_from_opts(opts) + server = self.server_proxy_from_opts(opts) slice_cred = self.get_slice_cred(args[0]).save_to_string(save_parents=True) creds = [slice_cred] if opts.delegate: @@ -1107,9 +1122,12 @@ class Sfi: return server.reset_slice(creds, slice_urn) def renew(self, opts, args): + """ + renew slice (RenewSliver) + """ slice_hrn = args[0] slice_urn = hrn_to_urn(slice_hrn, 'slice') - server = self.get_server_from_opts(opts) + server = self.server_proxy_from_opts(opts) slice_cred = self.get_slice_cred(args[0]).save_to_string(save_parents=True) creds = [slice_cred] if opts.delegate: @@ -1118,12 +1136,18 @@ class Sfi: time = args[1] call_args = [slice_urn, creds, time] - if self.server_supports_call_id_arg(server): - call_args.append(unique_call_id()) - return server.RenewSliver(*call_args) + if self.server_supports_options_arg(server): + options = {'call_id': unique_call_id()} + call_args.append(options) + result = server.RenewSliver(*call_args) + value = ReturnValue.get_value(result) + return value - def status(self, opts, args): + def shutdown(self, opts, args): + """ + shutdown named slice (Shutdown) + """ slice_hrn = args[0] slice_urn = hrn_to_urn(slice_hrn, 'slice') slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True) @@ -1131,64 +1155,123 @@ class Sfi: if opts.delegate: delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority)) creds.append(delegated_cred) - server = self.get_server_from_opts(opts) - call_args = [slice_urn, creds] - if self.server_supports_call_id_arg(server): - call_args.append(unique_call_id()) - print server.SliverStatus(*call_args) - + server = self.server_proxy_from_opts(opts) + return server.Shutdown(slice_urn, creds) + - def shutdown(self, opts, args): - slice_hrn = args[0] - slice_urn = hrn_to_urn(slice_hrn, 'slice') + def get_ticket(self, opts, args): + """ + get a ticket for the specified slice + """ + slice_hrn, rspec_path = args[0], args[1] + slice_urn = hrn_to_urn(slice_hrn, 'slice') + user_cred = self.get_user_cred() slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True) creds = [slice_cred] if opts.delegate: delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority)) creds.append(delegated_cred) - server = self.get_server_from_opts(opts) - return server.Shutdown(slice_urn, creds) - - def print_help (self): - self.sfi_parser.print_help() - self.cmd_parser.print_help() - - # - # Main: parse arguments and dispatch to command - # - def main(self): - self.sfi_parser = self.create_parser() - (options, args) = self.sfi_parser.parse_args() - self.options = options + rspec_file = self.get_rspec_file(rspec_path) + rspec = open(rspec_file).read() + server = self.server_proxy_from_opts(opts) + ticket_string = server.GetTicket(slice_urn, creds, rspec, []) + file = os.path.join(self.options.sfi_dir, get_leaf(slice_hrn) + ".ticket") + self.logger.info("writing ticket to %s"%file) + ticket = SfaTicket(string=ticket_string) + ticket.save_to_file(filename=file, save_parents=True) - self.logger.setLevelFromOptVerbose(self.options.verbose) - if options.hashrequest: - self.hashrequest = True + def redeem_ticket(self, opts, args): + """ + Connects to nodes in a slice and redeems a ticket +(slice hrn is retrieved from the ticket) + """ + ticket_file = args[0] + + # get slice hrn from the ticket + # use this to get the right slice credential + ticket = SfaTicket(filename=ticket_file) + ticket.decode() + slice_hrn = ticket.gidObject.get_hrn() + slice_urn = hrn_to_urn(slice_hrn, 'slice') + #slice_hrn = ticket.attributes['slivers'][0]['hrn'] + user_cred = self.get_user_cred() + slice_cred = self.get_slice_cred(slice_hrn).save_to_string(save_parents=True) + + # get a list of node hostnames from the RSpec + tree = etree.parse(StringIO(ticket.rspec)) + root = tree.getroot() + hostnames = root.xpath("./network/site/node/hostname/text()") + + # create an xmlrpc connection to the component manager at each of these + # components and gall redeem_ticket + connections = {} + for hostname in hostnames: + try: + self.logger.info("Calling redeem_ticket at %(hostname)s " % locals()) + server = self.server_proxy(hostname, CM_PORT, self.key_file, \ + self.cert_file, self.options.debug) + server.RedeemTicket(ticket.save_to_string(save_parents=True), slice_cred) + self.logger.info("Success") + except socket.gaierror: + self.logger.error("redeem_ticket failed: Component Manager not accepting requests") + except Exception, e: + self.logger.log_exc(e.message) + return - if len(args) <= 0: - self.logger.critical("No command given. Use -h for help.") - return -1 - - command = args[0] - self.cmd_parser = self.create_cmd_parser(command) - (cmd_opts, cmd_args) = self.cmd_parser.parse_args(args[1:]) + def create_gid(self, opts, args): + """ + Create a GID (CreateGid) + """ + if len(args) < 1: + self.print_help() + sys.exit(1) + target_hrn = args[0] + user_cred = self.get_user_cred().save_to_string(save_parents=True) + gid = self.registry.CreateGid(user_cred, target_hrn, self.cert.save_to_string()) + if opts.file: + filename = opts.file + else: + filename = os.sep.join([self.options.sfi_dir, '%s.gid' % target_hrn]) + self.logger.info("writing %s gid to %s" % (target_hrn, filename)) + GID(string=gid).save_to_file(filename) + - self.set_servers() - self.logger.info("Command=%s" % command) - if command in ("resources"): - self.logger.debug("resources cmd_opts %s" % cmd_opts.format) - elif command in ("list", "show", "remove"): - self.logger.debug("cmd_opts.type %s" % cmd_opts.type) - self.logger.debug('cmd_args %s' % cmd_args) + def delegate(self, opts, args): + """ + (locally) create delegate credential for use by given hrn + """ + delegee_hrn = args[0] + if opts.delegate_user: + user_cred = self.get_user_cred() + cred = self.delegate_cred(user_cred, delegee_hrn) + elif opts.delegate_slice: + slice_cred = self.get_slice_cred(opts.delegate_slice) + cred = self.delegate_cred(slice_cred, delegee_hrn) + else: + self.logger.warning("Must specify either --user or --slice ") + return + delegated_cred = Credential(string=cred) + object_hrn = delegated_cred.get_gid_object().get_hrn() + if opts.delegate_user: + dest_fn = os.path.join(self.options.sfi_dir, get_leaf(delegee_hrn) + "_" + + get_leaf(object_hrn) + ".cred") + elif opts.delegate_slice: + dest_fn = os.path.join(self.options.sfi_dir, get_leaf(delegee_hrn) + "_slice_" + + get_leaf(object_hrn) + ".cred") - try: - self.dispatch(command, cmd_opts, cmd_args) - except KeyError: - self.logger.critical ("Unknown command %s"%command) - raise - sys.exit(1) - - return + delegated_cred.save_to_file(dest_fn, save_parents=True) + + self.logger.info("delegated credential for %s to %s and wrote to %s"%(object_hrn, delegee_hrn,dest_fn)) -if __name__ == "__main__": - Sfi().main() + def get_trusted_certs(self, opts, args): + """ + return uhe trusted certs at this interface (get_trusted_certs) + """ + trusted_certs = self.registry.get_trusted_certs() + for trusted_cert in trusted_certs: + gid = GID(string=trusted_cert) + gid.dump() + cert = Certificate(string=trusted_cert) + self.logger.debug('Sfi.get_trusted_certs -> %r'%cert.get_subject()) + return +