sfa/clientbin/sfaadmin.py

   1 #!/usr/bin/python
   2 import os
   3 import sys
   4 import copy
   5 from pprint import pformat
   6 from sfa.generic import Generic
   7 from optparse import OptionParser
   8 from pprint import PrettyPrinter
   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
  15 pprinter = PrettyPrinter(indent=4)
  16
  17 def optparse_listvalue_callback(option, opt, value, parser):
  18     print option
  19     print opt
  20     print value
  21     print parser
  22     setattr(parser.values, option.dest, value.split(','))
  23
  24 def args(*args, **kwargs):
  25     def _decorator(func):
  26         func.__dict__.setdefault('options', []).insert(0, (args, kwargs))
  27         return func
  28     return _decorator
  29
  30 class Commands(object):
  31     def _get_commands(self):
  32         available_methods = []
  33         for attrib in dir(self):
  34             if callable(getattr(self, attrib)) and not attrib.startswith('_'):
  35                 available_methods.append(attrib)
  36         return available_methods
  37
  38
  39 class RegistryCommands(Commands):
  40     def __init__(self, *args, **kwds):
  41         self.api= Generic.the_flavour().make_api(interface='registry')
  42
  43     def version(self):
  44         version = self.api.manager.GetVersion(self.api, {})
  45         pprinter.pprint(version)
  46
  47     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn')
  48     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
  49     def list(self, xrn, type=None):
  50         xrn = Xrn(xrn, type)
  51         records = self.api.manager.List(self.api, xrn.get_hrn())
  52         for record in records:
  53             if not type or record['type'] == type:
  54                 print "%s (%s)" % (record['hrn'], record['type'])
  55
  56
  57     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn')
  58     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
  59     @args('-o', '--outfile', dest='outfile', metavar='<outfile>', help='save record to file')
  60     @args('-f', '--format', dest='format', metavar='<display>', type='choice',
  61           choices=('text', 'xml', 'simple'), help='display record in different formats')
  62     def show(self, xrn, type=None, format=None, outfile=None):
  63         records = self.api.manager.Resolve(self.api, xrn, type, True)
  64         for record in records:
  65             sfa_record = Record(dict=record)
  66             sfa_record.dump(format)
  67         if outfile:
  68             save_records_to_file(outfile, records)
  69
  70
  71     def _record_dict(self, xrn, type=None, url=None, key=None, \
  72                      slices='', researchers=''):
  73         record_dict = {}
  74         if xrn:
  75             if type:
  76                 xrn = Xrn(xrn, type)
  77             else:
  78                 xrn = Xrn(xrn)
  79             record_dict['urn'] = xrn.get_urn()
  80             record_dict['hrn'] = xrn.get_hrn()
  81             record_dict['type'] = xrn.get_type()
  82         if url:
  83             record_dict['url'] = url
  84         if key:
  85             try:
  86                 pubkey = open(key, 'r').read()
  87             except IOError:
  88                 pubkey = key
  89             record_dict['keys'] = [pubkey]
  90         if slices:
  91             record_dict['slices'] = slices
  92         if researchers:
  93             record_dict['researchers'] = researchers
  94         return record_dict
  95
  96     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn')
  97     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
  98     @args('-u', '--url', dest='url', metavar='<url>', help='URL', default=None)
  99     @args('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 100           default=None)
 101     @args('-s', '--slices', dest='slices', metavar='<slices>', help='slice xrns',
 102           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 103     @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='slice researchers',
 104           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 105     def register(self, xrn, type=None, url=None, key=None, slices='', researchers=''):
 106         record_dict = self._record_dict(xrn, type, url, key, slices, researchers)
 107         self.api.manager.Register(self.api, record_dict)
 108
 109     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn')
 110     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 111     @args('-u', '--url', dest='url', metavar='<url>', help='URL', default=None)
 112     @args('-k', '--key', dest='key', metavar='<key>', help='public key string or file',
 113           default=None)
 114     @args('-s', '--slices', dest='slices', metavar='<slices>', help='slice xrns',
 115           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 116     @args('-r', '--researchers', dest='researchers', metavar='<researchers>', help='slice researchers',
 117           default='', type="str", action='callback', callback=optparse_listvalue_callback)
 118     def update(self, record):
 119         record_dict = self._record_dict(xrn, type, url, key, slices, researchers)
 120         self.api.manager.Update(self.api, record_dict)
 121
 122     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn')
 123     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 124     def remove(self, xrn, type=None):
 125         xrn = Xrn(xrn, type)
 126         self.api.manager.Remove(self.api, xrn)
 127
 128
 129     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn')
 130     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 131     def credential(self, xrn, type=None):
 132         cred = self.api.manager.GetCredential(self.api, xrn, type, self.api.hrn)
 133         print cred
 134
 135
 136     def import_registry(self):
 137         from sfa.importer import Importer
 138         importer = Importer()
 139         importer.run()
 140
 141     @args('-a', '--all', dest='all', metavar='<all>', action='store_true', default=False,
 142           help='Remove all registry records and all files in %s area' % Hierarchy().basedir)
 143     @args('-c', '--certs', dest='certs', metavar='<certs>', action='store_true', default=False,
 144           help='Remove all cached certs/gids found in %s' % Hierarchy().basedir )
 145     @args('-0', '--no-reinit', dest='reinit', metavar='<reinit>', action='store_false', default=True,
 146           help='Prevents new DB schema from being installed after cleanup')
 147     def nuke(self, all=False, certs=False, reinit=True):
 148         from sfa.storage.dbschema import DBSchema
 149         from sfa.util.sfalogging import _SfaLogger
 150         logger = _SfaLogger(logfile='/var/log/sfa_import.log', loggername='importlog')
 151         logger.setLevelFromOptVerbose(self.api.config.SFA_API_LOGLEVEL)
 152         logger.info("Purging SFA records from database")
 153         dbschema=DBSchema()
 154         dbschema.nuke()
 155
 156         # for convenience we re-create the schema here, so there's no need for an explicit
 157         # service sfa restart
 158         # however in some (upgrade) scenarios this might be wrong
 159         if reinit:
 160             logger.info("re-creating empty schema")
 161             dbschema.init_or_upgrade()
 162
 163         # remove the server certificate and all gids found in /var/lib/sfa/authorities
 164         if certs:
 165             logger.info("Purging cached certificates")
 166             for (dir, _, files) in os.walk('/var/lib/sfa/authorities'):
 167                 for file in files:
 168                     if file.endswith('.gid') or file == 'server.cert':
 169                         path=dir+os.sep+file
 170                         os.unlink(path)
 171
 172         # just remove all files that do not match 'server.key' or 'server.cert'
 173         if all:
 174             logger.info("Purging registry filesystem cache")
 175             preserved_files = [ 'server.key', 'server.cert']
 176             for (dir,_,files) in os.walk(Hierarchy().basedir):
 177                 for file in files:
 178                     if file in preserved_files: continue
 179                     path=dir+os.sep+file
 180                     os.unlink(path)
 181
 182
 183 class CertCommands(Commands):
 184
 185     def import_gid(self, xrn):
 186         pass
 187
 188     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn')
 189     @args('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
 190     @args('-o', '--outfile', dest='outfile', metavar='<outfile>', help='output file', default=None)
 191     def export(self, xrn, type=None, outfile=None):
 192         from sfa.storage.alchemy import dbsession
 193         from sfa.storage.model import RegRecord
 194         hrn = Xrn(xrn).get_hrn()
 195         request=dbsession.query(RegRecord).filter_by(hrn=hrn)
 196         if type: request = request.filter_by(type=type)
 197         record=request.first()
 198         if record:
 199             gid = GID(string=record.gid)
 200         else:
 201             # check the authorities hierarchy
 202             hierarchy = Hierarchy()
 203             try:
 204                 auth_info = hierarchy.get_auth_info(hrn)
 205                 gid = auth_info.gid_object
 206             except:
 207                 print "Record: %s not found" % hrn
 208                 sys.exit(1)
 209         # save to file
 210         if not outfile:
 211             outfile = os.path.abspath('./%s.gid' % gid.get_hrn())
 212         gid.save_to_file(outfile, save_parents=True)
 213
 214     @args('-g', '--gidfile', dest='gid', metavar='<gid>', help='path of gid file to display')
 215     def display(self, gidfile):
 216         gid_path = os.path.abspath(gidfile)
 217         if not gid_path or not os.path.isfile(gid_path):
 218             print "No such gid file: %s" % gidfile
 219             sys.exit(1)
 220         gid = GID(filename=gid_path)
 221         gid.dump(dump_parents=True)
 222
 223
 224 class AggregateCommands(Commands):
 225
 226     def __init__(self, *args, **kwds):
 227         self.api= Generic.the_flavour().make_api(interface='aggregate')
 228
 229     def version(self):
 230         version = self.api.manager.GetVersion(self.api, {})
 231         pprinter.pprint(version)
 232
 233     def slices(self):
 234         print self.api.manager.ListSlices(self.api, [], {})
 235
 236     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn')
 237     def status(self, xrn):
 238         urn = Xrn(xrn, 'slice').get_urn()
 239         status = self.api.manager.SliverStatus(self.api, urn, [], {})
 240         pprinter.pprint(status)
 241
 242     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 243     @args('-r', '--rspec-version', dest='rspec_version', metavar='<rspec_version>',
 244           default='GENI', help='version/format of the resulting rspec response')
 245     def resources(self, xrn=None, rspec_version='GENI'):
 246         options = {'geni_rspec_version': rspec_version}
 247         if xrn:
 248             options['geni_slice_urn'] = xrn
 249         resources = self.api.manager.ListResources(self.api, [], options)
 250         print resources
 251
 252     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 253     @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='rspec file')
 254     @args('-u', '--user', dest='user', metavar='<user>', help='hrn/urn of slice user')
 255     @args('-k', '--key', dest='key', metavar='<key>', help="path to user's public key file")
 256     def create(self, xrn, rspec, user, key):
 257         xrn = Xrn(xrn, 'slice')
 258         slice_urn=xrn.get_urn()
 259         rspec_string = open(rspec).read()
 260         user_xrn = Xrn(user, 'user')
 261         user_urn = user_xrn.get_urn()
 262         user_key_string = open(key).read()
 263         users = [{'urn': user_urn, 'keys': [user_key_string]}]
 264         options={}
 265         self.api.manager.CreateSliver(self, slice_urn, [], rspec_string, users, options)
 266
 267     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 268     def delete(self, xrn):
 269         self.api.manager.DeleteSliver(self.api, xrn, [], {})
 270
 271     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 272     def start(self, xrn):
 273         self.api.manager.start_slice(self.api, xrn, [])
 274
 275     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 276     def stop(self, xrn):
 277         self.api.manager.stop_slice(self.api, xrn, [])
 278
 279     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 280     def reset(self, xrn):
 281         self.api.manager.reset_slice(self.api, xrn)
 282
 283
 284     @args('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn', default=None)
 285     @args('-r', '--rspec', dest='rspec', metavar='<rspec>', help='request rspec', default=None)
 286     def ticket(self, xrn, rspec):
 287         pass
 288
 289
 290
 291 class SliceManagerCommands(AggregateCommands):
 292
 293     def __init__(self, *args, **kwds):
 294         self.api= Generic.the_flavour().make_api(interface='slicemgr')
 295
 296
 297 CATEGORIES = {'cert': CertCommands,
 298               'registry': RegistryCommands,
 299               'aggregate': AggregateCommands,
 300               'slicemgr': SliceManagerCommands}
 301
 302 def category_usage():
 303     print "Available categories:"
 304     for k in CATEGORIES:
 305         print "\t%s" % k
 306
 307 def main():
 308     argv = copy.deepcopy(sys.argv)
 309     script_name = argv.pop(0)
 310     # ensure category is specified
 311     if len(argv) < 1:
 312         print script_name + " category action [<args>]"
 313         category_usage()
 314         sys.exit(2)
 315
 316     # ensure category is valid
 317     category = argv.pop(0)
 318     usage = "%%prog %s action <args> [options]" % (category)
 319     parser = OptionParser(usage=usage)
 320     command_class =  CATEGORIES.get(category, None)
 321     if not command_class:
 322         print "no such category %s " % category
 323         category_usage()
 324         sys.exit(2)
 325
 326     # ensure command is valid
 327     command_instance = command_class()
 328     actions = command_instance._get_commands()
 329     if len(argv) < 1:
 330         action = '__call__'
 331     else:
 332         action = argv.pop(0)
 333
 334     if hasattr(command_instance, action):
 335         command = getattr(command_instance, action)
 336     else:
 337         print script_name + " category action [<args>]"
 338         print "Available actions for %s category:" % category
 339         for k in actions:
 340             print "\t%s" % k
 341         sys.exit(2)
 342
 343     # ensure options are valid
 344     options = getattr(command, 'options', [])
 345     usage = "%%prog %s %s <args> [options]" % (category, action)
 346     parser = OptionParser(usage=usage)
 347     for arg, kwd in options:
 348         print "arg", arg
 349         print "kwd", kwd
 350         parser.add_option(*arg, **kwd)
 351     (opts, cmd_args) = parser.parse_args(argv)
 352     cmd_kwds = vars(opts)
 353
 354     # dont overrride meth
 355     for k, v in cmd_kwds.items():
 356         if v is None:
 357             del cmd_kwds[k]
 358
 359     # execute commadn
 360     try:
 361         command(*cmd_args, **cmd_kwds)
 362         sys.exit(0)
 363     except TypeError:
 364         print "Possible wrong number of arguments supplied"
 365         print command.__doc__
 366         parser.print_help()
 367         #raise
 368         raise
 369     except Exception:
 370         print "Command failed, please check log for more info"
 371         raise
 372
 373
 374 if __name__ == '__main__':
 375     main()
 376
 377
 378
 379