LDAP Constants

LDAP Constants.

class freeiam.ldap.constants.AVA(value)

Bases: IntEnum

Attribute Value Assertion formats.

Binary = 2

NonPrintable = 4

Null = 0

String = 1

class freeiam.ldap.constants.DNFormat(value)

Bases: IntEnum

Used for DN-parsing functions.

ADCanonical = 80

DCE = 48

LDAP = 0

LDAPV2 = 32

LDAPV3 = 16

Mask = 240

NoLeadTrailSpaces = 4096

NoSpaceAfterDN = 8192

Pedantic = 61440

Pretty = 256

Skip = 512

UFN = 64

class freeiam.ldap.constants.Dereference(value)

Bases: IntEnum

Dereference options.

Always = 3

Finding = 2

Never = 0

Searching = 1

class freeiam.ldap.constants.KeepAlive(value)

Bases: IntEnum

Keep Alive Option values.

Idle = 25344

Interval = 25346

Probes = 25345

class freeiam.ldap.constants.LDAPChangeType(value)

Bases: IntEnum

LDAP change type for PersistentSearchControl control.

Add = 1

Delete = 2

Modify = 4

ModifyDN = 8

class freeiam.ldap.constants.Mod(value)

Bases: IntEnum

Modification list entry.

Add = 0

BinaryValues = 128

Delete = 1

Increment = 3

Replace = 2

class freeiam.ldap.constants.Option(value)

Bases: IntEnum

LDAP Options.

ApiFeatureInfo = 21

Returns API feature information (int).

ApiInfo = 0

Returns API information (int).

ClientControls = 19

List of LDAP client controls (list).

ConnectAsync = 20496

Enables asynchronous connect mode (int).

DebugLevel = 20481

Sets the debug level within the underlying OpenLDAP C library (int).

libldap sends the log messages to stderr.

DefaultBase = 20489

Default search base DN for operations (str).

Dereference = 2

Specifies how alias dereferencing is performed (Dereference).

DiagnosticMessage = 50

Gets the diagnostic message of the last operation (str).

ErrorNumber = 49

Gets the error number of the last occurred error (int).

ErrorString = 50

Gets the error string corresponding to the last occurred error (str).

FileDescriptor = 1

Gets the file descriptor of the LDAP connection (int).

HostName = 48

The hostname used for the connection (str).

MatchedDN = 51

Gets the matched distinguished name from the last operation (str).

NetworkTimeout = 20485

Network timeout in seconds (int).

A timeout of -1 or None resets the timeout to infinity.

ProtocolVersion = 17

LDAP protocol version to use for the connection (Version).

Referrals = 8

Specifies whether referrals should be automatically chased (int).

Refhoplimit = 20483

Maximum number of referral hops (int).

Restart = 9

Specifies whether operations are automatically restarted (int).

ResultCode = 49

Gets the result code of the last operation (int).

ServerControls = 18

List of LDAP server controls (list).

Sizelimit = 3

Specifies the maximum number of entries to return for a search (int).

TCPUserTimeout = 20501

TCP user timeout in milliseconds (int).

Timelimit = 4

Specifies the maximum time in seconds a search may run (int).

Timeout = 20482

Operation timeout in seconds (int).

A timeout of -1 or None resets the timeout to infinity.

URI = 20486

LDAP URI(s) for the connection (str).

class freeiam.ldap.constants.OptionValue(value)

Bases: IntEnum

LDAP Option Values.

NoLimit = 0

Off = 0

On = 1

Success = 0

class freeiam.ldap.constants.ResponseType(value)

Bases: IntEnum

LDAP Response protocol operation.

Add = 105

Any = -1

Bind = 97

Compare = 111

Delete = 107

Extended = 120

Intermediate = 121

ModRDN = 109

Modify = 103

SearchEntry = 100

SearchReference = 115

SearchResult = 101

Unsolicited = 0

class freeiam.ldap.constants.SASLOption(value)

Bases: IntEnum

SASL Options (must be set per connection).

AuthCID = 24834

AuthZID = 24835

Mechanism = 24832

NoCanonicalization = 24843

If set to zero, SASL host name canonicalization is disabled.

Realm = 24833

SSF = 24836

Security Strength Factor

SSFExternal = 24837

SSFMax = 24840

Maximum Security Strength Factor

SSFMin = 24839

Minimum Security Strength Factor

Secprops = 24838

Username = 24844

SASL Username

class freeiam.ldap.constants.Scope(value)

Bases: IntEnum

All possible search scopes.

BASE = 0

Base = 0

Base entry scope

ONELEVEL = 1

One = 1

Onelevel = 1

Direct children scope

SUBTREE = 2

Sub = 2

Subordinate = 3

Subtree = 2

Whole subtree scope

class freeiam.ldap.constants.TLSCRLCheck(value)

Bases: IntEnum

Values for Certificate Revocation List checks (TLSOption.CRLCheck).

All = 2

None_ = 0

Peer = 1

class freeiam.ldap.constants.TLSOption(value)

Bases: IntEnum

TLS Options.

CACertdir = 24579

Path to a directory containing CA certificates (str).

CACertfile = 24578

Path to a CA certificate file (str).

CRLCheck = 24587

Certificate Revocation List check policy (TLSCRLCheck).

CRLFile = 24592

Path to a CRL file (str).

Certfile = 24580

Path to the client/server certificate file (str).

Cipher = 24596

Cipher specification (str).

CipherSuite = 24584

Cipher suite selection (str).

DHFile = 24590

Path to the Diffie-Hellman parameters file (str).

ECName = 24594

Name of the elliptic curve to use (str).

Keyfile = 24581

Path to the private key file corresponding to the certificate (str).

NewContext = 24591

Create a new internal TLS context (int).

libldap does not apply all TLS settings immediately. Use this option with value 0 to instruct libldap to apply pending TLS settings and create a new internal TLS context.

Package = 24593

TLS package to use (str).

PeerCert = 24597

Path to the peer certificate file (str).

ProtocolMax = 24603

Maximum allowed TLS protocol (TLSProtocol).

ProtocolMin = 24583

Minimum allowed TLS protocol (TLSProtocol).

RequireCert = 24582

Certificate requirement level (TLSRequireCert).

RequireSAN = 24602

Requirement for Subject Alternative Name (TLSRequireCert).

Version = 24595

TLS library version (str).

class freeiam.ldap.constants.TLSProtocol(value)

Bases: IntEnum

Values for TLSOption.ProtocolMin / TLSOption.ProtocolMax.

SSL3 = 768

TLS10 = 769

TLS11 = 770

TLS12 = 771

TLS13 = 772

class freeiam.ldap.constants.TLSRequireCert(value)

Bases: IntEnum

Values for Certificate requirement or Subject Alternative Name (TLSOption.RequireCert and TLSOption.RequireSAN).

Allow = 3

Demand = 2

Hard = 1

Never = 0

Try = 4

class freeiam.ldap.constants.Version(value)

Bases: IntEnum

LDAP Protocol Version.

LDAPV1 = 1

Version 1

LDAPV2 = 2

Version 2

LDAPV3 = 3

Version 3

Max = 3

Maximum protocol version

Min = 2

Minimum protocol version

V1 = 1

V2 = 2

V3 = 3