lib/ldb/include/ldb_module.h

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Simo Sorce         2008
   5
   6      ** NOTE! The following LGPL license applies to the ldb
   7      ** library. This does NOT imply that all of Samba is released
   8      ** under the LGPL
   9
  10    This library is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU Lesser General Public
  12    License as published by the Free Software Foundation; either
  13    version 3 of the License, or (at your option) any later version.
  14
  15    This library is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    Lesser General Public License for more details.
  19
  20    You should have received a copy of the GNU Lesser General Public
  21    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 /*
  25  *  Name: ldb
  26  *
  27  *  Component: ldb module header
  28  *
  29  *  Description: defines ldb modules structures and helpers
  30  *
  31  */
  32
  33 #ifndef _LDB_MODULE_H_
  34 #define _LDB_MODULE_H_
  35
  36 #include <ldb.h>
  37
  38 struct ldb_context;
  39 struct ldb_module;
  40
  41 /**
  42    internal flag bits on message elements. Must be within LDB_FLAG_INTERNAL_MASK
  43  */
  44 #define LDB_FLAG_INTERNAL_DISABLE_VALIDATION 0x10
  45
  46 /* disable any single value checking on this attribute */
  47 #define LDB_FLAG_INTERNAL_DISABLE_SINGLE_VALUE_CHECK 0x20
  48
  49 /* attribute has failed access check and must not be exposed */
  50 #define LDB_FLAG_INTERNAL_INACCESSIBLE_ATTRIBUTE 0x40
  51
  52 /* force single value checking on this attribute */
  53 #define LDB_FLAG_INTERNAL_FORCE_SINGLE_VALUE_CHECK 0x80
  54
  55 /* an extended match rule that always fails to match */
  56 #define SAMBA_LDAP_MATCH_ALWAYS_FALSE "1.3.6.1.4.1.7165.4.5.1"
  57
  58 /*
  59    these function pointers define the operations that a ldb module can intercept
  60 */
  61 struct ldb_module_ops {
  62         const char *name;
  63         int (*init_context) (struct ldb_module *);
  64         int (*search)(struct ldb_module *, struct ldb_request *); /* search */
  65         int (*add)(struct ldb_module *, struct ldb_request *); /* add */
  66         int (*modify)(struct ldb_module *, struct ldb_request *); /* modify */
  67         int (*del)(struct ldb_module *, struct ldb_request *); /* delete */
  68         int (*rename)(struct ldb_module *, struct ldb_request *); /* rename */
  69         int (*request)(struct ldb_module *, struct ldb_request *); /* match any other operation */
  70         int (*extended)(struct ldb_module *, struct ldb_request *); /* extended operations */
  71         int (*start_transaction)(struct ldb_module *);
  72         int (*prepare_commit)(struct ldb_module *);
  73         int (*end_transaction)(struct ldb_module *);
  74         int (*del_transaction)(struct ldb_module *);
  75         int (*sequence_number)(struct ldb_module *, struct ldb_request *);
  76         void *private_data;
  77 };
  78
  79
  80 /* The following definitions come from lib/ldb/common/ldb_debug.c  */
  81 void ldb_debug(struct ldb_context *ldb, enum ldb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
  82 void ldb_debug_set(struct ldb_context *ldb, enum ldb_debug_level level,
  83                    const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
  84 void ldb_debug_add(struct ldb_context *ldb, const char *fmt, ...) PRINTF_ATTRIBUTE(2, 3);
  85 void ldb_debug_end(struct ldb_context *ldb, enum ldb_debug_level level);
  86
  87 #define ldb_error(ldb, ecode, reason) ldb_error_at(ldb, ecode, reason, __FILE__, __LINE__)
  88
  89 #define ldb_oom(ldb) ldb_error(ldb, LDB_ERR_OPERATIONS_ERROR, "ldb out of memory")
  90 #define ldb_module_oom(module) ldb_oom(ldb_module_get_ctx(module))
  91 #define ldb_operr(ldb) ldb_error(ldb, LDB_ERR_OPERATIONS_ERROR, "operations error")
  92
  93 /* The following definitions come from lib/ldb/common/ldb.c  */
  94
  95 void ldb_request_set_state(struct ldb_request *req, int state);
  96 int ldb_request_get_status(struct ldb_request *req);
  97
  98 unsigned int ldb_get_create_perms(struct ldb_context *ldb);
  99
 100 const struct ldb_schema_syntax *ldb_standard_syntax_by_name(struct ldb_context *ldb,
 101                                                             const char *syntax);
 102
 103 /* The following definitions come from lib/ldb/common/ldb_attributes.c  */
 104
 105 int ldb_schema_attribute_add_with_syntax(struct ldb_context *ldb,
 106                                          const char *name,
 107                                          unsigned flags,
 108                                          const struct ldb_schema_syntax *syntax);
 109 int ldb_schema_attribute_add(struct ldb_context *ldb,
 110                              const char *name,
 111                              unsigned flags,
 112                              const char *syntax);
 113 void ldb_schema_attribute_remove(struct ldb_context *ldb, const char *name);
 114
 115 /* we allow external code to override the name -> schema_attribute function */
 116 typedef const struct ldb_schema_attribute *(*ldb_attribute_handler_override_fn_t)(struct ldb_context *, void *, const char *);
 117
 118 void ldb_schema_attribute_set_override_handler(struct ldb_context *ldb,
 119                                                ldb_attribute_handler_override_fn_t override,
 120                                                void *private_data);
 121
 122 /* A useful function to build comparison functions with */
 123 int ldb_any_comparison(struct ldb_context *ldb, void *mem_ctx,
 124                        ldb_attr_handler_t canonicalise_fn,
 125                        const struct ldb_val *v1,
 126                        const struct ldb_val *v2);
 127
 128 /* The following definitions come from lib/ldb/common/ldb_controls.c  */
 129 int ldb_save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver);
 130 /* Returns a list of controls, except the one specified.  Included
 131  * controls become a child of returned list if they were children of
 132  * controls_in */
 133 struct ldb_control **ldb_controls_except_specified(struct ldb_control **controls_in,
 134                                                TALLOC_CTX *mem_ctx,
 135                                                struct ldb_control *exclude);
 136 int ldb_check_critical_controls(struct ldb_control **controls);
 137
 138 /* The following definitions come from lib/ldb/common/ldb_ldif.c  */
 139 int ldb_should_b64_encode(struct ldb_context *ldb, const struct ldb_val *val);
 140
 141 /* The following definitions come from lib/ldb/common/ldb_match.c  */
 142 int ldb_match_msg(struct ldb_context *ldb,
 143                   const struct ldb_message *msg,
 144                   const struct ldb_parse_tree *tree,
 145                   struct ldb_dn *base,
 146                   enum ldb_scope scope);
 147
 148 int ldb_match_msg_error(struct ldb_context *ldb,
 149                         const struct ldb_message *msg,
 150                         const struct ldb_parse_tree *tree,
 151                         struct ldb_dn *base,
 152                         enum ldb_scope scope,
 153                         bool *matched);
 154
 155 int ldb_match_msg_objectclass(const struct ldb_message *msg,
 156                               const char *objectclass);
 157
 158 /* The following definitions come from lib/ldb/common/ldb_modules.c  */
 159
 160 struct ldb_module *ldb_module_new(TALLOC_CTX *memctx,
 161                                   struct ldb_context *ldb,
 162                                   const char *module_name,
 163                                   const struct ldb_module_ops *ops);
 164
 165 const char * ldb_module_get_name(struct ldb_module *module);
 166 struct ldb_context *ldb_module_get_ctx(struct ldb_module *module);
 167 void *ldb_module_get_private(struct ldb_module *module);
 168 void ldb_module_set_private(struct ldb_module *module, void *private_data);
 169 const struct ldb_module_ops *ldb_module_get_ops(struct ldb_module *module);
 170
 171 int ldb_next_request(struct ldb_module *module, struct ldb_request *request);
 172 int ldb_next_start_trans(struct ldb_module *module);
 173 int ldb_next_end_trans(struct ldb_module *module);
 174 int ldb_next_del_trans(struct ldb_module *module);
 175 int ldb_next_prepare_commit(struct ldb_module *module);
 176 int ldb_next_init(struct ldb_module *module);
 177
 178 void ldb_set_errstring(struct ldb_context *ldb, const char *err_string);
 179 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 180 void ldb_reset_err_string(struct ldb_context *ldb);
 181 int ldb_error_at(struct ldb_context *ldb, int ecode, const char *reason, const char *file, int line);
 182
 183 const char *ldb_default_modules_dir(void);
 184
 185 int ldb_register_module(const struct ldb_module_ops *);
 186
 187 typedef int (*ldb_connect_fn)(struct ldb_context *ldb, const char *url,
 188                               unsigned int flags, const char *options[],
 189                               struct ldb_module **module);
 190
 191 struct ldb_backend_ops {
 192         const char *name;
 193         ldb_connect_fn connect_fn;
 194 };
 195
 196 const char *ldb_default_modules_dir(void);
 197
 198 int ldb_register_backend(const char *url_prefix, ldb_connect_fn, bool);
 199
 200 struct ldb_handle *ldb_handle_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb);
 201
 202 int ldb_module_send_entry(struct ldb_request *req,
 203                           struct ldb_message *msg,
 204                           struct ldb_control **ctrls);
 205
 206 int ldb_module_send_referral(struct ldb_request *req,
 207                                            char *ref);
 208
 209 int ldb_module_done(struct ldb_request *req,
 210                     struct ldb_control **ctrls,
 211                     struct ldb_extended *response,
 212                     int error);
 213
 214 int ldb_mod_register_control(struct ldb_module *module, const char *oid);
 215
 216 void ldb_set_default_dns(struct ldb_context *ldb);
 217 /**
 218   Add a ldb_control to a ldb_reply
 219
 220   \param ares the reply struct where to add the control
 221   \param oid the object identifier of the control as string
 222   \param critical whether the control should be critical or not
 223   \param data a talloc pointer to the control specific data
 224
 225   \return result code (LDB_SUCCESS on success, or a failure code)
 226 */
 227 int ldb_reply_add_control(struct ldb_reply *ares, const char *oid, bool critical, void *data);
 228
 229 /**
 230   mark a request as untrusted. This tells the rootdse module to remove
 231   unregistered controls
 232  */
 233 void ldb_req_mark_untrusted(struct ldb_request *req);
 234
 235 /**
 236   mark a request as trusted.
 237  */
 238 void ldb_req_mark_trusted(struct ldb_request *req);
 239
 240 /**
 241    return true is a request is untrusted
 242  */
 243 bool ldb_req_is_untrusted(struct ldb_request *req);
 244
 245 /**
 246   set custom flags. Those flags are set by applications using ldb,
 247   they are application dependent and the same bit can have different
 248   meaning in different application.
 249  */
 250 void ldb_req_set_custom_flags(struct ldb_request *req, uint32_t flags);
 251
 252 /**
 253   get custom flags. Those flags are set by applications using ldb,
 254   they are application dependent and the same bit can have different
 255   meaning in different application.
 256  */
 257 uint32_t ldb_req_get_custom_flags(struct ldb_request *req);
 258
 259 /* load all modules from the given directory */
 260 int ldb_modules_load(const char *modules_path, const char *version);
 261
 262 /* init functions prototype */
 263 typedef int (*ldb_module_init_fn)(const char *);
 264
 265 /*
 266   general ldb hook function
 267  */
 268 enum ldb_module_hook_type { LDB_MODULE_HOOK_CMDLINE_OPTIONS     = 1,
 269                             LDB_MODULE_HOOK_CMDLINE_PRECONNECT  = 2,
 270                             LDB_MODULE_HOOK_CMDLINE_POSTCONNECT = 3 };
 271
 272 typedef int (*ldb_hook_fn)(struct ldb_context *, enum ldb_module_hook_type );
 273
 274 /*
 275   register a ldb hook function
 276  */
 277 int ldb_register_hook(ldb_hook_fn hook_fn);
 278
 279 /*
 280   call ldb hooks of a given type
 281  */
 282 int ldb_modules_hook(struct ldb_context *ldb, enum ldb_module_hook_type t);
 283
 284 #define LDB_MODULE_CHECK_VERSION(version) do { \
 285  if (strcmp(version, LDB_VERSION) != 0) { \
 286         fprintf(stderr, "ldb: module version mismatch in %s : ldb_version=%s module_version=%s\n", \
 287                         __FILE__, version, LDB_VERSION); \
 288         return LDB_ERR_UNAVAILABLE; \
 289  }} while (0)
 290
 291
 292 /*
 293   return a string representation of the calling chain for the given
 294   ldb request
 295  */
 296 char *ldb_module_call_chain(struct ldb_request *req, TALLOC_CTX *mem_ctx);
 297
 298 /*
 299   return the next module in the chain
 300  */
 301 struct ldb_module *ldb_module_next(struct ldb_module *module);
 302
 303 /*
 304   set the next module in the module chain
 305  */
 306 void ldb_module_set_next(struct ldb_module *module, struct ldb_module *next);
 307
 308 /*
 309   load a list of modules
 310  */
 311 int ldb_module_load_list(struct ldb_context *ldb, const char **module_list,
 312                          struct ldb_module *backend, struct ldb_module **out);
 313
 314 /*
 315   get the popt_options pointer in the ldb structure. This allows a ldb
 316   module to change the command line parsing
 317  */
 318 struct poptOption **ldb_module_popt_options(struct ldb_context *ldb);
 319
 320 /* modules are called in inverse order on the stack.
 321    Lets place them as an admin would think the right order is.
 322    Modules order is important */
 323 const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string);
 324
 325 /*
 326   return the current ldb flags LDB_FLG_*
 327  */
 328 uint32_t ldb_module_flags(struct ldb_context *ldb);
 329
 330 int ldb_module_connect_backend(struct ldb_context *ldb,
 331                                const char *url,
 332                                const char *options[],
 333                                struct ldb_module **backend_module);
 334
 335 /*
 336   initialise a chain of modules
 337  */
 338 int ldb_module_init_chain(struct ldb_context *ldb, struct ldb_module *module);
 339
 340 /*
 341  * prototype for the init function defined by dynamically loaded modules
 342  */
 343 int ldb_init_module(const char *version);
 344
 345 /* replace the components of a DN with those from another DN, without
 346  * touching the extended components
 347  *
 348  * return true if successful and false if not
 349  * if false is returned the dn may be marked invalid
 350  */
 351 bool ldb_dn_replace_components(struct ldb_dn *dn, struct ldb_dn *new_dn);
 352
 353 /*
 354   walk a parse tree, calling the provided callback on each node
 355 */
 356 int ldb_parse_tree_walk(struct ldb_parse_tree *tree,
 357                         int (*callback)(struct ldb_parse_tree *tree, void *),
 358                         void *private_context);
 359
 360 #endif