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 import tempfile
   9 from optparse import OptionParser
  10 from geni.util.cert import Keypair, Certificate
  11 from geni.util.credential import Credential
  12 from geni.util.geniclient import GeniClient
  13 from geni.util.gid import create_uuid
  14 from geni.util.record import GeniRecord
  15
  16 sfi_dir = os.path.expanduser("~/.sfi/")
  17 slicemgr = None
  18 registry = None
  19 user = None
  20 authority = None
  21 verbose = False
  22
  23 #
  24 # Establish Connection to SliceMgr and Registry Servers
  25 #
  26 def set_servers(options):
  27    global slicemgr
  28    global registry
  29    global user
  30    global authority
  31
  32    # Set SliceMgr URL
  33    if (options.sm is not None):
  34       sm_url = options.sm
  35    elif ("SFI_SM" in os.environ):
  36       sm_url = os.environ["SFI_SM"]
  37    else:
  38       print "No Known Slice Manager"
  39       sys.exit(1)
  40
  41    # Set Registry URL
  42    if (options.registry is not None):
  43       reg_url = options.registry
  44    elif ("SFI_REGISTRY" in os.environ):
  45       reg_url = os.environ["SFI_REGISTRY"]
  46    else:
  47       print "No Known Registry Server"
  48       sys.exit(1)
  49
  50    if options.verbose :
  51       print "Contacting Slice Manager at:", sm_url
  52       print "Contacting Registry at:", reg_url
  53
  54    # Set user HRN
  55    if (options.user is not None):
  56       user = options.user
  57    elif ("SFI_USER" in os.environ):
  58       user = os.environ["SFI_USER"]
  59    else:
  60       print "No Known User Name"
  61       sys.exit(1)
  62
  63    # Set authority HRN
  64    if (options.auth is not None):
  65       authority = options.auth
  66    elif ("SFI_AUTH" in os.environ):
  67       authority = os.environ["SFI_AUTH"]
  68    else:
  69       authority = None
  70
  71    # Get key and certificate
  72    key_file = get_key_file()
  73    cert_file = get_cert_file(key_file)
  74
  75    # Establish connection to server(s)
  76    slicemgr = GeniClient(sm_url, key_file, cert_file)
  77    registry = GeniClient(reg_url, key_file, cert_file)
  78    return
  79
  80 #
  81 # Get various credential and spec files
  82 #
  83 # Establishes limiting conventions
  84 #   - conflates MAs and SAs
  85 #   - assumes last token in slice name is unique
  86 #
  87 # Bootstraps credentials
  88 #   - bootstrap user credential from self-signed certificate
  89 #   - bootstrap authority credential from user credential
  90 #   - bootstrap slice credential from user credential
  91 #
  92
  93 def get_leaf(name):
  94    parts = name.split(".")
  95    return parts[-1]
  96
  97 def get_key_file():
  98    file = os.path.join(sfi_dir, get_leaf(user) + ".pkey")
  99    if (os.path.isfile(file)):
 100       return file
 101    else:
 102       print "Key file", file, "does not exist"
 103       sys.exit(-1)
 104    return
 105
 106 def get_cert_file(key_file):
 107    global verbose
 108
 109    file = os.path.join(sfi_dir, get_leaf(user) + ".cert")
 110    if (os.path.isfile(file)):
 111       return file
 112    else:
 113       k = Keypair(filename = key_file)
 114       cert = Certificate(subject=user)
 115       cert.set_pubkey(k)
 116       cert.set_issuer(k, user)
 117       cert.sign()
 118       if verbose :
 119          print "Writing self-signed certificate to", file
 120       cert.save_to_file(file)
 121       return file
 122
 123 def get_user_cred():
 124    global user
 125
 126    file = os.path.join(sfi_dir, get_leaf(user) + ".cred")
 127    if (os.path.isfile(file)):
 128       user_cred = Credential(filename=file)
 129       return user_cred
 130    else:
 131       # bootstrap user credential
 132       user_cred = registry.get_credential(None, "user", user)
 133       if user_cred:
 134          user_cred.save_to_file(file, save_parents=True)
 135          if verbose:
 136             print "Writing user credential to", file
 137          return user_cred
 138       else:
 139          print "Failed to get user credential"
 140          sys.exit(-1)
 141
 142 def get_auth_cred():
 143    global authority
 144
 145    if not authority:
 146       print "no authority specified. Use -a or set SF_AUTH"
 147       sys.exit(-1)
 148
 149    file = os.path.join(sfi_dir, get_leaf("authority") +".cred")
 150    if (os.path.isfile(file)):
 151       auth_cred = Credential(filename=file)
 152       return auth_cred
 153    else:
 154       # bootstrap authority credential from user credential
 155       user_cred = get_user_cred()
 156       auth_cred = registry.get_credential(user_cred, "sa", authority)
 157       if auth_cred:
 158          auth_cred.save_to_file(file, save_parents=True)
 159          if verbose:
 160             print "Writing authority credential to", file
 161          return auth_cred
 162       else:
 163          print "Failed to get authority credential"
 164          sys.exit(-1)
 165
 166 def get_slice_cred(name):
 167    file = os.path.join(sfi_dir, "slice_" + get_leaf(name) + ".cred")
 168    if (os.path.isfile(file)):
 169       slice_cred = Credential(filename=file)
 170       return slice_cred
 171    else:
 172       # bootstrap slice credential from user credential
 173       user_cred = get_user_cred()
 174       slice_cred = registry.get_credential(user_cred, "slice", name)
 175       if slice_cred:
 176          slice_cred.save_to_file(file, save_parents=True)
 177          if verbose:
 178             print "Writing slice credential to", file
 179          return slice_cred
 180       else:
 181          print "Failed to get slice credential"
 182          sys.exit(-1)
 183
 184 def get_rspec_file(rspec):
 185    if (os.path.isabs(rspec)):
 186       file = rspec
 187    else:
 188       file = os.path.join(sfi_dir, rspec)
 189    if (os.path.isfile(file)):
 190       return file
 191    else:
 192       print "No such rspec file", rspec
 193       sys.exit(1)
 194
 195 def get_record_file(record):
 196    if (os.path.isabs(record)):
 197       file = record
 198    else:
 199       file = os.path.join(sfi_dir, record)
 200    if (os.path.isfile(file)):
 201       return file
 202    else:
 203       print "No such registry record file", record
 204       sys.exit(1)
 205
 206 def load_publickey_string(fn):
 207    f = file(fn,"r")
 208    key_string = f.read()
 209
 210    # if the filename is a private key file, then extract the public key
 211    if "PRIVATE KEY" in key_string:
 212        outfn = tempfile.mktemp()
 213        cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
 214        os.system(cmd)
 215        f = file(outfn, "r")
 216        key_string = f.read()
 217        os.remove(outfn)
 218
 219    return key_string
 220
 221 #
 222 # Generate sub-command parser
 223 #
 224 def create_cmd_parser(command, additional_cmdargs = None):
 225    cmdargs = {"list": "name",
 226               "show": "name",
 227               "remove": "name",
 228               "add": "name record",
 229               "update": "name record",
 230               "nodes": "[name]",
 231               "slices": "",
 232               "resources": "name",
 233               "create": "name rspec",
 234               "delete": "name",
 235               "reset": "name",
 236               "start": "name",
 237               "stop": "name"
 238              }
 239
 240    if additional_cmdargs:
 241       cmdargs.update(additional_cmdargs)
 242
 243    if command not in cmdargs:
 244       print "Invalid command\n"
 245       print "Commands: ",
 246       for key in cmdargs.keys():
 247           print key+",",
 248       print ""
 249       sys.exit(2)
 250
 251    parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
 252       % (command, cmdargs[command]))
 253    if command in ("nodes", "resources"):
 254       parser.add_option("-f", "--format", dest="format",type="choice",
 255            help="display format (dns|ip|hrn|rspec)",default="rspec",
 256            choices=("dns","ip","hrn","rspec"))
 257    if command in ("list", "show", "remove"):
 258       parser.add_option("-t", "--type", dest="type",type="choice",
 259            help="type filter (user|slice|sa|ma|node|aggregate)",
 260            choices=("user","slice","sa","ma","node","aggregate", "all"),
 261            default="all")
 262    if command in ("show", "list", "nodes", "resources"):
 263       parser.add_option("-o", "--output", dest="file",
 264            help="output XML to file", metavar="FILE", default=None)
 265    return parser
 266
 267 def create_parser():
 268    # Generate command line parser
 269    parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
 270         description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
 271    parser.add_option("-r", "--registry", dest="registry",
 272         help="root registry", metavar="URL", default=None)
 273    parser.add_option("-s", "--slicemgr", dest="sm",
 274         help="slice manager", metavar="URL", default=None)
 275    parser.add_option("-d", "--dir", dest="dir",
 276         help="working directory", metavar="PATH", default = sfi_dir)
 277    parser.add_option("-u", "--user", dest="user",
 278         help="user name", metavar="HRN", default=None)
 279    parser.add_option("-a", "--auth", dest="auth",
 280         help="authority name", metavar="HRN", default=None)
 281    parser.add_option("-v", "--verbose",
 282         action="store_true", dest="verbose", default=False,
 283         help="verbose mode")
 284    parser.disable_interspersed_args()
 285
 286    return parser
 287
 288 def dispatch(command, cmd_opts, cmd_args):
 289    globals()[command](cmd_opts, cmd_args)
 290
 291 #
 292 # Main: parse arguments and dispatch to command
 293 #
 294 def main():
 295    global verbose
 296
 297    parser = create_parser()
 298    (options, args) = parser.parse_args()
 299
 300    if len(args) <= 0:
 301         print "No command given. Use -h for help."
 302         return -1
 303
 304    command = args[0]
 305    (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
 306    verbose = options.verbose
 307    if verbose :
 308       print options.registry, options.sm, options.dir, options.verbose,\
 309          options.user, options.auth
 310       print command
 311       if command in ("nodes", "resources"):
 312          print cmd_opts.format
 313       elif command in ("list","show","remove"):
 314          print cmd_opts.type
 315       print cmd_args
 316
 317    set_servers(options)
 318
 319    try:
 320       dispatch(command, cmd_opts, cmd_args)
 321    except KeyError:
 322       print "Command not found:", command
 323       sys.exit(1)
 324
 325    return
 326
 327 #
 328 # Following functions implement the commands
 329 #
 330 # Registry-related commands
 331 #
 332
 333 # list entires in named authority registry
 334 def list(opts, args):
 335    global registry
 336    user_cred = get_user_cred()
 337    list = registry.list(user_cred, args[0])
 338    list = filter_records(opts.type, list)
 339    display_records(list)
 340    if opts.file:
 341        save_records_to_file(opts.file, list)
 342    return
 343
 344 # show named registry record
 345 def show(opts, args):
 346    global registry
 347    user_cred = get_user_cred()
 348    records = registry.resolve(user_cred, args[0])
 349    records = filter_records(opts.type, records)
 350    if not records:
 351       print "No record of type", opts.type
 352    display_records(records, True)
 353    if opts.file:
 354        save_records_to_file(opts.file, records)
 355    return
 356
 357 # removed named registry record
 358 #   - have to first retrieve the record to be removed
 359 def remove(opts, args):
 360    global registry
 361    auth_cred = get_auth_cred()
 362    return registry.remove(auth_cred, opts.type, args[0])
 363
 364 # add named registry record
 365 def add(opts, args):
 366    global registry
 367    auth_cred = get_auth_cred()
 368    rec_file = get_record_file(args[0])
 369    record = load_record_from_file(rec_file)
 370
 371    # check and see if we need to create a gid for this record. The creator
 372    # of the record signals this by filling in the create_gid, create_gid_hrn,
 373    # and create_gid_key members.
 374    # (note: we'd use an unsigned GID in the record instead, but pyOpenSSL is
 375    #   broken and has no way for us to get the key back out of the gid)
 376    geni_info = record.get_geni_info()
 377    if "create_gid" in geni_info:
 378        gid = registry.create_gid(auth_cred, geni_info["create_gid_hrn"], create_uuid(), geni_info["create_gid_key"])
 379        record.set_gid(gid)
 380
 381        del geni_info["create_gid"]
 382        del geni_info["create_gid_hrn"]
 383        del geni_info["create_gid_key"]
 384
 385    return registry.register(auth_cred, record)
 386
 387 # update named registry entry
 388 def update(opts, args):
 389    global registry
 390    user_cred = get_user_cred()
 391    rec_file = get_record_file(args[0])
 392    record = load_record_from_file(rec_file)
 393
 394    if record.get_type() == "user":
 395        cred = user_cred
 396    elif record.get_type() in ["sa", "ma", "slice", "node"]:
 397        cred = get_auth_cred()
 398    else:
 399        raise "unknown record type" + record.get_type()
 400
 401    return registry.update(cred, record)
 402
 403 #
 404 # Slice-related commands
 405 #
 406
 407 # list available nodes
 408 def nodes(opts, args):
 409    global slicemgr
 410    user_cred = get_user_cred()
 411    if not opts.format:
 412       context = None
 413    else:
 414       context = opts.format
 415    results = slicemgr.list_nodes(user_cred, context)
 416    if opts.format in ['rspec']:
 417       display_rspec(results)
 418    else:
 419       display_list(results)
 420    if (opts.file is not None):
 421       rspec = slicemgr.list_nodes(user_cred, 'rspec')
 422       save_rspec_to_file(rspec, opts.file)
 423    return
 424
 425 # list instantiated slices
 426 def slices(opts, args):
 427    global slicemgr
 428    user_cred = get_user_cred()
 429    results = slicemgr.list_slices(user_cred)
 430    display_list(results)
 431    return
 432
 433 # show rspec for named slice
 434 def resources(opts, args):
 435    global slicemgr
 436    slice_cred = get_slice_cred(args[0])
 437    result = slicemgr.list_resources(slice_cred, args[0])
 438    display_rspec(result)
 439    if (opts.file is not None):
 440       save_rspec_to_file(opts.file, result)
 441    return
 442
 443 # created named slice with given rspec
 444 def create(opts, args):
 445    global slicemgr
 446    slice_hrn = args[0]
 447    slice_cred = get_slice_cred(slice_hrn)
 448    rspec_file = get_rspec_file(args[1])
 449    with open(rspec_file) as f:
 450       rspec = f.read()
 451    return slicemgr.create_slice(slice_cred, slice_hrn, rspec)
 452
 453 # delete named slice
 454 def delete(opts, args):
 455    global slicemgr
 456    slice_hrn = args[0]
 457    slice_cred = get_slice_cred(slice_hrn)
 458
 459    return slicemgr.delete_slice(slice_cred, slice_hrn)
 460
 461 # start named slice
 462 def start(opts, args):
 463    global slicemgr
 464    slice_cred = get_slice_cred(args[0])
 465    return slicemgr.start_slice(slice_cred)
 466
 467 # stop named slice
 468 def stop(opts, args):
 469    global slicemgr
 470    slice_cred = get_slice_cred(args[0])
 471    return slicemgr.stop_slice(slice_cred)
 472
 473 # reset named slice
 474 def reset(opts, args):
 475    global slicemgr
 476    slice_cred = get_slice_cred(args[0])
 477    return slicemgr.reset_slice(slice_cred)
 478
 479 #
 480 #
 481 # Display, Save, and Filter RSpecs and Records
 482 #   - to be replace by EMF-generated routines
 483 #
 484 #
 485
 486 def display_rspec(rspec):
 487    print rspec
 488    return
 489
 490 def display_list(results):
 491     for result in results:
 492         print result
 493
 494 def save_rspec_to_file(rspec, filename):
 495    if not filename.startswith(os.sep):
 496        filename = sfi_dir + filename
 497    if not filename.endswith(".rspec"):
 498        filename = filename + ".rspec"
 499
 500    f = open(filename, 'w')
 501    f.write(rspec)
 502    f.close()
 503    return
 504
 505 def display_records(recordList, dump = False):
 506    for record in recordList:
 507       display_record(record, dump)
 508
 509 def display_record(record, dump = False):
 510    if dump:
 511        record.dump(False)
 512    else:
 513        info = record.getdict()
 514        print "%s (%s)" % (info['hrn'], info['type'])
 515    return
 516
 517 def filter_records(type, records):
 518    filtered_records = []
 519    for record in records:
 520        if (record.get_type() == type) or (type == "all"):
 521            filtered_records.append(record)
 522    return filtered_records
 523
 524 def save_records_to_file(filename, recordList):
 525    index = 0
 526    for record in recordList:
 527        if index>0:
 528            save_record_to_file(filename + "." + str(index), record)
 529        else:
 530            save_record_to_file(filename, record)
 531        index = index + 1
 532
 533 def save_record_to_file(filename, record):
 534    if not filename.startswith(os.sep):
 535        filename = sfi_dir + filename
 536    print "saving record", record.name, "to file", filename
 537    str = record.save_to_string()
 538    file(filename, "w").write(str)
 539    return
 540
 541 def load_record_from_file(filename):
 542    str = file(filename, "r").read()
 543    record = GeniRecord(string=str)
 544    return record
 545
 546 if __name__=="__main__":
 547    main()