1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/*
ldb database library
Copyright (C) Andrew Tridgell 2004
Copyright (C) Stefan Metzmacher 2004
Copyright (C) Simo Sorce 2004-2005
** NOTE! The following LGPL license applies to the ldb
** library. This does NOT imply that all of Samba is released
** under the LGPL
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
/*
* Name: ldb
*
* Component: ldb private header
*
* Description: defines internal ldb structures used by the subsystem and modules
*
* Author: Andrew Tridgell
* Author: Stefan Metzmacher
*/
#ifndef _LDB_PRIVATE_H_
#define _LDB_PRIVATE_H_ 1
#include "replace.h"
#include "system/filesys.h"
#include "system/time.h"
#include "ldb.h"
#include "ldb_module.h"
struct ldb_context;
struct ldb_module_ops;
struct ldb_backend_ops;
#define LDB_HANDLE_FLAG_DONE_CALLED 1
/* call is from an untrusted source - eg. over ldap:// */
#define LDB_HANDLE_FLAG_UNTRUSTED 2
struct ldb_handle {
int status;
enum ldb_state state;
struct ldb_context *ldb;
unsigned flags;
/* flags dedicated to be set by application using ldb */
uint32_t custom_flags;
unsigned nesting;
/* Private event context (if not NULL) */
struct tevent_context *event_context;
/* used for debugging */
struct ldb_request *parent;
const char *location;
};
/* basic module structure */
struct ldb_module {
struct ldb_module *prev, *next;
struct ldb_context *ldb;
void *private_data;
const struct ldb_module_ops *ops;
};
/*
schema related information needed for matching rules
*/
struct ldb_schema {
void *attribute_handler_override_private;
ldb_attribute_handler_override_fn_t attribute_handler_override;
/* attribute handling table */
unsigned num_attributes;
struct ldb_schema_attribute *attributes;
unsigned num_dn_extended_syntax;
struct ldb_dn_extended_syntax *dn_extended_syntax;
/*
* If set, the attribute_handler_override has the details of
* what attributes have an index
*/
bool index_handler_override;
bool one_level_indexes;
};
/*
every ldb connection is started by establishing a ldb_context
*/
struct ldb_context {
/* the operations provided by the backend */
struct ldb_module *modules;
/* debugging operations */
struct ldb_debug_ops debug_ops;
/* extended matching rules */
struct ldb_extended_match_entry {
const struct ldb_extended_match_rule *rule;
struct ldb_extended_match_entry *prev, *next;
} *extended_match_rules;
/* custom utf8 functions */
struct ldb_utf8_fns utf8_fns;
/* backend specific opaque parameters */
struct ldb_opaque {
struct ldb_opaque *next;
const char *name;
void *value;
} *opaque;
struct ldb_schema schema;
char *err_string;
int transaction_active;
int default_timeout;
unsigned int flags;
unsigned int create_perms;
struct tevent_context *ev_ctx;
/*
* If the backend holds locks, we must not use a global event
* context, so this flag will be set and ldb_handle_new() will
* build a new event context
*/
bool require_private_event_context;
bool prepare_commit_done;
char *partial_debug;
struct poptOption *popt_options;
};
/* The following definitions come from lib/ldb/common/ldb.c */
extern const struct ldb_module_ops ldb_objectclass_module_ops;
extern const struct ldb_module_ops ldb_paged_results_module_ops;
extern const struct ldb_module_ops ldb_rdn_name_module_ops;
extern const struct ldb_module_ops ldb_schema_module_ops;
extern const struct ldb_module_ops ldb_asq_module_ops;
extern const struct ldb_module_ops ldb_server_sort_module_ops;
extern const struct ldb_module_ops ldb_ldap_module_ops;
extern const struct ldb_module_ops ldb_ildap_module_ops;
extern const struct ldb_module_ops ldb_paged_searches_module_ops;
extern const struct ldb_module_ops ldb_tdb_module_ops;
extern const struct ldb_module_ops ldb_skel_module_ops;
extern const struct ldb_module_ops ldb_subtree_rename_module_ops;
extern const struct ldb_module_ops ldb_subtree_delete_module_ops;
extern const struct ldb_module_ops ldb_sqlite3_module_ops;
extern const struct ldb_module_ops ldb_wins_ldb_module_ops;
extern const struct ldb_module_ops ldb_ranged_results_module_ops;
extern const struct ldb_backend_ops ldb_tdb_backend_ops;
extern const struct ldb_backend_ops ldb_sqlite3_backend_ops;
extern const struct ldb_backend_ops ldb_ldap_backend_ops;
extern const struct ldb_backend_ops ldb_ldapi_backend_ops;
extern const struct ldb_backend_ops ldb_ldaps_backend_ops;
int ldb_setup_wellknown_attributes(struct ldb_context *ldb);
/*
remove attributes with a specified flag (eg LDB_ATTR_FLAG_FROM_DB) for this ldb context
This is to permit correct reloads
*/
void ldb_schema_attribute_remove_flagged(struct ldb_context *ldb, unsigned int flag);
int ldb_schema_attribute_fill_with_syntax(struct ldb_context *ldb,
TALLOC_CTX *mem_ctx,
const char *attribute,
unsigned flags,
const struct ldb_schema_syntax *syntax,
struct ldb_schema_attribute *a);
const char **ldb_subclass_list(struct ldb_context *ldb, const char *classname);
void ldb_subclass_remove(struct ldb_context *ldb, const char *classname);
int ldb_subclass_add(struct ldb_context *ldb, const char *classname, const char *subclass);
/* The following definitions come from lib/ldb/common/ldb_utf8.c */
char *ldb_casefold_default(void *context, TALLOC_CTX *mem_ctx, const char *s, size_t n);
void ldb_dump_results(struct ldb_context *ldb, struct ldb_result *result, FILE *f);
/* The following definitions come from lib/ldb/common/ldb_modules.c */
const char **ldb_modules_list_from_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx, const char *string);
int ldb_load_modules(struct ldb_context *ldb, const char *options[]);
struct ldb_val ldb_binary_decode(TALLOC_CTX *mem_ctx, const char *str);
/* The following definitions come from lib/ldb/common/ldb_options.c */
const char *ldb_options_find(struct ldb_context *ldb, const char *options[],
const char *option_name);
/* The following definitions come from lib/ldb/common/ldb_ldif.c */
struct ldif_read_file_state {
FILE *f;
size_t line_no;
};
struct ldb_ldif *ldb_ldif_read_file_state(struct ldb_context *ldb,
struct ldif_read_file_state *state);
char *ldb_ldif_write_redacted_trace_string(struct ldb_context *ldb, TALLOC_CTX *mem_ctx,
const struct ldb_ldif *ldif);
/*
* Get the LDB context in use on an LDB DN.
*
* This is helpful to the python LDB code, which may use as part of
* adding base and child components to an existing DN.
*/
struct ldb_context *ldb_dn_get_ldb_context(struct ldb_dn *dn);
#endif
|
