sfa/client/sfi.py

   1 #
   2 # sfi.py - basic SFA command-line client
   3 # the actual binary in sfa/clientbin essentially runs main()
   4 # this module is used in sfascan
   5 #
   6
   7 import sys
   8 sys.path.append('.')
   9
  10 import os, os.path
  11 import socket
  12 import datetime
  13 import codecs
  14 import pickle
  15 from lxml import etree
  16 from StringIO import StringIO
  17 from optparse import OptionParser
  18 from pprint import PrettyPrinter
  19
  20 from sfa.trust.certificate import Keypair, Certificate
  21 from sfa.trust.gid import GID
  22 from sfa.trust.credential import Credential
  23 from sfa.trust.sfaticket import SfaTicket
  24
  25 from sfa.util.sfalogging import sfi_logger
  26 from sfa.util.xrn import get_leaf, get_authority, hrn_to_urn
  27 from sfa.util.config import Config
  28 from sfa.util.version import version_core
  29 from sfa.util.cache import Cache
  30
  31 from sfa.storage.record import SfaRecord, UserRecord, SliceRecord, NodeRecord, AuthorityRecord
  32
  33 from sfa.rspecs.rspec import RSpec
  34 from sfa.rspecs.rspec_converter import RSpecConverter
  35 from sfa.rspecs.version_manager import VersionManager
  36
  37 from sfa.client.sfaclientlib import SfaClientBootstrap
  38 from sfa.client.sfaserverproxy import SfaServerProxy, ServerException
  39 from sfa.client.client_helper import pg_users_arg, sfa_users_arg
  40 from sfa.client.return_value import ReturnValue
  41
  42 CM_PORT=12346
  43
  44 # utility methods here
  45 # display methods
  46 def display_rspec(rspec, format='rspec'):
  47     if format in ['dns']:
  48         tree = etree.parse(StringIO(rspec))
  49         root = tree.getroot()
  50         result = root.xpath("./network/site/node/hostname/text()")
  51     elif format in ['ip']:
  52         # The IP address is not yet part of the new RSpec
  53         # so this doesn't do anything yet.
  54         tree = etree.parse(StringIO(rspec))
  55         root = tree.getroot()
  56         result = root.xpath("./network/site/node/ipv4/text()")
  57     else:
  58         result = rspec
  59
  60     print result
  61     return
  62
  63 def display_list(results):
  64     for result in results:
  65         print result
  66
  67 def display_records(recordList, dump=False):
  68     ''' Print all fields in the record'''
  69     for record in recordList:
  70         display_record(record, dump)
  71
  72 def display_record(record, dump=False):
  73     if dump:
  74         record.dump()
  75     else:
  76         info = record.getdict()
  77         print "%s (%s)" % (info['hrn'], info['type'])
  78     return
  79
  80
  81 def filter_records(type, records):
  82     filtered_records = []
  83     for record in records:
  84         if (record['type'] == type) or (type == "all"):
  85             filtered_records.append(record)
  86     return filtered_records
  87
  88
  89 # save methods
  90 def save_variable_to_file(var, filename, format="text"):
  91     f = open(filename, "w")
  92     if format == "text":
  93         f.write(str(var))
  94     elif format == "pickled":
  95         f.write(pickle.dumps(var))
  96     else:
  97         # this should never happen
  98         print "unknown output format", format
  99
 100
 101 def save_rspec_to_file(rspec, filename):
 102     if not filename.endswith(".rspec"):
 103         filename = filename + ".rspec"
 104     f = open(filename, 'w')
 105     f.write(rspec)
 106     f.close()
 107     return
 108
 109 def save_records_to_file(filename, recordList, format="xml"):
 110     if format == "xml":
 111         index = 0
 112         for record in recordList:
 113             if index > 0:
 114                 save_record_to_file(filename + "." + str(index), record)
 115             else:
 116                 save_record_to_file(filename, record)
 117             index = index + 1
 118     elif format == "xmllist":
 119         f = open(filename, "w")
 120         f.write("<recordlist>\n")
 121         for record in recordList:
 122             record = SfaRecord(dict=record)
 123             f.write('<record hrn="' + record.get_name() + '" type="' + record.get_type() + '" />\n')
 124         f.write("</recordlist>\n")
 125         f.close()
 126     elif format == "hrnlist":
 127         f = open(filename, "w")
 128         for record in recordList:
 129             record = SfaRecord(dict=record)
 130             f.write(record.get_name() + "\n")
 131         f.close()
 132     else:
 133         # this should never happen
 134         print "unknown output format", format
 135
 136 def save_record_to_file(filename, record):
 137     if record['type'] in ['user']:
 138         record = UserRecord(dict=record)
 139     elif record['type'] in ['slice']:
 140         record = SliceRecord(dict=record)
 141     elif record['type'] in ['node']:
 142         record = NodeRecord(dict=record)
 143     elif record['type'] in ['authority', 'ma', 'sa']:
 144         record = AuthorityRecord(dict=record)
 145     else:
 146         record = SfaRecord(dict=record)
 147     str = record.save_to_string()
 148     f=codecs.open(filename, encoding='utf-8',mode="w")
 149     f.write(str)
 150     f.close()
 151     return
 152
 153
 154 # load methods
 155 def load_record_from_file(filename):
 156     f=codecs.open(filename, encoding="utf-8", mode="r")
 157     str = f.read()
 158     f.close()
 159     record = SfaRecord(string=str)
 160     return record
 161
 162
 163 import uuid
 164 def unique_call_id(): return uuid.uuid4().urn
 165
 166 class Sfi:
 167
 168     required_options=['verbose',  'debug',  'registry',  'sm',  'auth',  'user']
 169
 170     @staticmethod
 171     def default_sfi_dir ():
 172         if os.path.isfile("./sfi_config"):
 173             return os.getcwd()
 174         else:
 175             return os.path.expanduser("~/.sfi/")
 176
 177     # dummy to meet Sfi's expectations for its 'options' field
 178     # i.e. s/t we can do setattr on
 179     class DummyOptions:
 180         pass
 181
 182     def __init__ (self,options=None):
 183         if options is None: options=Sfi.DummyOptions()
 184         for opt in Sfi.required_options:
 185             if not hasattr(options,opt): setattr(options,opt,None)
 186         if not hasattr(options,'sfi_dir'): options.sfi_dir=Sfi.default_sfi_dir()
 187         self.options = options
 188         self.user = None
 189         self.authority = None
 190         self.logger = sfi_logger
 191         self.logger.enable_console()
 192         self.available_names = [ tuple[0] for tuple in Sfi.available ]
 193         self.available_dict = dict (Sfi.available)
 194
 195     # tuples command-name expected-args in the order in which they should appear in the help
 196     available = [
 197         ("version", ""),
 198         ("list", "authority"),
 199         ("show", "name"),
 200         ("add", "record"),
 201         ("update", "record"),
 202         ("remove", "name"),
 203         ("slices", ""),
 204         ("resources", "[slice_hrn]"),
 205         ("create", "slice_hrn rspec"),
 206         ("delete", "slice_hrn"),
 207         ("status", "slice_hrn"),
 208         ("start", "slice_hrn"),
 209         ("stop", "slice_hrn"),
 210         ("reset", "slice_hrn"),
 211         ("renew", "slice_hrn time"),
 212         ("shutdown", "slice_hrn"),
 213         ("get_ticket", "slice_hrn rspec"),
 214         ("redeem_ticket", "ticket"),
 215         ("delegate", "name"),
 216         ("create_gid", "[name]"),
 217         ("get_trusted_certs", "cred"),
 218         ]
 219
 220     def print_command_help (self, options):
 221         verbose=getattr(options,'verbose')
 222         format3="%18s %-15s %s"
 223         line=80*'-'
 224         if not verbose:
 225             print format3%("command","cmd_args","description")
 226             print line
 227         else:
 228             print line
 229             self.create_parser().print_help()
 230         for command in self.available_names:
 231             args=self.available_dict[command]
 232             method=getattr(self,command,None)
 233             doc=""
 234             if method: doc=getattr(method,'__doc__',"")
 235             if not doc: doc="*** no doc found ***"
 236             doc=doc.strip(" \t\n")
 237             doc=doc.replace("\n","\n"+35*' ')
 238             if verbose:
 239                 print line
 240             print format3%(command,args,doc)
 241             if verbose:
 242                 self.create_command_parser(command).print_help()
 243
 244     def create_command_parser(self, command):
 245         if command not in self.available_dict:
 246             msg="Invalid command\n"
 247             msg+="Commands: "
 248             msg += ','.join(self.available_names)
 249             self.logger.critical(msg)
 250             sys.exit(2)
 251
 252         parser = OptionParser(usage="sfi [sfi_options] %s [cmd_options] %s" \
 253                                      % (command, self.available_dict[command]))
 254
 255         # user specifies remote aggregate/sm/component
 256         if command in ("resources", "slices", "create", "delete", "start", "stop",
 257                        "restart", "shutdown",  "get_ticket", "renew", "status"):
 258             parser.add_option("-c", "--component", dest="component", default=None,
 259                              help="component hrn")
 260             parser.add_option("-d", "--delegate", dest="delegate", default=None,
 261                              action="store_true",
 262                              help="Include a credential delegated to the user's root"+\
 263                                   "authority in set of credentials for this call")
 264
 265         # registy filter option
 266         if command in ("list", "show", "remove"):
 267             parser.add_option("-t", "--type", dest="type", type="choice",
 268                             help="type filter ([all]|user|slice|authority|node|aggregate)",
 269                             choices=("all", "user", "slice", "authority", "node", "aggregate"),
 270                             default="all")
 271         # display formats
 272         if command in ("resources"):
 273             parser.add_option("-r", "--rspec-version", dest="rspec_version", default="SFA 1",
 274                               help="schema type and version of resulting RSpec")
 275             parser.add_option("-f", "--format", dest="format", type="choice",
 276                              help="display format ([xml]|dns|ip)", default="xml",
 277                              choices=("xml", "dns", "ip"))
 278             #panos: a new option to define the type of information about resources a user is interested in
 279             parser.add_option("-i", "--info", dest="info",
 280                                 help="optional component information", default=None)
 281
 282
 283         # 'create' does return the new rspec, makes sense to save that too
 284         if command in ("resources", "show", "list", "create_gid", 'create'):
 285            parser.add_option("-o", "--output", dest="file",
 286                             help="output XML to file", metavar="FILE", default=None)
 287
 288         if command in ("show", "list"):
 289            parser.add_option("-f", "--format", dest="format", type="choice",
 290                              help="display format ([text]|xml)", default="text",
 291                              choices=("text", "xml"))
 292
 293            parser.add_option("-F", "--fileformat", dest="fileformat", type="choice",
 294                              help="output file format ([xml]|xmllist|hrnlist)", default="xml",
 295                              choices=("xml", "xmllist", "hrnlist"))
 296
 297         if command in ("status", "version"):
 298            parser.add_option("-o", "--output", dest="file",
 299                             help="output dictionary to file", metavar="FILE", default=None)
 300            parser.add_option("-F", "--fileformat", dest="fileformat", type="choice",
 301                              help="output file format ([text]|pickled)", default="text",
 302                              choices=("text","pickled"))
 303
 304         if command in ("delegate"):
 305            parser.add_option("-u", "--user",
 306                             action="store_true", dest="delegate_user", default=False,
 307                             help="delegate user credential")
 308            parser.add_option("-s", "--slice", dest="delegate_slice",
 309                             help="delegate slice credential", metavar="HRN", default=None)
 310
 311         if command in ("version"):
 312             parser.add_option("-R","--registry-version",
 313                               action="store_true", dest="version_registry", default=False,
 314                               help="probe registry version instead of sliceapi")
 315             parser.add_option("-l","--local",
 316                               action="store_true", dest="version_local", default=False,
 317                               help="display version of the local client")
 318
 319         return parser
 320
 321
 322     def create_parser(self):
 323
 324         # Generate command line parser
 325         parser = OptionParser(usage="sfi [sfi_options] command [cmd_options] [cmd_args]",
 326                              description="Commands: %s"%(" ".join(self.available_names)))
 327         parser.add_option("-r", "--registry", dest="registry",
 328                          help="root registry", metavar="URL", default=None)
 329         parser.add_option("-s", "--sliceapi", dest="sm", default=None, metavar="URL",
 330                          help="slice API - in general a SM URL, but can be used to talk to an aggregate")
 331         parser.add_option("-d", "--dir", dest="sfi_dir",
 332                          help="config & working directory - default is %default",
 333                          metavar="PATH", default=Sfi.default_sfi_dir())
 334         parser.add_option("-u", "--user", dest="user",
 335                          help="user name", metavar="HRN", default=None)
 336         parser.add_option("-a", "--auth", dest="auth",
 337                          help="authority name", metavar="HRN", default=None)
 338         parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0,
 339                          help="verbose mode - cumulative")
 340         parser.add_option("-D", "--debug",
 341                           action="store_true", dest="debug", default=False,
 342                           help="Debug (xml-rpc) protocol messages")
 343         parser.add_option("-p", "--protocol", dest="protocol", default="xmlrpc",
 344                          help="RPC protocol (xmlrpc or soap)")
 345         # would it make sense to use ~/.ssh/id_rsa as a default here ?
 346         parser.add_option("-k", "--private-key",
 347                          action="store", dest="user_private_key", default=None,
 348                          help="point to the private key file to use if not yet installed in sfi_dir")
 349         parser.add_option("-t", "--timeout", dest="timeout", default=None,
 350                          help="Amout of time to wait before timing out the request")
 351         parser.add_option("-?", "--commands",
 352                          action="store_true", dest="command_help", default=False,
 353                          help="one page summary on commands & exit")
 354         parser.disable_interspersed_args()
 355
 356         return parser
 357
 358
 359     def print_help (self):
 360         self.sfi_parser.print_help()
 361         self.command_parser.print_help()
 362
 363     #
 364     # Main: parse arguments and dispatch to command
 365     #
 366     def dispatch(self, command, command_options, command_args):
 367         return getattr(self, command)(command_options, command_args)
 368
 369     def main(self):
 370         self.sfi_parser = self.create_parser()
 371         (options, args) = self.sfi_parser.parse_args()
 372         if options.command_help:
 373             self.print_command_help(options)
 374             sys.exit(1)
 375         self.options = options
 376
 377         self.logger.setLevelFromOptVerbose(self.options.verbose)
 378
 379         if len(args) <= 0:
 380             self.logger.critical("No command given. Use -h for help.")
 381             self.print_command_help(options)
 382             return -1
 383
 384         command = args[0]
 385         self.command_parser = self.create_command_parser(command)
 386         (command_options, command_args) = self.command_parser.parse_args(args[1:])
 387         self.command_options = command_options
 388
 389         self.read_config ()
 390         self.bootstrap ()
 391         self.logger.info("Command=%s" % command)
 392
 393         try:
 394             self.dispatch(command, command_options, command_args)
 395         except KeyError:
 396             self.logger.critical ("Unknown command %s"%command)
 397             raise
 398             sys.exit(1)
 399
 400         return
 401
 402     ####################
 403     def read_config(self):
 404         config_file = os.path.join(self.options.sfi_dir,"sfi_config")
 405         try:
 406            config = Config (config_file)
 407         except:
 408            self.logger.critical("Failed to read configuration file %s"%config_file)
 409            self.logger.info("Make sure to remove the export clauses and to add quotes")
 410            if self.options.verbose==0:
 411                self.logger.info("Re-run with -v for more details")
 412            else:
 413                self.logger.log_exc("Could not read config file %s"%config_file)
 414            sys.exit(1)
 415
 416         errors = 0
 417         # Set SliceMgr URL
 418         if (self.options.sm is not None):
 419            self.sm_url = self.options.sm
 420         elif hasattr(config, "SFI_SM"):
 421            self.sm_url = config.SFI_SM
 422         else:
 423            self.logger.error("You need to set e.g. SFI_SM='http://your.slicemanager.url:12347/' in %s" % config_file)
 424            errors += 1
 425
 426         # Set Registry URL
 427         if (self.options.registry is not None):
 428            self.reg_url = self.options.registry
 429         elif hasattr(config, "SFI_REGISTRY"):
 430            self.reg_url = config.SFI_REGISTRY
 431         else:
 432            self.logger.errors("You need to set e.g. SFI_REGISTRY='http://your.registry.url:12345/' in %s" % config_file)
 433            errors += 1
 434
 435         # Set user HRN
 436         if (self.options.user is not None):
 437            self.user = self.options.user
 438         elif hasattr(config, "SFI_USER"):
 439            self.user = config.SFI_USER
 440         else:
 441            self.logger.errors("You need to set e.g. SFI_USER='plc.princeton.username' in %s" % config_file)
 442            errors += 1
 443
 444         # Set authority HRN
 445         if (self.options.auth is not None):
 446            self.authority = self.options.auth
 447         elif hasattr(config, "SFI_AUTH"):
 448            self.authority = config.SFI_AUTH
 449         else:
 450            self.logger.error("You need to set e.g. SFI_AUTH='plc.princeton' in %s" % config_file)
 451            errors += 1
 452
 453         if errors:
 454            sys.exit(1)
 455
 456     #
 457     # Get various credential and spec files
 458     #
 459     # Establishes limiting conventions
 460     #   - conflates MAs and SAs
 461     #   - assumes last token in slice name is unique
 462     #
 463     # Bootstraps credentials
 464     #   - bootstrap user credential from self-signed certificate
 465     #   - bootstrap authority credential from user credential
 466     #   - bootstrap slice credential from user credential
 467     #
 468
 469     # init self-signed cert, user credentials and gid
 470     def bootstrap (self):
 471         bootstrap = SfaClientBootstrap (self.user, self.reg_url, self.options.sfi_dir)
 472         # if -k is provided, use this to initialize private key
 473         if self.options.user_private_key:
 474             bootstrap.init_private_key_if_missing (self.options.user_private_key)
 475         else:
 476             # trigger legacy compat code if needed
 477             # the name has changed from just <leaf>.pkey to <hrn>.pkey
 478             if not os.path.isfile(bootstrap.private_key_filename()):
 479                 self.logger.info ("private key not found, trying legacy name")
 480                 try:
 481                     legacy_private_key = os.path.join (self.options.sfi_dir, "%s.pkey"%get_leaf(self.user))
 482                     self.logger.debug("legacy_private_key=%s"%legacy_private_key)
 483                     bootstrap.init_private_key_if_missing (legacy_private_key)
 484                     self.logger.info("Copied private key from legacy location %s"%legacy_private_key)
 485                 except:
 486                     self.logger.log_exc("Can't find private key ")
 487                     sys.exit(1)
 488
 489         # make it bootstrap
 490         bootstrap.bootstrap_my_gid()
 491         # extract what's needed
 492         self.private_key = bootstrap.private_key()
 493         self.my_credential_string = bootstrap.my_credential_string ()
 494         self.my_gid = bootstrap.my_gid ()
 495         self.bootstrap = bootstrap
 496
 497
 498     def my_authority_credential_string(self):
 499         if not self.authority:
 500             self.logger.critical("no authority specified. Use -a or set SF_AUTH")
 501             sys.exit(-1)
 502         return self.bootstrap.authority_credential_string (self.authority)
 503
 504     def slice_credential_string(self, name):
 505         return self.bootstrap.slice_credential_string (name)
 506
 507     # xxx should be supported by sfaclientbootstrap as well
 508     def delegate_cred(self, object_cred, hrn, type='authority'):
 509         # the gid and hrn of the object we are delegating
 510         if isinstance(object_cred, str):
 511             object_cred = Credential(string=object_cred)
 512         object_gid = object_cred.get_gid_object()
 513         object_hrn = object_gid.get_hrn()
 514
 515         if not object_cred.get_privileges().get_all_delegate():
 516             self.logger.error("Object credential %s does not have delegate bit set"%object_hrn)
 517             return
 518
 519         # the delegating user's gid
 520         caller_gidfile = self.my_gid()
 521
 522         # the gid of the user who will be delegated to
 523         delegee_gid = self.bootstrap.gid(hrn,type)
 524         delegee_hrn = delegee_gid.get_hrn()
 525         dcred = object_cred.delegate(delegee_gid, self.private_key, caller_gidfile)
 526         return dcred.save_to_string(save_parents=True)
 527
 528     #
 529     # Management of the servers
 530     #
 531
 532     def registry (self):
 533         # cache the result
 534         if not hasattr (self, 'registry_proxy'):
 535             self.logger.info("Contacting Registry at: %s"%self.reg_url)
 536             self.registry_proxy = SfaServerProxy(self.reg_url, self.private_key, self.my_gid,
 537                                                  timeout=self.options.timeout, verbose=self.options.debug)
 538         return self.registry_proxy
 539
 540     def sliceapi (self):
 541         # cache the result
 542         if not hasattr (self, 'sliceapi_proxy'):
 543             # if the command exposes the --component option, figure it's hostname and connect at CM_PORT
 544             if hasattr(self.command_options,'component') and self.command_options.component:
 545                 # resolve the hrn at the registry
 546                 node_hrn = self.command_options.component
 547                 records = self.registry().Resolve(node_hrn, self.my_credential_string)
 548                 records = filter_records('node', records)
 549                 if not records:
 550                     self.logger.warning("No such component:%r"% opts.component)
 551                 record = records[0]
 552                 cm_url = "http://%s:%d/"%(record['hostname'],CM_PORT)
 553                 self.sliceapi_proxy=SfaServerProxy(cm_url, self.private_key, self.my_gid)
 554             else:
 555                 # otherwise use what was provided as --sliceapi, or SFI_SM in the config
 556                 self.logger.info("Contacting Slice Manager at: %s"%self.sm_url)
 557                 self.sliceapi_proxy = SfaServerProxy(self.sm_url, self.private_key, self.my_gid,
 558                                                      timeout=self.options.timeout, verbose=self.options.debug)
 559         return self.sliceapi_proxy
 560
 561     def get_cached_server_version(self, server):
 562         # check local cache first
 563         cache = None
 564         version = None
 565         cache_file = os.path.join(self.options.sfi_dir,'sfi_cache.dat')
 566         cache_key = server.url + "-version"
 567         try:
 568             cache = Cache(cache_file)
 569         except IOError:
 570             cache = Cache()
 571             self.logger.info("Local cache not found at: %s" % cache_file)
 572
 573         if cache:
 574             version = cache.get(cache_key)
 575
 576         if not version:
 577             result = server.GetVersion()
 578             version= ReturnValue.get_value(result)
 579             # cache version for 24 hours
 580             cache.add(cache_key, version, ttl= 60*60*24)
 581             self.logger.info("Updating cache file %s" % cache_file)
 582             cache.save_to_file(cache_file)
 583
 584         return version
 585
 586     ### resurrect this temporarily so we can support V1 aggregates for a while
 587     def server_supports_options_arg(self, server):
 588         """
 589         Returns true if server support the optional call_id arg, false otherwise.
 590         """
 591         server_version = self.get_cached_server_version(server)
 592         return True
 593         # xxx need to rewrite this
 594         if 'sfa' in server_version and 'code_tag' in server_version:
 595             code_tag = server_version['code_tag']
 596             code_tag_parts = code_tag.split("-")
 597
 598             version_parts = code_tag_parts[0].split(".")
 599             major, minor = version_parts[0], version_parts[1]
 600             rev = code_tag_parts[1]
 601             if int(major) >= 1:
 602                 if int(minor) >= 2:
 603                     return True
 604         return False
 605
 606     ### ois = options if supported
 607     def ois (self, server, option_dict):
 608         if self.server_supports_options_arg (server) : return [option_dict]
 609         else: return []
 610
 611     ######################################## miscell utilities
 612     def get_rspec_file(self, rspec):
 613        if (os.path.isabs(rspec)):
 614           file = rspec
 615        else:
 616           file = os.path.join(self.options.sfi_dir, rspec)
 617        if (os.path.isfile(file)):
 618           return file
 619        else:
 620           self.logger.critical("No such rspec file %s"%rspec)
 621           sys.exit(1)
 622
 623     def get_record_file(self, record):
 624        if (os.path.isabs(record)):
 625           file = record
 626        else:
 627           file = os.path.join(self.options.sfi_dir, record)
 628        if (os.path.isfile(file)):
 629           return file
 630        else:
 631           self.logger.critical("No such registry record file %s"%record)
 632           sys.exit(1)
 633
 634
 635     #==========================================================================
 636     # Following functions implement the commands
 637     #
 638     # Registry-related commands
 639     #==========================================================================
 640
 641     def version(self, options, args):
 642         """
 643         display an SFA server version (GetVersion)
 644 or version information about sfi itself
 645         """
 646         if options.version_local:
 647             version=version_core()
 648         else:
 649             if options.version_registry:
 650                 server=self.registry()
 651             else:
 652                 server = self.sliceapi()
 653             result = server.GetVersion()
 654             version = ReturnValue.get_value(result)
 655         pprinter = PrettyPrinter(indent=4)
 656         pprinter.pprint(version)
 657         if options.file:
 658             save_variable_to_file(version, options.file, options.fileformat)
 659
 660     def list(self, options, args):
 661         """
 662         list entries in named authority registry (List)
 663         """
 664         if len(args)!= 1:
 665             self.print_help()
 666             sys.exit(1)
 667         hrn = args[0]
 668         try:
 669             list = self.registry().List(hrn, self.my_credential_string)
 670         except IndexError:
 671             raise Exception, "Not enough parameters for the 'list' command"
 672
 673         # filter on person, slice, site, node, etc.
 674         # THis really should be in the self.filter_records funct def comment...
 675         list = filter_records(options.type, list)
 676         for record in list:
 677             print "%s (%s)" % (record['hrn'], record['type'])
 678         if options.file:
 679             save_records_to_file(options.file, list, options.fileformat)
 680         return
 681
 682     def show(self, options, args):
 683         """
 684         show details about named registry record (Resolve)
 685         """
 686         if len(args)!= 1:
 687             self.print_help()
 688             sys.exit(1)
 689         hrn = args[0]
 690         records = self.registry().Resolve(hrn, self.my_credential_string)
 691         records = filter_records(options.type, records)
 692         if not records:
 693             self.logger.error("No record of type %s"% options.type)
 694         for record in records:
 695             if record['type'] in ['user']:
 696                 record = UserRecord(dict=record)
 697             elif record['type'] in ['slice']:
 698                 record = SliceRecord(dict=record)
 699             elif record['type'] in ['node']:
 700                 record = NodeRecord(dict=record)
 701             elif record['type'].startswith('authority'):
 702                 record = AuthorityRecord(dict=record)
 703             else:
 704                 record = SfaRecord(dict=record)
 705             if (options.format == "text"):
 706                 record.dump()
 707             else:
 708                 print record.save_to_string()
 709         if options.file:
 710             save_records_to_file(options.file, records, options.fileformat)
 711         return
 712
 713     def add(self, options, args):
 714         "add record into registry from xml file (Register)"
 715         auth_cred = self.my_authority_credential_string()
 716         if len(args)!=1:
 717             self.print_help()
 718             sys.exit(1)
 719         record_filepath = args[0]
 720         rec_file = self.get_record_file(record_filepath)
 721         record = load_record_from_file(rec_file).as_dict()
 722         return self.registry().Register(record, auth_cred)
 723
 724     def update(self, options, args):
 725         "update record into registry from xml file (Update)"
 726         if len(args)!=1:
 727             self.print_help()
 728             sys.exit(1)
 729         rec_file = self.get_record_file(args[0])
 730         record = load_record_from_file(rec_file)
 731         if record['type'] == "user":
 732             if record.get_name() == self.user:
 733                 cred = self.my_credential_string
 734             else:
 735                 cred = self.my_authority_credential_string()
 736         elif record['type'] in ["slice"]:
 737             try:
 738                 cred = self.slice_credential_string(record.get_name())
 739             except ServerException, e:
 740                # XXX smbaker -- once we have better error return codes, update this
 741                # to do something better than a string compare
 742                if "Permission error" in e.args[0]:
 743                    cred = self.my_authority_credential_string()
 744                else:
 745                    raise
 746         elif record.get_type() in ["authority"]:
 747             cred = self.my_authority_credential_string()
 748         elif record.get_type() == 'node':
 749             cred = self.my_authority_credential_string()
 750         else:
 751             raise "unknown record type" + record.get_type()
 752         record = record.as_dict()
 753         return self.registry().Update(record, cred)
 754
 755     def remove(self, options, args):
 756         "remove registry record by name (Remove)"
 757         auth_cred = self.my_authority_credential_string()
 758         if len(args)!=1:
 759             self.print_help()
 760             sys.exit(1)
 761         hrn = args[0]
 762         type = options.type
 763         if type in ['all']:
 764             type = '*'
 765         return self.registry().Remove(hrn, auth_cred, type)
 766
 767     # ==================================================================
 768     # Slice-related commands
 769     # ==================================================================
 770
 771     def slices(self, options, args):
 772         "list instantiated slices (ListSlices) - returns urn's"
 773         creds = [self.my_credential_string]
 774         if options.delegate:
 775             delegated_cred = self.delegate_cred(self.my_credential_string, get_authority(self.authority))
 776             creds.append(delegated_cred)
 777         api_options = {}
 778         api_options ['call_id'] = unique_call_id()
 779         server = self.sliceapi()
 780         result = server.ListSlices(creds, *self.ois(server,api_options))
 781         value = ReturnValue.get_value(result)
 782         display_list(value)
 783         return
 784
 785     # show rspec for named slice
 786     def resources(self, options, args):
 787         """
 788         with no arg, discover available resources,
 789 or currently provisioned resources  (ListResources)
 790         """
 791         api_options = {}
 792         api_options ['call_id'] = unique_call_id()
 793         #panos add info api_options
 794         if options.info:
 795             api_options['info'] = options.info
 796
 797         if args:
 798             cred = self.slice_credential_string(args[0])
 799             hrn = args[0]
 800             api_options['geni_slice_urn'] = hrn_to_urn(hrn, 'slice')
 801         else:
 802             cred = self.my_credential_string
 803
 804         server = self.sliceapi()
 805         creds = [cred]
 806         if options.delegate:
 807             delegated_cred = self.delegate_cred(cred, get_authority(self.authority))
 808             creds.append(delegated_cred)
 809         if options.rspec_version:
 810             version_manager = VersionManager()
 811             server_version = self.get_cached_server_version(server)
 812             if 'sfa' in server_version:
 813                 # just request the version the client wants
 814                 api_options['geni_rspec_version'] = version_manager.get_version(options.rspec_version).to_dict()
 815             else:
 816                 # this must be a protogeni aggregate. We should request a v2 ad rspec
 817                 # regardless of what the client user requested
 818                 api_options['geni_rspec_version'] = version_manager.get_version('ProtoGENI 2').to_dict()
 819         else:
 820             api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'}
 821
 822         result = server.ListResources(creds, *self.ois(server,api_options))
 823         value = ReturnValue.get_value(result)
 824         if options.file is None:
 825             display_rspec(value, options.format)
 826         else:
 827             save_rspec_to_file(value, options.file)
 828         return
 829
 830     def create(self, options, args):
 831         """
 832         create or update named slice with given rspec
 833         """
 834         server = self.sliceapi()
 835         server_version = self.get_cached_server_version(server)
 836         slice_hrn = args[0]
 837         slice_urn = hrn_to_urn(slice_hrn, 'slice')
 838         slice_cred = self.slice_credential_string(slice_hrn)
 839         delegated_cred = None
 840         if server_version.get('interface') == 'slicemgr':
 841             # delegate our cred to the slice manager
 842             # do not delegate cred to slicemgr...not working at the moment
 843             pass
 844             #if server_version.get('hrn'):
 845             #    delegated_cred = self.delegate_cred(slice_cred, server_version['hrn'])
 846             #elif server_version.get('urn'):
 847             #    delegated_cred = self.delegate_cred(slice_cred, urn_to_hrn(server_version['urn']))
 848
 849         rspec_file = self.get_rspec_file(args[1])
 850         rspec = open(rspec_file).read()
 851
 852         # need to pass along user keys to the aggregate.
 853         # users = [
 854         #  { urn: urn:publicid:IDN+emulab.net+user+alice
 855         #    keys: [<ssh key A>, <ssh key B>]
 856         #  }]
 857         users = []
 858         slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string])
 859         if slice_records and 'researcher' in slice_records[0] and slice_records[0]['researcher']!=[]:
 860             slice_record = slice_records[0]
 861             user_hrns = slice_record['researcher']
 862             user_urns = [hrn_to_urn(hrn, 'user') for hrn in user_hrns]
 863             user_records = self.registry().Resolve(user_urns, [self.my_credential_string])
 864
 865             if 'sfa' not in server_version:
 866                 users = pg_users_arg(user_records)
 867                 rspec = RSpec(rspec)
 868                 rspec.filter({'component_manager_id': server_version['urn']})
 869                 rspec = RSpecConverter.to_pg_rspec(rspec.toxml(), content_type='request')
 870                 creds = [slice_cred]
 871             else:
 872                 users = sfa_users_arg(user_records, slice_record)
 873                 creds = [slice_cred]
 874                 if delegated_cred:
 875                     creds.append(delegated_cred)
 876         # do not append users, keys, or slice tags. Anything
 877         # not contained in this request will be removed from the slice
 878         api_options = {}
 879         api_options ['append'] = False
 880         api_options ['call_id'] = unique_call_id()
 881         result = server.CreateSliver(slice_urn, creds, rspec, users, *self.ois(server,api_options))
 882         value = ReturnValue.get_value(result)
 883         if options.file is None:
 884             print value
 885         else:
 886             save_rspec_to_file (value, options.file)
 887         return value
 888
 889     def delete(self, options, args):
 890         """
 891         delete named slice (DeleteSliver)
 892         """
 893         slice_hrn = args[0]
 894         slice_urn = hrn_to_urn(slice_hrn, 'slice')
 895         slice_cred = self.slice_credential_string(slice_hrn)
 896         creds = [slice_cred]
 897         if options.delegate:
 898             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
 899             creds.append(delegated_cred)
 900         server = self.sliceapi()
 901         api_options = {}
 902         api_options ['call_id'] = unique_call_id()
 903         return server.DeleteSliver(slice_urn, creds, *self.ois(server,api_options))
 904
 905     def status(self, options, args):
 906         """
 907         retrieve slice status (SliverStatus)
 908         """
 909         slice_hrn = args[0]
 910         slice_urn = hrn_to_urn(slice_hrn, 'slice')
 911         slice_cred = self.slice_credential_string(slice_hrn)
 912         creds = [slice_cred]
 913         if options.delegate:
 914             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
 915             creds.append(delegated_cred)
 916         server = self.sliceapi()
 917         api_options = {}
 918         api_options ['call_id'] = unique_call_id()
 919         result = server.SliverStatus(slice_urn, creds, *self.ois(server,api_options))
 920         value = ReturnValue.get_value(result)
 921         print value
 922         if options.file:
 923             save_variable_to_file(value, options.file, options.fileformat)
 924
 925     def start(self, options, args):
 926         """
 927         start named slice (Start)
 928         """
 929         slice_hrn = args[0]
 930         slice_urn = hrn_to_urn(slice_hrn, 'slice')
 931         slice_cred = self.slice_credential_string(args[0])
 932         creds = [slice_cred]
 933         if options.delegate:
 934             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
 935             creds.append(delegated_cred)
 936         server = self.sliceapi()
 937         # xxx Thierry - does this not need an api_options as well ?
 938         return server.Start(slice_urn, creds)
 939
 940     def stop(self, options, args):
 941         """
 942         stop named slice (Stop)
 943         """
 944         slice_hrn = args[0]
 945         slice_urn = hrn_to_urn(slice_hrn, 'slice')
 946         slice_cred = self.slice_credential_string(args[0])
 947         creds = [slice_cred]
 948         if options.delegate:
 949             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
 950             creds.append(delegated_cred)
 951         server = self.sliceapi()
 952         return server.Stop(slice_urn, creds)
 953
 954     # reset named slice
 955     def reset(self, options, args):
 956         """
 957         reset named slice (reset_slice)
 958         """
 959         slice_hrn = args[0]
 960         slice_urn = hrn_to_urn(slice_hrn, 'slice')
 961         server = self.sliceapi()
 962         slice_cred = self.slice_credential_string(args[0])
 963         creds = [slice_cred]
 964         if options.delegate:
 965             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
 966             creds.append(delegated_cred)
 967         return server.reset_slice(creds, slice_urn)
 968
 969     def renew(self, options, args):
 970         """
 971         renew slice (RenewSliver)
 972         """
 973         slice_hrn = args[0]
 974         slice_urn = hrn_to_urn(slice_hrn, 'slice')
 975         server = self.sliceapi()
 976         slice_cred = self.slice_credential_string(args[0])
 977         creds = [slice_cred]
 978         if options.delegate:
 979             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
 980             creds.append(delegated_cred)
 981         time = args[1]
 982         api_options = {}
 983         api_options ['call_id'] = unique_call_id()
 984         result =  server.RenewSliver(slice_urn, creds, time, *self.ois(server,api_options))
 985         value = ReturnValue.get_value(result)
 986         return value
 987
 988
 989     def shutdown(self, options, args):
 990         """
 991         shutdown named slice (Shutdown)
 992         """
 993         slice_hrn = args[0]
 994         slice_urn = hrn_to_urn(slice_hrn, 'slice')
 995         slice_cred = self.slice_credential_string(slice_hrn)
 996         creds = [slice_cred]
 997         if options.delegate:
 998             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
 999             creds.append(delegated_cred)
1000         server = self.sliceapi()
1001         return server.Shutdown(slice_urn, creds)
1002
1003
1004     def get_ticket(self, options, args):
1005         """
1006         get a ticket for the specified slice
1007         """
1008         slice_hrn, rspec_path = args[0], args[1]
1009         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1010         slice_cred = self.slice_credential_string(slice_hrn)
1011         creds = [slice_cred]
1012         if options.delegate:
1013             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1014             creds.append(delegated_cred)
1015         rspec_file = self.get_rspec_file(rspec_path)
1016         rspec = open(rspec_file).read()
1017         server = self.sliceapi()
1018         ticket_string = server.GetTicket(slice_urn, creds, rspec, [])
1019         file = os.path.join(self.options.sfi_dir, get_leaf(slice_hrn) + ".ticket")
1020         self.logger.info("writing ticket to %s"%file)
1021         ticket = SfaTicket(string=ticket_string)
1022         ticket.save_to_file(filename=file, save_parents=True)
1023
1024     def redeem_ticket(self, options, args):
1025         """
1026         Connects to nodes in a slice and redeems a ticket
1027 (slice hrn is retrieved from the ticket)
1028         """
1029         ticket_file = args[0]
1030
1031         # get slice hrn from the ticket
1032         # use this to get the right slice credential
1033         ticket = SfaTicket(filename=ticket_file)
1034         ticket.decode()
1035         slice_hrn = ticket.gidObject.get_hrn()
1036         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1037         #slice_hrn = ticket.attributes['slivers'][0]['hrn']
1038         slice_cred = self.slice_credential_string(slice_hrn)
1039
1040         # get a list of node hostnames from the RSpec
1041         tree = etree.parse(StringIO(ticket.rspec))
1042         root = tree.getroot()
1043         hostnames = root.xpath("./network/site/node/hostname/text()")
1044
1045         # create an xmlrpc connection to the component manager at each of these
1046         # components and gall redeem_ticket
1047         connections = {}
1048         for hostname in hostnames:
1049             try:
1050                 self.logger.info("Calling redeem_ticket at %(hostname)s " % locals())
1051                 server = self.server_proxy(hostname, CM_PORT, self.private_key, \
1052                                                self.my_gid, verbose=self.options.debug)
1053                 server.RedeemTicket(ticket.save_to_string(save_parents=True), slice_cred)
1054                 self.logger.info("Success")
1055             except socket.gaierror:
1056                 self.logger.error("redeem_ticket failed: Component Manager not accepting requests")
1057             except Exception, e:
1058                 self.logger.log_exc(e.message)
1059         return
1060
1061     def create_gid(self, options, args):
1062         """
1063         Create a GID (CreateGid)
1064         """
1065         if len(args) < 1:
1066             self.print_help()
1067             sys.exit(1)
1068         target_hrn = args[0]
1069         gid = self.registry().CreateGid(self.my_credential_string, target_hrn, self.bootstrap.my_gid_string())
1070         if options.file:
1071             filename = options.file
1072         else:
1073             filename = os.sep.join([self.options.sfi_dir, '%s.gid' % target_hrn])
1074         self.logger.info("writing %s gid to %s" % (target_hrn, filename))
1075         GID(string=gid).save_to_file(filename)
1076
1077
1078     def delegate(self, options, args):
1079         """
1080         (locally) create delegate credential for use by given hrn
1081         """
1082         delegee_hrn = args[0]
1083         if options.delegate_user:
1084             cred = self.delegate_cred(self.my_credential_string, delegee_hrn, 'user')
1085         elif options.delegate_slice:
1086             slice_cred = self.slice_credential_string(options.delegate_slice)
1087             cred = self.delegate_cred(slice_cred, delegee_hrn, 'slice')
1088         else:
1089             self.logger.warning("Must specify either --user or --slice <hrn>")
1090             return
1091         delegated_cred = Credential(string=cred)
1092         object_hrn = delegated_cred.get_gid_object().get_hrn()
1093         if options.delegate_user:
1094             dest_fn = os.path.join(self.options.sfi_dir, get_leaf(delegee_hrn) + "_"
1095                                   + get_leaf(object_hrn) + ".cred")
1096         elif options.delegate_slice:
1097             dest_fn = os.path.join(self.options.sfi_dir, get_leaf(delegee_hrn) + "_slice_"
1098                                   + get_leaf(object_hrn) + ".cred")
1099
1100         delegated_cred.save_to_file(dest_fn, save_parents=True)
1101
1102         self.logger.info("delegated credential for %s to %s and wrote to %s"%(object_hrn, delegee_hrn,dest_fn))
1103
1104     def get_trusted_certs(self, options, args):
1105         """
1106         return uhe trusted certs at this interface (get_trusted_certs)
1107         """
1108         trusted_certs = self.registry().get_trusted_certs()
1109         for trusted_cert in trusted_certs:
1110             gid = GID(string=trusted_cert)
1111             gid.dump()
1112             cert = Certificate(string=trusted_cert)
1113             self.logger.debug('Sfi.get_trusted_certs -> %r'%cert.get_subject())
1114         return
1115