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 delegate_cred(cred, hrn, type = 'authority'):
 187     # the gid and hrn of the object we are delegating
 188     object_gid = cred.get_gid_object()
 189     object_hrn = object_gid.get_hrn()
 190     cred.set_delegate(True)
 191     if not cred.get_delegate():
 192         raise Exception, "Error: Object credential %(object_hrn)s does not have delegate bit set" % locals()
 193
 194
 195     records = registry.resolve(cred, hrn)
 196     records = filter_records(type, records)
 197
 198     if not records:
 199         raise Exception, "Error: Didn't find a %(type)s record for %(hrn)s" % locals()
 200
 201     # the gid of the user who will be delegated too
 202     delegee_gid = records[0].get_gid_object()
 203     delegee_hrn = delegee_gid.get_hrn()
 204
 205     # the key and hrn of the user who will be delegating
 206     user_key = Keypair(filename = get_key_file())
 207     user_hrn = cred.get_gid_caller().get_hrn()
 208
 209     dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
 210     dcred.set_gid_caller(delegee_gid)
 211     dcred.set_gid_object(object_gid)
 212     dcred.set_privileges(cred.get_privileges())
 213     dcred.set_delegate(True)
 214     dcred.set_pubkey(object_gid.get_pubkey())
 215     dcred.set_issuer(user_key, user_hrn)
 216     dcred.set_parent(cred)
 217     dcred.encode()
 218     dcred.sign()
 219
 220     return dcred
 221
 222 def get_rspec_file(rspec):
 223    if (os.path.isabs(rspec)):
 224       file = rspec
 225    else:
 226       file = os.path.join(sfi_dir, rspec)
 227    if (os.path.isfile(file)):
 228       return file
 229    else:
 230       print "No such rspec file", rspec
 231       sys.exit(1)
 232
 233 def get_record_file(record):
 234    if (os.path.isabs(record)):
 235       file = record
 236    else:
 237       file = os.path.join(sfi_dir, record)
 238    if (os.path.isfile(file)):
 239       return file
 240    else:
 241       print "No such registry record file", record
 242       sys.exit(1)
 243
 244 def load_publickey_string(fn):
 245    f = file(fn,"r")
 246    key_string = f.read()
 247
 248    # if the filename is a private key file, then extract the public key
 249    if "PRIVATE KEY" in key_string:
 250        outfn = tempfile.mktemp()
 251        cmd = "openssl rsa -in " + fn + " -pubout -outform PEM -out " + outfn
 252        os.system(cmd)
 253        f = file(outfn, "r")
 254        key_string = f.read()
 255        os.remove(outfn)
 256
 257    return key_string
 258
 259 #
 260 # Generate sub-command parser
 261 #
 262 def create_cmd_parser(command, additional_cmdargs = None):
 263    cmdargs = {"list": "name",
 264               "show": "name",
 265               "remove": "name",
 266               "add": "record",
 267               "update": "record",
 268               "slices": "",
 269               "resources": "[name]",
 270               "create": "name rspec",
 271               "delete": "name",
 272               "reset": "name",
 273               "start": "name",
 274               "stop": "name",
 275               "delegate": "name"
 276              }
 277
 278    if additional_cmdargs:
 279       cmdargs.update(additional_cmdargs)
 280
 281    if command not in cmdargs:
 282       print "Invalid command\n"
 283       print "Commands: ",
 284       for key in cmdargs.keys():
 285           print key+",",
 286       print ""
 287       sys.exit(2)
 288
 289    parser = OptionParser(usage="sfi [sfi_options] %s [options] %s" \
 290       % (command, cmdargs[command]))
 291    if command in ("resources"):
 292       parser.add_option("-f", "--format", dest="format",type="choice",
 293            help="display format (dns|ip|rspec)",default="rspec",
 294            choices=("dns","ip","rspec"))
 295    if command in ("list", "show", "remove"):
 296       parser.add_option("-t", "--type", dest="type",type="choice",
 297            help="type filter (user|slice|sa|ma|node|aggregate)",
 298            choices=("user","slice","sa","ma","node","aggregate", "all"),
 299            default="all")
 300    if command in ("show", "list", "resources"):
 301       parser.add_option("-o", "--output", dest="file",
 302            help="output XML to file", metavar="FILE", default=None)
 303    if command in ("delegate"):
 304       parser.add_option("-u", "--user",
 305         action="store_true", dest="delegate_user", default=False,
 306         help="delegate user credential")
 307       parser.add_option("-s", "--slice", dest="delegate_slice",
 308         help="delegate slice credential", metavar="HRN", default=None)
 309    return parser
 310
 311 def create_parser():
 312    # Generate command line parser
 313    parser = OptionParser(usage="sfi [options] command [command_options] [command_args]",
 314         description="Commands: list,show,remove,add,update,nodes,slices,resources,create,delete,start,stop,reset")
 315    parser.add_option("-r", "--registry", dest="registry",
 316         help="root registry", metavar="URL", default=None)
 317    parser.add_option("-s", "--slicemgr", dest="sm",
 318         help="slice manager", metavar="URL", default=None)
 319    parser.add_option("-d", "--dir", dest="dir",
 320         help="working directory", metavar="PATH", default = sfi_dir)
 321    parser.add_option("-u", "--user", dest="user",
 322         help="user name", metavar="HRN", default=None)
 323    parser.add_option("-a", "--auth", dest="auth",
 324         help="authority name", metavar="HRN", default=None)
 325    parser.add_option("-v", "--verbose",
 326         action="store_true", dest="verbose", default=False,
 327         help="verbose mode")
 328    parser.disable_interspersed_args()
 329
 330    return parser
 331
 332 def dispatch(command, cmd_opts, cmd_args):
 333    globals()[command](cmd_opts, cmd_args)
 334
 335 #
 336 # Main: parse arguments and dispatch to command
 337 #
 338 def main():
 339    global verbose
 340
 341    parser = create_parser()
 342    (options, args) = parser.parse_args()
 343
 344    if len(args) <= 0:
 345         print "No command given. Use -h for help."
 346         return -1
 347
 348    command = args[0]
 349    (cmd_opts, cmd_args) = create_cmd_parser(command).parse_args(args[1:])
 350    verbose = options.verbose
 351    if verbose :
 352       print "Resgistry %s, sm %s, dir %s, user %s, auth %s" % (options.registry,
 353                                             options.sm,
 354                                             options.dir,
 355                                             options.user,
 356                                             options.auth)
 357       print "Command %s" %command
 358       if command in ("resources"):
 359          print "resources cmd_opts %s" %cmd_opts.format
 360       elif command in ("list","show","remove"):
 361          print "cmd_opts.type %s" %cmd_opts.type
 362       print "cmd_args %s" %cmd_args
 363
 364    set_servers(options)
 365
 366    try:
 367       dispatch(command, cmd_opts, cmd_args)
 368    except KeyError:
 369       print "Command not found:", command
 370       sys.exit(1)
 371
 372    return
 373
 374 #
 375 # Following functions implement the commands
 376 #
 377 # Registry-related commands
 378 #
 379
 380 # list entires in named authority registry
 381 def list(opts, args):
 382    global registry
 383    user_cred = get_user_cred()
 384    list = registry.list(user_cred, args[0])
 385    # filter on person, slice, site, node, etc.
 386    # THis really should be in the filter_records funct def comment...
 387    list = filter_records(opts.type, list)
 388    display_records(list)
 389    if opts.file:
 390        save_records_to_file(opts.file, list)
 391    return
 392
 393 # show named registry record
 394 def show(opts, args):
 395    global registry
 396    user_cred = get_user_cred()
 397    records = registry.resolve(user_cred, args[0])
 398    records = filter_records(opts.type, records)
 399    if not records:
 400       print "No record of type", opts.type
 401    display_records(records, True)
 402    if opts.file:
 403        save_records_to_file(opts.file, records)
 404    return
 405
 406 def delegate(opts, args):
 407    global registry
 408    user_cred = get_user_cred()
 409    if opts.delegate_user:
 410        object_cred = user_cred
 411    elif opts.delegate_slice:
 412        object_cred = get_slice_cred(opts.delegate_slice)
 413    else:
 414        print "Must specify either --user or --slice <hrn>"
 415        return
 416
 417    # the gid and hrn of the object we are delegating
 418    object_gid = object_cred.get_gid_object()
 419    object_hrn = object_gid.get_hrn()
 420
 421    if not object_cred.get_delegate():
 422        print "Error: Object credential", object_hrn, "does not have delegate bit set"
 423        return
 424
 425    records = registry.resolve(user_cred, args[0])
 426    records = filter_records("user", records)
 427
 428    if not records:
 429        print "Error: Didn't find a user record for", args[0]
 430        return
 431
 432    # the gid of the user who will be delegated too
 433    delegee_gid = records[0].get_gid_object()
 434    delegee_hrn = delegee_gid.get_hrn()
 435
 436    # the key and hrn of the user who will be delegating
 437    user_key = Keypair(filename = get_key_file())
 438    user_hrn = user_cred.get_gid_caller().get_hrn()
 439
 440    dcred = Credential(subject=object_hrn + " delegated to " + delegee_hrn)
 441    dcred.set_gid_caller(delegee_gid)
 442    dcred.set_gid_object(object_gid)
 443    dcred.set_privileges(object_cred.get_privileges())
 444    dcred.set_delegate(True)
 445    dcred.set_pubkey(object_gid.get_pubkey())
 446    dcred.set_issuer(user_key, user_hrn)
 447    dcred.set_parent(object_cred)
 448    dcred.encode()
 449    dcred.sign()
 450
 451    if opts.delegate_user:
 452        dest_fn = os.path.join(sfi_dir, get_leaf(delegee_hrn) + "_" + get_leaf(object_hrn) + ".cred")
 453    elif opts.delegate_slice:
 454        dest_fn = os.path_join(sfi_dir, get_leaf(delegee_hrn) + "_slice_" + get_leaf(object_hrn) + ".cred")
 455
 456    dcred.save_to_file(dest_fn, save_parents = True)
 457
 458    print "delegated credential for", object_hrn, "to", delegee_hrn, "and wrote to", dest_fn
 459
 460 # removed named registry record
 461 #   - have to first retrieve the record to be removed
 462 def remove(opts, args):
 463    global registry
 464    auth_cred = get_auth_cred()
 465    return registry.remove(auth_cred, opts.type, args[0])
 466
 467 # add named registry record
 468 def add(opts, args):
 469    global registry
 470    auth_cred = get_auth_cred()
 471    rec_file = get_record_file(args[0])
 472    record = load_record_from_file(rec_file)
 473
 474    # check and see if we need to create a gid for this record. The creator
 475    # of the record signals this by filling in the create_gid, create_gid_hrn,
 476    # and create_gid_key members.
 477    # (note: we'd use an unsigned GID in the record instead, but pyOpenSSL is
 478    #   broken and has no way for us to get the key back out of the gid)
 479    geni_info = record.get_geni_info()
 480    if "create_gid" in geni_info:
 481        key_string = geni_info["create_gid_key"].replace("|","\n") # XXX smbaker: the rspec kills newlines
 482        gid = registry.create_gid(auth_cred, geni_info["create_gid_hrn"], create_uuid(), key_string)
 483        record.set_gid(gid)
 484
 485        del geni_info["create_gid"]
 486        del geni_info["create_gid_hrn"]
 487        del geni_info["create_gid_key"]
 488
 489    return registry.register(auth_cred, record)
 490
 491 # update named registry entry
 492 def update(opts, args):
 493    global registry
 494    user_cred = get_user_cred()
 495    rec_file = get_record_file(args[0])
 496    record = load_record_from_file(rec_file)
 497    if record.get_type() == "user":
 498        if record.get_name() == user_cred.get_gid_object().get_hrn():
 499           cred = user_cred
 500        else:
 501           cred = get_auth_cred()
 502    elif record.get_type() in ["slice"]:
 503        try:
 504            cred = get_slice_cred(record.get_name())
 505        except ServerException, e:
 506            # XXX smbaker -- once we have better error return codes, update this
 507            # to do something better than a string compare
 508            if "Permission error" in e.args[0]:
 509                cred = get_auth_cred()
 510            else:
 511                raise
 512    elif record.get_type() in ["authority"]:
 513        cred = get_auth_cred()
 514    elif record.get_type() == 'node':
 515         cred = get_auth_cred()
 516    else:
 517        raise "unknown record type" + record.get_type()
 518    return registry.update(cred, record)
 519
 520 #
 521 # Slice-related commands
 522 #
 523
 524 # list available nodes -- now use 'resources' w/ no argument instead
 525 #def nodes(opts, args):
 526 #   global slicemgr
 527 #   user_cred = get_user_cred()
 528 #   if not opts.format:
 529 #      context = None
 530 #   else:
 531 #      context = opts.format
 532 #   results = slicemgr.list_nodes(user_cred)
 533 #   if opts.format in ['rspec']:
 534 #      display_rspec(results)
 535 #   else:
 536 #      display_list(results)
 537 #   if (opts.file is not None):
 538 #      rspec = slicemgr.list_nodes(user_cred)
 539 #      save_rspec_to_file(rspec, opts.file)
 540 #   return
 541
 542 # list instantiated slices
 543 def slices(opts, args):
 544    global slicemgr
 545    user_cred = get_user_cred()
 546    results = slicemgr.get_slices(user_cred)
 547    display_list(results)
 548    return
 549
 550 # show rspec for named slice
 551 def resources(opts, args):
 552    global slicemgr
 553    if args:
 554        slice_cred = get_slice_cred(args[0])
 555        result = slicemgr.get_resources(slice_cred, args[0])
 556    else:
 557        user_cred = get_user_cred()
 558        result = slicemgr.get_resources(user_cred)
 559    format = opts.format
 560    display_rspec(result, format)
 561    if (opts.file is not None):
 562       save_rspec_to_file(result, opts.file)
 563    return
 564
 565 # created named slice with given rspec
 566 def create(opts, args):
 567    global slicemgr
 568    slice_hrn = args[0]
 569    slice_cred = get_slice_cred(slice_hrn)
 570    rspec_file = get_rspec_file(args[1])
 571    with open(rspec_file) as f:
 572       rspec = f.read()
 573    return slicemgr.create_slice(slice_cred, slice_hrn, rspec)
 574
 575 # delete named slice
 576 def delete(opts, args):
 577    global slicemgr
 578    slice_hrn = args[0]
 579    slice_cred = get_slice_cred(slice_hrn)
 580
 581    return slicemgr.delete_slice(slice_cred, slice_hrn)
 582
 583 # start named slice
 584 def start(opts, args):
 585    global slicemgr
 586    slice_cred = get_slice_cred(args[0])
 587    return slicemgr.start_slice(slice_cred)
 588
 589 # stop named slice
 590 def stop(opts, args):
 591    global slicemgr
 592    slice_cred = get_slice_cred(args[0])
 593    return slicemgr.stop_slice(slice_cred)
 594
 595 # reset named slice
 596 def reset(opts, args):
 597    global slicemgr
 598    slice_cred = get_slice_cred(args[0])
 599    return slicemgr.reset_slice(slice_cred)
 600
 601 #
 602 #
 603 # Display, Save, and Filter RSpecs and Records
 604 #   - to be replace by EMF-generated routines
 605 #
 606 #
 607
 608 def display_rspec(rspec, format = 'rspec'):
 609     if format in ['dns']:
 610         spec = Rspec()
 611         spec.parseString(rspec)
 612         hostnames = []
 613         nodespecs = spec.getDictsByTagName('NodeSpec')
 614         for nodespec in nodespecs:
 615             if nodespec.has_key('name') and nodespec['name']:
 616                 if isinstance(nodespec['name'], ListType):
 617                     hostnames.extend(nodespec['name'])
 618                 elif isinstance(nodespec['name'], StringTypes):
 619                     hostnames.append(nodespec['name'])
 620         result = hostnames
 621     elif format in ['ip']:
 622         spec = Rspec()
 623         spec.parseString(rspec)
 624         ips = []
 625         ifspecs = spec.getDictsByTagName('IfSpec')
 626         for ifspec in ifspecs:
 627             if ifspec.has_key('addr') and ifspec['addr']:
 628                 ips.append(ifspec['addr'])
 629         result = ips
 630     else:
 631         result = rspec
 632
 633     print result
 634     return
 635
 636 def display_list(results):
 637     for result in results:
 638         print result
 639
 640 def save_rspec_to_file(rspec, filename):
 641    if not filename.startswith(os.sep):
 642        filename = sfi_dir + filename
 643    if not filename.endswith(".rspec"):
 644        filename = filename + ".rspec"
 645
 646    f = open(filename, 'w')
 647    f.write(rspec)
 648    f.close()
 649    return
 650
 651 def display_records(recordList, dump = False):
 652    ''' Print all fields in the record'''
 653    for record in recordList:
 654       display_record(record, dump)
 655
 656 def display_record(record, dump = False):
 657    if dump:
 658        record.dump()
 659    else:
 660        info = record.getdict()
 661        print "%s (%s)" % (info['hrn'], info['type'])
 662    return
 663
 664 def filter_records(type, records):
 665    filtered_records = []
 666    for record in records:
 667        if (record.get_type() == type) or (type == "all"):
 668            filtered_records.append(record)
 669    return filtered_records
 670
 671 def save_records_to_file(filename, recordList):
 672    index = 0
 673    for record in recordList:
 674        if index>0:
 675            save_record_to_file(filename + "." + str(index), record)
 676        else:
 677            save_record_to_file(filename, record)
 678        index = index + 1
 679
 680 def save_record_to_file(filename, record):
 681    if not filename.startswith(os.sep):
 682        filename = sfi_dir + filename
 683    str = record.save_to_string()
 684    file(filename, "w").write(str)
 685    return
 686
 687 def load_record_from_file(filename):
 688    str = file(filename, "r").read()
 689    record = GeniRecord(string=str)
 690    return record
 691
 692 if __name__=="__main__":
 693    main()