include/ldb.h(3)

📦

version 4.24.7 · 4 versions

✨ NAME ✨

include/ldb.h — Samba's ldb database, bestie. That's the whole name. It lives in the Library Functions Manual, section 3, so it's giving C library header energy. 🫶

🌸 SYNOPSIS 🌸

okay so before you can even look at the structs, you gotta pull in the headers. No cap, these are the includes:

#include <stdbool.h>
#include <talloc.h>
#include <tevent.h>
#include <ldb_version.h>
#include <ldb_errors.h>

and then, boom, data structures. The header says:

🦋 Data Structures 🦋

struct ldb_val — a result value. that's the whole job. 💅
struct ldb_message_element — results are given back as arrays of ldb_message_element, so this is how you get your result pieces. ✨
struct ldb_message — a ldb_message represents all or part of a record. main character behavior, honestly. 👑
struct ldb_ldif — LDIF record. exactly what it sounds like. 🎀
struct ldb_parse_tree — no blurb in the header, it's just out here being mysterious. 💀
struct ldb_schema_syntax — no extra text, just the struct name and vibes. 🌈
struct ldb_schema_attribute — again, no description, but it's in the lineup. 💜
struct ldb_dn_extended_syntax — header doesn't explain it, it just exists. 🦋
struct ldb_sd_flags_control — no little description here, just the struct. ⭐
struct ldb_search_options_control — same deal: no blurb, only struct. 🔥
struct ldb_paged_control — no description in this part, but it's here. 🍓
struct ldb_extended_dn_control — no blurb, it's just listed. 💖
struct ldb_server_sort_control — no description, but iconic name. 💅
struct ldb_sort_resp_control — no blurb in the header. ✨
struct ldb_asq_control — no description, just the struct. 🌸
struct ldb_dirsync_control — no blurb, still in the data structures list. 🧚
struct ldb_vlv_req_control — no description, just hanging out. 🫶
struct ldb_vlv_resp_control — no blurb, but it's here. 💜
struct ldb_verify_name_control — no description, just the struct name. 🌈
struct ldb_control — no blurb in the header, but it's a control, iykyk. 👑
struct ldb_extended — no description, just the struct. ⭐
struct ldb_seqnum_request — no blurb, but it's in the list. 🎀
struct ldb_seqnum_result — no description, still part of the squad. ✨
struct ldb_result — no blurb, just the struct. 💖
struct ldb_reply — no description, but it's here. 🦋
struct ldb_search — no blurb, just the struct. 🔥
struct ldb_add — no description, still listed. 🍓
struct ldb_modify — no blurb, just the struct. 💅
struct ldb_delete — no description, but it's in the lineup. 🌸
struct ldb_rename — no blurb, just the struct. 🧚
struct ldb_register_control — no description, still here. 🫶
struct ldb_register_partition — no blurb, just the struct. 💜
struct ldb_request — no description in the header, but it's the last one in this list. 🌈

✨ Macros ✨

okay bestie, welcome to the macro section of include/ldb.h. these are the little #define spells you'll see all over LDB. some have descriptions, some are just vibes. we're going through every single one, no skips. periodt. 💅

#define LDB_FLAG_MOD_MASK 0x3 — There are a whole bunch of flags that get used with ldap_modify() in the ldb_message_element.flags fields. This is the mask for the mod part. ✨
#define LDB_FLAG_MOD_TYPE(flags) — Use this to extract the mod type (enum) from the operation. slay.
#define LDB_FLAG_MOD_ADD 1 — The value used in ldap_modify() to say "we're adding attributes". 💖
#define LDB_FLAG_MOD_REPLACE 2 — The value used in ldap_modify() to say "we're replacing attributes". 🦋
#define LDB_FLAG_MOD_DELETE 3 — The value used in ldap_modify() to say "we're deleting attributes". 💀
#define LDB_FLAG_FORCE_NO_BASE64_LDIF 4 — Flag value used in ldb_ldif_write_trace() to enforce binary encoded attribute values per attribute. no cap.
#define LDB_FLAG_INTERNAL_MASK 0xFFFFFFF0 — Flag bits on an element that are usable only by the internal implementation. 👑
#define LDB_OID_COMPARATOR_AND '1.2.840.113556.1.4.803' — OID for logic AND comparison. iconic.
#define LDB_OID_COMPARATOR_OR '1.2.840.113556.1.4.804' — OID for logic OR comparison. 💅
#define LDB_DEBUG_ALWAYS_LOG LDB_DEBUG_FATAL — (no description, just vibes)
#define LDB_FLG_RDONLY 1 — Flag value for database connection mode. 🌸
#define LDB_FLG_NOSYNC 2 — Flag value for database connection mode. ✨
#define LDB_FLG_RECONNECT 4 — Flag value to specify autoreconnect mode. 🔥
#define LDB_FLG_NOMMAP 8 — Flag to tell backends not to use mmap. 🙈
#define LDB_FLG_SHOW_BINARY 16 — Flag to tell ldif handlers not to force encoding of binary structures in base64. 🎀
#define LDB_FLG_ENABLE_TRACING 32 — Flags to enable ldb tracing. 👑
#define LDB_FLG_DONT_CREATE_DB 64 — Flags to tell LDB not to create a new database file: 💜
#define LDB_FLG_PRIVATE_MASK 0xff000000 — Allow DB create time flags that have meaning only to our calling application or modules. 🌈
#define LDB_ATTR_FLAG_HIDDEN (1<<0) — The attribute is not returned by default. lowkey sneaky.
#define LDB_ATTR_FLAG_ALLOCATED (1<<1) — (no description, just vibes)
#define LDB_ATTR_FLAG_FIXED (1<<2) — The attribute is supplied by the application and should not be removed. periodt.
#define LDB_ATTR_FLAG_UNIQUE_INDEX (1<<3) — (no description, just vibes)
#define LDB_ATTR_FLAG_SINGLE_VALUE (1<<4) — (no description, just vibes)
#define LDB_ATTR_FLAG_FORCE_BASE64_LDIF (1<<5) — (no description, just vibes)
#define LDB_ATTR_FLAG_FROM_DB (1<<6) — (no description, just vibes)
#define LDB_ATTR_FLAG_INDEXED (1<<7) — (no description, just vibes)
#define LDB_SYNTAX_DN '1.3.6.1.4.1.1466.115.121.1.12' — LDAP attribute syntax for a DN. 💖
#define LDB_SYNTAX_DIRECTORY_STRING '1.3.6.1.4.1.1466.115.121.1.15' — LDAP attribute syntax for a Directory String. 🦋
#define LDB_SYNTAX_INTEGER '1.3.6.1.4.1.1466.115.121.1.27' — LDAP attribute syntax for an integer. 🔢
#define LDB_SYNTAX_ORDERED_INTEGER 'LDB_SYNTAX_ORDERED_INTEGER' — Custom attribute syntax for an integer whose index is lexicographically ordered by attribute value in the database. fancy.
#define LDB_SYNTAX_BOOLEAN '1.3.6.1.4.1.1466.115.121.1.7' — LDAP attribute syntax for a boolean. ✅
#define LDB_SYNTAX_OCTET_STRING '1.3.6.1.4.1.1466.115.121.1.40' — LDAP attribute syntax for an octet string. 🧚
#define LDB_SYNTAX_UTC_TIME '1.3.6.1.4.1.1466.115.121.1.53' — LDAP attribute syntax for UTC time. ⏰
#define LDB_SYNTAX_GENERALIZED_TIME '1.3.6.1.4.1.1466.115.121.1.24' — (no description, just vibes)
#define LDB_SYNTAX_OBJECTCLASS 'LDB_SYNTAX_OBJECTCLASS' — (no description, just vibes)
#define LDB_CONTROL_BYPASS_OPERATIONAL_OID '1.3.6.1.4.1.7165.4.3.13' — OID for getting and manipulating attributes from the ldb without interception in the operational module. 💅
#define LDB_CONTROL_BYPASS_OPERATIONAL_NAME 'bypassoperational' — (no description, just vibes)
#define LDB_CONTROL_RECALCULATE_RDN_OID '1.3.6.1.4.1.7165.4.3.30' — OID for recalculate RDN (rdn attribute and 'name') control. ✨
#define LDB_CONTROL_RECALCULATE_SD_OID '1.3.6.1.4.1.7165.4.3.5' — OID for recalculate SD control. 🌸
#define LDB_CONTROL_RECALCULATE_SD_NAME 'recalculate_sd' — (no description, just vibes)
#define LDB_CONTROL_REVEAL_INTERNALS '1.3.6.1.4.1.7165.4.3.6' — REVEAL_INTERNALS is used to reveal internal attributes and DN components which are not normally shown to the user. 👀
#define LDB_CONTROL_REVEAL_INTERNALS_NAME 'reveal_internals' — (no description, just vibes)
#define LDB_CONTROL_AS_SYSTEM_OID '1.3.6.1.4.1.7165.4.3.7' — LDB_CONTROL_AS_SYSTEM is used to skip access checks on operations that are performed by the system, but with a user's credentials, e.g. 😈
#define LDB_CONTROL_PROVISION_OID '1.3.6.1.4.1.7165.4.3.16' — LDB_CONTROL_PROVISION_OID is used to skip some constraint checks. 🦋
#define LDB_CONTROL_PROVISION_NAME 'provision' — (no description, just vibes)
#define LDB_CONTROL_PAGED_RESULTS_OID '1.2.840.113556.1.4.319' — OID for the paged results control. 📄
#define LDB_CONTROL_PAGED_RESULTS_NAME 'paged_results' — (no description, just vibes)
#define LDB_CONTROL_SD_FLAGS_OID '1.2.840.113556.1.4.801' — OID for specifying the returned elements of the ntSecurityDescriptor. 🔐
#define LDB_CONTROL_SD_FLAGS_NAME 'sd_flags' — (no description, just vibes)
#define LDB_CONTROL_DOMAIN_SCOPE_OID '1.2.840.113556.1.4.1339' — OID for specifying an advanced scope for the search (one partition). 🎯
#define LDB_CONTROL_DOMAIN_SCOPE_NAME 'domain_scope' — (no description, just vibes)
#define LDB_CONTROL_SEARCH_OPTIONS_OID '1.2.840.113556.1.4.1340' — OID for specifying an advanced scope for a search. 🔍
#define LDB_CONTROL_SEARCH_OPTIONS_NAME 'search_options' — (no description, just vibes)
#define LDB_CONTROL_NOTIFICATION_OID '1.2.840.113556.1.4.528' — OID for notification. 🔔
#define LDB_CONTROL_NOTIFICATION_NAME 'notification' — (no description, just vibes)
#define LDB_CONTROL_TREE_DELETE_OID '1.2.840.113556.1.4.805' — OID for performing subtree deletes. 🌳
#define LDB_CONTROL_TREE_DELETE_NAME 'tree_delete' — (no description, just vibes)
#define LDB_CONTROL_SHOW_DELETED_OID '1.2.840.113556.1.4.417' — OID for getting deleted objects. 💀
#define LDB_CONTROL_SHOW_DELETED_NAME 'show_deleted' — (no description, just vibes)
#define LDB_CONTROL_SHOW_RECYCLED_OID '1.2.840.113556.1.4.2064' — OID for getting recycled objects. ♻️
#define LDB_CONTROL_SHOW_RECYCLED_NAME 'show_recycled' — (no description, just vibes)
#define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID '1.2.840.113556.1.4.2065' — OID for getting deactivated linked attributes. 🔗
#define LDB_CONTROL_SHOW_DEACTIVATED_LINK_NAME 'show_deactivated_link' — (no description, just vibes)
#define LDB_CONTROL_EXTENDED_DN_OID '1.2.840.113556.1.4.529' — OID for extended DN. 🧬
#define LDB_CONTROL_EXTENDED_DN_NAME 'extended_dn' — (no description, just vibes)
#define LDB_CONTROL_SERVER_SORT_OID '1.2.840.113556.1.4.473' — OID for LDAP server sort result extension. 📊
#define LDB_CONTROL_SERVER_SORT_NAME 'server_sort' — (no description, just vibes)
#define LDB_CONTROL_SORT_RESP_OID '1.2.840.113556.1.4.474' — OID for LDAP server sort result response extension. 📈
#define LDB_CONTROL_SORT_RESP_NAME 'server_sort_resp' — (no description, just vibes)
#define LDB_CONTROL_ASQ_OID '1.2.840.113556.1.4.1504' — OID for LDAP Attribute Scoped Query extension. 🔎
#define LDB_CONTROL_ASQ_NAME 'asq' — (no description, just vibes)
#define LDB_CONTROL_DIRSYNC_OID '1.2.840.113556.1.4.841' — OID for LDAP Directory Sync extension. 🔄
#define LDB_CONTROL_DIRSYNC_NAME 'dirsync' — (no description, just vibes)
#define LDB_CONTROL_DIRSYNC_EX_OID '1.2.840.113556.1.4.2090' — (no description, just vibes)
#define LDB_CONTROL_DIRSYNC_EX_NAME 'dirsync_ex' — (no description, just vibes)
#define LDB_CONTROL_VLV_REQ_OID '2.16.840.1.113730.3.4.9' — OID for LDAP Virtual List View Request extension. 👁️
#define LDB_CONTROL_VLV_REQ_NAME 'vlv' — (no description, just vibes)
#define LDB_CONTROL_VLV_RESP_OID '2.16.840.1.113730.3.4.10' — OID for LDAP Virtual List View Response extension. 📋
#define LDB_CONTROL_VLV_RESP_NAME 'vlv_resp' — (no description, just vibes)
#define LDB_CONTROL_PERMISSIVE_MODIFY_OID '1.2.840.113556.1.4.1413' — OID to let modifies don't give an error when adding an existing attribute with the same value or deleting an nonexisting one attribute. chill mode. 😌
#define LDB_CONTROL_PERMISSIVE_MODIFY_NAME 'permissive_modify' — (no description, just vibes)
#define LDB_CONTROL_SERVER_LAZY_COMMIT '1.2.840.113556.1.4.619' — OID to allow the server to be more 'fast and loose' with the data being added. 🏃
#define LDB_CONTROL_RODC_DCPROMO_OID '1.2.840.113556.1.4.1341' — Control for RODC join -see [MS-ADTS] section 3.1.1.3.4.1.23. 📚
#define LDB_CONTROL_RODC_DCPROMO_NAME 'rodc_join' — (no description, just vibes)
#define LDB_CONTROL_RELAX_OID '1.3.6.1.4.1.4203.666.5.12' — OID for the allowing client to request temporary relaxed enforcement of constraints of the x.500 model. 😎
#define LDB_CONTROL_RELAX_NAME 'relax' — (no description, just vibes)
#define LDB_CONTROL_VERIFY_NAME_OID '1.2.840.113556.1.4.1338' — OID for the allowing some kind of relax check for attributes with DNs. ✅
#define LDB_CONTROL_VERIFY_NAME_NAME 'verify_name' — (no description, just vibes)
#define LDB_EXTENDED_SEQUENCE_NUMBER '1.3.6.1.4.1.7165.4.4.3' — OID for LDAP Extended Operation SEQUENCE_NUMBER. 🔢
#define LDB_EXTENDED_PASSWORD_CHANGE_OID '1.3.6.1.4.1.4203.1.11.1' — OID for LDAP Extended Operation PASSWORD_CHANGE. 🔑
#define LDB_EXTENDED_FAST_BIND_OID '1.2.840.113556.1.4.1781' — OID for LDAP Extended Operation FAST_BIND. ⚡
#define LDB_EXTENDED_START_TLS_OID '1.3.6.1.4.1.1466.20037' — OID for LDAP Extended Operation START_TLS. 🔒
#define LDB_EXTENDED_DYNAMIC_OID '1.3.6.1.4.1.1466.101.119.1' — OID for LDAP Extended Operation DYNAMIC_REFRESH. 🔄
#define LDB_EXTENDED_WHOAMI_OID '1.3.6.1.4.1.4203.1.11.3' — OID for RFC4532 WhoAmI"extendedoperation. 🪞
#define LDB_CONTROL_POLICY_HINTS_OID '1.2.840.113556.1.4.2239' — OID used to enforce password history length constraints in password reset. 📜
#define LDB_CONTROL_POLICY_HINTS_NAME 'policy_hints' — (no description, just vibes)
#define LDB_CONTROL_POLICY_HINTS_DEPRECATED_OID '1.2.840.113556.1.4.2066' — Another OID used to enforce password history length constraints in password reset. 👵
#define LDB_CONTROL_POLICY_HINTS_DEPRECATED_NAME 'policy_hints_deprecated' — (no description, just vibes)
#define LDB_SEARCH_OPTION_DOMAIN_SCOPE 0x00000001 — (no description, just vibes)
#define LDB_SEARCH_OPTION_PHANTOM_ROOT 0x00000002 — (no description, just vibes)
#define LDB_SEQ_GLOBAL_SEQUENCE 0x01 — (no description, just vibes)
#define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02 — (no description, just vibes)
#define ldb_attr_cmp(a, b) — Compare two attributes. 🔍
#define discard_const(ptr) — (no description, just vibes)
#define LDB_TYPESAFE_QSORT(base, numel, opaque, comparison) — (no description, just vibes)
#define TYPESAFE_QSORT(base, numel, comparison) — (no description, just vibes)
#define NUMERIC_CMP(a, b) — (no description, just vibes)
#define LDB_REQ_SET_LOCATION(req) — (no description, just vibes)

✨ Typedefs ✨

and now the typedefs, bestie. these are the function pointer types that make LDB go round. no descriptions here, just the exact signatures. copy them with love. 💖

typedef int(* ldb_attr_handler_t) (struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, struct ldb_val *)
typedef int(* ldb_attr_comparison_t) (struct ldb_context *, TALLOC_CTX *mem_ctx, const struct ldb_val *, const struct ldb_val *)
typedef int(* ldb_attr_operator_t) (struct ldb_context *, enum ldb_parse_op operation, const struct ldb_schema_attribute *a, const struct ldb_val *, const struct ldb_val *, bool *matched)
typedef int(* ldb_qsort_cmp_fn_t) (void *v1, void *v2, void *opaque)
typedef int(* ldb_request_callback_t) (struct ldb_request *, struct ldb_reply *)

✨ Enumerations ✨

okay so now we're at the enum part and honestly? this is where ldb.h really starts cooking 🔥. These are all the named integer constants the header hands you, and every single one of them is here — nothing skipped, nothing summarised, periodt. Let's take them one at a time, bestie. 💅

🦋 `enum ldb_changetype`

enum ldb_changetype { LDB_CHANGETYPE_NONE =0, LDB_CHANGETYPE_ADD,
    LDB_CHANGETYPE_DELETE, LDB_CHANGETYPE_MODIFY, LDB_CHANGETYPE_MODRDN
    }

LDB_CHANGETYPE_NONE — parked at =0, the "nothing to see here" one.
LDB_CHANGETYPE_ADD — the add one, going by the name.
LDB_CHANGETYPE_DELETE — and this is the delete one.
LDB_CHANGETYPE_MODIFY — modify energy.
LDB_CHANGETYPE_MODRDN — the mod-RDN one, which is literally what the identifier spells out.

🌸 `enum ldb_scope`

enum ldb_scope { LDB_SCOPE_DEFAULT =-1, LDB_SCOPE_BASE =0,
    LDB_SCOPE_ONELEVEL =1, LDB_SCOPE_SUBTREE =2 }

LDB_SCOPE_DEFAULT — -1, the "you pick for me" value.
LDB_SCOPE_BASE — 0.
LDB_SCOPE_ONELEVEL — 1.
LDB_SCOPE_SUBTREE — 2.

those are your four scope values, all spelled out in the declaration, no guessing required 💖

🎀 `enum ldb_debug_level`

enum ldb_debug_level { LDB_DEBUG_FATAL, LDB_DEBUG_ERROR,
    LDB_DEBUG_WARNING, LDB_DEBUG_TRACE }

LDB_DEBUG_FATAL
LDB_DEBUG_ERROR
LDB_DEBUG_WARNING
LDB_DEBUG_TRACE

no explicit numbers written next to these ones, so that's exactly how the header lists them — in that order, top to bottom. 🫶

🧚 `enum ldb_parse_op`

enum ldb_parse_op { LDB_OP_AND =1, LDB_OP_OR =2, LDB_OP_NOT =3,
    LDB_OP_EQUALITY =4, LDB_OP_SUBSTRING =5, LDB_OP_GREATER =6,
    LDB_OP_LESS =7, LDB_OP_PRESENT =8, LDB_OP_APPROX =9, LDB_OP_EXTENDED
    =10 }

LDB_OP_AND — =1
LDB_OP_OR — =2
LDB_OP_NOT — =3
LDB_OP_EQUALITY — =4
LDB_OP_SUBSTRING — =5
LDB_OP_GREATER — =6
LDB_OP_LESS — =7
LDB_OP_PRESENT — =8
LDB_OP_APPROX — =9
LDB_OP_EXTENDED — =10

ten ops, numbered 1 through 10, and yes we listed every single one because that's the whole assignment 💅

🌈 `enum ldb_request_type`

enum ldb_request_type { LDB_SEARCH, LDB_ADD, LDB_MODIFY, LDB_DELETE,
    LDB_RENAME, LDB_EXTENDED, LDB_REQ_REGISTER_CONTROL,
    LDB_REQ_REGISTER_PARTITION }

LDB_SEARCH
LDB_ADD
LDB_MODIFY
LDB_DELETE
LDB_RENAME
LDB_EXTENDED
LDB_REQ_REGISTER_CONTROL
LDB_REQ_REGISTER_PARTITION

eight request types, in that exact order, no explicit values written in the declaration. 👑

⭐ `enum ldb_reply_type`

enum ldb_reply_type { LDB_REPLY_ENTRY, LDB_REPLY_REFERRAL,
    LDB_REPLY_DONE }

LDB_REPLY_ENTRY
LDB_REPLY_REFERRAL
LDB_REPLY_DONE

three reply types, done and dusted. 🎀

💜 `enum ldb_wait_type`

enum ldb_wait_type { LDB_WAIT_ALL, LDB_WAIT_NONE }

LDB_WAIT_ALL
LDB_WAIT_NONE

just the two of them, living their best lives.

🍓 `enum ldb_state`

enum ldb_state { LDB_ASYNC_INIT, LDB_ASYNC_PENDING, LDB_ASYNC_DONE }

LDB_ASYNC_INIT
LDB_ASYNC_PENDING
LDB_ASYNC_DONE

the async state trio, in that order, exactly as written.

🦋 `enum ldb_sequence_type`

enum ldb_sequence_type { LDB_SEQ_HIGHEST_SEQ, LDB_SEQ_HIGHEST_TIMESTAMP,
    LDB_SEQ_NEXT }

LDB_SEQ_HIGHEST_SEQ
LDB_SEQ_HIGHEST_TIMESTAMP
LDB_SEQ_NEXT

and that's the last one — three sequence types, no explicit values given, and we are not skipping any of them. iykyk 🌸

lowkey important bestie: all ten of these enums are listed with exactly the members and exactly the values the header declares. If you're writing code against ldb.h, use the identifiers, not the raw numbers — the numbers are just what they happen to be set to. 💖

✨ FUNCTIONS ✨

okay bestie, this is the function buffet and it is long. grab a snack, hydrate, and let's get into it 💅 every single signature is here, no skips, no cuts, periodt.

struct ldb_parse_tree * ldb_parse_tree (TALLOC_CTX *mem_ctx, const char *s) — no extra notes in the source, just the signature, bestie.
char * ldb_filter_from_tree (TALLOC_CTX *mem_ctx, const struct ldb_parse_tree *tree) — same, just the signature.
char * ldb_binary_encode (TALLOC_CTX *mem_ctx, struct ldb_val val) — Encode a binary blob.
char * ldb_binary_encode_string (TALLOC_CTX *mem_ctx, const char *string) — Encode a string.
const struct ldb_schema_attribute * ldb_schema_attribute_by_name (struct ldb_context *ldb, const char *name) — just the signature.
const struct ldb_dn_extended_syntax * ldb_dn_extended_syntax_by_name (struct ldb_context *ldb, const char *name) — just the signature.
int ldb_request (struct ldb_context *ldb, struct ldb_request *request) — just the signature.
int ldb_request_done (struct ldb_request *req, int status) — just the signature.
bool ldb_request_is_done (struct ldb_request *req) — just the signature.
int ldb_modules_wait (struct ldb_handle *handle) — just the signature.
int ldb_wait (struct ldb_handle *handle, enum ldb_wait_type type) — just the signature.
int ldb_set_timeout (struct ldb_context *ldb, struct ldb_request *req, int timeout) — just the signature.
int ldb_set_timeout_from_prev_req (struct ldb_context *ldb, struct ldb_request *oldreq, struct ldb_request *newreq) — just the signature.
void ldb_set_create_perms (struct ldb_context *ldb, unsigned int perms) — just the signature.
void ldb_set_modules_dir (struct ldb_context *ldb, const char *path) — just the signature.
void ldb_set_event_context (struct ldb_context *ldb, struct tevent_context *ev) — just the signature.
struct tevent_context * ldb_get_event_context (struct ldb_context *ldb) — just the signature.
int ldb_global_init (void) — Initialise ldbs' global information.
struct ldb_context * ldb_init (TALLOC_CTX *mem_ctx, struct tevent_context *ev_ctx) — Initialise an ldb context.
int ldb_connect (struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]) — Connect to a database.
struct ldb_dn * ldb_get_root_basedn (struct ldb_context *ldb) — just the signature.
struct ldb_dn * ldb_get_config_basedn (struct ldb_context *ldb) — just the signature.
struct ldb_dn * ldb_get_schema_basedn (struct ldb_context *ldb) — just the signature.
struct ldb_dn * ldb_get_default_basedn (struct ldb_context *ldb) — just the signature.
int ldb_search_default_callback (struct ldb_request *req, struct ldb_reply *ares) — The default async search callback function.
int ldb_op_default_callback (struct ldb_request *req, struct ldb_reply *ares) — The default async extended operation callback function.
int ldb_modify_default_callback (struct ldb_request *req, struct ldb_reply *ares) — just the signature.
int ldb_build_search_req (struct ldb_request **ret_req, struct ldb_context *ldb, TALLOC_CTX *mem_ctx, struct ldb_dn *base, enum ldb_scope scope, const char *expression, const char *const *attrs, struct ldb_control **controls, void *context, ldb_request_callback_t callback, struct ldb_request *parent) — Helper function to build a search request.
int ldb_build_search_req_ex (struct ldb_request **ret_req, struct ldb_context *ldb, TALLOC_CTX *mem_ctx, struct ldb_dn *base, enum ldb_scope scope, struct ldb_parse_tree *tree, const char *const *attrs, struct ldb_control **controls, void *context, ldb_request_callback_t callback, struct ldb_request *parent) — just the signature.
int ldb_build_add_req (struct ldb_request **ret_req, struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const struct ldb_message *message, struct ldb_control **controls, void *context, ldb_request_callback_t callback, struct ldb_request *parent) — Helper function to build an add request.
int ldb_build_mod_req (struct ldb_request **ret_req, struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const struct ldb_message *message, struct ldb_control **controls, void *context, ldb_request_callback_t callback, struct ldb_request *parent) — Helper function to build a modify request.
int ldb_build_del_req (struct ldb_request **ret_req, struct ldb_context *ldb, TALLOC_CTX *mem_ctx, struct ldb_dn *dn, struct ldb_control **controls, void *context, ldb_request_callback_t callback, struct ldb_request *parent) — Helper function to build a delete request.
int ldb_build_rename_req (struct ldb_request **ret_req, struct ldb_context *ldb, TALLOC_CTX *mem_ctx, struct ldb_dn *olddn, struct ldb_dn *newdn, struct ldb_control **controls, void *context, ldb_request_callback_t callback, struct ldb_request *parent) — Helper function to build a rename request.
int ldb_request_add_control (struct ldb_request *req, const char *oid, bool critical, void *data) — Add a ldb_control to a ldb_request.
int ldb_request_replace_control (struct ldb_request *req, const char *oid, bool critical, void *data) — replace a ldb_control in a ldb_request
struct ldb_control * ldb_controls_get_control (struct ldb_control **controls, const char *oid) — check if a control with the specified oid"existandreturnit
struct ldb_control * ldb_request_get_control (struct ldb_request *req, const char *oid) — check if a control with the specified oid"existandreturnit
struct ldb_control * ldb_reply_get_control (struct ldb_reply *rep, const char *oid) — check if a control with the specified oid"existandreturnit
int ldb_search (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, struct ldb_result **result, struct ldb_dn *base, enum ldb_scope scope, const char *const *attrs, const char *exp_fmt,...) PRINTF_ATTRIBUTE(7 — Search the database.
int int ldb_add (struct ldb_context *ldb, const struct ldb_message *message) — Add a record to the database.
int ldb_modify (struct ldb_context *ldb, const struct ldb_message *message) — Modify the specified attributes of a record.
int ldb_rename (struct ldb_context *ldb, struct ldb_dn *olddn, struct ldb_dn *newdn) — Rename a record in the database.
int ldb_delete (struct ldb_context *ldb, struct ldb_dn *dn) — Delete a record from the database.
int ldb_extended_default_callback (struct ldb_request *req, struct ldb_reply *ares) — The default async extended operation callback function.
int ldb_build_extended_req (struct ldb_request **ret_req, struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *oid, void *data, struct ldb_control **controls, void *context, ldb_request_callback_t callback, struct ldb_request *parent) — Helper function to build a extended request.
int ldb_extended (struct ldb_context *ldb, const char *oid, void *data, struct ldb_result **res) — call an extended operation
int ldb_sequence_number (struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num) — Obtain current/next database sequence number.
int ldb_transaction_start (struct ldb_context *ldb) — start a transaction
int ldb_transaction_prepare_commit (struct ldb_context *ldb) — first phase of two phase commit
int ldb_transaction_commit (struct ldb_context *ldb) — commit a transaction
int ldb_transaction_cancel (struct ldb_context *ldb) — cancel a transaction
int ldb_transaction_cancel_noerr (struct ldb_context *ldb) — just the signature.
const char * ldb_errstring (struct ldb_context *ldb) — return extended error information from the last call
const char * ldb_strerror (int ldb_err) — return a string explaining what a ldb error constant means
void ldb_set_utf8_default (struct ldb_context *ldb) — setup the default utf8 functions FIXME: these functions do not yet handle utf8 😭
char * ldb_casefold (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *s, size_t n) — Casefold a string.
int ldb_valid_attr_name (const char *s) — Check the attribute name is valid according to rfc2251.
int ldb_ldif_write (struct ldb_context *ldb, int(*fprintf_fn)(void *, const char *,...) PRINTF_ATTRIBUTE(2, 3), void *private_data, const struct ldb_ldif *ldif) — Write an LDIF message.
void ldb_ldif_read_free (struct ldb_context *ldb, struct ldb_ldif *msg) — Clean up an LDIF message.
struct ldb_ldif * ldb_ldif_read (struct ldb_context *ldb, int(*fgetc_fn)(void *), void *private_data) — Read an LDIF message.
struct ldb_ldif * ldb_ldif_read_file (struct ldb_context *ldb, FILE *f) — Read an LDIF message from a file.
struct ldb_ldif * ldb_ldif_read_string (struct ldb_context *ldb, const char **s) — Read an LDIF message from a string.
int ldb_ldif_parse_modrdn (struct ldb_context *ldb, const struct ldb_ldif *ldif, TALLOC_CTX *mem_ctx, struct ldb_dn **olddn, struct ldb_dn **newrdn, bool *deleteoldrdn, struct ldb_dn **newsuperior, struct ldb_dn **newdn) — Parse a modrdn LDIF message from a struct ldb_message.
int ldb_ldif_write_file (struct ldb_context *ldb, FILE *f, const struct ldb_ldif *msg) — Write an LDIF message to a file.
char * ldb_ldif_write_string (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const struct ldb_ldif *msg) — Write an LDIF message to a string.
char * ldb_ldif_message_string (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, enum ldb_changetype changetype, const struct ldb_message *msg) — Write an LDB message to a string.
char * ldb_ldif_message_redacted_string (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, enum ldb_changetype changetype, const struct ldb_message *msg) — Write an LDB message to a string.
char * ldb_base64_encode (TALLOC_CTX *mem_ctx, const char *buf, int len) — Base64 encode a buffer.
int ldb_base64_decode (char *s) — Base64 decode a buffer.
const char * ldb_dn_get_linearized (struct ldb_dn *dn) — Get the linear form of a DN (without any extended components).
char * ldb_dn_alloc_linearized (TALLOC_CTX *mem_ctx, struct ldb_dn *dn) — Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context.
char * ldb_dn_get_extended_linearized (TALLOC_CTX *mem_ctx, struct ldb_dn *dn, int mode) — Get the linear form of a DN (with any extended components).
const struct ldb_val * ldb_dn_get_extended_component (struct ldb_dn *dn, const char *name) — just the signature.
int ldb_dn_set_extended_component (struct ldb_dn *dn, const char *name, const struct ldb_val *val) — just the signature.
void ldb_dn_extended_filter (struct ldb_dn *dn, const char *const *accept_list) — just the signature.
void ldb_dn_remove_extended_components (struct ldb_dn *dn) — just the signature.
bool ldb_dn_has_extended (struct ldb_dn *dn) — just the signature.
int ldb_dn_extended_add_syntax (struct ldb_context *ldb, unsigned flags, const struct ldb_dn_extended_syntax *syntax) — just the signature.
struct ldb_dn * ldb_dn_new (TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *dn) — Allocate a new DN from a string.
struct ldb_dn * ldb_dn_new_fmt (TALLOC_CTX *mem_ctx, struct ldb_context *ldb, const char *new_fmt,...) PRINTF_ATTRIBUTE(3 — Allocate a new DN from a printf style format string and arguments.
struct ldb_dn struct ldb_dn * ldb_dn_from_ldb_val (TALLOC_CTX *mem_ctx, — just the signature.

okay continuing the DN zone, no pauses 💅 — and heads up, this very first one is literally the back half of a prototype that started on the last page, so here it is verbatim:

struct ldb_context *ldb, const struct ldb_val *strdn)

that fragment above — Allocate a new DN from a struct ldb_val (useful to avoid buffer overrun). bestie it's the "please don't overrun my buffer" girlie 🫶
bool ldb_dn_validate (struct ldb_dn *dn) — Determine if this DN is syntactically valid. vibe check for your DN, basically 🎀
char * ldb_dn_escape_value (TALLOC_CTX *mem_ctx, struct ldb_val value) — escaping time ✨
const char * ldb_dn_get_casefold (struct ldb_dn *dn) — casefold, get it 👑
char * ldb_dn_alloc_casefold (TALLOC_CTX *mem_ctx, struct ldb_dn *dn) — casefold but it allocates, iconic
int ldb_dn_compare_base (struct ldb_dn *base, struct ldb_dn *dn) — comparing bases
int ldb_dn_compare (struct ldb_dn *edn0, struct ldb_dn *edn1) — the classic DN-vs-DN showdown 💀
bool ldb_dn_add_base (struct ldb_dn *dn, struct ldb_dn *base) — bolt a base onto a DN
bool ldb_dn_add_base_fmt (struct ldb_dn *dn, const char *base_fmt,...) PRINTF_ATTRIBUTE(2 — same energy, but with a format string, so it's fancy 💖
bool bool ldb_dn_add_child (struct ldb_dn *dn, struct ldb_dn *child) — yes the bool bool is really in there, don't come for me, I'm copying it character for character 😭
bool ldb_dn_add_child_fmt (struct ldb_dn *dn, const char *child_fmt,...) PRINTF_ATTRIBUTE(2 — child + format string
bool bool ldb_dn_remove_base_components (struct ldb_dn *dn, unsigned int num) — again, bool bool, verbatim, slay
bool ldb_dn_remove_child_components (struct ldb_dn *dn, unsigned int num) — popping num child components
bool ldb_dn_add_child_val (struct ldb_dn *dn, const char *rdn, struct ldb_val value) — new child from an rdn and an ldb_val
struct ldb_dn * ldb_dn_copy (TALLOC_CTX *mem_ctx, struct ldb_dn *dn) — copy that DN, twin energy 🦋
struct ldb_dn * ldb_dn_copy_with_ldb_context (TALLOC_CTX *mem_ctx, struct ldb_dn *dn, struct ldb_context *ldb) — copy but bring your own ldb context
struct ldb_dn * ldb_dn_get_parent (TALLOC_CTX *mem_ctx, struct ldb_dn *dn) — get the parent, mother is mothering 💜
char * ldb_dn_canonical_string (TALLOC_CTX *mem_ctx, struct ldb_dn *dn) — canonical string version
char * ldb_dn_canonical_ex_string (TALLOC_CTX *mem_ctx, struct ldb_dn *dn) — canonical ex string version, the extra letter is doing a lot
int ldb_dn_get_comp_num (struct ldb_dn *dn) — how many components?
int ldb_dn_get_extended_comp_num (struct ldb_dn *dn) — how many extended components?
const char * ldb_dn_get_component_name (struct ldb_dn *dn, unsigned int num) — the name of component number num
const struct ldb_val * ldb_dn_get_component_val (struct ldb_dn *dn, unsigned int num) — the value of component number num
const char * ldb_dn_get_rdn_name (struct ldb_dn *dn) — the RDN's name
const struct ldb_val * ldb_dn_get_rdn_val (struct ldb_dn *dn) — the RDN's value
int ldb_dn_set_component (struct ldb_dn *dn, int num, const char *name, const struct ldb_val val) — set component num to this name + value
bool ldb_dn_is_valid (struct ldb_dn *dn) — is it valid? we need answers 🔥
bool ldb_dn_is_special (struct ldb_dn *dn) — is it special? (it's giving main character energy ✨)
bool ldb_dn_check_special (struct ldb_dn *dn, const char *check) — check if it matches that special thing
bool ldb_dn_is_null (struct ldb_dn *dn) — is it null tho
int ldb_dn_update_components (struct ldb_dn *dn, const struct ldb_dn *ref_dn) — refresh your components against ref_dn

okay that's the DN girlies done, now we're on the attribute-name girls 🌸

char * ldb_attr_casefold (TALLOC_CTX *mem_ctx, const char *s) — casefold an attribute string
int ldb_attr_dn (const char *attr) — is this attribute a DN? asks attr directly

and now… the ldb_message era, which is genuinely most of this page, brace yourself bestie 😭

struct ldb_message * ldb_msg_new (TALLOC_CTX *mem_ctx) — Create an empty message. blank slate, fresh start, new me 🎀
struct ldb_message_element * ldb_msg_find_element (const struct ldb_message *msg, const char *attr_name) — Find an element within an message. yes it says "an message", I'm not editing the original's grammar, that's not my job 💅
int ldb_val_equal_exact (const struct ldb_val *v1, const struct ldb_val *v2) — Compare two ldb_val values. exactly, no vibes-based matching
struct ldb_val * ldb_msg_find_val (const struct ldb_message_element *el, struct ldb_val *val) — find a value within an ldb_message_element
int ldb_msg_add_empty (struct ldb_message *msg, const char *attr_name, int flags, struct ldb_message_element **return_el) — add a new empty element to a ldb_message
int ldb_msg_element_add_value (TALLOC_CTX *mem_ctx, struct ldb_message_element *el, const struct ldb_val *val) — add a value to a message element
int ldb_msg_add (struct ldb_message *msg, const struct ldb_message_element *el, int flags) — add a element to a ldb_message. "a element." iconic. we keep it 🫶
int ldb_msg_add_value (struct ldb_message *msg, const char *attr_name, const struct ldb_val *val, struct ldb_message_element **return_el) — add a value by attribute name
int ldb_msg_add_steal_value (struct ldb_message *msg, const char *attr_name, struct ldb_val *val) — add a value and steal it (ownership snatched, no cap)
int ldb_msg_add_steal_string (struct ldb_message *msg, const char *attr_name, char *str) — same but string flavored
int ldb_msg_add_string_flags (struct ldb_message *msg, const char *attr_name, const char *str, int flags) — add a string, but with flags
int ldb_msg_add_string (struct ldb_message *msg, const char *attr_name, const char *str) — add a string, no flags, simple life 🌈
int ldb_msg_add_linearized_dn (struct ldb_message *msg, const char *attr_name, struct ldb_dn *dn) — add a linearized DN
int ldb_msg_add_fmt (struct ldb_message *msg, const char *attr_name, const char *fmt,...) PRINTF_ATTRIBUTE(3 — add a formatted thing
int int ldb_msg_append_value (struct ldb_message *msg, const char *attr_name, const struct ldb_val *val, int flags) — append a element to a ldb_message. yep, int int. verbatim. don't look at me 🙈
int ldb_msg_append_steal_value (struct ldb_message *msg, const char *attr_name, struct ldb_val *val, int flags) — append + steal a value
int ldb_msg_append_steal_string (struct ldb_message *msg, const char *attr_name, char *str, int flags) — append + steal a string
int ldb_msg_append_string (struct ldb_message *msg, const char *attr_name, const char *str, int flags) — append a string
int ldb_msg_append_linearized_dn (struct ldb_message *msg, const char *attr_name, struct ldb_dn *dn, int flags) — append a linearized DN
int ldb_msg_append_fmt (struct ldb_message *msg, int flags, const char *attr_name, const char *fmt,...) PRINTF_ATTRIBUTE(4 — append, formatted, and note the argument order: flags comes before attr_name here 👀
int int ldb_msg_element_compare (struct ldb_message_element *el1, struct ldb_message_element *el2) — compare two message elements - return 0 on match. (int int again, we're loyal to the source 💖)
int ldb_msg_element_compare_name (struct ldb_message_element *el1, struct ldb_message_element *el2) — compare just the names of two elements
const struct ldb_val * ldb_msg_find_ldb_val (const struct ldb_message *msg, const char *attr_name) — Find elements in a message. and then hand you back a ldb_val
int ldb_msg_find_attr_as_int (const struct ldb_message *msg, const char *attr_name, int default_value) — find it, read it as an int, fall back to default_value
unsigned int ldb_msg_find_attr_as_uint (const struct ldb_message *msg, const char *attr_name, unsigned int default_value) — same but unsigned int
int64_t ldb_msg_find_attr_as_int64 (const struct ldb_message *msg, const char *attr_name, int64_t default_value) — same but int64_t
uint64_t ldb_msg_find_attr_as_uint64 (const struct ldb_message *msg, const char *attr_name, uint64_t default_value) — same but uint64_t
double ldb_msg_find_attr_as_double (const struct ldb_message *msg, const char *attr_name, double default_value) — same but double ✨
int ldb_msg_find_attr_as_bool (const struct ldb_message *msg, const char *attr_name, int default_value) — same but as a bool, returned as an int, classic C behavior 🎀
const char * ldb_msg_find_attr_as_string (const struct ldb_message *msg, const char *attr_name, const char *default_value) — same but as a string
struct ldb_dn * ldb_msg_find_attr_as_dn (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const struct ldb_message *msg, const char *attr_name) — same but as a DN, and yes it needs both an ldb and a mem_ctx 🌸
void ldb_msg_sort_elements (struct ldb_message *msg) — sort those elements, organize your life bestie
struct ldb_message * ldb_msg_copy_shallow (TALLOC_CTX *mem_ctx, const struct ldb_message *msg) — a shallow copy, so it's copying the surface not the soul 💅
struct ldb_message * ldb_msg_copy (TALLOC_CTX *mem_ctx, const struct ldb_message *msg) — the full copy
struct ldb_message * ldb_msg_canonicalize (struct ldb_context *ldb, const struct ldb_message *msg) _DEPRECATED_ — > deprecated, so maybe don't start anything new with it 🚫
int ldb_msg_normalize (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const struct ldb_message *msg, struct ldb_message **_msg_out) — the non-deprecated normalizing girlie, output lands in _msg_out
struct ldb_message * ldb_msg_diff (struct ldb_context *ldb, struct ldb_message *msg1, struct ldb_message *msg2) _DEPRECATED_ — > also deprecated, bestie, heads up
int ldb_msg_difference (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, struct ldb_message *msg1, struct ldb_message *msg2, struct ldb_message **_msg_out) — return a ldb_message representing the differences between msg1 and msg2.
int ldb_msg_check_string_attribute (const struct ldb_message *msg, const char *name, const char *value) — Tries to find a certain string attribute in a message.
int ldb_msg_sanity_check (struct ldb_context *ldb, const struct ldb_message *msg) — Integrity check an ldb_message. the vibe check, but for data 🫶

okay we made it past the message mountain, take a breath, hydrate 🍓

struct ldb_val ldb_val_dup (TALLOC_CTX *mem_ctx, const struct ldb_val *v) — Duplicate an ldb_val structure.
int ldb_set_debug (struct ldb_context *ldb, void(*debug)(void *context, enum ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3, 0), void *context) — this allows the user to set a debug function for error reporting
void ldb_set_utf8_functions (struct ldb_context *ldb, void *context, char *(*casefold)(void *, void *, const char *, size_t n), int(*casecmp)(void *ctx, const struct ldb_val *v1, const struct ldb_val *v2)) — This allows the user to set custom utf8 functions.
void ldb_set_utf8_fns (struct ldb_context *ldb, void *context, char *(*casefold)(void *, void *, const char *, size_t n)) _DEPRECATED_ — This legacy function is for setting a custom utf8 casefold function. > deprecated legacy energy, use the newer one above 💅
int ldb_set_debug_stderr (struct ldb_context *ldb) — this sets up debug to print messages on stderr
int ldb_set_opaque (struct ldb_context *ldb, const char *name, void *value) — stash something opaque under a name
void * ldb_get_opaque (struct ldb_context *ldb, const char *name) — grab that opaque thing back out
const char ** ldb_attr_list_copy (TALLOC_CTX *mem_ctx, const char *const *attrs) — copy an attribute list
const char ** ldb_attr_list_copy_add (TALLOC_CTX *mem_ctx, const char *const *attrs, const char *new_attr) — copy it and add new_attr, multitasking queen 👑
int ldb_attr_in_list (const char *const *attrs, const char *attr) — is attr in attrs??
int ldb_msg_rename_attr (struct ldb_message *msg, const char *attr, const char *replace) — rename attr to replace
int ldb_msg_copy_attr (struct ldb_message *msg, const char *attr, const char *replace) — copy attr over to replace
void ldb_msg_remove_attr (struct ldb_message *msg, const char *attr) — bye bye attribute 🦋
void ldb_msg_remove_element (struct ldb_message *msg, struct ldb_message_element *el) — bye bye element
void ldb_parse_tree_attr_replace (struct ldb_parse_tree *tree, const char *attr, const char *replace) — swap attr for replace inside a parse tree
struct ldb_parse_tree * ldb_parse_tree_copy_shallow (TALLOC_CTX *mem_ctx, const struct ldb_parse_tree *ot) — shallow copy of a parse tree
char * ldb_timestring (TALLOC_CTX *mem_ctx, time_t t) — Convert a time structure to a string.
time_t ldb_string_to_time (const char *s) — Convert a string to a time structure.
int ldb_val_to_time (const struct ldb_val *v, time_t *t) — convert a LDAP GeneralizedTime string in ldb_val format to a time_t.
char * ldb_timestring_utc (TALLOC_CTX *mem_ctx, time_t t) — Convert a time structure to a string. (the UTC one ⭐)
time_t ldb_string_utc_to_time (const char *s) — Convert a string to a time structure. (UTC again, consistent queen 🌈)
void ldb_qsort (void *const pbase, size_t total_elems, size_t size, void *opaque, ldb_qsort_cmp_fn_t cmp) — sorting, but make it ldb
char * ldb_control_to_string (TALLOC_CTX *mem_ctx, const struct ldb_control *control) — Convert a control into its string representation.
struct ldb_control * ldb_parse_control_from_string (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *control_strings) — Convert a string representing a control into a ldb_control structure.
struct ldb_control ** ldb_parse_control_strings (struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char **control_strings) — Convert an array of string representation of a control into an array of ldb_control structures.
unsigned int ldb_get_flags (struct ldb_context *ldb) — return the ldb flags 🎀

void ldb_set_flags (struct ldb_context *ldb, unsigned flags)
struct ldb_dn * ldb_dn_binary_from_ldb_val (TALLOC_CTX *mem_ctx, struct
    ldb_context *ldb, const struct ldb_val *strdn)
int ldb_dn_get_binary (struct ldb_dn *dn, struct ldb_val *val)
int ldb_dn_set_binary (struct ldb_dn *dn, struct ldb_val *val)
void ldb_req_set_location (struct ldb_request *req, const char
    *location)
const char * ldb_req_location (struct ldb_request *req)
bool ldb_dn_minimise (struct ldb_dn *dn)
int ldb_val_string_cmp (const struct ldb_val *v, const char *str)

🌈 Detailed Description 🌈

Samba's ldb database. 💖

This header file provides the main API for ldb. Like, the whole vibe of ldb lives in here. It's giving "everything you need, bestie". 🫶

🎀 Macro Definition Documentation 🎀

okay this next bit is the macro section and it is LONG but it is also lowkey iconic so stay with me 💅

`#define discard_const( ptr)`

Value:

((void *)((uintptr_t)(ptr)))

`#define ldb_attr_cmp( a, b)`

Value:

strcasecmp(a, b)

Compare two attributes. This function compares to attribute names. Note that this is a case-insensitive comparison. ✨

Parameters

a — the first attribute name to compare
b — the second attribute name to compare

Returns

0 if the attribute names are the same, or only differ in case; non-zero if there are any differences 🌸

attribute names are restricted by rfc2251 so using strcasecmp and toupper here is ok. return 0 for match. no cap. 🧚

`#define LDB_ATTR_FLAG_FIXED (1<<2)`

The attribute is supplied by the application and should not be removed. 💀

`#define LDB_ATTR_FLAG_HIDDEN (1<<0)`

The attribute is not returned by default. 🙈 sneaky.

`#define LDB_CONTROL_AS_SYSTEM_OID '1.3.6.1.4.1.7165.4.3.7'`

LDB_CONTROL_AS_SYSTEM is used to skip access checks on operations that are performed by the system, but with a user's credentials, e.g. updating prefix map 👑

`#define LDB_CONTROL_ASQ_OID '1.2.840.113556.1.4.1504'`

OID for LDAP Attribute Scoped Query extension. This control is included in SearchRequest or SearchResponse messages as part of the controls field of the LDAPMessage. 🌟

`#define LDB_CONTROL_BYPASS_OPERATIONAL_OID '1.3.6.1.4.1.7165.4.3.13'`

OID for getting and manipulating attributes from the ldb without interception in the operational module. It can be used to access attribute that used to be stored in the sam and that are now calculated. 🔥

`#define LDB_CONTROL_DIRSYNC_OID '1.2.840.113556.1.4.841'`

OID for LDAP Directory Sync extension. This control is included in SearchRequest or SearchResponse messages as part of the controls field of the LDAPMessage. 💫

`#define LDB_CONTROL_DOMAIN_SCOPE_OID '1.2.840.113556.1.4.1339'`

OID for specifying an advanced scope for the search (one partition). 🎯

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_EXTENDED_DN_OID '1.2.840.113556.1.4.529'`

OID for extended DN. 🌸

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_NOTIFICATION_OID '1.2.840.113556.1.4.528'`

OID for notification. 🔔

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_PAGED_RESULTS_OID '1.2.840.113556.1.4.319'`

OID for the paged results control. This control is included in the searchRequest and searchResultDone messages as part of the controls field of the LDAPMessage, as defined in Section 4.1.12 of LDAP v3. 📄

See also

RFC 2696.

`#define LDB_CONTROL_PERMISSIVE_MODIFY_OID '1.2.840.113556.1.4.1413'`

OID to let modifies don't give an error when adding an existing attribute with the same value or deleting an nonexisting one attribute. 🫶 so forgiving.

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_POLICY_HINTS_DEPRECATED_OID '1.2.840.113556.1.4.2066'`

Another OID used to enforce password history length constraints in password reset. This works just like LDB_CONTROL_POLICY_HINTS_OID (above): if the control value is 0x1 on a password set operation, the password history constraints in MS-SAMR 3.1.1.7.1 "General Password Policy" apply as if this was a password change. 🔐

This is used by Entra ID in a password change.

It is also the OID for the ms-DS-Required-Domain-Behavior-Version attribute), which is unlikely to cause confusion given the contexts. 😭 (yes, the parenthesis in the original is doing its own thing, we don't touch it)

`#define LDB_CONTROL_POLICY_HINTS_OID '1.2.840.113556.1.4.2239'`

OID used to enforce password history length constraints in password reset. If this is control as the value 0x1 on a password set operation, the password history constraints in MS-SAMR 3.1.1.7.1 "GeneralPassword Policy" apply as if this was a password change. This may be used by Entra ID or Keycloak. 🔑

LDB_CONTROL_POLICY_HINTS_DEPRECATED_OID (below) does exactly the same thing and seems to be more widely used in practice. ✨

`#define LDB_CONTROL_PROVISION_OID '1.3.6.1.4.1.7165.4.3.16'`

LDB_CONTROL_PROVISION_OID is used to skip some constraint checks. It's is mainly thought to be used for the provisioning. 🛠️

`#define LDB_CONTROL_RECALCULATE_RDN_OID '1.3.6.1.4.1.7165.4.3.30'`

OID for recalculate RDN (rdn attribute and 'name') control. This control forces the rdn_name module to the recalculate the rdn and name attributes as if the object was just created. 🌱

`#define LDB_CONTROL_RECALCULATE_SD_OID '1.3.6.1.4.1.7165.4.3.5'`

OID for recalculate SD control. This control force the dsdb code to recalculate the SD of the object as if the object was just created. 🔄

`#define LDB_CONTROL_RELAX_OID '1.3.6.1.4.1.4203.666.5.12'`

OID for the allowing client to request temporary relaxed enforcement of constraints of the x.500 model. Mainly used for the OpenLDAP backend. 😌

See also

draft managedit.

`#define LDB_CONTROL_REVEAL_INTERNALS '1.3.6.1.4.1.7165.4.3.6'`

REVEAL_INTERNALS is used to reveal internal attributes and DN components which are not normally shown to the user. 👀 peek behind the curtain bestie.

`#define LDB_CONTROL_RODC_DCPROMO_OID '1.2.840.113556.1.4.1341'`

Control for RODC join -see [MS-ADTS] section 3.1.1.3.4.1.23. 👑

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_SD_FLAGS_OID '1.2.840.113556.1.4.801'`

OID for specifying the returned elements of the ntSecurityDescriptor. 🔐

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_SEARCH_OPTIONS_OID '1.2.840.113556.1.4.1340'`

OID for specifying an advanced scope for a search. 🔍

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_SERVER_LAZY_COMMIT '1.2.840.113556.1.4.619'`

OID to allow the server to be more 'fast and loose' with the data being added. 💅 it's giving chaotic.

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_SERVER_SORT_OID '1.2.840.113556.1.4.473'`

OID for LDAP server sort result extension. This control is included in the searchRequest message as part of the controls field of the LDAPMessage, as defined in Section 4.1.12 of LDAP v3. The controlType is set to "1.2.840.113556.1.4.473". The criticality MAY be either TRUE or FALSE (where absent is also equivalent to FALSE) at the client's option. ✨

See also

RFC 2891.

`#define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID '1.2.840.113556.1.4.2065'`

OID for getting deactivated linked attributes. 🦋

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_SHOW_DELETED_OID '1.2.840.113556.1.4.417'`

OID for getting deleted objects. 💀 they're still there bestie.

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_SHOW_RECYCLED_OID '1.2.840.113556.1.4.2064'`

OID for getting recycled objects. ♻️

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_SORT_RESP_OID '1.2.840.113556.1.4.474'`

OID for LDAP server sort result response extension. This control is included in the searchResultDone message as part of the controls field of the LDAPMessage, as defined in Section 4.1.12 of LDAP v3. 🌟

See also

RFC 2891.

`#define LDB_CONTROL_TREE_DELETE_OID '1.2.840.113556.1.4.805'`

OID for performing subtree deletes. 🌳✂️

See also

Microsoft documentation of this OID

`#define LDB_CONTROL_VERIFY_NAME_OID '1.2.840.113556.1.4.1338'`

OID for the allowing some kind of relax check for attributes with DNs. 😌

See also

3.1.1.3.4.1.16 in [MS-ADTS].pdf

`#define LDB_CONTROL_VLV_REQ_OID '2.16.840.1.113730.3.4.9'`

OID for LDAP Virtual List View Request extension. This control is included in SearchRequest messages as part of the controls field of the LDAPMessage. 🎀

`#define LDB_CONTROL_VLV_RESP_OID '2.16.840.1.113730.3.4.10'`

OID for LDAP Virtual List View Response extension. This control is included in SearchResponse messages as part of the controls field of the LDAPMessage. 🎀

`#define LDB_EXTENDED_DYNAMIC_OID '1.3.6.1.4.1.1466.101.119.1'`

OID for LDAP Extended Operation DYNAMIC_REFRESH. This Extended operation is used to create and maintain objects which exist only a specific time, e.g. when a certain client or a certain person is logged in. Data refreshes have to be periodically sent in a specific interval. Otherwise the entry is going to be removed. ⏳

`#define LDB_EXTENDED_FAST_BIND_OID '1.2.840.113556.1.4.1781'`

OID for LDAP Extended Operation FAST_BIND. This Extended operations is used to perform a fast bind. ⚡

`#define LDB_EXTENDED_PASSWORD_CHANGE_OID '1.3.6.1.4.1.4203.1.11.1'`

OID for LDAP Extended Operation PASSWORD_CHANGE. This Extended operation is used to allow user password changes by the user itself. 🔑

`#define LDB_EXTENDED_SEQUENCE_NUMBER '1.3.6.1.4.1.7165.4.4.3'`

OID for LDAP Extended Operation SEQUENCE_NUMBER. This extended operation is used to retrieve the extended sequence number. 🔢

`#define LDB_EXTENDED_START_TLS_OID '1.3.6.1.4.1.1466.20037'`

OID for LDAP Extended Operation START_TLS. This Extended operation is used to start a new TLS channel on top of a clear text channel. 🔒✨

`#define LDB_EXTENDED_WHOAMI_OID '1.3.6.1.4.1.4203.1.11.3'`

OID for RFC4532 "Who Am I" extended operation. 🪞

`#define LDB_FLAG_FORCE_NO_BASE64_LDIF 4`

Flag value used in ldb_ldif_write_trace() to enforce binary encoded attribute values per attribute. This is a genuine flag, being outside LDB_FLAG_MOD_MASK and also outside LDB_FLAG_INTERNAL_MASK 💅

`#define LDB_FLAG_INTERNAL_MASK 0xFFFFFFF0`

flag bits on an element usable only by the internal implementation. 🙈 hands off bestie.

`#define LDB_FLAG_MOD_ADD 1`

Value used in ldap_modify() to indicate that attributes are being added. ➕

See also

LDB_FLAG_MOD_MASK

`#define LDB_FLAG_MOD_DELETE 3`

Value used in ldap_modify() to indicate that attributes are being deleted. 🗑️

See also

LDB_FLAG_MOD_MASK

`#define LDB_FLAG_MOD_MASK 0x3`

There are a number of flags that are used with ldap_modify() in ldb_message_element.flags fields. The LDB_FLAG_MOD_ADD, LDB_FLAG_MOD_DELETE and LDB_FLAG_MOD_REPLACE are better thought of as an enumeration, not flags, and are used in ldap_modify() calls to specify whether attributes are being added, deleted or modified respectively. 👑

`#define LDB_FLAG_MOD_REPLACE 2`

Value used in ldap_modify() to indicate that attributes are being replaced. 🔁

See also

LDB_FLAG_MOD_MASK

`#define LDB_FLAG_MOD_TYPE( flags)`

Value:

((flags) & LDB_FLAG_MOD_MASK)

use this to extract the mod type (enum) from the operation 🧚✨

LDB_FLG_DONT_CREATE_DB = 64 — okay so this one is a boundary-setting queen 💅 it tells LDB not to go make a new database file. Why do we care? Because without this flag, ldb_tdb (for example, bestie, for example) will just casually create a blank file during an invocation of ldb_connect(), even when the caller literally only wanted to do read operations — like, for example, in ldbsearch. Rude of it honestly.
LDB_FLG_ENABLE_TRACING = 32 — flags to enable ldb tracing ✨
LDB_FLG_NOMMAP = 8 — the "bestie please chill with the memory mapping" flag. Tells backends not to use mmap. 🫶
LDB_FLG_NOSYNC = 2 — a flag value for database connection mode. If LDB_FLG_NOSYNC is used in ldb_connect, then the database will be opened without synchronous operations, if possible. if possible. iykyk.
LDB_FLG_PRIVATE_MASK = 0xff000000 — this one lets you allow DB create time flags that have meaning only to your calling application or your modules 🌈 (your little private corner of flag-space, we love that for you). These must be in this range:
LDB_FLG_RDONLY = 1 — flag value for database connection mode. If LDB_FLG_RDONLY is used in ldb_connect, then the database will be opened read-only, if possible. 🔒

Examples: ldbreader.c.

LDB_FLG_RECONNECT = 4 — flag value to specify autoreconnect mode. If LDB_FLG_RECONNECT is used in ldb_connect, then the backend will be opened in a way that makes it try to auto reconnect if the connection is dropped (this actually makes sense only with ldap). 💀 "my wifi dropped mid-query and the backend just ✨recovers✨"
LDB_FLG_SHOW_BINARY = 16 — flag to tell ldif handlers not to force encoding of binary structures in base64. show me the raw vibes.
LDB_OID_COMPARATOR_AND = '1.2.840.113556.1.4.803' — OID for logic AND comparison. This is the well known object ID for a logical AND comparator. 🎀
LDB_OID_COMPARATOR_OR = '1.2.840.113556.1.4.804' — OID for logic OR comparison. This is the well known object ID for a logical OR comparator. 🎀
LDB_REQ_SET_LOCATION( req) — okay so this is a macro whose Value is:

ldb_req_set_location(req, __location__)

little one-liner, iconic, does exactly what it says. 💅

LDB_SYNTAX_BOOLEAN = '1.3.6.1.4.1.1466.115.121.1.7' — LDAP attribute syntax for a boolean. This is the well-known LDAP attribute syntax for a boolean.

See RFC 2252, Section 4.3.2

LDB_SYNTAX_DIRECTORY_STRING = '1.3.6.1.4.1.1466.115.121.1.15' — LDAP attribute syntax for a Directory String. This is the well-known LDAP attribute syntax for a Directory String.

🧚 FUNCTION DOCUMENTATION 🧚

okay bestie, deep breath, we're in the function zone now. every one of these lives in ldb.h and they're all so valid. let's go. 💖

int int ldb_add (struct ldb_context * ldb, const struct ldb_message * message) — Add a record to the database. (yes the int int is really in there, we don't touch it, we respect the artifact 👑)

This function adds a record to the database. This function will fail if a record with the specified class and key already exists in the database. no duplicates, we don't do that here.

Parameters

ldb — the context associated with the database (from ldb_init())
message — the message containing the record to add.

Returns

result code (LDB_SUCCESS if the record was added, otherwise a failure code)

int ldb_base64_decode (char * s) — Base64 decode a buffer. This function decodes a base64 encoded string in place. 🫶

Parameters

s — the string to decode.

Returns

the length of the returned (decoded) string.

Note: the string is null terminated, but the null terminator is not included in the length. (the null is just there for vibes, not for counting 🌸)

char * ldb_base64_encode (TALLOC_CTX * mem_ctx, const char * buf, int len) — Base64 encode a buffer. ✨

Parameters

mem_ctx — the memory context that the result is allocated from.
buf — pointer to the array that is to be encoded
len — the number of elements in the array to be encoded

Returns

pointer to an array containing the encoded data

Note: The caller is responsible for freeing the result. that's on you bestie, talloc won't do it for you 💀

char * ldb_binary_encode (TALLOC_CTX * mem_ctx, struct ldb_val val) — Encode a binary blob. This function encodes a binary blob using the encoding rules in RFC 2254 (Section 4). This function also escapes any non-printable characters. 🦋

Parameters

mem_ctx — the memory context to allocate the return string in.
val — the (potentially) binary data to be encoded

Returns

the encoded data as a null terminated string

See also: RFC 2252.

char * ldb_binary_encode_string (TALLOC_CTX * mem_ctx, const char * string) — Encode a string. This function encodes a string using the encoding rules in RFC 2254 (Section 4). This function also escapes any non-printable characters. 🎀

Parameters

mem_ctx — the memory context to allocate the return string in.
string — the string to be encoded

Returns

the encoded data as a null terminated string

See also: RFC 2252.

int ldb_build_add_req (struct ldb_request ** ret_req, struct ldb_context * ldb, TALLOC_CTX * mem_ctx, const struct ldb_message * message, struct ldb_control ** controls, void * context, ldb_request_callback_t callback, struct ldb_request * parent) — Helper function to build an add request. 🛠️

Parameters

ret_req — the request structure is returned here (talloced on mem_ctx)
ldb — the context associated with the database (from ldb_init())
mem_ctx — a talloc memory context (used as parent of ret_req)
message — contains the entry to be added
controls — an array of controls
context — the callback function context
callback — the callback function to handle the async replies
parent — the parent request if any

Returns

result code (LDB_SUCCESS on success, or a failure code)

int ldb_build_del_req (struct ldb_request ** ret_req, struct ldb_context * ldb, TALLOC_CTX * mem_ctx, struct ldb_dn * dn, struct ldb_control ** controls, void * context, ldb_request_callback_t callback, struct ldb_request * parent) — Helper function to build a delete request. 🗑️

Parameters

ret_req — the request structure is returned here (talloced on mem_ctx)
ldb — the context associated with the database (from ldb_init())
mem_ctx — a talloc memory context (used as parent of ret_req)
dn — the DN to be deleted
controls — an array of controls
context — the callback function context
callback — the callback function to handle the async replies
parent — the parent request if any

Returns

result code (LDB_SUCCESS on success, or a failure code)

int ldb_build_extended_req (struct ldb_request ** ret_req, struct ldb_context * ldb, TALLOC_CTX * mem_ctx, const char * oid, void * data, struct ldb_control ** controls, void * context, ldb_request_callback_t callback, struct ldb_request * parent) — Helper function to build a extended request. 🌈

Parameters

ret_req — the request structure is returned here (talloced on mem_ctx)
ldb — the context associated with the database (from ldb_init())
mem_ctx — a talloc memory context (used as parent of ret_req)
oid — the OID of the extended operation.
data — a void pointer to the extended operation specific parameters, it needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it
controls — an array of controls
context — the callback function context
callback — the callback function to handle the async replies
parent — the parent request if any

Returns

result code (LDB_SUCCESS on success, or a failure code)

int ldb_build_mod_req (struct ldb_request ** ret_req, struct ldb_context * ldb, TALLOC_CTX * mem_ctx, const struct ldb_message * message, struct ldb_control ** controls, void * context, ldb_request_callback_t callback, struct ldb_request * parent) — Helper function to build a modify request. 💅

Parameters

ret_req — the request structure is returned here (talloced on mem_ctx)
ldb — the context associated with the database (from ldb_init())
mem_ctx — a talloc memory context (used as parent of ret_req)
message — contains the entry to be modified
controls — an array of controls
context — the callback function context
callback — the callback function to handle the async replies
parent — the parent request if any

Returns

result code (LDB_SUCCESS on success, or a failure code)

int ldb_build_rename_req (struct ldb_request ** ret_req, struct ldb_context * ldb, TALLOC_CTX * mem_ctx, struct ldb_dn * olddn, struct ldb_dn * newdn, struct ldb_control ** controls, void * context, ldb_request_callback_t callback, struct ldb_request * parent) — Helper function to build a rename request. ✨

Parameters

ret_req — the request structure is returned here (talloced on mem_ctx)
ldb — the context associated with the database (from ldb_init())
mem_ctx — a talloc memory context (used as parent of ret_req)
olddn — the old DN
newdn — the new DN
controls — an array of controls
context — the callback function context
callback — the callback function to handle the async replies
parent — the parent request if any

Returns

result code (LDB_SUCCESS on success, or a failure code)

int ldb_build_search_req (struct ldb_request ** ret_req, struct ldb_context * ldb, TALLOC_CTX * mem_ctx, struct ldb_dn * base, enum ldb_scope scope, const char * expression, const char *const * attrs, struct ldb_control ** controls, void * context, ldb_request_callback_t callback, struct ldb_request * parent) — Helper function to build a search request. 🔍

Parameters

ret_req — the request structure gets returned right here, and it's talloced onto mem_ctx 💖
ldb — the context tied to the database (you got it from ldb_init())
mem_ctx — a talloc memory context, used as the parent of ret_req
base — the Base Distinguished Name for the query (use ldb_dn_new() if you want an empty one)
scope — the search scope for the query
expression — the search expression this query is gonna use
attrs — the search attributes for the query (pass NULL if you don't need any)
controls — an array of controls
context — the callback function context
callback — the callback function that handles the async replies
parent — the parent request, if there is one

Returns

result code (LDB_SUCCESS on success, or a failure code) ✨

🎀 `ldb_casefold`

char * ldb_casefold (struct ldb_context * ldb, TALLOC_CTX * mem_ctx, const char * s, size_t n)

Casefold a string, bestie. Heads up tho: the callback needs to be ASCII compatible. So ASCII has to be handled first, before any UTF-8 — that's literally required so you don't get weird issues with dotted languages 👑

Parameters

ldb — the ldb context
mem_ctx — the memory context the result string's memory gets allocated from
s — the string that's about to be folded

Returns

a copy of the string, converted to upper case 💅

Note

The default function is not yet UTF8 aware. Provide your own set of functions through ldb_set_utf8_fns() 🙈

🌈 `ldb_connect`

int ldb_connect (struct ldb_context * ldb, const char * url, unsigned int flags, const char * options[])

Connect to a database. This is typically called soon after ldb_init(), and it's required before any search or database modification operations. no cap.

The URL can be one of these forms, and only these:

tdb://path
ldapi://path
ldap://host
mdb://path

Parameters

ldb — the context associated with the database (from ldb_init())
url — the URL of the database to connect to, as noted above
flags — a combination of LDB_FLG_* to modify the connection behaviour
options — backend specific options, passed uninterpreted straight to the backend

Returns

result code (LDB_SUCCESS on success, or a failure code) ✨

Note

It's an error to connect to a database that doesn't exist in readonly mode (that is, with LDB_FLG_RDONLY). But in read-write mode? The database just gets created if it's not there 🦋

Examples

ldbreader.c.

💜 `ldb_control_to_string`

char * ldb_control_to_string (TALLOC_CTX * mem_ctx, const struct ldb_control * control)

Convert a control into its string representation. glow up moment ✨

Parameters

mem_ctx — TALLOC context to return result on, and to allocate error_string on
control — a struct ldb_control to convert

Returns

string representation of the control 🎀

⭐ `ldb_controls_get_control`

struct ldb_control * ldb_controls_get_control (struct ldb_control ** controls, const char * oid)

Check if a control with the specified oid exists and hand it over 💅

Parameters

controls — the array of controls
oid — the object identifier of the control as string

Returns

the control, or NULL if it's not found 😭

🔥 `ldb_delete`

int ldb_delete (struct ldb_context * ldb, struct ldb_dn * dn)

Delete a record from the database. Yeah, that's it, that's the whole job — this function deletes a record from the database. gone. periodt.

Parameters

ldb — the context associated with the database (from ldb_init())
dn — the DN for the record to be deleted

Returns

result code (LDB_SUCCESS if the record was deleted, otherwise a failure code) 🌸

🦋 `ldb_dn_alloc_linearized`

char * ldb_dn_alloc_linearized (TALLOC_CTX * mem_ctx, struct ldb_dn * dn)

Allocate a copy of the linear form of a DN (without any extended components) onto the supplied memory context. iconic.

Parameters

dn — The DN to linearize
mem_ctx — TALLOC context to return result on

👑 `ldb_dn_from_ldb_val`

struct ldb_dn struct ldb_dn * ldb_dn_from_ldb_val (TALLOC_CTX * mem_ctx, struct ldb_context * ldb, const struct ldb_val * strdn)

Allocate a new DN from a struct ldb_val (super useful to avoid buffer overrun, fr fr).

Parameters

mem_ctx — TALLOC context to return resulting ldb_dn structure on
dn — The new DN

Note

The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntactically correct 🙈

🌈 `ldb_dn_get_extended_linearized`

char * ldb_dn_get_extended_linearized (TALLOC_CTX * mem_ctx, struct ldb_dn * dn, int mode)

Get the linear form of a DN — this time with any extended components 💖

Parameters

mem_ctx — TALLOC context to return result on
dn — The DN to linearize
mode — Style of extended DN to return (0 is HEX representation of binary form, 1 is a string form)

🎀 `ldb_dn_get_linearized`

const char * ldb_dn_get_linearized (struct ldb_dn * dn)

Get the linear form of a DN (without any extended components). that's the whole vibe.

Parameters

dn — The DN to linearize

✨ `ldb_dn_new`

struct ldb_dn * ldb_dn_new (TALLOC_CTX * mem_ctx, struct ldb_context * ldb, const char * dn)

Allocate a new DN from a string. slay 💅

Parameters

mem_ctx — TALLOC context to return resulting ldb_dn structure on
dn — The new DN

Note

The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntactically correct 🦋

💜 `ldb_dn_new_fmt`

struct ldb_dn * ldb_dn_new_fmt (TALLOC_CTX * mem_ctx, struct ldb_context * ldb, const char * new_fmt,  ...)

Allocate a new DN from a printf style format string and arguments. fancy.

Parameters

mem_ctx — TALLOC context to return resulting ldb_dn structure on
new_fmt — The new DN as a format string (plus arguments)

Note

The DN will not be parsed at this time. Use ldb_dn_validate to tell if the DN is syntactically correct 😭

⭐ `ldb_dn_validate`

bool ldb_dn_validate (struct ldb_dn * dn)

Determine if this DN is syntactically valid. vibe check, but for DNs 🌸

Parameters

dn — The DN to validate

🔥 `ldb_errstring`

const char * ldb_errstring (struct ldb_context * ldb)

Return extended error information from the last call. the receipts, basically 💀

🌈 `ldb_extended`

int ldb_extended (struct ldb_context * ldb, const char * oid, void * data, struct ldb_result ** res)

Call an extended operation 🚀

Parameters

ldb — the context associated with the database (from ldb_init())
oid — the OID of the extended operation
data — a void pointer to the extended operation specific parameters. It needs to be NULL or a valid talloc pointer! talloc_get_type() will be used on it 👀
res — the result of the extended operation

Returns

result code (LDB_SUCCESS if the extended operation returned fine, otherwise a failure code) ✨

🦋 `ldb_extended_default_callback`

int ldb_extended_default_callback (struct ldb_request * req, struct ldb_reply * ares)

The default async extended operation callback function. it's giving default, but make it cute.

Parameters

req — the request we are callback of
ares — a single reply from the async core

Returns

result code (LDB_SUCCESS on success, or a failure code) 💖

Note

this function expects req->context to always be an struct ldb_result pointer AND a talloc context. This function will steal on the context each message from the ares reply passed on by the async core, so that in the end all the messages will be in the context (ldb_result) memory tree. Freeing the passed context (ldb_result tree) will free all the resources — but the request needs to be freed separately, and the result does not depend on the request, which can be freed as soon as the search request is finished 👑

🎀 `ldb_get_flags`

unsigned int ldb_get_flags (struct ldb_context * ldb)

Return the ldb flags. that's it bestie 🫶

✨ `ldb_global_init`

int ldb_global_init (void )

Initialise ldbs' global information. This is required before any other LDB call. periodt.

Returns

0 if initialisation succeeded, -1 otherwise 😭

👑 `ldb_init`

struct ldb_context * ldb_init (TALLOC_CTX * mem_ctx, struct tevent_context * ev_ctx)

Initialise an ldb context. Also required before any other LDB call 💅

Parameters

mem_ctx — pointer to a talloc memory context. Pass NULL if there's no suitable context available.

Note

The LDB modules will be loaded from the directory specified by the environment variable LDB_MODULES_PATH. If that variable isn't specified, the compiled-in default is used 🌈

Returns

pointer to ldb_context that should be free'd (using talloc_free()) at the end of the program 🎀

Examples

ldbreader.c, and ldifreader.c.

💜 `ldb_ldif_message_redacted_string`

char * ldb_ldif_message_redacted_string (struct ldb_context * ldb, TALLOC_CTX * mem_ctx, enum ldb_changetype changetype, const struct ldb_message * msg)

Write an LDB message to a string ✍️

Parameters

ldb — the ldb context (from ldb_init())
mem_ctx — the talloc context on which to attach the string)
changetype — LDB_CHANGETYPE_ADD or LDB_CHANGETYPE_MODIFY
msg — the message to write out

Returns

the string containing the LDIF, or NULL on error — but with secret attributes redacted 🙈

Note

The secret attributes are specified in a 'const char * const *' within the LDB_SECRET_ATTRIBUTE_LIST opaque set on the ldb 👀

🌈 `ldb_ldif_message_string`

char * ldb_ldif_message_string (struct ldb_context * ldb, TALLOC_CTX * mem_ctx, enum ldb_changetype changetype, const struct ldb_message * msg)

Write an LDB message to a string ✍️

Parameters

ldb — the ldb context (from ldb_init())
mem_ctx — the talloc context on which to attach the string)
changetype — LDB_CHANGETYPE_ADD or LDB_CHANGETYPE_MODIFY
msg — the message to write out

Returns

the string containing the LDIF, or NULL on error 🌸

⭐ `ldb_ldif_parse_modrdn`

int ldb_ldif_parse_modrdn (struct ldb_context * ldb, const struct ldb_ldif * ldif, TALLOC_CTX * mem_ctx, struct ldb_dn ** olddn, struct ldb_dn ** newrdn, bool * deleteoldrdn, struct ldb_dn ** newsuperior, struct ldb_dn ** newdn)

Parse a modrdn LDIF message from a struct ldb_message 🧚

Parameters

ldb — the ldb context (from ldb_init())
ldif — the preparsed LDIF chunk (from ldb_ldif_read())
mem_ctx — the memory context that's used for return values
olddn — the old dn as struct ldb_dn, if not needed pass NULL
newrdn — the new rdn as struct ldb_dn, if not needed pass NULL
deleteoldrdn — the deleteoldrdn value as bool, if not needed pass NULL
newsuperior — the newsuperior dn as struct ldb_dn, if not needed pass NULL. newsuperior can be NULL as it is optional in the LDIF 👀
newdn — the full constructed new dn as struct ldb_dn, if not needed pass NULL

🦋 `ldb_ldif_read`

struct ldb_ldif * ldb_ldif_read (struct ldb_context * ldb, int(* fgetc_fn )(void *), void * private_data)

Read an LDIF message. This function creates an LDIF message using a caller supplied read function 💅

Parameters

ldb — the ldb context (from ldb_init()) 💖
fgetc_fn — a function pointer for the read function. This one's gotta take a private data pointer, and it must return a pointer to an integer that's the next byte read (or EOF if there's literally nothing left to read).
private_data — pointer that gets handed right back to the read function. Super handy for keeping state or context around. 🎀

Returns

the LDIF message that has been read in ✨

Note

You must free the LDIF message when you don't need it anymore, using ldb_ldif_read_free(). Not optional, bestie. 💅

💖 `struct ldb_ldif * ldb_ldif_read_file (struct ldb_context * ldb, FILE * f)`

Read an LDIF message from a file. This one pulls the next LDIF message out of the contents of a file stream. Wanna get all the LDIF messages? Then you're gonna repeatedly call this function until it hands you back NULL. That's the whole loop, no cap. 🦋

Parameters

ldb — the ldb context (from ldb_init())
f — the file stream to read from (typically from fdopen())

Examples

ldifreader.c.

🌸 `void ldb_ldif_read_free (struct ldb_context * ldb, struct ldb_ldif * msg)`

Clean up an LDIF message. This function cleans up a LDIF message read using ldb_ldif_read() or related functions (such as ldb_ldif_read_string() and ldb_ldif_read_file(). 🧚

Parameters

ldb — the ldb context (from ldb_init())
msg — the message to clean up and free

Examples

ldifreader.c.

🎀 `struct ldb_ldif * ldb_ldif_read_string (struct ldb_context * ldb, const char ** s)`

Read an LDIF message from a string. This one reads the next LDIF message from the contents of a char array. Want all of the LDIF messages? Same deal — keep calling this function until it returns NULL. 🔥

Parameters

ldb — the ldb context (from ldb_init())
s — pointer to the char array to read from

👑 `int ldb_ldif_write (struct ldb_context * ldb, int(* )(void , const char ,...) PRINTF_ATTRIBUTE fprintf_fn(2, 3), void * private_data, const struct ldb_ldif * ldif)`

Write an LDIF message. This function writes an LDIF message using a write function that you, the caller, supply. Main character energy, honestly. 💅

Parameters

ldb — the ldb context (from ldb_init())
fprintf_fn — a function pointer for the write function. It's gotta take a private data pointer, then a format string, then a variable argument list.
private_data — pointer that will be provided back to the write function. Great for holding onto state or context. 🫶
ldif — the message to write out

Returns

the total number of bytes written, or an error code as returned from the write function.

Examples

ldbreader.c, and ldifreader.c.

🌈 `int ldb_ldif_write_file (struct ldb_context * ldb, FILE * f, const struct ldb_ldif * msg)`

Write an LDIF message to a file. 💖

Parameters

ldb — the ldb context (from ldb_init())
f — the file stream to write to (typically from fdopen())
msg — the message to write out

Returns

the total number of bytes written, or a negative error code

⭐ `char * ldb_ldif_write_string (struct ldb_context * ldb, TALLOC_CTX * mem_ctx, const struct ldb_ldif * msg)`

Write an LDIF message to a string. ✨

Parameters

ldb — the ldb context (from ldb_init())
mem_ctx — the talloc context on which to attach the string
msg — the message to write out

Returns

the string containing the LDIF, or NULL on error 😭

💜 `int ldb_modify (struct ldb_context * ldb, const struct ldb_message * message)`

Modify the specified attributes of a record. This function modifies a record that's already chilling in the database. 🦋

Parameters

ldb — the context associated with the database (from ldb_init())
message — the message containing the changes required.

Returns

result code (LDB_SUCCESS if the record was modified as requested, otherwise a failure code)

🍓 `int ldb_msg_add (struct ldb_message * msg, const struct ldb_message_element * el, int flags)`

add a element to a ldb_message 🌸

🧚 `int ldb_msg_add_empty (struct ldb_message * msg, const char * attr_name, int flags, struct ldb_message_element ** return_el)`

add a new empty element to a ldb_message

🎀 `int int ldb_msg_append_value (struct ldb_message * msg, const char * attr_name, const struct ldb_val * val, int flags)`

append a element to a ldb_message

💅 `int ldb_msg_check_string_attribute (const struct ldb_message * msg, const char * name, const char * value)`

Tries to find a certain string attribute in a message. 🔍

Parameters

msg — the message to check
name — attribute name
value — attribute value

Returns

1 on match and 0 otherwise.

🔥 `int ldb_msg_difference (struct ldb_context * ldb, TALLOC_CTX * mem_ctx, struct ldb_message * msg1, struct ldb_message * msg2, struct ldb_message ** _msg_out)`

return a ldb_message representing the differences between msg1 and msg2. And if you then use this in a ldb_modify() call, it can be used to save edits to a message. Iconic behaviour honestly. 👑

Result message is constructed as follows:

LDB_FLAG_MOD_ADD — elements found only in msg2
LDB_FLAG_MOD_REPLACE — elements in msg2 that have different value in msg1 Value for msg2 element is used
LDB_FLAG_MOD_DELETE — elements found only in msg2

Returns

LDB_SUCCESS or LDB_ERR_OPERATIONS_ERROR

🌈 `int ldb_msg_element_add_value (TALLOC_CTX * mem_ctx, struct ldb_message_element * el, const struct ldb_val * val)`

add a value to a message element 💖

⭐ `int int ldb_msg_element_compare (struct ldb_message_element * el1, struct ldb_message_element * el2)`

compare two message elements — return 0 on match

🦋 `struct ldb_message_element * ldb_msg_find_element (const struct ldb_message * msg, const char * attr_name)`

Find an element within an message. 🎀

🌸 `const struct ldb_val * ldb_msg_find_ldb_val (const struct ldb_message * msg, const char * attr_name)`

Find elements in a message. This function finds elements and converts to a specific type, with a given default value if not found. Assumes that elements are single valued. 📌

🧚 `struct ldb_val * ldb_msg_find_val (const struct ldb_message_element * el, struct ldb_val * val)`

find a value within an ldb_message_element

Parameters

el — the element to search
val — the value to search for

Note

This search is case sensitive. Don't come crying when Foo and foo don't match, bestie. 💀

💜 `struct ldb_message * ldb_msg_new (TALLOC_CTX * mem_ctx)`

Create an empty message. ✨

Parameters

mem_ctx — the memory context to create in. You can pass NULL to get the top level context, however the ldb context (from ldb_init()) may be a better choice

👑 `int ldb_msg_sanity_check (struct ldb_context * ldb, const struct ldb_message * msg)`

Integrity check an ldb_message. This function performs basic sanity / integrity checks on an ldb_message. Vibe check for your message, fr fr. 🫶

Parameters

ldb — context in which to perform the checks
msg — the message to check

Returns

LDB_SUCCESS if the message is OK, or a non-zero error code (one of LDB_ERR_INVALID_DN_SYNTAX, LDB_ERR_ENTRY_ALREADY_EXISTS or LDB_ERR_INVALID_ATTRIBUTE_SYNTAX) if there is a problem with a message.

💖 `int ldb_op_default_callback (struct ldb_request * req, struct ldb_reply * ares)`

The default async extended operation callback function. 🌈

Parameters

req — the request we are callback of
ares — a single reply from the async core

Returns

result code (LDB_SUCCESS on success, or a failure code)

🎀 `struct ldb_control * ldb_parse_control_from_string (struct ldb_context * ldb, TALLOC_CTX * mem_ctx, const char * control_strings)`

Convert a string representing a control into a ldb_control structure. ✨

Parameters

ldb — LDB context
mem_ctx — TALLOC context to return result on, and to allocate error_string on
control_strings — A string-formatted control

Returns

a ldb_control element

🦋 `struct ldb_control ** ldb_parse_control_strings (struct ldb_context * ldb, TALLOC_CTX * mem_ctx, const char ** control_strings)`

Convert an array of string representation of a control into an array of ldb_control structures. 💅

Parameters

ldb — LDB context
mem_ctx — TALLOC context to return result on, and to allocate error_string on
control_strings — Array of string-formatted controls

Returns

array of ldb_control elements

🔥 `int ldb_rename (struct ldb_context * ldb, struct ldb_dn * olddn, struct ldb_dn * newdn)`

Rename a record in the database. This function renames a record in the database. 🌟

Parameters

ldb — the context associated with the database (from ldb_init())
olddn — the DN for the record to be renamed.
newdn — the new DN

Returns

result code (LDB_SUCCESS if the record was renamed as requested, otherwise a failure code)

💜 `struct ldb_control * ldb_reply_get_control (struct ldb_reply * rep, const char * oid)`

check if a control with the specified "oid" exist and return it 🔍

Parameters

rep — the reply struct to search for the control
oid — the object identifier of the control as string

Returns

the control, NULL if not found 😭

🌈 `int ldb_request_add_control (struct ldb_request * req, const char * oid, bool critical, void * data)`

Add a ldb_control to a ldb_request. ✨

Parameters

req — the request struct where to add the control
oid — the object identifier of the control as string
critical — whether the control should be critical or not
data — a talloc pointer to the control specific data

Returns

result code (LDB_SUCCESS on success, or a failure code)

🎀 `struct ldb_control * ldb_request_get_control (struct ldb_request * req, const char * oid)`

check if a control with the specified "oid" exist and return it 🫶

Parameters

req — the request struct to search for the control
oid — the object identifier of the control as string
Returns — the control, or NULL if it wasn't found 🫶

💅 `ldb_request_replace_control`

int ldb_request_replace_control (struct ldb_request * req, const char * oid,
    bool critical, void * data)

Swaps out a ldb_control inside a ldb_request, bestie. Out with the old, in with the new ✨

Parameters

req — the request struct where we're adding the control
oid — the object identifier of the control, as a string
critical — whether the control should be critical or not
data — a talloc pointer to the control-specific data

Returns

result code — LDB_SUCCESS if it slayed, or a failure code 😭

🔍 `ldb_search`

int ldb_search (struct ldb_context * ldb, TALLOC_CTX * mem_ctx,
    struct ldb_result ** result, struct ldb_dn * base,
    enum ldb_scope scope, const char *const * attrs,
    const char * exp_fmt, ...)

Search the database, babe 💖 This one goes digging through the database and hands you back the records that match an LDAP-ish search expression. It's the main character of lookups, fr fr.

Parameters

ldb — the context tied to the database (the one you got from ldb_init())
mem_ctx — the memory context to use for the request and the results
result — the return result
base — the Base Distinguished Name for the query (use ldb_dn_new() if you want an empty one)
scope — the search scope for the query
attrs — the search attributes for the query (pass NULL if you don't need any)
exp_fmt — the search expression for this query (printf-like, so it takes the ... args)

Returns

result code — LDB_SUCCESS on success, or a failure code 🫠

Note: use talloc_free() to free the ldb_result you get back, bestie. Don't just leave it lying there 💀

Examples

ldbreader.c.

🎀 `ldb_search_default_callback`

int ldb_search_default_callback (struct ldb_request * req,
    struct ldb_reply * ares)

The default async search callback function. It's giving "reliable friend who handles your replies for you" 🌸

Parameters

req — the request we're the callback of
ares — a single reply from the async core

Returns

result code — LDB_SUCCESS on success, or a failure code

Note: this function expects req->context to always be a struct ldb_result pointer AND a talloc context. It will steal onto that context every single message from the ares reply that the async core passes along, so that in the end all the messages live inside that context (ldb_result) memory tree. Freeing the context you passed in (the ldb_result tree) frees all the resources. The request has to be freed separately, and the result does not depend on the request — so you can free the request the moment the search request is finished 💅

🔢 `ldb_sequence_number`

int ldb_sequence_number (struct ldb_context * ldb,
    enum ldb_sequence_type type, uint64_t * seq_num)

Obtain the current/next database sequence number. Numbers, but make it mysterious ✨

🐛 `ldb_set_debug`

int ldb_set_debug (struct ldb_context * ldb, void(*  )(void *context, enum
    ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE
    debug(3, 0), void * context)

This lets you, the user, set your very own debug function for error reporting. Custom bug-spotting, periodt 🔥

🖥️ `ldb_set_debug_stderr`

int ldb_set_debug_stderr (struct ldb_context * ldb)

Sets up debug so all the messages print on stderr. Old reliable 👑

🌈 `ldb_set_utf8_default`

void ldb_set_utf8_default (struct ldb_context * ldb)

Sets up the default utf8 functions. FIXME: these functions do not yet handle utf8 🙈 (yes, we know, we know — it's literally in the source)

🧚 `ldb_set_utf8_fns`

void ldb_set_utf8_fns (struct ldb_context * ldb, void * context,
    char *(* casefold )(void *, void *, const char *, size_t n))

This legacy function is for setting a custom utf8 casefold function. It cannot set a comparison function, which makes it very difficult for a comparison to be both efficient and correct. Not it 💀

Use ldb_set_utf8_functions() instead! Like, for real, bestie, that's the upgrade.

💜 `ldb_set_utf8_functions`

void ldb_set_utf8_functions (struct ldb_context * ldb, void * context,
    char *(* casefold )(void *, void *, const char *, size_t n),
    int(* casecmp )(void *ctx, const struct ldb_val *v1,
    const struct ldb_val *v2))

This allows you to set custom utf8 functions. Be aware that casefolding in some locales will break ldb's expectations 😬 In particular, if 'i' is uppercased to 'İ' (a capital I with a dot, used in some languages), the string '<guid=' will not equal '<GUID='. Rude, honestly.

The default functions casefold ASCII only, and the ones Samba uses are built on a version of the NTFS UCS-2 upcase table which is dotted-i safe. Samba stays winning 🏆

The context argument gets passed to the casefold() and casecmp() functions as their first argument. It's unused in the default and Samba implementations, but you could, for example, use it to hold a libICU context.

The second argument for the casefold function is a TALLOC context.

📢 `ldb_strerror`

const char * ldb_strerror (int ldb_err)

Returns a string explaining what a ldb error constant actually means. Translating cryptic into clear, iykyk 🫶

⏰ `ldb_string_to_time`

time_t ldb_string_to_time (const char * s)

Converts a string to a time structure. Specifically, this turns an LDAP formatted GeneralizedTime string into a time_t structure.

Parameters

s — the string to convert

Returns

the time structure, or 0 if the string can't be converted 😭

🕰️ `ldb_string_utc_to_time`

time_t ldb_string_utc_to_time (const char * s)

Converts a string to a time structure. This one turns an LDAP formatted UTCTime string into a time_t structure. Different format, same energy ✨

Parameters

s — the string to convert

Returns

the time structure, or 0 if the string can't be converted

📅 `ldb_timestring`

char * ldb_timestring (TALLOC_CTX * mem_ctx, time_t t)

Converts a time structure to a string. This one takes a time_t structure and gives you back an LDAP formatted GeneralizedTime string.

Parameters

mem_ctx — the memory context to allocate the return string in
t — the time structure to convert

Returns

the formatted string, or NULL if the time structure couldn't be converted 🫠

🗓️ `ldb_timestring_utc`

char * ldb_timestring_utc (TALLOC_CTX * mem_ctx, time_t t)

Converts a time structure to a string. This one takes a time_t structure and gives you back an LDAP formatted UTCTime string.

Parameters

mem_ctx — the memory context to allocate the return string in
t — the time structure to convert

Returns

the formatted string, or NULL if the time structure couldn't be converted

🛑 `ldb_transaction_cancel`

int ldb_transaction_cancel (struct ldb_context * ldb)

Cancel a transaction. Nope, never mind, we're not doing this 💀

✅ `ldb_transaction_commit`

int ldb_transaction_commit (struct ldb_context * ldb)

Commit a transaction. Locking it in, no take-backs 💅

🪄 `ldb_transaction_prepare_commit`

int ldb_transaction_prepare_commit (struct ldb_context * ldb)

First phase of two phase commit. The "getting ready" era before the actual "doing it" era ✨

🚀 `ldb_transaction_start`

int ldb_transaction_start (struct ldb_context * ldb)

Start a transaction. And so it begins, bestie 🎬

🦋 `ldb_val_dup`

struct ldb_val ldb_val_dup (TALLOC_CTX * mem_ctx,
    const struct ldb_val * v)

Duplicates an ldb_val structure. This copies an ldb value structure, so you get your own little clone 🫶

Parameters

mem_ctx — the memory context the duplicated value will be allocated from
v — the ldb_val to be duplicated.

Returns

the duplicated ldb_val structure. Twins! 👯

⚖️ `ldb_val_equal_exact`

int ldb_val_equal_exact (const struct ldb_val * v1,
    const struct ldb_val * v2)

Compares two ldb_val values. Are they the same? Vibe check 🔍

Parameters

v1 — first ldb_val structure to be tested
v2 — second ldb_val structure to be tested

Returns

1 for a match, 0 if there's any difference. Exact or nothing, no notes 💅

⏳ `ldb_val_to_time`

int ldb_val_to_time (const struct ldb_val * v, time_t * t)

Converts an LDAP GeneralizedTime string in ldb_val format to a time_t. Time-zone-hopping from val-land into time-land 🌸

🔤 `ldb_valid_attr_name`

int ldb_valid_attr_name (const char * s)

Checks that the attribute name is valid according to rfc2251. Gatekeeping, but make it standards-compliant 👑

Parameters

s — the string to check

Returns

1 if the name is ok ✅

💖 Author

Generated automatically by Doxygen for LDB from the source code. (Not a human, just a very diligent robot who never misses 🫡)

And that's a wrap on the whole page, bestie!! 🎀 You made it all the way to the bottom, which is honestly iconic behavior 👑 The little footer at the very end stamps the source/version as LDB and the page as include/ldb.h(3) — that's your "the end, go touch grass" marker 💅✨ 🌈

📦 where this page comes from

fedora 44: libldb-devel 2:4.24.0-6.fc44 · LGPL-3.0-or-later
fedora 44: libldb-devel 2:4.24.0-6.fc44 · LGPL-3.0-or-later
fedora 44: libldb-devel 2:4.24.7-1.fc44 · LGPL-3.0-or-later
fedora 44: libldb-devel 2:4.24.7-1.fc44 · LGPL-3.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

include/ldb.h(3)

✨ NAME ✨

🌸 SYNOPSIS 🌸

🦋 Data Structures 🦋

✨ Macros ✨

✨ Typedefs ✨

✨ Enumerations ✨

🦋 enum ldb_changetype

🌸 enum ldb_scope

🎀 enum ldb_debug_level

🧚 enum ldb_parse_op

🌈 enum ldb_request_type

⭐ enum ldb_reply_type

💜 enum ldb_wait_type

🍓 enum ldb_state

🦋 enum ldb_sequence_type

✨ FUNCTIONS ✨

🌈 Detailed Description 🌈

🎀 Macro Definition Documentation 🎀

#define discard_const( ptr)

#define ldb_attr_cmp( a, b)

#define LDB_ATTR_FLAG_FIXED (1<<2)

#define LDB_ATTR_FLAG_HIDDEN (1<<0)

#define LDB_CONTROL_AS_SYSTEM_OID '1.3.6.1.4.1.7165.4.3.7'

#define LDB_CONTROL_ASQ_OID '1.2.840.113556.1.4.1504'

#define LDB_CONTROL_BYPASS_OPERATIONAL_OID '1.3.6.1.4.1.7165.4.3.13'

#define LDB_CONTROL_DIRSYNC_OID '1.2.840.113556.1.4.841'

#define LDB_CONTROL_DOMAIN_SCOPE_OID '1.2.840.113556.1.4.1339'

#define LDB_CONTROL_EXTENDED_DN_OID '1.2.840.113556.1.4.529'

#define LDB_CONTROL_NOTIFICATION_OID '1.2.840.113556.1.4.528'

#define LDB_CONTROL_PAGED_RESULTS_OID '1.2.840.113556.1.4.319'

#define LDB_CONTROL_PERMISSIVE_MODIFY_OID '1.2.840.113556.1.4.1413'

#define LDB_CONTROL_POLICY_HINTS_DEPRECATED_OID '1.2.840.113556.1.4.2066'

#define LDB_CONTROL_POLICY_HINTS_OID '1.2.840.113556.1.4.2239'

#define LDB_CONTROL_PROVISION_OID '1.3.6.1.4.1.7165.4.3.16'

#define LDB_CONTROL_RECALCULATE_RDN_OID '1.3.6.1.4.1.7165.4.3.30'

#define LDB_CONTROL_RECALCULATE_SD_OID '1.3.6.1.4.1.7165.4.3.5'

#define LDB_CONTROL_RELAX_OID '1.3.6.1.4.1.4203.666.5.12'

#define LDB_CONTROL_REVEAL_INTERNALS '1.3.6.1.4.1.7165.4.3.6'

#define LDB_CONTROL_RODC_DCPROMO_OID '1.2.840.113556.1.4.1341'

#define LDB_CONTROL_SD_FLAGS_OID '1.2.840.113556.1.4.801'

#define LDB_CONTROL_SEARCH_OPTIONS_OID '1.2.840.113556.1.4.1340'

#define LDB_CONTROL_SERVER_LAZY_COMMIT '1.2.840.113556.1.4.619'

#define LDB_CONTROL_SERVER_SORT_OID '1.2.840.113556.1.4.473'

#define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID '1.2.840.113556.1.4.2065'

#define LDB_CONTROL_SHOW_DELETED_OID '1.2.840.113556.1.4.417'

#define LDB_CONTROL_SHOW_RECYCLED_OID '1.2.840.113556.1.4.2064'

#define LDB_CONTROL_SORT_RESP_OID '1.2.840.113556.1.4.474'

#define LDB_CONTROL_TREE_DELETE_OID '1.2.840.113556.1.4.805'

#define LDB_CONTROL_VERIFY_NAME_OID '1.2.840.113556.1.4.1338'

#define LDB_CONTROL_VLV_REQ_OID '2.16.840.1.113730.3.4.9'

#define LDB_CONTROL_VLV_RESP_OID '2.16.840.1.113730.3.4.10'

#define LDB_EXTENDED_DYNAMIC_OID '1.3.6.1.4.1.1466.101.119.1'

#define LDB_EXTENDED_FAST_BIND_OID '1.2.840.113556.1.4.1781'

#define LDB_EXTENDED_PASSWORD_CHANGE_OID '1.3.6.1.4.1.4203.1.11.1'

#define LDB_EXTENDED_SEQUENCE_NUMBER '1.3.6.1.4.1.7165.4.4.3'

#define LDB_EXTENDED_START_TLS_OID '1.3.6.1.4.1.1466.20037'

#define LDB_EXTENDED_WHOAMI_OID '1.3.6.1.4.1.4203.1.11.3'

#define LDB_FLAG_FORCE_NO_BASE64_LDIF 4

#define LDB_FLAG_INTERNAL_MASK 0xFFFFFFF0

#define LDB_FLAG_MOD_ADD 1

#define LDB_FLAG_MOD_DELETE 3

#define LDB_FLAG_MOD_MASK 0x3

#define LDB_FLAG_MOD_REPLACE 2

#define LDB_FLAG_MOD_TYPE( flags)

🧚 FUNCTION DOCUMENTATION 🧚

Parameters

Returns

🎀 ldb_casefold

Parameters

Returns

Note

🌈 ldb_connect

Parameters

Returns

Note

Examples

💜 ldb_control_to_string

Parameters

Returns

🦋 `enum ldb_changetype`

🌸 `enum ldb_scope`

🎀 `enum ldb_debug_level`

🧚 `enum ldb_parse_op`

🌈 `enum ldb_request_type`

⭐ `enum ldb_reply_type`

💜 `enum ldb_wait_type`

🍓 `enum ldb_state`

🦋 `enum ldb_sequence_type`

`#define discard_const( ptr)`

`#define ldb_attr_cmp( a, b)`

`#define LDB_ATTR_FLAG_FIXED (1<<2)`

`#define LDB_ATTR_FLAG_HIDDEN (1<<0)`

`#define LDB_CONTROL_AS_SYSTEM_OID '1.3.6.1.4.1.7165.4.3.7'`

`#define LDB_CONTROL_ASQ_OID '1.2.840.113556.1.4.1504'`

`#define LDB_CONTROL_BYPASS_OPERATIONAL_OID '1.3.6.1.4.1.7165.4.3.13'`

`#define LDB_CONTROL_DIRSYNC_OID '1.2.840.113556.1.4.841'`

`#define LDB_CONTROL_DOMAIN_SCOPE_OID '1.2.840.113556.1.4.1339'`

`#define LDB_CONTROL_EXTENDED_DN_OID '1.2.840.113556.1.4.529'`

`#define LDB_CONTROL_NOTIFICATION_OID '1.2.840.113556.1.4.528'`

`#define LDB_CONTROL_PAGED_RESULTS_OID '1.2.840.113556.1.4.319'`

`#define LDB_CONTROL_PERMISSIVE_MODIFY_OID '1.2.840.113556.1.4.1413'`

`#define LDB_CONTROL_POLICY_HINTS_DEPRECATED_OID '1.2.840.113556.1.4.2066'`

`#define LDB_CONTROL_POLICY_HINTS_OID '1.2.840.113556.1.4.2239'`

`#define LDB_CONTROL_PROVISION_OID '1.3.6.1.4.1.7165.4.3.16'`

`#define LDB_CONTROL_RECALCULATE_RDN_OID '1.3.6.1.4.1.7165.4.3.30'`

`#define LDB_CONTROL_RECALCULATE_SD_OID '1.3.6.1.4.1.7165.4.3.5'`

`#define LDB_CONTROL_RELAX_OID '1.3.6.1.4.1.4203.666.5.12'`

`#define LDB_CONTROL_REVEAL_INTERNALS '1.3.6.1.4.1.7165.4.3.6'`

`#define LDB_CONTROL_RODC_DCPROMO_OID '1.2.840.113556.1.4.1341'`

`#define LDB_CONTROL_SD_FLAGS_OID '1.2.840.113556.1.4.801'`

`#define LDB_CONTROL_SEARCH_OPTIONS_OID '1.2.840.113556.1.4.1340'`

`#define LDB_CONTROL_SERVER_LAZY_COMMIT '1.2.840.113556.1.4.619'`

`#define LDB_CONTROL_SERVER_SORT_OID '1.2.840.113556.1.4.473'`

`#define LDB_CONTROL_SHOW_DEACTIVATED_LINK_OID '1.2.840.113556.1.4.2065'`

`#define LDB_CONTROL_SHOW_DELETED_OID '1.2.840.113556.1.4.417'`

`#define LDB_CONTROL_SHOW_RECYCLED_OID '1.2.840.113556.1.4.2064'`

`#define LDB_CONTROL_SORT_RESP_OID '1.2.840.113556.1.4.474'`

`#define LDB_CONTROL_TREE_DELETE_OID '1.2.840.113556.1.4.805'`

`#define LDB_CONTROL_VERIFY_NAME_OID '1.2.840.113556.1.4.1338'`

`#define LDB_CONTROL_VLV_REQ_OID '2.16.840.1.113730.3.4.9'`

`#define LDB_CONTROL_VLV_RESP_OID '2.16.840.1.113730.3.4.10'`

`#define LDB_EXTENDED_DYNAMIC_OID '1.3.6.1.4.1.1466.101.119.1'`

`#define LDB_EXTENDED_FAST_BIND_OID '1.2.840.113556.1.4.1781'`

`#define LDB_EXTENDED_PASSWORD_CHANGE_OID '1.3.6.1.4.1.4203.1.11.1'`

`#define LDB_EXTENDED_SEQUENCE_NUMBER '1.3.6.1.4.1.7165.4.4.3'`

`#define LDB_EXTENDED_START_TLS_OID '1.3.6.1.4.1.1466.20037'`

`#define LDB_EXTENDED_WHOAMI_OID '1.3.6.1.4.1.4203.1.11.3'`

`#define LDB_FLAG_FORCE_NO_BASE64_LDIF 4`

`#define LDB_FLAG_INTERNAL_MASK 0xFFFFFFF0`

`#define LDB_FLAG_MOD_ADD 1`

`#define LDB_FLAG_MOD_DELETE 3`

`#define LDB_FLAG_MOD_MASK 0x3`

`#define LDB_FLAG_MOD_REPLACE 2`

`#define LDB_FLAG_MOD_TYPE( flags)`

🎀 `ldb_casefold`

🌈 `ldb_connect`

💜 `ldb_control_to_string`

⭐ `ldb_controls_get_control`

🔥 `ldb_delete`

🦋 `ldb_dn_alloc_linearized`

👑 `ldb_dn_from_ldb_val`

🌈 `ldb_dn_get_extended_linearized`

🎀 `ldb_dn_get_linearized`

✨ `ldb_dn_new`

💜 `ldb_dn_new_fmt`

⭐ `ldb_dn_validate`

🔥 `ldb_errstring`

🌈 `ldb_extended`

🦋 `ldb_extended_default_callback`

🎀 `ldb_get_flags`

✨ `ldb_global_init`

👑 `ldb_init`

💜 `ldb_ldif_message_redacted_string`

🌈 `ldb_ldif_message_string`

⭐ `ldb_ldif_parse_modrdn`

🦋 `ldb_ldif_read`

💖 `struct ldb_ldif * ldb_ldif_read_file (struct ldb_context * ldb, FILE * f)`

🌸 `void ldb_ldif_read_free (struct ldb_context * ldb, struct ldb_ldif * msg)`

🎀 `struct ldb_ldif * ldb_ldif_read_string (struct ldb_context * ldb, const char ** s)`