sfa/trust/hierarchy.py

   1 ##
   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.
   7 #
   8 # Each authority is stored in a subdirectory on the registry. Inside this
   9 # subdirectory are several files:
  10 #      *.GID - GID file
  11 #      *.PKEY - private key file
  12 #      *.DBINFO - database info
  13 ##
  14
  15 ### $Id$
  16 ### $URL$
  17
  18 import os
  19
  20 from sfa.util.report import *
  21 from sfa.trust.certificate import Keypair
  22 from sfa.trust.credential import *
  23 from sfa.trust.gid import GID, create_uuid
  24 from sfa.util.namespace import *
  25 from sfa.util.config import Config
  26 from sfa.util.sfaticket import SfaTicket
  27
  28 ##
  29 # The AuthInfo class contains the information for an authority. This information
  30 # includes the GID, private key, and database connection information.
  31
  32 class AuthInfo:
  33     hrn = None
  34     gid_object = None
  35     gid_filename = None
  36     privkey_filename = None
  37     dbinfo_filename = None
  38
  39     ##
  40     # Initialize and authority object.
  41     #
  42     # @param xrn the human readable name of the authority (urn will be converted to hrn)
  43     # @param gid_filename the filename containing the GID
  44     # @param privkey_filename the filename containing the private key
  45     # @param dbinfo_filename the filename containing the database info
  46
  47     def __init__(self, xrn, gid_filename, privkey_filename, dbinfo_filename):
  48         hrn, type = urn_to_hrn(xrn)
  49         self.hrn = hrn
  50         self.set_gid_filename(gid_filename)
  51         self.privkey_filename = privkey_filename
  52         self.dbinfo_filename = dbinfo_filename
  53
  54     ##
  55     # Set the filename of the GID
  56     #
  57     # @param fn filename of file containing GID
  58
  59     def set_gid_filename(self, fn):
  60         self.gid_filename = fn
  61         self.gid_object = None
  62
  63     def get_privkey_filename(self):
  64         return self.privkey_filename
  65
  66     def get_gid_filename(self):
  67         return self.gid_filename
  68
  69     ##
  70     # Get the GID in the form of a GID object
  71
  72     def get_gid_object(self):
  73         if not self.gid_object:
  74             self.gid_object = GID(filename = self.gid_filename)
  75         return self.gid_object
  76
  77     ##
  78     # Get the private key in the form of a Keypair object
  79
  80     def get_pkey_object(self):
  81         return Keypair(filename = self.privkey_filename)
  82
  83     ##
  84     # Get the dbinfo in the form of a dictionary
  85
  86     def get_dbinfo(self):
  87         f = file(self.dbinfo_filename)
  88         dict = eval(f.read())
  89         f.close()
  90         return dict
  91
  92     ##
  93     # Replace the GID with a new one. The file specified by gid_filename is
  94     # overwritten with the new GID object
  95     #
  96     # @param gid object containing new GID
  97
  98     def update_gid_object(self, gid):
  99         gid.save_to_file(self.gid_filename)
 100         self.gid_object = gid
 101
 102 ##
 103 # The Hierarchy class is responsible for managing the tree of authorities.
 104 # Each authority is a node in the tree and exists as an AuthInfo object.
 105 #
 106 # The tree is stored on disk in a hierarchical manner than reflects the
 107 # structure of the tree. Each authority is a subdirectory, and each subdirectory
 108 # contains the GID, pkey, and dbinfo files for that authority (as well as
 109 # subdirectories for each sub-authority)
 110
 111 class Hierarchy:
 112     ##
 113     # Create the hierarchy object.
 114     #
 115     # @param basedir the base directory to store the hierarchy in
 116
 117     def __init__(self, basedir = None):
 118         if not basedir:
 119             self.config = Config()
 120             basedir = os.path.join(self.config.SFA_DATA_DIR, "authorities")
 121         self.basedir = basedir
 122     ##
 123     # Given a hrn, return the filenames of the GID, private key, and dbinfo
 124     # files.
 125     #
 126     # @param xrn the human readable name of the authority (urn will be convertd to hrn)
 127
 128     def get_auth_filenames(self, xrn):
 129         hrn, type = urn_to_hrn(xrn)
 130         leaf = get_leaf(hrn)
 131         parent_hrn = get_authority(hrn)
 132         directory = os.path.join(self.basedir, hrn.replace(".", "/"))
 133
 134         gid_filename = os.path.join(directory, leaf+".gid")
 135         privkey_filename = os.path.join(directory, leaf+".pkey")
 136         dbinfo_filename = os.path.join(directory, leaf+".dbinfo")
 137
 138         return (directory, gid_filename, privkey_filename, dbinfo_filename)
 139
 140     ##
 141     # Check to see if an authority exists. An authority exists if it's disk
 142     # files exist.
 143     #
 144     # @param the human readable name of the authority to check
 145
 146     def auth_exists(self, xrn):
 147         hrn, type = urn_to_hrn(xrn)
 148         (directory, gid_filename, privkey_filename, dbinfo_filename) = \
 149             self.get_auth_filenames(hrn)
 150
 151         return os.path.exists(gid_filename) and \
 152                os.path.exists(privkey_filename) and \
 153                os.path.exists(dbinfo_filename)
 154
 155     ##
 156     # Create an authority. A private key for the authority and the associated
 157     # GID are created and signed by the parent authority.
 158     #
 159     # @param xrn the human readable name of the authority to create (urn will be converted to hrn)
 160     # @param create_parents if true, also create the parents if they do not exist
 161
 162     def create_auth(self, xrn, create_parents=False):
 163         hrn, type = urn_to_hrn(xrn)
 164         trace("Hierarchy: creating authority: " + hrn)
 165
 166         # create the parent authority if necessary
 167         parent_hrn = get_authority(hrn)
 168         parent_urn = hrn_to_urn(parent_hrn, 'authority')
 169         if (parent_hrn) and (not self.auth_exists(parent_urn)) and (create_parents):
 170             self.create_auth(parent_urn, create_parents)
 171
 172         (directory, gid_filename, privkey_filename, dbinfo_filename) = \
 173             self.get_auth_filenames(hrn)
 174
 175         # create the directory to hold the files
 176         try:
 177             os.makedirs(directory)
 178         # if the path already exists then pass
 179         except OSError, (errno, strerr):
 180             if errno == 17:
 181                 pass
 182
 183         if os.path.exists(privkey_filename):
 184             print "using existing key", privkey_filename, "for authority", hrn
 185             pkey = Keypair(filename = privkey_filename)
 186         else:
 187             pkey = Keypair(create = True)
 188             pkey.save_to_file(privkey_filename)
 189
 190         gid = self.create_gid(xrn, create_uuid(), pkey)
 191         gid.save_to_file(gid_filename, save_parents=True)
 192
 193         # XXX TODO: think up a better way for the dbinfo to work
 194
 195         dbinfo = Config().get_plc_dbinfo()
 196         dbinfo_file = file(dbinfo_filename, "w")
 197         dbinfo_file.write(str(dbinfo))
 198         dbinfo_file.close()
 199
 200     ##
 201     # Return the AuthInfo object for the specified authority. If the authority
 202     # does not exist, then an exception is thrown. As a side effect, disk files
 203     # and a subdirectory may be created to store the authority.
 204     #
 205     # @param xrn the human readable name of the authority to create (urn will be converted to hrn).
 206
 207     def get_auth_info(self, xrn):
 208
 209         #trace("Hierarchy: getting authority: " + hrn)
 210         hrn, type = urn_to_hrn(xrn)
 211         if not self.auth_exists(hrn):
 212             raise MissingAuthority(hrn)
 213
 214         (directory, gid_filename, privkey_filename, dbinfo_filename) = \
 215             self.get_auth_filenames(hrn)
 216
 217         auth_info = AuthInfo(hrn, gid_filename, privkey_filename, dbinfo_filename)
 218
 219         # check the GID and see if it needs to be refreshed
 220         gid = auth_info.get_gid_object()
 221         gid_refreshed = self.refresh_gid(gid)
 222         if gid != gid_refreshed:
 223             auth_info.update_gid_object(gid_refreshed)
 224
 225         return auth_info
 226
 227     ##
 228     # Create a new GID. The GID will be signed by the authority that is it's
 229     # immediate parent in the hierarchy (and recursively, the parents' GID
 230     # will be signed by its parent)
 231     #
 232     # @param hrn the human readable name to store in the GID
 233     # @param uuid the unique identifier to store in the GID
 234     # @param pkey the public key to store in the GID
 235
 236     def create_gid(self, xrn, uuid, pkey):
 237         hrn, type = urn_to_hrn(xrn)
 238         # Using hrn_to_urn() here to make sure the urn is in the right format
 239         # If xrn was a hrn instead of a urn, then the gid's urn will be
 240         # of type None
 241         urn = hrn_to_urn(hrn, type)
 242         gid = GID(subject=hrn, uuid=uuid, hrn=hrn, urn=urn)
 243
 244         parent_hrn = get_authority(hrn)
 245         if not parent_hrn or hrn == self.config.SFA_INTERFACE_HRN:
 246             # if there is no parent hrn, then it must be self-signed. this
 247             # is where we terminate the recursion
 248             gid.set_issuer(pkey, hrn)
 249         else:
 250             # we need the parent's private key in order to sign this GID
 251             parent_auth_info = self.get_auth_info(parent_hrn)
 252             gid.set_issuer(parent_auth_info.get_pkey_object(), parent_auth_info.hrn)
 253             gid.set_parent(parent_auth_info.get_gid_object())
 254
 255         gid.set_pubkey(pkey)
 256         gid.encode()
 257         gid.sign()
 258
 259         return gid
 260
 261     ##
 262     # Refresh a GID. The primary use of this function is to refresh the
 263     # the expiration time of the GID. It may also be used to change the HRN,
 264     # UUID, or Public key of the GID.
 265     #
 266     # @param gid the GID to refresh
 267     # @param hrn if !=None, change the hrn
 268     # @param uuid if !=None, change the uuid
 269     # @param pubkey if !=None, change the public key
 270
 271     def refresh_gid(self, gid, xrn=None, uuid=None, pubkey=None):
 272         # TODO: compute expiration time of GID, refresh it if necessary
 273         gid_is_expired = False
 274
 275         # update the gid if we need to
 276         if gid_is_expired or xrn or uuid or pubkey:
 277
 278             if not xrn:
 279                 xrn = gid.get_urn()
 280             if not uuid:
 281                 uuid = gid.get_uuid()
 282             if not pubkey:
 283                 pubkey = gid.get_pubkey()
 284
 285             gid = self.create_gid(xrn, uuid, pubkey)
 286
 287         return gid
 288
 289     ##
 290     # Retrieve an authority credential for an authority. The authority
 291     # credential will contain the authority privilege and will be signed by
 292     # the authority's parent.
 293     #
 294     # @param hrn the human readable name of the authority (urn is converted to hrn)
 295     # @param authority type of credential to return (authority | sa | ma)
 296
 297     def get_auth_cred(self, xrn, kind="authority"):
 298         hrn, type = urn_to_hrn(xrn)
 299         auth_info = self.get_auth_info(hrn)
 300         gid = auth_info.get_gid_object()
 301
 302         cred = Credential(subject=hrn)
 303         cred.set_gid_caller(gid)
 304         cred.set_gid_object(gid)
 305         cred.set_privileges(kind)
 306         cred.get_privileges().delegate_all_privileges(True)
 307         #cred.set_pubkey(auth_info.get_gid_object().get_pubkey())
 308
 309         parent_hrn = get_authority(hrn)
 310         if not parent_hrn or hrn == self.config.SFA_INTERFACE_HRN:
 311             # if there is no parent hrn, then it must be self-signed. this
 312             # is where we terminate the recursion
 313             cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
 314         else:
 315             # we need the parent's private key in order to sign this GID
 316             parent_auth_info = self.get_auth_info(parent_hrn)
 317             cred.set_issuer_keys(parent_auth_info.get_privkey_filename(), parent_auth_info.get_gid_filename())
 318
 319
 320             cred.set_parent(self.get_auth_cred(parent_hrn, kind))
 321
 322         cred.encode()
 323         cred.sign()
 324
 325         return cred
 326     ##
 327     # Retrieve an authority ticket. An authority ticket is not actually a
 328     # redeemable ticket, but only serves the purpose of being included as the
 329     # parent of another ticket, in order to provide a chain of authentication
 330     # for a ticket.
 331     #
 332     # This looks almost the same as get_auth_cred, but works for tickets
 333     # XXX does similarity imply there should be more code re-use?
 334     #
 335     # @param xrn the human readable name of the authority (urn is converted to hrn)
 336
 337     def get_auth_ticket(self, xrn):
 338         hrn, type = urn_to_hrn(xrn)
 339         auth_info = self.get_auth_info(hrn)
 340         gid = auth_info.get_gid_object()
 341
 342         ticket = SfaTicket(subject=hrn)
 343         ticket.set_gid_caller(gid)
 344         ticket.set_gid_object(gid)
 345         ticket.set_delegate(True)
 346         ticket.set_pubkey(auth_info.get_gid_object().get_pubkey())
 347
 348         parent_hrn = get_authority(hrn)
 349         if not parent_hrn:
 350             # if there is no parent hrn, then it must be self-signed. this
 351             # is where we terminate the recursion
 352             ticket.set_issuer(auth_info.get_pkey_object(), hrn)
 353         else:
 354             # we need the parent's private key in order to sign this GID
 355             parent_auth_info = self.get_auth_info(parent_hrn)
 356             ticket.set_issuer(parent_auth_info.get_pkey_object(), parent_auth_info.hrn)
 357             ticket.set_parent(self.get_auth_cred(parent_hrn))
 358
 359         ticket.encode()
 360         ticket.sign()
 361
 362         return ticket
 363