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        object_cred = user_cred
 375    elif opts.delegate_slice:
 376        object_cred = get_slice_cred(opts.delegate_slice)
 377    else:
 378        print "Must specify either --user or --slice <hrn>"
 379        return
 380
 381    # the gid and hrn of the object we are delegating
 382    object_gid = object_cred.get_gid_object()
 383    object_hrn = object_gid.get_hrn()
 384
 385    if not object_cred.get_delegate():
 386        print "Error: Object credential", object_hrn, "does not have delegate bit set"
 387        return
 388
 389    records = registry.resolve(user_cred, args[0])
 390    records = filter_records("user", records)
 391
 392    if not records:
 393        print "Error: Didn't find a user record for", delegee_name
 394        return
 395
 396    # the gid of the user who will be delegated too
 397    delegee_gid = records[0].get_gid_object()
 398    delegee_hrn = delegee_gid.get_hrn()
 399
 400    # the key and hrn of the user who will be delegating
 401    user_key = Keypair(filename = get_key_file())
 402    user_hrn = user_cred.get_gid_caller().get_hrn()
 403
 404    dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
 405    dcred.set_gid_caller(delegee_gid)
 406    dcred.set_gid_object(object_gid)
 407    dcred.set_privileges(object_cred.get_privileges())
 408    dcred.set_delegate(True)
 409    dcred.set_pubkey(object_gid.get_pubkey())
 410    dcred.set_issuer(user_key, user_hrn)
 411    dcred.set_parent(object_cred)
 412    dcred.encode()
 413    dcred.sign()
 414
 415    if opts.delegate_user:
 416        dest_fn = os.path.join(sfi_dir, get_leaf(delegee_hrn) + "_" + get_leaf(object_hrn) + ".cred")
 417    elif opts.delegate_slice:
 418        dest_fn = os.path_join(sfi_dir, get_leaf(delegee_hrn) + "_slice_" + get_leaf(object_hrn) + ".cred")
 419
 420    dcred.save_to_file(dest_fn, save_parents = True)
 421
 422    print "delegated credential for", object_hrn, "to", delegee_hrn, "and wrote to", dest_fn
 423
 424 # removed named registry record
 425 #   - have to first retrieve the record to be removed
 426 def remove(opts, args):
 427    global registry
 428    auth_cred = get_auth_cred()
 429    return registry.remove(auth_cred, opts.type, args[0])
 430
 431 # add named registry record
 432 def add(opts, args):
 433    global registry
 434    auth_cred = get_auth_cred()
 435    rec_file = get_record_file(args[0])
 436    record = load_record_from_file(rec_file)
 437
 438    # check and see if we need to create a gid for this record. The creator
 439    # of the record signals this by filling in the create_gid, create_gid_hrn,
 440    # and create_gid_key members.
 441    # (note: we'd use an unsigned GID in the record instead, but pyOpenSSL is
 442    #   broken and has no way for us to get the key back out of the gid)
 443    geni_info = record.get_geni_info()
 444    if "create_gid" in geni_info:
 445        key_string = geni_info["create_gid_key"].replace("|","\n") # XXX smbaker: the rspec kills newlines
 446        gid = registry.create_gid(auth_cred, geni_info["create_gid_hrn"], create_uuid(), key_string)
 447        record.set_gid(gid)
 448
 449        del geni_info["create_gid"]
 450        del geni_info["create_gid_hrn"]
 451        del geni_info["create_gid_key"]
 452
 453    return registry.register(auth_cred, record)
 454
 455 # update named registry entry
 456 def update(opts, args):
 457    global registry
 458    user_cred = get_user_cred()
 459    rec_file = get_record_file(args[0])
 460    record = load_record_from_file(rec_file)
 461    if record.get_type() == "user":
 462        if record.get_name() == user_cred.get_gid_object().get_hrn():
 463           cred = user_cred
 464        else:
 465           create = get_auth_cred()
 466    elif record.get_type() in ["slice"]:
 467        try:
 468            cred = get_slice_cred(record.get_name())
 469        except ServerException, e:
 470            # XXX smbaker -- once we have better error return codes, update this
 471            # to do something better than a string compare
 472            if "Permission error" in e.args[0]:
 473                cred = get_auth_cred()
 474            else:
 475                raise
 476    elif record.get_type() in ["authority"]:
 477        cred = get_auth_cred()
 478    else:
 479        raise "unknown record type" + record.get_type()
 480    return registry.update(cred, record)
 481
 482 #
 483 # Slice-related commands
 484 #
 485
 486 # list available nodes -- now use 'resources' w/ no argument instead
 487 #def nodes(opts, args):
 488 #   global slicemgr
 489 #   user_cred = get_user_cred()
 490 #   if not opts.format:
 491 #      context = None
 492 #   else:
 493 #      context = opts.format
 494 #   results = slicemgr.list_nodes(user_cred)
 495 #   if opts.format in ['rspec']:
 496 #      display_rspec(results)
 497 #   else:
 498 #      display_list(results)
 499 #   if (opts.file is not None):
 500 #      rspec = slicemgr.list_nodes(user_cred)
 501 #      save_rspec_to_file(rspec, opts.file)
 502 #   return
 503
 504 # list instantiated slices
 505 def slices(opts, args):
 506    global slicemgr
 507    user_cred = get_user_cred()
 508    results = slicemgr.get_slices(user_cred)
 509    display_list(results)
 510    return
 511
 512 # show rspec for named slice
 513 def resources(opts, args):
 514    global slicemgr
 515    if args:
 516        slice_cred = get_slice_cred(args[0])
 517        result = slicemgr.get_resources(slice_cred, args[0])
 518    else:
 519        user_cred = get_user_cred()
 520        result = slicemgr.get_resources(user_cred)
 521    format = opts.format
 522    display_rspec(result, format)
 523    if (opts.file is not None):
 524       save_rspec_to_file(opts.file, result)
 525    return
 526
 527 # created named slice with given rspec
 528 def create(opts, args):
 529    global slicemgr
 530    slice_hrn = args[0]
 531    slice_cred = get_slice_cred(slice_hrn)
 532    rspec_file = get_rspec_file(args[1])
 533    with open(rspec_file) as f:
 534       rspec = f.read()
 535    return slicemgr.create_slice(slice_cred, slice_hrn, rspec)
 536
 537 # delete named slice
 538 def delete(opts, args):
 539    global slicemgr
 540    slice_hrn = args[0]
 541    slice_cred = get_slice_cred(slice_hrn)
 542
 543    return slicemgr.delete_slice(slice_cred, slice_hrn)
 544
 545 # start named slice
 546 def start(opts, args):
 547    global slicemgr
 548    slice_cred = get_slice_cred(args[0])
 549    return slicemgr.start_slice(slice_cred)
 550
 551 # stop named slice
 552 def stop(opts, args):
 553    global slicemgr
 554    slice_cred = get_slice_cred(args[0])
 555    return slicemgr.stop_slice(slice_cred)
 556
 557 # reset named slice
 558 def reset(opts, args):
 559    global slicemgr
 560    slice_cred = get_slice_cred(args[0])
 561    return slicemgr.reset_slice(slice_cred)
 562
 563 #
 564 #
 565 # Display, Save, and Filter RSpecs and Records
 566 #   - to be replace by EMF-generated routines
 567 #
 568 #
 569
 570 def display_rspec(rspec, format = 'rspec'):
 571     if format in ['dns']:
 572         spec = Rspec()
 573         spec.parseString(rspec)
 574         hostnames = []
 575         nodespecs = spec.getDictsByTagName('NodeSpec')
 576         for nodespec in nodespecs:
 577             if nodespec.has_key('name') and nodespec['name']:
 578                 if isinstance(nodespec['name'], ListType):
 579                     hostnames.extend(nodespec['name'])
 580                 elif isinstance(nodespec['name'], StringTypes):
 581                     hostnames.append(nodespec['name'])
 582         result = hostnames
 583     elif format in ['ip']:
 584         spec = Rspec()
 585         spec.parseString(rspec)
 586         ips = []
 587         ifspecs = spec.getDictsByTagName('IfSpec')
 588         for ifspec in ifspecs:
 589             if ifspec.has_key('addr') and ifspec['addr']:
 590                 ips.append(ifspec['addr'])
 591         result = ips
 592     else:
 593         result = rspec
 594
 595     print result
 596     return
 597
 598 def display_list(results):
 599     for result in results:
 600         print result
 601
 602 def save_rspec_to_file(rspec, filename):
 603    if not filename.startswith(os.sep):
 604        filename = sfi_dir + filename
 605    if not filename.endswith(".rspec"):
 606        filename = filename + ".rspec"
 607
 608    f = open(filename, 'w')
 609    f.write(rspec)
 610    f.close()
 611    return
 612
 613 def display_records(recordList, dump = False):
 614    ''' Print all fields in the record'''
 615    for record in recordList:
 616       display_record(record, dump)
 617
 618 def display_record(record, dump = False):
 619    if dump:
 620        record.dump()
 621    else:
 622        info = record.getdict()
 623        print "%s (%s)" % (info['hrn'], info['type'])
 624    return
 625
 626 def filter_records(type, records):
 627    filtered_records = []
 628    for record in records:
 629        if (record.get_type() == type) or (type == "all"):
 630            filtered_records.append(record)
 631    return filtered_records
 632
 633 def save_records_to_file(filename, recordList):
 634    index = 0
 635    for record in recordList:
 636        if index>0:
 637            save_record_to_file(filename + "." + str(index), record)
 638        else:
 639            save_record_to_file(filename, record)
 640        index = index + 1
 641
 642 def save_record_to_file(filename, record):
 643    if not filename.startswith(os.sep):
 644        filename = sfi_dir + filename
 645    str = record.save_to_string()
 646    file(filename, "w").write(str)
 647    return
 648
 649 def load_record_from_file(filename):
 650    str = file(filename, "r").read()
 651    record = GeniRecord(string=str)
 652    return record
 653
 654 if __name__=="__main__":
 655    main()