Skip to content

Add support for X-ORIGIN in schema element class ObjectClass #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 7, 2019
Merged

Add support for X-ORIGIN in schema element class ObjectClass #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7c22697
Add support for X-ORIGIN in schema element class ObjectClass
droideck Oct 8, 2018
ebc12da
Add a test for X-ORIGIN
encukou Oct 25, 2018
9f5a578
Add docstrings for X-ORIGIN
droideck Nov 5, 2018
7d1359c
Add multi-value support to X-ORIGIN attribute
droideck Nov 26, 2018
cd35f1c
Test the stringification of X-ORIGIN in schema attributes
encukou Jan 4, 2019
c186345
Test behavior of setting x_origin
encukou Jan 4, 2019
2dc4ebd
Fix x_origin (not x-origin) attribute name in docs
encukou Jan 4, 2019
7b76b00
Fix and reword docs of schema elements
encukou Jan 4, 2019
9c48d3e
Test types and values of ObjectClass and AttributeType attributes
encukou Jan 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 77 additions & 58 deletions Lib/ldap/schema/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand All @@ -137,7 +143,8 @@ class ObjectClass(SchemaElement):
'AUXILIARY':None,
'ABSTRACT':None,
'MUST':(()),
'MAY':()
'MAY':(),
'X-ORIGIN':()
}

def _set_attrs(self,l,d):
Expand All @@ -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:
Expand All @@ -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)


Expand All @@ -190,40 +199,46 @@ 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
single_value
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
1 = directoryOperation,
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 = {
Expand All @@ -239,7 +254,7 @@ class AttributeType(SchemaElement):
'COLLECTIVE':None,
'NO-USER-MODIFICATION':None,
'USAGE':('userApplications',),
'X-ORIGIN':(None,),
'X-ORIGIN':(),
'X-ORDERED':(None,),
}

Expand All @@ -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]
Expand Down Expand Up @@ -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)

Expand All @@ -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)
Expand Down Expand Up @@ -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 = {
Expand Down Expand Up @@ -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 = {
Expand Down Expand Up @@ -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 = {
Expand Down Expand Up @@ -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'

Expand Down Expand Up @@ -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 = {
Expand Down
Loading