Control and extop rework

mistotebe · mistotebe · commit a4e590894c2a · 2022-04-06T13:15:12.000+01:00
diff --git a/Lib/ldap/__init__.py b/Lib/ldap/__init__.py
@@ -43,6 +43,12 @@
   if k.startswith('OPT_'):
     OPT_NAMES_DICT[v]=k
 
+# OID to class registries
+KNOWN_RESPONSE_CONTROLS = {}
+KNOWN_INTERMEDIATE_RESPONSES = {}
+KNOWN_EXTENDED_RESPONSES = {}
+
+
 class DummyLock:
   """Define dummy class with methods compatible to threading.Lock"""
   def __init__(self):
diff --git a/Lib/ldap/controls/__init__.py b/Lib/ldap/controls/__init__.py
@@ -15,12 +15,12 @@
        ImportError(f'ldap {__version__} and _ldap {_ldap.__version__} version mismatch!')
 
 import ldap
+from ldap import KNOWN_RESPONSE_CONTROLS
 
 from pyasn1.error import PyAsn1Error
 
 
 __all__ = [
-  'KNOWN_RESPONSE_CONTROLS',
   # Classes
   'AssertionControl',
   'BooleanControl',
@@ -37,9 +37,6 @@
   'DecodeControlTuples',
 ]
 
-# response control OID to class registry
-KNOWN_RESPONSE_CONTROLS = {}
-
 
 class RequestControl:
   """
@@ -77,6 +74,12 @@ class ResponseControl:
       sets the criticality of the received control (boolean)
   """
 
+  def __init_subclass__(cls):
+    if not getattr(cls, 'controlType', None):
+      return
+
+    KNOWN_RESPONSE_CONTROLS.setdefault(cls.controlType, cls)
+
   def __init__(self,controlType=None,criticality=False):
     self.controlType = controlType
     self.criticality = criticality
diff --git a/Lib/ldap/controls/deref.py b/Lib/ldap/controls/deref.py
@@ -11,7 +11,7 @@
 ]
 
 import ldap.controls
-from ldap.controls import LDAPControl,KNOWN_RESPONSE_CONTROLS
+from ldap.controls import LDAPControl
 
 import pyasn1_modules.rfc2251
 from pyasn1.type import namedtype,univ,tag
@@ -114,5 +114,3 @@ def decodeControlValue(self,encodedControlValue):
         self.derefRes[str(deref_attr)].append((str(deref_val),partial_attrs_dict))
       except KeyError:
         self.derefRes[str(deref_attr)] = [(str(deref_val),partial_attrs_dict)]
-
-KNOWN_RESPONSE_CONTROLS[DereferenceControl.controlType] = DereferenceControl
diff --git a/Lib/ldap/controls/libldap.py b/Lib/ldap/controls/libldap.py
@@ -13,7 +13,7 @@
 
 import ldap
 
-from ldap.controls import RequestControl,LDAPControl,KNOWN_RESPONSE_CONTROLS
+from ldap.controls import RequestControl,LDAPControl
 
 
 class AssertionControl(RequestControl):
@@ -33,8 +33,6 @@ def __init__(self,criticality=True,filterstr='(objectClass=*)'):
   def encodeControlValue(self):
     return _ldap.encode_assertion_control(self.filterstr)
 
-KNOWN_RESPONSE_CONTROLS[ldap.CONTROL_ASSERT] = AssertionControl
-
 
 class MatchedValuesControl(RequestControl):
   """
@@ -54,8 +52,6 @@ def __init__(self,criticality=False,filterstr='(objectClass=*)'):
   def encodeControlValue(self):
     return _ldap.encode_valuesreturnfilter_control(self.filterstr)
 
-KNOWN_RESPONSE_CONTROLS[ldap.CONTROL_VALUESRETURNFILTER] = MatchedValuesControl
-
 
 class SimplePagedResultsControl(LDAPControl):
   """
@@ -77,5 +73,3 @@ def encodeControlValue(self):
 
   def decodeControlValue(self,encodedControlValue):
     self.size,self.cookie = _ldap.decode_page_control(encodedControlValue)
-
-KNOWN_RESPONSE_CONTROLS[ldap.CONTROL_PAGEDRESULTS] = SimplePagedResultsControl
diff --git a/Lib/ldap/controls/openldap.py b/Lib/ldap/controls/openldap.py
@@ -39,9 +39,6 @@ def decodeControlValue(self,encodedControlValue):
     self.numSearchContinuations = int(decodedValue[2])
 
 
-ldap.controls.KNOWN_RESPONSE_CONTROLS[SearchNoOpControl.controlType] = SearchNoOpControl
-
-
 class SearchNoOpMixIn:
   """
   Mix-in class to be used with class LDAPObject and friends.
diff --git a/Lib/ldap/controls/pagedresults.py b/Lib/ldap/controls/pagedresults.py
@@ -11,7 +11,7 @@
 
 # Imports from python-ldap 2.4+
 import ldap.controls
-from ldap.controls import RequestControl,ResponseControl,KNOWN_RESPONSE_CONTROLS
+from ldap.controls import RequestControl,ResponseControl
 
 # Imports from pyasn1
 from pyasn1.type import tag,namedtype,univ,constraint
@@ -44,6 +44,3 @@ def decodeControlValue(self,encodedControlValue):
     decodedValue,_ = decoder.decode(encodedControlValue,asn1Spec=PagedResultsControlValue())
     self.size = int(decodedValue.getComponentByName('size'))
     self.cookie = bytes(decodedValue.getComponentByName('cookie'))
-
-
-KNOWN_RESPONSE_CONTROLS[SimplePagedResultsControl.controlType] = SimplePagedResultsControl
diff --git a/Lib/ldap/controls/ppolicy.py b/Lib/ldap/controls/ppolicy.py
@@ -11,7 +11,7 @@
 
 # Imports from python-ldap 2.4+
 from ldap.controls import (
-  ResponseControl, ValueLessRequestControl, KNOWN_RESPONSE_CONTROLS
+  ResponseControl, ValueLessRequestControl
 )
 
 # Imports from pyasn1
@@ -99,6 +99,3 @@ def decodeControlValue(self,encodedControlValue):
     error = ppolicyValue.getComponentByName('error')
     if error.hasValue():
       self.error = int(error)
-
-
-KNOWN_RESPONSE_CONTROLS[PasswordPolicyControl.controlType] = PasswordPolicyControl
diff --git a/Lib/ldap/controls/psearch.py b/Lib/ldap/controls/psearch.py
@@ -14,7 +14,7 @@
 
 # Imports from python-ldap 2.4+
 import ldap.controls
-from ldap.controls import RequestControl,ResponseControl,KNOWN_RESPONSE_CONTROLS
+from ldap.controls import RequestControl,ResponseControl
 
 # Imports from pyasn1
 from pyasn1.type import namedtype,namedval,univ,constraint
@@ -125,5 +125,3 @@ def decodeControlValue(self,encodedControlValue):
     else:
       self.changeNumber = None
     return (self.changeType,self.previousDN,self.changeNumber)
-
-KNOWN_RESPONSE_CONTROLS[EntryChangeNotificationControl.controlType] = EntryChangeNotificationControl
diff --git a/Lib/ldap/controls/pwdpolicy.py b/Lib/ldap/controls/pwdpolicy.py
@@ -12,7 +12,7 @@
 
 # Imports from python-ldap 2.4+
 import ldap.controls
-from ldap.controls import RequestControl,ResponseControl,ValueLessRequestControl,KNOWN_RESPONSE_CONTROLS
+from ldap.controls import ResponseControl
 
 
 class PasswordExpiringControl(ResponseControl):
@@ -24,8 +24,6 @@ class PasswordExpiringControl(ResponseControl):
   def decodeControlValue(self,encodedControlValue):
     self.gracePeriod = int(encodedControlValue)
 
-KNOWN_RESPONSE_CONTROLS[PasswordExpiringControl.controlType] = PasswordExpiringControl
-
 
 class PasswordExpiredControl(ResponseControl):
   """
@@ -35,5 +33,3 @@ class PasswordExpiredControl(ResponseControl):
 
   def decodeControlValue(self,encodedControlValue):
     self.passwordExpired = encodedControlValue=='0'
-
-KNOWN_RESPONSE_CONTROLS[PasswordExpiredControl.controlType] = PasswordExpiredControl
diff --git a/Lib/ldap/controls/readentry.py b/Lib/ldap/controls/readentry.py
@@ -8,7 +8,7 @@
 import ldap
 
 from pyasn1.codec.ber import encoder,decoder
-from ldap.controls import LDAPControl,KNOWN_RESPONSE_CONTROLS
+from ldap.controls import LDAPControl
 
 from pyasn1_modules.rfc2251 import AttributeDescriptionList,SearchResultEntry
 
@@ -63,8 +63,6 @@ class PreReadControl(ReadEntryControl):
   """
   controlType = ldap.CONTROL_PRE_READ
 
-KNOWN_RESPONSE_CONTROLS[PreReadControl.controlType] = PreReadControl
-
 
 class PostReadControl(ReadEntryControl):
   """
@@ -83,5 +81,3 @@ class PostReadControl(ReadEntryControl):
       after the operation was done by the server
   """
   controlType = ldap.CONTROL_POST_READ
-
-KNOWN_RESPONSE_CONTROLS[PostReadControl.controlType] = PostReadControl
diff --git a/Lib/ldap/controls/simple.py b/Lib/ldap/controls/simple.py
@@ -5,7 +5,7 @@
 """
 
 import struct,ldap
-from ldap.controls import RequestControl,ResponseControl,LDAPControl,KNOWN_RESPONSE_CONTROLS
+from ldap.controls import RequestControl,ResponseControl
 
 from pyasn1.type import univ
 from pyasn1.codec.ber import encoder,decoder
@@ -31,7 +31,7 @@ def encodeControlValue(self):
     return None
 
 
-class OctetStringInteger(LDAPControl):
+class OctetStringInteger:
   """
   Base class with controlValue being unsigend integer values
 
@@ -51,7 +51,7 @@ def decodeControlValue(self,encodedControlValue):
     self.integerValue = struct.unpack('!Q',encodedControlValue)[0]
 
 
-class BooleanControl(LDAPControl):
+class BooleanControl:
   """
   Base class for simple request controls with boolean control value.
 
@@ -82,8 +82,6 @@ class ManageDSAITControl(ValueLessRequestControl):
   def __init__(self,criticality=False):
     ValueLessRequestControl.__init__(self,ldap.CONTROL_MANAGEDSAIT,criticality=False)
 
-KNOWN_RESPONSE_CONTROLS[ldap.CONTROL_MANAGEDSAIT] = ManageDSAITControl
-
 
 class RelaxRulesControl(ValueLessRequestControl):
   """
@@ -93,8 +91,6 @@ class RelaxRulesControl(ValueLessRequestControl):
   def __init__(self,criticality=False):
     ValueLessRequestControl.__init__(self,ldap.CONTROL_RELAX,criticality=False)
 
-KNOWN_RESPONSE_CONTROLS[ldap.CONTROL_RELAX] = RelaxRulesControl
-
 
 class ProxyAuthzControl(RequestControl):
   """
@@ -134,9 +130,6 @@ def decodeControlValue(self,encodedControlValue):
     self.authzId = encodedControlValue
 
 
-KNOWN_RESPONSE_CONTROLS[AuthorizationIdentityResponseControl.controlType] = AuthorizationIdentityResponseControl
-
-
 class GetEffectiveRightsControl(RequestControl):
   """
   Get Effective Rights Control
diff --git a/Lib/ldap/controls/sss.py b/Lib/ldap/controls/sss.py
@@ -14,9 +14,7 @@
 import sys
 
 import ldap
-from ldap.ldapobject import LDAPObject
-from ldap.controls import (RequestControl, ResponseControl,
-        KNOWN_RESPONSE_CONTROLS, DecodeControlTuples)
+from ldap.controls import RequestControl, ResponseControl
 
 from pyasn1.type import univ, namedtype, tag, namedval, constraint
 from pyasn1.codec.ber import encoder, decoder
@@ -130,5 +128,3 @@ def decodeControlValue(self, encoded):
         # backward compatibility class attributes
         self.result = self.sortResult
         self.attribute_type_error = self.attributeType
-
-KNOWN_RESPONSE_CONTROLS[SSSResponseControl.controlType] = SSSResponseControl
diff --git a/Lib/ldap/controls/vlv.py b/Lib/ldap/controls/vlv.py
@@ -12,8 +12,7 @@
 
 import ldap
 from ldap.ldapobject import LDAPObject
-from ldap.controls import (RequestControl, ResponseControl,
-        KNOWN_RESPONSE_CONTROLS, DecodeControlTuples)
+from ldap.controls import RequestControl, ResponseControl
 
 from pyasn1.type import univ, namedtype, tag, namedval, constraint
 from pyasn1.codec.ber import encoder, decoder
@@ -88,8 +87,6 @@ def encodeControlValue(self):
         p.setComponentByName('target', target)
         return encoder.encode(p)
 
-KNOWN_RESPONSE_CONTROLS[VLVRequestControl.controlType] = VLVRequestControl
-
 
 class VirtualListViewResultType(univ.Enumerated):
     namedValues = namedval.NamedValues(
@@ -138,5 +135,3 @@ def decodeControlValue(self,encoded):
         self.content_count = self.contentCount
         self.result = self.virtualListViewResult
         self.context_id = self.contextID
-
-KNOWN_RESPONSE_CONTROLS[VLVResponseControl.controlType] = VLVResponseControl
diff --git a/Lib/ldap/extop/__init__.py b/Lib/ldap/extop/__init__.py
@@ -10,6 +10,7 @@
 """
 
 from ldap import __version__
+from ldap import KNOWN_EXTENDED_RESPONSES, KNOWN_INTERMEDIATE_RESPONSES
 
 
 class ExtendedRequest:
@@ -42,12 +43,49 @@ class ExtendedResponse:
   """
   Generic base class for a LDAPv3 extended operation response
 
-  requestName
-      OID as string of the LDAPv3 extended operation response
+  responseName
+      OID as string of the LDAPv3 extended operation response or None
   encodedResponseValue
       BER-encoded ASN.1 value of the LDAPv3 extended operation response
   """
 
+  def __init_subclass__(cls):
+    if not getattr(cls, 'responseName', None):
+      return
+
+    KNOWN_EXTENDED_RESPONSES.setdefault(cls.responseName, cls)
+
+  def __init__(self,responseName,encodedResponseValue):
+    self.responseName = responseName
+    self.responseValue = self.decodeResponseValue(encodedResponseValue)
+
+  def __repr__(self):
+    return f'{self.__class__.__name__}({self.responseName},{self.responseValue})'
+
+  def decodeResponseValue(self,value):
+    """
+    decodes the BER-encoded ASN.1 extended operation response value and
+    sets the appropriate class attributes
+    """
+    return value
+
+
+class IntermediateResponse:
+  """
+  Generic base class for a LDAPv3 intermediate response message
+
+  responseName
+      OID as string of the LDAPv3 intermediate response message or None
+  encodedResponseValue
+      BER-encoded ASN.1 value of the LDAPv3 intermediate response message
+  """
+
+  def __init_subclass__(cls):
+    if not getattr(cls, 'responseName', None):
+      return
+
+    KNOWN_INTERMEDIATE_RESPONSES.setdefault(cls.responseName, cls)
+
   def __init__(self,responseName,encodedResponseValue):
     self.responseName = responseName
     self.responseValue = self.decodeResponseValue(encodedResponseValue)
diff --git a/Lib/ldap/syncrepl.py b/Lib/ldap/syncrepl.py
@@ -11,7 +11,7 @@
 from pyasn1.codec.ber import encoder, decoder
 
 from ldap.pkginfo import __version__, __author__, __license__
-from ldap.controls import RequestControl, ResponseControl, KNOWN_RESPONSE_CONTROLS
+from ldap.controls import RequestControl, ResponseControl
 
 __all__ = [
     'SyncreplConsumer',
@@ -158,8 +158,6 @@ def decodeControlValue(self, encodedControlValue):
         self.state = self.__class__.opnames[int(state)]
         self.entryUUID = str(uuid)
 
-KNOWN_RESPONSE_CONTROLS[SyncStateControl.controlType] = SyncStateControl
-
 
 class SyncDoneValue(univ.Sequence):
     """
@@ -199,8 +197,6 @@ def decodeControlValue(self, encodedControlValue):
         else:
             self.refreshDeletes = None
 
-KNOWN_RESPONSE_CONTROLS[SyncDoneControl.controlType] = SyncDoneControl
-
 
 class RefreshDelete(univ.Sequence):
     """
