74a43a6dbc62b762ba51bb79c1214eeaea4d733c
[mod_auth_kerb.cvs/.git] / mod_auth_gssweb.c
1 /*
2  * Copyright (c) 2012, 2013, 2014 JANET(UK)
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
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * 3. Neither the name of JANET(UK) nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
31  * OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * NOTE: Some code in this module was derived from code in
34  * mod_auth_gssapi.c which is copyrighted by CESNET.  See that file
35  * for full copyright details.
36  *
37  * NOTE: Portions of the code in this file were derived from example
38  * code distributed under the Apache 2.0 license:
39  *     http://www.apache.org/licenses/LICENSE-2.0
40  * 
41  * This module implements the Apache server side of the GSSWeb
42  * authentiction type which allows Moonshot to be used for
43  * authentication in web applications.  The module consists of two
44  * components: the hook function (gssweb_authenticate_user) that does
45  * most of the work, and an output filter (gssweb_authenticate_filter)
46  * that is registered by the hook function to send the output token
47  * back to the client in a json message that wraps the original
48  * response content.
49  *
50  * This module uses a simple protocol between the client and server
51  * to exchange GSS tokens and nonce information.  The protocol is 
52  * described in the protocol.txt file included with module source.
53  */
54
55 #include <stdio.h>
56 #include "mod_auth_gssweb.h"
57
58 module AP_MODULE_DECLARE_DATA auth_gssweb_module;
59
60 #define command(name, func, var, type, usage)           \
61   AP_INIT_ ## type (name, (void*) func,                 \
62         (void*)APR_OFFSETOF(gss_auth_config, var),      \
63         OR_AUTHCFG | RSRC_CONF, usage)
64
65 static const command_rec gssweb_config_cmds[] = {
66     command("GSSServiceName", ap_set_string_slot, service_name,
67             TAKE1, "Service name used for Apache authentication."),
68
69     { NULL }
70 };
71   
72 #define DEFAULT_ENCTYPE         "application/x-www-form-urlencoded"
73 #define GSS_MAX_TOKEN_SIZE      4096    //TBD -- check this value
74
75 /* gssweb_read_req() -- reads the request data into a buffer 
76  */
77 static int gssweb_read_req(request_rec *r, const char **rbuf, apr_off_t *size)
78 {
79   int rc = OK;
80
81   if((rc = ap_setup_client_block(r, REQUEST_CHUNKED_ERROR))) {
82     return(rc);
83   }
84   
85   if(ap_should_client_block(r)) {
86
87     char         argsbuffer[HUGE_STRING_LEN];
88     apr_off_t    rsize, len_read, rpos = 0;
89     apr_off_t length = r->remaining;
90
91     *rbuf = (const char *) apr_pcalloc(r->pool, (apr_size_t) (length + 1));
92     *size = length;
93     while((len_read = ap_get_client_block(r, argsbuffer, sizeof(argsbuffer))) > 0) {
94       if((rpos + len_read) > length) {
95         rsize = length - rpos;
96       }
97       else {
98         rsize = len_read;
99       }
100       
101       memcpy((char *) *rbuf + rpos, argsbuffer, (size_t) rsize);
102       rpos += rsize;
103     }
104   }
105   return(rc);
106 }
107
108 /* gssweb_get_post_data() -- Gets the token and nonce from the request
109  * data.
110  */
111 static int gssweb_get_post_data(request_rec *r, int *nonce, gss_buffer_desc *input_token)
112 {
113   const char *data;
114   apr_off_t datalen;
115   const char *key, *val, *type;
116   int rc = 0;
117
118   *nonce = 0;
119   input_token->length = 0;
120   input_token->value = NULL;
121
122   if(r->method_number != M_POST) {
123     gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: Request data is not a POST, declining.");
124     return DECLINED;
125   }
126
127   type = apr_table_get(r->headers_in, "Content-Type");
128   if(strcasecmp(type, DEFAULT_ENCTYPE) != 0) {
129     gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: Unexpected content type, declining.");
130     return DECLINED;
131   }
132
133   if((rc = gssweb_read_req(r, &data, &datalen)) != OK) {
134     gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: Data read error, rc = %d", rc);
135     return rc;
136   }
137
138   while(*data && (val = ap_getword(r->pool, &data, '&'))) { 
139     gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: obtained val from ap_getword() (%s)", val);
140     key = ap_getword(r->pool, &val, '=');
141     ap_unescape_url((char*)key);
142     ap_unescape_url((char*)val);
143     if (0 == strcasecmp(key, "token")) {
144       gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: found token (%s)", val);
145       input_token->value = malloc(strlen(val));
146       input_token->length = apr_base64_decode(input_token->value, val);
147       gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: Token successfully decoded.");
148     }
149     else if (0 == strcasecmp(key, "nonce")) {
150       gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: found nonce (%s)", val);
151       *nonce = atoi(val);
152     }
153     else {
154       gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: unknown key (%s)", key);
155     }
156   }
157   if ((0 == *nonce) || (0 == input_token->length)) {
158     gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: nonce (%d) or token len (%d) is 0, declining", *nonce, input_token->length);
159     return DECLINED;
160   }
161   else {
162     gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_get_post_data: returning nonce (%d) and token (%d bytes)", *nonce, input_token->length);
163     return OK;
164   }
165 }
166
167 /* gssweb_authenticate_filter() -- Output filter for gssweb authentication.
168  * Wraps original response in JSON -- adding JSON to the beginning of the 
169  * response, escapes double quotes in the original response, and adds JSON
170  * to the end of the response.  Handles responses that involve more than
171  * one filter call by maintaining state until an EOS bucket is received.
172  */
173 static apr_status_t gssweb_authenticate_filter (ap_filter_t *f,
174                                         apr_bucket_brigade *brig_in)
175 {
176   gss_log(APLOG_MARK, APLOG_DEBUG, 0, f->r, "Entering GSSWeb filter");
177
178   request_rec *r = f->r;
179   conn_rec *c = r->connection;
180   apr_bucket_brigade *brig_out;
181   apr_bucket *bkt_in = NULL;
182   apr_bucket *bkt_out = NULL;
183   apr_bucket *bkt_eos = NULL;
184   const char *data = NULL;
185   apr_size_t len = 0;
186   char *buf = NULL;
187   char *stoken = NULL;
188   apr_size_t n = 0;
189   gss_conn_ctx conn_ctx = NULL;
190   const char *c_type = NULL;
191   const char *c_len = NULL;
192
193   apr_status_t ret = 0;
194
195   /* get the context from the request */
196   conn_ctx = gss_get_conn_ctx(r);
197   if ((NULL == conn_ctx) || 
198       (GSS_C_NO_CONTEXT == conn_ctx->context) ||
199       (GSS_CTX_EMPTY == conn_ctx->state) ||
200       (0 == conn_ctx->output_token.length)) {
201     conn_ctx->filter_stat = GSS_FILT_ERROR;
202     gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_authenticate_filter: Failed to find valid context.");
203     apr_brigade_cleanup(brig_in);
204     return HTTP_INTERNAL_SERVER_ERROR;
205   }
206     
207   /* if this is the first call for a response, send opening JSON block */
208
209   if (GSS_FILT_NEW == conn_ctx->filter_stat) {
210     if (NULL == (brig_out = apr_brigade_create(r->pool, c->bucket_alloc))) {
211       conn_ctx->filter_stat = GSS_FILT_ERROR;
212       gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_authenticate_filter: Unable to allocate output brigade (opening)");
213       apr_brigade_cleanup(brig_in);
214       return HTTP_INTERNAL_SERVER_ERROR;
215     }
216
217     len = apr_base64_encode_len(conn_ctx->output_token.length);
218     if (NULL == (data = apr_bucket_alloc(len+1024, c->bucket_alloc)) ||
219         NULL == (stoken = apr_bucket_alloc(len+1, c->bucket_alloc))) {
220       gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_authenticate_filter: Unable to allocate space for opening json block");
221       apr_brigade_cleanup(brig_in);
222       apr_brigade_cleanup(brig_out);
223       return HTTP_INTERNAL_SERVER_ERROR;
224     }
225
226     apr_base64_encode_binary(stoken, conn_ctx->output_token.value, conn_ctx->output_token.length);
227     snprintf((char *)data, len+1024, 
228              "{gssweb: {\ntoken: \"%s\",\nnonce: \"%d\"},\n application: {\ndata: \"", 
229              stoken, conn_ctx->nonce);
230     bkt_out = apr_bucket_heap_create(data, strlen(data), apr_bucket_free,
231                                      c->bucket_alloc);
232     APR_BRIGADE_INSERT_TAIL(brig_out, bkt_out);
233     if (0 != (ret = ap_pass_brigade(f->next, brig_out))) {
234       apr_brigade_cleanup(brig_in);
235       apr_brigade_cleanup(brig_out);
236       return ret;
237     }
238
239     conn_ctx->filter_stat = GSS_FILT_INPROGRESS;
240   }
241
242   /* loop through the app data buckets, escaping and sending each one */
243   for (bkt_in = APR_BRIGADE_FIRST(brig_in);
244        bkt_in != APR_BRIGADE_SENTINEL(brig_in);
245        bkt_in = APR_BUCKET_NEXT(bkt_in))
246     {
247       if (NULL == (brig_out = apr_brigade_create(r->pool, c->bucket_alloc))) {
248             gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_authenticate_filter: Unable to allocate brigade (loop)");
249             conn_ctx->filter_stat = GSS_FILT_ERROR;
250             apr_brigade_cleanup(brig_in);
251             return HTTP_INTERNAL_SERVER_ERROR;
252       }
253
254       /* if this is an EOS, send the JSON closing block */
255       if(APR_BUCKET_IS_EOS(bkt_in))
256         {
257           /* create and add the JSON closing block */
258           
259           if (NULL == (data = apr_bucket_alloc(1024, c->bucket_alloc))) {
260               gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_authenticate_filter: Unable to allocate space for closing json block");
261               apr_brigade_cleanup(brig_in);
262               apr_brigade_cleanup(brig_out);
263               return HTTP_INTERNAL_SERVER_ERROR;
264           }
265
266           c_type = apr_table_get(r->headers_in, "Content-Type");
267           c_len = apr_table_get(r->headers_in, "Content-Length");
268           snprintf((char *)data, 1024, "\"\ncontent-type: \"%s,\ncontent-length: \"%s\"\n}\n}", c_type, c_len);
269           bkt_out = apr_bucket_heap_create(data, strlen(data), apr_bucket_free,
270                                            c->bucket_alloc);
271           APR_BRIGADE_INSERT_TAIL(brig_out, bkt_out);
272
273           /* Indicate that the next filter call is a new response */
274           conn_ctx->filter_stat = GSS_FILT_NEW;
275           
276           /* set EOS in the outbound brigade */
277           bkt_eos = apr_bucket_eos_create(c->bucket_alloc);
278           APR_BRIGADE_INSERT_TAIL (brig_out, bkt_eos);
279           
280           /* pass the brigade */
281           if (0 != (ret = ap_pass_brigade(f->next, brig_out))) {
282             gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_authenticate_filter: Unable to pass output brigade (eos)");
283             conn_ctx->filter_stat = GSS_FILT_ERROR;
284             apr_brigade_cleanup(brig_in);
285             apr_brigade_cleanup(brig_out);
286             return ret;
287           }
288           continue;
289         }
290
291       /* Read application data from each input bucket */
292       apr_bucket_read(bkt_in, &data, &len, APR_BLOCK_READ);
293
294       /* Write data to an output brigade, escaping quotes */
295       for(n=0 ; n < len ; ++n) {
296         if ('"' == data[n]) {
297           /* Write n bytes of app data */
298           buf = apr_bucket_alloc(n, c->bucket_alloc);
299           bkt_out = apr_bucket_heap_create(buf, n, apr_bucket_free,
300                                            c->bucket_alloc);
301           APR_BRIGADE_INSERT_TAIL(brig_out, bkt_out);
302           
303           /* Write the escaped quote character */
304           buf = apr_bucket_alloc(3, c->bucket_alloc);
305           bkt_out = apr_bucket_heap_create("\\\"", 2, NULL, c->bucket_alloc);
306           APR_BRIGADE_INSERT_TAIL(brig_out, bkt_out);
307
308           /* Process remaining data */
309           buf = &buf[n];
310           len = len - n;
311           n = 0;
312         }
313       }
314
315       /* Send the output brigade */
316       if (OK != (ret = ap_pass_brigade(f->next, brig_out))) {
317         apr_brigade_cleanup(brig_in);
318         apr_brigade_cleanup(brig_out);
319         return ret;
320       }
321     }
322
323   /* Make sure we don't see the same data again */
324   apr_brigade_cleanup(brig_in);
325   return ret;
326 }
327
328 /* gssweb_add_filter() -- Hook to add our output filter to the request
329  * (r). Called for all error responses through the
330  * gssweb_insert_error_filter hook.
331  */
332 static void
333 gssweb_add_filter(request_rec *r) 
334 {
335   gss_conn_ctx conn_ctx = NULL;
336
337   /* Get the context for this request */
338   conn_ctx = gss_get_conn_ctx(r);
339   if (conn_ctx == NULL) {
340     gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_add_filter: Failed to find or create internal context.");
341     return;
342   }
343
344   /* Add the output filter */
345   ap_add_output_filter("gssweb_auth_filter", (void *)conn_ctx, r, r->connection);
346   return;
347 }
348
349 /* gssweb_authenticate_user() -- Hook to perform actual user
350  * authentication.  Will be called once for each round trip in the GSS
351  * authentication loop.  Reads the tokend from the request, calls
352  * gss_accept_sec_context(), and stores the output token and context
353  * in the user data areas.  Adds output filter to send the GSS
354  * output token back to the client.
355  */
356 static int
357 gssweb_authenticate_user(request_rec *r) 
358 {
359   gss_auth_config *conf = 
360     (gss_auth_config *) ap_get_module_config(r->per_dir_config,
361                                                 &auth_gssweb_module);
362   const char *auth_line = NULL;
363   char *auth_type = NULL;
364   char *negotiate_ret_value = NULL;
365   gss_conn_ctx conn_ctx = NULL;
366   int ret;
367   OM_uint32 major_status, minor_status, minor_status2;
368   gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
369   gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
370   gss_name_t client_name = GSS_C_NO_NAME;
371   gss_cred_id_t delegated_cred = GSS_C_NO_CREDENTIAL;
372   gss_cred_id_t server_creds = GSS_C_NO_CREDENTIAL;
373   OM_uint32 ret_flags = 0;
374   unsigned int nonce;
375
376   gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "Entering GSSWeb authentication");
377    
378   /* Check if this is for our auth type */
379   auth_type = (char *)ap_auth_type(r);
380   if (auth_type == NULL || strcasecmp(auth_type, "GSSWeb") != 0) {
381         gss_log(APLOG_MARK, APLOG_DEBUG, 0, r,
382                 "gssweb_authenticate_user: AuthType '%s' is not GSSWeb, bailing out",
383                 (auth_type) ? auth_type : "(NULL)");
384
385         return DECLINED;
386   }
387
388   /* Set up a GSS context for this request, if there isn't one already */
389   conn_ctx = gss_get_conn_ctx(r);
390   if (conn_ctx == NULL) {
391     gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_authenticate_user: Failed to create internal context");
392     return HTTP_INTERNAL_SERVER_ERROR;
393   }
394
395   /* Read the token and nonce from the POST */
396   if (0 != gssweb_get_post_data(r, &nonce, &input_token)) {
397     ret = HTTP_UNAUTHORIZED;
398     gss_log(APLOG_MARK, APLOG_ERR, 0, r, "gssweb_authenticate_user: Unable to read nonce or input token.");
399     goto end;
400   }
401   gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_authenticate_user: GSSWeb nonce value = %u.", nonce);
402    
403   /* If the nonce is set and doesn't match, start over */
404   if ((0 != conn_ctx->nonce) && (conn_ctx->nonce != nonce)) {
405     if (GSS_C_NO_CONTEXT != conn_ctx->context) {
406       gss_delete_sec_context(&minor_status, &conn_ctx->context, GSS_C_NO_BUFFER);
407     }
408     conn_ctx->context = GSS_C_NO_CONTEXT;
409     conn_ctx->state = GSS_CTX_EMPTY;
410     conn_ctx->filter_stat = GSS_FILT_NEW;
411     conn_ctx->user = NULL;
412     if (0 != conn_ctx->output_token.length) {
413       gss_release_buffer(&minor_status, &(conn_ctx->output_token));
414     }
415     conn_ctx->output_token.length = 0;
416   }
417  
418   /* If the output filter reported an internal server error, return it */
419   if (GSS_FILT_ERROR == conn_ctx->filter_stat) {
420     ret = HTTP_INTERNAL_SERVER_ERROR;
421     gss_log(APLOG_MARK, APLOG_ERR, 0, r,
422             "gssweb_authenticate_user: Output filter returned error, reporting.");
423     goto end;
424   }
425
426   /* Set-up the output filter (TBD -- register this once?) */
427   ap_register_output_filter("gssweb_auth_filter", gssweb_authenticate_filter, NULL, AP_FTYPE_RESOURCE);
428   ap_add_output_filter("gssweb_auth_filter", (void *)conn_ctx, r, r->connection);
429
430   /* Acquire server credentials (TBD -- do this once?) */
431   ret = get_gss_creds(r, conf, &server_creds);
432   if (ret)
433     goto end;
434   gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_authenticate_user: Server credentials acquired.");
435     
436   /* Call gss_accept_sec_context */
437   major_status = gss_accept_sec_context(&minor_status,
438                                         &conn_ctx->context,
439                                         server_creds,
440                                         &input_token,
441                                         GSS_C_NO_CHANNEL_BINDINGS,
442                                         NULL,
443                                         NULL,
444                                         &output_token,
445                                         &ret_flags,
446                                         NULL,
447                                         &delegated_cred);
448   gss_log(APLOG_MARK, APLOG_DEBUG, 0, r,
449           "gssweb_authenticate_user: Client %s us their credential",
450           (ret_flags & GSS_C_DELEG_FLAG) ? "delegated" : "didn't delegate");
451
452   if (GSS_ERROR(major_status)) {
453     gss_log(APLOG_MARK, APLOG_ERR, 0, r,
454             "%s", get_gss_error(r, major_status, minor_status,
455                                 "gssweb_authenticate_user: Failed to establish authentication"));
456     gss_delete_sec_context(&minor_status, &conn_ctx->context, GSS_C_NO_BUFFER);
457     conn_ctx->context = GSS_C_NO_CONTEXT;
458     conn_ctx->state = GSS_CTX_EMPTY;
459     ret = HTTP_UNAUTHORIZED;
460     goto end;
461     gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_authenticate_user: Decoding ouput token.");
462   }
463
464   gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "gssweb_authenticate_user: Got sec context, storing nonce and output token.");
465
466   /* Store the nonce & ouput token in the stored context */
467   conn_ctx->nonce = nonce;
468   conn_ctx->output_token = output_token;
469     
470   /* If we aren't done yet, go around again */
471   if (major_status & GSS_S_CONTINUE_NEEDED) {
472     conn_ctx->state = GSS_CTX_IN_PROGRESS;
473     ret = HTTP_UNAUTHORIZED;
474     goto end;
475   }
476
477   conn_ctx->state = GSS_CTX_ESTABLISHED;
478         r->user = apr_pstrdup(r->pool, conn_ctx->user);
479         r->ap_auth_type = "GSSWeb";
480   ret = OK;
481
482  end:
483   if (delegated_cred)
484     gss_release_cred(&minor_status, &delegated_cred);
485   
486   if (output_token.length) 
487     gss_release_buffer(&minor_status, &output_token);
488     
489   if (client_name != GSS_C_NO_NAME)
490     gss_release_name(&minor_status, &client_name);
491
492   if (server_creds != GSS_C_NO_CREDENTIAL)
493     gss_release_cred(&minor_status, &server_creds);
494
495   return ret;
496 }
497
498 static void
499 gssweb_register_hooks(apr_pool_t *p)
500 {
501     ap_hook_check_user_id(gssweb_authenticate_user, NULL, NULL, APR_HOOK_MIDDLE);
502     ap_hook_insert_error_filter(gssweb_add_filter, NULL, NULL, APR_HOOK_MIDDLE);
503 }
504
505 module AP_MODULE_DECLARE_DATA auth_gssweb_module = {
506     STANDARD20_MODULE_STUFF,
507     gss_config_dir_create,
508     NULL,
509     NULL,
510     NULL,
511     gssweb_config_cmds,
512     gssweb_register_hooks
513 };