source/BootAPI.py

   1 #!/usr/bin/python2
   2
   3 # Copyright (c) 2003 Intel Corporation
   4 # All rights reserved.
   5 #
   6 # Copyright (c) 2004-2006 The Trustees of Princeton University
   7 # All rights reserved.
   8
   9
  10 import xmlrpclib
  11 import xml.parsers.expat
  12 import hmac
  13 import string
  14 import sha
  15
  16 from Exceptions import *
  17
  18
  19 def create_auth_structure( vars, call_params ):
  20     """
  21     create and return an authentication structure for a Boot API
  22     call. Vars contains the boot manager runtime variables, and
  23     call_params is a tuple of the parameters that will be passed to the
  24     API call. Return None if unable to (typically due to missing
  25     keys in vars, such as node_id or node_key)
  26     """
  27
  28     auth= {}
  29     auth['AuthMethod']= 'hmac'
  30
  31     try:
  32         network= vars['NETWORK_SETTINGS']
  33
  34         auth['node_id']= vars['NODE_ID']
  35         auth['node_ip']= network['ip']
  36         node_key= vars['NODE_KEY']
  37     except KeyError, e:
  38         return None
  39
  40     params= serialize_params(call_params)
  41     params.sort()
  42     msg= "[" + "".join(params) + "]"
  43     node_hmac= hmac.new(node_key,msg.encode('utf-8'),sha).hexdigest()
  44     auth['value']= node_hmac
  45
  46     return auth
  47
  48
  49
  50 def serialize_params( call_params ):
  51     """
  52     convert a list of parameters into a format that will be used in the
  53     hmac generation. both the boot manager and plc must have a common
  54     format. full documentation is in the boot manager technical document,
  55     but essentially we are going to take all the values (and keys for
  56     dictionary objects), and put them into a list. sort them, and combine
  57     them into one long string encased in a set of braces.
  58     """
  59
  60     values= []
  61
  62     for param in call_params:
  63         if isinstance(param,list) or isinstance(param,tuple):
  64             values += serialize_params(param)
  65         elif isinstance(param,dict):
  66             values += serialize_params(param.values())
  67         else:
  68             values.append(unicode(param))
  69
  70     return values
  71
  72
  73 def call_api_function( vars, function, user_params ):
  74     """
  75     call the named api function with params, and return the
  76     value to the caller. the authentication structure is handled
  77     automatically, and doesn't need to be passed in with params.
  78
  79     If the call fails, a BootManagerException is raised.
  80     """
  81
  82     try:
  83         api_server= vars['API_SERVER_INST']
  84     except KeyError, e:
  85         raise BootManagerException, "No connection to the API server exists."
  86
  87     auth= create_auth_structure(vars,user_params)
  88     if auth is None:
  89         raise BootManagerException, \
  90               "Could not create auth structure, missing values."
  91
  92     params= (auth,)
  93     params= params + user_params
  94
  95     try:
  96         exec( "rc= api_server.%s(*params)" % function )
  97         return rc
  98     except xmlrpclib.Fault, fault:
  99         raise BootManagerException, "API Fault: %s" % fault
 100     except xmlrpclib.ProtocolError, err:
 101         raise BootManagerException,"XML RPC protocol error: %s" % err
 102     except xml.parsers.expat.ExpatError, err:
 103         raise BootManagerException,"XML parsing error: %s" % err