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
  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.common import optparse_listvalue_callback, optparse_dictvalue_callback, terminal_render, filter_records
  17 from sfa.client.candidates import Candidates
  18 from sfa.client.sfi import save_records_to_file
  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 add_options(*args, **kwargs):
  28     def _decorator(func):
  29         func.__dict__.setdefault('add_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     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='authority to list (hrn/urn - mandatory)')
  52     @add_options('-t', '--type', dest='type', metavar='<type>', help='object type', default='all')
  53     @add_options('-r', '--recursive', dest='recursive', metavar='<recursive>', help='list all child records',
  54           action='store_true', default=False)
  55     @add_options('-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     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
  70     @add_options('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
  71     @add_options('-o', '--outfile', dest='outfile', metavar='<outfile>', help='save record to file')
  72     @add_options('-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     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 121     @add_options('-t', '--type', dest='type', metavar='<type>', help='object type (mandatory)',)
 122     @add_options('-a', '--all', dest='all', metavar='<all>', action='store_true', default=False, help='check all users GID')
 123     @add_options('-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.model import RegRecord
 129         db_query = self.api.dbsession().query(RegRecord).filter_by(type=type)
 130         if xrn and not all:
 131             hrn = Xrn(xrn).get_hrn()
 132             db_query = db_query.filter_by(hrn=hrn)
 133         elif all and xrn:
 134             print "Use either -a or -x <xrn>, not both !!!"
 135             sys.exit(1)
 136         elif not all and not xrn:
 137             print "Use either -a or -x <xrn>, one of them is mandatory !!!"
 138             sys.exit(1)
 139
 140         records = db_query.all()
 141         if not records:
 142             print "No Record found"
 143             sys.exit(1)
 144
 145         OK = []
 146         NOK = []
 147         ERROR = []
 148         NOKEY = []
 149         for record in records:
 150              # get the pubkey stored in SFA DB
 151              if record.reg_keys:
 152                  db_pubkey_str = record.reg_keys[0].key
 153                  try:
 154                    db_pubkey_obj = convert_public_key(db_pubkey_str)
 155                  except:
 156                    ERROR.append(record.hrn)
 157                    continue
 158              else:
 159                  NOKEY.append(record.hrn)
 160                  continue
 161
 162              # get the pubkey from the gid
 163              gid_str = record.gid
 164              gid_obj = GID(string = gid_str)
 165              gid_pubkey_obj = gid_obj.get_pubkey()
 166
 167              # Check if gid_pubkey_obj and db_pubkey_obj are the same
 168              check = gid_pubkey_obj.is_same(db_pubkey_obj)
 169              if check :
 170                  OK.append(record.hrn)
 171              else:
 172                  NOK.append(record.hrn)
 173
 174         if not verbose:
 175             print "Users NOT having a PubKey: %s\n\
 176 Users having a non RSA PubKey: %s\n\
 177 Users having a GID/PubKey correpondence OK: %s\n\
 178 Users having a GID/PubKey correpondence Not OK: %s\n"%(len(NOKEY), len(ERROR), len(OK), len(NOK))
 179         else:
 180             print "Users NOT having a PubKey: %s and are: \n%s\n\n\
 181 Users having a non RSA PubKey: %s and are: \n%s\n\n\
 182 Users having a GID/PubKey correpondence OK: %s and are: \n%s\n\n\
 183 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)
 184
 185
 186
 187     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 188     @add_options('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 189     @add_options('-e', '--email', dest='email', default="",
 190           help="email (mandatory for users)")
 191     @add_options('-u', '--url', dest='url', metavar='<url>', default=None,
 192           help="URL, useful for slices")
 193     @add_options('-d', '--description', dest='description', metavar='<description>',
 194           help='Description, useful for slices', default=None)
 195     @add_options('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 196           default=None)
 197     @add_options('-s', '--slices', dest='slices', metavar='<slices>', help='Set/replace slice xrns',
 198           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 199     @add_options('-r', '--researchers', dest='researchers', metavar='<researchers>', help='Set/replace slice researchers',
 200           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 201     @add_options('-p', '--pis', dest='pis', metavar='<PIs>',
 202           help='Set/replace Principal Investigators/Project Managers',
 203           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 204     @add_options('-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")
 205     def register(self, xrn, type=None, url=None, description=None, key=None, slices='',
 206                  pis='', researchers='',email='', extras={}):
 207         """Create a new Registry record"""
 208         record_dict = self._record_dict(xrn=xrn, type=type, url=url, key=key,
 209                                         slices=slices, researchers=researchers, email=email, pis=pis, extras=extras)
 210         self.api.manager.Register(self.api, record_dict)
 211
 212
 213     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 214     @add_options('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 215     @add_options('-u', '--url', dest='url', metavar='<url>', help='URL', default=None)
 216     @add_options('-d', '--description', dest='description', metavar='<description>',
 217           help='Description', default=None)
 218     @add_options('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 219           default=None)
 220     @add_options('-s', '--slices', dest='slices', metavar='<slices>', help='Set/replace slice xrns',
 221           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 222     @add_options('-r', '--researchers', dest='researchers', metavar='<researchers>', help='Set/replace slice researchers',
 223           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 224     @add_options('-p', '--pis', dest='pis', metavar='<PIs>',
 225           help='Set/replace Principal Investigators/Project Managers',
 226           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 227     @add_options('-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")
 228     def update(self, xrn, type=None, url=None, description=None, key=None, slices='',
 229                pis='', researchers='', extras={}):
 230         """Update an existing Registry record"""
 231         print 'incoming PIS',pis
 232         record_dict = self._record_dict(xrn=xrn, type=type, url=url, description=description,
 233                                         key=key, slices=slices, researchers=researchers, pis=pis, extras=extras)
 234         self.api.manager.Update(self.api, record_dict)
 235
 236     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 237     @add_options('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 238     def remove(self, xrn, type=None):
 239         """Remove given object from the registry"""
 240         xrn = Xrn(xrn, type)
 241         self.api.manager.Remove(self.api, xrn)
 242
 243
 244     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 245     @add_options('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 246     def credential(self, xrn, type=None):
 247         """Invoke GetCredential"""
 248         cred = self.api.manager.GetCredential(self.api, xrn, type, self.api.hrn)
 249         print cred
 250
 251
 252     def import_registry(self):
 253         """Run the importer"""
 254         from sfa.importer import Importer
 255         importer = Importer()
 256         importer.run()
 257
 258     def sync_db(self):
 259         """Initialize or upgrade the db"""
 260         from sfa.storage.dbschema import DBSchema
 261         dbschema=DBSchema()
 262         dbschema.init_or_upgrade()
 263
 264     @add_options('-a', '--all', dest='all', metavar='<all>', action='store_true', default=False,
 265           help='Remove all registry records and all files in %s area' % help_basedir)
 266     @add_options('-c', '--certs', dest='certs', metavar='<certs>', action='store_true', default=False,
 267           help='Remove all cached certs/gids found in %s' % help_basedir )
 268     @add_options('-0', '--no-reinit', dest='reinit', metavar='<reinit>', action='store_false', default=True,
 269           help='Prevents new DB schema from being installed after cleanup')
 270     def nuke(self, all=False, certs=False, reinit=True):
 271         """Cleanup local registry DB, plus various additional filesystem cleanups optionally"""
 272         from sfa.storage.dbschema import DBSchema
 273         from sfa.util.sfalogging import _SfaLogger
 274         logger = _SfaLogger(logfile='/var/log/sfa_import.log', loggername='importlog')
 275         logger.setLevelFromOptVerbose(self.api.config.SFA_API_LOGLEVEL)
 276         logger.info("Purging SFA records from database")
 277         dbschema=DBSchema()
 278         dbschema.nuke()
 279
 280         # for convenience we re-create the schema here, so there's no need for an explicit
 281         # service sfa restart
 282         # however in some (upgrade) scenarios this might be wrong
 283         if reinit:
 284             logger.info("re-creating empty schema")
 285             dbschema.init_or_upgrade()
 286
 287         # remove the server certificate and all gids found in /var/lib/sfa/authorities
 288         if certs:
 289             logger.info("Purging cached certificates")
 290             for (dir, _, files) in os.walk('/var/lib/sfa/authorities'):
 291                 for file in files:
 292                     if file.endswith('.gid') or file == 'server.cert':
 293                         path=dir+os.sep+file
 294                         os.unlink(path)
 295
 296         # just remove all files that do not match 'server.key' or 'server.cert'
 297         if all:
 298             logger.info("Purging registry filesystem cache")
 299             preserved_files = [ 'server.key', 'server.cert']
 300             for (dir,_,files) in os.walk(Hierarchy().basedir):
 301                 for file in files:
 302                     if file in preserved_files: continue
 303                     path=dir+os.sep+file
 304                     os.unlink(path)
 305
 306
 307 class CertCommands(Commands):
 308
 309     def __init__(self, *args, **kwds):
 310         self.api= Generic.the_flavour().make_api(interface='registry')
 311
 312     def import_gid(self, xrn):
 313         pass
 314
 315     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 316     @add_options('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 317     @add_options('-o', '--outfile', dest='outfile', metavar='<outfile>', help='output file', default=None)
 318     def export(self, xrn, type=None, outfile=None):
 319         """Fetch an object's GID from the Registry"""
 320         from sfa.storage.model import RegRecord
 321         hrn = Xrn(xrn).get_hrn()
 322         request=self.api.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     @add_options('-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     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
 363     def status(self, xrn):
 364         """Retrieve the status of the slivers belonging to the named slice (Status)"""
 365         urns = [Xrn(xrn, 'slice').get_urn()]
 366         status = self.api.manager.Status(self.api, urns, [], {})
 367         pprinter.pprint(status)
 368
 369     @add_options('-r', '--rspec-version', dest='rspec_version', metavar='<rspec_version>',
 370           default='GENI', help='version/format of the resulting rspec response')
 371     def resources(self, rspec_version='GENI'):
 372         """Display the available resources at an aggregate"""
 373         options = {'geni_rspec_version': rspec_version}
 374         print options
 375         resources = self.api.manager.ListResources(self.api, [], options)
 376         print resources
 377
 378
 379     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 380     @add_options('-r', '--rspec', dest='rspec', metavar='<rspec>', help='rspec file (mandatory)')
 381     def allocate(self, xrn, rspec):
 382         """Allocate slivers"""
 383         xrn = Xrn(xrn, 'slice')
 384         slice_urn=xrn.get_urn()
 385         rspec_string = open(rspec).read()
 386         options={}
 387         manifest = self.api.manager.Allocate(self.api, slice_urn, [], rspec_string, options)
 388         print manifest
 389
 390
 391     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 392     def provision(self, xrn):
 393         """Provision slivers"""
 394         xrn = Xrn(xrn, 'slice')
 395         slice_urn=xrn.get_urn()
 396         options={}
 397         manifest = self.api.manager.provision(self.api, [slice_urn], [], options)
 398         print manifest
 399
 400
 401
 402     @add_options('-x', '--xrn', dest='xrn', metavar='<xrn>', help='slice hrn/urn (mandatory)')
 403     def delete(self, xrn):
 404         """Delete slivers"""
 405         self.api.manager.Delete(self.api, [xrn], [], {})
 406
 407
 408
 409
 410 class SliceManagerCommands(AggregateCommands):
 411
 412     def __init__(self, *args, **kwds):
 413         self.api= Generic.the_flavour().make_api(interface='slicemgr')
 414
 415
 416 class SfaAdmin:
 417
 418     CATEGORIES = {'certificate': CertCommands,
 419                   'registry': RegistryCommands,
 420                   'aggregate': AggregateCommands,
 421                   'slicemgr': SliceManagerCommands}
 422
 423     # returns (name,class) or (None,None)
 424     def find_category (self, input):
 425         full_name=Candidates (SfaAdmin.CATEGORIES.keys()).only_match(input)
 426         if not full_name: return (None,None)
 427         return (full_name,SfaAdmin.CATEGORIES[full_name])
 428
 429     def summary_usage (self, category=None):
 430         print "Usage:", self.script_name + " category command [<options>]"
 431         if category and category in SfaAdmin.CATEGORIES:
 432             categories=[category]
 433         else:
 434             categories=SfaAdmin.CATEGORIES
 435         for c in categories:
 436             cls=SfaAdmin.CATEGORIES[c]
 437             print "==================== category=%s"%c
 438             names=cls.__dict__.keys()
 439             names.sort()
 440             for name in names:
 441                 method=cls.__dict__[name]
 442                 if name.startswith('_'): continue
 443                 margin=15
 444                 format="%%-%ds"%margin
 445                 print "%-15s"%name,
 446                 doc=getattr(method,'__doc__',None)
 447                 if not doc:
 448                     print "<missing __doc__>"
 449                     continue
 450                 lines=[line.strip() for line in doc.split("\n")]
 451                 line1=lines.pop(0)
 452                 print line1
 453                 for extra_line in lines: print margin*" ",extra_line
 454         sys.exit(2)
 455
 456     def main(self):
 457         argv = copy.deepcopy(sys.argv)
 458         self.script_name = argv.pop(0)
 459         # ensure category is specified
 460         if len(argv) < 1:
 461             self.summary_usage()
 462
 463         # ensure category is valid
 464         category_input = argv.pop(0)
 465         (category_name, category_class) = self.find_category (category_input)
 466         if not category_name or not category_class:
 467             self.summary_usage(category_name)
 468
 469         usage = "%%prog %s command [options]" % (category_name)
 470         parser = OptionParser(usage=usage)
 471
 472         # ensure command is valid
 473         category_instance = category_class()
 474         commands = category_instance._get_commands()
 475         if len(argv) < 1:
 476             # xxx what is this about ?
 477             command_name = '__call__'
 478         else:
 479             command_input = argv.pop(0)
 480             command_name = Candidates (commands).only_match (command_input)
 481
 482         if command_name and hasattr(category_instance, command_name):
 483             command = getattr(category_instance, command_name)
 484         else:
 485             self.summary_usage(category_name)
 486
 487         # ensure options are valid
 488         usage = "%%prog %s %s [options]" % (category_name, command_name)
 489         parser = OptionParser(usage=usage)
 490         for args, kwdargs in getattr(command, 'add_options', []):
 491             parser.add_option(*args, **kwdargs)
 492         (opts, cmd_args) = parser.parse_args(argv)
 493         cmd_kwds = vars(opts)
 494
 495         # dont overrride meth
 496         for k, v in cmd_kwds.items():
 497             if v is None:
 498                 del cmd_kwds[k]
 499
 500         # execute command
 501         try:
 502             #print "invoking %s *=%s **=%s"%(command.__name__,cmd_args, cmd_kwds)
 503             command(*cmd_args, **cmd_kwds)
 504             sys.exit(0)
 505         except TypeError:
 506             print "Possible wrong number of arguments supplied"
 507             #import traceback
 508             #traceback.print_exc()
 509             print command.__doc__
 510             parser.print_help()
 511             #raise
 512         except Exception:
 513             print "Command failed, please check log for more info"
 514             raise
 515