source: TI12-security/trunk/ndg_xacml/ndg/xacml/core/attributedesignator.py @ 7324

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI12-security/trunk/ndg_xacml/ndg/xacml/core/attributedesignator.py@7324
Revision 7324, 14.3 KB checked in by pjkersha, 10 years ago (diff)

Incomplete - task 2: XACML-Security Integration

  • adding in functionality for call out to PIP via context handler from Subject Attribute Designator
  • Property svn:keywords set to Id
Line 
1"""NDG XACML AttributeDesignator type
2
3NERC DataGrid
4"""
5__author__ = "P J Kershaw"
6__date__ = "16/03/10"
7__copyright__ = "(C) 2010 Science and Technology Facilities Council"
8__contact__ = "Philip.Kershaw@stfc.ac.uk"
9__license__ = "BSD - see LICENSE file in top-level directory"
10__contact__ = "Philip.Kershaw@stfc.ac.uk"
11__revision__ = "$Id$"
12from ndg.xacml.utils import TypedList
13from ndg.xacml.core.expression import Expression
14from ndg.xacml.core.attributevalue import (AttributeValue, 
15                                           AttributeValueClassFactory)
16from ndg.xacml.core.context.request import Request
17from ndg.xacml.core.context.handler import CtxHandlerInterface
18from ndg.xacml.core.context.exceptions import MissingAttributeError
19
20
21class AttributeDesignator(Expression):
22    '''Base class for XACML Attribute Designator types
23   
24    @cvar ATTRIBUTE_ID_ATTRIB_NAME: attribute ID XML attribute name
25    @type ATTRIBUTE_ID_ATTRIB_NAME: string
26    @cvar ISSUER_ATTRIB_NAME: issuer XML attribute name
27    @type ISSUER_ATTRIB_NAME: string
28    @cvar MUST_BE_PRESENT_ATTRIB_NAME: must be present XML attribute name
29    @type MUST_BE_PRESENT_ATTRIB_NAME: string
30   
31    @ivar __attributeId: attribute ID for this designator
32    @type __attributeId: basestring / NoneType
33    @ivar __issuer: issuer if the designator
34    @type __issuer: basestring / NoneType
35    @ivar __mustBePresent: XML must be present flag
36    @type __mustBePresent: bool
37    @ivar __attributeValueFactory: When evaluating matches, use an attribute
38    value class factory to create attribute values for match bag of the correct
39    DataType to respect type based rule functions
40    @type __attributeValueFactory: ndg.xacml.core.attributevalue.AttributeValueClassFactory
41    '''
42    ATTRIBUTE_ID_ATTRIB_NAME = 'AttributeId'
43    ISSUER_ATTRIB_NAME = 'Issuer'
44    MUST_BE_PRESENT_ATTRIB_NAME = 'MustBePresent'
45   
46    __slots__ = (
47        '__attributeId', 
48        '__issuer', 
49        '__mustBePresent',
50        '__attributeValueFactory'
51    )
52   
53    def __init__(self):
54        """Initialise attributes"""
55        super(AttributeDesignator, self).__init__()
56        self.__attributeId = None
57        self.__issuer = None
58        self.__mustBePresent = False
59       
60        # When evaluating matches, use an attribute value class factory to
61        # create attribute values for match bag of the correct DataType to
62        # respect type based rule functions
63        self.__attributeValueFactory = AttributeValueClassFactory()
64
65    @property
66    def attributeId(self):
67        """Get Attribute Id
68        @return: attribute ID
69        @rtype: basestring / NoneType
70        """
71        return self.__attributeId
72
73    @attributeId.setter
74    def attributeId(self, value):
75        """Set Attribute Id
76        @param value: attribute ID
77        @type value: basestring
78        @raise TypeError: incorrect input type
79        """
80        if not isinstance(value, basestring):
81            raise TypeError('Expecting %r type for "attributeId" '
82                            'attribute; got %r' % (basestring, type(value)))
83           
84        self.__attributeId = value 
85       
86    @property
87    def issuer(self):
88        """Get Issuer
89        @return: issuer
90        @rtype: basestring / NoneType
91        """
92        return self.__issuer
93
94    @issuer.setter
95    def issuer(self, value):
96        """Set Issuer
97        @param value: issuer
98        @type value: basestring
99        @raise TypeError: incorrect input type
100        """
101        if not isinstance(value, basestring):
102            raise TypeError('Expecting %r type for "issuer" '
103                            'attribute; got %r' % (basestring, type(value)))
104           
105        self.__issuer = value   
106
107    @property
108    def mustBePresent(self):
109        """Get Must Be Present flag
110        @return: must be present flag
111        @rtype: bool
112        """
113        return self.__mustBePresent
114
115    @mustBePresent.setter
116    def mustBePresent(self, value):
117        """Set Must Be Present flag
118        @param value: must be present flag
119        @type value: bool
120        @raise TypeError: incorrect input type
121        """
122        if not isinstance(value, bool):
123            raise TypeError('Expecting %r type for "mustBePresent" '
124                            'attribute; got %r' % (bool, type(value)))
125           
126        self.__mustBePresent = value   
127             
128    @property
129    def attributeValueFactory(self):
130        """Get Attribute Value factory function
131       
132        @return: attribute value factory instance
133        @rtype: ndg.xacml.core.attributevalue.AttributeValueClassFactory
134        """
135        return self.__attributeValueFactory
136                           
137       
138class SubjectAttributeDesignator(AttributeDesignator):
139    """XACML Subject Attribute Designator type
140    @cvar ELEMENT_LOCAL_NAME: XML local name for this element
141    @type ELEMENT_LOCAL_NAME: string
142    """
143    ELEMENT_LOCAL_NAME = 'SubjectAttributeDesignator'
144    __slots__ = ()
145   
146    def evaluate(self, context):
147        """Evaluate the result of the SubjectAttributeDesignator in a condition
148       
149        @param context: the request context
150        @type context: ndg.xacml.core.context.request.Request
151        @return: attribute value(s) resulting from execution of this expression
152        in a condition
153        @rtype: AttributeValue/NoneType 
154        """ 
155        if not isinstance(context, Request):
156            raise TypeError('Expecting %r type for context input; got %r' %
157                            (Request, type(context)))
158       
159        dataType = self.dataType
160        attributeValueBag = TypedList(self.attributeValueFactory(dataType))
161        attributeId = self.attributeId
162        issuer = self.issuer
163       
164        if issuer is not None:
165            _issuerMatch = lambda _issuer: issuer == _issuer
166        else:
167            _issuerMatch = lambda _issuer: True
168       
169        _attributeMatch = lambda attr: (attr.attributeId == attributeId and 
170                                        attr.dataType == dataType and
171                                        _issuerMatch(attr.issuer))
172                                       
173        for subject in context.subjects: 
174            for attr in subject.attributes:
175                if _attributeMatch(attr):
176                    attributeValueBag.extend([i for i in attr.attributeValues
177                                              if i.dataType == dataType])
178                   
179            if context.ctxHandler is not None:
180                # Try querying the Policy Information Point via the Context
181                # Handler to see if values for the attribute specified in this
182                # designator can be retrieved externally. If retrieved, they're
183                # added to the bag.
184                attributeValues = context.ctxHandler.pipQuery(context, self)
185                if attributeValues is not None:
186                    attributeValueBag.extend(attributeValues)
187                   
188        if len(attributeValueBag) == 0 and self.mustBePresent:
189            raise MissingAttributeError('"MustBePresent" is set for %r but no '
190                                        'match for attributeId=%r, dataType=%r '
191                                        'and issuer=%r' % 
192                                        (self.__class__.__name__,
193                                         self.attributeId,
194                                         self.dataType,
195                                         self.issuer)) 
196                       
197        return attributeValueBag
198       
199       
200class ResourceAttributeDesignator(AttributeDesignator):
201    """XACML Resource Attribute Designator type
202    @cvar ELEMENT_LOCAL_NAME: XML local name for this element
203    @type ELEMENT_LOCAL_NAME: string
204    """
205    ELEMENT_LOCAL_NAME = 'ResourceAttributeDesignator'
206    __slots__ = ()
207   
208    def evaluate(self, context):
209        """Evaluate the result of the ResourceAttributeDesignator in a condition
210       
211        @param context: the request context
212        @type context: ndg.xacml.core.context.request.Request
213        @return: attribute value(s) resulting from execution of this expression
214        in a condition
215        @rtype: AttributeValue/NoneType 
216        """ 
217        if not isinstance(context, Request):
218            raise TypeError('Expecting %r type for context input; got %r' %
219                            (Request, type(context)))
220       
221        dataType = self.dataType
222        attributeValueBag = TypedList(self.attributeValueFactory(dataType))
223        attributeId = self.attributeId
224        issuer = self.issuer
225       
226        if issuer is not None:
227            _issuerMatch = lambda _issuer: issuer == _issuer
228        else:
229            _issuerMatch = lambda _issuer: True
230       
231        _attributeMatch = lambda attr: (attr.attributeId == attributeId and 
232                                        attr.dataType == dataType and
233                                        _issuerMatch(attr.issuer))
234                   
235        for resource in context.resources:
236            for attr in resource.attributes:
237                if _attributeMatch(attr):
238                    attributeValueBag.extend([i for i in attr.attributeValues
239                                              if i.dataType == dataType])
240                   
241        if len(attributeValueBag) == 0 and self.mustBePresent:
242            raise MissingAttributeError('"MustBePresent" is set for %r but no '
243                                        'match for attributeId=%r, dataType=%r '
244                                        'and issuer=%r' % 
245                                        (self.__class__.__name__,
246                                         self.attributeId,
247                                         self.dataType,
248                                         self.issuer)) 
249                       
250        return attributeValueBag
251   
252       
253class ActionAttributeDesignator(AttributeDesignator):
254    """XACML Action Attribute Designator type
255    @cvar ELEMENT_LOCAL_NAME: XML local name for this element
256    @type ELEMENT_LOCAL_NAME: string
257    """
258    ELEMENT_LOCAL_NAME = 'ActionAttributeDesignator'
259    __slots__ = ()
260   
261    def evaluate(self, context):
262        """Evaluate the result of the ActionAttributeDesignator in a condition
263       
264        @param context: the request context
265        @type context: ndg.xacml.core.context.request.Request
266        @return: attribute value(s) resulting from execution of this expression
267        in a condition
268        @rtype: AttributeValue/NoneType 
269        """ 
270        if not isinstance(context, Request):
271            raise TypeError('Expecting %r type for context input; got %r' %
272                            (Request, type(context)))
273       
274        dataType = self.dataType
275        attributeValueBag = TypedList(self.attributeValueFactory(dataType))
276        attributeId = self.attributeId
277        issuer = self.issuer
278        action = context.action
279       
280        if issuer is not None:
281            _issuerMatch = lambda _issuer: issuer == _issuer
282        else:
283            _issuerMatch = lambda _issuer: True
284       
285        _attributeMatch = lambda attr: (attr.attributeId == attributeId and 
286                                        attr.dataType == dataType and
287                                        _issuerMatch(attr.issuer))
288                   
289        for attr in action.attributes:
290            if _attributeMatch(attr):
291                attributeValueBag.extend([i for i in attr.attributeValues
292                                          if i.dataType == dataType])
293                   
294        if len(attributeValueBag) == 0 and self.mustBePresent:
295            raise MissingAttributeError('"MustBePresent" is set for %r but no '
296                                        'match for attributeId=%r, dataType=%r '
297                                        'and issuer=%r' % 
298                                        (self.__class__.__name__,
299                                         self.attributeId,
300                                         self.dataType,
301                                         self.issuer)) 
302                       
303        return attributeValueBag   
304   
305   
306class EnvironmentAttributeDesignator(AttributeDesignator):
307    """XACML Environment Attribute Designator type
308    @cvar ELEMENT_LOCAL_NAME: XML local name for this element
309    @type ELEMENT_LOCAL_NAME: string
310    """
311    ELEMENT_LOCAL_NAME = 'EnvironmentAttributeDesignator'
312    __slots__ = ()
313   
314    def evaluate(self, context):
315        """Evaluate the result of the EnvironmentAttributeDesignator in a
316        condition
317       
318        @param context: the request context
319        @type context: ndg.xacml.core.context.request.Request
320        @return: attribute value(s) resulting from execution of this expression
321        in a condition
322        @rtype: AttributeValue/NoneType 
323        """ 
324        if not isinstance(context, Request):
325            raise TypeError('Expecting %r type for context input; got %r' %
326                            (Request, type(context)))
327       
328        dataType = self.dataType
329        attributeValueBag = TypedList(self.attributeValueFactory(dataType))
330        attributeId = self.attributeId
331        issuer = self.issuer
332        environment = context.environment
333       
334        if issuer is not None:
335            _issuerMatch = lambda _issuer: issuer == _issuer
336        else:
337            _issuerMatch = lambda _issuer: True   
338       
339        _attributeMatch = lambda attr: (attr.attributeId == attributeId and 
340                                        attr.dataType == dataType and
341                                        _issuerMatch(attr.issuer))
342                 
343        for attr in environment.attributes:
344            if _attributeMatch(attr):
345                attributeValueBag.extend([i for i in attr.attributeValues
346                                          if i.dataType == dataType])
347                   
348        if len(attributeValueBag) == 0 and self.mustBePresent:
349            raise MissingAttributeError('"MustBePresent" is set for %r but no '
350                                        'match for attributeId=%r, dataType=%r '
351                                        'and issuer=%r' % 
352                                        (self.__class__.__name__,
353                                         self.attributeId,
354                                         self.dataType,
355                                         self.issuer)) 
356                       
357        return attributeValueBag
Note: See TracBrowser for help on using the repository browser.