Add support for OneFS ACLs
[kai/samba-autobuild/.git] / source4 / lib / ldb / include / ldb_private.h
1 /* 
2    ldb database library
3
4    Copyright (C) Andrew Tridgell    2004
5    Copyright (C) Stefan Metzmacher  2004
6    Copyright (C) Simo Sorce         2004-2005
7
8      ** NOTE! The following LGPL license applies to the ldb
9      ** library. This does NOT imply that all of Samba is released
10      ** under the LGPL
11    
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.
16
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.
21
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/>.
24 */
25
26 /*
27  *  Name: ldb
28  *
29  *  Component: ldb private header
30  *
31  *  Description: defines internal ldb structures used by the subsystem and modules
32  *
33  *  Author: Andrew Tridgell
34  *  Author: Stefan Metzmacher
35  */
36
37 #ifndef _LDB_PRIVATE_H_
38 #define _LDB_PRIVATE_H_ 1
39
40 struct ldb_context;
41
42 struct ldb_module_ops;
43
44 struct ldb_backend_ops;
45
46 struct ldb_handle {
47         int status;
48         enum ldb_state state;
49         struct ldb_context *ldb;
50 };
51
52 /* basic module structure */
53 struct ldb_module {
54         struct ldb_module *prev, *next;
55         struct ldb_context *ldb;
56         void *private_data;
57         const struct ldb_module_ops *ops;
58 };
59
60 /*
61    these function pointers define the operations that a ldb module can intercept
62 */
63 struct ldb_module_ops {
64         const char *name;
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 *);
77     void *private_data;
78 };
79
80 /*
81   schema related information needed for matching rules
82 */
83 struct ldb_schema {
84         /* attribute handling table */
85         unsigned num_attributes;
86         struct ldb_schema_attribute *attributes;
87 };
88
89 /*
90   every ldb connection is started by establishing a ldb_context
91 */
92 struct ldb_context {
93         /* the operations provided by the backend */
94         struct ldb_module *modules;
95
96         /* debugging operations */
97         struct ldb_debug_ops debug_ops;
98
99         /* custom utf8 functions */
100         struct ldb_utf8_fns utf8_fns;
101
102         /* backend specific opaque parameters */
103         struct ldb_opaque {
104                 struct ldb_opaque *next;
105                 const char *name;
106                 void *value;
107         } *opaque;
108
109         struct ldb_schema schema;
110
111         char *err_string;
112
113         int transaction_active;
114
115         int default_timeout;
116
117         unsigned int flags;
118
119         unsigned int create_perms;
120
121         char *modules_dir;
122
123         struct event_context *ev_ctx;
124 };
125
126 #ifndef ARRAY_SIZE
127 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
128 #endif
129
130 /*
131   simplify out of memory handling
132 */
133 #define ldb_oom(ldb) ldb_debug_set(ldb, LDB_DEBUG_FATAL, "ldb out of memory at %s:%d\n", __FILE__, __LINE__)
134
135 /* The following definitions come from lib/ldb/common/ldb.c  */
136
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);
140
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);
145
146 /* The following definitions come from lib/ldb/common/ldb_ldif.c  */
147 int ldb_should_b64_encode(const struct ldb_val *val);
148
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;
166
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;
172
173 int ldb_match_msg(struct ldb_context *ldb,
174                   const struct ldb_message *msg,
175                   const struct ldb_parse_tree *tree,
176                   struct ldb_dn *base,
177                   enum ldb_scope scope);
178
179 const struct ldb_schema_syntax *ldb_standard_syntax_by_name(struct ldb_context *ldb,
180                                                             const char *syntax);
181
182 /* The following definitions come from lib/ldb/common/ldb_attributes.c  */
183
184 int ldb_schema_attribute_add_with_syntax(struct ldb_context *ldb,
185                                          const char *name,
186                                          unsigned flags,
187                                          const struct ldb_schema_syntax *syntax);
188 int ldb_schema_attribute_add(struct ldb_context *ldb, 
189                              const char *name,
190                              unsigned flags,
191                              const char *syntax);
192 void ldb_schema_attribute_remove(struct ldb_context *ldb, const char *name);
193 int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
194
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);
198
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);
203
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);
208
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);
211
212 void ldb_msg_remove_element(struct ldb_message *msg, struct ldb_message_element *el);
213
214 int ldb_msg_element_compare_name(struct ldb_message_element *el1, 
215                                  struct ldb_message_element *el2);
216 void ldb_dump_results(struct ldb_context *ldb, struct ldb_result *result, FILE *f);
217
218 /**
219   Obtain current/next database sequence number
220 */
221 int ldb_sequence_number(struct ldb_context *ldb, enum ldb_sequence_type type, uint64_t *seq_num);
222
223 #define LDB_SEQ_GLOBAL_SEQUENCE    0x01
224 #define LDB_SEQ_TIMESTAMP_SEQUENCE 0x02
225
226
227 /* MODULES specific headers -- SSS */
228
229 /* The following definitions come from lib/ldb/common/ldb_modules.c  */
230
231 const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string);
232 int ldb_load_modules_list(struct ldb_context *ldb, const char **module_list, struct ldb_module *backend, struct ldb_module **out);
233 int ldb_load_modules(struct ldb_context *ldb, const char *options[]);
234 int ldb_init_module_chain(struct ldb_context *ldb, struct ldb_module *module);
235 int ldb_next_request(struct ldb_module *module, struct ldb_request *request);
236 int ldb_next_start_trans(struct ldb_module *module);
237 int ldb_next_end_trans(struct ldb_module *module);
238 int ldb_next_del_trans(struct ldb_module *module);
239 int ldb_next_init(struct ldb_module *module);
240
241 void ldb_set_errstring(struct ldb_context *ldb, const char *err_string);
242 void ldb_asprintf_errstring(struct ldb_context *ldb, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
243 void ldb_reset_err_string(struct ldb_context *ldb);
244
245 const char *ldb_default_modules_dir(void);
246
247 int ldb_register_module(const struct ldb_module_ops *);
248
249 typedef int (*ldb_connect_fn)(struct ldb_context *ldb, const char *url,
250                               unsigned int flags, const char *options[],
251                               struct ldb_module **module);
252
253 struct ldb_backend_ops {
254         const char *name;
255         ldb_connect_fn connect_fn;
256 };
257
258 const char *ldb_default_modules_dir(void);
259
260 int ldb_register_backend(const char *url_prefix, ldb_connect_fn);
261
262 void *ldb_dso_load_symbol(struct ldb_context *ldb, const char *name,
263                             const char *symbol);
264
265 struct ldb_handle *ldb_handle_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb);
266
267 int ldb_module_send_entry(struct ldb_request *req,
268                           struct ldb_message *msg);
269
270 int ldb_module_send_referral(struct ldb_request *req,
271                                            char *ref);
272
273 int ldb_module_done(struct ldb_request *req,
274                     struct ldb_control **ctrls,
275                     struct ldb_extended *response,
276                     int error);
277
278 int ldb_mod_register_control(struct ldb_module *module, const char *oid);
279
280
281 struct ldb_val ldb_binary_decode(void *mem_ctx, const char *str);
282
283 #endif