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