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
|
/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef APR_LDAP_INTERNAL_H
#define APR_LDAP_INTERNAL_H
#include "apr_private.h"
#include "apr_ldap.h"
#include "apr_skiplist.h"
#ifdef __cplusplus
extern "C" {
#endif
#if APR_HAS_LDAP
/*
* Include the standard LDAP header files.
*/
#if APR_HAS_MICROSOFT_LDAPSDK
#include <winldap.h>
#else
#include <lber.h>
#include <ldap.h>
#endif
/*
* Make sure the secure LDAP port is defined
*/
#ifndef LDAPS_PORT
#define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
#endif
/*
* For ldap function calls that input a size limit on the number of returned elements
* Some SDKs do not have the define for LDAP_DEFAULT_LIMIT (-1) or LDAP_NO_LIMIT (0)
* LDAP_DEFAULT_LIMIT is preferred as it allows inheritance from whatever the SDK
* or process is configured for.
*/
#ifdef LDAP_DEFAULT_LIMIT
#define APR_LDAP_SIZELIMIT LDAP_DEFAULT_LIMIT
#else
#ifdef LDAP_NO_LIMIT
#define APR_LDAP_SIZELIMIT LDAP_NO_LIMIT
#endif
#endif
#ifndef APR_LDAP_SIZELIMIT
#define APR_LDAP_SIZELIMIT 0 /* equivalent to LDAP_NO_LIMIT, and what goes on the wire */
#endif
/*
* z/OS is missing some defines
*/
#ifndef LDAP_VERSION_MAX
#define LDAP_VERSION_MAX LDAP_VERSION
#endif
#if APR_HAS_ZOS_LDAPSDK
#define LDAP_VENDOR_NAME "IBM z/OS"
#endif
/*
* LDAP v2.0 is history.
*/
#if LDAP_VERSION_MAX <= 2
#error Support for LDAP v2.0 toolkits has been removed from apr-util. Please use an LDAP v3.0 toolkit.
#endif
/* The MS SDK returns LDAP_UNAVAILABLE when the backend has closed the connection
* between LDAP calls. Protect with APR_HAS_MICROSOFT_LDAPSDK in case someone
* manually chooses another SDK on Windows
*/
#if APR_HAS_MICROSOFT_LDAPSDK
#define APR_LDAP_IS_SERVER_DOWN(s) ((s) == LDAP_SERVER_DOWN \
|| (s) == LDAP_UNAVAILABLE)
#else
#define APR_LDAP_IS_SERVER_DOWN(s) ((s) == LDAP_SERVER_DOWN)
#endif
/**
* Macro to detect security related return values.
*/
#if defined(LDAP_INSUFFICIENT_ACCESS)
#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_ACCESS
#elif defined(LDAP_INSUFFICIENT_RIGHTS)
#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_RIGHTS
#elif defined(APR_HAS_MICROSOFT_LDAPSDK)
/* The macros above fail to contemplate that LDAP_RETCODE values
* may be represented by an enum. autoconf tests would be much
* more robust.
*/
#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_RIGHTS
#else
#error The security return codes must be added to support this LDAP toolkit.
#endif
#if defined(LDAP_SECURITY_ERROR)
#define APU_LDAP_SECURITY_ERROR LDAP_SECURITY_ERROR
#else
#define APU_LDAP_SECURITY_ERROR(n) \
(LDAP_INAPPROPRIATE_AUTH == n) ? 1 \
: (LDAP_INVALID_CREDENTIALS == n) ? 1 \
: (APU_LDAP_INSUFFICIENT_ACCESS == n) ? 1 \
: 0
#endif
typedef struct apr_ldap_t {
apr_pool_t *pool;
LDAP *ld;
apr_socket_t *socket;
apr_skiplist *results;
apr_array_header_t *abandons;
apr_array_header_t *prepares;
LDAPControl **serverctrls;
LDAPControl **clientctrls;
apu_err_t err;
apr_status_t status;
} apr_ldap_t;
typedef struct apr_ldap_prepare_t {
apr_pool_t *pool;
apr_ldap_prepare_cb cb;
void *ctx;
} apr_ldap_prepare_t;
typedef struct apr_ldap_result_t {
apr_pool_t *pool;
apr_ldap_t *ld;
const char *mech;
const char *rmech;
LDAPMessage *message;
int msgid;
int msgtype;
union {
apr_ldap_bind_cb bind;
apr_ldap_compare_cb compare;
apr_ldap_search_result_cb search;
} cb;
union {
apr_ldap_search_entry_cb search;
} entry_cb;
void *ctx;
apr_size_t nentries;
} apr_ldap_result_t;
APU_DECLARE_LDAP(apr_status_t) apr_ldap_status(int rc, apr_status_t status);
APU_DECLARE_LDAP(void) apr_ldap_result_add(apr_pool_t *pool,
apr_ldap_t *ldap,
apr_ldap_result_t *res,
int msgid)
__attribute__((nonnull(1,2,3)));
#if APR_HAVE_MODULAR_DSO
/* For LDAP internal builds, wrap our LDAP namespace */
struct apr__ldap_dso_fntable {
int (*info)(apr_pool_t *pool, apu_err_t **err);
apr_status_t (*initialise)(apr_pool_t *pool, apr_ldap_t **ldap,
apu_err_t *err);
apr_status_t (*option_get)(apr_pool_t *pool, apr_ldap_t *ldap, int option,
apr_ldap_opt_t *outvalue, apu_err_t *err);
apr_status_t (*option_set)(apr_pool_t *pool, apr_ldap_t *ldap, int option,
const apr_ldap_opt_t *invalue, apu_err_t *err);
apr_status_t (*connect)(apr_pool_t *pool, apr_ldap_t *ldap,
apr_interval_time_t timeout, apu_err_t *err);
apr_status_t (*prepare)(apr_pool_t *pool, apr_ldap_t *ldap,
apr_ldap_prepare_cb prepare_cb,
void *prepare_ctx);
apr_status_t (*process)(apr_pool_t *pool, apr_ldap_t *ldap,
apr_interval_time_t timeout, apu_err_t *err);
apr_status_t (*result)(apr_pool_t *pool, apr_ldap_t *ldap,
apr_interval_time_t timeout, apu_err_t *err);
apr_status_t (*poll)(apr_pool_t *pool, apr_ldap_t *ldap, apr_pollcb_t *poll,
apr_interval_time_t timeout, apu_err_t *err);
apr_status_t (*bind)(apr_pool_t *pool, apr_ldap_t *ldap,
const char *mech, apr_ldap_bind_interact_cb *interact_cb,
void *interact_ctx, apr_interval_time_t timeout,
apr_ldap_bind_cb bind_cb, void *bind_ctx,
apu_err_t *err);
apr_status_t (*compare)(apr_pool_t *pool, apr_ldap_t *ldap,
const char *dn, const char *attr,
const apr_buffer_t *bval,
apr_ldap_control_t **serverctrls,
apr_ldap_control_t **clientctrls,
apr_interval_time_t timeout,
apr_ldap_compare_cb compare_cb, void *ctx, apu_err_t *err);
apr_status_t (*search)(apr_pool_t *pool, apr_ldap_t *ldap, const char *dn,
apr_ldap_search_scope_e scope, const char *filter,
const char **attrs, apr_ldap_switch_e attrsonly,
apr_ldap_control_t **serverctrls,
apr_ldap_control_t **clientctrls,
apr_interval_time_t timeout, apr_ssize_t sizelimit,
apr_ldap_search_result_cb search_result_cb,
apr_ldap_search_entry_cb search_entry_cb,
void *search_ctx, apu_err_t *err);
apr_status_t (*unbind)(apr_ldap_t *ldap, apr_ldap_control_t **serverctrls,
apr_ldap_control_t **clientctrls, apu_err_t *err);
};
#endif /* APR_HAVE_MODULAR_DSO */
#endif
#ifdef __cplusplus
}
#endif
#endif
|
