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

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

Incomplete - task 2: XACML-Security Integration

  • Working on PIP to make Attribute Service query
  • 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                attributeValueBag.extend(attributeValues)
186                   
187        if len(attributeValueBag) == 0 and self.mustBePresent:
188            raise MissingAttributeError('"MustBePresent" is set for %r but no '
189                                        'match for attributeId=%r, dataType=%r '
190                                        'and issuer=%r' % 
191                                        (self.__class__.__name__,
192                                         self.attributeId,
193                                         self.dataType,
194                                         self.issuer)) 
195                       
196        return attributeValueBag
197       
198       
199class ResourceAttributeDesignator(AttributeDesignator):
200    """XACML Resource Attribute Designator type
201    @cvar ELEMENT_LOCAL_NAME: XML local name for this element
202    @type ELEMENT_LOCAL_NAME: string
203    """
204    ELEMENT_LOCAL_NAME = 'ResourceAttributeDesignator'
205    __slots__ = ()
206   
207    def evaluate(self, context):
208        """Evaluate the result of the ResourceAttributeDesignator in a condition
209       
210        @param context: the request context
211        @type context: ndg.xacml.core.context.request.Request
212        @return: attribute value(s) resulting from execution of this expression
213        in a condition
214        @rtype: AttributeValue/NoneType 
215        """ 
216        if not isinstance(context, Request):
217            raise TypeError('Expecting %r type for context input; got %r' %
218                            (Request, type(context)))
219       
220        dataType = self.dataType
221        attributeValueBag = TypedList(self.attributeValueFactory(dataType))
222        attributeId = self.attributeId
223        issuer = self.issuer
224       
225        if issuer is not None:
226            _issuerMatch = lambda _issuer: issuer == _issuer
227        else:
228            _issuerMatch = lambda _issuer: True
229       
230        _attributeMatch = lambda attr: (attr.attributeId == attributeId and 
231                                        attr.dataType == dataType and
232                                        _issuerMatch(attr.issuer))
233                   
234        for resource in context.resources:
235            for attr in resource.attributes:
236                if _attributeMatch(attr):
237                    attributeValueBag.extend([i for i in attr.attributeValues
238                                              if i.dataType == dataType])
239                   
240        if len(attributeValueBag) == 0 and self.mustBePresent:
241            raise MissingAttributeError('"MustBePresent" is set for %r but no '
242                                        'match for attributeId=%r, dataType=%r '
243                                        'and issuer=%r' % 
244                                        (self.__class__.__name__,
245                                         self.attributeId,
246                                         self.dataType,
247                                         self.issuer)) 
248                       
249        return attributeValueBag
250   
251       
252class ActionAttributeDesignator(AttributeDesignator):
253    """XACML Action Attribute Designator type
254    @cvar ELEMENT_LOCAL_NAME: XML local name for this element
255    @type ELEMENT_LOCAL_NAME: string
256    """
257    ELEMENT_LOCAL_NAME = 'ActionAttributeDesignator'
258    __slots__ = ()
259   
260    def evaluate(self, context):
261        """Evaluate the result of the ActionAttributeDesignator in a condition
262       
263        @param context: the request context
264        @type context: ndg.xacml.core.context.request.Request
265        @return: attribute value(s) resulting from execution of this expression
266        in a condition
267        @rtype: AttributeValue/NoneType 
268        """ 
269        if not isinstance(context, Request):
270            raise TypeError('Expecting %r type for context input; got %r' %
271                            (Request, type(context)))
272       
273        dataType = self.dataType
274        attributeValueBag = TypedList(self.attributeValueFactory(dataType))
275        attributeId = self.attributeId
276        issuer = self.issuer
277        action = context.action
278       
279        if issuer is not None:
280            _issuerMatch = lambda _issuer: issuer == _issuer
281        else:
282            _issuerMatch = lambda _issuer: True
283       
284        _attributeMatch = lambda attr: (attr.attributeId == attributeId and 
285                                        attr.dataType == dataType and
286                                        _issuerMatch(attr.issuer))
287                   
288        for attr in action.attributes:
289            if _attributeMatch(attr):
290                attributeValueBag.extend([i for i in attr.attributeValues
291                                          if i.dataType == dataType])
292                   
293        if len(attributeValueBag) == 0 and self.mustBePresent:
294            raise MissingAttributeError('"MustBePresent" is set for %r but no '
295                                        'match for attributeId=%r, dataType=%r '
296                                        'and issuer=%r' % 
297                                        (self.__class__.__name__,
298                                         self.attributeId,
299                                         self.dataType,
300                                         self.issuer)) 
301                       
302        return attributeValueBag   
303   
304   
305class EnvironmentAttributeDesignator(AttributeDesignator):
306    """XACML Environment Attribute Designator type
307    @cvar ELEMENT_LOCAL_NAME: XML local name for this element
308    @type ELEMENT_LOCAL_NAME: string
309    """
310    ELEMENT_LOCAL_NAME = 'EnvironmentAttributeDesignator'
311    __slots__ = ()
312   
313    def evaluate(self, context):
314        """Evaluate the result of the EnvironmentAttributeDesignator in a
315        condition
316       
317        @param context: the request context
318        @type context: ndg.xacml.core.context.request.Request
319        @return: attribute value(s) resulting from execution of this expression
320        in a condition
321        @rtype: AttributeValue/NoneType 
322        """ 
323        if not isinstance(context, Request):
324            raise TypeError('Expecting %r type for context input; got %r' %
325                            (Request, type(context)))
326       
327        dataType = self.dataType
328        attributeValueBag = TypedList(self.attributeValueFactory(dataType))
329        attributeId = self.attributeId
330        issuer = self.issuer
331        environment = context.environment
332       
333        if issuer is not None:
334            _issuerMatch = lambda _issuer: issuer == _issuer
335        else:
336            _issuerMatch = lambda _issuer: True   
337       
338        _attributeMatch = lambda attr: (attr.attributeId == attributeId and 
339                                        attr.dataType == dataType and
340                                        _issuerMatch(attr.issuer))
341                 
342        for attr in environment.attributes:
343            if _attributeMatch(attr):
344                attributeValueBag.extend([i for i in attr.attributeValues
345                                          if i.dataType == dataType])
346                   
347        if len(attributeValueBag) == 0 and self.mustBePresent:
348            raise MissingAttributeError('"MustBePresent" is set for %r but no '
349                                        'match for attributeId=%r, dataType=%r '
350                                        'and issuer=%r' % 
351                                        (self.__class__.__name__,
352                                         self.attributeId,
353                                         self.dataType,
354                                         self.issuer)) 
355                       
356        return attributeValueBag
Note: See TracBrowser for help on using the repository browser.