2 # This module implements the client-side of the Geni API. Stubs are provided
3 # that convert the supplied parameters to the necessary format and send them
4 # via XMLRPC to a Geni Server.
6 # TODO: Investigate ways to combine this with existing PLC API?
12 from credential import *
14 from geniticket import *
17 # ServerException, ExceptionUnmarshaller
19 # Used to convert server exception strings back to an exception.
20 # from usenet, Raghuram Devarakonda
22 class ServerException(Exception):
25 class ExceptionUnmarshaller(xmlrpclib.Unmarshaller):
28 return xmlrpclib.Unmarshaller.close(self)
29 except xmlrpclib.Fault, e:
30 raise ServerException(e.faultString)
35 # A transport for XMLRPC that works on top of HTTPS
37 class GeniTransport(xmlrpclib.Transport):
40 def make_connection(self, host):
41 # create a HTTPS connection object from a host descriptor
42 # host may be a string, or a (host, x509-dict) tuple
44 host, extra_headers, x509 = self.get_host_info(host)
46 HTTPS = httplib.HTTPS()
47 except AttributeError:
48 raise NotImplementedError(
49 "your version of httplib doesn't support HTTPS"
52 return httplib.HTTPS(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
55 unmarshaller = ExceptionUnmarshaller()
56 parser = xmlrpclib.ExpatParser(unmarshaller)
57 return parser, unmarshaller
60 # The GeniClient class provides stubs for executing Geni operations. A given
61 # client object connects to one server. To connect to multiple servers, create
62 # multiple GeniClient objects.
64 # The Geni protocol uses an HTTPS connection, and the client's side of the
65 # connection uses his private key. Generally, this private key must match the
66 # public key that is containing in the GID that the client is providing for
67 # those functions that take a GID.
71 # Create a new GeniClient object.
73 # @param url is the url of the server
74 # @param key_file = private key file of client
75 # @param cert_file = x.509 cert containing the client's public key. This
76 # could be a GID certificate, or any x.509 cert.
78 def __init__(self, url, key_file, cert_file):
80 self.key_file = key_file
81 self.cert_file = cert_file
82 self.transport = GeniTransport()
83 self.transport.key_file = self.key_file
84 self.transport.cert_file = self.cert_file
85 self.server = xmlrpclib.ServerProxy(self.url, self.transport, allow_none=True)
87 # -------------------------------------------------------------------------
89 # -------------------------------------------------------------------------
92 # Create a new GID. For MAs and SAs that are physically located on the
93 # registry, this allows a owner/operator/PI to create a new GID and have it
94 # signed by his respective authority.
96 # @param cred credential of caller
97 # @param name hrn for new GID
98 # @param uuid unique identifier for new GID
99 # @param pkey_string public-key string (TODO: why is this a string and not a keypair object?)
101 # @return a GID object
103 def create_gid(self, cred, name, uuid, pkey_string):
104 gid_str = self.server.create_gid(cred.save_to_string(save_parents=True), name, uuid, pkey_string)
105 return GID(string=gid_str)
108 # Retrieve the GID for an object. This function looks up a record in the
109 # registry and returns the GID of the record if it exists.
110 # TODO: Is this function needed? It's a shortcut for Resolve()
112 # @param name hrn to look up
114 # @return a GID object
116 def get_gid(self, name):
117 gid_str_list = self.server.get_gid(name)
119 for str in gid_str_list:
120 gid_list.append(GID(string=str))
124 # Get_self_credential a degenerate version of get_credential used by a
125 # client to get his initial credential when he doesn't have one. This is
126 # the same as get_credential(..., cred=None,...).
128 # The registry ensures that the client is the principal that is named by
129 # (type, name) by comparing the public key in the record's GID to the
130 # private key used to encrypt the client-side of the HTTPS connection. Thus
131 # it is impossible for one principal to retrieve another principal's
132 # credential without having the appropriate private key.
134 # @param type type of object (user | slice | sa | ma | node
135 # @param name human readable name of object
137 # @return a credential object
139 def get_self_credential(self, type, name):
140 cred_str = self.server.get_self_credential(type, name)
141 return Credential(string = cred_str)
144 # Retrieve a credential for an object.
146 # If cred==None, then the behavior reverts to get_self_credential()
148 # @param cred credential object specifying rights of the caller
149 # @param type type of object (user | slice | sa | ma | node)
150 # @param name human readable name of object
152 # @return a credental object
154 def get_credential(self, cred, type, name):
156 cred = cred.save_to_string(save_parents=True)
157 cred_str = self.server.get_credential(cred, type, name)
158 return Credential(string = cred_str)
161 # List the records in an authority. The objectGID in the supplied credential
162 # should name the authority that will be listed.
164 # @param cred credential object specifying rights of the caller
166 # @return list of record objects
168 def list(self, cred, auth_hrn):
169 result_dict_list = self.server.list(cred.save_to_string(save_parents=True), auth_hrn)
171 for dict in result_dict_list:
172 result_rec_list.append(GeniRecord(dict=dict))
173 return result_rec_list
176 # Register an object with the registry. In addition to being stored in the
177 # Geni database, the appropriate records will also be created in the
182 # @param cred credential object specifying rights of the caller
183 # @return record to register
185 # @return GID object for the newly-registered record
187 def register(self, cred, record):
188 gid_str = self.server.register(cred.save_to_string(save_parents=True), record.as_dict())
189 return GID(string = gid_str)
192 # Remove an object from the registry. If the object represents a PLC object,
193 # then the PLC records will also be removed.
195 # @param cred credential object specifying rights of the caller
199 def remove(self, cred, type, hrn):
200 result = self.server.remove(cred.save_to_string(save_parents=True), type, hrn)
204 # Resolve an object in the registry. A given HRN may have multiple records
205 # associated with it, and therefore multiple records may be returned. The
206 # caller should check the type fields of the records to find the one that
207 # he is interested in.
209 # @param cred credential object specifying rights of the caller
210 # @param name human readable name of object
212 def resolve(self, cred, name):
213 result_dict_list = self.server.resolve(cred.save_to_string(save_parents=True), name)
215 for dict in result_dict_list:
216 if dict['type'] in ['authority']:
217 result_rec_list.append(AuthorityRecord(dict=dict))
218 elif dict['type'] in ['node']:
219 result_rec_list.append(NodeRecord(dict=dict))
220 elif dict['type'] in ['slice']:
221 result_rec_list.append(SliceRecord(dict=dict))
222 elif dict['type'] in ['user']:
223 result_rec_list.append(UserRecord(dict=dict))
225 result_rec_list.append(GeniRecord(dict=dict))
226 return result_rec_list
229 # Update an object in the registry. Currently, this only updates the
230 # PLC information associated with the record. The Geni fields (name, type,
235 # @param cred credential object specifying rights of the caller
236 # @param record a record object to be updated
238 def update(self, cred, record):
239 result = self.server.update(cred.save_to_string(save_parents=True), record.as_dict())
243 #-------------------------------------------------------------------------
244 # Aggregate Interface
245 #-------------------------------------------------------------------------
249 # @param cred a credential
250 # @param hrn slice hrn
252 def get_resources(self, cred, hrn=None):
253 result = self.server.get_resources(cred.save_to_string(save_parents=True), hrn)
256 def get_aggregates(self, cred, hrn=None):
257 result = self.server.get_resources(cred.save_to_string(save_parents=True), hrn)
262 # @param cred a credential
264 def get_policy(self, cred):
265 result = self.server.get_policy(cred.save_to_string(save_parents=True))
270 # @param cred a credential
271 # @param rspec resource specification defining how to instantiate the slice
273 def create_slice(self, cred, hrn, rspec):
274 result = self.server.create_slice(cred.save_to_string(save_parents=True), hrn, rspec)
280 # @param cred a credential
281 # @param hrn slice to delete
282 def delete_slice(self, cred, hrn):
283 result = self.server.delete_slice(cred.save_to_string(save_parents=True), hrn)
286 # ------------------------------------------------------------------------
288 # ------------------------------------------------------------------------
293 # @param cred a credential identifying the caller (callerGID) and the slice
296 def start_slice(self, cred, hrn):
297 result = self.server.start_slice(cred.save_to_string(save_parents=True), hrn)
303 # @param cred a credential identifying the caller (callerGID) and the slice
306 def stop_slice(self, cred, hrn):
307 result = self.server.stop_slice(cred.save_to_string(save_parents=True), hrn)
313 # @param cred a credential identifying the caller (callerGID) and the slice
316 def reset_slice(self, cred, hrn):
317 result = self.server.reset_slice(cred.save_to_string(save_parents=True), hrn)
323 # @param cred a credential identifying the caller (callerGID) and the slice
326 def delete_slice(self, cred, hrn):
327 result = self.server.delete_slice(cred.save_to_string(save_parents=True), hrn)
331 # List the slices on a component.
333 # @param cred credential object that authorizes the caller
335 # @return a list of slice names
337 def get_slices(self, cred):
338 result = self.server.get_slices(cred.save_to_string(save_parents=True))
342 # Retrieve a ticket. This operation is currently implemented on the
343 # registry (see SFA, engineering decisions), and is not implemented on
346 # The ticket is filled in with information from the PLC database. This
347 # information includes resources, and attributes such as user keys and
350 # @param cred credential object
351 # @param name name of the slice to retrieve a ticket for
352 # @param rspec resource specification dictionary
354 # @return a ticket object
356 def get_ticket(self, cred, name, rspec):
357 ticket_str = self.server.get_ticket(cred.save_to_string(save_parents=True), name, rspec)
358 ticket = Ticket(string=ticket_str)
362 # Redeem a ticket. This operation is currently implemented on the
365 # The ticket is submitted to the node manager, and the slice is instantiated
366 # or updated as appropriate.
368 # TODO: This operation should return a sliver credential and indicate
369 # whether or not the component will accept only sliver credentials, or
370 # will accept both sliver and slice credentials.
372 # @param ticket a ticket object containing the ticket
374 def redeem_ticket(self, ticket):
375 result = self.server.redeem_ticket(ticket.save_to_string(save_parents=True))