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, ServerException
  13 from geni.util.gid import create_uuid
  14 from geni.util.record import GeniRecord
  15 from geni.util.rspec import Rspec
  16 from types import StringTypes, ListType
  17
  18 sfi_dir = os.path.expanduser("~/.sfi/")
  19 slicemgr = None
  20 registry = None
  21 user = None
  22 authority = None
  23 verbose = False
  24
  25 #
  26 # Establish Connection to SliceMgr and Registry Servers
  27 #
  28 def set_servers(options):
  29    global slicemgr
  30    global registry
  31    global user
  32    global authority
  33
  34    # Set SliceMgr URL
  35    if (options.sm is not None):
  36       sm_url = options.sm
  37    elif ("SFI_SM" in os.environ):
  38       sm_url = os.environ["SFI_SM"]
  39    else:
  40       print "No Known Slice Manager"
  41       sys.exit(1)
  42
  43    # Set Registry URL
  44    if (options.registry is not None):
  45       reg_url = options.registry
  46    elif ("SFI_REGISTRY" in os.environ):
  47       reg_url = os.environ["SFI_REGISTRY"]
  48    else:
  49       print "No Known Registry Server"
  50       sys.exit(1)
  51
  52    if options.verbose :
  53       print "Contacting Slice Manager at:", sm_url
  54       print "Contacting Registry at:", reg_url
  55
  56    # Set user HRN
  57    if (options.user is not None):
  58       user = options.user
  59    elif ("SFI_USER" in os.environ):
  60       user = os.environ["SFI_USER"]
  61    else:
  62       print "No Known User Name"
  63       sys.exit(1)
  64
  65    # Set authority HRN
  66    if (options.auth is not None):
  67       authority = options.auth
  68    elif ("SFI_AUTH" in os.environ):
  69       authority = os.environ["SFI_AUTH"]
  70    else:
  71       authority = None
  72
  73    # Get key and certificate
  74    key_file = get_key_file()
  75    cert_file = get_cert_file(key_file)
  76
  77    # Establish connection to server(s)
  78    slicemgr = GeniClient(sm_url, key_file, cert_file)
  79    registry = GeniClient(reg_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 = registry.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    if not authority:
 148       print "no authority specified. Use -a or set SF_AUTH"
 149       sys.exit(-1)
 150
 151    file = os.path.join(sfi_dir, get_leaf("authority") +".cred")
 152    if (os.path.isfile(file)):
 153       auth_cred = Credential(filename=file)
 154       return auth_cred
 155    else:
 156       # bootstrap authority credential from user credential
 157       user_cred = get_user_cred()
 158       auth_cred = registry.get_credential(user_cred, "sa", authority)
 159       if auth_cred:
 160          auth_cred.save_to_file(file, save_parents=True)
 161          if verbose:
 162             print "Writing authority credential to", file
 163          return auth_cred
 164       else:
 165          print "Failed to get authority credential"
 166          sys.exit(-1)
 167
 168 def get_slice_cred(name):
 169    file = os.path.join(sfi_dir, "slice_" + get_leaf(name) + ".cred")
 170    if (os.path.isfile(file)):
 171       slice_cred = Credential(filename=file)
 172       return slice_cred
 173    else:
 174       # bootstrap slice credential from user credential
 175       user_cred = get_user_cred()
 176       slice_cred = registry.get_credential(user_cred, "slice", name)
 177       if slice_cred:
 178          slice_cred.save_to_file(file, save_parents=True)
 179          if verbose:
 180             print "Writing slice credential to", file
 181          return slice_cred
 182       else:
 183          print "Failed to get slice credential"
 184          sys.exit(-1)
 185
 186 def get_rspec_file(rspec):
 187    if (os.path.isabs(rspec)):
 188       file = rspec
 189    else:
 190       file = os.path.join(sfi_dir, rspec)
 191    if (os.path.isfile(file)):
 192       return file
 193    else:
 194       print "No such rspec file", rspec
 195       sys.exit(1)
 196
 197 def get_record_file(record):
 198    if (os.path.isabs(record)):
 199       file = record
 200    else:
 201       file = os.path.join(sfi_dir, record)
 202    if (os.path.isfile(file)):
 203       return file
 204    else:
 205       print "No such registry record file", record
 206       sys.exit(1)
 207
 208 def load_publickey_string(fn):
 209    f = file(fn,"r")
 210    key_string = f.read()
 211
 212    # if the filename is a private key file, then extract the public key
 213    if "PRIVATE KEY" in key_string:
 214        outfn = tempfile.mktemp()
 215        cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
 216        os.system(cmd)
 217        f = file(outfn, "r")
 218        key_string = f.read()
 219        os.remove(outfn)
 220
 221    return key_string
 222
 223 #
 224 # Generate sub-command parser
 225 #
 226 def create_cmd_parser(command, additional_cmdargs = None):
 227    cmdargs = {"list": "name",
 228               "show": "name",
 229               "remove": "name",
 230               "add": "record",
 231               "update": "record",
 232               "slices": "",
 233               "resources": "[name]",
 234               "create": "name rspec",
 235               "delete": "name",
 236               "reset": "name",
 237               "start": "name",
 238               "stop": "name",
 239               "delegate": "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 ("resources"):
 256       parser.add_option("-f", "--format", dest="format",type="choice",
 257            help="display format (dns|ip|rspec)",default="rspec",
 258            choices=("dns","ip","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", "resources"):
 265       parser.add_option("-o", "--output", dest="file",
 266            help="output XML to file", metavar="FILE", default=None)
 267    if command in ("delegate"):
 268       parser.add_option("-u", "--user",
 269         action="store_true", dest="delegate_user", default=False,
 270         help="delegate user credential")
 271       parser.add_option("-s", "--slice", dest="delegate_slice",
 272         help="delegate slice credential", metavar="HRN", default=None)
 273    return parser
 274
 275 def create_parser():
 276    # Generate command line parser
 277    parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
 278         description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
 279    parser.add_option("-r", "--registry", dest="registry",
 280         help="root registry", metavar="URL", default=None)
 281    parser.add_option("-s", "--slicemgr", dest="sm",
 282         help="slice manager", metavar="URL", default=None)
 283    parser.add_option("-d", "--dir", dest="dir",
 284         help="working directory", metavar="PATH", default = sfi_dir)
 285    parser.add_option("-u", "--user", dest="user",
 286         help="user name", metavar="HRN", default=None)
 287    parser.add_option("-a", "--auth", dest="auth",
 288         help="authority name", metavar="HRN", default=None)
 289    parser.add_option("-v", "--verbose",
 290         action="store_true", dest="verbose", default=False,
 291         help="verbose mode")
 292    parser.disable_interspersed_args()
 293
 294    return parser
 295
 296 def dispatch(command, cmd_opts, cmd_args):
 297    globals()[command](cmd_opts, cmd_args)
 298
 299 #
 300 # Main: parse arguments and dispatch to command
 301 #
 302 def main():
 303    global verbose
 304
 305    parser = create_parser()
 306    (options, args) = parser.parse_args()
 307
 308    if len(args) <= 0:
 309         print "No command given. Use -h for help."
 310         return -1
 311
 312    command = args[0]
 313    (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
 314    verbose = options.verbose
 315    if verbose :
 316       print "Resgistry %s, sm %s, dir %s, user %s, auth %s" % (options.registry,
 317                                             options.sm,
 318                                             options.dir,
 319                                             options.user,
 320                                             options.auth)
 321       print "Command %s" %command
 322       if command in ("resources"):
 323          print "resources cmd_opts %s" %cmd_opts.format
 324       elif command in ("list","show","remove"):
 325          print "cmd_opts.type %s" %cmd_opts.type
 326       print "cmd_args %s" %cmd_args
 327
 328    set_servers(options)
 329
 330    try:
 331       dispatch(command, cmd_opts, cmd_args)
 332    except KeyError:
 333       print "Command not found:", command
 334       sys.exit(1)
 335
 336    return
 337
 338 #
 339 # Following functions implement the commands
 340 #
 341 # Registry-related commands
 342 #
 343
 344 # list entires in named authority registry
 345 def list(opts, args):
 346    global registry
 347    user_cred = get_user_cred()
 348    list = registry.list(user_cred, args[0])
 349    # filter on person, slice, site, node, etc.
 350    # THis really should be in the filter_records funct def comment...
 351    list = filter_records(opts.type, list)
 352    display_records(list)
 353    if opts.file:
 354        save_records_to_file(opts.file, list)
 355    return
 356
 357 # show named registry record
 358 def show(opts, args):
 359    global registry
 360    user_cred = get_user_cred()
 361    records = registry.resolve(user_cred, args[0])
 362    records = filter_records(opts.type, records)
 363    if not records:
 364       print "No record of type", opts.type
 365    display_records(records, True)
 366    if opts.file:
 367        save_records_to_file(opts.file, records)
 368    return
 369
 370 def delegate(opts, args):
 371    global registry
 372    user_cred = get_user_cred()
 373    if opts.delegate_user:
 374        cred = user_cred
 375    elif opts.delegate_slice:
 376        cred = get_slice_cred(opt.delegate_slice)
 377    else:
 378        print "Must specify either --user or --slice <hrn>"
 379        return
 380
 381    records = registry.resolve(user_cred, args[0])
 382    records = filter_records("user", records)
 383
 384    if not records:
 385        print "Didn't find a user record for", delegee_name
 386        return
 387
 388    # the gid and hrn of the object we are delegating
 389    object_gid = cred.get_gid_object()
 390    object_hrn = object_gid.get_hrn()
 391
 392    # the gid of the user who will be delegated too
 393    delegee_gid = records[0].get_gid_object()
 394    delegee_hrn = delegee_gid.get_hrn()
 395
 396    # the key and hrn of the user who will be delegating
 397    user_key = Keypair(filename = get_key_file())
 398    user_hrn = user_cred.get_gid_caller().get_hrn()
 399
 400    dcred = Credential(subject=cred.get_subject())
 401    dcred.set_gid_caller(delegee_gid)
 402    dcred.set_gid_object(object_gid)
 403    dcred.set_privileges(cred.get_privileges())
 404    dcred.set_delegate(True)
 405    dcred.set_pubkey(object_gid.get_pubkey())
 406    dcred.set_issuer(user_key, user_hrn)
 407    dcred.set_parent(cred)
 408    dcred.encode()
 409    dcred.sign()
 410
 411    if opts.delegate_user:
 412        dest_fn = os.path.join(sfi_dir, get_leaf(delegee_hrn) + "_" + get_leaf(object_hrn) + ".cred")
 413    elif opts.delegate_slice:
 414        dest_fn = os.path_join(sfi_dir, get_leaf(delegee_hrn) + "_slice_" + get_leaf(object_hrn) + ".cred")
 415
 416    dcred.save_to_file(dest_fn, save_parents = True)
 417
 418    print "delegated credential for", object_hrn, "to", delegee_hrn, "and wrote to", dest_fn
 419
 420 # removed named registry record
 421 #   - have to first retrieve the record to be removed
 422 def remove(opts, args):
 423    global registry
 424    auth_cred = get_auth_cred()
 425    return registry.remove(auth_cred, opts.type, args[0])
 426
 427 # add named registry record
 428 def add(opts, args):
 429    global registry
 430    auth_cred = get_auth_cred()
 431    rec_file = get_record_file(args[0])
 432    record = load_record_from_file(rec_file)
 433
 434    # check and see if we need to create a gid for this record. The creator
 435    # of the record signals this by filling in the create_gid, create_gid_hrn,
 436    # and create_gid_key members.
 437    # (note: we'd use an unsigned GID in the record instead, but pyOpenSSL is
 438    #   broken and has no way for us to get the key back out of the gid)
 439    geni_info = record.get_geni_info()
 440    if "create_gid" in geni_info:
 441        gid = registry.create_gid(auth_cred, geni_info["create_gid_hrn"], create_uuid(), geni_info["create_gid_key"])
 442        record.set_gid(gid)
 443
 444        del geni_info["create_gid"]
 445        del geni_info["create_gid_hrn"]
 446        del geni_info["create_gid_key"]
 447
 448    return registry.register(auth_cred, record)
 449
 450 # update named registry entry
 451 def update(opts, args):
 452    global registry
 453    user_cred = get_user_cred()
 454    rec_file = get_record_file(args[0])
 455    record = load_record_from_file(rec_file)
 456    if record.get_type() == "user":
 457        if record.get_name() == user_cred.get_gid_object().get_hrn():
 458           cred = user_cred
 459        else:
 460           create = get_auth_cred()
 461    elif record.get_type() in ["slice"]:
 462        try:
 463            cred = get_slice_cred(record.get_name())
 464        except ServerException, e:
 465            if "PermissionError" in e.args[0]:
 466                cred = get_auth_cred()
 467            else:
 468                raise
 469    elif record.get_type() in ["sa", "ma", "node"]:
 470        cred = get_auth_cred()
 471    else:
 472        raise "unknown record type" + record.get_type()
 473    return registry.update(cred, record)
 474
 475 #
 476 # Slice-related commands
 477 #
 478
 479 # list available nodes -- now use 'resources' w/ no argument instead
 480 #def nodes(opts, args):
 481 #   global slicemgr
 482 #   user_cred = get_user_cred()
 483 #   if not opts.format:
 484 #      context = None
 485 #   else:
 486 #      context = opts.format
 487 #   results = slicemgr.list_nodes(user_cred)
 488 #   if opts.format in ['rspec']:
 489 #      display_rspec(results)
 490 #   else:
 491 #      display_list(results)
 492 #   if (opts.file is not None):
 493 #      rspec = slicemgr.list_nodes(user_cred)
 494 #      save_rspec_to_file(rspec, opts.file)
 495 #   return
 496
 497 # list instantiated slices
 498 def slices(opts, args):
 499    global slicemgr
 500    user_cred = get_user_cred()
 501    results = slicemgr.get_slices(user_cred)
 502    display_list(results)
 503    return
 504
 505 # show rspec for named slice
 506 def resources(opts, args):
 507    global slicemgr
 508    if args:
 509        slice_cred = get_slice_cred(args[0])
 510        result = slicemgr.get_resources(slice_cred, args[0])
 511    else:
 512        user_cred = get_user_cred()
 513        result = slicemgr.get_resources(user_cred)
 514    format = opts.format
 515    display_rspec(result, format)
 516    if (opts.file is not None):
 517       save_rspec_to_file(opts.file, result)
 518    return
 519
 520 # created named slice with given rspec
 521 def create(opts, args):
 522    global slicemgr
 523    slice_hrn = args[0]
 524    slice_cred = get_slice_cred(slice_hrn)
 525    rspec_file = get_rspec_file(args[1])
 526    with open(rspec_file) as f:
 527       rspec = f.read()
 528    return slicemgr.create_slice(slice_cred, slice_hrn, rspec)
 529
 530 # delete named slice
 531 def delete(opts, args):
 532    global slicemgr
 533    slice_hrn = args[0]
 534    slice_cred = get_slice_cred(slice_hrn)
 535
 536    return slicemgr.delete_slice(slice_cred, slice_hrn)
 537
 538 # start named slice
 539 def start(opts, args):
 540    global slicemgr
 541    slice_cred = get_slice_cred(args[0])
 542    return slicemgr.start_slice(slice_cred)
 543
 544 # stop named slice
 545 def stop(opts, args):
 546    global slicemgr
 547    slice_cred = get_slice_cred(args[0])
 548    return slicemgr.stop_slice(slice_cred)
 549
 550 # reset named slice
 551 def reset(opts, args):
 552    global slicemgr
 553    slice_cred = get_slice_cred(args[0])
 554    return slicemgr.reset_slice(slice_cred)
 555
 556 #
 557 #
 558 # Display, Save, and Filter RSpecs and Records
 559 #   - to be replace by EMF-generated routines
 560 #
 561 #
 562
 563 def display_rspec(rspec, format = 'rspec'):
 564     if format in ['dns']:
 565         spec = Rspec()
 566         spec.parseString(rspec)
 567         hostnames = []
 568         nodespecs = spec.getDictsByTagName('NodeSpec')
 569         for nodespec in nodespecs:
 570             if nodespec.has_key('name') and nodespec['name']:
 571                 if isinstance(nodespec['name'], ListType):
 572                     hostnames.extend(nodespec['name'])
 573                 elif isinstance(nodespec['name'], StringTypes):
 574                     hostnames.append(nodespec['name'])
 575         result = hostnames
 576     elif format in ['ip']:
 577         spec = Rspec()
 578         spec.parseString(rspec)
 579         ips = []
 580         ifspecs = spec.getDictsByTagName('IfSpec')
 581         for ifspec in ifspecs:
 582             if ifspec.has_key('addr') and ifspec['addr']:
 583                 ips.append(ifspec['addr'])
 584         result = ips
 585     else:
 586         result = rspec
 587
 588     print result
 589     return
 590
 591 def display_list(results):
 592     for result in results:
 593         print result
 594
 595 def save_rspec_to_file(rspec, filename):
 596    if not filename.startswith(os.sep):
 597        filename = sfi_dir + filename
 598    if not filename.endswith(".rspec"):
 599        filename = filename + ".rspec"
 600
 601    f = open(filename, 'w')
 602    f.write(rspec)
 603    f.close()
 604    return
 605
 606 def display_records(recordList, dump = False):
 607    ''' Print all fields in the record'''
 608    for record in recordList:
 609       display_record(record, dump)
 610
 611 def display_record(record, dump = False):
 612    if dump:
 613        record.dump()
 614    else:
 615        info = record.getdict()
 616        print "%s (%s)" % (info['hrn'], info['type'])
 617    return
 618
 619 def filter_records(type, records):
 620    filtered_records = []
 621    for record in records:
 622        if (record.get_type() == type) or (type == "all"):
 623            filtered_records.append(record)
 624    return filtered_records
 625
 626 def save_records_to_file(filename, recordList):
 627    index = 0
 628    for record in recordList:
 629        if index>0:
 630            save_record_to_file(filename + "." + str(index), record)
 631        else:
 632            save_record_to_file(filename, record)
 633        index = index + 1
 634
 635 def save_record_to_file(filename, record):
 636    if not filename.startswith(os.sep):
 637        filename = sfi_dir + filename
 638    str = record.save_to_string()
 639    file(filename, "w").write(str)
 640    return
 641
 642 def load_record_from_file(filename):
 643    str = file(filename, "r").read()
 644    record = GeniRecord(string=str)
 645    return record
 646
 647 if __name__=="__main__":
 648    main()