4 Copyright (C) Andrew Tridgell 2004
5 Copyright (C) Stefan Metzmacher 2004
6 Copyright (C) Simo Sorce 2004-2005
8 ** NOTE! The following LGPL license applies to the ldb
9 ** library. This does NOT imply that all of Samba is released
12 This library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Lesser General Public
14 License as published by the Free Software Foundation; either
15 version 3 of the License, or (at your option) any later version.
17 This library is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 Lesser General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public
23 License along with this library; if not, see <http://www.gnu.org/licenses/>.
29 * Component: ldb private header
31 * Description: defines internal ldb structures used by the subsystem and modules
33 * Author: Andrew Tridgell
34 * Author: Stefan Metzmacher
37 #ifndef _LDB_PRIVATE_H_
38 #define _LDB_PRIVATE_H_ 1
42 struct ldb_module_ops
;
44 struct ldb_backend_ops
;
49 struct ldb_context
*ldb
;
52 /* basic module structure */
54 struct ldb_module
*prev
, *next
;
55 struct ldb_context
*ldb
;
57 const struct ldb_module_ops
*ops
;
61 these function pointers define the operations that a ldb module can intercept
63 struct ldb_module_ops
{
65 int (*init_context
) (struct ldb_module
*);
66 int (*search
)(struct ldb_module
*, struct ldb_request
*); /* search */
67 int (*add
)(struct ldb_module
*, struct ldb_request
*); /* add */
68 int (*modify
)(struct ldb_module
*, struct ldb_request
*); /* modify */
69 int (*del
)(struct ldb_module
*, struct ldb_request
*); /* delete */
70 int (*rename
)(struct ldb_module
*, struct ldb_request
*); /* rename */
71 int (*request
)(struct ldb_module
*, struct ldb_request
*); /* match any other operation */
72 int (*extended
)(struct ldb_module
*, struct ldb_request
*); /* extended operations */
73 int (*start_transaction
)(struct ldb_module
*);
74 int (*end_transaction
)(struct ldb_module
*);
75 int (*del_transaction
)(struct ldb_module
*);
76 int (*sequence_number
)(struct ldb_module
*, struct ldb_request
*);
81 schema related information needed for matching rules
84 /* attribute handling table */
85 unsigned num_attributes
;
86 struct ldb_schema_attribute
*attributes
;
90 every ldb connection is started by establishing a ldb_context
93 /* the operations provided by the backend */
94 struct ldb_module
*modules
;
96 /* debugging operations */
97 struct ldb_debug_ops debug_ops
;
99 /* custom utf8 functions */
100 struct ldb_utf8_fns utf8_fns
;
102 /* backend specific opaque parameters */
104 struct ldb_opaque
*next
;
109 struct ldb_schema schema
;
113 int transaction_active
;
119 unsigned int create_perms
;
123 struct event_context
*ev_ctx
;
127 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
131 simplify out of memory handling
133 #define ldb_oom(ldb) ldb_debug_set(ldb, LDB_DEBUG_FATAL, "ldb out of memory at %s:%d\n", __FILE__, __LINE__)
135 /* The following definitions come from lib/ldb/common/ldb.c */
137 int ldb_connect_backend(struct ldb_context
*ldb
, const char *url
, const char *options
[],
138 struct ldb_module
**backend_module
);
139 void ldb_set_default_dns(struct ldb_context
*ldb
);
141 /* The following definitions come from lib/ldb/common/ldb_debug.c */
142 void ldb_debug(struct ldb_context
*ldb
, enum ldb_debug_level level
, const char *fmt
, ...) PRINTF_ATTRIBUTE(3, 4);
143 void ldb_debug_set(struct ldb_context
*ldb
, enum ldb_debug_level level
,
144 const char *fmt
, ...) PRINTF_ATTRIBUTE(3, 4);
146 /* The following definitions come from lib/ldb/common/ldb_ldif.c */
147 int ldb_should_b64_encode(const struct ldb_val
*val
);
149 extern const struct ldb_module_ops ldb_objectclass_module_ops
;
150 extern const struct ldb_module_ops ldb_operational_module_ops
;
151 extern const struct ldb_module_ops ldb_paged_results_module_ops
;
152 extern const struct ldb_module_ops ldb_rdn_name_module_ops
;
153 extern const struct ldb_module_ops ldb_schema_module_ops
;
154 extern const struct ldb_module_ops ldb_asq_module_ops
;
155 extern const struct ldb_module_ops ldb_server_sort_module_ops
;
156 extern const struct ldb_module_ops ldb_ldap_module_ops
;
157 extern const struct ldb_module_ops ldb_ildap_module_ops
;
158 extern const struct ldb_module_ops ldb_paged_searches_module_ops
;
159 extern const struct ldb_module_ops ldb_tdb_module_ops
;
160 extern const struct ldb_module_ops ldb_skel_module_ops
;
161 extern const struct ldb_module_ops ldb_subtree_rename_module_ops
;
162 extern const struct ldb_module_ops ldb_subtree_delete_module_ops
;
163 extern const struct ldb_module_ops ldb_sqlite3_module_ops
;
164 extern const struct ldb_module_ops ldb_wins_ldb_module_ops
;
165 extern const struct ldb_module_ops ldb_ranged_results_module_ops
;
167 extern const struct ldb_backend_ops ldb_tdb_backend_ops
;
168 extern const struct ldb_backend_ops ldb_sqlite3_backend_ops
;
169 extern const struct ldb_backend_ops ldb_ldap_backend_ops
;
170 extern const struct ldb_backend_ops ldb_ldapi_backend_ops
;
171 extern const struct ldb_backend_ops ldb_ldaps_backend_ops
;
173 int ldb_match_msg(struct ldb_context
*ldb
,
174 const struct ldb_message
*msg
,
175 const struct ldb_parse_tree
*tree
,
177 enum ldb_scope scope
);
179 const struct ldb_schema_syntax
*ldb_standard_syntax_by_name(struct ldb_context
*ldb
,
182 /* The following definitions come from lib/ldb/common/ldb_attributes.c */
184 int ldb_schema_attribute_add_with_syntax(struct ldb_context
*ldb
,
187 const struct ldb_schema_syntax
*syntax
);
188 int ldb_schema_attribute_add(struct ldb_context
*ldb
,
192 void ldb_schema_attribute_remove(struct ldb_context
*ldb
, const char *name
);
193 int ldb_setup_wellknown_attributes(struct ldb_context
*ldb
);
195 const char **ldb_subclass_list(struct ldb_context
*ldb
, const char *classname
);
196 void ldb_subclass_remove(struct ldb_context
*ldb
, const char *classname
);
197 int ldb_subclass_add(struct ldb_context
*ldb
, const char *classname
, const char *subclass
);
199 int ldb_handler_copy(struct ldb_context
*ldb
, void *mem_ctx
,
200 const struct ldb_val
*in
, struct ldb_val
*out
);
201 int ldb_comparison_binary(struct ldb_context
*ldb
, void *mem_ctx
,
202 const struct ldb_val
*v1
, const struct ldb_val
*v2
);
204 /* The following definitions come from lib/ldb/common/ldb_controls.c */
205 struct ldb_control
*get_control_from_list(struct ldb_control
**controls
, const char *oid
);
206 int save_controls(struct ldb_control
*exclude
, struct ldb_request
*req
, struct ldb_control
***saver
);
207 int check_critical_controls(struct ldb_control
**controls
);
209 /* The following definitions come from lib/ldb/common/ldb_utf8.c */
210 char *ldb_casefold_default(void *context
, void *mem_ctx
, const char *s
, size_t n
);
212 void ldb_msg_remove_element(struct ldb_message
*msg
, struct ldb_message_element
*el
);
215 Obtain current/next database sequence number
217 int ldb_sequence_number(struct ldb_context
*ldb
, enum ldb_sequence_type type
, uint64_t *seq_num
);
219 #define LDB_SEQ_GLOBAL_SEQUENCE 0x01
220 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
223 /* MODULES specific headers -- SSS */
225 /* The following definitions come from lib/ldb/common/ldb_modules.c */
227 const char **ldb_modules_list_from_string(struct ldb_context
*ldb
, TALLOC_CTX
*mem_ctx
, const char *string
);
228 int ldb_load_modules_list(struct ldb_context
*ldb
, const char **module_list
, struct ldb_module
*backend
, struct ldb_module
**out
);
229 int ldb_load_modules(struct ldb_context
*ldb
, const char *options
[]);
230 int ldb_init_module_chain(struct ldb_context
*ldb
, struct ldb_module
*module
);
231 int ldb_next_request(struct ldb_module
*module
, struct ldb_request
*request
);
232 int ldb_next_start_trans(struct ldb_module
*module
);
233 int ldb_next_end_trans(struct ldb_module
*module
);
234 int ldb_next_del_trans(struct ldb_module
*module
);
235 int ldb_next_init(struct ldb_module
*module
);
237 void ldb_set_errstring(struct ldb_context
*ldb
, const char *err_string
);
238 void ldb_asprintf_errstring(struct ldb_context
*ldb
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
239 void ldb_reset_err_string(struct ldb_context
*ldb
);
241 const char *ldb_default_modules_dir(void);
243 int ldb_register_module(const struct ldb_module_ops
*);
245 typedef int (*ldb_connect_fn
)(struct ldb_context
*ldb
, const char *url
,
246 unsigned int flags
, const char *options
[],
247 struct ldb_module
**module
);
249 struct ldb_backend_ops
{
251 ldb_connect_fn connect_fn
;
254 const char *ldb_default_modules_dir(void);
256 int ldb_register_backend(const char *url_prefix
, ldb_connect_fn
);
258 void *ldb_dso_load_symbol(struct ldb_context
*ldb
, const char *name
,
261 struct ldb_handle
*ldb_handle_new(TALLOC_CTX
*mem_ctx
, struct ldb_context
*ldb
);
263 int ldb_module_send_entry(struct ldb_request
*req
,
264 struct ldb_message
*msg
);
266 int ldb_module_send_referral(struct ldb_request
*req
,
269 int ldb_module_done(struct ldb_request
*req
,
270 struct ldb_control
**ctrls
,
271 struct ldb_extended
*response
,
274 int ldb_mod_register_control(struct ldb_module
*module
, const char *oid
);