sfa/client/sfi.py

   1 #
   2 # sfi.py - basic SFA command-line client
   3 # this module is also used in sfascan
   4 #
   5
   6 import sys
   7 sys.path.append('.')
   8
   9 import os, os.path
  10 import socket
  11 import re
  12 import datetime
  13 import codecs
  14 import pickle
  15 import json
  16 import shutil
  17 from lxml import etree
  18 from StringIO import StringIO
  19 from optparse import OptionParser
  20 from pprint import PrettyPrinter
  21 from tempfile import mkstemp
  22
  23 from sfa.trust.certificate import Keypair, Certificate
  24 from sfa.trust.gid import GID
  25 from sfa.trust.credential import Credential
  26 from sfa.trust.sfaticket import SfaTicket
  27
  28 from sfa.util.faults import SfaInvalidArgument
  29 from sfa.util.sfalogging import sfi_logger
  30 from sfa.util.xrn import get_leaf, get_authority, hrn_to_urn, Xrn
  31 from sfa.util.config import Config
  32 from sfa.util.version import version_core
  33 from sfa.util.cache import Cache
  34
  35 from sfa.storage.record import Record
  36
  37 from sfa.rspecs.rspec import RSpec
  38 from sfa.rspecs.rspec_converter import RSpecConverter
  39 from sfa.rspecs.version_manager import VersionManager
  40
  41 from sfa.client.sfaclientlib import SfaClientBootstrap
  42 from sfa.client.sfaserverproxy import SfaServerProxy, ServerException
  43 from sfa.client.client_helper import pg_users_arg, sfa_users_arg
  44 from sfa.client.return_value import ReturnValue
  45 from sfa.client.candidates import Candidates
  46
  47 CM_PORT=12346
  48
  49 # utility methods here
  50 def optparse_listvalue_callback(option, option_string, value, parser):
  51     setattr(parser.values, option.dest, value.split(','))
  52
  53 # a code fragment that could be helpful for argparse which unfortunately is
  54 # available with 2.7 only, so this feels like too strong a requirement for the client side
  55 #class ExtraArgAction  (argparse.Action):
  56 #    def __call__ (self, parser, namespace, values, option_string=None):
  57 # would need a try/except of course
  58 #        (k,v)=values.split('=')
  59 #        d=getattr(namespace,self.dest)
  60 #        d[k]=v
  61 #####
  62 #parser.add_argument ("-X","--extra",dest='extras', default={}, action=ExtraArgAction,
  63 #                     help="set extra flags, testbed dependent, e.g. --extra enabled=true")
  64
  65 def optparse_dictvalue_callback (option, option_string, value, parser):
  66     try:
  67         (k,v)=value.split('=',1)
  68         d=getattr(parser.values, option.dest)
  69         d[k]=v
  70     except:
  71         parser.print_help()
  72         sys.exit(1)
  73
  74 # display methods
  75 def display_rspec(rspec, format='rspec'):
  76     if format in ['dns']:
  77         tree = etree.parse(StringIO(rspec))
  78         root = tree.getroot()
  79         result = root.xpath("./network/site/node/hostname/text()")
  80     elif format in ['ip']:
  81         # The IP address is not yet part of the new RSpec
  82         # so this doesn't do anything yet.
  83         tree = etree.parse(StringIO(rspec))
  84         root = tree.getroot()
  85         result = root.xpath("./network/site/node/ipv4/text()")
  86     else:
  87         result = rspec
  88
  89     print result
  90     return
  91
  92 def display_list(results):
  93     for result in results:
  94         print result
  95
  96 def display_records(recordList, dump=False):
  97     ''' Print all fields in the record'''
  98     for record in recordList:
  99         display_record(record, dump)
 100
 101 def display_record(record, dump=False):
 102     if dump:
 103         record.dump(sort=True)
 104     else:
 105         info = record.getdict()
 106         print "%s (%s)" % (info['hrn'], info['type'])
 107     return
 108
 109
 110 def filter_records(type, records):
 111     filtered_records = []
 112     for record in records:
 113         if (record['type'] == type) or (type == "all"):
 114             filtered_records.append(record)
 115     return filtered_records
 116
 117
 118 def credential_printable (credential_string):
 119     credential=Credential(string=credential_string)
 120     result=""
 121     result += credential.get_summary_tostring()
 122     result += "\n"
 123     rights = credential.get_privileges()
 124     result += "rights=%s"%rights
 125     result += "\n"
 126     return result
 127
 128 def show_credentials (cred_s):
 129     if not isinstance (cred_s,list): cred_s = [cred_s]
 130     for cred in cred_s:
 131         print "Using Credential %s"%credential_printable(cred)
 132
 133 # save methods
 134 def save_raw_to_file(var, filename, format="text", banner=None):
 135     if filename == "-":
 136         # if filename is "-", send it to stdout
 137         f = sys.stdout
 138     else:
 139         f = open(filename, "w")
 140     if banner:
 141         f.write(banner+"\n")
 142     if format == "text":
 143         f.write(str(var))
 144     elif format == "pickled":
 145         f.write(pickle.dumps(var))
 146     elif format == "json":
 147         if hasattr(json, "dumps"):
 148             f.write(json.dumps(var))   # python 2.6
 149         else:
 150             f.write(json.write(var))   # python 2.5
 151     else:
 152         # this should never happen
 153         print "unknown output format", format
 154     if banner:
 155         f.write('\n'+banner+"\n")
 156
 157 def save_rspec_to_file(rspec, filename):
 158     if not filename.endswith(".rspec"):
 159         filename = filename + ".rspec"
 160     f = open(filename, 'w')
 161     f.write(rspec)
 162     f.close()
 163     return
 164
 165 def save_records_to_file(filename, record_dicts, format="xml"):
 166     if format == "xml":
 167         index = 0
 168         for record_dict in record_dicts:
 169             if index > 0:
 170                 save_record_to_file(filename + "." + str(index), record_dict)
 171             else:
 172                 save_record_to_file(filename, record_dict)
 173             index = index + 1
 174     elif format == "xmllist":
 175         f = open(filename, "w")
 176         f.write("<recordlist>\n")
 177         for record_dict in record_dicts:
 178             record_obj=Record(dict=record_dict)
 179             f.write('<record hrn="' + record_obj.hrn + '" type="' + record_obj.type + '" />\n')
 180         f.write("</recordlist>\n")
 181         f.close()
 182     elif format == "hrnlist":
 183         f = open(filename, "w")
 184         for record_dict in record_dicts:
 185             record_obj=Record(dict=record_dict)
 186             f.write(record_obj.hrn + "\n")
 187         f.close()
 188     else:
 189         # this should never happen
 190         print "unknown output format", format
 191
 192 def save_record_to_file(filename, record_dict):
 193     record = Record(dict=record_dict)
 194     xml = record.save_as_xml()
 195     f=codecs.open(filename, encoding='utf-8',mode="w")
 196     f.write(xml)
 197     f.close()
 198     return
 199
 200 # used in sfi list
 201 def terminal_render (records,options):
 202     # sort records by type
 203     grouped_by_type={}
 204     for record in records:
 205         type=record['type']
 206         if type not in grouped_by_type: grouped_by_type[type]=[]
 207         grouped_by_type[type].append(record)
 208     group_types=grouped_by_type.keys()
 209     group_types.sort()
 210     for type in group_types:
 211         group=grouped_by_type[type]
 212 #        print 20 * '-', type
 213         try:    renderer=eval('terminal_render_'+type)
 214         except: renderer=terminal_render_default
 215         for record in group: renderer(record,options)
 216
 217 def render_plural (how_many, name,names=None):
 218     if not names: names="%ss"%name
 219     if how_many<=0: return "No %s"%name
 220     elif how_many==1: return "1 %s"%name
 221     else: return "%d %s"%(how_many,names)
 222
 223 def terminal_render_default (record,options):
 224     print "%s (%s)" % (record['hrn'], record['type'])
 225 def terminal_render_user (record, options):
 226     print "%s (User)"%record['hrn'],
 227     if record.get('reg-pi-authorities',None): print " [PI at %s]"%(" and ".join(record['reg-pi-authorities'])),
 228     if record.get('reg-slices',None): print " [IN slices %s]"%(" and ".join(record['reg-slices'])),
 229     user_keys=record.get('reg-keys',[])
 230     if not options.verbose:
 231         print " [has %s]"%(render_plural(len(user_keys),"key"))
 232     else:
 233         print ""
 234         for key in user_keys: print 8*' ',key.strip("\n")
 235
 236 def terminal_render_slice (record, options):
 237     print "%s (Slice)"%record['hrn'],
 238     if record.get('reg-researchers',None): print " [USERS %s]"%(" and ".join(record['reg-researchers'])),
 239 #    print record.keys()
 240     print ""
 241 def terminal_render_authority (record, options):
 242     print "%s (Authority)"%record['hrn'],
 243     if record.get('reg-pis',None): print " [PIS %s]"%(" and ".join(record['reg-pis'])),
 244     print ""
 245 def terminal_render_node (record, options):
 246     print "%s (Node)"%record['hrn']
 247
 248 # minimally check a key argument
 249 def check_ssh_key (key):
 250     good_ssh_key = r'^.*(?:ssh-dss|ssh-rsa)[ ]+[A-Za-z0-9+/=]+(?: .*)?$'
 251     return re.match(good_ssh_key, key, re.IGNORECASE)
 252
 253 # load methods
 254 def load_record_from_opts(options):
 255     record_dict = {}
 256     if hasattr(options, 'xrn') and options.xrn:
 257         if hasattr(options, 'type') and options.type:
 258             xrn = Xrn(options.xrn, options.type)
 259         else:
 260             xrn = Xrn(options.xrn)
 261         record_dict['urn'] = xrn.get_urn()
 262         record_dict['hrn'] = xrn.get_hrn()
 263         record_dict['type'] = xrn.get_type()
 264     if hasattr(options, 'key') and options.key:
 265         try:
 266             pubkey = open(options.key, 'r').read()
 267         except IOError:
 268             pubkey = options.key
 269         if not check_ssh_key (pubkey):
 270             raise SfaInvalidArgument(name='key',msg="Could not find file, or wrong key format")
 271         record_dict['keys'] = [pubkey]
 272     if hasattr(options, 'slices') and options.slices:
 273         record_dict['slices'] = options.slices
 274     if hasattr(options, 'researchers') and options.researchers:
 275         record_dict['researcher'] = options.researchers
 276     if hasattr(options, 'email') and options.email:
 277         record_dict['email'] = options.email
 278     if hasattr(options, 'pis') and options.pis:
 279         record_dict['pi'] = options.pis
 280
 281     # handle extra settings
 282     record_dict.update(options.extras)
 283
 284     return Record(dict=record_dict)
 285
 286 def load_record_from_file(filename):
 287     f=codecs.open(filename, encoding="utf-8", mode="r")
 288     xml_string = f.read()
 289     f.close()
 290     return Record(xml=xml_string)
 291
 292
 293 import uuid
 294 def unique_call_id(): return uuid.uuid4().urn
 295
 296 class Sfi:
 297
 298     # dirty hack to make this class usable from the outside
 299     required_options=['verbose',  'debug',  'registry',  'sm',  'auth',  'user', 'user_private_key']
 300
 301     @staticmethod
 302     def default_sfi_dir ():
 303         if os.path.isfile("./sfi_config"):
 304             return os.getcwd()
 305         else:
 306             return os.path.expanduser("~/.sfi/")
 307
 308     # dummy to meet Sfi's expectations for its 'options' field
 309     # i.e. s/t we can do setattr on
 310     class DummyOptions:
 311         pass
 312
 313     def __init__ (self,options=None):
 314         if options is None: options=Sfi.DummyOptions()
 315         for opt in Sfi.required_options:
 316             if not hasattr(options,opt): setattr(options,opt,None)
 317         if not hasattr(options,'sfi_dir'): options.sfi_dir=Sfi.default_sfi_dir()
 318         self.options = options
 319         self.user = None
 320         self.authority = None
 321         self.logger = sfi_logger
 322         self.logger.enable_console()
 323         self.available_names = [ tuple[0] for tuple in Sfi.available ]
 324         self.available_dict = dict (Sfi.available)
 325
 326     # tuples command-name expected-args in the order in which they should appear in the help
 327     available = [
 328         ("version", ""),
 329         ("list", "authority"),
 330         ("show", "name"),
 331         ("add", "record"),
 332         ("update", "record"),
 333         ("remove", "name"),
 334         ("slices", ""),
 335         ("resources", "[slice_hrn]"),
 336         ("create", "slice_hrn rspec"),
 337         ("delete", "slice_hrn"),
 338         ("status", "slice_hrn"),
 339         ("start", "slice_hrn"),
 340         ("stop", "slice_hrn"),
 341         ("reset", "slice_hrn"),
 342         ("renew", "slice_hrn time"),
 343         ("shutdown", "slice_hrn"),
 344         ("get_ticket", "slice_hrn rspec"),
 345         ("redeem_ticket", "ticket"),
 346         ("delegate", "name"),
 347         ("gid", "[name]"),
 348         ("trusted", "cred"),
 349         ("config", ""),
 350         ]
 351
 352     def print_command_help (self, options):
 353         verbose=getattr(options,'verbose')
 354         format3="%18s %-15s %s"
 355         line=80*'-'
 356         if not verbose:
 357             print format3%("command","cmd_args","description")
 358             print line
 359         else:
 360             print line
 361             self.create_parser().print_help()
 362         for command in self.available_names:
 363             args=self.available_dict[command]
 364             method=getattr(self,command,None)
 365             doc=""
 366             if method: doc=getattr(method,'__doc__',"")
 367             if not doc: doc="*** no doc found ***"
 368             doc=doc.strip(" \t\n")
 369             doc=doc.replace("\n","\n"+35*' ')
 370             if verbose:
 371                 print line
 372             print format3%(command,args,doc)
 373             if verbose:
 374                 self.create_command_parser(command).print_help()
 375
 376     def create_command_parser(self, command):
 377         if command not in self.available_dict:
 378             msg="Invalid command\n"
 379             msg+="Commands: "
 380             msg += ','.join(self.available_names)
 381             self.logger.critical(msg)
 382             sys.exit(2)
 383
 384         parser = OptionParser(usage="sfi [sfi_options] %s [cmd_options] %s" \
 385                                      % (command, self.available_dict[command]))
 386
 387         if command in ("add", "update"):
 388             parser.add_option('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 389             parser.add_option('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 390             parser.add_option('-e', '--email', dest='email', default="",  help="email (mandatory for users)")
 391 # use --extra instead
 392 #            parser.add_option('-u', '--url', dest='url', metavar='<url>', default=None, help="URL, useful for slices")
 393 #            parser.add_option('-d', '--description', dest='description', metavar='<description>',
 394 #                              help='Description, useful for slices', default=None)
 395             parser.add_option('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 396                               default=None)
 397             parser.add_option('-s', '--slices', dest='slices', metavar='<slices>', help='slice xrns',
 398                               default='', type="str", action='callback', callback=optparse_listvalue_callback)
 399             parser.add_option('-r', '--researchers', dest='researchers', metavar='<researchers>',
 400                               help='slice researchers', default='', type="str", action='callback',
 401                               callback=optparse_listvalue_callback)
 402             parser.add_option('-p', '--pis', dest='pis', metavar='<PIs>', help='Principal Investigators/Project Managers',
 403                               default='', type="str", action='callback', callback=optparse_listvalue_callback)
 404 # use --extra instead
 405 #            parser.add_option('-f', '--firstname', dest='firstname', metavar='<firstname>', help='user first name')
 406 #            parser.add_option('-l', '--lastname', dest='lastname', metavar='<lastname>', help='user last name')
 407             parser.add_option ('-X','--extra',dest='extras',default={},type='str',metavar="<EXTRA_ASSIGNS>",
 408                                action="callback", callback=optparse_dictvalue_callback, nargs=1,
 409                                help="set extra/testbed-dependent flags, e.g. --extra enabled=true")
 410
 411         # user specifies remote aggregate/sm/component
 412         if command in ("resources", "slices", "create", "delete", "start", "stop",
 413                        "restart", "shutdown",  "get_ticket", "renew", "status"):
 414             parser.add_option("-d", "--delegate", dest="delegate", default=None,
 415                              action="store_true",
 416                              help="Include a credential delegated to the user's root "+\
 417                                   "authority in set of credentials for this call")
 418
 419         # show_credential option
 420         if command in ("list","resources","create","add","update","remove","slices","delete","status","renew"):
 421             parser.add_option("-C","--credential",dest='show_credential',action='store_true',default=False,
 422                               help="show credential(s) used in human-readable form")
 423         # registy filter option
 424         if command in ("list", "show", "remove"):
 425             parser.add_option("-t", "--type", dest="type", type="choice",
 426                             help="type filter ([all]|user|slice|authority|node|aggregate)",
 427                             choices=("all", "user", "slice", "authority", "node", "aggregate"),
 428                             default="all")
 429         if command in ("show"):
 430             parser.add_option("-k","--key",dest="keys",action="append",default=[],
 431                               help="specify specific keys to be displayed from record")
 432         if command in ("resources"):
 433             # rspec version
 434             parser.add_option("-r", "--rspec-version", dest="rspec_version", default="SFA 1",
 435                               help="schema type and version of resulting RSpec")
 436             # disable/enable cached rspecs
 437             parser.add_option("-c", "--current", dest="current", default=False,
 438                               action="store_true",
 439                               help="Request the current rspec bypassing the cache. Cached rspecs are returned by default")
 440             # display formats
 441             parser.add_option("-f", "--format", dest="format", type="choice",
 442                              help="display format ([xml]|dns|ip)", default="xml",
 443                              choices=("xml", "dns", "ip"))
 444             #panos: a new option to define the type of information about resources a user is interested in
 445             parser.add_option("-i", "--info", dest="info",
 446                                 help="optional component information", default=None)
 447             # a new option to retreive or not reservation-oriented RSpecs (leases)
 448             parser.add_option("-l", "--list_leases", dest="list_leases", type="choice",
 449                                 help="Retreive or not reservation-oriented RSpecs ([resources]|leases|all )",
 450                                 choices=("all", "resources", "leases"), default="resources")
 451
 452
 453         # 'create' does return the new rspec, makes sense to save that too
 454         if command in ("resources", "show", "list", "gid", 'create'):
 455            parser.add_option("-o", "--output", dest="file",
 456                             help="output XML to file", metavar="FILE", default=None)
 457
 458         if command in ("show", "list"):
 459            parser.add_option("-f", "--format", dest="format", type="choice",
 460                              help="display format ([text]|xml)", default="text",
 461                              choices=("text", "xml"))
 462
 463            parser.add_option("-F", "--fileformat", dest="fileformat", type="choice",
 464                              help="output file format ([xml]|xmllist|hrnlist)", default="xml",
 465                              choices=("xml", "xmllist", "hrnlist"))
 466         if command == 'list':
 467            parser.add_option("-r", "--recursive", dest="recursive", action='store_true',
 468                              help="list all child records", default=False)
 469            parser.add_option("-v", "--verbose", dest="verbose", action='store_true',
 470                              help="gives details, like user keys", default=False)
 471         if command in ("delegate"):
 472            parser.add_option("-u", "--user",
 473                             action="store_true", dest="delegate_user", default=False,
 474                             help="delegate your own credentials")
 475            parser.add_option("-s", "--slice", dest="delegate_slice",
 476                             help="delegate slice credential", metavar="HRN", default=None)
 477            parser.add_option("-a", "--authority", dest='delegate_to_authority', default=None, action='store_true',
 478                              help="""by default the only argument is expected to be a user,
 479 use this if you mean an authority instead""")
 480
 481         if command in ("version"):
 482             parser.add_option("-R","--registry-version",
 483                               action="store_true", dest="version_registry", default=False,
 484                               help="probe registry version instead of sliceapi")
 485             parser.add_option("-l","--local",
 486                               action="store_true", dest="version_local", default=False,
 487                               help="display version of the local client")
 488
 489         return parser
 490
 491
 492     def create_parser(self):
 493
 494         # Generate command line parser
 495         parser = OptionParser(usage="sfi [sfi_options] command [cmd_options] [cmd_args]",
 496                              description="Commands: %s"%(" ".join(self.available_names)))
 497         parser.add_option("-r", "--registry", dest="registry",
 498                          help="root registry", metavar="URL", default=None)
 499         parser.add_option("-s", "--sliceapi", dest="sm", default=None, metavar="URL",
 500                          help="slice API - in general a SM URL, but can be used to talk to an aggregate")
 501         parser.add_option("-R", "--raw", dest="raw", default=None,
 502                           help="Save raw, unparsed server response to a file")
 503         parser.add_option("", "--rawformat", dest="rawformat", type="choice",
 504                           help="raw file format ([text]|pickled|json)", default="text",
 505                           choices=("text","pickled","json"))
 506         parser.add_option("", "--rawbanner", dest="rawbanner", default=None,
 507                           help="text string to write before and after raw output")
 508         parser.add_option("-d", "--dir", dest="sfi_dir",
 509                          help="config & working directory - default is %default",
 510                          metavar="PATH", default=Sfi.default_sfi_dir())
 511         parser.add_option("-u", "--user", dest="user",
 512                          help="user name", metavar="HRN", default=None)
 513         parser.add_option("-a", "--auth", dest="auth",
 514                          help="authority name", metavar="HRN", default=None)
 515         parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0,
 516                          help="verbose mode - cumulative")
 517         parser.add_option("-D", "--debug",
 518                           action="store_true", dest="debug", default=False,
 519                           help="Debug (xml-rpc) protocol messages")
 520         # would it make sense to use ~/.ssh/id_rsa as a default here ?
 521         parser.add_option("-k", "--private-key",
 522                          action="store", dest="user_private_key", default=None,
 523                          help="point to the private key file to use if not yet installed in sfi_dir")
 524         parser.add_option("-t", "--timeout", dest="timeout", default=None,
 525                          help="Amout of time to wait before timing out the request")
 526         parser.add_option("-?", "--commands",
 527                          action="store_true", dest="command_help", default=False,
 528                          help="one page summary on commands & exit")
 529         parser.disable_interspersed_args()
 530
 531         return parser
 532
 533
 534     def print_help (self):
 535         print "==================== Generic sfi usage"
 536         self.sfi_parser.print_help()
 537         print "==================== Specific command usage"
 538         self.command_parser.print_help()
 539
 540     #
 541     # Main: parse arguments and dispatch to command
 542     #
 543     def dispatch(self, command, command_options, command_args):
 544         method=getattr(self, command,None)
 545         if not method:
 546             print "Unknown command %s"%command
 547             return
 548         return method(command_options, command_args)
 549
 550     def main(self):
 551         self.sfi_parser = self.create_parser()
 552         (options, args) = self.sfi_parser.parse_args()
 553         if options.command_help:
 554             self.print_command_help(options)
 555             sys.exit(1)
 556         self.options = options
 557
 558         self.logger.setLevelFromOptVerbose(self.options.verbose)
 559
 560         if len(args) <= 0:
 561             self.logger.critical("No command given. Use -h for help.")
 562             self.print_command_help(options)
 563             return -1
 564
 565         # complete / find unique match with command set
 566         command_candidates = Candidates (self.available_names)
 567         input = args[0]
 568         command = command_candidates.only_match(input)
 569         if not command:
 570             self.print_command_help(options)
 571             sys.exit(1)
 572         # second pass options parsing
 573         self.command_parser = self.create_command_parser(command)
 574         (command_options, command_args) = self.command_parser.parse_args(args[1:])
 575         self.command_options = command_options
 576
 577         self.read_config ()
 578         self.bootstrap ()
 579         self.logger.debug("Command=%s" % command)
 580
 581         try:
 582             self.dispatch(command, command_options, command_args)
 583         except:
 584             self.logger.log_exc ("sfi command %s failed"%command)
 585             sys.exit(1)
 586
 587         return
 588
 589     ####################
 590     def read_config(self):
 591         config_file = os.path.join(self.options.sfi_dir,"sfi_config")
 592         shell_config_file  = os.path.join(self.options.sfi_dir,"sfi_config.sh")
 593         try:
 594             if Config.is_ini(config_file):
 595                 config = Config (config_file)
 596             else:
 597                 # try upgrading from shell config format
 598                 fp, fn = mkstemp(suffix='sfi_config', text=True)
 599                 config = Config(fn)
 600                 # we need to preload the sections we want parsed
 601                 # from the shell config
 602                 config.add_section('sfi')
 603                 config.add_section('sface')
 604                 config.load(config_file)
 605                 # back up old config
 606                 shutil.move(config_file, shell_config_file)
 607                 # write new config
 608                 config.save(config_file)
 609
 610         except:
 611             self.logger.critical("Failed to read configuration file %s"%config_file)
 612             self.logger.info("Make sure to remove the export clauses and to add quotes")
 613             if self.options.verbose==0:
 614                 self.logger.info("Re-run with -v for more details")
 615             else:
 616                 self.logger.log_exc("Could not read config file %s"%config_file)
 617             sys.exit(1)
 618
 619         errors = 0
 620         # Set SliceMgr URL
 621         if (self.options.sm is not None):
 622            self.sm_url = self.options.sm
 623         elif hasattr(config, "SFI_SM"):
 624            self.sm_url = config.SFI_SM
 625         else:
 626            self.logger.error("You need to set e.g. SFI_SM='http://your.slicemanager.url:12347/' in %s" % config_file)
 627            errors += 1
 628
 629         # Set Registry URL
 630         if (self.options.registry is not None):
 631            self.reg_url = self.options.registry
 632         elif hasattr(config, "SFI_REGISTRY"):
 633            self.reg_url = config.SFI_REGISTRY
 634         else:
 635            self.logger.error("You need to set e.g. SFI_REGISTRY='http://your.registry.url:12345/' in %s" % config_file)
 636            errors += 1
 637
 638         # Set user HRN
 639         if (self.options.user is not None):
 640            self.user = self.options.user
 641         elif hasattr(config, "SFI_USER"):
 642            self.user = config.SFI_USER
 643         else:
 644            self.logger.error("You need to set e.g. SFI_USER='plc.princeton.username' in %s" % config_file)
 645            errors += 1
 646
 647         # Set authority HRN
 648         if (self.options.auth is not None):
 649            self.authority = self.options.auth
 650         elif hasattr(config, "SFI_AUTH"):
 651            self.authority = config.SFI_AUTH
 652         else:
 653            self.logger.error("You need to set e.g. SFI_AUTH='plc.princeton' in %s" % config_file)
 654            errors += 1
 655
 656         self.config_file=config_file
 657         if errors:
 658            sys.exit(1)
 659
 660     def show_config (self):
 661         print "From configuration file %s"%self.config_file
 662         flags=[
 663             ('SFI_USER','user'),
 664             ('SFI_AUTH','authority'),
 665             ('SFI_SM','sm_url'),
 666             ('SFI_REGISTRY','reg_url'),
 667             ]
 668         for (external_name, internal_name) in flags:
 669             print "%s='%s'"%(external_name,getattr(self,internal_name))
 670
 671     #
 672     # Get various credential and spec files
 673     #
 674     # Establishes limiting conventions
 675     #   - conflates MAs and SAs
 676     #   - assumes last token in slice name is unique
 677     #
 678     # Bootstraps credentials
 679     #   - bootstrap user credential from self-signed certificate
 680     #   - bootstrap authority credential from user credential
 681     #   - bootstrap slice credential from user credential
 682     #
 683
 684     # init self-signed cert, user credentials and gid
 685     def bootstrap (self):
 686         client_bootstrap = SfaClientBootstrap (self.user, self.reg_url, self.options.sfi_dir,
 687                                                logger=self.logger)
 688         # if -k is provided, use this to initialize private key
 689         if self.options.user_private_key:
 690             client_bootstrap.init_private_key_if_missing (self.options.user_private_key)
 691         else:
 692             # trigger legacy compat code if needed
 693             # the name has changed from just <leaf>.pkey to <hrn>.pkey
 694             if not os.path.isfile(client_bootstrap.private_key_filename()):
 695                 self.logger.info ("private key not found, trying legacy name")
 696                 try:
 697                     legacy_private_key = os.path.join (self.options.sfi_dir, "%s.pkey"%Xrn.unescape(get_leaf(self.user)))
 698                     self.logger.debug("legacy_private_key=%s"%legacy_private_key)
 699                     client_bootstrap.init_private_key_if_missing (legacy_private_key)
 700                     self.logger.info("Copied private key from legacy location %s"%legacy_private_key)
 701                 except:
 702                     self.logger.log_exc("Can't find private key ")
 703                     sys.exit(1)
 704
 705         # make it bootstrap
 706         client_bootstrap.bootstrap_my_gid()
 707         # extract what's needed
 708         self.private_key = client_bootstrap.private_key()
 709         self.my_credential_string = client_bootstrap.my_credential_string ()
 710         self.my_gid = client_bootstrap.my_gid ()
 711         self.client_bootstrap = client_bootstrap
 712
 713
 714     def my_authority_credential_string(self):
 715         if not self.authority:
 716             self.logger.critical("no authority specified. Use -a or set SF_AUTH")
 717             sys.exit(-1)
 718         return self.client_bootstrap.authority_credential_string (self.authority)
 719
 720     def slice_credential_string(self, name):
 721         return self.client_bootstrap.slice_credential_string (name)
 722
 723     #
 724     # Management of the servers
 725     #
 726
 727     def registry (self):
 728         # cache the result
 729         if not hasattr (self, 'registry_proxy'):
 730             self.logger.info("Contacting Registry at: %s"%self.reg_url)
 731             self.registry_proxy = SfaServerProxy(self.reg_url, self.private_key, self.my_gid,
 732                                                  timeout=self.options.timeout, verbose=self.options.debug)
 733         return self.registry_proxy
 734
 735     def sliceapi (self):
 736         # cache the result
 737         if not hasattr (self, 'sliceapi_proxy'):
 738             # if the command exposes the --component option, figure it's hostname and connect at CM_PORT
 739             if hasattr(self.command_options,'component') and self.command_options.component:
 740                 # resolve the hrn at the registry
 741                 node_hrn = self.command_options.component
 742                 records = self.registry().Resolve(node_hrn, self.my_credential_string)
 743                 records = filter_records('node', records)
 744                 if not records:
 745                     self.logger.warning("No such component:%r"% opts.component)
 746                 record = records[0]
 747                 cm_url = "http://%s:%d/"%(record['hostname'],CM_PORT)
 748                 self.sliceapi_proxy=SfaServerProxy(cm_url, self.private_key, self.my_gid)
 749             else:
 750                 # otherwise use what was provided as --sliceapi, or SFI_SM in the config
 751                 if not self.sm_url.startswith('http://') or self.sm_url.startswith('https://'):
 752                     self.sm_url = 'http://' + self.sm_url
 753                 self.logger.info("Contacting Slice Manager at: %s"%self.sm_url)
 754                 self.sliceapi_proxy = SfaServerProxy(self.sm_url, self.private_key, self.my_gid,
 755                                                      timeout=self.options.timeout, verbose=self.options.debug)
 756         return self.sliceapi_proxy
 757
 758     def get_cached_server_version(self, server):
 759         # check local cache first
 760         cache = None
 761         version = None
 762         cache_file = os.path.join(self.options.sfi_dir,'sfi_cache.dat')
 763         cache_key = server.url + "-version"
 764         try:
 765             cache = Cache(cache_file)
 766         except IOError:
 767             cache = Cache()
 768             self.logger.info("Local cache not found at: %s" % cache_file)
 769
 770         if cache:
 771             version = cache.get(cache_key)
 772
 773         if not version:
 774             result = server.GetVersion()
 775             version= ReturnValue.get_value(result)
 776             # cache version for 20 minutes
 777             cache.add(cache_key, version, ttl= 60*20)
 778             self.logger.info("Updating cache file %s" % cache_file)
 779             cache.save_to_file(cache_file)
 780
 781         return version
 782
 783     ### resurrect this temporarily so we can support V1 aggregates for a while
 784     def server_supports_options_arg(self, server):
 785         """
 786         Returns true if server support the optional call_id arg, false otherwise.
 787         """
 788         server_version = self.get_cached_server_version(server)
 789         result = False
 790         # xxx need to rewrite this
 791         if int(server_version.get('geni_api')) >= 2:
 792             result = True
 793         return result
 794
 795     def server_supports_call_id_arg(self, server):
 796         server_version = self.get_cached_server_version(server)
 797         result = False
 798         if 'sfa' in server_version and 'code_tag' in server_version:
 799             code_tag = server_version['code_tag']
 800             code_tag_parts = code_tag.split("-")
 801             version_parts = code_tag_parts[0].split(".")
 802             major, minor = version_parts[0], version_parts[1]
 803             rev = code_tag_parts[1]
 804             if int(major) == 1 and minor == 0 and build >= 22:
 805                 result = True
 806         return result
 807
 808     ### ois = options if supported
 809     # to be used in something like serverproxy.Method (arg1, arg2, *self.ois(api_options))
 810     def ois (self, server, option_dict):
 811         if self.server_supports_options_arg (server):
 812             return [option_dict]
 813         elif self.server_supports_call_id_arg (server):
 814             return [ unique_call_id () ]
 815         else:
 816             return []
 817
 818     ### cis = call_id if supported - like ois
 819     def cis (self, server):
 820         if self.server_supports_call_id_arg (server):
 821             return [ unique_call_id ]
 822         else:
 823             return []
 824
 825     ######################################## miscell utilities
 826     def get_rspec_file(self, rspec):
 827        if (os.path.isabs(rspec)):
 828           file = rspec
 829        else:
 830           file = os.path.join(self.options.sfi_dir, rspec)
 831        if (os.path.isfile(file)):
 832           return file
 833        else:
 834           self.logger.critical("No such rspec file %s"%rspec)
 835           sys.exit(1)
 836
 837     def get_record_file(self, record):
 838        if (os.path.isabs(record)):
 839           file = record
 840        else:
 841           file = os.path.join(self.options.sfi_dir, record)
 842        if (os.path.isfile(file)):
 843           return file
 844        else:
 845           self.logger.critical("No such registry record file %s"%record)
 846           sys.exit(1)
 847
 848
 849     #==========================================================================
 850     # Following functions implement the commands
 851     #
 852     # Registry-related commands
 853     #==========================================================================
 854
 855     def version(self, options, args):
 856         """
 857         display an SFA server version (GetVersion)
 858 or version information about sfi itself
 859         """
 860         if options.version_local:
 861             version=version_core()
 862         else:
 863             if options.version_registry:
 864                 server=self.registry()
 865             else:
 866                 server = self.sliceapi()
 867             result = server.GetVersion()
 868             version = ReturnValue.get_value(result)
 869         if self.options.raw:
 870             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
 871         else:
 872             pprinter = PrettyPrinter(indent=4)
 873             pprinter.pprint(version)
 874
 875     def list(self, options, args):
 876         """
 877         list entries in named authority registry (List)
 878         """
 879         if len(args)!= 1:
 880             self.print_help()
 881             sys.exit(1)
 882         hrn = args[0]
 883         opts = {}
 884         if options.recursive:
 885             opts['recursive'] = options.recursive
 886
 887         if options.show_credential:
 888             show_credentials(self.my_credential_string)
 889         try:
 890             list = self.registry().List(hrn, self.my_credential_string, options)
 891         except IndexError:
 892             raise Exception, "Not enough parameters for the 'list' command"
 893
 894         # filter on person, slice, site, node, etc.
 895         # This really should be in the self.filter_records funct def comment...
 896         list = filter_records(options.type, list)
 897         terminal_render (list, options)
 898         if options.file:
 899             save_records_to_file(options.file, list, options.fileformat)
 900         return
 901
 902     def show(self, options, args):
 903         """
 904         show details about named registry record (Resolve)
 905         """
 906         if len(args)!= 1:
 907             self.print_help()
 908             sys.exit(1)
 909         hrn = args[0]
 910         # explicitly require Resolve to run in details mode
 911         record_dicts = self.registry().Resolve(hrn, self.my_credential_string, {'details':True})
 912         record_dicts = filter_records(options.type, record_dicts)
 913         if not record_dicts:
 914             self.logger.error("No record of type %s"% options.type)
 915             return
 916         # user has required to focus on some keys
 917         if options.keys:
 918             def project (record):
 919                 projected={}
 920                 for key in options.keys:
 921                     try: projected[key]=record[key]
 922                     except: pass
 923                 return projected
 924             record_dicts = [ project (record) for record in record_dicts ]
 925         records = [ Record(dict=record_dict) for record_dict in record_dicts ]
 926         for record in records:
 927             if (options.format == "text"):      record.dump(sort=True)
 928             else:                               print record.save_as_xml()
 929         if options.file:
 930             save_records_to_file(options.file, record_dicts, options.fileformat)
 931         return
 932
 933     def add(self, options, args):
 934         "add record into registry from xml file (Register)"
 935         auth_cred = self.my_authority_credential_string()
 936         if options.show_credential:
 937             show_credentials(auth_cred)
 938         record_dict = {}
 939         if len(args) > 0:
 940             record_filepath = args[0]
 941             rec_file = self.get_record_file(record_filepath)
 942             record_dict.update(load_record_from_file(rec_file).todict())
 943         if options:
 944             record_dict.update(load_record_from_opts(options).todict())
 945         # we should have a type by now
 946         if 'type' not in record_dict :
 947             self.print_help()
 948             sys.exit(1)
 949         # this is still planetlab dependent.. as plc will whine without that
 950         # also, it's only for adding
 951         if record_dict['type'] == 'user':
 952             if not 'first_name' in record_dict:
 953                 record_dict['first_name'] = record_dict['hrn']
 954             if 'last_name' not in record_dict:
 955                 record_dict['last_name'] = record_dict['hrn']
 956         return self.registry().Register(record_dict, auth_cred)
 957
 958     def update(self, options, args):
 959         "update record into registry from xml file (Update)"
 960         record_dict = {}
 961         if len(args) > 0:
 962             record_filepath = args[0]
 963             rec_file = self.get_record_file(record_filepath)
 964             record_dict.update(load_record_from_file(rec_file).todict())
 965         if options:
 966             record_dict.update(load_record_from_opts(options).todict())
 967         # at the very least we need 'type' here
 968         if 'type' not in record_dict:
 969             self.print_help()
 970             sys.exit(1)
 971
 972         # don't translate into an object, as this would possibly distort
 973         # user-provided data; e.g. add an 'email' field to Users
 974         if record_dict['type'] == "user":
 975             if record_dict['hrn'] == self.user:
 976                 cred = self.my_credential_string
 977             else:
 978                 cred = self.my_authority_credential_string()
 979         elif record_dict['type'] in ["slice"]:
 980             try:
 981                 cred = self.slice_credential_string(record_dict['hrn'])
 982             except ServerException, e:
 983                # XXX smbaker -- once we have better error return codes, update this
 984                # to do something better than a string compare
 985                if "Permission error" in e.args[0]:
 986                    cred = self.my_authority_credential_string()
 987                else:
 988                    raise
 989         elif record_dict['type'] in ["authority"]:
 990             cred = self.my_authority_credential_string()
 991         elif record_dict['type'] == 'node':
 992             cred = self.my_authority_credential_string()
 993         else:
 994             raise "unknown record type" + record_dict['type']
 995         if options.show_credential:
 996             show_credentials(cred)
 997         return self.registry().Update(record_dict, cred)
 998
 999     def remove(self, options, args):
1000         "remove registry record by name (Remove)"
1001         auth_cred = self.my_authority_credential_string()
1002         if len(args)!=1:
1003             self.print_help()
1004             sys.exit(1)
1005         hrn = args[0]
1006         type = options.type
1007         if type in ['all']:
1008             type = '*'
1009         if options.show_credential:
1010             show_credentials(auth_cred)
1011         return self.registry().Remove(hrn, auth_cred, type)
1012
1013     # ==================================================================
1014     # Slice-related commands
1015     # ==================================================================
1016
1017     def slices(self, options, args):
1018         "list instantiated slices (ListSlices) - returns urn's"
1019         server = self.sliceapi()
1020         # creds
1021         creds = [self.my_credential_string]
1022         if options.delegate:
1023             delegated_cred = self.delegate_cred(self.my_credential_string, get_authority(self.authority))
1024             creds.append(delegated_cred)
1025         # options and call_id when supported
1026         api_options = {}
1027         api_options['call_id']=unique_call_id()
1028         if options.show_credential:
1029             show_credentials(creds)
1030         result = server.ListSlices(creds, *self.ois(server,api_options))
1031         value = ReturnValue.get_value(result)
1032         if self.options.raw:
1033             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1034         else:
1035             display_list(value)
1036         return
1037
1038     # show rspec for named slice
1039     def resources(self, options, args):
1040         """
1041         with no arg, discover available resources, (ListResources)
1042 or with an slice hrn, shows currently provisioned resources
1043         """
1044         server = self.sliceapi()
1045
1046         # set creds
1047         creds = []
1048         if args:
1049             the_credential=self.slice_credential_string(args[0])
1050             creds.append(the_credential)
1051         else:
1052             the_credential=self.my_credential_string
1053             creds.append(the_credential)
1054         if options.delegate:
1055             creds.append(self.delegate_cred(the_credential, get_authority(self.authority)))
1056         if options.show_credential:
1057             show_credentials(creds)
1058
1059         # no need to check if server accepts the options argument since the options has
1060         # been a required argument since v1 API
1061         api_options = {}
1062         # always send call_id to v2 servers
1063         api_options ['call_id'] = unique_call_id()
1064         # ask for cached value if available
1065         api_options ['cached'] = True
1066         if args:
1067             hrn = args[0]
1068             api_options['geni_slice_urn'] = hrn_to_urn(hrn, 'slice')
1069         if options.info:
1070             api_options['info'] = options.info
1071         if options.list_leases:
1072             api_options['list_leases'] = options.list_leases
1073         if options.current:
1074             if options.current == True:
1075                 api_options['cached'] = False
1076             else:
1077                 api_options['cached'] = True
1078         if options.rspec_version:
1079             version_manager = VersionManager()
1080             server_version = self.get_cached_server_version(server)
1081             if 'sfa' in server_version:
1082                 # just request the version the client wants
1083                 api_options['geni_rspec_version'] = version_manager.get_version(options.rspec_version).to_dict()
1084             else:
1085                 api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'}
1086         else:
1087             api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'}
1088         result = server.ListResources (creds, api_options)
1089         value = ReturnValue.get_value(result)
1090         if self.options.raw:
1091             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1092         if options.file is not None:
1093             save_rspec_to_file(value, options.file)
1094         if (self.options.raw is None) and (options.file is None):
1095             display_rspec(value, options.format)
1096
1097         return
1098
1099     def create(self, options, args):
1100         """
1101         create or update named slice with given rspec
1102         """
1103         server = self.sliceapi()
1104
1105         # xxx do we need to check usage (len(args)) ?
1106         # slice urn
1107         slice_hrn = args[0]
1108         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1109
1110         # credentials
1111         creds = [self.slice_credential_string(slice_hrn)]
1112
1113         delegated_cred = None
1114         server_version = self.get_cached_server_version(server)
1115         if server_version.get('interface') == 'slicemgr':
1116             # delegate our cred to the slice manager
1117             # do not delegate cred to slicemgr...not working at the moment
1118             pass
1119             #if server_version.get('hrn'):
1120             #    delegated_cred = self.delegate_cred(slice_cred, server_version['hrn'])
1121             #elif server_version.get('urn'):
1122             #    delegated_cred = self.delegate_cred(slice_cred, urn_to_hrn(server_version['urn']))
1123
1124         if options.show_credential:
1125             show_credentials(creds)
1126
1127         # rspec
1128         rspec_file = self.get_rspec_file(args[1])
1129         rspec = open(rspec_file).read()
1130
1131         # users
1132         # need to pass along user keys to the aggregate.
1133         # users = [
1134         #  { urn: urn:publicid:IDN+emulab.net+user+alice
1135         #    keys: [<ssh key A>, <ssh key B>]
1136         #  }]
1137         users = []
1138         # xxx Thierry 2012 sept. 21
1139         # contrary to what I was first thinking, calling Resolve with details=False does not yet work properly here
1140         # I am turning details=True on again on a - hopefully - temporary basis, just to get this whole thing to work again
1141         slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string])
1142         # slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string], {'details':True})
1143         if slice_records and 'reg-researchers' in slice_records[0] and slice_records[0]['reg-researchers']:
1144             slice_record = slice_records[0]
1145             user_hrns = slice_record['reg-researchers']
1146             user_urns = [hrn_to_urn(hrn, 'user') for hrn in user_hrns]
1147             user_records = self.registry().Resolve(user_urns, [self.my_credential_string])
1148
1149             if 'sfa' not in server_version:
1150                 users = pg_users_arg(user_records)
1151                 rspec = RSpec(rspec)
1152                 rspec.filter({'component_manager_id': server_version['urn']})
1153                 rspec = RSpecConverter.to_pg_rspec(rspec.toxml(), content_type='request')
1154             else:
1155                 users = sfa_users_arg(user_records, slice_record)
1156
1157         # do not append users, keys, or slice tags. Anything
1158         # not contained in this request will be removed from the slice
1159
1160         # CreateSliver has supported the options argument for a while now so it should
1161         # be safe to assume this server support it
1162         api_options = {}
1163         api_options ['append'] = False
1164         api_options ['call_id'] = unique_call_id()
1165         result = server.CreateSliver(slice_urn, creds, rspec, users, *self.ois(server, api_options))
1166         value = ReturnValue.get_value(result)
1167         if self.options.raw:
1168             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1169         if options.file is not None:
1170             save_rspec_to_file (value, options.file)
1171         if (self.options.raw is None) and (options.file is None):
1172             print value
1173
1174         return value
1175
1176     def delete(self, options, args):
1177         """
1178         delete named slice (DeleteSliver)
1179         """
1180         server = self.sliceapi()
1181
1182         # slice urn
1183         slice_hrn = args[0]
1184         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1185
1186         # creds
1187         slice_cred = self.slice_credential_string(slice_hrn)
1188         creds = [slice_cred]
1189         if options.delegate:
1190             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1191             creds.append(delegated_cred)
1192
1193         # options and call_id when supported
1194         api_options = {}
1195         api_options ['call_id'] = unique_call_id()
1196         if options.show_credential:
1197             show_credentials(creds)
1198         result = server.DeleteSliver(slice_urn, creds, *self.ois(server, api_options ) )
1199         value = ReturnValue.get_value(result)
1200         if self.options.raw:
1201             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1202         else:
1203             print value
1204         return value
1205
1206     def status(self, options, args):
1207         """
1208         retrieve slice status (SliverStatus)
1209         """
1210         server = self.sliceapi()
1211
1212         # slice urn
1213         slice_hrn = args[0]
1214         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1215
1216         # creds
1217         slice_cred = self.slice_credential_string(slice_hrn)
1218         creds = [slice_cred]
1219         if options.delegate:
1220             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1221             creds.append(delegated_cred)
1222
1223         # options and call_id when supported
1224         api_options = {}
1225         api_options['call_id']=unique_call_id()
1226         if options.show_credential:
1227             show_credentials(creds)
1228         result = server.SliverStatus(slice_urn, creds, *self.ois(server,api_options))
1229         value = ReturnValue.get_value(result)
1230         if self.options.raw:
1231             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1232         else:
1233             print value
1234
1235     def start(self, options, args):
1236         """
1237         start named slice (Start)
1238         """
1239         server = self.sliceapi()
1240
1241         # the slice urn
1242         slice_hrn = args[0]
1243         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1244
1245         # cred
1246         slice_cred = self.slice_credential_string(args[0])
1247         creds = [slice_cred]
1248         if options.delegate:
1249             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1250             creds.append(delegated_cred)
1251         # xxx Thierry - does this not need an api_options as well ?
1252         result = server.Start(slice_urn, creds)
1253         value = ReturnValue.get_value(result)
1254         if self.options.raw:
1255             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1256         else:
1257             print value
1258         return value
1259
1260     def stop(self, options, args):
1261         """
1262         stop named slice (Stop)
1263         """
1264         server = self.sliceapi()
1265         # slice urn
1266         slice_hrn = args[0]
1267         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1268         # cred
1269         slice_cred = self.slice_credential_string(args[0])
1270         creds = [slice_cred]
1271         if options.delegate:
1272             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1273             creds.append(delegated_cred)
1274         result =  server.Stop(slice_urn, creds)
1275         value = ReturnValue.get_value(result)
1276         if self.options.raw:
1277             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1278         else:
1279             print value
1280         return value
1281
1282     # reset named slice
1283     def reset(self, options, args):
1284         """
1285         reset named slice (reset_slice)
1286         """
1287         server = self.sliceapi()
1288         # slice urn
1289         slice_hrn = args[0]
1290         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1291         # cred
1292         slice_cred = self.slice_credential_string(args[0])
1293         creds = [slice_cred]
1294         if options.delegate:
1295             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1296             creds.append(delegated_cred)
1297         result = server.reset_slice(creds, slice_urn)
1298         value = ReturnValue.get_value(result)
1299         if self.options.raw:
1300             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1301         else:
1302             print value
1303         return value
1304
1305     def renew(self, options, args):
1306         """
1307         renew slice (RenewSliver)
1308         """
1309         server = self.sliceapi()
1310         if len(args) != 2:
1311             self.print_help()
1312             sys.exit(1)
1313         [ slice_hrn, input_time ] = args
1314         # slice urn
1315         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1316         # time: don't try to be smart on the time format, server-side will
1317         # creds
1318         slice_cred = self.slice_credential_string(args[0])
1319         creds = [slice_cred]
1320         if options.delegate:
1321             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1322             creds.append(delegated_cred)
1323         # options and call_id when supported
1324         api_options = {}
1325         api_options['call_id']=unique_call_id()
1326         if options.show_credential:
1327             show_credentials(creds)
1328         result =  server.RenewSliver(slice_urn, creds, input_time, *self.ois(server,api_options))
1329         value = ReturnValue.get_value(result)
1330         if self.options.raw:
1331             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1332         else:
1333             print value
1334         return value
1335
1336
1337     def shutdown(self, options, args):
1338         """
1339         shutdown named slice (Shutdown)
1340         """
1341         server = self.sliceapi()
1342         # slice urn
1343         slice_hrn = args[0]
1344         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1345         # creds
1346         slice_cred = self.slice_credential_string(slice_hrn)
1347         creds = [slice_cred]
1348         if options.delegate:
1349             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1350             creds.append(delegated_cred)
1351         result = server.Shutdown(slice_urn, creds)
1352         value = ReturnValue.get_value(result)
1353         if self.options.raw:
1354             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1355         else:
1356             print value
1357         return value
1358
1359
1360     def get_ticket(self, options, args):
1361         """
1362         get a ticket for the specified slice
1363         """
1364         server = self.sliceapi()
1365         # slice urn
1366         slice_hrn, rspec_path = args[0], args[1]
1367         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1368         # creds
1369         slice_cred = self.slice_credential_string(slice_hrn)
1370         creds = [slice_cred]
1371         if options.delegate:
1372             delegated_cred = self.delegate_cred(slice_cred, get_authority(self.authority))
1373             creds.append(delegated_cred)
1374         # rspec
1375         rspec_file = self.get_rspec_file(rspec_path)
1376         rspec = open(rspec_file).read()
1377         # options and call_id when supported
1378         api_options = {}
1379         api_options['call_id']=unique_call_id()
1380         # get ticket at the server
1381         ticket_string = server.GetTicket(slice_urn, creds, rspec, *self.ois(server,api_options))
1382         # save
1383         file = os.path.join(self.options.sfi_dir, get_leaf(slice_hrn) + ".ticket")
1384         self.logger.info("writing ticket to %s"%file)
1385         ticket = SfaTicket(string=ticket_string)
1386         ticket.save_to_file(filename=file, save_parents=True)
1387
1388     def redeem_ticket(self, options, args):
1389         """
1390         Connects to nodes in a slice and redeems a ticket
1391 (slice hrn is retrieved from the ticket)
1392         """
1393         ticket_file = args[0]
1394
1395         # get slice hrn from the ticket
1396         # use this to get the right slice credential
1397         ticket = SfaTicket(filename=ticket_file)
1398         ticket.decode()
1399         ticket_string = ticket.save_to_string(save_parents=True)
1400
1401         slice_hrn = ticket.gidObject.get_hrn()
1402         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1403         #slice_hrn = ticket.attributes['slivers'][0]['hrn']
1404         slice_cred = self.slice_credential_string(slice_hrn)
1405
1406         # get a list of node hostnames from the RSpec
1407         tree = etree.parse(StringIO(ticket.rspec))
1408         root = tree.getroot()
1409         hostnames = root.xpath("./network/site/node/hostname/text()")
1410
1411         # create an xmlrpc connection to the component manager at each of these
1412         # components and gall redeem_ticket
1413         connections = {}
1414         for hostname in hostnames:
1415             try:
1416                 self.logger.info("Calling redeem_ticket at %(hostname)s " % locals())
1417                 cm_url="http://%s:%s/"%(hostname,CM_PORT)
1418                 server = SfaServerProxy(cm_url, self.private_key, self.my_gid)
1419                 server = self.server_proxy(hostname, CM_PORT, self.private_key,
1420                                            timeout=self.options.timeout, verbose=self.options.debug)
1421                 server.RedeemTicket(ticket_string, slice_cred)
1422                 self.logger.info("Success")
1423             except socket.gaierror:
1424                 self.logger.error("redeem_ticket failed on %s: Component Manager not accepting requests"%hostname)
1425             except Exception, e:
1426                 self.logger.log_exc(e.message)
1427         return
1428
1429     def gid(self, options, args):
1430         """
1431         Create a GID (CreateGid)
1432         """
1433         if len(args) < 1:
1434             self.print_help()
1435             sys.exit(1)
1436         target_hrn = args[0]
1437         gid = self.registry().CreateGid(self.my_credential_string, target_hrn, self.client_bootstrap.my_gid_string())
1438         if options.file:
1439             filename = options.file
1440         else:
1441             filename = os.sep.join([self.options.sfi_dir, '%s.gid' % target_hrn])
1442         self.logger.info("writing %s gid to %s" % (target_hrn, filename))
1443         GID(string=gid).save_to_file(filename)
1444
1445
1446     def delegate (self, options, args):
1447         """
1448         (locally) create delegate credential for use by given hrn
1449         """
1450         if len(args) != 1:
1451             self.print_help()
1452             sys.exit(1)
1453         to_hrn = args[0]
1454         print 'to_hrn',to_hrn
1455         if options.delegate_to_authority:       to_type='authority'
1456         else:                                   to_type='user'
1457         if options.delegate_user:
1458             message="%s.user"%self.user
1459             original = self.my_credential_string
1460         elif options.delegate_slice:
1461             message="%s.slice"%options.delegate_slice
1462             original = self.slice_credential_string(options.delegate_slice)
1463         else:
1464             self.logger.warning("Must specify either --user or --slice <hrn>")
1465             return
1466         delegated_string = self.client_bootstrap.delegate_credential_string(original, to_hrn, to_type)
1467         delegated_credential = Credential (string=delegated_string)
1468         filename = os.path.join ( self.options.sfi_dir,
1469                                   "%s_for_%s.%s.cred"%(message,to_hrn,to_type))
1470         delegated_credential.save_to_file(filename, save_parents=True)
1471         self.logger.info("delegated credential for %s to %s and wrote to %s"%(message,to_hrn,filename))
1472
1473     def trusted(self, options, args):
1474         """
1475         return uhe trusted certs at this interface (get_trusted_certs)
1476         """
1477         trusted_certs = self.registry().get_trusted_certs()
1478         for trusted_cert in trusted_certs:
1479             gid = GID(string=trusted_cert)
1480             gid.dump()
1481             cert = Certificate(string=trusted_cert)
1482             self.logger.debug('Sfi.trusted -> %r'%cert.get_subject())
1483         return
1484
1485     def config (self, options, args):
1486         "Display contents of current config"
1487         self.show_config()