ldaptor.protocols.ldap package¶

Subpackages¶

ldaptor.protocols.ldap.autofill package

Submodules¶

ldaptor.protocols.ldap.distinguishedname module¶

class ldaptor.protocols.ldap.distinguishedname.DistinguishedName(magic=None, stringValue=None, listOfRDNs=None)[source]¶

Bases: TextStrAlias

LDAP Distinguished Name.

contains(other)[source]¶: Does the tree rooted at DN contain or equal the other DN.

getDomainName()[source]¶

getText()[source]¶

listOfRDNs = None¶

split()[source]¶

up()[source]¶

exception ldaptor.protocols.ldap.distinguishedname.InvalidRelativeDistinguishedName(rdn)[source]¶

Bases: Exception

Invalid relative distinguished name. It is assumed that passed RDN is of str type: bytes for PY2 and unicode for PY3.

class ldaptor.protocols.ldap.distinguishedname.LDAPAttributeTypeAndValue(stringValue=None, attributeType=None, value=None)[source]¶

Bases: TextStrAlias

attributeType = None¶

getText()[source]¶

value = None¶

class ldaptor.protocols.ldap.distinguishedname.RelativeDistinguishedName(magic=None, stringValue=None, attributeTypesAndValues=None)[source]¶

Bases: TextStrAlias

LDAP Relative Distinguished Name.

attributeTypesAndValues = None¶

count()[source]¶

getText()[source]¶

split()[source]¶

ldaptor.protocols.ldap.distinguishedname.escape(s)[source]¶

ldaptor.protocols.ldap.distinguishedname.unescape(s)[source]¶

ldaptor.protocols.ldap.fetchschema module¶

ldaptor.protocols.ldap.fetchschema.fetch(client, baseObject)[source]¶

ldaptor.protocols.ldap.ldapclient module¶

LDAP protocol client

class ldaptor.protocols.ldap.ldapclient.LDAPClient[source]¶

Bases: Protocol

An LDAP client

berdecoder = <LDAPBERDecoderContext_TopLevel identities={0x10: LDAPMessage} fallback=None inherit=<LDAPBERDecoderContext_LDAPMessage identities={0x80: LDAPControls, 0x53: LDAPSearchResultReference} fallback=<LDAPBERDecoderContext identities={0x41: LDAPBindResponse, 0x40: LDAPBindRequest, 0x42: LDAPUnbindRequest, 0x43: LDAPSearchRequest, 0x44: LDAPSearchResultEntry, 0x45: LDAPSearchResultDone, 0x53: LDAPSearchResultReference, 0x83: LDAPReferral, 0x46: LDAPModifyRequest, 0x47: LDAPModifyResponse, 0x48: LDAPAddRequest, 0x49: LDAPAddResponse, 0x4a: LDAPDelRequest, 0x4b: LDAPDelResponse, 0x57: LDAPExtendedRequest, 0x58: LDAPExtendedResponse, 0x4c: LDAPModifyDNRequest, 0x4d: LDAPModifyDNResponse, 0x50: LDAPAbandonRequest, 0x4e: LDAPCompareRequest, 0x4f: LDAPCompareResponse} fallback=<BERDecoderContext identities={0x01: BERBoolean, 0x02: BERInteger, 0x04: BEROctetString, 0x05: BERNull, 0x0a: BEREnumerated, 0x10: BERSequence, 0x11: BERSet} fallback=None inherit=None> inherit=None> inherit=<LDAPBERDecoderContext identities={0x41: LDAPBindResponse, 0x40: LDAPBindRequest, 0x42: LDAPUnbindRequest, 0x43: LDAPSearchRequest, 0x44: LDAPSearchResultEntry, 0x45: LDAPSearchResultDone, 0x53: LDAPSearchResultReference, 0x83: LDAPReferral, 0x46: LDAPModifyRequest, 0x47: LDAPModifyResponse, 0x48: LDAPAddRequest, 0x49: LDAPAddResponse, 0x4a: LDAPDelRequest, 0x4b: LDAPDelResponse, 0x57: LDAPExtendedRequest, 0x58: LDAPExtendedResponse, 0x4c: LDAPModifyDNRequest, 0x4d: LDAPModifyDNResponse, 0x50: LDAPAbandonRequest, 0x4e: LDAPCompareRequest, 0x4f: LDAPCompareResponse} fallback=<BERDecoderContext identities={0x01: BERBoolean, 0x02: BERInteger, 0x04: BEROctetString, 0x05: BERNull, 0x0a: BEREnumerated, 0x10: BERSequence, 0x11: BERSet} fallback=None inherit=None> inherit=None>>>¶

bind(dn='', auth='')[source]¶

@depreciated: Use e.bind(auth).

@todo: Remove this method when there are no callers.

connectionLost(reason=<twisted.python.failure.Failure twisted.internet.error.ConnectionDone: Connection was closed cleanly.>)[source]¶: Called when TCP connection has been lost

connectionMade()[source]¶: TCP connection has opened

dataReceived(recd)[source]¶

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

@param data: a string of indeterminate length. Please keep in mind: that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

debug = False¶

handle(msg)[source]¶

notifyOnDisconnect()[source]¶: Return a Deferred that fires with the disconnect reason once the transport has actually been closed. Useful for waiting on a clean TLS shutdown after unbind() (#225).

send(op, controls=None)[source]¶: Send an LDAP operation to the server. @param op: the operation to send @type op: LDAPProtocolRequest @param controls: Any controls to be included in the request. @type controls: LDAPControls @return: the response from server @rtype: Deferred LDAPProtocolResponse

send_multiResponse(op, handler, *args, **kwargs)[source]¶

Send an LDAP operation to the server, expecting one or more responses.

If handler is provided, it will receive a LDAP response as its first argument. The Deferred returned by this function will fire with a result of None when the handler returns True to indicate the final response has been handled.

If handler is not provided, the Deferred returned by this function will fire with the first LDAP response.

@param op: the operation to send @type op: LDAPProtocolRequest @param handler: a callable that will be called for each response. It should return a boolean, whether this was the final response. @param args: positional arguments to pass to handler @param kwargs: keyword arguments to pass to handler @return: the result from the first handler as a deferred that completes when the first response has been received @rtype: Deferred LDAPProtocolResponse

send_multiResponse_ex(op, controls=None, handler=None, *args, **kwargs)[source]¶

Send an LDAP operation to the server, expecting one or more responses.

If handler is provided, it will receive an LDAP response and response controls as its first 2 arguments. The Deferred returned by this function will fire with a result of None when the handler returns True to indicate the final response has been handled.

If handler is not provided, the Deferred returned by this function will fire with a tuple of the first LDAP response and any associated response controls.

@param op: the operation to send @type op: LDAPProtocolRequest @param controls: LDAP controls to send with the message. @type controls: LDAPControls @param handler: a callable that will be called for each response. It should return a boolean, whether this was the final response. @param args: positional arguments to pass to handler @param kwargs: keyword arguments to pass to handler @return: the result from the last handler as a deferred that completes when the last response has been received @rtype: Deferred LDAPProtocolResponse

send_noResponse(op, controls=None)[source]¶

Send an LDAP operation to the server, with no response expected.

@param op: the operation to send @type op: LDAPProtocolRequest

startTLS(ctx=None)[source]¶

Start Transport Layer Security.

It is the callers responsibility to make sure other things are not happening at the same time.

@todo: server hostname check, see rfc2830 section 3.6. @return: a deferred that will complete when the TLS handshake is complete.

unbind()[source]¶

Send an LDAP unbind and close the connection.

Returns a Deferred that fires with the connection-lost reason once the transport has actually closed. Callers that don’t need to wait can ignore the return value; callers that do (e.g. cleanup after a TLS shutdown) can chain on it.

unsolicitedNotification(msg)[source]¶

exception ldaptor.protocols.ldap.ldapclient.LDAPClientConnectionLostException(message=None)[source]¶

ldaptor.protocols.ldap package¶

Subpackages¶

Submodules¶

ldaptor.protocols.ldap.distinguishedname module¶

ldaptor.protocols.ldap.fetchschema module¶

ldaptor.protocols.ldap.ldapclient module¶

ldaptor.protocols.ldap.ldapconnector module¶

ldaptor.protocols.ldap.ldaperrors module¶

ldaptor.protocols.ldap.ldapserver module¶

ldaptor.protocols.ldap.ldapsyntax module¶

ldaptor.protocols.ldap.ldif module¶

ldaptor.protocols.ldap.ldifdelta module¶

ldaptor.protocols.ldap.ldifprotocol module¶

ldaptor.protocols.ldap.proxy module¶

ldaptor.protocols.ldap.svcbindproxy module¶

Module contents¶