a44b458d64d5f01b8516e6fa69a69abbcba5dd2e
[mod_auth_kerb.cvs/.git] / src / mod_auth_kerb.c
1 /*
2  * Daniel Kouril <kouril@users.sourceforge.net>
3  *
4  * Source and Documentation can be found at:
5  * http://modauthkerb.sourceforge.net/
6  *
7  * Based on work by
8  *   James E. Robinson, III <james@ncstate.net>
9  *   Daniel Henninger <daniel@ncsu.edu>
10  *   Ludek Sulak <xsulak@fi.muni.cz>
11  */
12
13 /* ====================================================================
14  * The Apache Software License, Version 1.1
15  *
16  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
17  * reserved.
18  *
19  * Redistribution and use in source and binary forms, with or without
20  * modification, are permitted provided that the following conditions
21  * are met:
22  *
23  * 1. Redistributions of source code must retain the above copyright
24  *    notice, this list of conditions and the following disclaimer.
25  *
26  * 2. Redistributions in binary form must reproduce the above copyright
27  *    notice, this list of conditions and the following disclaimer in
28  *    the documentation and/or other materials provided with the
29  *    distribution.
30  *
31  * 3. The end-user documentation included with the redistribution,
32  *    if any, must include the following acknowledgment:
33  *       "This product includes software developed by the
34  *        Apache Software Foundation (http://www.apache.org/)."
35  *    Alternately, this acknowledgment may appear in the software itself,
36  *    if and wherever such third-party acknowledgments normally appear.
37  *
38  * 4. The names "Apache" and "Apache Software Foundation" must
39  *    not be used to endorse or promote products derived from this
40  *    software without prior written permission. For written
41  *    permission, please contact apache@apache.org.
42  *
43  * 5. Products derived from this software may not be called "Apache",
44  *    nor may "Apache" appear in their name, without prior written
45  *    permission of the Apache Software Foundation.
46  *
47  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
48  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
49  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
50  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
51  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
52  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
53  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
54  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
55  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
56  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
57  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  * ====================================================================
60  *
61  * This software consists of voluntary contributions made by many
62  * individuals on behalf of the Apache Software Foundation.  For more
63  * information on the Apache Software Foundation, please see
64  * <http://www.apache.org/>.
65  *
66  * Portions of this software are based upon public domain software
67  * originally written at the National Center for Supercomputing Applications,
68  * University of Illinois, Urbana-Champaign.
69  */
70
71 #ident "$Id$"
72
73 #include "config.h"
74
75 #define MODAUTHKERB_VERSION "5.0-rc4"
76
77 #ifndef APXS1
78 #include "ap_compat.h"
79 #include "apr_strings.h"
80 #endif
81 #include "httpd.h"
82 #include "http_config.h"
83 #include "http_core.h"
84 #include "http_log.h"
85 #include "http_protocol.h"
86 #include "http_request.h"
87
88 #ifdef KRB5
89 #include <krb5.h>
90 #ifdef HEIMDAL
91 #  include <gssapi.h>
92 #else
93 #  include <gssapi/gssapi.h>
94 #  include <gssapi/gssapi_generic.h>
95 #  define GSS_C_NT_USER_NAME gss_nt_user_name
96 #  define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
97 #  define krb5_get_err_text(context,code) error_message(code)
98 #endif
99 #include "spnegokrb5.h"
100 #endif /* KRB5 */
101
102 #ifdef KRB4
103 /*Prevent warning about closesocket redefinition (Apache's ap_config.h and 
104  * MIT Kerberos' port-sockets.h both define it as close) */
105 #ifdef closesocket
106 #  undef closesocket
107 #endif
108 #include <krb.h>
109 #include <netdb.h> /* gethostbyname() */
110 #endif /* KRB4 */
111
112 #ifdef APXS1
113 module auth_kerb_module;
114 #else
115 module AP_MODULE_DECLARE_DATA auth_kerb_module;
116 #endif
117
118 /*************************************************************************** 
119  Macros To Ease Compatibility
120  ***************************************************************************/
121 #ifdef APXS1
122 #define MK_POOL pool
123 #define MK_TABLE_GET ap_table_get
124 #define MK_USER r->connection->user
125 #define MK_AUTH_TYPE r->connection->ap_auth_type
126 #define PROXYREQ_PROXY STD_PROXY
127 #else
128 #define MK_POOL apr_pool_t
129 #define MK_TABLE_GET apr_table_get
130 #define MK_USER r->user
131 #define MK_AUTH_TYPE r->ap_auth_type
132 #endif /* APXS1 */
133
134
135 /*************************************************************************** 
136  Auth Configuration Structure
137  ***************************************************************************/
138 typedef struct {
139         char *krb_auth_realms;
140         int krb_save_credentials;
141         int krb_verify_kdc;
142         char *krb_service_name;
143         int krb_authoritative;
144 #ifdef KRB5
145         char *krb_5_keytab;
146         int krb_method_gssapi;
147         int krb_method_k5pass;
148 #endif
149 #ifdef KRB4
150         char *krb_4_srvtab;
151         int krb_method_k4pass;
152 #endif
153 } kerb_auth_config;
154
155 static const char*
156 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg);
157
158 #ifdef APXS1
159 #define command(name, func, var, type, usage)           \
160   { name, func,                                         \
161     (void*)XtOffsetOf(kerb_auth_config, var),           \
162     OR_AUTHCFG, type, usage }
163 #else
164 #define command(name, func, var, type, usage)           \
165   AP_INIT_ ## type (name, func,                         \
166         (void*)APR_XtOffsetOf(kerb_auth_config, var),   \
167         OR_AUTHCFG, usage)
168 #endif
169
170 static const command_rec kerb_auth_cmds[] = {
171    command("KrbAuthRealms", krb5_save_realms, krb_auth_realms,
172      RAW_ARGS, "Realms to attempt authentication against (can be multiple)."),
173
174    command("KrbAuthRealm", krb5_save_realms, krb_auth_realms,
175      RAW_ARGS, "Alias for KrbAuthRealms."),
176
177    command("KrbSaveCredentials", ap_set_flag_slot, krb_save_credentials,
178      FLAG, "Save and store credentials/tickets retrieved during auth."),
179
180    command("KrbVerifyKDC", ap_set_flag_slot, krb_verify_kdc,
181      FLAG, "Verify tickets against keytab to prevent KDC spoofing attacks."),
182
183    command("KrbServiceName", ap_set_string_slot, krb_service_name,
184      TAKE1, "Service name to be used by Apache for authentication."),
185
186    command("KrbAuthoritative", ap_set_flag_slot, krb_authoritative,
187      FLAG, "Set to 'off' to allow access control to be passed along to lower modules if the UserID is not known to this module."),
188
189 #ifdef KRB5
190    command("Krb5Keytab", ap_set_file_slot, krb_5_keytab,
191      TAKE1, "Location of Kerberos V5 keytab file."),
192
193    command("KrbMethodNegotiate", ap_set_flag_slot, krb_method_gssapi,
194      FLAG, "Enable Negotiate authentication method."),
195
196    command("KrbMethodK5Passwd", ap_set_flag_slot, krb_method_k5pass,
197      FLAG, "Enable Kerberos V5 password authentication."),
198 #endif 
199
200 #ifdef KRB4
201    command("Krb4Srvtab", ap_set_file_slot, krb_4_srvtab,
202      TAKE1, "Location of Kerberos V4 srvtab file."),
203
204    command("KrbMethodK4Passwd", ap_set_flag_slot, krb_method_k4pass,
205      FLAG, "Enable Kerberos V4 password authentication."),
206 #endif
207
208    { NULL }
209 };
210
211 #ifdef KRB5
212 typedef struct {
213    gss_ctx_id_t context;
214    gss_cred_id_t server_creds;
215 } gss_connection_t;
216
217 static gss_connection_t *gss_connection = NULL;
218
219 static const char *EMPTY_STRING = "\0";
220 #endif
221
222
223 /*************************************************************************** 
224  Auth Configuration Initialization
225  ***************************************************************************/
226 static void *kerb_dir_create_config(MK_POOL *p, char *d)
227 {
228         kerb_auth_config *rec;
229
230         rec = (kerb_auth_config *) ap_pcalloc(p, sizeof(kerb_auth_config));
231         ((kerb_auth_config *)rec)->krb_verify_kdc = 1;
232         ((kerb_auth_config *)rec)->krb_service_name = "HTTP";
233         ((kerb_auth_config *)rec)->krb_authoritative = 1;
234 #ifdef KRB5
235         ((kerb_auth_config *)rec)->krb_method_k5pass = 1;
236         ((kerb_auth_config *)rec)->krb_method_gssapi = 1;
237 #endif
238 #ifdef KRB4
239         ((kerb_auth_config *)rec)->krb_method_k4pass = 1;
240 #endif
241         return rec;
242 }
243
244 static const char*
245 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg)
246 {
247    sec->krb_auth_realms= ap_pstrdup(cmd->pool, arg);
248    return NULL;
249 }
250
251 void log_rerror(const char *file, int line, int level, int status,
252                 const request_rec *r, const char *fmt, ...)
253 {
254    char errstr[1024];
255    va_list ap;
256
257    va_start(ap, fmt);
258    vsnprintf(errstr, sizeof(errstr), fmt, ap);
259    va_end(ap);
260
261    
262 #ifdef APXS1
263    ap_log_rerror(file, line, level | APLOG_NOERRNO, r, "%s", errstr);
264 #else
265    ap_log_rerror(file, line, level | APLOG_NOERRNO, status, r, "%s", errstr);
266 #endif
267 }
268
269 #ifdef KRB4
270 /*************************************************************************** 
271  Username/Password Validation for Krb4
272  ***************************************************************************/
273 static int
274 verify_krb4_user(request_rec *r, char *name, char *instance, char *realm,
275                  char *password, char *linstance, char *srvtab, int krb_verify_kdc)
276 {
277    int ret;
278    char *phost;
279    unsigned long addr;
280    struct hostent *hp;
281    const char *hostname;
282    KTEXT_ST ticket;
283    AUTH_DAT authdata;
284    char lrealm[REALM_SZ];
285
286    ret = krb_get_pw_in_tkt(name, instance, realm, "krbtgt", realm, 
287                            DEFAULT_TKT_LIFE, password);
288    if (ret) {
289       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
290                  "Cannot get krb4 ticket: krb_get_pw_in_tkt() failed: %s",
291                  krb_get_err_text(ret));
292       return ret;
293    }
294
295    if (!krb_verify_kdc)
296       return ret;
297
298    hostname = ap_get_server_name(r);
299
300    hp = gethostbyname(hostname);
301    if (hp == NULL) {
302       dest_tkt();
303       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
304                  "Cannot verify krb4 ticket: gethostbyname() failed: %s",
305                  hstrerror(h_errno));
306       return h_errno;
307    }
308    memcpy(&addr, hp->h_addr, sizeof(addr));
309
310    phost = krb_get_phost((char *)hostname);
311
312    krb_get_lrealm(lrealm, 1);
313
314    ret = krb_mk_req(&ticket, linstance, phost, lrealm, 0);
315    if (ret) {
316       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
317                  "Cannot verify krb4 ticket: krb_mk_req() failed: %s",
318                  krb_get_err_text(ret));
319       dest_tkt();
320       return ret;
321    }
322
323    ret = krb_rd_req(&ticket, linstance, phost, addr, &authdata, srvtab);
324    if (ret) {
325       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
326                  "Cannot verify krb4 ticket: krb_rd_req() failed: %s",
327                  krb_get_err_text(ret));
328       dest_tkt();
329    }
330
331    return ret;
332 }
333
334 static int
335 krb4_cache_cleanup(void *data)
336 {
337    char *tkt_file = (char *) data;
338    
339    krb_set_tkt_string(tkt_file);
340    dest_tkt();
341    return OK;
342 }
343
344 static int 
345 authenticate_user_krb4pwd(request_rec *r,
346                           kerb_auth_config *conf,
347                           const char *auth_line)
348 {
349    int ret;
350    const char *sent_pw;
351    const char *sent_name;
352    char *sent_instance;
353    char tkt_file[32];
354    char *tkt_file_p = NULL;
355    int fd;
356    const char *realms;
357    const char *realm;
358    char *user;
359    char lrealm[REALM_SZ];
360    int all_principals_unkown;
361
362    sent_pw = ap_pbase64decode(r->pool, auth_line);
363    sent_name = ap_getword (r->pool, &sent_pw, ':');
364
365    /* do not allow user to override realm setting of server */
366    if (strchr(sent_name, '@')) {
367       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
368                  "specifying realm in user name is prohibited");
369       return HTTP_UNAUTHORIZED;
370    }
371
372    sent_instance = strchr(sent_name, '.');
373    if (sent_instance)
374       *sent_instance++ = '\0'; 
375
376    snprintf(tkt_file, sizeof(tkt_file), "/tmp/apache_tkt_XXXXXX");
377    fd = mkstemp(tkt_file);
378    if (fd < 0) {
379       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
380                  "Cannot create krb4 ccache: mkstemp() failed: %s",
381                  strerror(errno));
382       return HTTP_INTERNAL_SERVER_ERROR;
383    }
384
385    tkt_file_p = ap_pstrdup(r->pool, tkt_file);
386    ap_register_cleanup(r->pool, tkt_file_p,
387                        krb4_cache_cleanup, ap_null_cleanup);
388
389    krb_set_tkt_string(tkt_file);
390
391    all_principals_unkown = 1;
392    realms = conf->krb_auth_realms;
393    do {
394       memset(lrealm, 0, sizeof(lrealm));
395       realm = NULL;
396       if (realms)
397          realm = ap_getword_white(r->pool, &realms);
398
399       if (realm == NULL) {
400          ret = krb_get_lrealm(lrealm, 1);
401          if (ret)
402             break;
403          realm = lrealm;
404       }
405
406       ret = verify_krb4_user(r, (char *)sent_name, 
407                              (sent_instance) ? sent_instance : "",
408                              (char *)realm, (char *)sent_pw,
409                              conf->krb_service_name,
410                              conf->krb_4_srvtab, conf->krb_verify_kdc);
411       if (!conf->krb_authoritative && ret) {
412          /* if we're not authoritative, we allow authentication to pass on
413           * to another modules if (and only if) the user is not known to us */
414          if (all_principals_unkown && ret != KDC_PR_UNKNOWN)
415             all_principals_unkown = 0;
416       }
417
418       if (ret == 0)
419          break;
420    } while (realms && *realms);
421
422    if (ret) {
423       /* XXX log only in the verify_krb4_user() call */
424       log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Verifying krb4 password failed");
425       ret = (!conf->krb_authoritative && all_principals_unkown == 1 && ret == KDC_PR_UNKNOWN) ?
426                  DECLINED : HTTP_UNAUTHORIZED;
427       goto end;
428    }
429
430    user = ap_pstrdup(r->pool, sent_name);
431    if (sent_instance)
432       user = ap_pstrcat(r->pool, user, ".", sent_instance, NULL);
433    user = ap_pstrcat(r->pool, user, "@", realm, NULL);
434
435    MK_USER = user;
436    MK_AUTH_TYPE = "Basic";
437    ap_table_setn(r->subprocess_env, "KRBTKFILE", tkt_file_p);
438
439    if (!conf->krb_save_credentials)
440       krb4_cache_cleanup(tkt_file);
441
442 end:
443    if (ret)
444       krb4_cache_cleanup(tkt_file);
445    close(fd);
446    tf_close();
447
448    return ret;
449 }
450 #endif /* KRB4 */
451
452 #ifdef KRB5
453 /*************************************************************************** 
454  Username/Password Validation for Krb5
455  ***************************************************************************/
456 /* Inspired by krb5_verify_user from Heimdal */
457 static krb5_error_code
458 verify_krb5_user(request_rec *r, krb5_context context, krb5_principal principal,
459                  krb5_ccache ccache, const char *password, const char *service,
460                  krb5_keytab keytab, int krb_verify_kdc)
461 {
462    krb5_creds creds;
463    krb5_principal server = NULL;
464    krb5_error_code ret;
465    krb5_verify_init_creds_opt opt;
466
467    memset(&creds, 0, sizeof(creds));
468
469    ret = krb5_get_init_creds_password(context, &creds, principal, 
470                                       (char *)password, krb5_prompter_posix,
471                                       NULL, 0, NULL, NULL);
472    if (ret)
473       return ret;
474
475    ret = krb5_sname_to_principal(context, ap_get_server_name(r), service, 
476                                  KRB5_NT_SRV_HST, &server);
477    if (ret)
478       goto end;
479
480    krb5_verify_init_creds_opt_init(&opt);
481    krb5_verify_init_creds_opt_set_ap_req_nofail(&opt, krb_verify_kdc);
482
483    ret = krb5_verify_init_creds(context, &creds, server, keytab, NULL, &opt);
484    if (ret)
485       goto end;
486
487    if (ccache) {
488       ret = krb5_cc_initialize(context, ccache, principal);
489       if (ret == 0)
490          ret = krb5_cc_store_cred(context, ccache, &creds);
491    }
492
493 end:
494    krb5_free_cred_contents(context, &creds);
495    if (server)
496       krb5_free_principal(context, server);
497    return ret;
498 }
499
500 static int
501 krb5_cache_cleanup(void *data)
502 {
503    krb5_context context;
504    krb5_ccache  cache;
505    krb5_error_code problem;
506    char *cache_name = (char *) data;
507
508    problem = krb5_init_context(&context);
509    if (problem) {
510       /* ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL, "krb5_init_context() failed"); */
511       return HTTP_INTERNAL_SERVER_ERROR;
512    }
513
514    problem = krb5_cc_resolve(context, cache_name, &cache);
515    if (problem) {
516       /* log_error(APLOG_MARK, APLOG_ERR, 0, NULL, 
517                 "krb5_cc_resolve() failed (%s: %s)",
518                 cache_name, krb5_get_err_text(context, problem)); */
519       return HTTP_INTERNAL_SERVER_ERROR;
520    }
521
522    krb5_cc_destroy(context, cache);
523    krb5_free_context(context);
524    return OK;
525 }
526
527 static int
528 create_krb5_ccache(krb5_context kcontext,
529                    request_rec *r,
530                    kerb_auth_config *conf,
531                    krb5_principal princ,
532                    krb5_ccache *ccache)
533 {
534    char *ccname;
535    int fd;
536    krb5_error_code problem;
537    int ret;
538    krb5_ccache tmp_ccache = NULL;
539
540    ccname = ap_psprintf(r->pool, "FILE:%s/krb5cc_apache_XXXXXX", P_tmpdir);
541    fd = mkstemp(ccname + strlen("FILE:"));
542    if (fd < 0) {
543       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
544                  "mkstemp() failed: %s", strerror(errno));
545       ret = HTTP_INTERNAL_SERVER_ERROR;
546       goto end;
547    }
548    close(fd);
549
550    problem = krb5_cc_resolve(kcontext, ccname, &tmp_ccache);
551    if (problem) {
552       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
553                  "krb5_cc_resolve() failed: %s",
554                  krb5_get_err_text(kcontext, problem));
555       ret = HTTP_INTERNAL_SERVER_ERROR;
556       unlink(ccname);
557       goto end;
558    }
559
560    problem = krb5_cc_initialize(kcontext, tmp_ccache, princ);
561    if (problem) {
562       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
563                  "Cannot initialize krb5 ccache %s: krb5_cc_initialize() failed: %s",
564                  ccname, krb5_get_err_text(kcontext, problem));
565       ret = HTTP_INTERNAL_SERVER_ERROR;
566       goto end;
567    }
568
569    ap_table_setn(r->subprocess_env, "KRB5CCNAME", ccname);
570    ap_register_cleanup(r->pool, ccname,
571                        krb5_cache_cleanup, ap_null_cleanup);
572
573    *ccache = tmp_ccache;
574    tmp_ccache = NULL;
575
576    ret = OK;
577
578 end:
579    if (tmp_ccache)
580       krb5_cc_destroy(kcontext, tmp_ccache);
581
582    return ret;
583 }
584
585 static int
586 store_krb5_creds(krb5_context kcontext,
587                  request_rec *r,
588                  kerb_auth_config *conf,
589                  krb5_ccache delegated_cred)
590 {
591    char errstr[1024];
592    krb5_error_code problem;
593    krb5_principal princ;
594    krb5_ccache ccache;
595    int ret;
596
597    problem = krb5_cc_get_principal(kcontext, delegated_cred, &princ);
598    if (problem) {
599       snprintf(errstr, sizeof(errstr), "krb5_cc_get_principal() failed: %s",
600                krb5_get_err_text(kcontext, problem));
601       return HTTP_INTERNAL_SERVER_ERROR;
602    }
603
604    ret = create_krb5_ccache(kcontext, r, conf, princ, &ccache);
605    if (ret) {
606       krb5_free_principal(kcontext, princ);
607       return ret;
608    }
609
610 #ifdef HEIMDAL
611    problem = krb5_cc_copy_cache(kcontext, delegated_cred, ccache);
612 #else
613    problem = krb5_cc_copy_creds(kcontext, delegated_cred, ccache);
614 #endif
615    krb5_free_principal(kcontext, princ);
616    if (problem) {
617       snprintf(errstr, sizeof(errstr), "Failed to store credentials: %s",
618                krb5_get_err_text(kcontext, problem));
619       krb5_cc_destroy(kcontext, ccache);
620       return HTTP_INTERNAL_SERVER_ERROR;
621    }
622
623    krb5_cc_close(kcontext, ccache);
624    return OK;
625 }
626
627
628 int authenticate_user_krb5pwd(request_rec *r,
629                               kerb_auth_config *conf,
630                               const char *auth_line)
631 {
632    const char      *sent_pw = NULL; 
633    const char      *sent_name = NULL;
634    const char      *realms = NULL;
635    krb5_context    kcontext = NULL;
636    krb5_error_code code;
637    krb5_principal  client = NULL;
638    krb5_ccache     ccache = NULL;
639    krb5_keytab     keytab = NULL;
640    int             ret;
641    char            *name = NULL;
642    int             all_principals_unkown;
643    char            *ccname = NULL;
644    int             fd;
645
646    code = krb5_init_context(&kcontext);
647    if (code) {
648       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
649                  "Cannot initialize Kerberos5 context (%d)", code);
650       return HTTP_INTERNAL_SERVER_ERROR;
651    }
652
653    sent_pw = ap_pbase64decode(r->pool, auth_line);
654    sent_name = ap_getword (r->pool, &sent_pw, ':');
655    /* do not allow user to override realm setting of server */
656    if (strchr(sent_name, '@')) {
657       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
658                  "specifying realm in user name is prohibited");
659       ret = HTTP_UNAUTHORIZED;
660       goto end;
661    }
662
663    if (sent_pw == NULL || *sent_pw == '\0') {
664       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
665                  "empty passwords are not accepted");
666       ret = HTTP_UNAUTHORIZED;
667       goto end;
668    }
669
670 #ifdef HEIMDAL
671    code = krb5_cc_gen_new(kcontext, &krb5_mcc_ops, &ccache);
672 #else
673    code = krb5_cc_resolve(kcontext, "MEMORY:", &ccache);
674 #endif
675    if (code) {
676       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
677                  "generating new memory ccache failed: %s",
678                  krb5_get_err_text(kcontext, code));
679       ret = HTTP_INTERNAL_SERVER_ERROR;
680       unlink(ccname);
681       goto end;
682    }
683
684    if (conf->krb_5_keytab)
685       krb5_kt_resolve(kcontext, conf->krb_5_keytab, &keytab);
686
687    all_principals_unkown = 1;
688    realms = conf->krb_auth_realms;
689    do {
690       if (realms && (code = krb5_set_default_realm(kcontext,
691                                            ap_getword_white(r->pool, &realms))))
692          continue;
693
694       if (client) {
695          krb5_free_principal(kcontext, client);
696          client = NULL;
697       }
698       code = krb5_parse_name(kcontext, sent_name, &client);
699       if (code)
700          continue;
701
702       code = verify_krb5_user(r, kcontext, client, ccache, sent_pw, 
703                               conf->krb_service_name, 
704                               keytab, conf->krb_verify_kdc);
705       if (!conf->krb_authoritative && code) {
706          /* if we're not authoritative, we allow authentication to pass on
707           * to another modules if (and only if) the user is not known to us */
708          if (all_principals_unkown && code != KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
709             all_principals_unkown = 0;
710       }
711
712       if (code == 0)
713          break;
714
715       /* ap_getword_white() used above shifts the parameter, so it's not
716          needed to touch the realms variable */
717    } while (realms && *realms);
718
719    memset((char *)sent_pw, 0, strlen(sent_pw));
720
721    if (code) {
722       /* XXX log only in the verify_krb5_user() call */
723       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
724                  "Verifying krb5 password failed: %s",
725                  krb5_get_err_text(kcontext, code));
726       if (!conf->krb_authoritative && all_principals_unkown == 1 && code == KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
727          ret = DECLINED;
728       else
729          ret = HTTP_UNAUTHORIZED;
730
731       goto end;
732    }
733
734    code = krb5_unparse_name(kcontext, client, &name);
735    if (code) {
736       log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "krb5_unparse_name() failed: %s",
737                  krb5_get_err_text(kcontext, code));
738       ret = HTTP_UNAUTHORIZED;
739       goto end;
740    }
741    MK_USER = ap_pstrdup (r->pool, name);
742    MK_AUTH_TYPE = "Basic";
743    free(name);
744
745    if (conf->krb_save_credentials)
746       store_krb5_creds(kcontext, r, conf, ccache);
747
748    ret = OK;
749
750 end:
751    if (client)
752       krb5_free_principal(kcontext, client);
753    if (ccache)
754       krb5_cc_destroy(kcontext, ccache);
755    if (keytab)
756       krb5_kt_close(kcontext, keytab);
757    krb5_free_context(kcontext);
758
759    return ret;
760 }
761
762 /*********************************************************************
763  * GSSAPI Authentication
764  ********************************************************************/
765
766 static const char *
767 get_gss_error(MK_POOL *p, OM_uint32 err_maj, OM_uint32 err_min, char *prefix)
768 {
769    OM_uint32 maj_stat, min_stat; 
770    OM_uint32 msg_ctx = 0;
771    gss_buffer_desc status_string;
772    char *err_msg;
773    size_t len;
774
775    err_msg = ap_pstrdup(p, prefix);
776    do {
777       maj_stat = gss_display_status (&min_stat,
778                                      err_maj,
779                                      GSS_C_GSS_CODE,
780                                      GSS_C_NO_OID,
781                                      &msg_ctx,
782                                      &status_string);
783       if (GSS_ERROR(maj_stat))
784          break;
785       err_msg = ap_pstrcat(p, err_msg, ": ", (char*) status_string.value, NULL);
786       gss_release_buffer(&min_stat, &status_string);
787       
788       maj_stat = gss_display_status (&min_stat,
789                                      err_min,
790                                      GSS_C_MECH_CODE,
791                                      GSS_C_NULL_OID,
792                                      &msg_ctx,
793                                      &status_string);
794       if (!GSS_ERROR(maj_stat)) {
795          err_msg = ap_pstrcat(p, err_msg,
796                               " (", (char*) status_string.value, ")", NULL);
797          gss_release_buffer(&min_stat, &status_string);
798       }
799    } while (!GSS_ERROR(maj_stat) && msg_ctx != 0);
800
801    return err_msg;
802 }
803
804 static int
805 cleanup_gss_connection(void *data)
806 {
807    OM_uint32 minor_status;
808    gss_connection_t *gss_conn = (gss_connection_t *)data;
809
810    if (data == NULL)
811       return OK;
812    if (gss_conn->context != GSS_C_NO_CONTEXT)
813       gss_delete_sec_context(&minor_status, &gss_conn->context,
814                              GSS_C_NO_BUFFER);
815    if (gss_conn->server_creds != GSS_C_NO_CREDENTIAL)
816       gss_release_cred(&minor_status, &gss_conn->server_creds);
817
818    gss_connection = NULL;
819
820    return OK;
821 }
822
823 static int
824 store_gss_creds(request_rec *r, kerb_auth_config *conf, char *princ_name,
825                 gss_cred_id_t delegated_cred)
826 {
827    OM_uint32 maj_stat, min_stat;
828    krb5_principal princ = NULL;
829    krb5_ccache ccache = NULL;
830    krb5_error_code problem;
831    krb5_context context;
832    int ret = HTTP_INTERNAL_SERVER_ERROR;
833
834    problem = krb5_init_context(&context);
835    if (problem) {
836       log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Cannot initialize krb5 context");
837       return HTTP_INTERNAL_SERVER_ERROR;
838    }
839
840    problem = krb5_parse_name(context, princ_name, &princ);
841    if (problem) {
842       log_rerror(APLOG_MARK, APLOG_ERR, 0, r, 
843          "Cannot parse delegated username (%s)", krb5_get_err_text(context, problem));
844       goto end;
845    }
846
847    problem = create_krb5_ccache(context, r, conf, princ, &ccache);
848    if (problem) {
849       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
850          "Cannot create krb5 ccache (%s)", krb5_get_err_text(context, problem));
851       goto end;
852    }
853
854    maj_stat = gss_krb5_copy_ccache(&min_stat, delegated_cred, ccache);
855    if (GSS_ERROR(maj_stat)) {
856       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
857          "Cannot store delegated credential (%s)", 
858          get_gss_error(r->pool, maj_stat, min_stat, "gss_krb5_copy_ccache"));
859       goto end;
860    }
861
862    krb5_cc_close(context, ccache);
863    ccache = NULL;
864    ret = 0;
865
866 end:
867    if (princ)
868       krb5_free_principal(context, princ);
869    if (ccache)
870       krb5_cc_destroy(context, ccache);
871    krb5_free_context(context);
872    return ret;
873 }
874
875 static int
876 get_gss_creds(request_rec *r,
877               kerb_auth_config *conf,
878               gss_cred_id_t *server_creds)
879 {
880    gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
881    OM_uint32 major_status, minor_status, minor_status2;
882    gss_name_t server_name = GSS_C_NO_NAME;
883    char buf[1024];
884
885 #if 0
886    /* Don't specify service name. This makes MIT 1.3 not to use replay caches,
887     * which causes large problems with the Microsoft krb5 implementation. MS
888     * obviously uses a format of the krb5 authenticator that is considered by
889     * the MIT as replay (Two valid MS authenticators may contain the same time
890     * and utime fields and only differ in the sequential numbers).
891     */
892    snprintf(buf, sizeof(buf), "%s/%s", conf->krb_service_name,
893          ap_get_server_name(r));
894
895    input_token.value = buf;
896    input_token.length = strlen(buf) + 1;
897
898    major_status = gss_import_name(&minor_status, &input_token,
899                                   GSS_C_NT_USER_NAME,
900                                   &server_name);
901    if (GSS_ERROR(major_status)) {
902       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
903                  "%s", get_gss_error(r->pool, major_status, minor_status,
904                  "gss_import_name() failed"));
905       return HTTP_INTERNAL_SERVER_ERROR;
906    }
907 #endif
908    
909    major_status = gss_acquire_cred(&minor_status, server_name, GSS_C_INDEFINITE,
910                                    GSS_C_NO_OID_SET, GSS_C_ACCEPT,
911                                    server_creds, NULL, NULL);
912    gss_release_name(&minor_status2, &server_name);
913    if (GSS_ERROR(major_status)) {
914       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
915                  "%s", get_gss_error(r->pool, major_status, minor_status,
916                                      "gss_acquire_cred() failed"));
917       return HTTP_INTERNAL_SERVER_ERROR;
918    }
919    
920    return 0;
921 }
922
923 static int
924 cmp_gss_type(gss_buffer_t token, gss_OID oid)
925 {
926    unsigned char *p;
927    size_t len;
928
929    if (token->length == 0)
930       return GSS_S_DEFECTIVE_TOKEN;
931
932    p = token->value;
933    if (*p++ != 0x60)
934       return GSS_S_DEFECTIVE_TOKEN;
935    len = *p++;
936    if (len & 0x80) {
937       if ((len & 0x7f) > 4)
938          return GSS_S_DEFECTIVE_TOKEN;
939       p += len & 0x7f;
940    }
941    if (*p++ != 0x06)
942       return GSS_S_DEFECTIVE_TOKEN;
943
944    if (((OM_uint32) *p++) != oid->length)
945       return GSS_S_DEFECTIVE_TOKEN;
946
947    return memcmp(p, oid->elements, oid->length);
948 }
949
950 static int
951 authenticate_user_gss(request_rec *r, kerb_auth_config *conf,
952                       const char *auth_line, char **negotiate_ret_value)
953 {
954   OM_uint32 major_status, minor_status, minor_status2;
955   gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
956   gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
957   const char *auth_param = NULL;
958   int ret;
959   gss_name_t client_name = GSS_C_NO_NAME;
960   gss_cred_id_t delegated_cred = GSS_C_NO_CREDENTIAL;
961   OM_uint32 (*accept_sec_token)();
962   gss_OID_desc spnego_oid;
963
964   *negotiate_ret_value = (char *)EMPTY_STRING;
965
966   spnego_oid.length = 6;
967   spnego_oid.elements = (void *)"\x2b\x06\x01\x05\x05\x02";
968
969   if (gss_connection == NULL) {
970      gss_connection = ap_pcalloc(r->connection->pool, sizeof(*gss_connection));
971      if (gss_connection == NULL) {
972         log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
973                    "ap_pcalloc() failed (not enough memory)");
974         ret = HTTP_INTERNAL_SERVER_ERROR;
975         goto end;
976      }
977      memset(gss_connection, 0, sizeof(*gss_connection));
978      ap_register_cleanup(r->connection->pool, gss_connection, cleanup_gss_connection, ap_null_cleanup);
979   }
980
981   if (conf->krb_5_keytab) {
982      char *ktname;
983      /* we don't use the ap_* calls here, since the string passed to putenv()
984       * will become part of the enviroment and shouldn't be free()ed by apache
985       */
986      ktname = malloc(strlen("KRB5_KTNAME=") + strlen(conf->krb_5_keytab) + 1);
987      if (ktname == NULL) {
988         log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "malloc() failed: not enough memory");
989         ret = HTTP_INTERNAL_SERVER_ERROR;
990         goto end;
991      }
992      sprintf(ktname, "KRB5_KTNAME=%s", conf->krb_5_keytab);
993      putenv(ktname);
994   }
995
996   if (gss_connection->server_creds == GSS_C_NO_CREDENTIAL) {
997      ret = get_gss_creds(r, conf, &gss_connection->server_creds);
998      if (ret)
999         goto end;
1000   }
1001
1002   /* ap_getword() shifts parameter */
1003   auth_param = ap_getword_white(r->pool, &auth_line);
1004   if (auth_param == NULL) {
1005      log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1006                 "No Authorization parameter in request from client");
1007      ret = HTTP_UNAUTHORIZED;
1008      goto end;
1009   }
1010
1011   input_token.length = ap_base64decode_len(auth_param) + 1;
1012   input_token.value = ap_pcalloc(r->connection->pool, input_token.length);
1013   if (input_token.value == NULL) {
1014      log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1015                 "ap_pcalloc() failed (not enough memory)");
1016      ret = HTTP_INTERNAL_SERVER_ERROR;
1017      goto end;
1018   }
1019   input_token.length = ap_base64decode(input_token.value, auth_param);
1020
1021   accept_sec_token = (cmp_gss_type(&input_token, &spnego_oid) == 0) ?
1022                         gss_accept_sec_context_spnego : gss_accept_sec_context;
1023
1024   major_status = accept_sec_token(&minor_status,
1025                                   &gss_connection->context,
1026                                   gss_connection->server_creds,
1027                                   &input_token,
1028                                   GSS_C_NO_CHANNEL_BINDINGS,
1029                                   &client_name,
1030                                   NULL,
1031                                   &output_token,
1032                                   NULL,
1033                                   NULL,
1034                                   &delegated_cred);
1035   if (output_token.length) {
1036      char *token = NULL;
1037      size_t len;
1038      
1039      len = ap_base64encode_len(output_token.length) + 1;
1040      token = ap_pcalloc(r->connection->pool, len + 1);
1041      if (token == NULL) {
1042         log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1043                    "ap_pcalloc() failed (not enough memory)");
1044         ret = HTTP_INTERNAL_SERVER_ERROR;
1045         gss_release_buffer(&minor_status2, &output_token);
1046         goto end;
1047      }
1048      ap_base64encode(token, output_token.value, output_token.length);
1049      token[len] = '\0';
1050      *negotiate_ret_value = token;
1051      gss_release_buffer(&minor_status2, &output_token);
1052   }
1053
1054   if (GSS_ERROR(major_status)) {
1055      log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1056                 "%s", get_gss_error(r->pool, major_status, minor_status,
1057                                     "gss_accept_sec_context() failed"));
1058      /* Don't offer the Negotiate method again if call to GSS layer failed */
1059      *negotiate_ret_value = NULL;
1060      ret = HTTP_UNAUTHORIZED;
1061      goto end;
1062   }
1063
1064   if (major_status & GSS_S_CONTINUE_NEEDED) {
1065      /* Some GSSAPI mechanism (eg GSI from Globus) may require multiple 
1066       * iterations to establish authentication */
1067      ret = HTTP_UNAUTHORIZED;
1068      goto end;
1069   }
1070
1071   major_status = gss_display_name(&minor_status, client_name, &output_token, NULL);
1072   gss_release_name(&minor_status, &client_name); 
1073   if (GSS_ERROR(major_status)) {
1074     log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1075                "%s", get_gss_error(r->pool, major_status, minor_status,
1076                                    "gss_export_name() failed"));
1077     ret = HTTP_INTERNAL_SERVER_ERROR;
1078     goto end;
1079   }
1080
1081   MK_AUTH_TYPE = "Negotiate";
1082   MK_USER = ap_pstrdup(r->pool, output_token.value);
1083
1084   if (conf->krb_save_credentials && delegated_cred != GSS_C_NO_CREDENTIAL)
1085      store_gss_creds(r, conf, (char *)output_token.value, delegated_cred);
1086
1087   gss_release_buffer(&minor_status, &output_token);
1088
1089   ret = OK;
1090
1091 end:
1092   if (delegated_cred)
1093      gss_release_cred(&minor_status, &delegated_cred);
1094
1095   if (output_token.length) 
1096      gss_release_buffer(&minor_status, &output_token);
1097
1098   if (client_name != GSS_C_NO_NAME)
1099      gss_release_name(&minor_status, &client_name);
1100
1101   cleanup_gss_connection(gss_connection);
1102
1103   return ret;
1104 }
1105 #endif /* KRB5 */
1106
1107 static int
1108 already_succeeded(request_rec *r)
1109 {
1110    if (ap_is_initial_req(r) || MK_AUTH_TYPE == NULL)
1111       return 0;
1112    if (strcmp(MK_AUTH_TYPE, "Negotiate") ||
1113        (strcmp(MK_AUTH_TYPE, "Basic") && strchr(MK_USER, '@')))
1114       return 1;
1115    return 0;
1116 }
1117
1118 static void
1119 note_kerb_auth_failure(request_rec *r, const kerb_auth_config *conf,
1120                        int use_krb4, int use_krb5, char *negotiate_ret_value)
1121 {
1122    const char *auth_name = NULL;
1123    int set_basic = 0;
1124    char *negoauth_param;
1125    const char *header_name = 
1126       (r->proxyreq == PROXYREQ_PROXY) ? "Proxy-Authenticate" : "WWW-Authenticate";
1127
1128    /* get the user realm specified in .htaccess */
1129    auth_name = ap_auth_name(r);
1130
1131    /* XXX should the WWW-Authenticate header be cleared first? */
1132 #ifdef KRB5
1133    if (use_krb5 && conf->krb_method_gssapi && negotiate_ret_value != NULL) {
1134       negoauth_param = (*negotiate_ret_value == '\0') ? "Negotiate" :
1135                   ap_pstrcat(r->pool, "Negotiate ", negotiate_ret_value, NULL);
1136       ap_table_add(r->err_headers_out, header_name, negoauth_param);
1137    }
1138    if (use_krb5 && conf->krb_method_k5pass) {
1139       ap_table_add(r->err_headers_out, header_name,
1140                    ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1141       set_basic = 1;
1142    }
1143 #endif
1144
1145 #ifdef KRB4
1146    if (use_krb4 && conf->krb_method_k4pass && !set_basic)
1147       ap_table_add(r->err_headers_out, header_name,
1148                   ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1149 #endif
1150 }
1151
1152 int kerb_authenticate_user(request_rec *r)
1153 {
1154    kerb_auth_config *conf = 
1155       (kerb_auth_config *) ap_get_module_config(r->per_dir_config,
1156                                                 &auth_kerb_module);
1157    const char *auth_type = NULL;
1158    const char *auth_line = NULL;
1159    const char *type = NULL;
1160    int use_krb5 = 0, use_krb4 = 0;
1161    int ret;
1162    static int last_return = HTTP_UNAUTHORIZED;
1163    char *negotiate_ret_value;
1164
1165    /* get the type specified in .htaccess */
1166    type = ap_auth_type(r);
1167
1168    if (type && strcasecmp(type, "Kerberos") == 0)
1169       use_krb5 = use_krb4 = 1;
1170    else if(type && strcasecmp(type, "KerberosV5") == 0)
1171       use_krb4 = 0;
1172    else if(type && strcasecmp(type, "KerberosV4") == 0)
1173       use_krb5 = 0;
1174    else
1175       return DECLINED;
1176
1177    /* get what the user sent us in the HTTP header */
1178    auth_line = MK_TABLE_GET(r->headers_in, "Authorization");
1179    if (!auth_line) {
1180        auth_line = MK_TABLE_GET(r->headers_in, "Proxy-Authorization");
1181        if (!auth_line) {
1182                note_kerb_auth_failure(r, conf, use_krb4, use_krb5, "\0");
1183                return HTTP_UNAUTHORIZED;
1184        }
1185    }
1186    auth_type = ap_getword_white(r->pool, &auth_line);
1187
1188    if (already_succeeded(r))
1189       return last_return;
1190
1191    ret = HTTP_UNAUTHORIZED;
1192
1193 #ifdef KRB5
1194    if (use_krb5 && conf->krb_method_gssapi &&
1195        strcasecmp(auth_type, "Negotiate") == 0) {
1196       ret = authenticate_user_gss(r, conf, auth_line, &negotiate_ret_value);
1197    } else if (use_krb5 && conf->krb_method_k5pass &&
1198               strcasecmp(auth_type, "Basic") == 0) {
1199        ret = authenticate_user_krb5pwd(r, conf, auth_line);
1200    }
1201 #endif
1202
1203 #ifdef KRB4
1204    if (ret == HTTP_UNAUTHORIZED && use_krb4 && conf->krb_method_k4pass &&
1205        strcasecmp(auth_type, "Basic") == 0)
1206       ret = authenticate_user_krb4pwd(r, conf, auth_line);
1207 #endif
1208
1209    if (ret == HTTP_UNAUTHORIZED)
1210       note_kerb_auth_failure(r, conf, use_krb4, use_krb5, negotiate_ret_value);
1211
1212    last_return = ret;
1213    return ret;
1214 }
1215
1216
1217 /*************************************************************************** 
1218  Module Setup/Configuration
1219  ***************************************************************************/
1220 #ifdef APXS1
1221 module MODULE_VAR_EXPORT auth_kerb_module = {
1222         STANDARD_MODULE_STUFF,
1223         NULL,                           /*      module initializer            */
1224         kerb_dir_create_config,         /*      per-directory config creator  */
1225         NULL,                           /*      per-directory config merger   */
1226         NULL,                           /*      per-server    config creator  */
1227         NULL,                           /*      per-server    config merger   */
1228         kerb_auth_cmds,                 /*      command table                 */
1229         NULL,                           /* [ 9] content handlers              */
1230         NULL,                           /* [ 2] URI-to-filename translation   */
1231         kerb_authenticate_user,         /* [ 5] check/validate user_id        */
1232         NULL,                           /* [ 6] check user_id is valid *here* */
1233         NULL,                           /* [ 4] check access by host address  */
1234         NULL,                           /* [ 7] MIME type checker/setter      */
1235         NULL,                           /* [ 8] fixups                        */
1236         NULL,                           /* [10] logger                        */
1237         NULL,                           /* [ 3] header parser                 */
1238         NULL,                           /*      process initialization        */
1239         NULL,                           /*      process exit/cleanup          */
1240         NULL                            /* [ 1] post read_request handling    */
1241 };
1242 #else
1243 static int
1244 kerb_init_handler(apr_pool_t *p, apr_pool_t *plog,
1245                   apr_pool_t *ptemp, server_rec *s)
1246 {
1247    ap_add_version_component(p, "mod_auth_kerb/" MODAUTHKERB_VERSION);
1248    return OK;
1249 }
1250
1251 void kerb_register_hooks(apr_pool_t *p)
1252 {
1253    ap_hook_post_config(kerb_init_handler, NULL, NULL, APR_HOOK_MIDDLE);
1254    ap_hook_check_user_id(kerb_authenticate_user, NULL, NULL, APR_HOOK_MIDDLE);
1255 }
1256
1257 module AP_MODULE_DECLARE_DATA auth_kerb_module =
1258 {
1259    STANDARD20_MODULE_STUFF,
1260    kerb_dir_create_config,      /* create per-dir    conf structures  */
1261    NULL,                        /* merge  per-dir    conf structures  */
1262    NULL,                        /* create per-server conf structures  */
1263    NULL,                        /* merge  per-server conf structures  */
1264    kerb_auth_cmds,              /* table of configuration directives  */
1265    kerb_register_hooks          /* register hooks                     */
1266 };
1267 #endif