source: fedd/federation/authorizer.py @ cbe0570

compt_changesinfo-ops
Last change on this file since cbe0570 was cbe0570, checked in by Ted Faber <faber@…>, 8 years ago

Convert to libcreddy. Closes #19

  • Property mode set to 100644
File size: 16.1 KB
Line 
1#/usr/local/bin/python
2
3from tempfile import mkstemp
4from subprocess import call
5from threading import Lock
6
7from string import join, hexdigits
8
9from fedid import fedid
10from remote_service import service_caller
11from service_error import service_error
12from util import abac_pem_type, abac_split_cert
13from proof import proof
14
15
16import ABAC
17import Creddy
18import pickle
19
20import sys
21import os, os.path
22import re
23
24class authorizer_base:
25    """
26    Classes based on this one keep track of authorization attributes for the
27    various modules running.  This base class holds some utility functions that
28    they all potentially use.
29    """
30
31    # general error exception for badly formed names. 
32    class bad_name(RuntimeError): pass
33    # difficulty creating an attribute
34    class attribute_error(RuntimeError): pass
35
36    @staticmethod
37    def auth_name(name):
38        """
39        Helper to convert a non-unicode local name to a unicode string.  Mixed
40        representations can needlessly confuse the authorizer.
41        """
42        if isinstance(name, basestring):
43            if not isinstance(name, unicode): return unicode(name)
44            else: return name
45        else: return name
46
47    @staticmethod
48    def valid_name(name):
49        """
50        Ensure that the given name is valid.  A valid name can either be a
51        triple of strings and fedids representing one of our generalized Emulab
52        names or a single fedid.  Compound names can include wildcards (None)
53        and must anchor to a fedid at their highest level (unless they're all
54        None)
55
56        This either returns True or throws an exception.  More an assertion
57        than a function.
58        """
59        if isinstance(name, tuple) and len(name) == 3:
60            for n in name:
61                if n: 
62                    if not (isinstance(n, basestring) or isinstance(n, fedid)):
63                        raise authorizer_base.bad_name(
64                                "names must be either a triple or a fedid")
65            for n in name: 
66                if n:
67                    if isinstance(n, fedid):
68                        return True
69                    else:
70                        raise authorizer_base.bad_name(
71                                "Compound names must be " + \
72                                "rooted in fedids: %s" % str(name))
73
74            return True
75        elif isinstance(name, fedid):
76            return True
77        else:
78            raise authorizer_base.bad_name(
79                    "Names must be a triple or a fedid (%s)" % name)
80
81
82class authorizer(authorizer_base):
83    """
84    This class keeps track of authorization attributes for the various modules
85    running.  When it gets smarter it will be the basis for a real
86    attribute-based authentication system.
87    """
88    def __init__(self, def_attr="testbed"):
89        self.attrs = { }
90        self.globals=set()
91
92    def set_attribute(self, name, attr):
93        """
94        Attach attr to name.  Multiple attrs can be attached.
95        """
96        self.valid_name(name)
97        if isinstance(name, tuple):
98            aname = tuple([ self.auth_name(n) for n in name])
99        else:
100            aname = self.auth_name(name)
101
102        if not self.attrs.has_key(aname):
103            self.attrs[aname] = set()
104        self.attrs[aname].add(attr)
105
106    def unset_attribute(self, name, attr):
107        """
108        Remove an attribute from name
109        """
110        self.valid_name(name)
111        if isinstance(name, tuple):
112            aname = tuple([ self.auth_name(n) for n in name])
113        else:
114            aname = self.auth_name(name)
115
116        attrs = self.attrs.get(aname, None)
117        if attrs: attrs.discard(attr)
118
119    def check_attribute(self, name, attr, with_proof=False):
120        """
121        Return True if name has attr (or if attr is global).  Tuple names match
122        any tuple name that matches all names present and has None entries in
123        other fileds.  For tuple names True implies that there is a matching
124        tuple name with the attribute.
125        """
126        def tup(tup, i, p):
127            mask = 1 << i
128            if p & mask : return authorizer.auth_name(tup[i])
129            else: return None
130
131        self.valid_name(name)
132        if attr in self.globals:
133            if with_proof: return True, proof("me", name, attr)
134            else: return True
135
136        if isinstance(name, tuple):
137            for p in range(0,8):
138                lookup = ( tup(name, 0, p), tup(name,1, p), tup(name,2,p))
139                if self.attrs.has_key(lookup):
140                    if attr in self.attrs[lookup]:
141                        if with_proof: return True, proof("me", name, attr)
142                        else: return True
143                # Drop through
144                if with_proof: return False, proof("me", name, attr)
145                else: return False
146        else:
147            if with_proof:
148                return attr in self.attrs.get(self.auth_name(name), set()), \
149                        proof("me", name, attr)
150            else:
151                return attr in self.attrs.get(self.auth_name(name), set())
152
153    def set_global_attribute(self, attr):
154        """
155        Set a global attribute.  All names, even those otherwise unknown to the
156        authorizer have this attribute.
157        """
158        self.globals.add(attr)
159
160    def unset_global_attribute(self, attr):
161        """
162        Remove a global attribute
163        """
164
165        self.globals.discard(attr)
166
167    def import_credentials(self, file_list=None, data_list=None):
168        return False
169
170    def __str__(self):
171        rv = ""
172        rv += "attrs %s\n" % self.attrs
173        rv += "globals %s" % self.globals
174        return rv
175
176    def clone(self):
177        rv = authorizer()
178        rv.attrs = self.attrs.copy()
179        rv.globals = self.globals.copy()
180        return rv
181
182    def save(self, fn=None):
183        if fn:
184            f = open(fn, "w")
185            pickle.dump(self, f)
186            f.close()
187
188    def load(self, fn=None):
189        if fn:
190            f = open(fn, "r")
191            a = pickle.load(f)
192            f.close()
193            self.attrs = a.attrs
194            self.globals = a.globals
195       
196
197class abac_authorizer(authorizer_base):
198    """
199    Use the ABAC authorization system to make attribute decisions.
200    """
201
202    clean_attr_re = re.compile('[^A-Za-z0-9_]+')
203    clean_prefix_attr_re = re.compile('^_+')
204    cred_file_re = re.compile('.*\.der$')
205    bad_name = authorizer_base.bad_name
206    attribute_error = authorizer_base.attribute_error
207    class no_file_error(RuntimeError): pass
208    class bad_cert_error(RuntimeError): pass
209
210    def __init__(self, certs=None, me=None, key=None, load=None, save=None):
211        self.creddy_id = None
212        self.globals = set()
213        self.lock = Lock()
214        self.me = me
215        self.save_dir = load or save
216        self.local_files = False
217        if self.save_dir:
218            self.save_dir = os.path.abspath(self.save_dir)
219        # If the me parameter is a combination certificate, split it into the
220        # abac_authorizer save directory (if any) for use with creddy.
221        if self.me is not None and abac_pem_type(self.me) == 'both':
222            if self.save_dir:
223                keyfile="%s/key.pem" % self.save_dir
224                certfile = "%s/cert.pem" % self.save_dir
225
226                # Clear a spot for the new key and cert files.
227                for fn in (keyfile, certfile):
228                    if os.access(fn, os.F_OK):
229                        os.unlink(fn)
230
231                self.key, self.me = abac_split_cert(self.me, keyfile, certfile)
232                self.local_files = True
233                self.init_libcreddy_id()
234            else:
235                raise abac_authorizer.bad_cert_error("Combination " + \
236                        "certificate and nowhere to split it");
237        else:
238            self.key = key
239        self.context = ABAC.Context()
240        if me:
241            self.fedid = fedid(file=self.me)
242            rv = self.context.load_id_file(self.me)
243            if rv != 0:
244                raise abac_authorizer.bad_name(
245                        'Cannot load identity from %s' % me)
246        else:
247            self.fedid = None
248
249        if isinstance(certs, basestring):
250            certs = [ certs ] 
251
252        for dir in certs or []:
253            self.context.load_directory(dir)
254
255        if load:
256            self.load(load)
257
258    def init_libcreddy_id(self):
259        self.creddy_id = None
260        try:
261            self.creddy_id = Creddy.ID(self.me)
262        except:
263            raise abac_authorizer.bad_cert_error('Cannot load cert %s: %s' \
264                    % self.me)
265
266        try:
267            self.creddy_id.load_privkey(self.key)
268        except:
269            self.creddy_id = None
270            raise abac_authorized_bad_cert_error('Cannot load key %s' \
271                    % self.key)
272
273
274
275    # Modify the pickling operations so that the context and lock are not
276    # pickled
277
278    def __getstate__(self):
279        d = self.__dict__.copy()
280        del d['lock']
281        del d['context']
282        del d['creddy_id']
283        return d
284
285    def __setstate__(self, d):
286        # Import everything from the pickle dict (except what we excluded in
287        # __getstate__)
288        self.__dict__.update(d)
289        # Initialize the unpicklables
290        self.context = ABAC.Context()
291        self.lock = Lock()
292
293    @staticmethod
294    def clean_attr(attr):
295        a = abac_authorizer.clean_attr_re.sub('_', attr)
296        return abac_authorizer.clean_prefix_attr_re.sub('', a)
297
298
299    def import_credentials(self, file_list=None, data_list=None):
300        if data_list:
301            return any([self.import_credential(data=d) for d in data_list])
302        elif file_list:
303            return any([self.import_credential(file=f) for f in file_list])
304        else:
305            return False
306
307    def import_credential(self, file=None, data=None):
308        if data:
309            if self.context.load_id_chunk(data) != ABAC.ABAC_CERT_SUCCESS:
310                return self.context.load_attribute_chunk(data) == \
311                        ABAC.ABAC_CERT_SUCCESS
312            else:
313                return True
314        elif file:
315            if self.context.load_id_file(file) != ABAC.ABAC_CERT_SUCCESS:
316                return self.context.load_attribute_file(file) == \
317                        ABAC.ABAC_CERT_SUCCESS
318            else:
319                return True
320        else:
321            return False
322
323    def set_attribute(self, name=None, attr=None, cert=None):
324        if name and attr:
325            if isinstance(name, tuple):
326                raise abac_authorizer.bad_name(
327                        "ABAC doesn't understand three-names")
328            # Convert non-string attributes to strings
329            if not isinstance(attr, basestring):
330                attr = "%s" % attr
331
332            if self.creddy_id:
333                # Create a credential and insert it into context
334                # This will simplify when we have libcreddy
335                try:
336                    attrcert = Creddy.Attribute(self.creddy_id, 
337                            self.clean_attr(attr), 3600 * 24 * 365 * 10)
338                    attrcert.principal("%s" % name)
339                    attrcert.bake()
340                except:
341                    raise abac_authorized_bad_cert_error(
342                            "Cannot create attribute cert")
343                self.lock.acquire()
344                # load it to context and remove the file
345                rv = self.context.load_attribute_chunk(attrcert.cert_chunk())
346                self.lock.release()
347                return rv
348            else:
349                raise abac_authorizer.attribute_error(
350                        "Identity and key not specified on creation")
351        elif cert:
352            # Insert this credential into the context
353            self.lock.acquire()
354            rv = self.context.load_attribute_chunk(cert)
355            self.lock.release()
356            return rv
357        else:
358            raise abac_authorizer.attribute_error(
359                    "Neither name/attr nor cert is set")
360
361    def unset_attribute(self, name, attr):
362        if isinstance(name, tuple):
363            raise abac_authorizer.bad_name(
364                    "ABAC doesn't understand three-names")
365        # Convert non-string attributes to strings
366        if not isinstance(attr, basestring):
367            attr = "%s" % attr
368        cattr = self.clean_attr(attr)
369        self.lock.acquire()
370        ctxt = ABAC.Context()
371        ids = set()
372        for c in self.context.credentials():
373            h = c.head()
374            t = c.tail()
375            if h.is_role() and t.is_principal():
376                if t.principal() == '%s' % name and \
377                        h.principal() == '%s' % self.fedid and \
378                        h.role_name() == cattr:
379                    continue
380
381            id = c.issuer_cert()
382            if id not in ids:
383                ctxt.load_id_chunk(id)
384                ids.add(id)
385            ctxt.load_attribute_chunk(c.attribute_cert())
386        self.context = ctxt
387        self.lock.release()
388
389    @staticmethod
390    def starts_with_fedid(attr):
391        """
392        Return true if the first 40 characters of the string are hex digits
393        followed by a dot.  False otherwise.  Used in check_attribute.
394        """
395        if attr.find('.') == 40:
396            return all([ x in hexdigits for x in attr[0:40]])
397        else:
398            return False
399
400
401    def check_attribute(self, name, attr, with_proof=False):
402        if isinstance(name, tuple):
403            raise abac_authorizer.bad_name(
404                    "ABAC doesn't understand three-names")
405        else:
406            # Convert non-string attributes to strings
407            if not isinstance(attr, basestring):
408                attr = "%s" % attr
409            # Attributes that start with a fedid only have the part of the
410            # attribute after the dot cleaned.  Others are completely cleaned
411            # and have the owner fedid attached.
412            if self.starts_with_fedid(attr):
413                r, a = attr.split('.',1)
414                a = "%s.%s" % ( r, self.clean_attr(a))
415            else: 
416                a = "%s.%s" % (self.fedid, self.clean_attr(attr))
417
418            a = str(a)
419            n = str("%s" % name)
420
421            self.lock.acquire()
422            # Sigh. Unicode vs swig and swig seems to lose.  Make sure
423            # everything we pass into ABAC is a str not a unicode.
424            rv, p = self.context.query(a, n)
425            # XXX delete soon
426            if not rv and attr in self.globals: 
427                rv = True
428                p = None
429            self.lock.release()
430            if with_proof: return rv, proof(self.fedid, name, a, p)
431            else: return rv
432
433    def set_global_attribute(self, attr):
434        """
435        Set a global attribute.  All names, even those otherwise unknown to the
436        authorizer have this attribute.
437        """
438        self.lock.acquire()
439        self.globals.add(self.clean_attr(attr))
440        self.lock.release()
441
442    def unset_global_attribute(self, attr):
443        """
444        Remove a global attribute
445        """
446
447        self.lock.acquire()
448        self.globals.discard(self.clean_attr(attr))
449        self.lock.release()
450
451    def clone(self):
452        self.lock.acquire()
453        rv = abac_authorizer(me=self.me, key=self.key)
454        rv.globals = self.globals.copy()
455        rv.context = ABAC.Context(self.context)
456        self.lock.release()
457        return rv
458
459    def copy_file(self, src, dest, mode=0600):
460        '''
461        Copy src to dest with file mode mode.  May raise exceptions on file ops
462        '''
463        d = open(dest, 'w')
464        s = open(src, 'r')
465        d.write(s.read())
466        s.close()
467        d.close()
468        os.chmod(dest, mode)
469
470
471
472    def save(self, dir=None):
473        self.lock.acquire()
474        if dir:
475            self.save_dir = os.path.abspath(dir)
476        else:
477            dir = self.save_dir
478        if dir is None:
479            self.lock.release()
480            raise abac_authorizer.no_file_error("No load directory specified")
481        try:
482            if not os.access(dir, os.F_OK):
483                os.mkdir(dir)
484
485            # if self.key and self.me were split, copy the split files into the
486            # new directory.
487            if self.local_files:
488                self.copy_file(self.key, '%s/key.pem' % dir)
489                self.copy_file(self.me, '%s/cert.pem' % dir)
490                # Point the key and me members to the new locations for
491                # pickling
492                hold_key = self.key
493                hold_me = self.me
494                self.key = '%s/key.pem' % dir
495                self.me = '%s/cert.pem' % dir
496
497            f = open("%s/state" % dir, "w")
498            pickle.dump(self, f)
499            f.close()
500
501            if self.local_files:
502                self.key = hold_key
503                self.me = hold_me
504
505            if not os.access("%s/certs" %dir, os.F_OK):
506                os.mkdir("%s/certs" % dir)
507
508            # Clear the certs subdir
509            for fn in [ f for f in os.listdir("%s/certs" % dir) \
510                    if abac_authorizer.cred_file_re.match(f)]:
511                os.unlink('%s/certs/%s' % (dir, fn))
512
513            # Save the context
514            ii = 0
515            ai = 0
516            seenid = set()
517            seenattr = set()
518            for c in self.context.credentials():
519                id = c.issuer_cert()
520                attr = c.attribute_cert()
521                # NB: file naming conventions matter here.  The trailing_ID and
522                # _attr are required by ABAC.COntext.load_directory()
523                if id and id not in seenid:
524                    f = open("%s/certs/ID_%03d_ID.der" % (dir, ii), "w")
525                    f.write(id)
526                    f.close()
527                    ii += 1
528                    seenid.add(id)
529                if attr and attr not in seenattr:
530                    f = open("%s/certs/attr_%03d_attr.der" % (dir, ai), "w")
531                    f.write(attr)
532                    f.close()
533                    ai += 1
534                    seenattr.add(attr)
535        except EnvironmentError, e:
536            self.lock.release()
537            raise e
538        except pickle.PickleError, e:
539            self.lock.release()
540            raise e
541        self.lock.release()
542
543    def load(self, dir=None):
544        self.lock.acquire()
545        if dir:
546            self.save_dir = dir
547        else:
548            dir = self.save_dir
549        if dir is None:
550            self.lock.release()
551            raise abac_authorizer.no_file_error("No load directory specified")
552        try:
553            if os.access("%s/state" % dir, os.R_OK):
554                f = open("%s/state" % dir, "r")
555                st = pickle.load(f)
556                f.close()
557                # Copy the useful attributes from the pickled state
558                for a in ('globals', 'key', 'me', 'cert', 'fedid'):
559                    setattr(self, a, getattr(st, a, None))
560
561            # Initialize the new context with the new identity
562            self.context = ABAC.Context()
563            if self.me:
564                self.context.load_id_file(self.me)
565                if self.key:
566                    self.init_libcreddy_id()
567            self.context.load_directory("%s/certs" % dir)
568            self.save_dir = dir
569        except EnvironmentError, e:
570            self.lock.release()
571            raise e
572        except pickle.PickleError, e:
573            self.lock.release()
574            raise e
575        self.lock.release()
576
577    @staticmethod
578    def encode_credential(c):
579        return '%s <- %s' % (c.head().string(), c.tail().string())
580
581    def get_creds_for_principal(self, fid):
582        look_for = set(["%s" % fid])
583        found_attrs = set()
584        next_look = set()
585        found = set([])
586
587        self.lock.acquire()
588        while look_for:
589            for c in self.context.credentials():
590                tail = c.tail()
591                # XXX: This needs to be more aggressive for linked stuff
592                if tail.string() in look_for and c not in found:
593                    found.add(c)
594                    next_look.add(c.head().string())
595
596            look_for = next_look
597            next_look = set()
598        self.lock.release()
599       
600        return found
601
602    def __str__(self):
603
604        self.lock.acquire()
605        rv = "%s" % self.fedid
606        add = join([abac_authorizer.encode_credential(c)
607            for c in self.context.credentials()], '\n');
608        if add: rv += "\n%s" % add
609        self.lock.release()
610        return rv
611
Note: See TracBrowser for help on using the repository browser.