]> arthur.barton.de Git - netatalk.git/blob - libatalk/acl/ldap.c
Fix LDAP search scope and timeout behaviour
[netatalk.git] / libatalk / acl / ldap.c
1 /*
2   $Id: ldap.c,v 1.5 2010-04-22 10:17:57 franklahm Exp $
3   Copyright (c) 2008,2009 Frank Lahm <franklahm@gmail.com>
4
5   This program is free software; you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation; either version 2 of the License, or
8   (at your option) any later version.
9
10   This program is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14 */
15
16 #ifdef HAVE_CONFIG_H
17 #include "config.h"
18 #endif /* HAVE_CONFIG_H */
19
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <sys/time.h>
23 #include <string.h>
24 #include <errno.h>
25 #include <ldap.h>
26
27 #include <atalk/logger.h>
28 #include <atalk/afp.h>
29 #include <atalk/uuid.h>
30 #include <atalk/ldapconfig.h>   /* For struct ldap_pref */
31
32 typedef enum {
33     KEEPALIVE = 1
34 } ldapcon_t;
35
36 /********************************************************
37  * LDAP config stuff. Filled by libatalk/acl/ldap_config.c
38  ********************************************************/
39 int ldap_config_valid;
40
41 char *ldap_server;
42 int  ldap_auth_method;
43 char *ldap_auth_dn;
44 char *ldap_auth_pw;
45 char *ldap_userbase;
46 int  ldap_userscope;
47 char *ldap_groupbase;
48 int  ldap_groupscope;
49 char *ldap_uuid_attr;
50 char *ldap_name_attr;
51 char *ldap_group_attr;
52 char *ldap_uid_attr;
53
54 struct ldap_pref ldap_prefs[] = {
55     {&ldap_server,     "ldap_server",      0, 0, -1},
56     {&ldap_auth_method,"ldap_auth_method", 1, 1, -1},
57     {&ldap_auth_dn,    "ldap_auth_dn",     0, 0,  0},
58     {&ldap_auth_pw,    "ldap_auth_pw",     0, 0,  0},
59     {&ldap_userbase,   "ldap_userbase",    0, 0, -1},
60     {&ldap_userscope,  "ldap_userscope",   1 ,1, -1},
61     {&ldap_groupbase,  "ldap_groupbase",   0, 0, -1},
62     {&ldap_groupscope, "ldap_groupscope",  1 ,1, -1},
63     {&ldap_uuid_attr,  "ldap_uuid_attr",   0, 0, -1},
64     {&ldap_name_attr,  "ldap_name_attr",   0, 0, -1},
65     {&ldap_group_attr, "ldap_group_attr",  0, 0, -1},
66     {&ldap_uid_attr,   "ldap_uid_attr",    0, 0,  0},
67     {NULL,             NULL,               0, 0, -1}
68 };
69
70 struct pref_array prefs_array[] = {
71     {"ldap_auth_method", "none",   LDAP_AUTH_NONE},
72     {"ldap_auth_method", "simple", LDAP_AUTH_SIMPLE},
73     {"ldap_auth_method", "sasl",   LDAP_AUTH_SASL},
74     {"ldap_userscope",   "base",   LDAP_SCOPE_BASE},
75     {"ldap_userscope",   "one",    LDAP_SCOPE_ONELEVEL},
76     {"ldap_userscope",   "sub",    LDAP_SCOPE_SUBTREE},
77     {"ldap_groupscope",  "base",   LDAP_SCOPE_BASE},
78     {"ldap_groupscope",  "one",    LDAP_SCOPE_ONELEVEL},
79     {"ldap_groupscope",  "sub",    LDAP_SCOPE_SUBTREE},
80     {NULL,               NULL,     0}
81 };
82
83 /********************************************************
84  * Static helper function
85  ********************************************************/
86
87 /*
88  * ldap_getattr_fromfilter_withbase_scope():
89  *   conflags: KEEPALIVE
90  *   scope: LDAP_SCOPE_BASE, LDAP_SCOPE_ONELEVEL, LDAP_SCOPE_SUBTREE
91  *   result: return unique search result here, allocated here, caller must free
92  *
93  * All connection managment to the LDAP server is done here. Just set KEEPALIVE if you know
94  * you will be dispatching more than one search in a row, then don't set it with the last search.
95  * You MUST dispatch the queries timely, otherwise the LDAP handle might timeout.
96  */
97 static int ldap_getattr_fromfilter_withbase_scope( const char *searchbase,
98                                                    const char *filter,
99                                                    char *attributes[],
100                                                    int scope,
101                                                    ldapcon_t conflags,
102                                                    char **result) {
103     int ret = 0;
104     int ldaperr;
105     int ldap_results = -1;
106     int desired_version  = LDAP_VERSION3;
107     static int ldapconnected = 0;
108     static LDAP *ld     = NULL;
109     LDAPMessage* msg    = NULL;
110     LDAPMessage* entry  = NULL;
111
112     char **attribute_values;
113     struct timeval timeout;
114
115     LOG(log_maxdebug, logtype_afpd,"ldap_getattr_fromfilter_withbase_scope: BEGIN");
116
117     timeout.tv_sec = 3;
118     timeout.tv_usec = 0;
119
120     /* init LDAP if necessary */
121     if (!ld) {
122         LOG(log_maxdebug, logtype_default, "ldap_getattr_fromfilter_withbase_scope: LDAP server: \"%s\"",
123             ldap_server);
124         if ((ld = ldap_init(ldap_server, LDAP_PORT)) == NULL ) {
125             LOG(log_error, logtype_default, "ldap_getattr_fromfilter_withbase_scope: ldap_init error");
126             return -1;
127         }
128         if (ldap_set_option(ld, LDAP_OPT_PROTOCOL_VERSION, &desired_version) != 0) {
129             /* LDAP_OPT_SUCCESS is not in the proposed standard, so we check for 0
130                http://tools.ietf.org/id/draft-ietf-ldapext-ldap-c-api-05.txt */
131             LOG(log_error, logtype_default, "ldap_getattr_fromfilter_withbase_scope: ldap_set_option failed!");
132             ret = -1;
133             goto cleanup;
134         }
135     }
136
137     /* connect */
138     if (!ldapconnected) {
139         if (LDAP_AUTH_NONE == ldap_auth_method) {
140             if (ldap_bind_s(ld, "", "", LDAP_AUTH_SIMPLE) != LDAP_SUCCESS ) {
141                 LOG(log_error, logtype_default, "ldap_getattr_fromfilter_withbase_scope: ldap_bind failed!");
142                 LOG(log_error, logtype_default, "ldap_auth_method: \'%d\'", ldap_auth_method);
143                 return -1;
144             }
145             ldapconnected = 1;
146
147         } else if (LDAP_AUTH_SIMPLE == ldap_auth_method) {
148             if (ldap_bind_s(ld, ldap_auth_dn, ldap_auth_pw, ldap_auth_method) != LDAP_SUCCESS ) {
149                 LOG(log_error, logtype_default, "ldap_getattr_fromfilter_withbase_scope: ldap_bind failed!");
150                 LOG(log_error, logtype_default, "ldap_auth_dn: \'%s\', ldap_auth_pw: \'%s\', ldap_auth_method: \'%d\'",
151                     ldap_auth_dn, ldap_auth_pw, ldap_auth_method);
152                 return -1;
153             }
154             ldapconnected = 1;
155         }
156     }
157
158     LOG(log_maxdebug, logtype_afpd, "LDAP start search: base: %s, filter: %s, attr: %s",
159         searchbase, filter, attributes[0]);
160
161     /* start LDAP search */
162     ldaperr = ldap_search_st(ld, searchbase, scope, filter, attributes, 0, &timeout, &msg);
163     if (ldaperr != LDAP_SUCCESS) {
164         LOG(log_error, logtype_default, "ldap_getattr_fromfilter_withbase_scope: ldap_search_st failed: %s", ldap_err2string(ldaperr));
165         ret = -1;
166         goto cleanup;
167     }
168
169     /* parse search result */
170     LOG(log_maxdebug, logtype_default, "ldap_getuuidfromname: got %d entries from ldap search",
171         ldap_count_entries(ld, msg));
172     if ((ldap_results = ldap_count_entries(ld, msg)) != 1) {
173         ret = -1;
174         goto cleanup;
175     }
176
177     entry = ldap_first_entry(ld, msg);
178     if (entry == NULL) {
179         LOG(log_error, logtype_default, "ldap_getattr_fromfilter_withbase_scope: error in ldap_first_entry");
180         ret = -1;
181         goto cleanup;
182     }
183     attribute_values = ldap_get_values(ld, entry, attributes[0]);
184     if (attribute_values == NULL) {
185         LOG(log_error, logtype_default, "ldap_getattr_fromfilter_withbase_scope: error in ldap_get_values");
186         ret = -1;
187         goto cleanup;
188     }
189
190     LOG(log_maxdebug, logtype_afpd,"LDAP Search result: %s: %s",
191         attributes[0], attribute_values[0]);
192
193     /* allocate place for uuid as string */
194     *result = calloc( 1, strlen(attribute_values[0]) + 1);
195     if (*result == NULL) {
196         LOG(log_error, logtype_default, "ldap_getattr_fromfilter_withbase_scope: %s: error calloc'ing",strerror(errno));
197         ret = -1;
198         goto cleanup;
199     }
200     /* get value */
201     strcpy( *result, attribute_values[0]);
202     ldap_value_free(attribute_values);
203
204     /* FIXME: is there another way to free entry ? */
205     while (entry != NULL)
206         entry = ldap_next_entry(ld, entry);
207
208 cleanup:
209     if (msg)
210         ldap_msgfree(msg);
211     if (ld) {
212         if (ldapconnected
213             && ( !(conflags & KEEPALIVE)
214                  ||
215                  ((ret == -1) && (ldaperr != LDAP_NO_RESULTS_RETURNED)))
216             ) {
217
218             ldapconnected = 0;  /* regardless of unbind errors */
219             LOG(log_maxdebug, logtype_default,"LDAP unbind");
220             if (ldap_unbind_s(ld) != 0) {
221                 LOG(log_error, logtype_default, "ldap_unbind_s: %s\n", ldap_err2string(ldaperr));
222                 return -1;
223             }
224         }
225     }
226     return ret;
227 }
228
229 /********************************************************
230  * Interface
231  ********************************************************/
232
233 int ldap_getuuidfromname( const char *name, uuidtype_t type, char **uuid_string) {
234     int ret;
235     int len;
236     char filter[256];           /* this should really be enough. we dont want to malloc everything! */
237     char *attributes[]  = { ldap_uuid_attr, NULL};
238     char *ldap_attr;
239
240     /* make filter */
241     if (type == UUID_GROUP)
242         ldap_attr = ldap_group_attr;
243     else /* type hopefully == UUID_USER */
244         ldap_attr = ldap_name_attr;
245     len = snprintf( filter, 256, "%s=%s", ldap_attr, name);
246     if (len >= 256 || len == -1) {
247         LOG(log_error, logtype_default, "ldap_getnamefromuuid: filter error:%d, \"%s\"", len, filter);
248         return -1;
249     }
250
251     if (type == UUID_GROUP) {
252         ret = ldap_getattr_fromfilter_withbase_scope( ldap_groupbase, filter, attributes, ldap_groupscope, KEEPALIVE, uuid_string);
253     } else  { /* type hopefully == UUID_USER */
254         ret = ldap_getattr_fromfilter_withbase_scope( ldap_userbase, filter, attributes, ldap_userscope, KEEPALIVE, uuid_string);
255     }
256     return ret;
257 }
258
259 int ldap_getnamefromuuid( char *uuidstr, char **name, uuidtype_t *type) {
260     int ret;
261     int len;
262     char filter[256];       /* this should really be enough. we dont want to malloc everything! */
263     char *attributes[]  = { NULL, NULL};
264
265     /* make filter */
266     len = snprintf( filter, 256, "%s=%s", ldap_uuid_attr, uuidstr);
267     if (len >= 256 || len == -1) {
268         LOG(log_error, logtype_default, "ldap_getnamefromuuid: filter overflow:%d, \"%s\"", len, filter);
269         return -1;
270     }
271     /* search groups first. group acls are probably used more often */
272     attributes[0] = ldap_group_attr;
273     ret = ldap_getattr_fromfilter_withbase_scope( ldap_groupbase, filter, attributes, ldap_groupscope, KEEPALIVE, name);
274     if (ret == 0) {
275         *type = UUID_GROUP;
276         return 0;
277     }
278     attributes[0] = ldap_name_attr;
279     ret = ldap_getattr_fromfilter_withbase_scope( ldap_userbase, filter, attributes, ldap_userscope, KEEPALIVE, name);
280     if (ret == 0) {
281         *type = UUID_USER;
282         return 0;
283     }
284
285     return ret;
286 }