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 void ldb_vdebug(struct ldb_context *ldb, enum ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3, 0);
  87
  88 #define ldb_error(ldb, ecode, reason) ldb_error_at(ldb, ecode, reason, __FILE__, __LINE__)
  89 #define ldb_module_error(module, ecode, reason) ldb_error_at(ldb_module_get_ctx(module), ecode, reason, __FILE__, __LINE__)
  90
  91 #define ldb_oom(ldb) ldb_error(ldb, LDB_ERR_OPERATIONS_ERROR, "ldb out of memory")
  92 #define ldb_module_oom(module) ldb_oom(ldb_module_get_ctx(module))
  93 #define ldb_operr(ldb) ldb_error(ldb, LDB_ERR_OPERATIONS_ERROR, "operations error")
  94 #define ldb_module_operr(module) ldb_error(ldb_module_get_ctx(module), LDB_ERR_OPERATIONS_ERROR, "operations error")
  95
  96 /* The following definitions come from lib/ldb/common/ldb.c  */
  97
  98 void ldb_request_set_state(struct ldb_request *req, int state);
  99 int ldb_request_get_status(struct ldb_request *req);
 100
 101 unsigned int ldb_get_create_perms(struct ldb_context *ldb);
 102
 103 const struct ldb_schema_syntax *ldb_standard_syntax_by_name(struct ldb_context *ldb,
 104                                                             const char *syntax);
 105
 106 /* The following definitions come from lib/ldb/common/ldb_attributes.c  */
 107
 108 int ldb_schema_attribute_add_with_syntax(struct ldb_context *ldb,
 109                                          const char *name,
 110                                          unsigned flags,
 111                                          const struct ldb_schema_syntax *syntax);
 112 int ldb_schema_attribute_add(struct ldb_context *ldb,
 113                              const char *name,
 114                              unsigned flags,
 115                              const char *syntax);
 116 void ldb_schema_attribute_remove(struct ldb_context *ldb, const char *name);
 117
 118 /* we allow external code to override the name -> schema_attribute function */
 119 typedef const struct ldb_schema_attribute *(*ldb_attribute_handler_override_fn_t)(struct ldb_context *, void *, const char *);
 120
 121 void ldb_schema_attribute_set_override_handler(struct ldb_context *ldb,
 122                                                ldb_attribute_handler_override_fn_t override,
 123                                                void *private_data);
 124
 125 /* A useful function to build comparison functions with */
 126 int ldb_any_comparison(struct ldb_context *ldb, void *mem_ctx,
 127                        ldb_attr_handler_t canonicalise_fn,
 128                        const struct ldb_val *v1,
 129                        const struct ldb_val *v2);
 130
 131 /* The following definitions come from lib/ldb/common/ldb_controls.c  */
 132 int ldb_save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver);
 133 /* Returns a list of controls, except the one specified.  Included
 134  * controls become a child of returned list if they were children of
 135  * controls_in */
 136 struct ldb_control **ldb_controls_except_specified(struct ldb_control **controls_in,
 137                                                TALLOC_CTX *mem_ctx,
 138                                                struct ldb_control *exclude);
 139 int ldb_check_critical_controls(struct ldb_control **controls);
 140
 141 /* The following definitions come from lib/ldb/common/ldb_ldif.c  */
 142 int ldb_should_b64_encode(struct ldb_context *ldb, const struct ldb_val *val);
 143
 144 /* The following definitions come from lib/ldb/common/ldb_match.c  */
 145 int ldb_match_msg(struct ldb_context *ldb,
 146                   const struct ldb_message *msg,
 147                   const struct ldb_parse_tree *tree,
 148                   struct ldb_dn *base,
 149                   enum ldb_scope scope);
 150
 151 int ldb_match_msg_error(struct ldb_context *ldb,
 152                         const struct ldb_message *msg,
 153                         const struct ldb_parse_tree *tree,
 154                         struct ldb_dn *base,
 155                         enum ldb_scope scope,
 156                         bool *matched);
 157
 158 int ldb_match_msg_objectclass(const struct ldb_message *msg,
 159                               const char *objectclass);
 160
 161 /* The following definitions come from lib/ldb/common/ldb_modules.c  */
 162
 163 struct ldb_module *ldb_module_new(TALLOC_CTX *memctx,
 164                                   struct ldb_context *ldb,
 165                                   const char *module_name,
 166                                   const struct ldb_module_ops *ops);
 167
 168 const char * ldb_module_get_name(struct ldb_module *module);
 169 struct ldb_context *ldb_module_get_ctx(struct ldb_module *module);
 170 void *ldb_module_get_private(struct ldb_module *module);
 171 void ldb_module_set_private(struct ldb_module *module, void *private_data);
 172 const struct ldb_module_ops *ldb_module_get_ops(struct ldb_module *module);
 173
 174 int ldb_next_request(struct ldb_module *module, struct ldb_request *request);
 175 int ldb_next_start_trans(struct ldb_module *module);
 176 int ldb_next_end_trans(struct ldb_module *module);
 177 int ldb_next_del_trans(struct ldb_module *module);
 178 int ldb_next_prepare_commit(struct ldb_module *module);
 179 int ldb_next_init(struct ldb_module *module);
 180
 181 void ldb_set_errstring(struct ldb_context *ldb, const char *err_string);
 182 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 183 void ldb_reset_err_string(struct ldb_context *ldb);
 184 int ldb_error_at(struct ldb_context *ldb, int ecode, const char *reason, const char *file, int line);
 185
 186 const char *ldb_default_modules_dir(void);
 187
 188 int ldb_register_module(const struct ldb_module_ops *);
 189
 190 typedef int (*ldb_connect_fn)(struct ldb_context *ldb, const char *url,
 191                               unsigned int flags, const char *options[],
 192                               struct ldb_module **module);
 193
 194 struct ldb_backend_ops {
 195         const char *name;
 196         ldb_connect_fn connect_fn;
 197 };
 198
 199 const char *ldb_default_modules_dir(void);
 200
 201 int ldb_register_backend(const char *url_prefix, ldb_connect_fn, bool);
 202
 203 struct ldb_handle *ldb_handle_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb);
 204
 205 int ldb_module_send_entry(struct ldb_request *req,
 206                           struct ldb_message *msg,
 207                           struct ldb_control **ctrls);
 208
 209 int ldb_module_send_referral(struct ldb_request *req,
 210                                            char *ref);
 211
 212 int ldb_module_done(struct ldb_request *req,
 213                     struct ldb_control **ctrls,
 214                     struct ldb_extended *response,
 215                     int error);
 216
 217 int ldb_mod_register_control(struct ldb_module *module, const char *oid);
 218
 219 void ldb_set_default_dns(struct ldb_context *ldb);
 220 /**
 221   Add a ldb_control to a ldb_reply
 222
 223   \param ares the reply struct where to add the control
 224   \param oid the object identifier of the control as string
 225   \param critical whether the control should be critical or not
 226   \param data a talloc pointer to the control specific data
 227
 228   \return result code (LDB_SUCCESS on success, or a failure code)
 229 */
 230 int ldb_reply_add_control(struct ldb_reply *ares, const char *oid, bool critical, void *data);
 231
 232 /**
 233   mark a request as untrusted. This tells the rootdse module to remove
 234   unregistered controls
 235  */
 236 void ldb_req_mark_untrusted(struct ldb_request *req);
 237
 238 /**
 239   mark a request as trusted.
 240  */
 241 void ldb_req_mark_trusted(struct ldb_request *req);
 242
 243 /**
 244    return true is a request is untrusted
 245  */
 246 bool ldb_req_is_untrusted(struct ldb_request *req);
 247
 248 /**
 249   set custom flags. Those flags are set by applications using ldb,
 250   they are application dependent and the same bit can have different
 251   meaning in different application.
 252  */
 253 void ldb_req_set_custom_flags(struct ldb_request *req, uint32_t flags);
 254
 255 /**
 256   get custom flags. Those flags are set by applications using ldb,
 257   they are application dependent and the same bit can have different
 258   meaning in different application.
 259  */
 260 uint32_t ldb_req_get_custom_flags(struct ldb_request *req);
 261
 262 /* load all modules from the given directory */
 263 int ldb_modules_load(const char *modules_path, const char *version);
 264
 265 /* init functions prototype */
 266 typedef int (*ldb_module_init_fn)(const char *);
 267
 268 /*
 269   general ldb hook function
 270  */
 271 enum ldb_module_hook_type { LDB_MODULE_HOOK_CMDLINE_OPTIONS     = 1,
 272                             LDB_MODULE_HOOK_CMDLINE_PRECONNECT  = 2,
 273                             LDB_MODULE_HOOK_CMDLINE_POSTCONNECT = 3 };
 274
 275 typedef int (*ldb_hook_fn)(struct ldb_context *, enum ldb_module_hook_type );
 276
 277 /*
 278   register a ldb hook function
 279  */
 280 int ldb_register_hook(ldb_hook_fn hook_fn);
 281
 282 /*
 283   call ldb hooks of a given type
 284  */
 285 int ldb_modules_hook(struct ldb_context *ldb, enum ldb_module_hook_type t);
 286
 287 #define LDB_MODULE_CHECK_VERSION(version) do { \
 288  if (strcmp(version, LDB_VERSION) != 0) { \
 289         fprintf(stderr, "ldb: module version mismatch in %s : ldb_version=%s module_version=%s\n", \
 290                         __FILE__, version, LDB_VERSION); \
 291         return LDB_ERR_UNAVAILABLE; \
 292  }} while (0)
 293
 294
 295 /*
 296   return a string representation of the calling chain for the given
 297   ldb request
 298  */
 299 char *ldb_module_call_chain(struct ldb_request *req, TALLOC_CTX *mem_ctx);
 300
 301 /*
 302   return the next module in the chain
 303  */
 304 struct ldb_module *ldb_module_next(struct ldb_module *module);
 305
 306 /*
 307   set the next module in the module chain
 308  */
 309 void ldb_module_set_next(struct ldb_module *module, struct ldb_module *next);
 310
 311 /*
 312   load a list of modules
 313  */
 314 int ldb_module_load_list(struct ldb_context *ldb, const char **module_list,
 315                          struct ldb_module *backend, struct ldb_module **out);
 316
 317 /*
 318   get the popt_options pointer in the ldb structure. This allows a ldb
 319   module to change the command line parsing
 320  */
 321 struct poptOption **ldb_module_popt_options(struct ldb_context *ldb);
 322
 323 /* modules are called in inverse order on the stack.
 324    Lets place them as an admin would think the right order is.
 325    Modules order is important */
 326 const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string);
 327
 328 /*
 329   return the current ldb flags LDB_FLG_*
 330  */
 331 uint32_t ldb_module_flags(struct ldb_context *ldb);
 332
 333 int ldb_module_connect_backend(struct ldb_context *ldb,
 334                                const char *url,
 335                                const char *options[],
 336                                struct ldb_module **backend_module);
 337
 338 /*
 339   initialise a chain of modules
 340  */
 341 int ldb_module_init_chain(struct ldb_context *ldb, struct ldb_module *module);
 342
 343 /*
 344  * prototype for the init function defined by dynamically loaded modules
 345  */
 346 int ldb_init_module(const char *version);
 347
 348 /* replace the components of a DN with those from another DN, without
 349  * touching the extended components
 350  *
 351  * return true if successful and false if not
 352  * if false is returned the dn may be marked invalid
 353  */
 354 bool ldb_dn_replace_components(struct ldb_dn *dn, struct ldb_dn *new_dn);
 355
 356 /*
 357   walk a parse tree, calling the provided callback on each node
 358 */
 359 int ldb_parse_tree_walk(struct ldb_parse_tree *tree,
 360                         int (*callback)(struct ldb_parse_tree *tree, void *),
 361                         void *private_context);
 362
 363 /* compare two message elements with ordering - used by modify */
 364 bool ldb_msg_element_equal_ordered(const struct ldb_message_element *el1,
 365                                    const struct ldb_message_element *el2);
 366
 367
 368 #endif