2 # This module implements a hierarchy of authorities and performs a similar
3 # function as the "tree" module of the original SFA prototype. An HRN
4 # is assumed to be a string of authorities separated by dots. For example,
5 # "planetlab.us.arizona.bakers". Each component of the HRN is a different
6 # authority, with the last component being a leaf in the tree.
8 # Each authority is stored in a subdirectory on the registry. Inside this
9 # subdirectory are several files:
11 # *.PKEY - private key file
16 from sfa.util.faults import MissingAuthority
17 from sfa.util.sfalogging import logger
18 from sfa.util.xrn import get_leaf, get_authority, hrn_to_urn, urn_to_hrn
19 from sfa.trust.certificate import Keypair
20 from sfa.trust.credential import Credential
21 from sfa.trust.gid import GID, create_uuid
22 from sfa.util.config import Config
23 from sfa.trust.sfaticket import SfaTicket
26 # The AuthInfo class contains the information for an authority. This information
27 # includes the GID, private key, and database connection information.
34 privkey_filename = None
36 # Initialize and authority object.
38 # @param xrn the human readable name of the authority (urn will be converted to hrn)
39 # @param gid_filename the filename containing the GID
40 # @param privkey_filename the filename containing the private key
42 def __init__(self, xrn, gid_filename, privkey_filename):
43 hrn, type = urn_to_hrn(xrn)
45 self.set_gid_filename(gid_filename)
46 self.privkey_filename = privkey_filename
49 # Set the filename of the GID
51 # @param fn filename of file containing GID
53 def set_gid_filename(self, fn):
54 self.gid_filename = fn
55 self.gid_object = None
57 def get_privkey_filename(self):
58 return self.privkey_filename
60 def get_gid_filename(self):
61 return self.gid_filename
64 # Get the GID in the form of a GID object
66 def get_gid_object(self):
67 if not self.gid_object:
68 self.gid_object = GID(filename=self.gid_filename)
69 return self.gid_object
72 # Get the private key in the form of a Keypair object
74 def get_pkey_object(self):
75 return Keypair(filename=self.privkey_filename)
78 # Replace the GID with a new one. The file specified by gid_filename is
79 # overwritten with the new GID object
81 # @param gid object containing new GID
83 def update_gid_object(self, gid):
84 gid.save_to_file(self.gid_filename)
88 # The Hierarchy class is responsible for managing the tree of authorities.
89 # Each authority is a node in the tree and exists as an AuthInfo object.
91 # The tree is stored on disk in a hierarchical manner than reflects the
92 # structure of the tree. Each authority is a subdirectory, and each subdirectory
93 # contains the GID and pkey files for that authority (as well as
94 # subdirectories for each sub-authority)
99 # Create the hierarchy object.
101 # @param basedir the base directory to store the hierarchy in
103 def __init__(self, basedir=None):
104 self.config = Config()
106 basedir = os.path.join(self.config.SFA_DATA_DIR, "authorities")
107 self.basedir = basedir
109 # Given a hrn, return the filenames of the GID, private key
112 # @param xrn the human readable name of the authority (urn will be convertd to hrn)
114 def get_auth_filenames(self, xrn):
115 hrn, type = urn_to_hrn(xrn)
117 hrn = hrn.replace('\\', '')
121 parent_hrn = get_authority(hrn)
122 directory = os.path.join(self.basedir, hrn.replace(".", "/"))
124 gid_filename = os.path.join(directory, leaf + ".gid")
125 privkey_filename = os.path.join(directory, leaf + ".pkey")
127 return (directory, gid_filename, privkey_filename)
130 # Check to see if an authority exists. An authority exists if it's disk
133 # @param the human readable name of the authority to check
135 def auth_exists(self, xrn):
136 hrn, type = urn_to_hrn(xrn)
137 (directory, gid_filename, privkey_filename) = \
138 self.get_auth_filenames(hrn)
140 return os.path.exists(gid_filename) and os.path.exists(privkey_filename)
143 # Create an authority. A private key for the authority and the associated
144 # GID are created and signed by the parent authority.
146 # @param xrn the human readable name of the authority to create (urn will be converted to hrn)
147 # @param create_parents if true, also create the parents if they do not exist
149 def create_auth(self, xrn, create_parents=False):
150 hrn, type = urn_to_hrn(str(xrn))
151 logger.debug("Hierarchy: creating authority: %s" % hrn)
153 # create the parent authority if necessary
154 parent_hrn = get_authority(hrn)
155 parent_urn = hrn_to_urn(parent_hrn, 'authority')
156 if (parent_hrn) and (not self.auth_exists(parent_urn)) and (create_parents):
157 self.create_auth(parent_urn, create_parents)
158 directory, gid_filename, privkey_filename = self.get_auth_filenames(
161 # create the directory to hold the files
163 os.makedirs(directory)
164 # if the path already exists then pass
165 except OSError as xxx_todo_changeme:
166 (errno, strerr) = xxx_todo_changeme.args
170 if os.path.exists(privkey_filename):
171 logger.debug("using existing key %r for authority %r"
172 % (privkey_filename, hrn))
173 pkey = Keypair(filename=privkey_filename)
175 pkey = Keypair(create=True)
176 pkey.save_to_file(privkey_filename)
178 gid = self.create_gid(xrn, create_uuid(), pkey)
179 gid.save_to_file(gid_filename, save_parents=True)
182 def create_top_level_auth(self, hrn=None):
184 Create top level records (includes root and sub authorities (local/remote)
186 # create the authority if it doesnt alrady exist
187 if not self.auth_exists(hrn):
188 self.create_auth(hrn, create_parents=True)
190 def get_interface_auth_info(self, create=True):
191 hrn = self.config.SFA_INTERFACE_HRN
192 if not self.auth_exists(hrn):
194 self.create_top_level_auth(hrn)
196 raise MissingAuthority(hrn)
197 return self.get_auth_info(hrn)
199 # Return the AuthInfo object for the specified authority. If the authority
200 # does not exist, then an exception is thrown. As a side effect, disk files
201 # and a subdirectory may be created to store the authority.
203 # @param xrn the human readable name of the authority to create (urn will be converted to hrn).
205 def get_auth_info(self, xrn):
206 hrn, type = urn_to_hrn(xrn)
207 if not self.auth_exists(hrn):
209 "Hierarchy: missing authority - xrn=%s, hrn=%s" % (xrn, hrn))
210 raise MissingAuthority(hrn)
212 (directory, gid_filename, privkey_filename, ) = \
213 self.get_auth_filenames(hrn)
215 auth_info = AuthInfo(hrn, gid_filename, privkey_filename)
217 # check the GID and see if it needs to be refreshed
218 gid = auth_info.get_gid_object()
219 gid_refreshed = self.refresh_gid(gid)
220 if gid != gid_refreshed:
221 auth_info.update_gid_object(gid_refreshed)
226 # Create a new GID. The GID will be signed by the authority that is it's
227 # immediate parent in the hierarchy (and recursively, the parents' GID
228 # will be signed by its parent)
230 # @param hrn the human readable name to store in the GID
231 # @param uuid the unique identifier to store in the GID
232 # @param pkey the public key to store in the GID
234 def create_gid(self, xrn, uuid, pkey, CA=False, email=None, force_parent=None):
235 hrn, type = urn_to_hrn(xrn)
238 parent_hrn = force_parent if force_parent else get_authority(hrn)
239 # Using hrn_to_urn() here to make sure the urn is in the right format
240 # If xrn was a hrn instead of a urn, then the gid's urn will be
242 urn = hrn_to_urn(hrn, type)
243 gid = GID(subject=hrn, uuid=uuid, hrn=hrn, urn=urn, email=email)
245 if hrn == self.config.SFA_INTERFACE_HRN or not parent_hrn:
246 # root or sub authority
247 gid.set_intermediate_ca(True)
248 elif type and 'authority' in type:
250 gid.set_intermediate_ca(True)
252 gid.set_intermediate_ca(True)
254 gid.set_intermediate_ca(False)
257 if not parent_hrn or hrn == self.config.SFA_INTERFACE_HRN:
258 # if there is no parent hrn, then it must be self-signed. this
259 # is where we terminate the recursion
260 gid.set_issuer(pkey, hrn)
262 # we need the parent's private key in order to sign this GID
263 parent_auth_info = self.get_auth_info(parent_hrn)
264 gid.set_issuer(parent_auth_info.get_pkey_object(),
265 parent_auth_info.hrn)
266 gid.set_parent(parent_auth_info.get_gid_object())
275 # Refresh a GID. The primary use of this function is to refresh the
276 # the expiration time of the GID. It may also be used to change the HRN,
277 # UUID, or Public key of the GID.
279 # @param gid the GID to refresh
280 # @param hrn if !=None, change the hrn
281 # @param uuid if !=None, change the uuid
282 # @param pubkey if !=None, change the public key
284 def refresh_gid(self, gid, xrn=None, uuid=None, pubkey=None):
285 # TODO: compute expiration time of GID, refresh it if necessary
286 gid_is_expired = False
288 # update the gid if we need to
289 if gid_is_expired or xrn or uuid or pubkey:
294 uuid = gid.get_uuid()
296 pubkey = gid.get_pubkey()
298 gid = self.create_gid(xrn, uuid, pubkey)
303 # Retrieve an authority credential for an authority. The authority
304 # credential will contain the authority privilege and will be signed by
305 # the authority's parent.
307 # @param hrn the human readable name of the authority (urn is converted to hrn)
308 # @param authority type of credential to return (authority | sa | ma)
310 def get_auth_cred(self, xrn, kind="authority"):
311 hrn, type = urn_to_hrn(xrn)
312 auth_info = self.get_auth_info(hrn)
313 gid = auth_info.get_gid_object()
315 cred = Credential(subject=hrn)
316 cred.set_gid_caller(gid)
317 cred.set_gid_object(gid)
318 cred.set_privileges(kind)
319 cred.get_privileges().delegate_all_privileges(True)
320 # cred.set_pubkey(auth_info.get_gid_object().get_pubkey())
322 parent_hrn = get_authority(hrn)
323 if not parent_hrn or hrn == self.config.SFA_INTERFACE_HRN:
324 # if there is no parent hrn, then it must be self-signed. this
325 # is where we terminate the recursion
326 cred.set_issuer_keys(
327 auth_info.get_privkey_filename(), auth_info.get_gid_filename())
329 # we need the parent's private key in order to sign this GID
330 parent_auth_info = self.get_auth_info(parent_hrn)
331 cred.set_issuer_keys(parent_auth_info.get_privkey_filename(
332 ), parent_auth_info.get_gid_filename())
334 cred.set_parent(self.get_auth_cred(parent_hrn, kind))
341 # Retrieve an authority ticket. An authority ticket is not actually a
342 # redeemable ticket, but only serves the purpose of being included as the
343 # parent of another ticket, in order to provide a chain of authentication
346 # This looks almost the same as get_auth_cred, but works for tickets
347 # XXX does similarity imply there should be more code re-use?
349 # @param xrn the human readable name of the authority (urn is converted to hrn)
351 def get_auth_ticket(self, xrn):
352 hrn, type = urn_to_hrn(xrn)
353 auth_info = self.get_auth_info(hrn)
354 gid = auth_info.get_gid_object()
356 ticket = SfaTicket(subject=hrn)
357 ticket.set_gid_caller(gid)
358 ticket.set_gid_object(gid)
359 ticket.set_delegate(True)
360 ticket.set_pubkey(auth_info.get_gid_object().get_pubkey())
362 parent_hrn = get_authority(hrn)
364 # if there is no parent hrn, then it must be self-signed. this
365 # is where we terminate the recursion
366 ticket.set_issuer(auth_info.get_pkey_object(), hrn)
368 # we need the parent's private key in order to sign this GID
369 parent_auth_info = self.get_auth_info(parent_hrn)
371 parent_auth_info.get_pkey_object(), parent_auth_info.hrn)
372 ticket.set_parent(self.get_auth_cred(parent_hrn))