diff --git a/Lib/ldap/schema/models.py b/Lib/ldap/schema/models.py index feb7bff1..7520b2b1 100644 --- a/Lib/ldap/schema/models.py +++ b/Lib/ldap/schema/models.py @@ -106,26 +106,32 @@ class ObjectClass(SchemaElement): oid OID assigned to the object class names - This list of strings contains all NAMEs of the object class + All NAMEs of the object class (tuple of strings) desc - This string contains description text (DESC) of the object class + Description text (DESC) of the object class (string, or None if missing) obsolete Integer flag (0 or 1) indicating whether the object class is marked as OBSOLETE in the schema must - This list of strings contains NAMEs or OIDs of all attributes - an entry of the object class must have + NAMEs or OIDs of all attributes an entry of the object class must have + (tuple of strings) may - This list of strings contains NAMEs or OIDs of additional attributes - an entry of the object class may have + NAMEs or OIDs of additional attributes an entry of the object class may + have (tuple of strings) kind Kind of an object class: 0 = STRUCTURAL, 1 = ABSTRACT, 2 = AUXILIARY sup - This list of strings contains NAMEs or OIDs of object classes - this object class is derived from + NAMEs or OIDs of object classes this object class is derived from + (tuple of strings) + x_origin + Value of the X-ORIGIN extension flag (tuple of strings) + + Although it's not official, X-ORIGIN is used in several LDAP server + implementations to indicate the source of the associated schema + element """ schema_attribute = u'objectClasses' token_defaults = { @@ -137,7 +143,8 @@ class ObjectClass(SchemaElement): 'AUXILIARY':None, 'ABSTRACT':None, 'MUST':(()), - 'MAY':() + 'MAY':(), + 'X-ORIGIN':() } def _set_attrs(self,l,d): @@ -146,6 +153,7 @@ def _set_attrs(self,l,d): self.desc = d['DESC'][0] self.must = d['MUST'] self.may = d['MAY'] + self.x_origin = d['X-ORIGIN'] # Default is STRUCTURAL, see RFC2552 or draft-ietf-ldapbis-syntaxes self.kind = 0 if d['ABSTRACT']!=None: @@ -168,6 +176,7 @@ def __str__(self): result.append({0:' STRUCTURAL',1:' ABSTRACT',2:' AUXILIARY'}[self.kind]) result.append(self.key_list('MUST',self.must,sep=' $ ')) result.append(self.key_list('MAY',self.may,sep=' $ ')) + result.append(self.key_list('X-ORIGIN',self.x_origin,quoted=1)) return '( %s )' % ''.join(result) @@ -190,11 +199,11 @@ class AttributeType(SchemaElement): Class attributes: oid - OID assigned to the attribute type + OID assigned to the attribute type (string) names - This list of strings contains all NAMEs of the attribute type + All NAMEs of the attribute type (tuple of strings) desc - This string contains description text (DESC) of the attribute type + Description text (DESC) of the attribute type (string, or None if missing) obsolete Integer flag (0 or 1) indicating whether the attribute type is marked as OBSOLETE in the schema @@ -202,19 +211,19 @@ class AttributeType(SchemaElement): Integer flag (0 or 1) indicating whether the attribute must have only one value syntax - String contains OID of the LDAP syntax assigned to the attribute type + OID of the LDAP syntax assigned to the attribute type no_user_mod Integer flag (0 or 1) indicating whether the attribute is modifiable by a client application equality - String contains NAME or OID of the matching rule used for - checking whether attribute values are equal + NAME or OID of the matching rule used for checking whether attribute values + are equal (string, or None if missing) substr - String contains NAME or OID of the matching rule used for - checking whether an attribute value contains another value + NAME or OID of the matching rule used for checking whether an attribute + value contains another value (string, or None if missing) ordering - String contains NAME or OID of the matching rule used for - checking whether attribute values are lesser-equal than + NAME or OID of the matching rule used for checking whether attribute values + are lesser-equal than (string, or None if missing) usage USAGE of an attribute type: 0 = userApplications @@ -222,8 +231,14 @@ class AttributeType(SchemaElement): 2 = distributedOperation, 3 = dSAOperation sup - This list of strings contains NAMEs or OIDs of attribute types - this attribute type is derived from + NAMEs or OIDs of attribute types this attribute type is derived from + (tuple of strings) + x_origin + Value of the X-ORIGIN extension flag (tuple of strings). + + Although it's not official, X-ORIGIN is used in several LDAP server + implementations to indicate the source of the associated schema + element """ schema_attribute = u'attributeTypes' token_defaults = { @@ -239,7 +254,7 @@ class AttributeType(SchemaElement): 'COLLECTIVE':None, 'NO-USER-MODIFICATION':None, 'USAGE':('userApplications',), - 'X-ORIGIN':(None,), + 'X-ORIGIN':(), 'X-ORDERED':(None,), } @@ -251,7 +266,7 @@ def _set_attrs(self,l,d): self.equality = d['EQUALITY'][0] self.ordering = d['ORDERING'][0] self.substr = d['SUBSTR'][0] - self.x_origin = d['X-ORIGIN'][0] + self.x_origin = d['X-ORIGIN'] self.x_ordered = d['X-ORDERED'][0] try: syntax = d['SYNTAX'][0] @@ -302,7 +317,7 @@ def __str__(self): 3:" USAGE dSAOperation", }[self.usage] ) - result.append(self.key_attr('X-ORIGIN',self.x_origin,quoted=1)) + result.append(self.key_list('X-ORIGIN',self.x_origin,quoted=1)) result.append(self.key_attr('X-ORDERED',self.x_ordered,quoted=1)) return '( %s )' % ''.join(result) @@ -314,7 +329,7 @@ class LDAPSyntax(SchemaElement): oid OID assigned to the LDAP syntax desc - This string contains description text (DESC) of the LDAP syntax + Description text (DESC) of the LDAP syntax (string, or None if missing) not_human_readable Integer flag (0 or 1) indicating whether the attribute type is marked as not human-readable (X-NOT-HUMAN-READABLE) @@ -358,14 +373,15 @@ class MatchingRule(SchemaElement): oid OID assigned to the matching rule names - This list of strings contains all NAMEs of the matching rule + All NAMEs of the matching rule (tuple of strings) desc - This string contains description text (DESC) of the matching rule + Description text (DESC) of the matching rule obsolete Integer flag (0 or 1) indicating whether the matching rule is marked as OBSOLETE in the schema syntax - String contains OID of the LDAP syntax this matching rule is usable with + OID of the LDAP syntax this matching rule is usable with + (string, or None if missing) """ schema_attribute = u'matchingRules' token_defaults = { @@ -403,15 +419,15 @@ class MatchingRuleUse(SchemaElement): oid OID of the accompanying matching rule names - This list of strings contains all NAMEs of the matching rule + All NAMEs of the matching rule (tuple of strings) desc - This string contains description text (DESC) of the matching rule + Description text (DESC) of the matching rule (string, or None if missing) obsolete Integer flag (0 or 1) indicating whether the matching rule is marked as OBSOLETE in the schema applies - This list of strings contains NAMEs or OIDs of attribute types - for which this matching rule is used + NAMEs or OIDs of attribute types for which this matching rule is used + (tuple of strings) """ schema_attribute = u'matchingRuleUse' token_defaults = { @@ -449,26 +465,29 @@ class DITContentRule(SchemaElement): oid OID of the accompanying structural object class names - This list of strings contains all NAMEs of the DIT content rule + All NAMEs of the DIT content rule (tuple of strings) desc - This string contains description text (DESC) of the DIT content rule + Description text (DESC) of the DIT content rule + (string, or None if missing) obsolete Integer flag (0 or 1) indicating whether the DIT content rule is marked as OBSOLETE in the schema aux - This list of strings contains NAMEs or OIDs of all auxiliary - object classes usable in an entry of the object class + NAMEs or OIDs of all auxiliary object classes usable in an entry of the + object class (tuple of strings) must - This list of strings contains NAMEs or OIDs of all attributes - an entry of the object class must have which may extend the - list of required attributes of the object classes of an entry + NAMEs or OIDs of all attributes an entry of the object class must + have, which may extend the list of required attributes of the object + classes of an entry. + (tuple of strings) may - This list of strings contains NAMEs or OIDs of additional attributes - an entry of the object class may have which may extend the - list of optional attributes of the object classes of an entry + NAMEs or OIDs of additional attributes an entry of the object class may + have. which may extend the list of optional attributes of the object + classes of an entry. + (tuple of strings) nots - This list of strings contains NAMEs or OIDs of attributes which - may not be present in an entry of the object class + NAMEs or OIDs of attributes which may not be present in an entry of the + object class. (tuple of strings) """ schema_attribute = u'dITContentRules' token_defaults = { @@ -515,17 +534,18 @@ class DITStructureRule(SchemaElement): ruleid rule ID of the DIT structure rule (only locally unique) names - This list of strings contains all NAMEs of the DIT structure rule + All NAMEs of the DIT structure rule (tuple of strings) desc - This string contains description text (DESC) of the DIT structure rule + Description text (DESC) of the DIT structure rule + (string, or None if missing) obsolete Integer flag (0 or 1) indicating whether the DIT content rule is marked as OBSOLETE in the schema form - List of strings with NAMEs or OIDs of associated name forms + NAMEs or OIDs of associated name forms (tuple of strings) sup - List of strings with NAMEs or OIDs of allowed structural object classes - of superior entries in the DIT + NAMEs or OIDs of allowed structural object classes + of superior entries in the DIT (tuple of strings) """ schema_attribute = u'dITStructureRules' @@ -573,23 +593,22 @@ class NameForm(SchemaElement): oid OID of the name form names - This list of strings contains all NAMEs of the name form + All NAMEs of the name form (tuple of strings) desc - This string contains description text (DESC) of the name form + Description text (DESC) of the name form (string, or None if missing) obsolete Integer flag (0 or 1) indicating whether the name form is marked as OBSOLETE in the schema form - List of strings with NAMEs or OIDs of associated name forms + NAMEs or OIDs of associated name forms (tuple of strings) oc - String with NAME or OID of structural object classes this name form - is usable with + NAME or OID of structural object classes this name form + is usable with (string) must - This list of strings contains NAMEs or OIDs of all attributes - an RDN must contain + NAMEs or OIDs of all attributes an RDN must contain (tuple of strings) may - This list of strings contains NAMEs or OIDs of additional attributes - an RDN may contain + NAMEs or OIDs of additional attributes an RDN may contain + (tuple of strings) """ schema_attribute = u'nameForms' token_defaults = { diff --git a/Tests/t_ldap_schema_subentry.py b/Tests/t_ldap_schema_subentry.py index 4e1e09b2..e05c957a 100644 --- a/Tests/t_ldap_schema_subentry.py +++ b/Tests/t_ldap_schema_subentry.py @@ -15,7 +15,7 @@ import ldif from ldap.ldapobject import SimpleLDAPObject import ldap.schema -from ldap.schema.models import ObjectClass +from ldap.schema.models import ObjectClass, AttributeType from slapdtest import SlapdTestCase, requires_ldapi HERE = os.path.abspath(os.path.dirname(__file__)) @@ -61,10 +61,182 @@ def test_urlfetch_file(self): str(obj), "( 2.5.6.9 NAME 'groupOfNames' SUP top STRUCTURAL MUST cn " "MAY ( member $ businessCategory $ seeAlso $ owner $ ou $ o " - "$ description ) )" + "$ description ) X-ORIGIN 'RFC 4519' )" ) +class TestXOrigin(unittest.TestCase): + def get_attribute_type(self, oid): + openldap_uri = 'file://{}'.format(TEST_SUBSCHEMA_FILES[0]) + dn, schema = ldap.schema.urlfetch(openldap_uri) + return schema.get_obj(AttributeType, oid) + + def test_origin_none(self): + self.assertEqual( + self.get_attribute_type('2.16.840.1.113719.1.301.4.24.1').x_origin, + ()) + + def test_origin_string(self): + self.assertEqual( + self.get_attribute_type('2.16.840.1.113730.3.1.2091').x_origin, + ('Netscape',)) + + def test_origin_multi_valued(self): + self.assertEqual( + self.get_attribute_type('1.3.6.1.4.1.11.1.3.1.1.3').x_origin, + ('RFC4876', 'user defined')) + + def test_origin_none_str(self): + """Check string representation of an attribute without X-ORIGIN""" + # This should check that the representation: + # - does not contain X-ORIGIN, and + # - is still syntactically valid. + # Checking the full output makes the test simpler, + # though might need to be adjusted in the future. + self.assertEqual( + str(self.get_attribute_type('2.16.840.1.113719.1.301.4.24.1')), + ( + "( 2.16.840.1.113719.1.301.4.24.1 " + + "NAME 'krbHostServer' " + + "EQUALITY caseExactIA5Match " + + "SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )" + ), + ) + + def test_origin_string_str(self): + """Check string representation of an attr with single-value X-ORIGIN""" + # This should check that the representation: + # - has the X-ORIGIN entry 'Netscape' with no parentheses, and + # - is still syntactically valid. + # Checking the full output makes the test simpler, + # though might need to be adjusted in the future. + self.assertEqual( + str(self.get_attribute_type('2.16.840.1.113730.3.1.2091')), + ( + "( 2.16.840.1.113730.3.1.2091 " + + "NAME 'nsslapd-suffix' " + + "DESC 'Netscape defined attribute type' " + + "SYNTAX 1.3.6.1.4.1.1466.115.121.1.12 " + + "X-ORIGIN 'Netscape' )" + ), + ) + + def test_origin_multi_valued_str(self): + """Check string representation of an attr with multi-value X-ORIGIN""" + # This should check that the representation: + # - has a parenthesized X-ORIGIN entry, and + # - is still syntactically valid. + # Checking the full output makes the test simpler, + # though might need to be adjusted in the future. + self.assertEqual( + str(self.get_attribute_type('1.3.6.1.4.1.11.1.3.1.1.3')), + ( + "( 1.3.6.1.4.1.11.1.3.1.1.3 NAME 'searchTimeLimit' " + + "DESC 'Maximum time an agent or service allows for a search " + + "to complete' " + + "EQUALITY integerMatch " + + "ORDERING integerOrderingMatch " + + "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 " + + "SINGLE-VALUE " + + "X-ORIGIN ( 'RFC4876' 'user defined' ) )" + ), + ) + + def test_set_origin_str(self): + """Check that setting X-ORIGIN to a string makes entry unusable""" + attr = self.get_attribute_type('2.16.840.1.113719.1.301.4.24.1') + attr.x_origin = 'Netscape' + self.assertRaises(AssertionError, str, attr) + + def test_set_origin_list(self): + """Check that setting X-ORIGIN to a list makes entry unusable""" + attr = self.get_attribute_type('2.16.840.1.113719.1.301.4.24.1') + attr.x_origin = [] + self.assertRaises(AssertionError, str, attr) + + def test_set_origin_tuple(self): + """Check that setting X-ORIGIN to a tuple works""" + attr = self.get_attribute_type('2.16.840.1.113719.1.301.4.24.1') + attr.x_origin = ('user defined',) + self.assertIn(" X-ORIGIN 'user defined' ", str(attr)) + + +class TestAttributes(unittest.TestCase): + def get_schema(self): + openldap_uri = 'file://{}'.format(TEST_SUBSCHEMA_FILES[0]) + dn, schema = ldap.schema.urlfetch(openldap_uri) + return schema + + def test_empty_attributetype_attrs(self): + """Check types and values of attributes of a minimal AttributeType""" + # (OID 2.999 is actually "/Example", for use in documentation) + attr = AttributeType('( 2.999 )') + self.assertEqual(attr.oid, '2.999') + self.assertEqual(attr.names, ()) + self.assertEqual(attr.desc, None) + self.assertEqual(attr.obsolete, False) + self.assertEqual(attr.single_value, False) + self.assertEqual(attr.syntax, None) + self.assertEqual(attr.no_user_mod, False) + self.assertEqual(attr.equality, None) + self.assertEqual(attr.substr, None) + self.assertEqual(attr.ordering, None) + self.assertEqual(attr.usage, 0) + self.assertEqual(attr.sup, ()) + self.assertEqual(attr.x_origin, ()) + + def test_empty_objectclass_attrs(self): + """Check types and values of attributes of a minimal ObjectClass""" + # (OID 2.999 is actually "/Example", for use in documentation) + cls = ObjectClass('( 2.999 )') + self.assertEqual(cls.oid, '2.999') + self.assertEqual(cls.names, ()) + self.assertEqual(cls.desc, None) + self.assertEqual(cls.obsolete, False) + self.assertEqual(cls.must, ()) + self.assertEqual(cls.may, ()) + self.assertEqual(cls.kind, 0) + self.assertEqual(cls.sup, ('top',)) + self.assertEqual(cls.x_origin, ()) + + def test_attributetype_attrs(self): + """Check types and values of an AttributeType object's attributes""" + schema = self.get_schema() + attr = schema.get_obj(AttributeType, '1.3.6.1.4.1.11.1.3.1.1.3') + expected_desc = ( + 'Maximum time an agent or service allows for a search to complete' + ) + self.assertEqual(attr.oid, '1.3.6.1.4.1.11.1.3.1.1.3') + self.assertEqual(attr.names, ('searchTimeLimit',)) + self.assertEqual(attr.desc, expected_desc) + self.assertEqual(attr.obsolete, False) + self.assertEqual(attr.single_value, True) + self.assertEqual(attr.syntax, '1.3.6.1.4.1.1466.115.121.1.27') + self.assertEqual(attr.no_user_mod, False) + self.assertEqual(attr.equality, 'integerMatch') + self.assertEqual(attr.ordering, 'integerOrderingMatch') + self.assertEqual(attr.sup, ()) + self.assertEqual(attr.x_origin, ('RFC4876', 'user defined')) + + def test_objectclass_attrs(self): + """Check types and values of an ObjectClass object's attributes""" + schema = self.get_schema() + cls = schema.get_obj(ObjectClass, '2.5.6.9') + expected_may = ( + 'member', 'businessCategory', 'seeAlso', 'owner', 'ou', 'o', + 'description', + ) + self.assertEqual(cls.oid, '2.5.6.9') + self.assertEqual(cls.names, ('groupOfNames',)) + self.assertEqual(cls.desc, None) + self.assertEqual(cls.obsolete, False) + self.assertEqual(cls.must, ('cn',)) + self.assertEqual(cls.may, expected_may) + self.assertEqual(cls.kind, 0) + self.assertEqual(cls.sup, ('top',)) + self.assertEqual(cls.x_origin, ('RFC 4519',)) + + class TestSubschemaUrlfetchSlapd(SlapdTestCase): ldap_object_class = SimpleLDAPObject pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy