1 #----------------------------------------------------------------------
2 # Copyright (c) 2008 Board of Trustees, Princeton University
4 # Permission is hereby granted, free of charge, to any person obtaining
5 # a copy of this software and/or hardware specification (the "Work") to
6 # deal in the Work without restriction, including without limitation the
7 # rights to use, copy, modify, merge, publish, distribute, sublicense,
8 # and/or sell copies of the Work, and to permit persons to whom the Work
9 # is furnished to do so, subject to the following conditions:
11 # The above copyright notice and this permission notice shall be
12 # included in all copies or substantial portions of the Work.
14 # THE WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
18 # HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 # OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS
22 #----------------------------------------------------------------------
24 # Implements SFA GID. GIDs are based on certificates, and the GID class is a
25 # descendant of the certificate class.
28 from __future__ import print_function
32 from sfa.trust.certificate import Certificate
34 from sfa.util.faults import GidInvalidParentHrn, GidParentHrn
35 from sfa.util.xrn import hrn_to_urn, urn_to_hrn, hrn_authfor_hrn
36 from sfa.util.sfalogging import logger
37 from sfa.util.py23 import xmlrpc_client
40 # Create a new uuid. Returns the UUID as a string.
44 return str(uuid.uuid4().int)
48 # (uuid, urn, public_key)
50 # UUID is a unique identifier and is created by the python uuid module
51 # (or the utility function create_uuid() in gid.py).
53 # HRN is a human readable name. It is a dotted form similar to a backward domain
54 # name. For example, planetlab.us.arizona.bakers.
56 # URN is a human readable identifier of form:
57 # "urn:publicid:IDN+toplevelauthority[:sub-auth.]*[\res. type]\ +object name"
58 # For example, urn:publicid:IDN+planetlab:us:arizona+user+bakers
60 # PUBLIC_KEY is the public key of the principal identified by the UUID/HRN.
61 # It is a Keypair object as defined in the cert.py module.
63 # It is expected that there is a one-to-one pairing between UUIDs and HRN,
64 # but it is uncertain how this would be inforced or if it needs to be enforced.
66 # These fields are encoded using xmlrpc into the subjectAltName field of the
67 # x509 certificate. Note: Call encode() once the fields have been filled in
68 # to perform this encoding.
71 class GID(Certificate):
73 # Create a new GID object
75 # @param create If true, create the X509 certificate
76 # @param subject If subject!=None, create the X509 cert and set the subject name
77 # @param string If string!=None, load the GID from a string
78 # @param filename If filename!=None, load the GID from a file
79 # @param lifeDays life of GID in days - default is 1825==5 years
80 # @param email Email address to put in subjectAltName - default is None
82 def __init__(self, create=False, subject=None, string=None, filename=None,
83 uuid=None, hrn=None, urn=None, lifeDays=1825, email=None):
87 self.email = None # for adding to the SubjectAltName
88 Certificate.__init__(self, lifeDays, create, subject, string, filename)
91 logger.debug("Creating GID for subject: %s" % subject)
96 self.urn = hrn_to_urn(hrn, 'unknown')
99 self.hrn, type = urn_to_hrn(urn)
102 logger.debug("Creating GID for subject using email: %s" % email)
103 self.set_email(email)
105 def set_uuid(self, uuid):
106 if isinstance(uuid, str):
107 self.uuid = int(uuid)
116 def set_hrn(self, hrn):
124 def set_urn(self, urn):
126 self.hrn, type = urn_to_hrn(urn)
133 # Will be stuffed into subjectAltName
134 def set_email(self, email):
145 _, t = urn_to_hrn(self.urn)
149 # Encode the GID fields and package them into the subject-alt-name field
150 # of the X509 certificate. This must be called prior to signing the
151 # certificate. It may only be called once per certificate.
157 urn = hrn_to_urn(self.hrn, None)
162 str += ", " + "URI:" + uuid.UUID(int=self.uuid).urn
165 str += ", " + "email:" + self.email
167 self.set_data(str, 'subjectAltName')
170 # Decode the subject-alt-name field of the X509 certificate into the
171 # fields of the GID. This is automatically called by the various get_*()
172 # functions in this class.
175 data = self.get_data('subjectAltName')
178 if data.lower().startswith('uri:http://<params>'):
179 dict = xmlrpc_client.loads(data[11:])[0][0]
181 spl = data.split(', ')
183 if val.lower().startswith('uri:urn:uuid:'):
184 dict['uuid'] = uuid.UUID(val[4:]).int
185 elif val.lower().startswith('uri:urn:publicid:idn+'):
186 dict['urn'] = val[4:]
187 elif val.lower().startswith('email:'):
188 # FIXME: Ensure there isn't cruft in that address...
189 # EG look for email:copy,....
190 dict['email'] = val[6:]
192 self.uuid = dict.get("uuid", None)
193 self.urn = dict.get("urn", None)
194 self.hrn = dict.get("hrn", None)
195 self.email = dict.get("email", None)
197 self.hrn = urn_to_hrn(self.urn)[0]
200 # Dump the credential to stdout.
202 # @param indent specifies a number of spaces to indent the output
203 # @param dump_parents If true, also dump the parents of the GID
205 def dump(self, *args, **kwargs):
206 print(self.dump_string(*args, **kwargs))
208 def dump_string(self, indent=0, dump_parents=False):
209 result = " " * (indent - 2) + "GID\n"
210 result += " " * indent + "hrn:" + str(self.get_hrn()) + "\n"
211 result += " " * indent + "urn:" + str(self.get_urn()) + "\n"
212 result += " " * indent + "uuid:" + str(self.get_uuid()) + "\n"
213 if self.get_email() is not None:
214 result += " " * indent + "email:" + str(self.get_email()) + "\n"
215 filename = self.get_filename()
217 result += "Filename %s\n" % filename
219 if self.parent and dump_parents:
220 result += " " * indent + "parent:\n"
221 result += self.parent.dump_string(indent + 4, dump_parents)
225 # Verify the chain of authenticity of the GID. First perform the checks
226 # of the certificate class (verifying that each parent signs the child,
227 # etc). In addition, GIDs also confirm that the parent's HRN is a prefix
228 # of the child's HRN, and the parent is of type 'authority'.
230 # Verifying these prefixes prevents a rogue authority from signing a GID
231 # for a principal that is not a member of that authority. For example,
232 # planetlab.us.arizona cannot sign a GID for planetlab.us.princeton.foo.
234 def verify_chain(self, trusted_certs=None):
235 logger.debug("GID.verify_chain with {} trusted certs".format(len(trusted_certs)))
236 # do the normal certificate verification stuff
237 trusted_root = Certificate.verify_chain(self, trusted_certs)
240 # make sure the parent's hrn is a prefix of the child's hrn
241 if not hrn_authfor_hrn(self.parent.get_hrn(), self.get_hrn()):
243 "This cert HRN {} isn't in the namespace for parent HRN {}"
244 .format(self.get_hrn(), self.parent.get_hrn()))
246 # Parent must also be an authority (of some type) to sign a GID
247 # There are multiple types of authority - accept them all here
248 if not self.parent.get_type().find('authority') == 0:
249 raise GidInvalidParentHrn(
250 "This cert {}'s parent {} is not an authority (is a %{})"
251 .format(self.get_hrn(), self.parent.get_hrn(), self.parent.get_type()))
253 # Then recurse up the chain - ensure the parent is a trusted
254 # root or is in the namespace of a trusted root
255 self.parent.verify_chain(trusted_certs)
257 # make sure that the trusted root's hrn is a prefix of the child's
258 trusted_gid = GID(string=trusted_root.save_to_string())
259 trusted_type = trusted_gid.get_type()
260 trusted_hrn = trusted_gid.get_hrn()
261 # if trusted_type == 'authority':
262 # trusted_hrn = trusted_hrn[:trusted_hrn.rindex('.')]
263 cur_hrn = self.get_hrn()
264 if not hrn_authfor_hrn(trusted_hrn, cur_hrn):
266 "Trusted root with HRN {} isn't a namespace authority for this cert: {}"
267 .format(trusted_hrn, cur_hrn))
269 # There are multiple types of authority - accept them all here
270 if not trusted_type.find('authority') == 0:
271 raise GidInvalidParentHrn(
272 "This cert {}'s trusted root signer {} is not an authority (is a {})"
273 .format(self.get_hrn(), trusted_hrn, trusted_type))