summaryrefslogtreecommitdiff
path: root/source3/lib/ldb/swig/ldb.i
blob: 09d3461c2a920349f9d81fa08ba97f2bb3800bcb (plain)
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
/* 
   Unix SMB/CIFS implementation.

   Swig interface to ldb.

   Copyright (C) 2005,2006 Tim Potter <tpot@samba.org>
   Copyright (C) 2006 Simo Sorce <idra@samba.org>

     ** 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 2 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, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

%module ldb

%{

/* Some typedefs to help swig along */

typedef unsigned char uint8_t;
typedef unsigned long long uint64_t;
typedef long long int64_t;

/* Include headers */

#include "lib/ldb/include/ldb.h"
#include "lib/talloc/talloc.h"

%}

%include "carrays.i"
%include "exception.i"

/*
 * Constants
 */

#define LDB_SUCCESS				0
#define LDB_ERR_OPERATIONS_ERROR		1
#define LDB_ERR_PROTOCOL_ERROR			2
#define LDB_ERR_TIME_LIMIT_EXCEEDED		3
#define LDB_ERR_SIZE_LIMIT_EXCEEDED		4
#define LDB_ERR_COMPARE_FALSE			5
#define LDB_ERR_COMPARE_TRUE			6
#define LDB_ERR_AUTH_METHOD_NOT_SUPPORTED	7
#define LDB_ERR_STRONG_AUTH_REQUIRED		8
/* 9 RESERVED */
#define LDB_ERR_REFERRAL			10
#define LDB_ERR_ADMIN_LIMIT_EXCEEDED		11
#define LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION	12
#define LDB_ERR_CONFIDENTIALITY_REQUIRED	13
#define LDB_ERR_SASL_BIND_IN_PROGRESS		14
#define LDB_ERR_NO_SUCH_ATTRIBUTE		16
#define LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE	17
#define LDB_ERR_INAPPROPRIATE_MATCHING		18
#define LDB_ERR_CONSTRAINT_VIOLATION		19
#define LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS	20
#define LDB_ERR_INVALID_ATTRIBUTE_SYNTAX	21
/* 22-31 unused */
#define LDB_ERR_NO_SUCH_OBJECT			32
#define LDB_ERR_ALIAS_PROBLEM			33
#define LDB_ERR_INVALID_DN_SYNTAX		34
/* 35 RESERVED */
#define LDB_ERR_ALIAS_DEREFERENCING_PROBLEM	36
/* 37-47 unused */
#define LDB_ERR_INAPPROPRIATE_AUTHENTICATION	48
#define LDB_ERR_INVALID_CREDENTIALS		49
#define LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS	50
#define LDB_ERR_BUSY				51
#define LDB_ERR_UNAVAILABLE			52
#define LDB_ERR_UNWILLING_TO_PERFORM		53
#define LDB_ERR_LOOP_DETECT			54
/* 55-63 unused */
#define LDB_ERR_NAMING_VIOLATION		64
#define LDB_ERR_OBJECT_CLASS_VIOLATION		65
#define LDB_ERR_NOT_ALLOWED_ON_NON_LEAF		66
#define LDB_ERR_NOT_ALLOWED_ON_RDN		67
#define LDB_ERR_ENTRY_ALREADY_EXISTS		68
#define LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED	69
/* 70 RESERVED FOR CLDAP */
#define LDB_ERR_AFFECTS_MULTIPLE_DSAS		71
/* 72-79 unused */
#define LDB_ERR_OTHER				80

enum ldb_scope {LDB_SCOPE_DEFAULT=-1, 
		LDB_SCOPE_BASE=0, 
		LDB_SCOPE_ONELEVEL=1,
		LDB_SCOPE_SUBTREE=2};

/* 
 * Wrap struct ldb_context
 */

/* The ldb functions will crash if a NULL ldb context is passed so
   catch this before it happens. */

%typemap(check) struct ldb_context* {
	if ($1 == NULL)
		SWIG_exception(SWIG_ValueError, 
			"ldb context must be non-NULL");
}

/* 
 * Wrap a small bit of talloc
 */

/* Use talloc_init() to create a parameter to pass to ldb_init().  Don't
   forget to free it using talloc_free() afterwards. */

TALLOC_CTX *talloc_init(char *name);
int talloc_free(TALLOC_CTX *ptr);

/*
 * Wrap struct ldb_val
 */

%typemap(in) struct ldb_val *INPUT (struct ldb_val temp) {
	$1 = &temp;
	if (!PyString_Check($input)) {
		PyErr_SetString(PyExc_TypeError, "string arg expected");
		return NULL;
	}
	$1->length = PyString_Size($input);
	$1->data = PyString_AsString($input);
}

%typemap(out) struct ldb_val {
	$result = PyString_FromStringAndSize($1.data, $1.length);
}

/*
 * Wrap struct ldb_result
 */

%typemap(in, numinputs=0) struct ldb_result **OUT (struct ldb_result *temp_ldb_result) {
	$1 = &temp_ldb_result;
}

%typemap(argout) struct ldb_result ** {
	resultobj = SWIG_NewPointerObj(*$1, SWIGTYPE_p_ldb_result, 0);
}	

%types(struct ldb_result *);

/*
 * Wrap struct ldb_message_element
 */

%array_functions(struct ldb_val, ldb_val_array);

struct ldb_message_element {
	unsigned int flags;
	const char *name;
	unsigned int num_values;
	struct ldb_val *values;
};

/*
 * Wrap struct ldb_message
 */

%array_functions(struct ldb_message_element, ldb_message_element_array);

struct ldb_message {
	struct ldb_dn *dn;
	unsigned int num_elements;
	struct ldb_message_element *elements;
	void *private_data;
};

/*
 * Wrap struct ldb_result
 */

%array_functions(struct ldb_message *, ldb_message_ptr_array);

struct ldb_result {
	unsigned int count;
	struct ldb_message **msgs;
	char **refs;
	struct ldb_control **controls;
};

/*
 * Wrap ldb functions 
 */

/* Initialisation */

int ldb_global_init(void);
struct ldb_context *ldb_init(TALLOC_CTX *mem_ctx);

/* Error handling */

const char *ldb_errstring(struct ldb_context *ldb);
const char *ldb_strerror(int ldb_err);

/* Top-level ldb operations */

int ldb_connect(struct ldb_context *ldb, const char *url, unsigned int flags, const char *options[]);

int ldb_search(struct ldb_context *ldb, const struct ldb_dn *base, enum ldb_scope scope, const char *expression, const char * const *attrs, struct ldb_result **OUT);

int ldb_delete(struct ldb_context *ldb, const struct ldb_dn *dn);

int ldb_rename(struct ldb_context *ldb, const struct ldb_dn *olddn, const struct ldb_dn *newdn);

int ldb_add(struct ldb_context *ldb, const struct ldb_message *message);

/* Ldb message operations */

struct ldb_message *ldb_msg_new(void *mem_ctx);

struct ldb_message_element *ldb_msg_find_element(const struct ldb_message *msg, const char *attr_name);

int ldb_msg_add_value(struct ldb_message *msg, const char *attr_name, const struct ldb_val *INPUT);

void ldb_msg_remove_attr(struct ldb_message *msg, const char *attr);

int ldb_msg_sanity_check(struct ldb_message *msg);

/* DN operations */

struct ldb_dn *ldb_dn_explode(void *mem_ctx, const char *dn);

char *ldb_dn_linearize(void *mem_ctx, const struct ldb_dn *dn);