auth/gensec: introduce gensec_internal.h
[sharpe/samba-autobuild/.git] / source4 / libcli / ldap / ldap_bind.c
1 /* 
2    Unix SMB/CIFS mplementation.
3
4    LDAP bind calls
5    
6    Copyright (C) Andrew Tridgell  2005
7    Copyright (C) Volker Lendecke  2004
8     
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13    
14    This program 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
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
21    
22 */
23
24 #include "includes.h"
25 #include "libcli/ldap/libcli_ldap.h"
26 #include "libcli/ldap/ldap_proto.h"
27 #include "libcli/ldap/ldap_client.h"
28 #include "lib/tls/tls.h"
29 #include "auth/gensec/gensec.h"
30 #include "auth/gensec/gensec_internal.h" /* TODO: remove this */
31 #include "auth/gensec/gensec_socket.h"
32 #include "auth/credentials/credentials.h"
33 #include "lib/stream/packet.h"
34 #include "param/param.h"
35
36 struct ldap_simple_creds {
37         const char *dn;
38         const char *pw;
39 };
40
41 _PUBLIC_ NTSTATUS ldap_rebind(struct ldap_connection *conn)
42 {
43         NTSTATUS status;
44         struct ldap_simple_creds *creds;
45
46         switch (conn->bind.type) {
47         case LDAP_BIND_SASL:
48                 status = ldap_bind_sasl(conn, (struct cli_credentials *)conn->bind.creds,
49                                         conn->lp_ctx);
50                 break;
51                 
52         case LDAP_BIND_SIMPLE:
53                 creds = (struct ldap_simple_creds *)conn->bind.creds;
54
55                 if (creds == NULL) {
56                         return NT_STATUS_UNSUCCESSFUL;
57                 }
58
59                 status = ldap_bind_simple(conn, creds->dn, creds->pw);
60                 break;
61
62         default:
63                 return NT_STATUS_UNSUCCESSFUL;
64         }
65
66         return status;
67 }
68
69
70 static struct ldap_message *new_ldap_simple_bind_msg(struct ldap_connection *conn, 
71                                                      const char *dn, const char *pw)
72 {
73         struct ldap_message *res;
74
75         res = new_ldap_message(conn);
76         if (!res) {
77                 return NULL;
78         }
79
80         res->type = LDAP_TAG_BindRequest;
81         res->r.BindRequest.version = 3;
82         res->r.BindRequest.dn = talloc_strdup(res, dn);
83         res->r.BindRequest.mechanism = LDAP_AUTH_MECH_SIMPLE;
84         res->r.BindRequest.creds.password = talloc_strdup(res, pw);
85         res->controls = NULL;
86
87         return res;
88 }
89
90
91 /*
92   perform a simple username/password bind
93 */
94 _PUBLIC_ NTSTATUS ldap_bind_simple(struct ldap_connection *conn, 
95                           const char *userdn, const char *password)
96 {
97         struct ldap_request *req;
98         struct ldap_message *msg;
99         const char *dn, *pw;
100         NTSTATUS status;
101
102         if (conn == NULL) {
103                 return NT_STATUS_INVALID_CONNECTION;
104         }
105
106         if (userdn) {
107                 dn = userdn;
108         } else {
109                 if (conn->auth_dn) {
110                         dn = conn->auth_dn;
111                 } else {
112                         dn = "";
113                 }
114         }
115
116         if (password) {
117                 pw = password;
118         } else {
119                 if (conn->simple_pw) {
120                         pw = conn->simple_pw;
121                 } else {
122                         pw = "";
123                 }
124         }
125
126         msg = new_ldap_simple_bind_msg(conn, dn, pw);
127         NT_STATUS_HAVE_NO_MEMORY(msg);
128
129         /* send the request */
130         req = ldap_request_send(conn, msg);
131         talloc_free(msg);
132         NT_STATUS_HAVE_NO_MEMORY(req);
133
134         /* wait for replies */
135         status = ldap_request_wait(req);
136         if (!NT_STATUS_IS_OK(status)) {
137                 talloc_free(req);
138                 return status;
139         }
140
141         /* check its a valid reply */
142         msg = req->replies[0];
143         if (msg->type != LDAP_TAG_BindResponse) {
144                 talloc_free(req);
145                 return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
146         }
147
148         status = ldap_check_response(conn, &msg->r.BindResponse.response);
149
150         talloc_free(req);
151
152         if (NT_STATUS_IS_OK(status)) {
153                 struct ldap_simple_creds *creds = talloc(conn, struct ldap_simple_creds);
154                 if (creds == NULL) {
155                         return NT_STATUS_NO_MEMORY;
156                 }
157                 creds->dn = talloc_strdup(creds, dn);
158                 creds->pw = talloc_strdup(creds, pw);
159                 if (creds->dn == NULL || creds->pw == NULL) {
160                         return NT_STATUS_NO_MEMORY;
161                 }
162                 conn->bind.type = LDAP_BIND_SIMPLE;
163                 conn->bind.creds = creds;
164         }
165
166         return status;
167 }
168
169
170 static struct ldap_message *new_ldap_sasl_bind_msg(struct ldap_connection *conn, 
171                                                    const char *sasl_mechanism, 
172                                                    DATA_BLOB *secblob)
173 {
174         struct ldap_message *res;
175
176         res = new_ldap_message(conn);
177         if (!res) {
178                 return NULL;
179         }
180
181         res->type = LDAP_TAG_BindRequest;
182         res->r.BindRequest.version = 3;
183         res->r.BindRequest.dn = "";
184         res->r.BindRequest.mechanism = LDAP_AUTH_MECH_SASL;
185         res->r.BindRequest.creds.SASL.mechanism = talloc_strdup(res, sasl_mechanism);
186         if (secblob) {
187                 res->r.BindRequest.creds.SASL.secblob = talloc(res, DATA_BLOB);
188                 if (!res->r.BindRequest.creds.SASL.secblob) {
189                         talloc_free(res);
190                         return NULL;
191                 }
192                 *res->r.BindRequest.creds.SASL.secblob = *secblob;
193         } else {
194                 res->r.BindRequest.creds.SASL.secblob = NULL;
195         }
196         res->controls = NULL;
197
198         return res;
199 }
200
201
202 /*
203   perform a sasl bind using the given credentials
204 */
205 _PUBLIC_ NTSTATUS ldap_bind_sasl(struct ldap_connection *conn,
206                         struct cli_credentials *creds,
207                         struct loadparm_context *lp_ctx)
208 {
209         NTSTATUS status;
210         TALLOC_CTX *tmp_ctx = NULL;
211
212         DATA_BLOB input = data_blob(NULL, 0);
213         DATA_BLOB output = data_blob(NULL, 0);
214
215         struct ldap_message **sasl_mechs_msgs;
216         struct ldap_SearchResEntry *search;
217         int count, i;
218
219         const char **sasl_names;
220         uint32_t old_gensec_features;
221         static const char *supported_sasl_mech_attrs[] = {
222                 "supportedSASLMechanisms", 
223                 NULL 
224         };
225         unsigned int logon_retries = 0;
226
227         status = ildap_search(conn, "", LDAP_SEARCH_SCOPE_BASE, "", supported_sasl_mech_attrs,
228                               false, NULL, NULL, &sasl_mechs_msgs);
229         if (!NT_STATUS_IS_OK(status)) {
230                 DEBUG(1, ("Failed to inquire of target's available sasl mechs in rootdse search: %s\n",
231                           nt_errstr(status)));
232                 goto failed;
233         }
234
235         count = ildap_count_entries(conn, sasl_mechs_msgs);
236         if (count != 1) {
237                 DEBUG(1, ("Failed to inquire of target's available sasl mechs in rootdse search: wrong number of replies: %d\n",
238                           count));
239                 goto failed;
240         }
241
242         tmp_ctx = talloc_new(conn);
243         if (tmp_ctx == NULL) goto failed;
244
245         search = &sasl_mechs_msgs[0]->r.SearchResultEntry;
246         if (search->num_attributes != 1) {
247                 DEBUG(1, ("Failed to inquire of target's available sasl mechs in rootdse search: wrong number of attributes: %d != 1\n",
248                           search->num_attributes));
249                 goto failed;
250         }
251
252         sasl_names = talloc_array(tmp_ctx, const char *, search->attributes[0].num_values + 1);
253         if (!sasl_names) {
254                 DEBUG(1, ("talloc_arry(char *, %d) failed\n",
255                           count));
256                 goto failed;
257         }
258
259         for (i=0; i<search->attributes[0].num_values; i++) {
260                 sasl_names[i] = (const char *)search->attributes[0].values[i].data;
261         }
262         sasl_names[i] = NULL;
263
264         gensec_init();
265
266 try_logon_again:
267         /*
268           we loop back here on a logon failure, and re-create the
269           gensec session. The logon_retries counter ensures we don't
270           loop forever.
271          */
272
273         status = gensec_client_start(conn, &conn->gensec,
274                                      lpcfg_gensec_settings(conn, lp_ctx));
275         if (!NT_STATUS_IS_OK(status)) {
276                 DEBUG(0, ("Failed to start GENSEC engine (%s)\n", nt_errstr(status)));
277                 goto failed;
278         }
279
280         /* require Kerberos SIGN/SEAL only if we don't use SSL
281          * Windows seem not to like double encryption */
282         old_gensec_features = cli_credentials_get_gensec_features(creds);
283         if (tls_enabled(conn->sock)) {
284                 cli_credentials_set_gensec_features(creds, old_gensec_features & ~(GENSEC_FEATURE_SIGN|GENSEC_FEATURE_SEAL));
285         }
286
287         /* this call also sets the gensec_want_features */
288         status = gensec_set_credentials(conn->gensec, creds);
289         if (!NT_STATUS_IS_OK(status)) {
290                 DEBUG(1, ("Failed to set GENSEC creds: %s\n", 
291                           nt_errstr(status)));
292                 goto failed;
293         }
294
295         /* reset the original gensec_features (on the credentials
296          * context, so we don't tatoo it ) */
297         cli_credentials_set_gensec_features(creds, old_gensec_features);
298
299         if (conn->host) {
300                 status = gensec_set_target_hostname(conn->gensec, conn->host);
301                 if (!NT_STATUS_IS_OK(status)) {
302                         DEBUG(1, ("Failed to set GENSEC target hostname: %s\n", 
303                                   nt_errstr(status)));
304                         goto failed;
305                 }
306         }
307
308         status = gensec_set_target_service(conn->gensec, "ldap");
309         if (!NT_STATUS_IS_OK(status)) {
310                 DEBUG(1, ("Failed to set GENSEC target service: %s\n", 
311                           nt_errstr(status)));
312                 goto failed;
313         }
314
315         status = gensec_start_mech_by_sasl_list(conn->gensec, sasl_names);
316         if (!NT_STATUS_IS_OK(status)) {
317                 DEBUG(1, ("None of the %d proposed SASL mechs were acceptable: %s\n",
318                           count, nt_errstr(status)));
319                 goto failed;
320         }
321
322         while (1) {
323                 NTSTATUS gensec_status;
324                 struct ldap_message *response;
325                 struct ldap_message *msg;
326                 struct ldap_request *req;
327                 int result = LDAP_OTHER;
328         
329                 status = gensec_update(conn->gensec, tmp_ctx,
330                                        conn->event.event_ctx,
331                                        input,
332                                        &output);
333                 /* The status value here, from GENSEC is vital to the security
334                  * of the system.  Even if the other end accepts, if GENSEC
335                  * claims 'MORE_PROCESSING_REQUIRED' then you must keep
336                  * feeding it blobs, or else the remote host/attacker might
337                  * avoid mutal authentication requirements.
338                  *
339                  * Likewise, you must not feed GENSEC too much (after the OK),
340                  * it doesn't like that either
341                  */
342
343                 gensec_status = status;
344
345                 if (!NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED) && 
346                     !NT_STATUS_IS_OK(status)) {
347                         break;
348                 }
349                 if (NT_STATUS_IS_OK(status) && output.length == 0) {
350                         break;
351                 }
352
353                 /* Perhaps we should make gensec_start_mech_by_sasl_list() return the name we got? */
354                 msg = new_ldap_sasl_bind_msg(tmp_ctx, conn->gensec->ops->sasl_name, (output.data?&output:NULL));
355                 if (msg == NULL) {
356                         status = NT_STATUS_NO_MEMORY;
357                         goto failed;
358                 }
359
360                 req = ldap_request_send(conn, msg);
361                 if (req == NULL) {
362                         status = NT_STATUS_NO_MEMORY;
363                         goto failed;
364                 }
365                 talloc_reparent(conn, tmp_ctx, req);
366
367                 status = ldap_result_n(req, 0, &response);
368                 if (!NT_STATUS_IS_OK(status)) {
369                         goto failed;
370                 }
371                 
372                 if (response->type != LDAP_TAG_BindResponse) {
373                         status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
374                         goto failed;
375                 }
376
377                 result = response->r.BindResponse.response.resultcode;
378
379                 if (result == LDAP_INVALID_CREDENTIALS) {
380                         /*
381                           try a second time on invalid credentials, to
382                           give the user a chance to re-enter the
383                           password and to handle the case where our
384                           kerberos ticket is invalid as the server
385                           password has changed
386                         */
387                         const char *principal;
388
389                         principal = gensec_get_target_principal(conn->gensec);
390                         if (principal == NULL) {
391                                 const char *hostname = gensec_get_target_hostname(conn->gensec);
392                                 const char *service  = gensec_get_target_service(conn->gensec);
393                                 if (hostname != NULL && service != NULL) {
394                                         principal = talloc_asprintf(tmp_ctx, "%s/%s", service, hostname);
395                                 }
396                         }
397
398                         if (cli_credentials_failed_kerberos_login(creds, principal, &logon_retries) ||
399                             cli_credentials_wrong_password(creds)) {
400                                 /*
401                                   destroy our gensec session and loop
402                                   back up to the top to retry,
403                                   offering the user a chance to enter
404                                   new credentials, or get a new ticket
405                                   if using kerberos
406                                  */
407                                 talloc_free(conn->gensec);
408                                 conn->gensec = NULL;
409                                 goto try_logon_again;
410                         }
411                 }
412
413                 if (result != LDAP_SUCCESS && result != LDAP_SASL_BIND_IN_PROGRESS) {
414                         status = ldap_check_response(conn, 
415                                                      &response->r.BindResponse.response);
416                         break;
417                 }
418
419                 /* This is where we check if GENSEC wanted to be fed more data */
420                 if (!NT_STATUS_EQUAL(gensec_status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
421                         break;
422                 }
423                 if (response->r.BindResponse.SASL.secblob) {
424                         input = *response->r.BindResponse.SASL.secblob;
425                 } else {
426                         input = data_blob(NULL, 0);
427                 }
428         }
429
430         talloc_free(tmp_ctx);
431
432         if (NT_STATUS_IS_OK(status)) {
433                 struct socket_context *sasl_socket;
434                 status = gensec_socket_init(conn->gensec, 
435                                             conn,
436                                             conn->sock,
437                                             conn->event.event_ctx, 
438                                             ldap_read_io_handler,
439                                             conn,
440                                             &sasl_socket);
441                 if (!NT_STATUS_IS_OK(status)) goto failed;
442
443                 conn->sock = sasl_socket;
444                 packet_set_socket(conn->packet, conn->sock);
445
446                 conn->bind.type = LDAP_BIND_SASL;
447                 conn->bind.creds = creds;
448         }
449
450         return status;
451
452 failed:
453         talloc_free(tmp_ctx);
454         talloc_free(conn->gensec);
455         conn->gensec = NULL;
456         return status;
457 }