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