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