ldap3.utils package

Submodules

ldap3.utils.asn1 module

class ldap3.utils.asn1.LDAPBooleanEncoder[source]

Bases: pyasn1.codec.ber.encoder.AbstractItemEncoder

encodeValue(value, asn1Spec, encodeFun, **options)[source]
supportIndefLenMode = False
ldap3.utils.asn1.compute_ber_size(data)[source]

Compute size according to BER definite length rules Returns size of value and value offset

ldap3.utils.asn1.decode_bind_response(message, start, stop, context_decoders=None)[source]
ldap3.utils.asn1.decode_boolean(message, start, stop, context_decoders=None)[source]
ldap3.utils.asn1.decode_controls(message, start, stop, context_decoders=None)[source]
ldap3.utils.asn1.decode_extended_response(message, start, stop, context_decoders=None)[source]
ldap3.utils.asn1.decode_integer(message, start, stop, context_decoders=None)[source]
ldap3.utils.asn1.decode_intermediate_response(message, start, stop, context_decoders=None)[source]
ldap3.utils.asn1.decode_message_fast(message)[source]
ldap3.utils.asn1.decode_octet_string(message, start, stop, context_decoders=None)[source]
ldap3.utils.asn1.decode_sequence(message, start, stop, context_decoders=None)[source]
ldap3.utils.asn1.get_byte(x)[source]
ldap3.utils.asn1.get_bytes(x)[source]
ldap3.utils.asn1.ldap_result_to_dict_fast(response)[source]

ldap3.utils.ciDict module

class ldap3.utils.ciDict.CaseInsensitiveDict(other=None, **kwargs)[source]

Bases: _abcoll.MutableMapping

copy()[source]
items()[source]
keys()[source]
values()[source]
class ldap3.utils.ciDict.CaseInsensitiveWithAliasDict(other=None, **kwargs)[source]

Bases: ldap3.utils.ciDict.CaseInsensitiveDict

aliases()[source]
copy()[source]
remove_alias(alias)[source]
set_alias(key, alias)[source]

ldap3.utils.config module

ldap3.utils.config.get_config_parameter(parameter)[source]
ldap3.utils.config.set_config_parameter(parameter, value)[source]

ldap3.utils.conv module

ldap3.utils.conv.check_json_dict(json_dict)[source]
ldap3.utils.conv.escape_bytes(bytes_value)[source]

Convert a byte sequence to a properly escaped for LDAP (format BACKSLASH HEX HEX) string

ldap3.utils.conv.escape_filter_chars(text, encoding=None)[source]

Escape chars mentioned in RFC4515.

ldap3.utils.conv.format_json(obj)[source]
ldap3.utils.conv.is_filter_escaped(text)[source]
ldap3.utils.conv.json_encode_b64(obj)[source]
ldap3.utils.conv.json_hook(obj)[source]
ldap3.utils.conv.ldap_escape_to_bytes(text)[source]
ldap3.utils.conv.prepare_for_stream(value)[source]
ldap3.utils.conv.to_raw(obj, encoding='utf-8')[source]

Tries to convert to raw bytes from unicode

ldap3.utils.conv.to_unicode(obj, encoding=None, from_server=False)[source]

Try to convert bytes (and str in python2) to unicode. Return object unmodified if python3 string, else raise an exception

ldap3.utils.conv.unescape_filter_chars(text, encoding=None)[source]

unescape chars mentioned in RFC4515.

ldap3.utils.dn module

ldap3.utils.dn.escape_rdn(rdn)[source]

Escape rdn characters to prevent injection according to RFC 4514.

ldap3.utils.dn.parse_dn(dn, escape=False, strip=True)[source]
ldap3.utils.dn.safe_dn(dn, decompose=False, reverse=False)[source]

normalize and escape a dn, if dn is a sequence it is joined. the reverse parameter changes the join direction of the sequence

ldap3.utils.dn.safe_rdn(dn, decompose=False)[source]

Returns a list of rdn for the dn, usually there is only one rdn, but it can be more than one when the + sign is used

ldap3.utils.dn.to_dn(iterator, decompose=False, remove_space=False, space_around_equal=False, separate_rdn=False)[source]

Convert an iterator to a list of dn parts if decompose=True return a list of tuple (one for each dn component) else return a list of strings if remove_space=True removes unneeded spaces if space_around_equal=True add spaces around equal in returned strings if separate_rdn=True consider multiple RDNs as different component of DN

ldap3.utils.hashed module

ldap3.utils.hashed.hashed(algorithm, value, salt=None, raw=False, encoding='utf-8')[source]

ldap3.utils.log module

ldap3.utils.log.format_ldap_message(message, prefix)[source]
ldap3.utils.log.get_detail_level_name(level_name)[source]
ldap3.utils.log.get_library_log_activation_lavel()[source]
ldap3.utils.log.get_library_log_detail_level()[source]
ldap3.utils.log.get_library_log_hide_sensitive_data()[source]
ldap3.utils.log.get_library_log_max_line_length()[source]
ldap3.utils.log.log(detail, message, *args)[source]
ldap3.utils.log.log_enabled(detail)[source]
ldap3.utils.log.set_library_log_activation_level(logging_level)[source]
ldap3.utils.log.set_library_log_detail_level(detail)[source]
ldap3.utils.log.set_library_log_hide_sensitive_data(hide=True)[source]
ldap3.utils.log.set_library_log_max_line_length(length)[source]

ldap3.utils.ntlm module

class ldap3.utils.ntlm.NtlmClient(domain, user_name, password)[source]

Bases: object

compute_nt_response()[source]
create_authenticate_message()[source]

Microsoft MS-NLMP 2.2.1.3

create_negotiate_message()[source]

Microsoft MS-NLMP 2.2.1.1

get_client_flag(flag)[source]
get_negotiated_flag(flag)[source]
get_server_av_flag(flag)[source]
ntowf_v2()[source]
static pack_av_info(avs)[source]
static pack_field(value, offset)[source]
static pack_windows_timestamp()[source]
parse_challenge_message(message)[source]

Microsoft MS-NLMP 2.2.1.2

reset_client_flags()[source]
set_client_flag(flags)[source]
static unpack_av_info(info)[source]
static unpack_field(field_message)[source]
unset_client_flag(flags)[source]
ldap3.utils.ntlm.pack_windows_version(debug=False)[source]
ldap3.utils.ntlm.unpack_windows_version(version_message)[source]

ldap3.utils.ordDict module

class ldap3.utils.ordDict.OrderedDict(*args, **kwds)[source]

Bases: dict, UserDict.DictMixin

clear()[source]
copy()[source]
classmethod fromkeys(iterable, value=None)[source]
items()
iteritems()
iterkeys()
itervalues()
keys()[source]
pop(key, *args)
popitem(last=True)[source]
setdefault(key, default=None)
update(other=None, **kwargs)
values()

ldap3.utils.repr module

ldap3.utils.repr.to_stdout_encoding(value)[source]

ldap3.utils.tls_backport module

ldap3.utils.uri module

ldap3.utils.uri.parse_uri(uri)[source]

Decode LDAP URI as specified in RFC 4516 relaxing specifications permitting ‘ldaps’ as scheme for ssl-ldap

Module contents