sfa/client/manifolduploader.py

   1 #!/usr/bin/env python
   2 #
   3 # inspired from tophat/bin/uploadcredential.py
   4 #
   5 # the purpose here is to let people upload their delegated credentials
   6 # to a manifold/myslice infrastructure, without the need for having to
   7 # install a separate tool; so duplicating this code is suboptimal in
   8 # terms of code sharing but acceptable for hopefully easier use
   9 #
  10 # As of April 2013, manifold is moving from old-fashioned API known as
  11 # v1, that offers an AddCredential API call, towards a new API v2 that
  12 # manages credentials with the same set of Get/Update calls as other
  13 # objects
  14 #
  15 # Since this code targets the future we favour v2, however in case
  16 # this won't work the v1 way is attempted too
  17 #
  18
  19 ## this for now points at demo.myslice.info, but sounds like a
  20 ## better default for the long run
  21 DEFAULT_URL = "http://myslice.onelab.eu:7080"
  22 DEFAULT_PLATFORM = 'ple'
  23
  24 import xmlrpclib
  25 import getpass
  26
  27 class ManifoldUploader:
  28     """A utility class for uploading delegated credentials to a manifold/MySlice infrastructure"""
  29
  30     # platform is a name internal to the manifold deployment,
  31     # that maps to a testbed, like e.g. 'ple'
  32     def __init__ (self, logger, url=None, platform=None, username=None, password=None, ):
  33         self._url=url
  34         self._platform=platform
  35         self._username=username
  36         self._password=password
  37         self.logger=logger
  38         self._proxy=None
  39
  40     def username (self):
  41         if not self._username:
  42             self._username=raw_input("Enter your manifold username: ")
  43         return self._username
  44
  45     def password (self):
  46         if not self._password:
  47             username=self.username()
  48             self._password=getpass.getpass("Enter password for manifold user %s: "%username)
  49         return self._password
  50
  51     def platform (self):
  52         if not self._platform:
  53             self._platform=raw_input("Enter your manifold platform [%s]: "%DEFAULT_PLATFORM)
  54             if self._platform.strip()=="": self._platform = DEFAULT_PLATFORM
  55         return self._platform
  56
  57     def url (self):
  58         if not self._url:
  59             self._url=raw_input("Enter the URL for your manifold API [%s]: "%DEFAULT_URL)
  60             if self._url.strip()=="": self._url = DEFAULT_URL
  61         return self._url
  62
  63     def prompt_all(self):
  64         self.username(); self.password(); self.platform(); self.url()
  65
  66     def proxy (self):
  67         if not self._proxy:
  68             url=self.url()
  69             self.logger.debug("Connecting manifold url %s"%url)
  70             self._proxy = xmlrpclib.ServerProxy(url, allow_none = True)
  71         return self._proxy
  72
  73     # does the job for one credential
  74     # expects the credential (string) and an optional message for reporting
  75     # return True upon success and False otherwise
  76     def upload (self, delegated_credential, message=None):
  77         platform=self.platform()
  78         username=self.username()
  79         password=self.password()
  80         auth = {'AuthMethod': 'password', 'Username': username, 'AuthString': password}
  81         if not message: message=""
  82
  83         try:
  84 #            manifold=self.proxy()
  85             url=self.url()
  86             self.logger.debug("Connecting manifold url %s"%url)
  87             manifold = xmlrpclib.Server(url, allow_none = 1)
  88             # the code for a V2 interface
  89             query= { 'action':     'update',
  90                      'object':     'local:account',
  91                      'filters':    [ ['platform', '=', platform] ] ,
  92                      'params':     {'credential': delegated_credential, },
  93                      }
  94             try:
  95                 self.logger.debug("Trying v2 method Update@%s %s"%(platform,message))
  96                 retcod2=manifold.Update (auth, query)
  97             except Exception,e:
  98                 # xxx we need a constant constant for UNKNOWN, how about using 1
  99                 MANIFOLD_UNKNOWN=1
 100                 retcod2={'code':MANIFOLD_UNKNOWN,'description':"%s"%e}
 101             if retcod2['code']==0:
 102                 info=""
 103                 if message: info += message+" "
 104                 info += 'v2 upload OK'
 105                 self.logger.info(info)
 106                 return True
 107             #print delegated_credential, "upload failed,",retcod['description'], \
 108             #    "with code",retcod['code']
 109             # the code for V1
 110             try:
 111                 self.logger.debug("Trying v1 method AddCredential@%s %s"%(platform,message))
 112                 retcod1=manifold.AddCredential(auth, delegated_credential, platform)
 113             except Exception,e:
 114                 retcod1=e
 115             if retcod1==1:
 116                 info=""
 117                 if message: info += message+" "
 118                 info += 'v1 upload OK'
 119                 self.logger.info(message)
 120                 return True
 121             # everything has failed, let's report
 122             if message: self.logger.error("Could not upload %s"%message)
 123             else: self.logger.error("Could not upload credential")
 124             if 'code' in retcod2 and 'description' in retcod2:
 125                 self.logger.info("  V2 Update returned code %s and error >>%s<<"%(retcod2['code'],retcod2['description']))
 126                 self.logger.debug("****** full retcod2")
 127                 for (k,v) in retcod2.items(): self.logger.debug("**** %s: %s"%(k,v))
 128             else:
 129                 self.logger.info("  V2 Update returned %s"%retcod2)
 130             self.logger.info("  V1 AddCredential returned code %s (expected 1)"%retcod1)
 131             return False
 132         except Exception, e:
 133             if message: self.logger.error("Could not upload %s %s"%(message,e))
 134             else:        self.logger.error("Could not upload credential %s"%e)
 135             if self.logger.debugEnabled():
 136                 import traceback
 137                 traceback.print_exc()
 138
 139 ### this is mainly for unit testing this class but can come in handy as well
 140 def main ():
 141     from argparse import ArgumentParser
 142     parser = ArgumentParser (description="manifoldupoader simple tester.")
 143     parser.add_argument ('credential_files',metavar='FILE',type=str,nargs='+',
 144                          help="the filenames to upload")
 145     parser.add_argument ('-u','--url',dest='url', action='store',default=None,
 146                          help='the URL of the manifold API')
 147     parser.add_argument ('-p','--platform',dest='platform',action='store',default=None,
 148                          help='the manifold platform name')
 149     parser.add_argument ('-U','--user',dest='username',action='store',default=None,
 150                          help='the manifold username')
 151     parser.add_argument ('-P','--password',dest='password',action='store',default=None,
 152                          help='the manifold password')
 153     parser.add_argument ('-v','--verbose',dest='verbose',action='count',default=0,
 154                          help='more and more verbose')
 155     args = parser.parse_args ()
 156
 157     from sfa.util.sfalogging import sfi_logger
 158     sfi_logger.enable_console()
 159     sfi_logger.setLevelFromOptVerbose(args.verbose)
 160     uploader = ManifoldUploader (url=args.url, platform=args.platform,
 161                                  username=args.username, password=args.password,
 162                                  logger=sfi_logger)
 163
 164     for filename in args.credential_files:
 165         with file(filename) as f:
 166             result=uploader.upload (f.read(),filename)
 167             sfi_logger.info('... result=%s'%result)
 168
 169 if __name__ == '__main__':
 170     main()