sfa/client/sfaadmin.py

   1 #!/usr/bin/python
   2 import os
   3 import sys
   4 import copy
   5 from pprint import pformat, PrettyPrinter
   6 from optparse import OptionParser
   7
   8 from sfa.generic import Generic
   9 from sfa.util.xrn import Xrn
  10 from sfa.storage.record import Record
  11 from sfa.client.sfi import save_records_to_file
  12 from sfa.trust.hierarchy import Hierarchy
  13 from sfa.trust.gid import GID
  14 from sfa.trust.certificate import convert_public_key
  15
  16 from sfa.client.candidates import Candidates
  17
  18 from sfa.client.common import optparse_listvalue_callback, optparse_dictvalue_callback, terminal_render, filter_records
  19
  20 pprinter = PrettyPrinter(indent=4)
  21
  22 try:
  23     help_basedir=Hierarchy().basedir
  24 except:
  25     help_basedir='*unable to locate Hierarchy().basedir'
  26
  27 def args(*args, **kwargs):
  28     def _decorator(func):
  29         func.__dict__.setdefault('options', []).insert(0, (args, kwargs))
  30         return func
  31     return _decorator
  32
  33 class Commands(object):
  34     def _get_commands(self):
  35         command_names = []
  36         for attrib in dir(self):
  37             if callable(getattr(self, attrib)) and not attrib.startswith('_'):
  38                 command_names.append(attrib)
  39         return command_names
  40
  41
  42 class RegistryCommands(Commands):
  43     def __init__(self, *args, **kwds):
  44         self.api= Generic.the_flavour().make_api(interface='registry')
  45
  46     def version(self):
  47         """Display the Registry version"""
  48         version = self.api.manager.GetVersion(self.api, {})
  49         pprinter.pprint(version)
  50
  51     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='authority to list (hrn/urn - mandatory)')
  52     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default='all')
  53     @args('-r', '--recursive', dest='recursive', metavar='<recursive>', help='list all child records',
  54           action='store_true', default=False)
  55     @args('-v', '--verbose', dest='verbose', action='store_true', default=False)
  56     def list(self, xrn, type=None, recursive=False, verbose=False):
  57         """List names registered at a given authority - possibly filtered by type"""
  58         xrn = Xrn(xrn, type)
  59         options_dict = {'recursive': recursive}
  60         records = self.api.manager.List(self.api, xrn.get_hrn(), options=options_dict)
  61         list = filter_records(type, records)
  62         # terminal_render expects an options object
  63         class Options: pass
  64         options=Options()
  65         options.verbose=verbose
  66         terminal_render (list, options)
  67
  68
  69     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
  70     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
  71     @args('-o', '--outfile', dest='outfile', metavar='<outfile>', help='save record to file')
  72     @args('-f', '--format', dest='format', metavar='<display>', type='choice',
  73           choices=('text', 'xml', 'simple'), help='display record in different formats')
  74     def show(self, xrn, type=None, format=None, outfile=None):
  75         """Display details for a registered object"""
  76         records = self.api.manager.Resolve(self.api, xrn, type, details=True)
  77         for record in records:
  78             sfa_record = Record(dict=record)
  79             sfa_record.dump(format)
  80         if outfile:
  81             save_records_to_file(outfile, records)
  82
  83
  84     def _record_dict(self, xrn=None, type=None,
  85                      url=None, description=None, email='',
  86                      key=None,
  87                      slices=[], researchers=[], pis=[], extras={}):
  88         record_dict = {}
  89         if xrn:
  90             if type:
  91                 xrn = Xrn(xrn, type)
  92             else:
  93                 xrn = Xrn(xrn)
  94             record_dict['urn'] = xrn.get_urn()
  95             record_dict['hrn'] = xrn.get_hrn()
  96             record_dict['type'] = xrn.get_type()
  97         if url:
  98             record_dict['url'] = url
  99         if description:
 100             record_dict['description'] = description
 101         if key:
 102             try:
 103                 pubkey = open(key, 'r').read()
 104             except IOError:
 105                 pubkey = key
 106             record_dict['keys'] = [pubkey]
 107         if slices:
 108             record_dict['slices'] = slices
 109         if researchers:
 110             record_dict['researcher'] = researchers
 111         if email:
 112             record_dict['email'] = email
 113         if pis:
 114             record_dict['pi'] = pis
 115         if extras:
 116             record_dict.update(extras)
 117         return record_dict
 118
 119
 120     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 121     @args('-t', '--type', dest='type', metavar='<type>', help='object type (mandatory)',)
 122     @args('-a', '--all', dest='all', metavar='<all>', action='store_true', default=False, help='check all users GID')
 123     @args('-v', '--verbose', dest='verbose', metavar='<verbose>', action='store_true', default=False, help='verbose mode: display user\'s hrn ')
 124     def check_gid(self, xrn=None, type=None, all=None, verbose=None):
 125         """Check the correspondance between the GID and the PubKey"""
 126
 127         # db records
 128         from sfa.storage.alchemy import dbsession
 129         from sfa.storage.model import RegRecord
 130         db_query = dbsession.query(RegRecord).filter_by(type=type)
 131         if xrn and not all:
 132             hrn = Xrn(xrn).get_hrn()
 133             db_query = db_query.filter_by(hrn=hrn)
 134         elif all and xrn:
 135             print "Use either -a or -x <xrn>, not both !!!"
 136             sys.exit(1)
 137         elif not all and not xrn:
 138             print "Use either -a or -x <xrn>, one of them is mandatory !!!"
 139             sys.exit(1)
 140
 141         records = db_query.all()
 142         if not records:
 143             print "No Record found"
 144             sys.exit(1)
 145
 146         OK = []
 147         NOK = []
 148         ERROR = []
 149         NOKEY = []
 150         for record in records:
 151              # get the pubkey stored in SFA DB
 152              if record.reg_keys:
 153                  db_pubkey_str = record.reg_keys[0].key
 154                  try:
 155                    db_pubkey_obj = convert_public_key(db_pubkey_str)
 156                  except:
 157                    ERROR.append(record.hrn)
 158                    continue
 159              else:
 160                  NOKEY.append(record.hrn)
 161                  continue
 162
 163              # get the pubkey from the gid
 164              gid_str = record.gid
 165              gid_obj = GID(string = gid_str)
 166              gid_pubkey_obj = gid_obj.get_pubkey()
 167
 168              # Check if gid_pubkey_obj and db_pubkey_obj are the same
 169              check = gid_pubkey_obj.is_same(db_pubkey_obj)
 170              if check :
 171                  OK.append(record.hrn)
 172              else:
 173                  NOK.append(record.hrn)
 174
 175         if not verbose:
 176             print "Users NOT having a PubKey: %s\n\
 177 Users having a non RSA PubKey: %s\n\
 178 Users having a GID/PubKey correpondence OK: %s\n\
 179 Users having a GID/PubKey correpondence Not OK: %s\n"%(len(NOKEY), len(ERROR), len(OK), len(NOK))
 180         else:
 181             print "Users NOT having a PubKey: %s and are: \n%s\n\n\
 182 Users having a non RSA PubKey: %s and are: \n%s\n\n\
 183 Users having a GID/PubKey correpondence OK: %s and are: \n%s\n\n\
 184 Users having a GID/PubKey correpondence NOT OK: %s and are: \n%s\n\n"%(len(NOKEY),NOKEY, len(ERROR), ERROR, len(OK), OK, len(NOK), NOK)
 185
 186
 187
 188     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 189     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 190     @args('-e', '--email', dest='email', default="",
 191           help="email (mandatory for users)")
 192     @args('-u', '--url', dest='url', metavar='<url>', default=None,
 193           help="URL, useful for slices")
 194     @args('-d', '--description', dest='description', metavar='<description>',
 195           help='Description, useful for slices', default=None)
 196     @args('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 197           default=None)
 198     @args('-s', '--slices', dest='slices', metavar='<slices>', help='Set/replace slice xrns',
 199           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 200     @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='Set/replace slice researchers',
 201           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 202     @args('-p', '--pis', dest='pis', metavar='<PIs>',
 203           help='Set/replace Principal Investigators/Project Managers',
 204           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 205     @args('-X','--extra',dest='extras',default={},type='str',metavar="<EXTRA_ASSIGNS>", action="callback", callback=optparse_dictvalue_callback, nargs=1, help="set extra/testbed-dependent flags, e.g. --extra enabled=true")
 206
 207     def register(self, xrn, type=None, url=None, description=None, key=None, slices='',
 208                  pis='', researchers='',email='', extras={}):
 209         """Create a new Registry record"""
 210         record_dict = self._record_dict(xrn=xrn, type=type, url=url, key=key,
 211                                         slices=slices, researchers=researchers, email=email, pis=pis, extras=extras)
 212         self.api.manager.Register(self.api, record_dict)
 213
 214
 215     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 216     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 217     @args('-u', '--url', dest='url', metavar='<url>', help='URL', default=None)
 218     @args('-d', '--description', dest='description', metavar='<description>',
 219           help='Description', default=None)
 220     @args('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 221           default=None)
 222     @args('-s', '--slices', dest='slices', metavar='<slices>', help='Set/replace slice xrns',
 223           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 224     @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='Set/replace slice researchers',
 225           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 226     @args('-p', '--pis', dest='pis', metavar='<PIs>',
 227           help='Set/replace Principal Investigators/Project Managers',
 228           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 229     @args('-X','--extra',dest='extras',default={},type='str',metavar="<EXTRA_ASSIGNS>", action="callback", callback=optparse_dictvalue_callback, nargs=1, help="set extra/testbed-dependent flags, e.g. --extra enabled=true")
 230     def update(self, xrn, type=None, url=None, description=None, key=None, slices='',
 231                pis='', researchers='', extras={}):
 232         """Update an existing Registry record"""
 233         print 'incoming PIS',pis
 234         record_dict = self._record_dict(xrn=xrn, type=type, url=url, description=description,
 235                                         key=key, slices=slices, researchers=researchers, pis=pis, extras=extras)
 236         self.api.manager.Update(self.api, record_dict)
 237
 238     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 239     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 240     def remove(self, xrn, type=None):
 241         """Remove given object from the registry"""
 242         xrn = Xrn(xrn, type)
 243         self.api.manager.Remove(self.api, xrn)
 244
 245
 246     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 247     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 248     def credential(self, xrn, type=None):
 249         """Invoke GetCredential"""
 250         cred = self.api.manager.GetCredential(self.api, xrn, type, self.api.hrn)
 251         print cred
 252
 253
 254     def import_registry(self):
 255         """Run the importer"""
 256         from sfa.importer import Importer
 257         importer = Importer()
 258         importer.run()
 259
 260     def sync_db(self):
 261         """Initialize or upgrade the db"""
 262         from sfa.storage.dbschema import DBSchema
 263         dbschema=DBSchema()
 264         dbschema.init_or_upgrade()
 265
 266     @args('-a', '--all', dest='all', metavar='<all>', action='store_true', default=False,
 267           help='Remove all registry records and all files in %s area' % help_basedir)
 268     @args('-c', '--certs', dest='certs', metavar='<certs>', action='store_true', default=False,
 269           help='Remove all cached certs/gids found in %s' % help_basedir )
 270     @args('-0', '--no-reinit', dest='reinit', metavar='<reinit>', action='store_false', default=True,
 271           help='Prevents new DB schema from being installed after cleanup')
 272     def nuke(self, all=False, certs=False, reinit=True):
 273         """Cleanup local registry DB, plus various additional filesystem cleanups optionally"""
 274         from sfa.storage.dbschema import DBSchema
 275         from sfa.util.sfalogging import _SfaLogger
 276         logger = _SfaLogger(logfile='/var/log/sfa_import.log', loggername='importlog')
 277         logger.setLevelFromOptVerbose(self.api.config.SFA_API_LOGLEVEL)
 278         logger.info("Purging SFA records from database")
 279         dbschema=DBSchema()
 280         dbschema.nuke()
 281
 282         # for convenience we re-create the schema here, so there's no need for an explicit
 283         # service sfa restart
 284         # however in some (upgrade) scenarios this might be wrong
 285         if reinit:
 286             logger.info("re-creating empty schema")
 287             dbschema.init_or_upgrade()
 288
 289         # remove the server certificate and all gids found in /var/lib/sfa/authorities
 290         if certs:
 291             logger.info("Purging cached certificates")
 292             for (dir, _, files) in os.walk('/var/lib/sfa/authorities'):
 293                 for file in files:
 294                     if file.endswith('.gid') or file == 'server.cert':
 295                         path=dir+os.sep+file
 296                         os.unlink(path)
 297
 298         # just remove all files that do not match 'server.key' or 'server.cert'
 299         if all:
 300             logger.info("Purging registry filesystem cache")
 301             preserved_files = [ 'server.key', 'server.cert']
 302             for (dir,_,files) in os.walk(Hierarchy().basedir):
 303                 for file in files:
 304                     if file in preserved_files: continue
 305                     path=dir+os.sep+file
 306                     os.unlink(path)
 307
 308
 309 class CertCommands(Commands):
 310
 311     def import_gid(self, xrn):
 312         pass
 313
 314     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 315     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 316     @args('-o', '--outfile', dest='outfile', metavar='<outfile>', help='output file', default=None)
 317     def export(self, xrn, type=None, outfile=None):
 318         """Fetch an object's GID from the Registry"""
 319         from sfa.storage.alchemy import dbsession
 320         from sfa.storage.model import RegRecord
 321         hrn = Xrn(xrn).get_hrn()
 322         request=dbsession.query(RegRecord).filter_by(hrn=hrn)
 323         if type: request = request.filter_by(type=type)
 324         record=request.first()
 325         if record:
 326             gid = GID(string=record.gid)
 327         else:
 328             # check the authorities hierarchy
 329             hierarchy = Hierarchy()
 330             try:
 331                 auth_info = hierarchy.get_auth_info(hrn)
 332                 gid = auth_info.gid_object
 333             except:
 334                 print "Record: %s not found" % hrn
 335                 sys.exit(1)
 336         # save to file
 337         if not outfile:
 338             outfile = os.path.abspath('./%s.gid' % gid.get_hrn())
 339         gid.save_to_file(outfile, save_parents=True)
 340
 341     @args('-g', '--gidfile', dest='gid', metavar='<gid>', help='path of gid file to display (mandatory)')
 342     def display(self, gidfile):
 343         """Print contents of a GID file"""
 344         gid_path = os.path.abspath(gidfile)
 345         if not gid_path or not os.path.isfile(gid_path):
 346             print "No such gid file: %s" % gidfile
 347             sys.exit(1)
 348         gid = GID(filename=gid_path)
 349         gid.dump(dump_parents=True)
 350
 351
 352 class AggregateCommands(Commands):
 353
 354     def __init__(self, *args, **kwds):
 355         self.api= Generic.the_flavour().make_api(interface='aggregate')
 356
 357     def version(self):
 358         """Display the Aggregate version"""
 359         version = self.api.manager.GetVersion(self.api, {})
 360         pprinter.pprint(version)
 361
 362     def slices(self):
 363         """List the running slices at this Aggregate"""
 364         print self.api.manager.ListSlices(self.api, [], {})
 365
 366     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 367     def status(self, xrn):
 368         """Display the status of a slice or slivers"""
 369         urn = Xrn(xrn, 'slice').get_urn()
 370         status = self.api.manager.SliverStatus(self.api, urn, [], {})
 371         pprinter.pprint(status)
 372
 373     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 374     @args('-r', '--rspec-version', dest='rspec_version', metavar='<rspec_version>',
 375           default='GENI', help='version/format of the resulting rspec response')
 376     def resources(self, xrn=None, rspec_version='GENI'):
 377         """Display the available resources at an aggregate
 378 or the resources allocated by a slice"""
 379         options = {'geni_rspec_version': rspec_version}
 380         if xrn:
 381             options['geni_slice_urn'] = Xrn(xrn, 'slice').get_urn()
 382         print options
 383         resources = self.api.manager.ListResources(self.api, [], options)
 384         print resources
 385
 386     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 387     @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='rspec file (mandatory)')
 388     @args('-u', '--user', dest='user', metavar='<user>', help='hrn/urn of slice user (mandatory)')
 389     @args('-k', '--key', dest='key', metavar='<key>', help="path to user's public key file (mandatory)")
 390     def create(self, xrn, rspec, user, key):
 391         """Allocate slivers"""
 392         xrn = Xrn(xrn, 'slice')
 393         slice_urn=xrn.get_urn()
 394         rspec_string = open(rspec).read()
 395         user_xrn = Xrn(user, 'user')
 396         user_urn = user_xrn.get_urn()
 397         user_key_string = open(key).read()
 398         users = [{'urn': user_urn, 'keys': [user_key_string]}]
 399         options={}
 400         self.api.manager.CreateSliver(self, slice_urn, [], rspec_string, users, options)
 401
 402     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 403     def delete(self, xrn):
 404         """Delete slivers"""
 405         self.api.manager.DeleteSliver(self.api, xrn, [], {})
 406
 407     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 408     def start(self, xrn):
 409         """Start slivers"""
 410         self.api.manager.start_slice(self.api, xrn, [])
 411
 412     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 413     def stop(self, xrn):
 414         """Stop slivers"""
 415         self.api.manager.stop_slice(self.api, xrn, [])
 416
 417     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 418     def reset(self, xrn):
 419         """Reset sliver"""
 420         self.api.manager.reset_slice(self.api, xrn)
 421
 422
 423 #    @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 424 #    @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='request rspec', default=None)
 425 #    def ticket(self, xrn, rspec):
 426 #        pass
 427
 428
 429
 430 class SliceManagerCommands(AggregateCommands):
 431
 432     def __init__(self, *args, **kwds):
 433         self.api= Generic.the_flavour().make_api(interface='slicemgr')
 434
 435
 436 class SfaAdmin:
 437
 438     CATEGORIES = {'certificate': CertCommands,
 439                   'registry': RegistryCommands,
 440                   'aggregate': AggregateCommands,
 441                   'slicemgr': SliceManagerCommands}
 442
 443     # returns (name,class) or (None,None)
 444     def find_category (self, input):
 445         full_name=Candidates (SfaAdmin.CATEGORIES.keys()).only_match(input)
 446         if not full_name: return (None,None)
 447         return (full_name,SfaAdmin.CATEGORIES[full_name])
 448
 449     def summary_usage (self, category=None):
 450         print "Usage:", self.script_name + " category command [<options>]"
 451         if category and category in SfaAdmin.CATEGORIES:
 452             categories=[category]
 453         else:
 454             categories=SfaAdmin.CATEGORIES
 455         for c in categories:
 456             cls=SfaAdmin.CATEGORIES[c]
 457             print "==================== category=%s"%c
 458             names=cls.__dict__.keys()
 459             names.sort()
 460             for name in names:
 461                 method=cls.__dict__[name]
 462                 if name.startswith('_'): continue
 463                 margin=15
 464                 format="%%-%ds"%margin
 465                 print "%-15s"%name,
 466                 doc=getattr(method,'__doc__',None)
 467                 if not doc:
 468                     print "<missing __doc__>"
 469                     continue
 470                 lines=[line.strip() for line in doc.split("\n")]
 471                 line1=lines.pop(0)
 472                 print line1
 473                 for extra_line in lines: print margin*" ",extra_line
 474         sys.exit(2)
 475
 476     def main(self):
 477         argv = copy.deepcopy(sys.argv)
 478         self.script_name = argv.pop(0)
 479         # ensure category is specified
 480         if len(argv) < 1:
 481             self.summary_usage()
 482
 483         # ensure category is valid
 484         category_input = argv.pop(0)
 485         (category_name, category_class) = self.find_category (category_input)
 486         if not category_name or not category_class:
 487             self.summary_usage(category_name)
 488
 489         usage = "%%prog %s command [options]" % (category_name)
 490         parser = OptionParser(usage=usage)
 491
 492         # ensure command is valid
 493         category_instance = category_class()
 494         commands = category_instance._get_commands()
 495         if len(argv) < 1:
 496             # xxx what is this about ?
 497             command_name = '__call__'
 498         else:
 499             command_input = argv.pop(0)
 500             command_name = Candidates (commands).only_match (command_input)
 501
 502         if command_name and hasattr(category_instance, command_name):
 503             command = getattr(category_instance, command_name)
 504         else:
 505             self.summary_usage(category_name)
 506
 507         # ensure options are valid
 508         options = getattr(command, 'options', [])
 509         usage = "%%prog %s %s [options]" % (category_name, command_name)
 510         parser = OptionParser(usage=usage)
 511         for arg, kwd in options:
 512             parser.add_option(*arg, **kwd)
 513         (opts, cmd_args) = parser.parse_args(argv)
 514         cmd_kwds = vars(opts)
 515
 516         # dont overrride meth
 517         for k, v in cmd_kwds.items():
 518             if v is None:
 519                 del cmd_kwds[k]
 520
 521         # execute command
 522         try:
 523             #print "invoking %s *=%s **=%s"%(command.__name__,cmd_args, cmd_kwds)
 524             command(*cmd_args, **cmd_kwds)
 525             sys.exit(0)
 526         except TypeError:
 527             print "Possible wrong number of arguments supplied"
 528             #import traceback
 529             #traceback.print_exc()
 530             print command.__doc__
 531             parser.print_help()
 532             #raise
 533         except Exception:
 534             print "Command failed, please check log for more info"
 535             raise
 536