2 ### $Id: interface.py 17583 2010-04-06 15:01:08Z tmack $
3 ### $URL: https://svn.planet-lab.org/svn/sfa/trunk/sfa/server/interface.py $
6 from sfa.util.faults import *
7 from sfa.util.storage import *
8 from sfa.util.namespace import *
9 from sfa.trust.gid import GID
10 from sfa.util.table import SfaTable
11 from sfa.util.record import SfaRecord
13 import sfa.util.xmlrpcprotocol as xmlrpcprotocol
14 import sfa.util.soapprotocol as soapprotocol
17 # GeniLight client support is optional
19 from egeni.geniLight_client import *
21 GeniClientLight = None
25 # In is a dictionary of registry connections keyed on the registry
28 class Interfaces(dict):
30 Interfaces is a base class for managing information on the
31 peers we are federated with. It is responsible for the following:
33 1) Makes sure a record exist in the local registry for the each
35 2) Attepts to fetch and install trusted gids
36 3) Provides connections (xmlrpc or soap) to federated peers
39 # fields that must be specified in the config file
46 # defined by the class
51 def __init__(self, api, conf_file, type='authority'):
52 if type not in self.types:
53 raise SfaInfaildArgument('Invalid type %s: must be in %s' % (type, self.types))
54 dict.__init__(self, {})
58 self.interface_info = XmlStorage(conf_file, self.default_dict)
59 self.interface_info.load()
60 interfaces = self.interface_info.values()[0].values()[0]
61 if not isinstance(interfaces, list):
62 interfaces = [self.interfaces]
64 for interface in interfaces:
65 self.interfaces[interface['hrn']] = interface
68 def sync_interfaces(self):
70 Install missing trusted gids and db records for our federated
73 # Attempt to get any missing peer gids
74 # There should be a gid file in /etc/sfa/trusted_roots for every
75 # peer registry found in in the registries.xml config file. If there
76 # are any missing gids, request a new one from the peer registry.
77 gids_current = self.api.auth.trusted_cert_list
78 hrns_current = [gid.get_hrn() for gid in gids_current]
79 hrns_expected = self.interfaces.keys()
80 new_hrns = set(hrns_expected).difference(hrns_current)
81 gids = self.get_peer_gids(new_hrns)
82 # update the local db records for these registries
83 self.update_db_records(self.type, gids)
85 def get_peer_gids(self, new_hrns):
87 Install trusted gids from the specified interfaces.
92 trusted_certs_dir = self.api.config.get_trustedroots_dir()
93 for new_hrn in new_hrns:
94 # the gid for this interface should already be installed
95 if new_hrn == self.api.config.SFA_INTERFACE_HRN:
98 # get gid from the registry
99 interface_info = self.interfaces[new_hrn]
100 interface = self[new_hrn]
101 trusted_gids = interface.get_trusted_certs()
103 # the gid we want shoudl be the first one in the list,
105 for trusted_gid in trusted_gids:
107 message = "interface: %s\t" % (self.api.interface)
108 message += "unable to install trusted gid for %s" % \
110 gid = GID(string=trusted_gids[0])
111 peer_gids.append(gid)
112 if gid.get_hrn() == new_hrn:
113 gid_filename = os.path.join(trusted_certs_dir, '%s.gid' % new_hrn)
114 gid.save_to_file(gid_filename, save_parents=True)
115 message = "interface: %s\tinstalled trusted gid for %s" % \
116 (self.api.interface, new_hrn)
118 self.api.logger.info(message)
120 message = "interface: %s\tunable to install trusted gid for %s" % \
121 (self.api.interface, new_hrn)
122 self.api.logger.info(message)
123 traceback.print_exc()
125 # reload the trusted certs list
126 self.api.auth.load_trusted_certs()
129 def update_db_records(self, type, gids):
131 Make sure there is a record in the local db for allowed registries
132 defined in the config file (registries.xml). Removes old records from
137 # get hrns we expect to find
138 # ignore records for local interfaces
139 ignore_interfaces = [self.api.config.SFA_INTERFACE_HRN]
140 hrns_expected = [gid.get_hrn() for gid in gids \
141 if gid.get_hrn() not in ignore_interfaces]
143 # get hrns that actually exist in the db
145 records = table.find({'type': type})
146 hrns_found = [record['hrn'] for record in records]
149 for record in records:
150 if record['hrn'] not in hrns_expected:
156 if hrn not in hrns_found:
161 'authority': get_authority(hrn),
162 'gid': gid.save_to_string(save_parents=True),
164 record = SfaRecord(dict=record)
167 def get_connections(self):
169 read connection details for the trusted peer registries from file return
170 a dictionary of connections keyed on interface hrn.
173 required_fields = self.default_fields.keys()
174 for interface in self.interfaces.values():
175 # make sure the required fields are present and not null
176 if not all([interface.get(key) for key in required_fields]):
179 hrn, address, port = interface['hrn'], interface['addr'], interface['port']
180 url = 'http://%(address)s:%(port)s' % locals()
181 # check which client we should use
182 # sfa.util.xmlrpcprotocol is default
183 client_type = 'xmlrpcprotocol'
184 if interface.has_key('client') and \
185 interface['client'] in ['geniclientlight'] and \
187 client_type = 'geniclientlight'
188 connections[hrn] = GeniClientLight(url, self.api.key_file, self.api.cert_file)
190 connections[hrn] = xmlrpcprotocol.get_server(url, self.api.key_file, self.api.cert_file)