Break out of processing upon GSS error being reported.
[mod_auth_kerb.git] / gss.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 __GSS_H__
33 #define __GSS_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 #define SERVICE_NAME "HTTP"
48
49 typedef struct {
50     const char *service_name;
51     const char *krb5_keytab;
52 } gss_auth_config;
53
54 typedef struct gss_conn_ctx_t {
55   gss_ctx_id_t context;
56   gss_cred_id_t server_creds;
57   enum {
58     GSS_CTX_EMPTY,
59     GSS_CTX_IN_PROGRESS,
60     GSS_CTX_FAILED,
61     GSS_CTX_ESTABLISHED,
62   } state;
63   enum {
64     GSS_FILT_NEW,
65     GSS_FILT_INPROGRESS,
66     GSS_FILT_ERROR,
67   } filter_stat;
68
69   char *user;
70   gss_buffer_desc output_token;
71   unsigned int nonce;
72 } *gss_conn_ctx;
73
74 void
75 gss_log(const char *file, 
76         int line,
77 #if AP_SERVER_MAJORVERSION_NUMBER == 2 && AP_SERVER_MINORVERSION_NUMBER == 4
78         int module_index,
79 #endif
80         int level,
81         int status,
82         const request_rec *r,
83         const char *fmt, ...);
84
85 apr_status_t
86 gss_cleanup_conn_ctx(void *data);
87
88 gss_conn_ctx
89 gss_retrieve_conn_ctx(request_rec *r);
90
91 gss_conn_ctx
92 gss_create_conn_ctx(request_rec *r, gss_auth_config *conf);
93
94 void *
95 gss_config_dir_create(apr_pool_t *p, char *d);
96
97 const char *
98 get_gss_error(request_rec *r, OM_uint32 err_maj, OM_uint32 err_min, char *prefix);
99
100 int
101 get_gss_creds(request_rec *r, gss_auth_config *conf, gss_cred_id_t *server_creds);
102
103 int
104 cmp_gss_type(gss_buffer_t token, gss_OID oid);
105
106 #endif