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
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
*/
#ifndef _LIBADUTILS_H
#define _LIBADUTILS_H
#include <stdlib.h>
#include <stdio.h>
#include <sys/types.h>
#include <rpc/rpc.h>
#include <ldap.h>
#ifdef __cplusplus
extern "C" {
#endif
#define ADUTILS_DEF_NUM_RETRIES 2
/*
* Symbolic constants for different sets of debug messages.
*/
enum ad_debug {
AD_DEBUG_ALL = 0,
AD_DEBUG_DNS = 1,
AD_DEBUG_LDAP = 2,
AD_DEBUG_DISC = 3,
AD_DEBUG_MAX = 3
};
#define ADUTILS_SID_MAX_SUB_AUTHORITIES 15
#define ADUTILS_MAXBINSID\
(1 + 1 + 6 + (ADUTILS_SID_MAX_SUB_AUTHORITIES * 4))
#define ADUTILS_MAXHEXBINSID (ADUTILS_MAXBINSID * 3)
typedef struct adutils_ad adutils_ad_t;
typedef struct adutils_entry adutils_entry_t;
typedef struct adutils_result adutils_result_t;
typedef struct adutils_ctx adutils_ctx_t;
typedef struct adutils_query_state adutils_query_state_t;
/*
* Typedef for callback routine for adutils_lookup_batch_start.
* This callback routine is used to process the result of
* ldap_result(3LDAP).
* ld - LDAP handle used by ldap_result(3LDAP)
* res - Entry returned by ldap_result(3LDAP)
* rc - Return value of ldap_result(3LDAP)
* qid - Query ID that corresponds to the result.
* argp - Argument passed by the caller at the time
* of adutils_lookup_batch_start.
*/
typedef void (*adutils_ldap_res_search_cb)(LDAP *ld, LDAPMessage **res,
int rc, int qid, void *argp);
typedef enum {
ADUTILS_SUCCESS = 0,
ADUTILS_ERR_INTERNAL = -10000,
ADUTILS_ERR_OTHER,
ADUTILS_ERR_NOTFOUND,
ADUTILS_ERR_RETRIABLE_NET_ERR,
ADUTILS_ERR_MEMORY,
ADUTILS_ERR_DOMAIN
} adutils_rc;
/*
* We use the port numbers for normal LDAP and global catalog LDAP as
* the enum values for this enumeration. Clever? Silly? You decide.
* Although we never actually use these enum values as port numbers and
* never will, so this is just cute.
*/
typedef enum adutils_ad_partition {
ADUTILS_AD_DATA = 389,
ADUTILS_AD_GLOBAL_CATALOG = 3268
} adutils_ad_partition_t;
/*
* adutils interfaces:
*
* - an adutils_ad_t represents an AD partition
* - a DS (hostname + port, if port != 0) can be added/removed from an
* adutils_ad_t
* - an adutils_ad_t can be allocated, ref'ed and released; last release
* releases resources
*
*
* adutils_lookup_batch_xxx interfaces:
*
* These interfaces allow the caller to batch AD lookup requests. The
* batched requests are processed asynchronously. The actual lookup
* is currently implement using libldap's ldap_search_ext(3LDAP) and
* ldap_result(3LDAP) APIs.
*
* Example:
* adutils_query_state_t *qs;
* adutils_lookup_batch_start(..., &qs);
* for each request {
* rc = adutils_lookup_batch_add(qs, ...);
* if (rc != success)
* break;
* }
* if (rc == success)
* adutils_lookup_batch_end(&qs);
* else
* adutils_lookup_batch_release(&qs);
*
* The adutils_lookup_batch_start interface allows the caller to pass
* in a callback function that's invoked when ldap_result() returns
* LDAP_RES_SEARCH_RESULT and LDAP_RES_SEARCH_ENTRY for each request.
*
* If no callback is provided then adutils batch API falls back to its
* default behaviour which is:
* For LDAP_RES_SEARCH_ENTRY, add the entry to the entry set.
* For LDAP_RES_SEARCH_RESULT, set return code to
* ADUTILS_ERR_NOTFOUND if the entry set is empty.
*
* See $SRC/cmd/idmap/idmapd/adutils.c for an example of
* non-default callback routine.
*
*/
typedef void (*adutils_logger)(int, const char *, ...);
extern void adutils_set_debug(enum ad_debug item, int val);
extern adutils_rc adutils_ad_alloc(adutils_ad_t **new_ad,
const char *domain_name,
adutils_ad_partition_t part);
extern void adutils_ad_free(adutils_ad_t **ad);
extern adutils_rc adutils_add_ds(adutils_ad_t *ad,
const char *host, int port);
extern adutils_rc adutils_add_domain(adutils_ad_t *ad,
const char *domain_name,
const char *domain_sid);
extern void adutils_freeresult(adutils_result_t **result);
extern adutils_rc adutils_lookup(adutils_ad_t *ad,
const char *searchfilter,
const char **attrs, const char *domain,
adutils_result_t **result);
extern char **adutils_getattr(const adutils_entry_t *entry,
const char *attrname);
extern const adutils_entry_t *adutils_getfirstentry(
adutils_result_t *result);
extern int adutils_txtsid2hexbinsid(const char *txt,
const uint32_t *rid,
char *hexbinsid, int hexbinsidlen);
extern char *adutils_bv_str(BerValue *bval);
extern boolean_t adutils_bv_uint(BerValue *bval, unsigned int *result);
extern char *adutils_bv_objsid2sidstr(BerValue *bval,
uint32_t *rid);
extern void adutils_reap_idle_connections(void);
extern char *adutils_dn2dns(const char *dn);
extern adutils_rc adutils_lookup_batch_start(adutils_ad_t *ad,
int nqueries,
adutils_ldap_res_search_cb ldap_res_search_cb,
void *ldap_res_search_argp,
adutils_query_state_t **state);
extern adutils_rc adutils_lookup_batch_add(adutils_query_state_t *state,
const char *filter, const char * const *attrs,
const char *edomain, adutils_result_t **result,
adutils_rc *rc);
extern adutils_rc adutils_lookup_batch_end(
adutils_query_state_t **state);
extern void adutils_lookup_batch_release(
adutils_query_state_t **state);
extern int adutils_lookup_check_domain(
adutils_query_state_t *state,
const char *domain);
extern int adutils_lookup_check_sid_prefix(
adutils_query_state_t *state,
const char *sid);
extern void adutils_set_logger(adutils_logger logger);
extern boolean_t domain_eq(const char *a, const char *b);
#ifdef __cplusplus
}
#endif
#endif /* _LIBADUTILS_H */
|
