dsdb-acl: add acl_check_access_on_objectclass() helper
[Samba/gebeck_regimport.git] / nsswitch / libwbclient / wbclient.c
blob19bb3e9e0a85348adabbd0fe19c6a397c2eec2a1
1 /*
2 Unix SMB/CIFS implementation.
4 Winbind client API
6 Copyright (C) Gerald (Jerry) Carter 2007
9 This library is free software; you can redistribute it and/or
10 modify it under the terms of the GNU Lesser General Public
11 License as published by the Free Software Foundation; either
12 version 3 of the License, or (at your option) any later version.
14 This library is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Library General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 /* Required Headers */
25 #include "replace.h"
26 #include "libwbclient.h"
28 /* From wb_common.c */
30 NSS_STATUS winbindd_request_response(int req_type,
31 struct winbindd_request *request,
32 struct winbindd_response *response);
33 NSS_STATUS winbindd_priv_request_response(int req_type,
34 struct winbindd_request *request,
35 struct winbindd_response *response);
38 result == NSS_STATUS_UNAVAIL: winbind not around
39 result == NSS_STATUS_NOTFOUND: winbind around, but domain missing
41 Due to a bad API NSS_STATUS_NOTFOUND is returned both when winbind_off
42 and when winbind return WINBINDD_ERROR. So the semantics of this
43 routine depends on winbind_on. Grepping for winbind_off I just
44 found 3 places where winbind is turned off, and this does not conflict
45 (as far as I have seen) with the callers of is_trusted_domains.
47 --Volker
50 static wbcErr wbcRequestResponseInt(
51 int cmd,
52 struct winbindd_request *request,
53 struct winbindd_response *response,
54 NSS_STATUS (*fn)(int req_type,
55 struct winbindd_request *request,
56 struct winbindd_response *response))
58 wbcErr wbc_status = WBC_ERR_UNKNOWN_FAILURE;
59 NSS_STATUS nss_status;
61 /* for some calls the request and/or response can be NULL */
63 nss_status = fn(cmd, request, response);
65 switch (nss_status) {
66 case NSS_STATUS_SUCCESS:
67 wbc_status = WBC_ERR_SUCCESS;
68 break;
69 case NSS_STATUS_UNAVAIL:
70 wbc_status = WBC_ERR_WINBIND_NOT_AVAILABLE;
71 break;
72 case NSS_STATUS_NOTFOUND:
73 wbc_status = WBC_ERR_DOMAIN_NOT_FOUND;
74 break;
75 default:
76 wbc_status = WBC_ERR_NSS_ERROR;
77 break;
80 return wbc_status;
83 /**
84 * @brief Wrapper around Winbind's send/receive API call
86 * @param cmd Winbind command operation to perform
87 * @param request Send structure
88 * @param response Receive structure
90 * @return #wbcErr
92 wbcErr wbcRequestResponse(int cmd,
93 struct winbindd_request *request,
94 struct winbindd_response *response)
96 return wbcRequestResponseInt(cmd, request, response,
97 winbindd_request_response);
100 wbcErr wbcRequestResponsePriv(int cmd,
101 struct winbindd_request *request,
102 struct winbindd_response *response)
104 return wbcRequestResponseInt(cmd, request, response,
105 winbindd_priv_request_response);
108 /** @brief Translate an error value into a string
110 * @param error
112 * @return a pointer to a static string
114 const char *wbcErrorString(wbcErr error)
116 switch (error) {
117 case WBC_ERR_SUCCESS:
118 return "WBC_ERR_SUCCESS";
119 case WBC_ERR_NOT_IMPLEMENTED:
120 return "WBC_ERR_NOT_IMPLEMENTED";
121 case WBC_ERR_UNKNOWN_FAILURE:
122 return "WBC_ERR_UNKNOWN_FAILURE";
123 case WBC_ERR_NO_MEMORY:
124 return "WBC_ERR_NO_MEMORY";
125 case WBC_ERR_INVALID_SID:
126 return "WBC_ERR_INVALID_SID";
127 case WBC_ERR_INVALID_PARAM:
128 return "WBC_ERR_INVALID_PARAM";
129 case WBC_ERR_WINBIND_NOT_AVAILABLE:
130 return "WBC_ERR_WINBIND_NOT_AVAILABLE";
131 case WBC_ERR_DOMAIN_NOT_FOUND:
132 return "WBC_ERR_DOMAIN_NOT_FOUND";
133 case WBC_ERR_INVALID_RESPONSE:
134 return "WBC_ERR_INVALID_RESPONSE";
135 case WBC_ERR_NSS_ERROR:
136 return "WBC_ERR_NSS_ERROR";
137 case WBC_ERR_UNKNOWN_USER:
138 return "WBC_ERR_UNKNOWN_USER";
139 case WBC_ERR_UNKNOWN_GROUP:
140 return "WBC_ERR_UNKNOWN_GROUP";
141 case WBC_ERR_AUTH_ERROR:
142 return "WBC_ERR_AUTH_ERROR";
143 case WBC_ERR_PWD_CHANGE_FAILED:
144 return "WBC_ERR_PWD_CHANGE_FAILED";
147 return "unknown wbcErr value";
150 #define WBC_MAGIC (0x7a2b0e1e)
151 #define WBC_MAGIC_FREE (0x875634fe)
153 struct wbcMemPrefix {
154 uint32_t magic;
155 void (*destructor)(void *ptr);
158 static size_t wbcPrefixLen(void)
160 size_t result = sizeof(struct wbcMemPrefix);
161 return (result + 15) & ~15;
164 static struct wbcMemPrefix *wbcMemToPrefix(void *ptr)
166 return (struct wbcMemPrefix *)(((char *)ptr) - wbcPrefixLen());
169 void *wbcAllocateMemory(size_t nelem, size_t elsize,
170 void (*destructor)(void *ptr))
172 struct wbcMemPrefix *result;
174 if (nelem >= (2<<24)/elsize) {
175 /* basic protection against integer wrap */
176 return NULL;
179 result = (struct wbcMemPrefix *)calloc(
180 1, nelem*elsize + wbcPrefixLen());
181 if (result == NULL) {
182 return NULL;
184 result->magic = WBC_MAGIC;
185 result->destructor = destructor;
186 return ((char *)result) + wbcPrefixLen();
189 /* Free library allocated memory */
190 void wbcFreeMemory(void *p)
192 struct wbcMemPrefix *wbcMem;
194 if (p == NULL) {
195 return;
197 wbcMem = wbcMemToPrefix(p);
198 if (wbcMem->magic != WBC_MAGIC) {
199 return;
202 /* paranoid check to ensure we don't double free */
203 wbcMem->magic = WBC_MAGIC_FREE;
205 if (wbcMem->destructor != NULL) {
206 wbcMem->destructor(p);
208 free(wbcMem);
209 return;
212 char *wbcStrDup(const char *str)
214 char *result;
215 size_t len;
217 len = strlen(str);
218 result = (char *)wbcAllocateMemory(len+1, sizeof(char), NULL);
219 if (result == NULL) {
220 return NULL;
222 memcpy(result, str, len+1);
223 return result;
226 static void wbcStringArrayDestructor(void *ptr)
228 char **p = (char **)ptr;
229 while (*p != NULL) {
230 free(*p);
231 p += 1;
235 const char **wbcAllocateStringArray(int num_strings)
237 return (const char **)wbcAllocateMemory(
238 num_strings + 1, sizeof(const char *),
239 wbcStringArrayDestructor);
242 wbcErr wbcLibraryDetails(struct wbcLibraryDetails **_details)
244 struct wbcLibraryDetails *info;
246 info = (struct wbcLibraryDetails *)wbcAllocateMemory(
247 1, sizeof(struct wbcLibraryDetails), NULL);
249 if (info == NULL) {
250 return WBC_ERR_NO_MEMORY;
253 info->major_version = WBCLIENT_MAJOR_VERSION;
254 info->minor_version = WBCLIENT_MINOR_VERSION;
255 info->vendor_version = WBCLIENT_VENDOR_VERSION;
257 *_details = info;
258 return WBC_ERR_SUCCESS;