140 lines
5.1 KiB
Python
140 lines
5.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
ldap.controls.vlv - classes for Virtual List View
|
|
(see draft-ietf-ldapext-ldapv3-vlv)
|
|
|
|
See http://www.python-ldap.org/ for project details.
|
|
|
|
$Id: vlv.py,v 1.3 2015/07/07 12:46:31 stroeder Exp $
|
|
"""
|
|
|
|
__all__ = [
|
|
'VLVRequestControl',
|
|
'VLVResponseControl',
|
|
]
|
|
|
|
import ldap
|
|
from ldap.ldapobject import LDAPObject
|
|
from ldap.controls import (RequestControl, ResponseControl,
|
|
KNOWN_RESPONSE_CONTROLS, DecodeControlTuples)
|
|
|
|
from pyasn1.type import univ, namedtype, tag, namedval, constraint
|
|
from pyasn1.codec.ber import encoder, decoder
|
|
|
|
|
|
class ByOffsetType(univ.Sequence):
|
|
tagSet = univ.Sequence.tagSet.tagImplicitly(
|
|
tag.Tag(tag.tagClassContext, tag.tagFormatSimple, 0))
|
|
componentType = namedtype.NamedTypes(
|
|
namedtype.NamedType('offset', univ.Integer()),
|
|
namedtype.NamedType('contentCount', univ.Integer()))
|
|
|
|
|
|
class TargetType(univ.Choice):
|
|
componentType = namedtype.NamedTypes(
|
|
namedtype.NamedType('byOffset', ByOffsetType()),
|
|
namedtype.NamedType('greaterThanOrEqual', univ.OctetString().subtype(
|
|
implicitTag=tag.Tag(tag.tagClassContext,
|
|
tag.tagFormatSimple, 1))))
|
|
|
|
|
|
class VirtualListViewRequestType(univ.Sequence):
|
|
componentType = namedtype.NamedTypes(
|
|
namedtype.NamedType('beforeCount', univ.Integer()),
|
|
namedtype.NamedType('afterCount', univ.Integer()),
|
|
namedtype.NamedType('target', TargetType()),
|
|
namedtype.OptionalNamedType('contextID', univ.OctetString()))
|
|
|
|
|
|
class VLVRequestControl(RequestControl):
|
|
controlType = '2.16.840.1.113730.3.4.9'
|
|
|
|
def __init__(
|
|
self,
|
|
criticality=False,
|
|
before_count=0,
|
|
after_count=0,
|
|
offset=None,
|
|
content_count=None,
|
|
greater_than_or_equal=None,
|
|
context_id=None,
|
|
):
|
|
RequestControl.__init__(self,self.controlType,criticality)
|
|
assert (offset is not None and content_count is not None) or \
|
|
greater_than_or_equal, \
|
|
ValueError(
|
|
'offset and content_count must be set together or greater_than_or_equal must be used'
|
|
)
|
|
self.before_count = before_count
|
|
self.after_count = after_count
|
|
self.offset = offset
|
|
self.content_count = content_count
|
|
self.greater_than_or_equal = greater_than_or_equal
|
|
self.context_id = context_id
|
|
|
|
def encodeControlValue(self):
|
|
p = VirtualListViewRequestType()
|
|
p.setComponentByName('beforeCount', self.before_count)
|
|
p.setComponentByName('afterCount', self.after_count)
|
|
if self.offset is not None and self.content_count is not None:
|
|
by_offset = ByOffsetType()
|
|
by_offset.setComponentByName('offset', self.offset)
|
|
by_offset.setComponentByName('contentCount', self.content_count)
|
|
target = TargetType()
|
|
target.setComponentByName('byOffset', by_offset)
|
|
elif self.greater_than_or_equal:
|
|
target = TargetType()
|
|
target.setComponentByName('greaterThanOrEqual',
|
|
self.greater_than_or_equal)
|
|
else:
|
|
raise NotImplementedError
|
|
p.setComponentByName('target', target)
|
|
return encoder.encode(p)
|
|
|
|
KNOWN_RESPONSE_CONTROLS[VLVRequestControl.controlType] = VLVRequestControl
|
|
|
|
|
|
class VirtualListViewResultType(univ.Enumerated):
|
|
namedValues = namedval.NamedValues(
|
|
('success', 0),
|
|
('operationsError', 1),
|
|
('protocolError', 3),
|
|
('unwillingToPerform', 53),
|
|
('insufficientAccessRights', 50),
|
|
('adminLimitExceeded', 11),
|
|
('innapropriateMatching', 18),
|
|
('sortControlMissing', 60),
|
|
('offsetRangeError', 61),
|
|
('other', 80),
|
|
)
|
|
|
|
|
|
class VirtualListViewResponseType(univ.Sequence):
|
|
componentType = namedtype.NamedTypes(
|
|
namedtype.NamedType('targetPosition', univ.Integer()),
|
|
namedtype.NamedType('contentCount', univ.Integer()),
|
|
namedtype.NamedType('virtualListViewResult',
|
|
VirtualListViewResultType()),
|
|
namedtype.OptionalNamedType('contextID', univ.OctetString()))
|
|
|
|
|
|
class VLVResponseControl(ResponseControl):
|
|
controlType = '2.16.840.1.113730.3.4.10'
|
|
|
|
def __init__(self,criticality=False):
|
|
ResponseControl.__init__(self,self.controlType,criticality)
|
|
|
|
def decodeControlValue(self,encoded):
|
|
p, rest = decoder.decode(encoded, asn1Spec=VirtualListViewResponseType())
|
|
assert not rest, 'all data could not be decoded'
|
|
self.target_position = int(p.getComponentByName('targetPosition'))
|
|
self.content_count = int(p.getComponentByName('contentCount'))
|
|
self.result = int(p.getComponentByName('virtualListViewResult'))
|
|
self.result_code = p.getComponentByName('virtualListViewResult') \
|
|
.prettyOut(self.result)
|
|
self.context_id = p.getComponentByName('contextID')
|
|
if self.context_id:
|
|
self.context_id = str(self.context_id)
|
|
|
|
KNOWN_RESPONSE_CONTROLS[VLVResponseControl.controlType] = VLVResponseControl
|