cmdline/sfi.py

   1 #! /usr/bin/env python
   2 from __future__ import with_statement
   3
   4 # sfi -- slice-based facility interface
   5
   6 import sys
   7 import os, os.path
   8 from optparse import OptionParser
   9 from util.cert import Keypair, Certificate
  10 from util.credential import Credential
  11 from util.geniclient import GeniClient
  12
  13 sfi_dir = os.path.expanduser("~/.sfi/")
  14 sm_chan = None
  15 reg_chan = None
  16 user = None
  17 authority = None
  18 verbose = False
  19
  20 #
  21 # Establish Connection to SliceMgr and Registry Servers
  22 #
  23 def set_servers(options):
  24    global sm_chan
  25    global reg_chan
  26    global user
  27    global authority
  28
  29    # Set SliceMgr URL
  30    if (options.sm is not None):
  31       sm_url = options.sm
  32    elif ("SFI_SM" in os.environ):
  33       sm_url = os.environ["SFI_SM"]
  34    else:
  35       print "No Known Slice Manager"
  36       sys.exit(1)
  37
  38    # Set Registry URL
  39    if (options.registry is not None):
  40       reg_url = options.registry
  41    elif ("SFI_REGISTRY" in os.environ):
  42       reg_url = os.environ["SFI_REGISTRY"]
  43    else:
  44       print "No Known Registry Server"
  45       sys.exit(1)
  46
  47    if options.verbose :
  48       print "Contacting Slice Manager at:", sm_url
  49       print "Contacting Registry at:", registry_url
  50
  51    # Set user HRN
  52    if (options.user is not None):
  53       user = options.user
  54    elif ("SFI_USER" in os.environ):
  55       user = os.environ["SFI_USER"]
  56    else:
  57       print "No Known User Name"
  58       sys.exit(1)
  59
  60    # Set authority HRN
  61    if (options.auth is not None):
  62       authority = options.auth
  63    elif ("SFI_AUTH" in os.environ):
  64       authority = os.environ["SFI_AUTH"]
  65    else:
  66       authority = None
  67
  68    # Get key and certificate
  69    key_file = get_key_file()
  70    cert_file = get_cert_file(key_file)
  71
  72    # Establish connection to server(s)
  73    # SliceMgr and Registry may be available on the same server
  74    if (sm_url == registry_url):
  75       sm_chan = GeniClient(sm_url, key_file, cert_file)
  76       reg_chan = sm_chan
  77    else:
  78       sm_chan = GeniClient(sm_url, key_file, cert_file)
  79       reg_chan = GeniClient(registry_url, key_file, cert_file)
  80    return
  81
  82 #
  83 # Get various credential and spec files
  84 #
  85 # Establishes limiting conventions
  86 #   - conflates MAs and SAs
  87 #   - assumes last token in slice name is unique
  88 #
  89 # Bootstraps credentials
  90 #   - bootstrap user credential from self-signed certificate
  91 #   - bootstrap authority credential from user credential
  92 #   - bootstrap slice credential from user credential
  93 #
  94
  95 def get_leaf(name):
  96    parts = name.split(".")
  97    return parts[-1]
  98
  99 def get_key_file():
 100    file = os.path.join(sfi_dir, get_leaf(user) + ".pkey")
 101    if (os.path.isfile(file)):
 102       return file
 103    else:
 104       print "Key file", file, "does not exist"
 105       sys.exit(-1)
 106    return
 107
 108 def get_cert_file(key_file):
 109    global verbose
 110
 111    file = os.path.join(sfi_dir, get_leaf(user) + ".cert")
 112    if (os.path.isfile(file)):
 113       return file
 114    else:
 115       k = Keypair(filename = key_file)
 116       cert = Certificate(subject=user)
 117       cert.set_pubkey(k)
 118       cert.set_issuer(k, user)
 119       cert.sign()
 120       if verbose :
 121          print "Writing self-signed certificate to", file
 122       cert.save_to_file(file)
 123       return file
 124
 125 def get_user_cred():
 126    global user
 127
 128    file = os.path.join(sfi_dir, get_leaf(user) + ".cred")
 129    if (os.path.isfile(file)):
 130       user_cred = Credential(filename=file)
 131       return user_cred
 132    else:
 133       # bootstrap user credential
 134       user_cred = get_credential(None, "user", user)
 135       if user_cred:
 136          user_cred.save_to_file(file, save_parents=True)
 137          if verbose:
 138             print "Writing user credential to", file
 139          return user_cred
 140       else:
 141          print "Failed to get user credential"
 142          sys.exit(-1)
 143
 144 def get_auth_cred():
 145    global authority
 146
 147    file = os.path.join(sfi_dir, "authority.cred")
 148    if (os.path.isfile(file)):
 149       auth_cred = Credential(filename=file)
 150       return auth_cred
 151    else:
 152       # bootstrap authority credential from user credential
 153       user_cred = get_user_cred()
 154       auth_cred = get_credential(user_cred, "sa", authority)
 155       if auth_cred:
 156          auth_cred.save_to_file(file, save_parents=True)
 157          if verbose:
 158             print "Writing authority credential to", file
 159          return auth_cred
 160       else:
 161          print "Failed to get authority credential"
 162          sys.exit(-1)
 163
 164 def get_slice_cred(name):
 165    file = os.path.join(sfi_dir, "slice_" + get_leaf(name) + ".cred")
 166    if (os.path.isfile(file)):
 167       slice_cred = Credential(filename=file)
 168       return slice_cred
 169    else:
 170       # bootstrap slice credential from user credential
 171       user_cred = get_user_cred()
 172       slice_cred = get_credential(user_cred, "slice", name)
 173       if slice_cred:
 174          slice_cred.save_to_file(file, save_parents=True)
 175          if verbose:
 176             print "Writing slice credential to", file
 177          return slice_cred
 178       else:
 179          print "Failed to get slice credential"
 180          sys.exit(-1)
 181
 182 def get_rspec_file(rspec):
 183    if (os.path.isabs(rspec)):
 184       file = rspec
 185    else:
 186       file = os.path.join(sfi_dir, rspec)
 187    if (os.path.isfile(file)):
 188       return file
 189    else:
 190       print "No such rspec file"
 191       sys.exit(1)
 192
 193 def get_record_file(record):
 194    if (os.path.isabs(record)):
 195       file = record
 196    else:
 197       file = os.path.join(sfi_dir, record)
 198    if (os.path.isfile(file)):
 199       return file
 200    else:
 201       print "No such registry record file"
 202       sys.exit(1)
 203
 204 #
 205 # Generate sub-command parser
 206 #
 207 def create_cmd_parser(command):
 208    cmdargs = {"list": "name",
 209               "show": "name",
 210               "remove": "name",
 211               "add": "name record",
 212               "update": "name record",
 213               "nodes": "[name]",
 214               "slices": "",
 215               "resources": "name",
 216               "create": "name rspec",
 217               "delete": "name",
 218               "reset": "name",
 219               "start": "name",
 220               "stop": "name"
 221              }
 222    if command not in cmdargs:
 223       print "Invalid command\n"
 224       print "Commands:list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset"
 225       sys.exit(2)
 226
 227    parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
 228       % (command, cmdargs[command]))
 229    if command in ("nodes", "resources"):
 230       parser.add_option("-f", "--format", dest="format",type="choice",
 231            help="output format (dns|ip|hrn|rspec)",default="rspec",
 232            choices=("dns","ip","hrn","rspec"))
 233    elif command in ("list", "show", "remove"):
 234       parser.add_option("-t", "--type", dest="type",type="choice",
 235            help="type filter (user|slice|sa|ma|node|aggregate)",
 236            choices=("user","slice","sa","ma","node","aggregate", "all"),
 237            default="all")
 238    return parser
 239
 240 #
 241 # Main: parse arguments and dispatch to command
 242 #
 243 def main():
 244    global sm_chan
 245    global reg_chan
 246    global verbose
 247
 248    # Generate command line parser
 249    parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
 250         description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
 251    parser.add_option("-r", "--registry", dest="registry",
 252         help="root registry", metavar="URL", default=None)
 253    parser.add_option("-s", "--slicemgr", dest="sm",
 254         help="slice manager", metavar="URL", default=None)
 255    parser.add_option("-d", "--dir", dest="dir",
 256         help="working directory", metavar="PATH", default = sfi_dir)
 257    parser.add_option("-u", "--user", dest="user",
 258         help="user name", metavar="USER_HRN", default=None)
 259    parser.add_option("-a", "--auth", dest="auth",
 260         help="authority name", metavar="AUTH_HRN", default=None)
 261    parser.add_option("-v", "--verbose",
 262         action="store_true", dest="verbose", default=False,
 263         help="verbose mode")
 264    parser.disable_interspersed_args()
 265    (options, args) = parser.parse_args()
 266    command = args[0]
 267    (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
 268    verbose = options.verbose
 269    if verbose :
 270       print options.registry, options.sm, options.dir, options.verbose,\
 271          options.user, options.auth
 272       print command
 273       if command in ("nodes", "resources"):
 274          print cmd_opts.format
 275       elif command in ("list","show","remove"):
 276          print cmd_opts.type
 277       print cmd_args
 278
 279    set_servers(options)
 280
 281    # Dispatch to selected command
 282    try:
 283       globals()[command](cmd_opts, cmd_args)
 284    except KeyError:
 285       print "Command not found:", command
 286       sys.exit(1)
 287    return
 288
 289 #
 290 # Following functions implement the commands
 291 #
 292 # Registry-related commands
 293 #
 294
 295 # list entires in named authority registry
 296 def list(opts, args):
 297    global reg_chan
 298    user_cred = get_user_cred()
 299    result = reg_chan.list(user_cred, args[0])
 300    display_record(opts.type, results)
 301    return
 302
 303 # show named registry record
 304 def show(opts, args):
 305    global reg_chan
 306    user_cred = get_user_cred()
 307    result = reg_chan.resolve(user_cred, args[0])
 308    display_record(opts.type, results)
 309    return
 310
 311 # removed named registry record
 312 #   - have to first retrieve the record to be removed
 313 def remove(opts, args):
 314    global reg_chan
 315    auth_cred = get_auth_cred()
 316    results = reg_chan.resolve(auth_cred, args[0])
 317    record = filter_record(opts.type, results)
 318    return reg_chan.remove(auth_cred, record)
 319
 320 # add named registry record
 321 def add(opts, args):
 322    global reg_chan
 323    auth_cred = get_auth_cred()
 324    rec_file = get_record_file(args[1])
 325    with open(rec_file) as f:
 326       record = f.read()
 327    return reg_chan.register(auth_cred, record)
 328
 329 # update named registry entry
 330 def update(opts, args):
 331    global reg_chan
 332    user_cred = get_user_cred()
 333    rec_file = get_record_file(args[1])
 334    with open(rec_file) as f:
 335       record = f.read()
 336    return reg_chan.update(user_cred, record)
 337
 338 #
 339 # Slice-related commands
 340 #
 341
 342 # list available nodes
 343 def nodes(opts, args):
 344    global sm_chan
 345    user_cred = get_user_cred()
 346    if (len(args) == 0):
 347       context = None
 348    else:
 349       context = args[0]
 350    result = sm_chan.list_nodes(user_cred, context)
 351    display_rspec(opts.format, result)
 352    return
 353
 354 # list instantiated slices
 355 def slices(opts, args):
 356    global sm_chan
 357    user_cred = get_user_cred()
 358    result = sm_chan.list_slices(user_cred)
 359    display_rspec(opts.format, results)
 360    return
 361
 362 # show rspec for named slice
 363 def resources(opts, args):
 364    global sm_chan
 365    slice_cred = get_slice_cred(args[0])
 366    print "resources:", opts.format, args[0], sm_chan
 367    result = sm_chan.get_resources(slice_cred, args[0])
 368    display_rspec(opts.format, result)
 369    return
 370
 371 # created named slice with given rspec
 372 def create(opts, args):
 373    global sm_chan
 374    slice_cred = get_slice_cred(args[0])
 375    rspec_file = get_rspec_file(args[1])
 376    with open(rspec_file) as f:
 377       rspec = f.read()
 378    return sm_chan.instantiate(slice_cred, rspec)
 379
 380 # delete named slice
 381 def delete(opts, args):
 382    global sm_chan
 383    slice_cred = get_slice_cred(args[0])
 384    return sm_chan.delete_slice(slice_cred)
 385
 386 # start named slice
 387 def start(opts, args):
 388    global sm_chan
 389    slice_cred = get_slice_cred(args[0])
 390    return sm_chan.start_slice(slice_cred)
 391
 392 # stop named slice
 393 def stop(opts, args):
 394    global sm_chan
 395    slice_cred = get_slice_cred(args[0])
 396    return sm_chan.stop_slice(slice_cred)
 397
 398 # reset named slice
 399 def reset(opts, args):
 400    global sm_chan
 401    slice_cred = get_slice_cred(args[0])
 402    return sm_chan.reset_slice(slice_cred)
 403
 404 #
 405 #
 406 # Display and Filter RSpecs and Records
 407 #
 408 #
 409
 410 def display_rspec(format, rspec):
 411    print "display rspec"
 412    return
 413
 414 def display_record(type, record):
 415    rec = filter_record(type, record)
 416    print "display record"
 417    return
 418
 419 def filter_record(type, record):
 420    print "filter record"
 421    return
 422
 423
 424 if __name__=="__main__":
 425    main()