use krb5_cc_resolve() and manualy created temporary files (generated with mkstemp...
[mod_auth_kerb.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-rc3"
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 #else
127 #define MK_POOL apr_pool_t
128 #define MK_TABLE_GET apr_table_get
129 #define MK_USER r->user
130 #define MK_AUTH_TYPE r->ap_auth_type
131 #endif /* APXS1 */
132
133
134 /*************************************************************************** 
135  Auth Configuration Structure
136  ***************************************************************************/
137 typedef struct {
138         char *krb_auth_realms;
139         int krb_save_credentials;
140         int krb_verify_kdc;
141         char *krb_service_name;
142         int krb_authoritative;
143 #ifdef KRB5
144         char *krb_5_keytab;
145         int krb_method_gssapi;
146         int krb_method_k5pass;
147 #endif
148 #ifdef KRB4
149         char *krb_4_srvtab;
150         int krb_method_k4pass;
151 #endif
152 } kerb_auth_config;
153
154 static const char*
155 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg);
156
157 #ifdef APXS1
158 #define command(name, func, var, type, usage)           \
159   { name, func,                                         \
160     (void*)XtOffsetOf(kerb_auth_config, var),           \
161     OR_AUTHCFG, type, usage }
162 #else
163 #define command(name, func, var, type, usage)           \
164   AP_INIT_ ## type (name, func,                         \
165         (void*)APR_XtOffsetOf(kerb_auth_config, var),   \
166         OR_AUTHCFG, usage)
167 #endif
168
169 static const command_rec kerb_auth_cmds[] = {
170    command("KrbAuthRealms", krb5_save_realms, krb_auth_realms,
171      RAW_ARGS, "Realms to attempt authentication against (can be multiple)."),
172
173    command("KrbAuthRealm", krb5_save_realms, krb_auth_realms,
174      RAW_ARGS, "Alias for KrbAuthRealms."),
175
176    command("KrbSaveCredentials", ap_set_flag_slot, krb_save_credentials,
177      FLAG, "Save and store credentials/tickets retrieved during auth."),
178
179    command("KrbVerifyKDC", ap_set_flag_slot, krb_verify_kdc,
180      FLAG, "Verify tickets against keytab to prevent KDC spoofing attacks."),
181
182    command("KrbServiceName", ap_set_string_slot, krb_service_name,
183      TAKE1, "Service name to be used by Apache for authentication."),
184
185    command("KrbAuthoritative", ap_set_flag_slot, krb_authoritative,
186      FLAG, "Set to 'off' to allow access control to be passed along to lower modules if the UserID is not known to this module."),
187
188 #ifdef KRB5
189    command("Krb5Keytab", ap_set_file_slot, krb_5_keytab,
190      TAKE1, "Location of Kerberos V5 keytab file."),
191
192    command("KrbMethodNegotiate", ap_set_flag_slot, krb_method_gssapi,
193      FLAG, "Enable Negotiate authentication method."),
194
195    command("KrbMethodK5Pass", ap_set_flag_slot, krb_method_k5pass,
196      FLAG, "Enable Kerberos V5 password authentication."),
197 #endif 
198
199 #ifdef KRB4
200    command("Krb4Srvtab", ap_set_file_slot, krb_4_srvtab,
201      TAKE1, "Location of Kerberos V4 srvtab file."),
202
203    command("KrbMethodK4Pass", ap_set_flag_slot, krb_method_k4pass,
204      FLAG, "Enable Kerberos V4 password authentication."),
205 #endif
206
207    { NULL }
208 };
209
210 #ifdef KRB5
211 typedef struct {
212    gss_ctx_id_t context;
213    gss_cred_id_t server_creds;
214 } gss_connection_t;
215
216 static gss_connection_t *gss_connection = NULL;
217 #endif
218
219
220 /*************************************************************************** 
221  Auth Configuration Initialization
222  ***************************************************************************/
223 static void *kerb_dir_create_config(MK_POOL *p, char *d)
224 {
225         kerb_auth_config *rec;
226
227         rec = (kerb_auth_config *) ap_pcalloc(p, sizeof(kerb_auth_config));
228         ((kerb_auth_config *)rec)->krb_verify_kdc = 1;
229         ((kerb_auth_config *)rec)->krb_service_name = "khttp";
230         ((kerb_auth_config *)rec)->krb_authoritative = 1;
231 #ifdef KRB5
232         ((kerb_auth_config *)rec)->krb_method_k5pass = 1;
233         ((kerb_auth_config *)rec)->krb_method_gssapi = 1;
234 #endif
235 #ifdef KRB4
236         ((kerb_auth_config *)rec)->krb_method_k4pass = 1;
237 #endif
238         return rec;
239 }
240
241 static const char*
242 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg)
243 {
244    sec->krb_auth_realms= ap_pstrdup(cmd->pool, arg);
245    return NULL;
246 }
247
248 void log_rerror(const char *file, int line, int level, int status,
249                 const request_rec *r, const char *fmt, ...)
250 {
251    char errstr[1024];
252    char errnostr[1024];
253    va_list ap;
254
255    va_start(ap, fmt);
256    vsnprintf(errstr, sizeof(errstr), fmt, ap);
257    va_end(ap);
258
259    errnostr[0] = '\0';
260    if (errno)
261       snprintf(errnostr, sizeof(errnostr), "%s: (%s)", errstr, strerror(errno));
262    else
263       snprintf(errnostr, sizeof(errnostr), "%s", errstr);
264    
265 #ifdef APXS1
266    ap_log_rerror(file, line, level | APLOG_NOERRNO, r, "%s", errnostr);
267 #else
268    ap_log_rerror(file, line, level | APLOG_NOERRNO, status, r, "%s", errnostr);
269 #endif
270 }
271
272 #ifdef KRB4
273 /*************************************************************************** 
274  Username/Password Validation for Krb4
275  ***************************************************************************/
276 static int
277 verify_krb4_user(request_rec *r, char *name, char *instance, char *realm,
278                  char *password, char *linstance, char *srvtab, int krb_verify_kdc)
279 {
280    int ret;
281    char *phost;
282    unsigned long addr;
283    struct hostent *hp;
284    const char *hostname;
285    KTEXT_ST ticket;
286    AUTH_DAT authdata;
287    char lrealm[REALM_SZ];
288
289    ret = krb_get_pw_in_tkt(name, instance, realm, "krbtgt", realm, 
290                            DEFAULT_TKT_LIFE, password);
291    if (ret) {
292       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
293                  "Cannot get krb4 ticket: krb_get_pw_in_tkt() failed: %s",
294                  krb_get_err_text(ret));
295       return ret;
296    }
297
298    if (!krb_verify_kdc)
299       return ret;
300
301    hostname = ap_get_server_name(r);
302
303    hp = gethostbyname(hostname);
304    if (hp == NULL) {
305       dest_tkt();
306       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
307                  "Cannot verify krb4 ticket: gethostbyname() failed: %s",
308                  hstrerror(h_errno));
309       return h_errno;
310    }
311    memcpy(&addr, hp->h_addr, sizeof(addr));
312
313    phost = krb_get_phost((char *)hostname);
314
315    krb_get_lrealm(lrealm, 1);
316
317    ret = krb_mk_req(&ticket, linstance, phost, lrealm, 0);
318    if (ret) {
319       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
320                  "Cannot verify krb4 ticket: krb_mk_req() failed: %s",
321                  krb_get_err_text(ret));
322       dest_tkt();
323       return ret;
324    }
325
326    ret = krb_rd_req(&ticket, linstance, phost, addr, &authdata, srvtab);
327    if (ret) {
328       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
329                  "Cannot verify krb4 ticket: krb_rd_req() failed: %s",
330                  krb_get_err_text(ret));
331       dest_tkt();
332    }
333
334    return ret;
335 }
336
337 static int
338 krb4_cache_cleanup(void *data)
339 {
340    char *tkt_file = (char *) data;
341    
342    krb_set_tkt_string(tkt_file);
343    dest_tkt();
344    return OK;
345 }
346
347 static int 
348 authenticate_user_krb4pwd(request_rec *r,
349                           kerb_auth_config *conf,
350                           const char *auth_line)
351 {
352    int ret;
353    const char *sent_pw;
354    const char *sent_name;
355    char *sent_instance;
356    char tkt_file[32];
357    char *tkt_file_p = NULL;
358    int fd;
359    const char *realms;
360    const char *realm;
361    char *user;
362    char lrealm[REALM_SZ];
363    int all_principals_unkown;
364
365    sent_pw = ap_pbase64decode(r->pool, auth_line);
366    sent_name = ap_getword (r->pool, &sent_pw, ':');
367
368    /* do not allow user to override realm setting of server */
369    if (strchr(sent_name, '@')) {
370       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
371                  "specifying realm in user name is prohibited");
372       return HTTP_UNAUTHORIZED;
373    }
374
375    sent_instance = strchr(sent_name, '.');
376    if (sent_instance)
377       *sent_instance++ = '\0'; 
378
379    snprintf(tkt_file, sizeof(tkt_file), "/tmp/apache_tkt_XXXXXX");
380    fd = mkstemp(tkt_file);
381    if (fd < 0) {
382       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
383                  "Cannot create krb4 ccache: mkstemp() failed: %s",
384                  strerror(errno));
385       return HTTP_INTERNAL_SERVER_ERROR;
386    }
387
388    tkt_file_p = ap_pstrdup(r->pool, tkt_file);
389    ap_register_cleanup(r->pool, tkt_file_p,
390                        krb4_cache_cleanup, ap_null_cleanup);
391
392    krb_set_tkt_string(tkt_file);
393
394    all_principals_unkown = 1;
395    realms = conf->krb_auth_realms;
396    do {
397       memset(lrealm, 0, sizeof(lrealm));
398       realm = NULL;
399       if (realms)
400          realm = ap_getword_white(r->pool, &realms);
401
402       if (realm == NULL) {
403          ret = krb_get_lrealm(lrealm, 1);
404          if (ret)
405             break;
406          realm = lrealm;
407       }
408
409       ret = verify_krb4_user(r, (char *)sent_name, 
410                              (sent_instance) ? sent_instance : "",
411                              (char *)realm, (char *)sent_pw,
412                              conf->krb_service_name,
413                              conf->krb_4_srvtab, conf->krb_verify_kdc);
414       if (!conf->krb_authoritative && ret) {
415          /* if we're not authoritative, we allow authentication to pass on
416           * to another modules if (and only if) the user is not known to us */
417          if (all_principals_unkown && ret != KDC_PR_UNKNOWN)
418             all_principals_unkown = 0;
419       }
420
421       if (ret == 0)
422          break;
423    } while (realms && *realms);
424
425    if (ret) {
426       /* XXX log only in the verify_krb4_user() call */
427       log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Verifying krb4 password failed");
428       ret = (!conf->krb_authoritative && all_principals_unkown == 1 && ret == KDC_PR_UNKNOWN) ?
429                  DECLINED : HTTP_UNAUTHORIZED;
430       goto end;
431    }
432
433    user = ap_pstrdup(r->pool, sent_name);
434    if (sent_instance)
435       user = ap_pstrcat(r->pool, user, ".", sent_instance, NULL);
436    user = ap_pstrcat(r->pool, user, "@", realm, NULL);
437
438    MK_USER = user;
439    MK_AUTH_TYPE = "Basic";
440    ap_table_setn(r->subprocess_env, "KRBTKFILE", tkt_file_p);
441
442    if (!conf->krb_save_credentials)
443       krb4_cache_cleanup(tkt_file);
444
445 end:
446    if (ret)
447       krb4_cache_cleanup(tkt_file);
448    close(fd);
449    tf_close();
450
451    return ret;
452 }
453 #endif /* KRB4 */
454
455 #ifdef KRB5
456 /*************************************************************************** 
457  Username/Password Validation for Krb5
458  ***************************************************************************/
459 /* Inspired by krb5_verify_user from Heimdal */
460 static krb5_error_code
461 verify_krb5_user(request_rec *r, krb5_context context, krb5_principal principal,
462                  krb5_ccache ccache, const char *password, const char *service,
463                  krb5_keytab keytab, int krb_verify_kdc)
464 {
465    krb5_creds creds;
466    krb5_principal server = NULL;
467    krb5_error_code ret;
468    krb5_verify_init_creds_opt opt;
469
470    memset(&creds, 0, sizeof(creds));
471
472    ret = krb5_get_init_creds_password(context, &creds, principal, 
473                                       (char *)password, krb5_prompter_posix,
474                                       NULL, 0, NULL, NULL);
475    if (ret)
476       return ret;
477
478    ret = krb5_sname_to_principal(context, ap_get_server_name(r), service, 
479                                  KRB5_NT_SRV_HST, &server);
480    if (ret)
481       goto end;
482
483    krb5_verify_init_creds_opt_init(&opt);
484    krb5_verify_init_creds_opt_set_ap_req_nofail(&opt, krb_verify_kdc);
485
486    ret = krb5_verify_init_creds(context, &creds, server, keytab, NULL, &opt);
487    if (ret)
488       goto end;
489
490    if (ccache) {
491       ret = krb5_cc_initialize(context, ccache, principal);
492       if (ret == 0)
493          ret = krb5_cc_store_cred(context, ccache, &creds);
494    }
495
496 end:
497    krb5_free_cred_contents(context, &creds);
498    if (server)
499       krb5_free_principal(context, server);
500    return ret;
501 }
502
503 static int
504 krb5_cache_cleanup(void *data)
505 {
506    krb5_context context;
507    krb5_ccache  cache;
508    krb5_error_code problem;
509    char *cache_name = (char *) data;
510
511    problem = krb5_init_context(&context);
512    if (problem) {
513       /* ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL, "krb5_init_context() failed"); */
514       return HTTP_INTERNAL_SERVER_ERROR;
515    }
516
517    problem = krb5_cc_resolve(context, cache_name, &cache);
518    if (problem) {
519       /* log_error(APLOG_MARK, APLOG_ERR, 0, NULL, 
520                 "krb5_cc_resolve() failed (%s: %s)",
521                 cache_name, krb5_get_err_text(context, problem)); */
522       return HTTP_INTERNAL_SERVER_ERROR;
523    }
524
525    krb5_cc_destroy(context, cache);
526    krb5_free_context(context);
527    return OK;
528 }
529
530 static int
531 create_krb5_ccache(krb5_context kcontext,
532                    request_rec *r,
533                    kerb_auth_config *conf,
534                    krb5_principal princ,
535                    krb5_ccache *ccache)
536 {
537    char *ccname;
538    int fd;
539    krb5_error_code problem;
540    int ret;
541    krb5_ccache tmp_ccache = NULL;
542
543    ccname = ap_psprintf(r->pool, "FILE:%s/krb5cc_apache_XXXXXX", P_tmpdir);
544    fd = mkstemp(ccname + strlen("FILE:"));
545    if (fd < 0) {
546       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
547                  "mkstemp() failed: %s", strerror(errno));
548       ret = HTTP_INTERNAL_SERVER_ERROR;
549       goto end;
550    }
551    close(fd);
552
553    problem = krb5_cc_resolve(kcontext, ccname, &tmp_ccache);
554    if (problem) {
555       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
556                  "krb5_cc_resolve() failed: %s",
557                  krb5_get_err_text(kcontext, problem));
558       ret = HTTP_INTERNAL_SERVER_ERROR;
559       unlink(ccname);
560       goto end;
561    }
562
563    problem = krb5_cc_initialize(kcontext, tmp_ccache, princ);
564    if (problem) {
565       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
566                  "Cannot initialize krb5 ccache %s: krb5_cc_initialize() failed: %s",
567                  ccname, krb5_get_err_text(kcontext, problem));
568       ret = HTTP_INTERNAL_SERVER_ERROR;
569       goto end;
570    }
571
572    ap_table_setn(r->subprocess_env, "KRB5CCNAME", ccname);
573    ap_register_cleanup(r->pool, ccname,
574                        krb5_cache_cleanup, ap_null_cleanup);
575
576    *ccache = tmp_ccache;
577    tmp_ccache = NULL;
578
579    ret = OK;
580
581 end:
582    if (tmp_ccache)
583       krb5_cc_destroy(kcontext, tmp_ccache);
584
585    return ret;
586 }
587
588 static int
589 store_krb5_creds(krb5_context kcontext,
590                  request_rec *r,
591                  kerb_auth_config *conf,
592                  krb5_ccache delegated_cred)
593 {
594    char errstr[1024];
595    krb5_error_code problem;
596    krb5_principal princ;
597    krb5_ccache ccache;
598    int ret;
599
600    problem = krb5_cc_get_principal(kcontext, delegated_cred, &princ);
601    if (problem) {
602       snprintf(errstr, sizeof(errstr), "krb5_cc_get_principal() failed: %s",
603                krb5_get_err_text(kcontext, problem));
604       return HTTP_INTERNAL_SERVER_ERROR;
605    }
606
607    ret = create_krb5_ccache(kcontext, r, conf, princ, &ccache);
608    if (ret) {
609       krb5_free_principal(kcontext, princ);
610       return ret;
611    }
612
613 #ifdef HEIMDAL
614    problem = krb5_cc_copy_cache(kcontext, delegated_cred, ccache);
615 #else
616    problem = krb5_cc_copy_creds(kcontext, delegated_cred, ccache);
617 #endif
618    krb5_free_principal(kcontext, princ);
619    if (problem) {
620       snprintf(errstr, sizeof(errstr), "Failed to store credentials: %s",
621                krb5_get_err_text(kcontext, problem));
622       krb5_cc_destroy(kcontext, ccache);
623       return HTTP_INTERNAL_SERVER_ERROR;
624    }
625
626    krb5_cc_close(kcontext, ccache);
627    return OK;
628 }
629
630
631 int authenticate_user_krb5pwd(request_rec *r,
632                               kerb_auth_config *conf,
633                               const char *auth_line)
634 {
635    const char      *sent_pw = NULL; 
636    const char      *sent_name = NULL;
637    const char      *realms = NULL;
638    krb5_context    kcontext = NULL;
639    krb5_error_code code;
640    krb5_principal  client = NULL;
641    krb5_ccache     ccache = NULL;
642    krb5_keytab     keytab = NULL;
643    int             ret;
644    char            *name = NULL;
645    int             all_principals_unkown;
646    char            *ccname = NULL;
647    int             fd;
648
649    code = krb5_init_context(&kcontext);
650    if (code) {
651       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
652                  "Cannot initialize Kerberos5 context (%d)", code);
653       return HTTP_INTERNAL_SERVER_ERROR;
654    }
655
656    sent_pw = ap_pbase64decode(r->pool, auth_line);
657    sent_name = ap_getword (r->pool, &sent_pw, ':');
658    /* do not allow user to override realm setting of server */
659    if (strchr(sent_name, '@')) {
660       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
661                  "specifying realm in user name is prohibited");
662       ret = HTTP_UNAUTHORIZED;
663       goto end;
664    }
665
666    /* XXX Heimdal allows to use the MEMORY: type with empty argument ? */
667    ccname = ap_psprintf(r->pool, "MEMORY:%s/krb5cc_apache_XXXXXX", P_tmpdir);
668    fd = mkstemp(ccname + strlen("MEMORY:"));
669    if (fd < 0) {
670       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
671                  "mkstemp() failed: %s", strerror(errno));
672       ret = HTTP_INTERNAL_SERVER_ERROR;
673       goto end;
674    }
675    close(fd);
676
677    code = krb5_cc_resolve(kcontext, ccname, &ccache);
678    if (code) {
679       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
680                  "krb5_cc_resolve() failed: %s",
681                  krb5_get_err_text(kcontext, code));
682       ret = HTTP_INTERNAL_SERVER_ERROR;
683       unlink(ccname);
684       goto end;
685    }
686
687    if (conf->krb_5_keytab)
688       krb5_kt_resolve(kcontext, conf->krb_5_keytab, &keytab);
689
690    all_principals_unkown = 1;
691    realms = conf->krb_auth_realms;
692    do {
693       if (realms && (code = krb5_set_default_realm(kcontext,
694                                            ap_getword_white(r->pool, &realms))))
695          continue;
696
697       if (client) {
698          krb5_free_principal(kcontext, client);
699          client = NULL;
700       }
701       code = krb5_parse_name(kcontext, sent_name, &client);
702       if (code)
703          continue;
704
705       code = verify_krb5_user(r, kcontext, client, ccache, sent_pw, 
706                               conf->krb_service_name, 
707                               keytab, conf->krb_verify_kdc);
708       if (!conf->krb_authoritative && code) {
709          /* if we're not authoritative, we allow authentication to pass on
710           * to another modules if (and only if) the user is not known to us */
711          if (all_principals_unkown && code != KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
712             all_principals_unkown = 0;
713       }
714
715       if (code == 0)
716          break;
717
718       /* ap_getword_white() used above shifts the parameter, so it's not
719          needed to touch the realms variable */
720    } while (realms && *realms);
721
722    memset((char *)sent_pw, 0, strlen(sent_pw));
723
724    if (code) {
725       /* XXX log only in the verify_krb5_user() call */
726       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
727                  "Verifying krb5 password failed: %s",
728                  krb5_get_err_text(kcontext, code));
729       if (!conf->krb_authoritative && all_principals_unkown == 1 && code == KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
730          ret = DECLINED;
731       else
732          ret = HTTP_UNAUTHORIZED;
733
734       goto end;
735    }
736
737    code = krb5_unparse_name(kcontext, client, &name);
738    if (code) {
739       log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "krb5_unparse_name() failed: %s",
740                  krb5_get_err_text(kcontext, code));
741       ret = HTTP_UNAUTHORIZED;
742       goto end;
743    }
744    MK_USER = ap_pstrdup (r->pool, name);
745    MK_AUTH_TYPE = "Basic";
746    free(name);
747
748    if (conf->krb_save_credentials)
749       store_krb5_creds(kcontext, r, conf, ccache);
750
751    ret = OK;
752
753 end:
754    if (client)
755       krb5_free_principal(kcontext, client);
756    if (ccache)
757       krb5_cc_destroy(kcontext, ccache);
758    if (keytab)
759       krb5_kt_close(kcontext, keytab);
760    krb5_free_context(kcontext);
761
762    return ret;
763 }
764
765 /*********************************************************************
766  * GSSAPI Authentication
767  ********************************************************************/
768
769 static const char *
770 get_gss_error(MK_POOL *p, OM_uint32 error_status, char *prefix)
771 {
772    OM_uint32 maj_stat, min_stat;
773    OM_uint32 msg_ctx = 0;
774    gss_buffer_desc status_string;
775    char buf[1024];
776    size_t len;
777
778    snprintf(buf, sizeof(buf), "%s", prefix);
779    len = strlen(buf);
780    do {
781       maj_stat = gss_display_status (&min_stat,
782                                      error_status,
783                                      GSS_C_MECH_CODE,
784                                      GSS_C_NO_OID,
785                                      &msg_ctx,
786                                      &status_string);
787       if (sizeof(buf) > len + status_string.length + 1) {
788          sprintf(buf+len, ": %s", (char*) status_string.value);
789          len += status_string.length;
790       }
791       gss_release_buffer(&min_stat, &status_string);
792    } while (!GSS_ERROR(maj_stat) && msg_ctx != 0);
793
794    return (ap_pstrdup(p, buf));
795 }
796
797 static int
798 cleanup_gss_connection(void *data)
799 {
800    OM_uint32 minor_status;
801    gss_connection_t *gss_conn = (gss_connection_t *)data;
802
803    if (data == NULL)
804       return OK;
805    if (gss_conn->context != GSS_C_NO_CONTEXT)
806       gss_delete_sec_context(&minor_status, &gss_conn->context,
807                              GSS_C_NO_BUFFER);
808    if (gss_conn->server_creds != GSS_C_NO_CREDENTIAL)
809       gss_release_cred(&minor_status, &gss_conn->server_creds);
810
811    gss_connection = NULL;
812
813    return OK;
814 }
815
816 static int
817 store_gss_creds(request_rec *r, kerb_auth_config *conf, char *princ_name,
818                 gss_cred_id_t delegated_cred)
819 {
820    OM_uint32 maj_stat, min_stat;
821    krb5_principal princ = NULL;
822    krb5_ccache ccache = NULL;
823    krb5_error_code problem;
824    krb5_context context;
825    int ret = HTTP_INTERNAL_SERVER_ERROR;
826
827    problem = krb5_init_context(&context);
828    if (problem) {
829       log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Cannot initialize krb5 context");
830       return HTTP_INTERNAL_SERVER_ERROR;
831    }
832
833    problem = krb5_parse_name(context, princ_name, &princ);
834    if (problem) {
835       log_rerror(APLOG_MARK, APLOG_ERR, 0, r, 
836          "Cannot parse delegated username (%s)", krb5_get_err_text(context, problem));
837       goto end;
838    }
839
840    problem = create_krb5_ccache(context, r, conf, princ, &ccache);
841    if (problem) {
842       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
843          "Cannot create krb5 ccache (%s)", krb5_get_err_text(context, problem));
844       goto end;
845    }
846
847    maj_stat = gss_krb5_copy_ccache(&min_stat, delegated_cred, ccache);
848    if (GSS_ERROR(maj_stat)) {
849       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
850          "Cannot store delegated credential (%s)", 
851          get_gss_error(r->pool, min_stat, "gss_krb5_copy_ccache"));
852       goto end;
853    }
854
855    krb5_cc_close(context, ccache);
856    ccache = NULL;
857    ret = 0;
858
859 end:
860    if (princ)
861       krb5_free_principal(context, princ);
862    if (ccache)
863       krb5_cc_destroy(context, ccache);
864    krb5_free_context(context);
865    return ret;
866 }
867
868 static int
869 get_gss_creds(request_rec *r,
870               kerb_auth_config *conf,
871               gss_cred_id_t *server_creds)
872 {
873    gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
874    OM_uint32 major_status, minor_status, minor_status2;
875    gss_name_t server_name = GSS_C_NO_NAME;
876    char buf[1024];
877
878    snprintf(buf, sizeof(buf), "%s/%s", conf->krb_service_name, ap_get_server_name(r));
879
880    input_token.value = buf;
881    input_token.length = strlen(buf) + 1;
882
883    major_status = gss_import_name(&minor_status, &input_token,
884                                   GSS_C_NT_USER_NAME,
885                                   &server_name);
886    if (GSS_ERROR(major_status)) {
887       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
888                  "%s", get_gss_error(r->pool, minor_status,
889                  "gss_import_name() failed"));
890       return HTTP_INTERNAL_SERVER_ERROR;
891    }
892    
893    major_status = gss_acquire_cred(&minor_status, server_name, GSS_C_INDEFINITE,
894                                    GSS_C_NO_OID_SET, GSS_C_ACCEPT,
895                                    server_creds, NULL, NULL);
896    gss_release_name(&minor_status2, &server_name);
897    if (GSS_ERROR(major_status)) {
898       log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
899                  "%s", get_gss_error(r->pool, minor_status,
900                                      "gss_acquire_cred() failed"));
901       return HTTP_INTERNAL_SERVER_ERROR;
902    }
903    
904    return 0;
905 }
906
907 static int
908 cmp_gss_type(gss_buffer_t token, gss_OID oid)
909 {
910    unsigned char *p;
911    size_t len;
912
913    if (token->length == 0)
914       return GSS_S_DEFECTIVE_TOKEN;
915
916    p = token->value;
917    if (*p++ != 0x60)
918       return GSS_S_DEFECTIVE_TOKEN;
919    len = *p++;
920    if (len & 0x80) {
921       if ((len & 0x7f) > 4)
922          return GSS_S_DEFECTIVE_TOKEN;
923       p += len & 0x7f;
924    }
925    if (*p++ != 0x06)
926       return GSS_S_DEFECTIVE_TOKEN;
927
928    if (((OM_uint32) *p++) != oid->length)
929       return GSS_S_DEFECTIVE_TOKEN;
930
931    return memcmp(p, oid->elements, oid->length);
932 }
933
934 static int
935 authenticate_user_gss(request_rec *r,
936                       kerb_auth_config *conf,
937                       const char *auth_line)
938 {
939   OM_uint32 major_status, minor_status, minor_status2;
940   gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
941   gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
942   const char *auth_param = NULL;
943   int ret;
944   gss_name_t client_name = GSS_C_NO_NAME;
945   gss_cred_id_t delegated_cred = GSS_C_NO_CREDENTIAL;
946   OM_uint32 (*accept_sec_token)();
947   gss_OID_desc spnego_oid;
948
949   spnego_oid.length = 6;
950   spnego_oid.elements = (void *)"\x2b\x06\x01\x05\x05\x02";
951
952   if (gss_connection == NULL) {
953      gss_connection = ap_pcalloc(r->connection->pool, sizeof(*gss_connection));
954      if (gss_connection == NULL) {
955         log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
956                    "ap_pcalloc() failed (not enough memory)");
957         ret = HTTP_INTERNAL_SERVER_ERROR;
958         goto end;
959      }
960      memset(gss_connection, 0, sizeof(*gss_connection));
961      ap_register_cleanup(r->connection->pool, gss_connection, cleanup_gss_connection, ap_null_cleanup);
962   }
963
964   if (conf->krb_5_keytab) {
965      char *ktname;
966      /* we don't use the ap_* calls here, since the string passed to putenv()
967       * will become part of the enviroment and shouldn't be free()ed by apache
968       */
969      ktname = malloc(strlen("KRB5_KTNAME=") + strlen(conf->krb_5_keytab) + 1);
970      if (ktname == NULL) {
971         log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "malloc() failed: not enough memory");
972         ret = HTTP_INTERNAL_SERVER_ERROR;
973         goto end;
974      }
975      sprintf(ktname, "KRB5_KTNAME=%s", conf->krb_5_keytab);
976      putenv(ktname);
977   }
978
979   if (gss_connection->server_creds == GSS_C_NO_CREDENTIAL) {
980      ret = get_gss_creds(r, conf, &gss_connection->server_creds);
981      if (ret)
982         goto end;
983   }
984
985   /* ap_getword() shifts parameter */
986   auth_param = ap_getword_white(r->pool, &auth_line);
987   if (auth_param == NULL) {
988      log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
989                 "No Authorization parameter in request from client");
990      ret = HTTP_UNAUTHORIZED;
991      goto end;
992   }
993
994   input_token.length = ap_base64decode_len(auth_param) + 1;
995   input_token.value = ap_pcalloc(r->connection->pool, input_token.length);
996   if (input_token.value == NULL) {
997      log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
998                 "ap_pcalloc() failed (not enough memory)");
999      ret = HTTP_INTERNAL_SERVER_ERROR;
1000      goto end;
1001   }
1002   input_token.length = ap_base64decode(input_token.value, auth_param);
1003
1004   accept_sec_token = (cmp_gss_type(&input_token, &spnego_oid) == 0) ?
1005                         gss_accept_sec_context_spnego : gss_accept_sec_context;
1006
1007   major_status = accept_sec_token(&minor_status,
1008                                   &gss_connection->context,
1009                                   gss_connection->server_creds,
1010                                   &input_token,
1011                                   GSS_C_NO_CHANNEL_BINDINGS,
1012                                   &client_name,
1013                                   NULL,
1014                                   &output_token,
1015                                   NULL,
1016                                   NULL,
1017                                   &delegated_cred);
1018   if (output_token.length) {
1019      char *token = NULL;
1020      size_t len;
1021      
1022      len = ap_base64encode_len(output_token.length) + 1;
1023      token = ap_pcalloc(r->connection->pool, len + 1);
1024      if (token == NULL) {
1025         log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1026                    "ap_pcalloc() failed (not enough memory)");
1027         ret = HTTP_INTERNAL_SERVER_ERROR;
1028         gss_release_buffer(&minor_status2, &output_token);
1029         goto end;
1030      }
1031      ap_base64encode(token, output_token.value, output_token.length);
1032      token[len] = '\0';
1033      ap_table_set(r->err_headers_out, "WWW-Authenticate",
1034                   ap_pstrcat(r->pool, "Negotiate ", token, NULL));
1035      gss_release_buffer(&minor_status2, &output_token);
1036   }
1037
1038   if (GSS_ERROR(major_status)) {
1039      log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1040                 "%s", get_gss_error(r->pool, minor_status,
1041                                     "gss_accept_sec_context() failed"));
1042      ret = HTTP_UNAUTHORIZED;
1043      goto end;
1044   }
1045
1046   if (major_status & GSS_S_CONTINUE_NEEDED) {
1047      /* Some GSSAPI mechanism (eg GSI from Globus) may require multiple 
1048       * iterations to establish authentication */
1049      ret = HTTP_UNAUTHORIZED;
1050      goto end;
1051   }
1052
1053   major_status = gss_display_name(&minor_status, client_name, &output_token, NULL);
1054   gss_release_name(&minor_status, &client_name); 
1055   if (GSS_ERROR(major_status)) {
1056     log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1057                "%s", get_gss_error(r->pool, minor_status, 
1058                                    "gss_export_name() failed"));
1059     ret = HTTP_INTERNAL_SERVER_ERROR;
1060     goto end;
1061   }
1062
1063   MK_AUTH_TYPE = "Negotiate";
1064   MK_USER = ap_pstrdup(r->pool, output_token.value);
1065
1066   if (conf->krb_save_credentials && delegated_cred != GSS_C_NO_CREDENTIAL)
1067      store_gss_creds(r, conf, (char *)output_token.value, delegated_cred);
1068
1069   gss_release_buffer(&minor_status, &output_token);
1070
1071   ret = OK;
1072
1073 end:
1074   if (delegated_cred)
1075      gss_release_cred(&minor_status, &delegated_cred);
1076
1077   if (output_token.length) 
1078      gss_release_buffer(&minor_status, &output_token);
1079
1080   if (client_name != GSS_C_NO_NAME)
1081      gss_release_name(&minor_status, &client_name);
1082
1083   cleanup_gss_connection(gss_connection);
1084
1085   return ret;
1086 }
1087 #endif /* KRB5 */
1088
1089 static int
1090 already_succeeded(request_rec *r)
1091 {
1092    if (ap_is_initial_req(r) || MK_AUTH_TYPE == NULL)
1093       return 0;
1094    if (strcmp(MK_AUTH_TYPE, "Negotiate") ||
1095        (strcmp(MK_AUTH_TYPE, "Basic") && strchr(MK_USER, '@')))
1096       return 1;
1097    return 0;
1098 }
1099
1100 static void
1101 note_kerb_auth_failure(request_rec *r, const kerb_auth_config *conf,
1102                        int use_krb4, int use_krb5)
1103 {
1104    const char *auth_name = NULL;
1105    int set_basic = 0;
1106
1107    /* get the user realm specified in .htaccess */
1108    auth_name = ap_auth_name(r);
1109
1110    /* XXX should the WWW-Authenticate header be cleared first? */
1111 #ifdef KRB5
1112    if (use_krb5 && conf->krb_method_gssapi)
1113       ap_table_add(r->err_headers_out, "WWW-Authenticate", "Negotiate");
1114    if (use_krb5 && conf->krb_method_k5pass) {
1115       ap_table_add(r->err_headers_out, "WWW-Authenticate",
1116                    ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1117       set_basic = 1;
1118    }
1119 #endif
1120
1121 #ifdef KRB4
1122    if (use_krb4 && conf->krb_method_k4pass && !set_basic)
1123       ap_table_add(r->err_headers_out, "WWW-Authenticate",
1124                    ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1125 #endif
1126 }
1127
1128 int kerb_authenticate_user(request_rec *r)
1129 {
1130    kerb_auth_config *conf = 
1131       (kerb_auth_config *) ap_get_module_config(r->per_dir_config,
1132                                                 &auth_kerb_module);
1133    const char *auth_type = NULL;
1134    const char *auth_line = NULL;
1135    const char *type = NULL;
1136    int use_krb5 = 0, use_krb4 = 0;
1137    int ret;
1138    static int last_return = HTTP_UNAUTHORIZED;
1139
1140    /* get the type specified in .htaccess */
1141    type = ap_auth_type(r);
1142
1143    if (type && strcasecmp(type, "Kerberos") == 0)
1144       use_krb5 = use_krb4 = 1;
1145    else if(type && strcasecmp(type, "KerberosV5") == 0)
1146       use_krb4 = 0;
1147    else if(type && strcasecmp(type, "KerberosV4") == 0)
1148       use_krb5 = 0;
1149    else
1150       return DECLINED;
1151
1152    /* get what the user sent us in the HTTP header */
1153    auth_line = MK_TABLE_GET(r->headers_in, "Authorization");
1154    if (!auth_line) {
1155       note_kerb_auth_failure(r, conf, use_krb4, use_krb5);
1156       return HTTP_UNAUTHORIZED;
1157    }
1158    auth_type = ap_getword_white(r->pool, &auth_line);
1159
1160    if (already_succeeded(r))
1161       return last_return;
1162
1163    ret = HTTP_UNAUTHORIZED;
1164
1165 #ifdef KRB5
1166    if (use_krb5 && conf->krb_method_gssapi &&
1167        strcasecmp(auth_type, "Negotiate") == 0) {
1168       ret = authenticate_user_gss(r, conf, auth_line);
1169    } else if (use_krb5 && conf->krb_method_k5pass &&
1170               strcasecmp(auth_type, "Basic") == 0) {
1171        ret = authenticate_user_krb5pwd(r, conf, auth_line);
1172    }
1173 #endif
1174
1175 #ifdef KRB4
1176    if (ret == HTTP_UNAUTHORIZED && use_krb4 && conf->krb_method_k4pass &&
1177        strcasecmp(auth_type, "Basic") == 0)
1178       ret = authenticate_user_krb4pwd(r, conf, auth_line);
1179 #endif
1180
1181    if (ret == HTTP_UNAUTHORIZED)
1182       note_kerb_auth_failure(r, conf, use_krb4, use_krb5);
1183
1184    last_return = ret;
1185    return ret;
1186 }
1187
1188
1189 /*************************************************************************** 
1190  Module Setup/Configuration
1191  ***************************************************************************/
1192 #ifdef APXS1
1193 module MODULE_VAR_EXPORT auth_kerb_module = {
1194         STANDARD_MODULE_STUFF,
1195         NULL,                           /*      module initializer            */
1196         kerb_dir_create_config,         /*      per-directory config creator  */
1197         NULL,                           /*      per-directory config merger   */
1198         NULL,                           /*      per-server    config creator  */
1199         NULL,                           /*      per-server    config merger   */
1200         kerb_auth_cmds,                 /*      command table                 */
1201         NULL,                           /* [ 9] content handlers              */
1202         NULL,                           /* [ 2] URI-to-filename translation   */
1203         kerb_authenticate_user,         /* [ 5] check/validate user_id        */
1204         NULL,                           /* [ 6] check user_id is valid *here* */
1205         NULL,                           /* [ 4] check access by host address  */
1206         NULL,                           /* [ 7] MIME type checker/setter      */
1207         NULL,                           /* [ 8] fixups                        */
1208         NULL,                           /* [10] logger                        */
1209         NULL,                           /* [ 3] header parser                 */
1210         NULL,                           /*      process initialization        */
1211         NULL,                           /*      process exit/cleanup          */
1212         NULL                            /* [ 1] post read_request handling    */
1213 };
1214 #else
1215 static int
1216 kerb_init_handler(apr_pool_t *p, apr_pool_t *plog,
1217                   apr_pool_t *ptemp, server_rec *s)
1218 {
1219    ap_add_version_component(p, "mod_auth_kerb/" MODAUTHKERB_VERSION);
1220    return OK;
1221 }
1222
1223 void kerb_register_hooks(apr_pool_t *p)
1224 {
1225    ap_hook_post_config(kerb_init_handler, NULL, NULL, APR_HOOK_MIDDLE);
1226    ap_hook_check_user_id(kerb_authenticate_user, NULL, NULL, APR_HOOK_MIDDLE);
1227 }
1228
1229 module AP_MODULE_DECLARE_DATA auth_kerb_module =
1230 {
1231    STANDARD20_MODULE_STUFF,
1232    kerb_dir_create_config,      /* create per-dir    conf structures  */
1233    NULL,                        /* merge  per-dir    conf structures  */
1234    NULL,                        /* create per-server conf structures  */
1235    NULL,                        /* merge  per-server conf structures  */
1236    kerb_auth_cmds,              /* table of configuration directives  */
1237    kerb_register_hooks          /* register hooks                     */
1238 };
1239 #endif