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", "to_hrn"),
 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         # show_credential option
 412         if command in ("list","resources","create","add","update","remove","slices","delete","status","renew"):
 413             parser.add_option("-C","--credential",dest='show_credential',action='store_true',default=False,
 414                               help="show credential(s) used in human-readable form")
 415         # registy filter option
 416         if command in ("list", "show", "remove"):
 417             parser.add_option("-t", "--type", dest="type", type="choice",
 418                             help="type filter ([all]|user|slice|authority|node|aggregate)",
 419                             choices=("all", "user", "slice", "authority", "node", "aggregate"),
 420                             default="all")
 421         if command in ("show"):
 422             parser.add_option("-k","--key",dest="keys",action="append",default=[],
 423                               help="specify specific keys to be displayed from record")
 424         if command in ("resources"):
 425             # rspec version
 426             parser.add_option("-r", "--rspec-version", dest="rspec_version", default="SFA 1",
 427                               help="schema type and version of resulting RSpec")
 428             # disable/enable cached rspecs
 429             parser.add_option("-c", "--current", dest="current", default=False,
 430                               action="store_true",
 431                               help="Request the current rspec bypassing the cache. Cached rspecs are returned by default")
 432             # display formats
 433             parser.add_option("-f", "--format", dest="format", type="choice",
 434                              help="display format ([xml]|dns|ip)", default="xml",
 435                              choices=("xml", "dns", "ip"))
 436             #panos: a new option to define the type of information about resources a user is interested in
 437             parser.add_option("-i", "--info", dest="info",
 438                                 help="optional component information", default=None)
 439             # a new option to retreive or not reservation-oriented RSpecs (leases)
 440             parser.add_option("-l", "--list_leases", dest="list_leases", type="choice",
 441                                 help="Retreive or not reservation-oriented RSpecs ([resources]|leases|all )",
 442                                 choices=("all", "resources", "leases"), default="resources")
 443
 444
 445         # 'create' does return the new rspec, makes sense to save that too
 446         if command in ("resources", "show", "list", "gid", 'create'):
 447            parser.add_option("-o", "--output", dest="file",
 448                             help="output XML to file", metavar="FILE", default=None)
 449
 450         if command in ("show", "list"):
 451            parser.add_option("-f", "--format", dest="format", type="choice",
 452                              help="display format ([text]|xml)", default="text",
 453                              choices=("text", "xml"))
 454
 455            parser.add_option("-F", "--fileformat", dest="fileformat", type="choice",
 456                              help="output file format ([xml]|xmllist|hrnlist)", default="xml",
 457                              choices=("xml", "xmllist", "hrnlist"))
 458         if command == 'list':
 459            parser.add_option("-r", "--recursive", dest="recursive", action='store_true',
 460                              help="list all child records", default=False)
 461            parser.add_option("-v", "--verbose", dest="verbose", action='store_true',
 462                              help="gives details, like user keys", default=False)
 463         if command in ("delegate"):
 464            parser.add_option("-u", "--user",
 465                              action="store_true", dest="delegate_user", default=False,
 466                              help="delegate your own credentials; default if no other option is provided")
 467            parser.add_option("-s", "--slice", dest="delegate_slices",action='append',default=[],
 468                              metavar="slice_hrn", help="delegate cred. for slice HRN")
 469            parser.add_option("-a", "--auths", dest='delegate_auths',action='append',default=[],
 470                              metavar='auth_hrn', help="delegate cred for auth HRN")
 471            # this primarily is a shorthand for -a my_hrn^
 472            parser.add_option("-p", "--pi", dest='delegate_pi', default=None, action='store_true',
 473                              help="delegate your PI credentials, so s.t. like -a your_hrn^")
 474            parser.add_option("-A","--to-authority",dest='delegate_to_authority',action='store_true',default=False,
 475                              help="""by default the mandatory argument is expected to be a user,
 476 use this if you mean an authority instead""")
 477
 478         if command in ("version"):
 479             parser.add_option("-R","--registry-version",
 480                               action="store_true", dest="version_registry", default=False,
 481                               help="probe registry version instead of sliceapi")
 482             parser.add_option("-l","--local",
 483                               action="store_true", dest="version_local", default=False,
 484                               help="display version of the local client")
 485
 486         return parser
 487
 488
 489     def create_parser(self):
 490
 491         # Generate command line parser
 492         parser = OptionParser(usage="sfi [sfi_options] command [cmd_options] [cmd_args]",
 493                              description="Commands: %s"%(" ".join(self.available_names)))
 494         parser.add_option("-r", "--registry", dest="registry",
 495                          help="root registry", metavar="URL", default=None)
 496         parser.add_option("-s", "--sliceapi", dest="sm", default=None, metavar="URL",
 497                          help="slice API - in general a SM URL, but can be used to talk to an aggregate")
 498         parser.add_option("-R", "--raw", dest="raw", default=None,
 499                           help="Save raw, unparsed server response to a file")
 500         parser.add_option("", "--rawformat", dest="rawformat", type="choice",
 501                           help="raw file format ([text]|pickled|json)", default="text",
 502                           choices=("text","pickled","json"))
 503         parser.add_option("", "--rawbanner", dest="rawbanner", default=None,
 504                           help="text string to write before and after raw output")
 505         parser.add_option("-d", "--dir", dest="sfi_dir",
 506                          help="config & working directory - default is %default",
 507                          metavar="PATH", default=Sfi.default_sfi_dir())
 508         parser.add_option("-u", "--user", dest="user",
 509                          help="user name", metavar="HRN", default=None)
 510         parser.add_option("-a", "--auth", dest="auth",
 511                          help="authority name", metavar="HRN", default=None)
 512         parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0,
 513                          help="verbose mode - cumulative")
 514         parser.add_option("-D", "--debug",
 515                           action="store_true", dest="debug", default=False,
 516                           help="Debug (xml-rpc) protocol messages")
 517         # would it make sense to use ~/.ssh/id_rsa as a default here ?
 518         parser.add_option("-k", "--private-key",
 519                          action="store", dest="user_private_key", default=None,
 520                          help="point to the private key file to use if not yet installed in sfi_dir")
 521         parser.add_option("-t", "--timeout", dest="timeout", default=None,
 522                          help="Amout of time to wait before timing out the request")
 523         parser.add_option("-?", "--commands",
 524                          action="store_true", dest="command_help", default=False,
 525                          help="one page summary on commands & exit")
 526         parser.disable_interspersed_args()
 527
 528         return parser
 529
 530
 531     def print_help (self):
 532         print "==================== Generic sfi usage"
 533         self.sfi_parser.print_help()
 534         print "==================== Specific command usage"
 535         self.command_parser.print_help()
 536
 537     #
 538     # Main: parse arguments and dispatch to command
 539     #
 540     def dispatch(self, command, command_options, command_args):
 541         method=getattr(self, command,None)
 542         if not method:
 543             print "Unknown command %s"%command
 544             return
 545         return method(command_options, command_args)
 546
 547     def main(self):
 548         self.sfi_parser = self.create_parser()
 549         (options, args) = self.sfi_parser.parse_args()
 550         if options.command_help:
 551             self.print_command_help(options)
 552             sys.exit(1)
 553         self.options = options
 554
 555         self.logger.setLevelFromOptVerbose(self.options.verbose)
 556
 557         if len(args) <= 0:
 558             self.logger.critical("No command given. Use -h for help.")
 559             self.print_command_help(options)
 560             return -1
 561
 562         # complete / find unique match with command set
 563         command_candidates = Candidates (self.available_names)
 564         input = args[0]
 565         command = command_candidates.only_match(input)
 566         if not command:
 567             self.print_command_help(options)
 568             sys.exit(1)
 569         # second pass options parsing
 570         self.command_parser = self.create_command_parser(command)
 571         (command_options, command_args) = self.command_parser.parse_args(args[1:])
 572         self.command_options = command_options
 573
 574         self.read_config ()
 575         self.bootstrap ()
 576         self.logger.debug("Command=%s" % command)
 577
 578         try:
 579             self.dispatch(command, command_options, command_args)
 580         except:
 581             self.logger.log_exc ("sfi command %s failed"%command)
 582             sys.exit(1)
 583
 584         return
 585
 586     ####################
 587     def read_config(self):
 588         config_file = os.path.join(self.options.sfi_dir,"sfi_config")
 589         shell_config_file  = os.path.join(self.options.sfi_dir,"sfi_config.sh")
 590         try:
 591             if Config.is_ini(config_file):
 592                 config = Config (config_file)
 593             else:
 594                 # try upgrading from shell config format
 595                 fp, fn = mkstemp(suffix='sfi_config', text=True)
 596                 config = Config(fn)
 597                 # we need to preload the sections we want parsed
 598                 # from the shell config
 599                 config.add_section('sfi')
 600                 config.add_section('sface')
 601                 config.load(config_file)
 602                 # back up old config
 603                 shutil.move(config_file, shell_config_file)
 604                 # write new config
 605                 config.save(config_file)
 606
 607         except:
 608             self.logger.critical("Failed to read configuration file %s"%config_file)
 609             self.logger.info("Make sure to remove the export clauses and to add quotes")
 610             if self.options.verbose==0:
 611                 self.logger.info("Re-run with -v for more details")
 612             else:
 613                 self.logger.log_exc("Could not read config file %s"%config_file)
 614             sys.exit(1)
 615
 616         errors = 0
 617         # Set SliceMgr URL
 618         if (self.options.sm is not None):
 619            self.sm_url = self.options.sm
 620         elif hasattr(config, "SFI_SM"):
 621            self.sm_url = config.SFI_SM
 622         else:
 623            self.logger.error("You need to set e.g. SFI_SM='http://your.slicemanager.url:12347/' in %s" % config_file)
 624            errors += 1
 625
 626         # Set Registry URL
 627         if (self.options.registry is not None):
 628            self.reg_url = self.options.registry
 629         elif hasattr(config, "SFI_REGISTRY"):
 630            self.reg_url = config.SFI_REGISTRY
 631         else:
 632            self.logger.error("You need to set e.g. SFI_REGISTRY='http://your.registry.url:12345/' in %s" % config_file)
 633            errors += 1
 634
 635         # Set user HRN
 636         if (self.options.user is not None):
 637            self.user = self.options.user
 638         elif hasattr(config, "SFI_USER"):
 639            self.user = config.SFI_USER
 640         else:
 641            self.logger.error("You need to set e.g. SFI_USER='plc.princeton.username' in %s" % config_file)
 642            errors += 1
 643
 644         # Set authority HRN
 645         if (self.options.auth is not None):
 646            self.authority = self.options.auth
 647         elif hasattr(config, "SFI_AUTH"):
 648            self.authority = config.SFI_AUTH
 649         else:
 650            self.logger.error("You need to set e.g. SFI_AUTH='plc.princeton' in %s" % config_file)
 651            errors += 1
 652
 653         self.config_file=config_file
 654         if errors:
 655            sys.exit(1)
 656
 657     def show_config (self):
 658         print "From configuration file %s"%self.config_file
 659         flags=[
 660             ('SFI_USER','user'),
 661             ('SFI_AUTH','authority'),
 662             ('SFI_SM','sm_url'),
 663             ('SFI_REGISTRY','reg_url'),
 664             ]
 665         for (external_name, internal_name) in flags:
 666             print "%s='%s'"%(external_name,getattr(self,internal_name))
 667
 668     #
 669     # Get various credential and spec files
 670     #
 671     # Establishes limiting conventions
 672     #   - conflates MAs and SAs
 673     #   - assumes last token in slice name is unique
 674     #
 675     # Bootstraps credentials
 676     #   - bootstrap user credential from self-signed certificate
 677     #   - bootstrap authority credential from user credential
 678     #   - bootstrap slice credential from user credential
 679     #
 680
 681     # init self-signed cert, user credentials and gid
 682     def bootstrap (self):
 683         client_bootstrap = SfaClientBootstrap (self.user, self.reg_url, self.options.sfi_dir,
 684                                                logger=self.logger)
 685         # if -k is provided, use this to initialize private key
 686         if self.options.user_private_key:
 687             client_bootstrap.init_private_key_if_missing (self.options.user_private_key)
 688         else:
 689             # trigger legacy compat code if needed
 690             # the name has changed from just <leaf>.pkey to <hrn>.pkey
 691             if not os.path.isfile(client_bootstrap.private_key_filename()):
 692                 self.logger.info ("private key not found, trying legacy name")
 693                 try:
 694                     legacy_private_key = os.path.join (self.options.sfi_dir, "%s.pkey"%Xrn.unescape(get_leaf(self.user)))
 695                     self.logger.debug("legacy_private_key=%s"%legacy_private_key)
 696                     client_bootstrap.init_private_key_if_missing (legacy_private_key)
 697                     self.logger.info("Copied private key from legacy location %s"%legacy_private_key)
 698                 except:
 699                     self.logger.log_exc("Can't find private key ")
 700                     sys.exit(1)
 701
 702         # make it bootstrap
 703         client_bootstrap.bootstrap_my_gid()
 704         # extract what's needed
 705         self.private_key = client_bootstrap.private_key()
 706         self.my_credential_string = client_bootstrap.my_credential_string ()
 707         self.my_gid = client_bootstrap.my_gid ()
 708         self.client_bootstrap = client_bootstrap
 709
 710
 711     def my_authority_credential_string(self):
 712         if not self.authority:
 713             self.logger.critical("no authority specified. Use -a or set SF_AUTH")
 714             sys.exit(-1)
 715         return self.client_bootstrap.authority_credential_string (self.authority)
 716
 717     def authority_credential_string(self, auth_hrn):
 718         return self.client_bootstrap.authority_credential_string (auth_hrn)
 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 by using the command options (Recommended) or 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 by using the command options (Recommended) or 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         # options and call_id when supported
1023         api_options = {}
1024         api_options['call_id']=unique_call_id()
1025         if options.show_credential:
1026             show_credentials(creds)
1027         result = server.ListSlices(creds, *self.ois(server,api_options))
1028         value = ReturnValue.get_value(result)
1029         if self.options.raw:
1030             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1031         else:
1032             display_list(value)
1033         return
1034
1035     # show rspec for named slice
1036     def resources(self, options, args):
1037         """
1038         with no arg, discover available resources, (ListResources)
1039 or with an slice hrn, shows currently provisioned resources
1040         """
1041         server = self.sliceapi()
1042
1043         # set creds
1044         creds = []
1045         if args:
1046             the_credential=self.slice_credential_string(args[0])
1047             creds.append(the_credential)
1048         else:
1049             the_credential=self.my_credential_string
1050             creds.append(the_credential)
1051         if options.show_credential:
1052             show_credentials(creds)
1053
1054         # no need to check if server accepts the options argument since the options has
1055         # been a required argument since v1 API
1056         api_options = {}
1057         # always send call_id to v2 servers
1058         api_options ['call_id'] = unique_call_id()
1059         # ask for cached value if available
1060         api_options ['cached'] = True
1061         if args:
1062             hrn = args[0]
1063             api_options['geni_slice_urn'] = hrn_to_urn(hrn, 'slice')
1064         if options.info:
1065             api_options['info'] = options.info
1066         if options.list_leases:
1067             api_options['list_leases'] = options.list_leases
1068         if options.current:
1069             if options.current == True:
1070                 api_options['cached'] = False
1071             else:
1072                 api_options['cached'] = True
1073         if options.rspec_version:
1074             version_manager = VersionManager()
1075             server_version = self.get_cached_server_version(server)
1076             if 'sfa' in server_version:
1077                 # just request the version the client wants
1078                 api_options['geni_rspec_version'] = version_manager.get_version(options.rspec_version).to_dict()
1079             else:
1080                 api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'}
1081         else:
1082             api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'}
1083         result = server.ListResources (creds, api_options)
1084         value = ReturnValue.get_value(result)
1085         if self.options.raw:
1086             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1087         if options.file is not None:
1088             save_rspec_to_file(value, options.file)
1089         if (self.options.raw is None) and (options.file is None):
1090             display_rspec(value, options.format)
1091
1092         return
1093
1094     def create(self, options, args):
1095         """
1096         create or update named slice with given rspec
1097         """
1098         server = self.sliceapi()
1099
1100         # xxx do we need to check usage (len(args)) ?
1101         # slice urn
1102         slice_hrn = args[0]
1103         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1104
1105         # credentials
1106         creds = [self.slice_credential_string(slice_hrn)]
1107
1108         delegated_cred = None
1109         server_version = self.get_cached_server_version(server)
1110         if server_version.get('interface') == 'slicemgr':
1111             # delegate our cred to the slice manager
1112             # do not delegate cred to slicemgr...not working at the moment
1113             pass
1114             #if server_version.get('hrn'):
1115             #    delegated_cred = self.delegate_cred(slice_cred, server_version['hrn'])
1116             #elif server_version.get('urn'):
1117             #    delegated_cred = self.delegate_cred(slice_cred, urn_to_hrn(server_version['urn']))
1118
1119         if options.show_credential:
1120             show_credentials(creds)
1121
1122         # rspec
1123         rspec_file = self.get_rspec_file(args[1])
1124         rspec = open(rspec_file).read()
1125
1126         # users
1127         # need to pass along user keys to the aggregate.
1128         # users = [
1129         #  { urn: urn:publicid:IDN+emulab.net+user+alice
1130         #    keys: [<ssh key A>, <ssh key B>]
1131         #  }]
1132         users = []
1133         # xxx Thierry 2012 sept. 21
1134         # contrary to what I was first thinking, calling Resolve with details=False does not yet work properly here
1135         # I am turning details=True on again on a - hopefully - temporary basis, just to get this whole thing to work again
1136         slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string])
1137         # slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string], {'details':True})
1138         if slice_records and 'reg-researchers' in slice_records[0] and slice_records[0]['reg-researchers']:
1139             slice_record = slice_records[0]
1140             user_hrns = slice_record['reg-researchers']
1141             user_urns = [hrn_to_urn(hrn, 'user') for hrn in user_hrns]
1142             user_records = self.registry().Resolve(user_urns, [self.my_credential_string])
1143
1144             if 'sfa' not in server_version:
1145                 users = pg_users_arg(user_records)
1146                 rspec = RSpec(rspec)
1147                 rspec.filter({'component_manager_id': server_version['urn']})
1148                 rspec = RSpecConverter.to_pg_rspec(rspec.toxml(), content_type='request')
1149             else:
1150                 print >>sys.stderr, "\r\n \r\n \r\n WOOOOOO"
1151                 users = sfa_users_arg(user_records, slice_record)
1152
1153         # do not append users, keys, or slice tags. Anything
1154         # not contained in this request will be removed from the slice
1155
1156         # CreateSliver has supported the options argument for a while now so it should
1157         # be safe to assume this server support it
1158         api_options = {}
1159         api_options ['append'] = False
1160         api_options ['call_id'] = unique_call_id()
1161         result = server.CreateSliver(slice_urn, creds, rspec, users, *self.ois(server, api_options))
1162         value = ReturnValue.get_value(result)
1163         if self.options.raw:
1164             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1165         if options.file is not None:
1166             save_rspec_to_file (value, options.file)
1167         if (self.options.raw is None) and (options.file is None):
1168             print value
1169
1170         return value
1171
1172     def delete(self, options, args):
1173         """
1174         delete named slice (DeleteSliver)
1175         """
1176         server = self.sliceapi()
1177
1178         # slice urn
1179         slice_hrn = args[0]
1180         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1181
1182         # creds
1183         slice_cred = self.slice_credential_string(slice_hrn)
1184         creds = [slice_cred]
1185
1186         # options and call_id when supported
1187         api_options = {}
1188         api_options ['call_id'] = unique_call_id()
1189         if options.show_credential:
1190             show_credentials(creds)
1191         result = server.DeleteSliver(slice_urn, creds, *self.ois(server, api_options ) )
1192         value = ReturnValue.get_value(result)
1193         if self.options.raw:
1194             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1195         else:
1196             print value
1197         return value
1198
1199     def status(self, options, args):
1200         """
1201         retrieve slice status (SliverStatus)
1202         """
1203         server = self.sliceapi()
1204
1205         # slice urn
1206         slice_hrn = args[0]
1207         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1208
1209         # creds
1210         slice_cred = self.slice_credential_string(slice_hrn)
1211         creds = [slice_cred]
1212
1213         # options and call_id when supported
1214         api_options = {}
1215         api_options['call_id']=unique_call_id()
1216         if options.show_credential:
1217             show_credentials(creds)
1218         result = server.SliverStatus(slice_urn, creds, *self.ois(server,api_options))
1219         value = ReturnValue.get_value(result)
1220         if self.options.raw:
1221             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1222         else:
1223             print value
1224
1225     def start(self, options, args):
1226         """
1227         start named slice (Start)
1228         """
1229         server = self.sliceapi()
1230
1231         # the slice urn
1232         slice_hrn = args[0]
1233         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1234
1235         # cred
1236         slice_cred = self.slice_credential_string(args[0])
1237         creds = [slice_cred]
1238         # xxx Thierry - does this not need an api_options as well ?
1239         result = server.Start(slice_urn, creds)
1240         value = ReturnValue.get_value(result)
1241         if self.options.raw:
1242             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1243         else:
1244             print value
1245         return value
1246
1247     def stop(self, options, args):
1248         """
1249         stop named slice (Stop)
1250         """
1251         server = self.sliceapi()
1252         # slice urn
1253         slice_hrn = args[0]
1254         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1255         # cred
1256         slice_cred = self.slice_credential_string(args[0])
1257         creds = [slice_cred]
1258         result =  server.Stop(slice_urn, creds)
1259         value = ReturnValue.get_value(result)
1260         if self.options.raw:
1261             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1262         else:
1263             print value
1264         return value
1265
1266     # reset named slice
1267     def reset(self, options, args):
1268         """
1269         reset named slice (reset_slice)
1270         """
1271         server = self.sliceapi()
1272         # slice urn
1273         slice_hrn = args[0]
1274         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1275         # cred
1276         slice_cred = self.slice_credential_string(args[0])
1277         creds = [slice_cred]
1278         result = server.reset_slice(creds, slice_urn)
1279         value = ReturnValue.get_value(result)
1280         if self.options.raw:
1281             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1282         else:
1283             print value
1284         return value
1285
1286     def renew(self, options, args):
1287         """
1288         renew slice (RenewSliver)
1289         """
1290         server = self.sliceapi()
1291         if len(args) != 2:
1292             self.print_help()
1293             sys.exit(1)
1294         [ slice_hrn, input_time ] = args
1295         # slice urn
1296         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1297         # time: don't try to be smart on the time format, server-side will
1298         # creds
1299         slice_cred = self.slice_credential_string(args[0])
1300         creds = [slice_cred]
1301         # options and call_id when supported
1302         api_options = {}
1303         api_options['call_id']=unique_call_id()
1304         if options.show_credential:
1305             show_credentials(creds)
1306         result =  server.RenewSliver(slice_urn, creds, input_time, *self.ois(server,api_options))
1307         value = ReturnValue.get_value(result)
1308         if self.options.raw:
1309             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1310         else:
1311             print value
1312         return value
1313
1314
1315     def shutdown(self, options, args):
1316         """
1317         shutdown named slice (Shutdown)
1318         """
1319         server = self.sliceapi()
1320         # slice urn
1321         slice_hrn = args[0]
1322         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1323         # creds
1324         slice_cred = self.slice_credential_string(slice_hrn)
1325         creds = [slice_cred]
1326         result = server.Shutdown(slice_urn, creds)
1327         value = ReturnValue.get_value(result)
1328         if self.options.raw:
1329             save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
1330         else:
1331             print value
1332         return value
1333
1334
1335     def get_ticket(self, options, args):
1336         """
1337         get a ticket for the specified slice
1338         """
1339         server = self.sliceapi()
1340         # slice urn
1341         slice_hrn, rspec_path = args[0], args[1]
1342         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1343         # creds
1344         slice_cred = self.slice_credential_string(slice_hrn)
1345         creds = [slice_cred]
1346         # rspec
1347         rspec_file = self.get_rspec_file(rspec_path)
1348         rspec = open(rspec_file).read()
1349         # options and call_id when supported
1350         api_options = {}
1351         api_options['call_id']=unique_call_id()
1352         # get ticket at the server
1353         ticket_string = server.GetTicket(slice_urn, creds, rspec, *self.ois(server,api_options))
1354         # save
1355         file = os.path.join(self.options.sfi_dir, get_leaf(slice_hrn) + ".ticket")
1356         self.logger.info("writing ticket to %s"%file)
1357         ticket = SfaTicket(string=ticket_string)
1358         ticket.save_to_file(filename=file, save_parents=True)
1359
1360     def redeem_ticket(self, options, args):
1361         """
1362         Connects to nodes in a slice and redeems a ticket
1363 (slice hrn is retrieved from the ticket)
1364         """
1365         ticket_file = args[0]
1366
1367         # get slice hrn from the ticket
1368         # use this to get the right slice credential
1369         ticket = SfaTicket(filename=ticket_file)
1370         ticket.decode()
1371         ticket_string = ticket.save_to_string(save_parents=True)
1372
1373         slice_hrn = ticket.gidObject.get_hrn()
1374         slice_urn = hrn_to_urn(slice_hrn, 'slice')
1375         #slice_hrn = ticket.attributes['slivers'][0]['hrn']
1376         slice_cred = self.slice_credential_string(slice_hrn)
1377
1378         # get a list of node hostnames from the RSpec
1379         tree = etree.parse(StringIO(ticket.rspec))
1380         root = tree.getroot()
1381         hostnames = root.xpath("./network/site/node/hostname/text()")
1382
1383         # create an xmlrpc connection to the component manager at each of these
1384         # components and gall redeem_ticket
1385         connections = {}
1386         for hostname in hostnames:
1387             try:
1388                 self.logger.info("Calling redeem_ticket at %(hostname)s " % locals())
1389                 cm_url="http://%s:%s/"%(hostname,CM_PORT)
1390                 server = SfaServerProxy(cm_url, self.private_key, self.my_gid)
1391                 server = self.server_proxy(hostname, CM_PORT, self.private_key,
1392                                            timeout=self.options.timeout, verbose=self.options.debug)
1393                 server.RedeemTicket(ticket_string, slice_cred)
1394                 self.logger.info("Success")
1395             except socket.gaierror:
1396                 self.logger.error("redeem_ticket failed on %s: Component Manager not accepting requests"%hostname)
1397             except Exception, e:
1398                 self.logger.log_exc(e.message)
1399         return
1400
1401     def gid(self, options, args):
1402         """
1403         Create a GID (CreateGid)
1404         """
1405         if len(args) < 1:
1406             self.print_help()
1407             sys.exit(1)
1408         target_hrn = args[0]
1409         my_gid_string = open(self.client_bootstrap.my_gid()).read()
1410         gid = self.registry().CreateGid(self.my_credential_string, target_hrn, my_gid_string)
1411         if options.file:
1412             filename = options.file
1413         else:
1414             filename = os.sep.join([self.options.sfi_dir, '%s.gid' % target_hrn])
1415         self.logger.info("writing %s gid to %s" % (target_hrn, filename))
1416         GID(string=gid).save_to_file(filename)
1417
1418
1419     def delegate (self, options, args):
1420         """
1421         (locally) create delegate credential for use by given hrn
1422         """
1423         if len(args) != 1:
1424             self.print_help()
1425             sys.exit(1)
1426         to_hrn = args[0]
1427         # support for several delegations in the same call
1428         # so first we gather the things to do
1429         tuples=[]
1430         for slice_hrn in options.delegate_slices:
1431             message="%s.slice"%slice_hrn
1432             original = self.slice_credential_string(slice_hrn)
1433             tuples.append ( (message, original,) )
1434         if options.delegate_pi:
1435             my_authority=self.authority
1436             message="%s.pi"%my_authority
1437             original = self.my_authority_credential_string()
1438             tuples.append ( (message, original,) )
1439         for auth_hrn in options.delegate_auths:
1440             message="%s.auth"%auth_hrn
1441             original=self.authority_credential_string(auth_hrn)
1442             tuples.append ( (message, original, ) )
1443         # if nothing was specified at all at this point, let's assume -u
1444         if not tuples: options.delegate_user=True
1445         # this user cred
1446         if options.delegate_user:
1447             message="%s.user"%self.user
1448             original = self.my_credential_string
1449             tuples.append ( (message, original, ) )
1450
1451         # default type for beneficial is user unless -A
1452         if options.delegate_to_authority:       to_type='authority'
1453         else:                                   to_type='user'
1454
1455         # let's now handle all this
1456         # it's all in the filenaming scheme
1457         for (message,original) in tuples:
1458             delegated_string = self.client_bootstrap.delegate_credential_string(original, to_hrn, to_type)
1459             delegated_credential = Credential (string=delegated_string)
1460             filename = os.path.join ( self.options.sfi_dir,
1461                                       "%s_for_%s.%s.cred"%(message,to_hrn,to_type))
1462             delegated_credential.save_to_file(filename, save_parents=True)
1463             self.logger.info("delegated credential for %s to %s and wrote to %s"%(message,to_hrn,filename))
1464
1465     def trusted(self, options, args):
1466         """
1467         return uhe trusted certs at this interface (get_trusted_certs)
1468         """
1469         trusted_certs = self.registry().get_trusted_certs()
1470         for trusted_cert in trusted_certs:
1471             gid = GID(string=trusted_cert)
1472             gid.dump()
1473             cert = Certificate(string=trusted_cert)
1474             self.logger.debug('Sfi.trusted -> %r'%cert.get_subject())
1475         return
1476
1477     def config (self, options, args):
1478         "Display contents of current config"
1479         self.show_config()