d2464c3cbf6dd4a2dbeb05cd7e0bd000702da0c4
[amitay/samba.git] / source4 / auth / ntlm / auth.c
1 /* 
2    Unix SMB/CIFS implementation.
3    Password and authentication handling
4    Copyright (C) Andrew Bartlett         2001-2002
5    Copyright (C) Stefan Metzmacher       2005
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "includes.h"
22 #include <tevent.h>
23 #include "../lib/util/tevent_ntstatus.h"
24 #include "../lib/util/dlinklist.h"
25 #include "auth/auth.h"
26 #include "auth/ntlm/auth_proto.h"
27 #include "param/param.h"
28 #include "dsdb/samdb/samdb.h"
29
30
31 /***************************************************************************
32  Set a fixed challenge
33 ***************************************************************************/
34 _PUBLIC_ NTSTATUS auth_context_set_challenge(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by) 
35 {
36         auth_ctx->challenge.set_by = talloc_strdup(auth_ctx, set_by);
37         NT_STATUS_HAVE_NO_MEMORY(auth_ctx->challenge.set_by);
38
39         auth_ctx->challenge.data = data_blob_talloc(auth_ctx, chal, 8);
40         NT_STATUS_HAVE_NO_MEMORY(auth_ctx->challenge.data.data);
41
42         return NT_STATUS_OK;
43 }
44
45 /***************************************************************************
46  Set a fixed challenge
47 ***************************************************************************/
48 _PUBLIC_ bool auth_challenge_may_be_modified(struct auth4_context *auth_ctx)
49 {
50         return auth_ctx->challenge.may_be_modified;
51 }
52
53 /****************************************************************************
54  Try to get a challenge out of the various authentication modules.
55  Returns a const char of length 8 bytes.
56 ****************************************************************************/
57 _PUBLIC_ NTSTATUS auth_get_challenge(struct auth4_context *auth_ctx, uint8_t chal[8])
58 {
59         NTSTATUS nt_status;
60         struct auth_method_context *method;
61
62         if (auth_ctx->challenge.data.length == 8) {
63                 DEBUG(5, ("auth_get_challenge: returning previous challenge by module %s (normal)\n", 
64                           auth_ctx->challenge.set_by));
65                 memcpy(chal, auth_ctx->challenge.data.data, 8);
66                 return NT_STATUS_OK;
67         }
68
69         for (method = auth_ctx->methods; method; method = method->next) {
70                 nt_status = method->ops->get_challenge(method, auth_ctx, chal);
71                 if (NT_STATUS_EQUAL(nt_status, NT_STATUS_NOT_IMPLEMENTED)) {
72                         continue;
73                 }
74
75                 NT_STATUS_NOT_OK_RETURN(nt_status);
76
77                 auth_ctx->challenge.data        = data_blob_talloc(auth_ctx, chal, 8);
78                 NT_STATUS_HAVE_NO_MEMORY(auth_ctx->challenge.data.data);
79                 auth_ctx->challenge.set_by      = method->ops->name;
80
81                 break;
82         }
83
84         if (!auth_ctx->challenge.set_by) {
85                 generate_random_buffer(chal, 8);
86
87                 auth_ctx->challenge.data                = data_blob_talloc(auth_ctx, chal, 8);
88                 NT_STATUS_HAVE_NO_MEMORY(auth_ctx->challenge.data.data);
89                 auth_ctx->challenge.set_by              = "random";
90
91                 auth_ctx->challenge.may_be_modified     = true;
92         }
93
94         DEBUG(10,("auth_get_challenge: challenge set by %s\n",
95                  auth_ctx->challenge.set_by));
96
97         return NT_STATUS_OK;
98 }
99
100 /****************************************************************************
101 Used in the gensec_gssapi and gensec_krb5 server-side code, where the
102 PAC isn't available, and for tokenGroups in the DSDB stack.
103
104  Supply either a principal or a DN
105 ****************************************************************************/
106 _PUBLIC_ NTSTATUS auth_get_user_info_dc_principal(TALLOC_CTX *mem_ctx,
107                                                  struct auth4_context *auth_ctx,
108                                                  const char *principal,
109                                                  struct ldb_dn *user_dn,
110                                                  struct auth_user_info_dc **user_info_dc)
111 {
112         NTSTATUS nt_status;
113         struct auth_method_context *method;
114
115         for (method = auth_ctx->methods; method; method = method->next) {
116                 if (!method->ops->get_user_info_dc_principal) {
117                         continue;
118                 }
119
120                 nt_status = method->ops->get_user_info_dc_principal(mem_ctx, auth_ctx, principal, user_dn, user_info_dc);
121                 if (NT_STATUS_EQUAL(nt_status, NT_STATUS_NOT_IMPLEMENTED)) {
122                         continue;
123                 }
124
125                 return nt_status;
126         }
127
128         return NT_STATUS_NOT_IMPLEMENTED;
129 }
130
131 /**
132  * Check a user's Plaintext, LM or NTLM password.
133  * (sync version)
134  *
135  * Check a user's password, as given in the user_info struct and return various
136  * interesting details in the user_info_dc struct.
137  *
138  * The return value takes precedence over the contents of the user_info_dc
139  * struct.  When the return is other than NT_STATUS_OK the contents 
140  * of that structure is undefined.
141  *
142  * @param auth_ctx Supplies the challenges and some other data. 
143  *                  Must be created with auth_context_create(), and the challenges should be 
144  *                  filled in, either at creation or by calling the challenge geneation 
145  *                  function auth_get_challenge().  
146  *
147  * @param user_info Contains the user supplied components, including the passwords.
148  *
149  * @param mem_ctx The parent memory context for the user_info_dc structure
150  *
151  * @param user_info_dc If successful, contains information about the authentication,
152  *                    including a SAM_ACCOUNT struct describing the user.
153  *
154  * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
155  *
156  **/
157
158 _PUBLIC_ NTSTATUS auth_check_password(struct auth4_context *auth_ctx,
159                              TALLOC_CTX *mem_ctx,
160                              const struct auth_usersupplied_info *user_info, 
161                              struct auth_user_info_dc **user_info_dc)
162 {
163         struct tevent_req *subreq;
164         struct tevent_context *ev;
165         bool ok;
166         NTSTATUS status;
167
168         /*TODO: create a new event context here! */
169         ev = auth_ctx->event_ctx;
170
171         subreq = auth_check_password_send(mem_ctx,
172                                           ev,
173                                           auth_ctx,
174                                           user_info);
175         if (subreq == NULL) {
176                 return NT_STATUS_NO_MEMORY;
177         }
178
179         ok = tevent_req_poll(subreq, ev);
180         if (!ok) {
181                 return NT_STATUS_INTERNAL_ERROR;
182         }
183
184         status = auth_check_password_recv(subreq, mem_ctx, user_info_dc);
185         TALLOC_FREE(subreq);
186
187         return status;
188 }
189
190 struct auth_check_password_state {
191         struct auth4_context *auth_ctx;
192         const struct auth_usersupplied_info *user_info;
193         struct auth_user_info_dc *user_info_dc;
194         struct auth_method_context *method;
195 };
196
197 static void auth_check_password_async_trigger(struct tevent_context *ev,
198                                               struct tevent_immediate *im,
199                                               void *private_data);
200 /**
201  * Check a user's Plaintext, LM or NTLM password.
202  * async send hook
203  *
204  * Check a user's password, as given in the user_info struct and return various
205  * interesting details in the user_info_dc struct.
206  *
207  * The return value takes precedence over the contents of the user_info_dc
208  * struct.  When the return is other than NT_STATUS_OK the contents 
209  * of that structure is undefined.
210  *
211  * @param mem_ctx The memory context the request should operate on
212  *
213  * @param ev The tevent context the request should operate on
214  *
215  * @param auth_ctx Supplies the challenges and some other data. 
216  *                  Must be created with make_auth_context(), and the challenges should be 
217  *                  filled in, either at creation or by calling the challenge geneation 
218  *                  function auth_get_challenge().  
219  *
220  * @param user_info Contains the user supplied components, including the passwords.
221  *
222  * @return The request handle or NULL on no memory error.
223  *
224  **/
225
226 _PUBLIC_ struct tevent_req *auth_check_password_send(TALLOC_CTX *mem_ctx,
227                                 struct tevent_context *ev,
228                                 struct auth4_context *auth_ctx,
229                                 const struct auth_usersupplied_info *user_info)
230 {
231         struct tevent_req *req;
232         struct auth_check_password_state *state;
233         /* if all the modules say 'not for me' this is reasonable */
234         NTSTATUS nt_status;
235         uint8_t chal[8];
236         struct auth_usersupplied_info *user_info_tmp;
237         struct tevent_immediate *im;
238
239         DEBUG(3,("auth_check_password_send: "
240                  "Checking password for unmapped user [%s]\\[%s]@[%s]\n",
241                  user_info->client.domain_name, user_info->client.account_name,
242                  user_info->workstation_name));
243
244         req = tevent_req_create(mem_ctx, &state,
245                                 struct auth_check_password_state);
246         if (req == NULL) {
247                 return NULL;
248         }
249
250         state->auth_ctx         = auth_ctx;
251         state->user_info        = user_info;
252
253         if (!user_info->mapped_state) {
254                 nt_status = map_user_info(req, lpcfg_workgroup(auth_ctx->lp_ctx),
255                                           user_info, &user_info_tmp);
256                 if (tevent_req_nterror(req, nt_status)) {
257                         return tevent_req_post(req, ev);
258                 }
259                 user_info = user_info_tmp;
260                 state->user_info = user_info_tmp;
261         }
262
263         DEBUGADD(3,("auth_check_password_send: "
264                     "mapped user is: [%s]\\[%s]@[%s]\n",
265                     user_info->mapped.domain_name,
266                     user_info->mapped.account_name,
267                     user_info->workstation_name));
268
269         nt_status = auth_get_challenge(auth_ctx, chal);
270         if (tevent_req_nterror(req, nt_status)) {
271                 DEBUG(0,("auth_check_password_send: "
272                          "Invalid challenge (length %u) stored for "
273                          "this auth context set_by %s - cannot continue: %s\n",
274                         (unsigned)auth_ctx->challenge.data.length,
275                         auth_ctx->challenge.set_by,
276                         nt_errstr(nt_status)));
277                 return tevent_req_post(req, ev);
278         }
279
280         if (auth_ctx->challenge.set_by) {
281                 DEBUG(10,("auth_check_password_send: "
282                           "auth_context challenge created by %s\n",
283                           auth_ctx->challenge.set_by));
284         }
285
286         DEBUG(10, ("auth_check_password_send: challenge is: \n"));
287         dump_data(5, auth_ctx->challenge.data.data,
288                   auth_ctx->challenge.data.length);
289
290         im = tevent_create_immediate(state);
291         if (tevent_req_nomem(im, req)) {
292                 return tevent_req_post(req, ev);
293         }
294
295         tevent_schedule_immediate(im,
296                                   auth_ctx->event_ctx,
297                                   auth_check_password_async_trigger,
298                                   req);
299         return req;
300 }
301
302 static void auth_check_password_async_trigger(struct tevent_context *ev,
303                                               struct tevent_immediate *im,
304                                               void *private_data)
305 {
306         struct tevent_req *req =
307                 talloc_get_type_abort(private_data, struct tevent_req);
308         struct auth_check_password_state *state =
309                 tevent_req_data(req, struct auth_check_password_state);
310         NTSTATUS status;
311         struct auth_method_context *method;
312
313         status = NT_STATUS_OK;
314
315         for (method=state->auth_ctx->methods; method; method = method->next) {
316
317                 /* we fill in state->method here so debug messages in
318                    the callers know which method failed */
319                 state->method = method;
320
321                 /* check if the module wants to check the password */
322                 status = method->ops->want_check(method, req, state->user_info);
323                 if (NT_STATUS_EQUAL(status, NT_STATUS_NOT_IMPLEMENTED)) {
324                         DEBUG(11,("auth_check_password_send: "
325                                   "%s had nothing to say\n",
326                                   method->ops->name));
327                         continue;
328                 }
329
330                 if (tevent_req_nterror(req, status)) {
331                         return;
332                 }
333
334                 status = method->ops->check_password(method,
335                                                      state,
336                                                      state->user_info,
337                                                      &state->user_info_dc);
338                 if (!NT_STATUS_EQUAL(status, NT_STATUS_NOT_IMPLEMENTED)) {
339                         /* the backend has handled the request */
340                         break;
341                 }
342         }
343
344         if (NT_STATUS_EQUAL(status, NT_STATUS_NOT_IMPLEMENTED)) {
345                 /* don't expose the NT_STATUS_NOT_IMPLEMENTED
346                    internals */
347                 status = NT_STATUS_NO_SUCH_USER;
348         }
349
350         if (tevent_req_nterror(req, status)) {
351                 return;
352         }
353
354         tevent_req_done(req);
355 }
356
357 /**
358  * Check a user's Plaintext, LM or NTLM password.
359  * async receive function
360  *
361  * The return value takes precedence over the contents of the user_info_dc
362  * struct.  When the return is other than NT_STATUS_OK the contents 
363  * of that structure is undefined.
364  *
365  *
366  * @param req The async request state
367  *
368  * @param mem_ctx The parent memory context for the user_info_dc structure
369  *
370  * @param user_info_dc If successful, contains information about the authentication,
371  *                    including a SAM_ACCOUNT struct describing the user.
372  *
373  * @return An NTSTATUS with NT_STATUS_OK or an appropriate error.
374  *
375  **/
376
377 _PUBLIC_ NTSTATUS auth_check_password_recv(struct tevent_req *req,
378                                   TALLOC_CTX *mem_ctx,
379                                   struct auth_user_info_dc **user_info_dc)
380 {
381         struct auth_check_password_state *state =
382                 tevent_req_data(req, struct auth_check_password_state);
383         NTSTATUS status;
384
385         if (tevent_req_is_nterror(req, &status)) {
386                 DEBUG(2,("auth_check_password_recv: "
387                          "%s authentication for user [%s\\%s] "
388                          "FAILED with error %s\n",
389                          (state->method ? state->method->ops->name : "NO_METHOD"),
390                          state->user_info->mapped.domain_name,
391                          state->user_info->mapped.account_name,
392                          nt_errstr(status)));
393                 tevent_req_received(req);
394                 return status;
395         }
396
397         DEBUG(5,("auth_check_password_recv: "
398                  "%s authentication for user [%s\\%s] succeeded\n",
399                  state->method->ops->name,
400                  state->user_info_dc->info->domain_name,
401                  state->user_info_dc->info->account_name));
402
403         *user_info_dc = talloc_move(mem_ctx, &state->user_info_dc);
404
405         tevent_req_received(req);
406         return NT_STATUS_OK;
407 }
408
409 /* Wrapper because we don't want to expose all callers to needing to
410  * know that session_info is generated from the main ldb */
411 static NTSTATUS auth_generate_session_info_wrapper(TALLOC_CTX *mem_ctx,
412                                                    struct auth4_context *auth_context,
413                                                    struct auth_user_info_dc *user_info_dc,
414                                                    uint32_t session_info_flags,
415                                                    struct auth_session_info **session_info)
416 {
417         return auth_generate_session_info(mem_ctx, auth_context->lp_ctx,
418                                           auth_context->sam_ctx, user_info_dc,
419                                           session_info_flags, session_info);
420 }
421
422 /***************************************************************************
423  Make a auth_info struct for the auth subsystem
424  - Allow the caller to specify the methods to use, including optionally the SAM to use
425 ***************************************************************************/
426 _PUBLIC_ NTSTATUS auth_context_create_methods(TALLOC_CTX *mem_ctx, const char **methods, 
427                                               struct tevent_context *ev,
428                                               struct imessaging_context *msg,
429                                               struct loadparm_context *lp_ctx,
430                                               struct ldb_context *sam_ctx,
431                                               struct auth4_context **auth_ctx)
432 {
433         int i;
434         struct auth4_context *ctx;
435
436         auth4_init();
437
438         if (!ev) {
439                 DEBUG(0,("auth_context_create: called with out event context\n"));
440                 return NT_STATUS_INTERNAL_ERROR;
441         }
442
443         ctx = talloc(mem_ctx, struct auth4_context);
444         NT_STATUS_HAVE_NO_MEMORY(ctx);
445         ctx->challenge.set_by           = NULL;
446         ctx->challenge.may_be_modified  = false;
447         ctx->challenge.data             = data_blob(NULL, 0);
448         ctx->methods                    = NULL;
449         ctx->event_ctx                  = ev;
450         ctx->msg_ctx                    = msg;
451         ctx->lp_ctx                     = lp_ctx;
452
453         if (sam_ctx) {
454                 ctx->sam_ctx = sam_ctx;
455         } else {
456                 ctx->sam_ctx = samdb_connect(ctx, ctx->event_ctx, ctx->lp_ctx, system_session(ctx->lp_ctx), 0);
457         }
458
459         for (i=0; methods && methods[i] ; i++) {
460                 struct auth_method_context *method;
461
462                 method = talloc(ctx, struct auth_method_context);
463                 NT_STATUS_HAVE_NO_MEMORY(method);
464
465                 method->ops = auth_backend_byname(methods[i]);
466                 if (!method->ops) {
467                         DEBUG(1,("auth_context_create: failed to find method=%s\n",
468                                 methods[i]));
469                         return NT_STATUS_INTERNAL_ERROR;
470                 }
471                 method->auth_ctx        = ctx;
472                 method->depth           = i;
473                 DLIST_ADD_END(ctx->methods, method, struct auth_method_context *);
474         }
475
476         ctx->check_password = auth_check_password;
477         ctx->get_challenge = auth_get_challenge;
478         ctx->set_challenge = auth_context_set_challenge;
479         ctx->challenge_may_be_modified = auth_challenge_may_be_modified;
480         ctx->get_user_info_dc_principal = auth_get_user_info_dc_principal;
481         ctx->generate_session_info = auth_generate_session_info_wrapper;
482
483         *auth_ctx = ctx;
484
485         return NT_STATUS_OK;
486 }
487
488 const char **auth_methods_from_lp(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx)
489 {
490         char **auth_methods = NULL;
491
492         switch (lpcfg_server_role(lp_ctx)) {
493         case ROLE_STANDALONE:
494                 auth_methods = str_list_make(mem_ctx, "anonymous sam_ignoredomain", NULL);
495                 break;
496         case ROLE_DOMAIN_MEMBER:
497                 auth_methods = str_list_make(mem_ctx, "anonymous sam winbind", NULL);
498                 break;
499         case ROLE_DOMAIN_BDC:
500         case ROLE_DOMAIN_PDC:
501                 auth_methods = str_list_make(mem_ctx, "anonymous sam_ignoredomain winbind", NULL);
502                 break;
503         }
504         return (const char **) auth_methods;
505 }
506
507 /***************************************************************************
508  Make a auth_info struct for the auth subsystem
509  - Uses default auth_methods, depending on server role and smb.conf settings
510 ***************************************************************************/
511 _PUBLIC_ NTSTATUS auth_context_create(TALLOC_CTX *mem_ctx,
512                              struct tevent_context *ev,
513                              struct imessaging_context *msg,
514                              struct loadparm_context *lp_ctx,
515                              struct auth4_context **auth_ctx)
516 {
517         NTSTATUS status;
518         const char **auth_methods;
519         TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
520         if (!tmp_ctx) {
521                 return NT_STATUS_NO_MEMORY;
522         }
523
524         auth_methods = auth_methods_from_lp(tmp_ctx, lp_ctx);
525         if (!auth_methods) {
526                 return NT_STATUS_INVALID_PARAMETER;
527         }
528         status = auth_context_create_methods(mem_ctx, auth_methods, ev, msg, lp_ctx, NULL, auth_ctx);
529         talloc_free(tmp_ctx);
530         return status;
531 }
532
533 /* Create an auth context from an open LDB.
534
535    This allows us not to re-open the LDB when we need to do a some authentication logic (such as tokenGroups)
536
537  */
538 NTSTATUS auth_context_create_from_ldb(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, struct auth4_context **auth_ctx)
539 {
540         NTSTATUS status;
541         const char **auth_methods;
542         struct loadparm_context *lp_ctx = talloc_get_type_abort(ldb_get_opaque(ldb, "loadparm"), struct loadparm_context);
543         struct tevent_context *ev = ldb_get_event_context(ldb);
544
545         TALLOC_CTX *tmp_ctx = talloc_new(mem_ctx);
546         if (!tmp_ctx) {
547                 return NT_STATUS_NO_MEMORY;
548         }
549
550         auth_methods = auth_methods_from_lp(tmp_ctx, lp_ctx);
551         if (!auth_methods) {
552                 return NT_STATUS_INVALID_PARAMETER;
553         }
554         status = auth_context_create_methods(mem_ctx, auth_methods, ev, NULL, lp_ctx, ldb, auth_ctx);
555         talloc_free(tmp_ctx);
556         return status;
557 }
558
559 /* the list of currently registered AUTH backends */
560 static struct auth_backend {
561         const struct auth_operations *ops;
562 } *backends = NULL;
563 static int num_backends;
564
565 /*
566   register a AUTH backend. 
567
568   The 'name' can be later used by other backends to find the operations
569   structure for this backend.
570 */
571 _PUBLIC_ NTSTATUS auth_register(const struct auth_operations *ops)
572 {
573         struct auth_operations *new_ops;
574         
575         if (auth_backend_byname(ops->name) != NULL) {
576                 /* its already registered! */
577                 DEBUG(0,("AUTH backend '%s' already registered\n", 
578                          ops->name));
579                 return NT_STATUS_OBJECT_NAME_COLLISION;
580         }
581
582         backends = talloc_realloc(talloc_autofree_context(), backends, 
583                                   struct auth_backend, num_backends+1);
584         NT_STATUS_HAVE_NO_MEMORY(backends);
585
586         new_ops = (struct auth_operations *)talloc_memdup(backends, ops, sizeof(*ops));
587         NT_STATUS_HAVE_NO_MEMORY(new_ops);
588         new_ops->name = talloc_strdup(new_ops, ops->name);
589         NT_STATUS_HAVE_NO_MEMORY(new_ops->name);
590
591         backends[num_backends].ops = new_ops;
592
593         num_backends++;
594
595         DEBUG(3,("AUTH backend '%s' registered\n", 
596                  ops->name));
597
598         return NT_STATUS_OK;
599 }
600
601 /*
602   return the operations structure for a named backend of the specified type
603 */
604 const struct auth_operations *auth_backend_byname(const char *name)
605 {
606         int i;
607
608         for (i=0;i<num_backends;i++) {
609                 if (strcmp(backends[i].ops->name, name) == 0) {
610                         return backends[i].ops;
611                 }
612         }
613
614         return NULL;
615 }
616
617 /*
618   return the AUTH interface version, and the size of some critical types
619   This can be used by backends to either detect compilation errors, or provide
620   multiple implementations for different smbd compilation options in one module
621 */
622 const struct auth_critical_sizes *auth_interface_version(void)
623 {
624         static const struct auth_critical_sizes critical_sizes = {
625                 AUTH4_INTERFACE_VERSION,
626                 sizeof(struct auth_operations),
627                 sizeof(struct auth_method_context),
628                 sizeof(struct auth4_context),
629                 sizeof(struct auth_usersupplied_info),
630                 sizeof(struct auth_user_info_dc)
631         };
632
633         return &critical_sizes;
634 }
635
636 _PUBLIC_ NTSTATUS auth4_init(void)
637 {
638         static bool initialized = false;
639 #define _MODULE_PROTO(init) extern NTSTATUS init(void);
640         STATIC_auth4_MODULES_PROTO;
641         init_module_fn static_init[] = { STATIC_auth4_MODULES };
642         
643         if (initialized) return NT_STATUS_OK;
644         initialized = true;
645         
646         run_init_functions(static_init);
647         
648         return NT_STATUS_OK;    
649 }