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 util.cert import Keypair, Certificate
  11 from util.credential import Credential
  12 from util.geniclient import GeniClient
  13 from util.gid import create_uuid
  14 from 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 #
 223 # Generate sub-command parser
 224 #
 225 def create_cmd_parser(command, additional_cmdargs = None):
 226    cmdargs = {"list": "name",
 227               "show": "name",
 228               "remove": "name",
 229               "creategid": "hrn publickey_fn",
 230               "add": "name record",
 231               "update": "name record",
 232               "nodes": "[name]",
 233               "slices": "",
 234               "resources": "name",
 235               "create": "name rspec",
 236               "delete": "name",
 237               "reset": "name",
 238               "start": "name",
 239               "stop": "name"
 240              }
 241
 242    if additional_cmdargs:
 243       cmdargs.update(additional_cmdargs)
 244
 245    if command not in cmdargs:
 246       print "Invalid command\n"
 247       print "Commands: ",
 248       for key in cmdargs.keys():
 249           print key+",",
 250       print ""
 251       sys.exit(2)
 252
 253    parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
 254       % (command, cmdargs[command]))
 255    if command in ("nodes", "resources"):
 256       parser.add_option("-f", "--format", dest="format",type="choice",
 257            help="display format (dns|ip|hrn|rspec)",default="rspec",
 258            choices=("dns","ip","hrn","rspec"))
 259    if command in ("list", "show", "remove"):
 260       parser.add_option("-t", "--type", dest="type",type="choice",
 261            help="type filter (user|slice|sa|ma|node|aggregate)",
 262            choices=("user","slice","sa","ma","node","aggregate", "all"),
 263            default="all")
 264    if command in ("show", "list", "nodes", "resources", "creategid"):
 265       parser.add_option("-o", "--output", dest="file",
 266            help="output XML to file", metavar="FILE", default=None)
 267    return parser
 268
 269 def create_parser():
 270    # Generate command line parser
 271    parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
 272         description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
 273    parser.add_option("-r", "--registry", dest="registry",
 274         help="root registry", metavar="URL", default=None)
 275    parser.add_option("-s", "--slicemgr", dest="sm",
 276         help="slice manager", metavar="URL", default=None)
 277    parser.add_option("-d", "--dir", dest="dir",
 278         help="working directory", metavar="PATH", default = sfi_dir)
 279    parser.add_option("-u", "--user", dest="user",
 280         help="user name", metavar="HRN", default=None)
 281    parser.add_option("-a", "--auth", dest="auth",
 282         help="authority name", metavar="HRN", default=None)
 283    parser.add_option("-v", "--verbose",
 284         action="store_true", dest="verbose", default=False,
 285         help="verbose mode")
 286    parser.disable_interspersed_args()
 287
 288    return parser
 289
 290 def dispatch(command, cmd_opts, cmd_args):
 291    globals()[command](cmd_opts, cmd_args)
 292
 293 #
 294 # Main: parse arguments and dispatch to command
 295 #
 296 def main():
 297    global verbose
 298
 299    parser = create_parser()
 300    (options, args) = parser.parse_args()
 301
 302    if len(args) <= 0:
 303         print "No command given. Use -h for help."
 304         return -1
 305
 306    command = args[0]
 307    (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
 308    verbose = options.verbose
 309    if verbose :
 310       print options.registry, options.sm, options.dir, options.verbose,\
 311          options.user, options.auth
 312       print command
 313       if command in ("nodes", "resources"):
 314          print cmd_opts.format
 315       elif command in ("list","show","remove"):
 316          print cmd_opts.type
 317       print cmd_args
 318
 319    set_servers(options)
 320
 321    try:
 322       dispatch(command, cmd_opts, cmd_args)
 323    except KeyError:
 324       print "Command not found:", command
 325       sys.exit(1)
 326
 327    return
 328
 329 #
 330 # Following functions implement the commands
 331 #
 332 # Registry-related commands
 333 #
 334
 335 # list entires in named authority registry
 336 def list(opts, args):
 337    global registry
 338    user_cred = get_user_cred()
 339    list = registry.list(user_cred, args[0])
 340    list = filter_records(opts.type, list)
 341    display_records(list)
 342    if opts.file:
 343        save_records_to_file(opts.file, list)
 344    return
 345
 346 # show named registry record
 347 def show(opts, args):
 348    global registry
 349    user_cred = get_user_cred()
 350    records = registry.resolve(user_cred, args[0])
 351    records = filter_records(opts.type, records)
 352    if not records:
 353       print "No record of type", opts.type
 354    display_records(records)
 355    if opts.file:
 356        save_records_to_file(opts.file, records)
 357    return
 358
 359 # removed named registry record
 360 #   - have to first retrieve the record to be removed
 361 def remove(opts, args):
 362    global registry
 363    auth_cred = get_auth_cred()
 364    return registry.remove(auth_cred, opts.type, args[0])
 365
 366 def creategid(opts, args):
 367    global registry
 368    auth_cred = get_auth_cred()
 369    hrn = args[0]
 370    pkey_string = load_publickey_string(args[1])
 371    gid = registry.create_gid(auth_cred, hrn, create_uuid(), pkey_string)
 372    if (opts.file is not None):
 373       gid.save_to_file(opts.file, save_parents=True)
 374    else:
 375       print "I created your gid, but you did not ask me to save it"
 376
 377 # add named registry record
 378 def add(opts, args):
 379    global registry
 380    auth_cred = get_auth_cred()
 381    rec_file = get_record_file(args[0])
 382    record = load_record_from_file(rec_file)
 383    return registry.register(auth_cred, record)
 384
 385 # update named registry entry
 386 def update(opts, args):
 387    global registry
 388    user_cred = get_user_cred()
 389    rec_file = get_record_file(args[0])
 390    record = load_record_from_file(rec_file)
 391
 392    if record.get_type() == "user":
 393        cred = user_cred
 394    elif record.get_type() in ["sa", "ma", "slice", "node"]:
 395        cred = get_auth_cred()
 396    else:
 397        raise "unknown record type" + record.get_type()
 398
 399    return registry.update(cred, record)
 400
 401 #
 402 # Slice-related commands
 403 #
 404
 405 # list available nodes
 406 def nodes(opts, args):
 407    global slicemgr
 408    user_cred = get_user_cred()
 409    if (len(args) == 0):
 410       context = None
 411    else:
 412       context = args[0]
 413    result = slicemgr.list_nodes(user_cred, context)
 414    display_rspec(opts.format, result)
 415    if (opts.file is not None):
 416       save_rspec_to_file(opts.file, result)
 417    return
 418
 419 # list instantiated slices
 420 def slices(opts, args):
 421    global slicemgr
 422    user_cred = get_user_cred()
 423    result = slicemgr.list_slices(user_cred)
 424    display_rspec(opts.format, results)
 425    return
 426
 427 # show rspec for named slice
 428 def resources(opts, args):
 429    global slicemgr
 430    slice_cred = get_slice_cred(args[0])
 431    result = slicemgr.get_slice_resources(slice_cred, args[0])
 432    display_rspec(opts.format, result)
 433    if (opts.file is not None):
 434       save_rspec_to_file(opts.file, result)
 435    return
 436
 437 # created named slice with given rspec
 438 def create(opts, args):
 439    global slicemgr
 440    slice_cred = get_slice_cred(args[0])
 441    rspec_file = get_rspec_file(args[1])
 442    with open(rspec_file) as f:
 443       rspec = f.read()
 444    return slicemgr.create_slice(slice_cred, rspec)
 445
 446 # delete named slice
 447 def delete(opts, args):
 448    global slicemgr
 449    slice_cred = get_slice_cred(args[0])
 450    return slicemgr.delete_slice(slice_cred)
 451
 452 # start named slice
 453 def start(opts, args):
 454    global slicemgr
 455    slice_cred = get_slice_cred(args[0])
 456    return slicemgr.start_slice(slice_cred)
 457
 458 # stop named slice
 459 def stop(opts, args):
 460    global slicemgr
 461    slice_cred = get_slice_cred(args[0])
 462    return slicemgr.stop_slice(slice_cred)
 463
 464 # reset named slice
 465 def reset(opts, args):
 466    global slicemgr
 467    slice_cred = get_slice_cred(args[0])
 468    return slicemgr.reset_slice(slice_cred)
 469
 470 #
 471 #
 472 # Display, Save, and Filter RSpecs and Records
 473 #   - to be replace by EMF-generated routines
 474 #
 475 #
 476
 477 def display_rspec(format, rspec):
 478    print "display rspec"
 479    return
 480
 481 def save_rspec_to_file(file, rspec):
 482    print "save rspec"
 483    return
 484
 485 def display_records(recordList):
 486    for record in recordList:
 487       display_record(record)
 488
 489 def display_record(record):
 490    record.dump(False)
 491    return
 492
 493 def filter_records(type, records):
 494    filtered_records = []
 495    for record in records:
 496        if (record.get_type() == type) or (type == "all"):
 497            filtered_records.append(record)
 498    return filtered_records
 499
 500 def save_records_to_file(filename, recordList):
 501    index = 0
 502    for record in recordList:
 503        if index>0:
 504            save_record_to_file(filename + "." + str(index), record)
 505        else:
 506            save_record_to_file(filename, record)
 507        index = index + 1
 508
 509 def save_record_to_file(filename, record):
 510    print "saving record", record.name, "to file", filename
 511    str = record.save_to_string()
 512    file(filename, "w").write(str)
 513    return
 514
 515 def load_record_from_file(filename):
 516    str = file(filename, "r").read()
 517    record = GeniRecord(string=str)
 518    return record
 519
 520 if __name__=="__main__":
 521    main()