1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
|
/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "mod_session.h"
#include "apr_lib.h"
#include "apr_strings.h"
#include "util_filter.h"
#include "http_log.h"
#include "http_request.h"
#include "http_protocol.h"
#define SESSION_EXPIRY "expiry"
#define HTTP_SESSION "HTTP_SESSION"
APR_HOOK_STRUCT(
APR_HOOK_LINK(session_load)
APR_HOOK_LINK(session_save)
APR_HOOK_LINK(session_encode)
APR_HOOK_LINK(session_decode)
)
APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(ap, SESSION, int, session_load,
(request_rec * r, session_rec ** z), (r, z), DECLINED)
APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(ap, SESSION, int, session_save,
(request_rec * r, session_rec * z), (r, z), DECLINED)
APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL(ap, SESSION, int, session_encode,
(request_rec * r, session_rec * z), (r, z), OK, DECLINED)
APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL(ap, SESSION, int, session_decode,
(request_rec * r, session_rec * z), (r, z), OK, DECLINED)
static int session_identity_encode(request_rec * r, session_rec * z);
static int session_identity_decode(request_rec * r, session_rec * z);
static int session_fixups(request_rec * r);
/**
* Should the session be included within this URL.
*
* This function tests whether a session is valid for this URL. It uses the
* include and exclude arrays to determine whether they should be included.
*/
static int session_included(request_rec * r, session_dir_conf * conf)
{
const char **includes = (const char **) conf->includes->elts;
const char **excludes = (const char **) conf->excludes->elts;
int included = 1; /* defaults to included */
int i;
if (conf->includes->nelts) {
included = 0;
for (i = 0; !included && i < conf->includes->nelts; i++) {
const char *include = includes[i];
if (strncmp(r->uri, include, strlen(include)) == 0) {
included = 1;
}
}
}
if (conf->excludes->nelts) {
for (i = 0; included && i < conf->excludes->nelts; i++) {
const char *exclude = excludes[i];
if (strncmp(r->uri, exclude, strlen(exclude)) == 0) {
included = 0;
}
}
}
return included;
}
/**
* Load the session.
*
* If the session doesn't exist, a blank one will be created.
*
* @param r The request
* @param z A pointer to where the session will be written.
*/
static apr_status_t ap_session_load(request_rec * r, session_rec ** z)
{
session_dir_conf *dconf = ap_get_module_config(r->per_dir_config,
&session_module);
apr_time_t now;
session_rec *zz = NULL;
int rv = 0;
/* is the session enabled? */
if (!dconf || !dconf->enabled) {
return APR_SUCCESS;
}
/* should the session be loaded at all? */
if (!session_included(r, dconf)) {
ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, APLOGNO(01814)
"excluded by configuration for: %s", r->uri);
return APR_SUCCESS;
}
/* load the session from the session hook */
rv = ap_run_session_load(r, &zz);
if (DECLINED == rv) {
ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, APLOGNO(01815)
"session is enabled but no session modules have been configured, "
"session not loaded: %s", r->uri);
return APR_EGENERAL;
}
else if (OK != rv) {
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01816)
"error while loading the session, "
"session not loaded: %s", r->uri);
return rv;
}
/* found a session that hasn't expired? */
now = apr_time_now();
if (zz) {
/* load the session attributes */
rv = ap_run_session_decode(r, zz);
/* having a session we cannot decode is just as good as having
none at all */
if (OK != rv) {
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01817)
"error while decoding the session, "
"session not loaded: %s", r->uri);
/* preserve pointers to zz in load/save providers */
memset(zz, 0, sizeof(session_rec));
zz->pool = r->pool;
zz->entries = apr_table_make(zz->pool, 10);
}
/* invalidate session if session is expired */
if (zz && zz->expiry && zz->expiry < now) {
ap_log_rerror(APLOG_MARK, APLOG_TRACE2, 0, r, "session is expired");
/* preserve pointers to zz in load/save providers */
memset(zz, 0, sizeof(session_rec));
zz->pool = r->pool;
zz->entries = apr_table_make(zz->pool, 10);
}
}
/* no luck, create a blank session. Note that the included session_load
* providers will return new sessions during session_load when configured.
*/
if (!zz) {
zz = (session_rec *) apr_pcalloc(r->pool, sizeof(session_rec));
zz->pool = r->pool;
zz->entries = apr_table_make(zz->pool, 10);
}
/* make sure the expiry and maxage are set, if present */
if (dconf->maxage) {
if (!zz->expiry) {
zz->expiry = now + dconf->maxage * APR_USEC_PER_SEC;
}
zz->maxage = dconf->maxage;
}
*z = zz;
return APR_SUCCESS;
}
/**
* Save the session.
*
* In most implementations the session is only saved if the dirty flag is
* true. This prevents the session being saved unnecessarily.
*
* @param r The request
* @param z A pointer to where the session will be written.
*/
static apr_status_t ap_session_save(request_rec * r, session_rec * z)
{
if (z) {
apr_time_t now = apr_time_now();
apr_time_t initialExpiry = z->expiry;
int rv = 0;
session_dir_conf *dconf = ap_get_module_config(r->per_dir_config,
&session_module);
/* sanity checks, should we try save at all? */
if (z->written) {
ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01818)
"attempt made to save the session twice, "
"session not saved: %s", r->uri);
return APR_EGENERAL;
}
if (z->expiry && z->expiry < now) {
ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, APLOGNO(01819)
"attempt made to save a session when the session had already expired, "
"session not saved: %s", r->uri);
return APR_EGENERAL;
}
/* reset the expiry back to maxage, if the expiry is present */
if (dconf->maxage) {
z->expiry = now + dconf->maxage * APR_USEC_PER_SEC;
z->maxage = dconf->maxage;
}
/* reset the expiry before saving if present */
if (z->dirty && z->maxage) {
z->expiry = now + z->maxage * APR_USEC_PER_SEC;
}
/* don't save if the only change is the expiry by a small amount */
if (!z->dirty && dconf->expiry_update_time
&& (z->expiry - initialExpiry < dconf->expiry_update_time)) {
return APR_SUCCESS;
}
/* also don't save sessions that didn't change at all */
if (!z->dirty && !z->maxage) {
return APR_SUCCESS;
}
/* encode the session */
rv = ap_run_session_encode(r, z);
if (OK != rv) {
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01820)
"error while encoding the session, "
"session not saved: %s", r->uri);
return rv;
}
/* try the save */
rv = ap_run_session_save(r, z);
if (DECLINED == rv) {
ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, APLOGNO(01821)
"session is enabled but no session modules have been configured, "
"session not saved: %s", r->uri);
return APR_EGENERAL;
}
else if (OK != rv) {
ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01822)
"error while saving the session, "
"session not saved: %s", r->uri);
return rv;
}
else {
z->written = 1;
}
}
return APR_SUCCESS;
}
/**
* Get a particular value from the session.
* @param r The current request.
* @param z The current session. If this value is NULL, the session will be
* looked up in the request, created if necessary, and saved to the request
* notes.
* @param key The key to get.
* @param value The buffer to write the value to.
*/
static apr_status_t ap_session_get(request_rec * r, session_rec * z,
const char *key, const char **value)
{
if (!z) {
apr_status_t rv;
rv = ap_session_load(r, &z);
if (APR_SUCCESS != rv) {
return rv;
}
}
if (z && z->entries) {
*value = apr_table_get(z->entries, key);
}
return OK;
}
/**
* Set a particular value to the session.
*
* Using this method ensures that the dirty flag is set correctly, so that
* the session can be saved efficiently.
* @param r The current request.
* @param z The current session. If this value is NULL, the session will be
* looked up in the request, created if necessary, and saved to the request
* notes.
* @param key The key to set. The existing key value will be replaced.
* @param value The value to set.
*/
static apr_status_t ap_session_set(request_rec * r, session_rec * z,
const char *key, const char *value)
{
if (!z) {
apr_status_t rv;
rv = ap_session_load(r, &z);
if (APR_SUCCESS != rv) {
return rv;
}
}
if (z) {
if (value) {
apr_table_set(z->entries, key, value);
}
else {
apr_table_unset(z->entries, key);
}
z->dirty = 1;
}
return APR_SUCCESS;
}
static int identity_count(void *v, const char *key, const char *val)
{
apr_size_t *count = v;
*count += strlen(key) * 3 + strlen(val) * 3 + 2;
return 1;
}
static int identity_concat(void *v, const char *key, const char *val)
{
char *slider = v;
apr_size_t length = strlen(slider);
slider += length;
if (length) {
*slider = '&';
slider++;
}
ap_escape_urlencoded_buffer(slider, key);
slider += strlen(slider);
*slider = '=';
slider++;
ap_escape_urlencoded_buffer(slider, val);
return 1;
}
/**
* Default identity encoding for the session.
*
* By default, the name value pairs in the session are URLEncoded, separated
* by equals, and then in turn separated by ampersand, in the format of an
* html form.
*
* This was chosen to make it easy for external code to unpack a session,
* should there be a need to do so.
*
* @param r The request pointer.
* @param z A pointer to where the session will be written.
*/
static apr_status_t session_identity_encode(request_rec * r, session_rec * z)
{
char *buffer = NULL;
apr_size_t length = 0;
if (z->expiry) {
char *expiry = apr_psprintf(z->pool, "%" APR_INT64_T_FMT, z->expiry);
apr_table_setn(z->entries, SESSION_EXPIRY, expiry);
}
apr_table_do(identity_count, &length, z->entries, NULL);
buffer = apr_pcalloc(r->pool, length + 1);
apr_table_do(identity_concat, buffer, z->entries, NULL);
z->encoded = buffer;
return OK;
}
/**
* Default identity decoding for the session.
*
* By default, the name value pairs in the session are URLEncoded, separated
* by equals, and then in turn separated by ampersand, in the format of an
* html form.
*
* This was chosen to make it easy for external code to unpack a session,
* should there be a need to do so.
*
* This function reverses that process, and populates the session table.
*
* Name / value pairs that are not encoded properly are ignored.
*
* @param r The request pointer.
* @param z A pointer to where the session will be written.
*/
static apr_status_t session_identity_decode(request_rec * r, session_rec * z)
{
char *last = NULL;
char *encoded, *pair;
const char *sep = "&";
/* sanity check - anything to decode? */
if (!z->encoded) {
return OK;
}
/* decode what we have */
encoded = apr_pstrdup(r->pool, z->encoded);
pair = apr_strtok(encoded, sep, &last);
while (pair && pair[0]) {
char *plast = NULL;
const char *psep = "=";
char *key = apr_strtok(pair, psep, &plast);
if (key && *key) {
char *val = apr_strtok(NULL, psep, &plast);
if (!val || !*val) {
apr_table_unset(z->entries, key);
}
else if (!ap_unescape_urlencoded(key) && !ap_unescape_urlencoded(val)) {
if (!strcmp(SESSION_EXPIRY, key)) {
z->expiry = (apr_time_t) apr_atoi64(val);
}
else {
apr_table_set(z->entries, key, val);
}
}
}
pair = apr_strtok(NULL, sep, &last);
}
z->encoded = NULL;
return OK;
}
/**
* Ensure any changes to the session are committed.
*
* This is done in an output filter so that our options for where to
* store the session can include storing the session within a cookie:
* As an HTTP header, the cookie must be set before the output is
* written, but after the handler is run.
*
* NOTE: It is possible for internal redirects to cause more than one
* request to be present, and each request might have a session
* defined. We need to go through each session in turn, and save each
* one.
*
* The same session might appear in more than one request. The first
* attempt to save the session will be called
*/
static apr_status_t session_output_filter(ap_filter_t * f,
apr_bucket_brigade * in)
{
/* save all the sessions in all the requests */
request_rec *r = f->r->main;
if (!r) {
r = f->r;
}
while (r) {
session_rec *z = NULL;
session_dir_conf *conf = ap_get_module_config(r->per_dir_config,
&session_module);
/* load the session, or create one if necessary */
/* when unset or on error, z will be NULL */
ap_session_load(r, &z);
if (!z || z->written) {
r = r->next;
continue;
}
/* if a header was specified, insert the new values from the header */
if (conf->header_set) {
const char *override = apr_table_get(r->err_headers_out, conf->header);
if (!override) {
override = apr_table_get(r->headers_out, conf->header);
}
if (override) {
apr_table_unset(r->err_headers_out, conf->header);
apr_table_unset(r->headers_out, conf->header);
z->encoded = override;
z->dirty = 1;
session_identity_decode(r, z);
}
}
/* save away the session, and we're done */
/* when unset or on error, we've complained to the log */
ap_session_save(r, z);
r = r->next;
}
/* remove ourselves from the filter chain */
ap_remove_output_filter(f);
/* send the data up the stack */
return ap_pass_brigade(f->next, in);
}
/**
* Insert the output filter.
*/
static void session_insert_output_filter(request_rec * r)
{
ap_add_output_filter("MOD_SESSION_OUT", NULL, r, r->connection);
}
/**
* Fixups hook.
*
* Load the session within a fixup - this ensures that the session is
* properly loaded prior to the handler being called.
*
* The fixup is also responsible for injecting the session into the CGI
* environment, should the admin have configured it so.
*
* @param r The request
*/
static int session_fixups(request_rec * r)
{
session_dir_conf *conf = ap_get_module_config(r->per_dir_config,
&session_module);
session_rec *z = NULL;
/* if an error occurs or no session has been configured, we ignore
* the broken session and allow it to be recreated from scratch on save
* if necessary.
*/
ap_session_load(r, &z);
if (conf->env) {
if (z) {
session_identity_encode(r, z);
if (z->encoded) {
apr_table_set(r->subprocess_env, HTTP_SESSION, z->encoded);
z->encoded = NULL;
}
}
apr_table_unset(r->headers_in, "Session");
}
return OK;
}
static void *create_session_dir_config(apr_pool_t * p, char *dummy)
{
session_dir_conf *new =
(session_dir_conf *) apr_pcalloc(p, sizeof(session_dir_conf));
new->includes = apr_array_make(p, 10, sizeof(const char **));
new->excludes = apr_array_make(p, 10, sizeof(const char **));
return (void *) new;
}
static void *merge_session_dir_config(apr_pool_t * p, void *basev, void *addv)
{
session_dir_conf *new = (session_dir_conf *) apr_pcalloc(p, sizeof(session_dir_conf));
session_dir_conf *add = (session_dir_conf *) addv;
session_dir_conf *base = (session_dir_conf *) basev;
new->enabled = (add->enabled_set == 0) ? base->enabled : add->enabled;
new->enabled_set = add->enabled_set || base->enabled_set;
new->maxage = (add->maxage_set == 0) ? base->maxage : add->maxage;
new->maxage_set = add->maxage_set || base->maxage_set;
new->header = (add->header_set == 0) ? base->header : add->header;
new->header_set = add->header_set || base->header_set;
new->env = (add->env_set == 0) ? base->env : add->env;
new->env_set = add->env_set || base->env_set;
new->includes = apr_array_append(p, base->includes, add->includes);
new->excludes = apr_array_append(p, base->excludes, add->excludes);
new->expiry_update_time = (add->expiry_update_set == 0)
? base->expiry_update_time
: add->expiry_update_time;
new->expiry_update_set = add->expiry_update_set || base->expiry_update_set;
return new;
}
static const char *
set_session_enable(cmd_parms * parms, void *dconf, int flag)
{
session_dir_conf *conf = dconf;
conf->enabled = flag;
conf->enabled_set = 1;
return NULL;
}
static const char *
set_session_maxage(cmd_parms * parms, void *dconf, const char *arg)
{
session_dir_conf *conf = dconf;
conf->maxage = atol(arg);
conf->maxage_set = 1;
return NULL;
}
static const char *
set_session_header(cmd_parms * parms, void *dconf, const char *arg)
{
session_dir_conf *conf = dconf;
conf->header = arg;
conf->header_set = 1;
return NULL;
}
static const char *
set_session_env(cmd_parms * parms, void *dconf, int flag)
{
session_dir_conf *conf = dconf;
conf->env = flag;
conf->env_set = 1;
return NULL;
}
static const char *add_session_include(cmd_parms * cmd, void *dconf, const char *f)
{
session_dir_conf *conf = dconf;
const char **new = apr_array_push(conf->includes);
*new = f;
return NULL;
}
static const char *add_session_exclude(cmd_parms * cmd, void *dconf, const char *f)
{
session_dir_conf *conf = dconf;
const char **new = apr_array_push(conf->excludes);
*new = f;
return NULL;
}
static const char *
set_session_expiry_update(cmd_parms * parms, void *dconf, const char *arg)
{
session_dir_conf *conf = dconf;
conf->expiry_update_time = atoi(arg);
if (conf->expiry_update_time < 0) {
return "SessionExpiryUpdateInterval must be zero (disable) or a positive value";
}
conf->expiry_update_time = apr_time_from_sec(conf->expiry_update_time);
conf->expiry_update_set = 1;
return NULL;
}
static const command_rec session_cmds[] =
{
AP_INIT_FLAG("Session", set_session_enable, NULL, RSRC_CONF|OR_AUTHCFG,
"on if a session should be maintained for these URLs"),
AP_INIT_TAKE1("SessionMaxAge", set_session_maxage, NULL, RSRC_CONF|OR_AUTHCFG,
"length of time for which a session should be valid. Zero to disable"),
AP_INIT_TAKE1("SessionHeader", set_session_header, NULL, RSRC_CONF|OR_AUTHCFG,
"output header, if present, whose contents will be injected into the session."),
AP_INIT_FLAG("SessionEnv", set_session_env, NULL, RSRC_CONF|OR_AUTHCFG,
"on if a session should be written to the CGI environment. Defaults to off"),
AP_INIT_TAKE1("SessionInclude", add_session_include, NULL, RSRC_CONF|OR_AUTHCFG,
"URL prefixes to include in the session. Defaults to all URLs"),
AP_INIT_TAKE1("SessionExclude", add_session_exclude, NULL, RSRC_CONF|OR_AUTHCFG,
"URL prefixes to exclude from the session. Defaults to no URLs"),
AP_INIT_TAKE1("SessionExpiryUpdateInterval", set_session_expiry_update, NULL, RSRC_CONF|OR_AUTHCFG,
"time interval for which a session's expiry time may change "
"without having to be rewritten. Zero to disable"),
{NULL}
};
static void register_hooks(apr_pool_t * p)
{
ap_register_output_filter("MOD_SESSION_OUT", session_output_filter,
NULL, AP_FTYPE_CONTENT_SET);
ap_hook_insert_filter(session_insert_output_filter, NULL, NULL,
APR_HOOK_MIDDLE);
ap_hook_insert_error_filter(session_insert_output_filter,
NULL, NULL, APR_HOOK_MIDDLE);
ap_hook_fixups(session_fixups, NULL, NULL, APR_HOOK_MIDDLE);
ap_hook_session_encode(session_identity_encode, NULL, NULL,
APR_HOOK_REALLY_FIRST);
ap_hook_session_decode(session_identity_decode, NULL, NULL,
APR_HOOK_REALLY_LAST);
APR_REGISTER_OPTIONAL_FN(ap_session_get);
APR_REGISTER_OPTIONAL_FN(ap_session_set);
APR_REGISTER_OPTIONAL_FN(ap_session_load);
APR_REGISTER_OPTIONAL_FN(ap_session_save);
}
AP_DECLARE_MODULE(session) =
{
STANDARD20_MODULE_STUFF,
create_session_dir_config, /* dir config creater */
merge_session_dir_config, /* dir merger --- default is to override */
NULL, /* server config */
NULL, /* merge server config */
session_cmds, /* command apr_table_t */
register_hooks /* register hooks */
};
|