Added protocol description for GSS Web authentication.
[mod_auth_kerb.cvs/.git] / mod_auth_gssweb.h
1 /*
2  * Copyright (c) 2010 CESNET
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *    this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of CESNET nor the names of its contributors may
16  *    be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef __MOD_AUTH_GSSWEB_H__
33 #define __MOD_AUTH_GSSWEB_H__
34
35 #include <httpd.h>
36 #include <http_config.h>
37 #include <http_core.h>
38 #include <http_log.h>
39 #include <http_protocol.h>
40 #include <http_request.h>
41
42 #include <apr_base64.h>
43 #include <apr_strings.h>
44
45 #include <gssapi.h>
46
47 // #ifndef GSSAPI_SUPPORTS_SPNEGO
48 // #include "spnegokrb5.h"
49 // #endif
50
51 #define SERVICE_NAME "HTTP"
52
53 typedef struct {
54     const char *service_name;
55     const char *krb5_keytab;
56 } gss_auth_config;
57
58 typedef struct gss_conn_ctx_t {
59     gss_ctx_id_t context;
60     enum {
61         GSS_CTX_EMPTY,
62         GSS_CTX_IN_PROGRESS,
63         GSS_CTX_ESTABLISHED,
64     } state;
65     char *user;
66 } *gss_conn_ctx;
67
68 void
69 gss_log(const char *file, int line, int level, int status,
70         const request_rec *r, const char *fmt, ...);
71
72 apr_status_t
73 cleanup_conn_ctx(void *data);
74
75 gss_conn_ctx
76 gss_get_conn_ctx(request_rec *r);
77
78 void *
79 gss_config_dir_create(apr_pool_t *p, char *d);
80
81 static const char *
82 get_gss_error(request_rec *r, OM_uint32 err_maj, OM_uint32 err_min, char *prefix);
83
84 static int
85 get_gss_creds(request_rec *r, gss_auth_config *conf, gss_cred_id_t *server_creds);
86
87 static int
88 cmp_gss_type(gss_buffer_t token, gss_OID oid);
89
90 int
91 gssweb_authenticate(request_rec *r, gss_auth_config *conf, gss_conn_ctx ctx,
92                  const char *auth_line, char **negotiate_ret_value);
93 #endif