-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathcgi.c
2472 lines (2211 loc) · 73.9 KB
/
cgi.c
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
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/cgi.c,v $
*
* Purpose : Declares functions to intercept request, generate
* html or gif answers, and to compose HTTP resonses.
* This only contains the framework functions, the
* actual handler functions are declared elsewhere.
*
* Copyright : Written by and Copyright (C) 2001-2017
* members of the Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
* by and Copyright (C) 1997 Anonymous Coders and
* Junkbusters Corporation. http://www.junkbusters.com
*
* This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
* Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will
* be useful, but WITHOUT ANY WARRANTY; without even the
* implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU General Public
* License for more details.
*
* The GNU General Public License should be included with
* this file. If not, you can view it at
* http://www.gnu.org/copyleft/gpl.html
* or write to the Free Software Foundation, Inc., 59
* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
**********************************************************************/
#include "config.h"
#include <stdio.h>
#include <sys/types.h>
#include <stdlib.h>
#include <ctype.h>
#include <string.h>
#include <limits.h>
#include <assert.h>
#ifdef FEATURE_COMPRESSION
#include <zlib.h>
#endif
#include "project.h"
#include "cgi.h"
#include "list.h"
#include "encode.h"
#include "ssplit.h"
#include "errlog.h"
#include "filters.h"
#include "miscutil.h"
#include "cgisimple.h"
#include "jbsockets.h"
#if defined(FEATURE_CGI_EDIT_ACTIONS) || defined(FEATURE_TOGGLE)
#include "cgiedit.h"
#endif /* defined(FEATURE_CGI_EDIT_ACTIONS) || defined (FEATURE_TOGGLE) */
/* loadcfg.h is for global_toggle_state only */
#include "loadcfg.h"
/* jcc.h is for mutex semaphore globals only */
#include "jcc.h"
/*
* List of CGI functions: name, handler, description
* Note: Do NOT use single quotes in the description;
* this will break the dynamic "blocked" template!
*/
static const struct cgi_dispatcher cgi_dispatchers[] = {
{ "",
cgi_default,
"Privoxy main page",
TRUE },
#ifdef FEATURE_GRACEFUL_TERMINATION
{ "die",
cgi_die,
"<b>Shut down</b> - <em class=\"warning\">Do not deploy this build in a production environment, "
"this is a one click Denial Of Service attack!!!</em>",
FALSE },
#endif
{ "show-status",
cgi_show_status,
#ifdef FEATURE_CGI_EDIT_ACTIONS
"View & change the current configuration",
#else
"View the current configuration",
#endif
TRUE },
#ifdef FEATURE_CLIENT_TAGS
/*
* This is marked as harmless because despite the description
* used in the menu the actual toggling is done through another
* path ("/toggle-client-tag").
*/
{ "client-tags",
cgi_show_client_tags,
"View or toggle the tags that can be set based on the clients address",
TRUE },
#endif
{ "show-request",
cgi_show_request,
"View the request headers",
TRUE },
{ "show-url-info",
cgi_show_url_info,
"Look up which actions apply to a URL and why",
TRUE },
#ifdef FEATURE_TOGGLE
{ "toggle",
cgi_toggle,
"Toggle Privoxy on or off",
FALSE },
#endif /* def FEATURE_TOGGLE */
#ifdef FEATURE_CLIENT_TAGS
{ "toggle-client-tag",
cgi_toggle_client_tag,
NULL,
FALSE },
#endif
#ifdef FEATURE_CGI_EDIT_ACTIONS
{ "edit-actions", /* Edit the actions list */
cgi_edit_actions,
NULL, FALSE },
{ "eaa", /* Shortcut for edit-actions-add-url-form */
cgi_edit_actions_add_url_form,
NULL, FALSE },
{ "eau", /* Shortcut for edit-actions-url-form */
cgi_edit_actions_url_form,
NULL, FALSE },
{ "ear", /* Shortcut for edit-actions-remove-url-form */
cgi_edit_actions_remove_url_form,
NULL, FALSE },
{ "eal", /* Shortcut for edit-actions-list */
cgi_edit_actions_list,
NULL, FALSE },
{ "eafu", /* Shortcut for edit-actions-for-url */
cgi_edit_actions_for_url,
NULL, FALSE },
{ "eas", /* Shortcut for edit-actions-submit */
cgi_edit_actions_submit,
NULL, FALSE },
{ "easa", /* Shortcut for edit-actions-section-add */
cgi_edit_actions_section_add,
NULL, FALSE },
{ "easr", /* Shortcut for edit-actions-section-remove */
cgi_edit_actions_section_remove,
NULL, FALSE },
{ "eass", /* Shortcut for edit-actions-section-swap */
cgi_edit_actions_section_swap,
NULL, FALSE },
{ "edit-actions-for-url",
cgi_edit_actions_for_url,
NULL, FALSE /* Edit the actions for (a) specified URL(s) */ },
{ "edit-actions-list",
cgi_edit_actions_list,
NULL, TRUE /* Edit the actions list */ },
{ "edit-actions-submit",
cgi_edit_actions_submit,
NULL, FALSE /* Change the actions for (a) specified URL(s) */ },
{ "edit-actions-url",
cgi_edit_actions_url,
NULL, FALSE /* Change a URL pattern in the actionsfile */ },
{ "edit-actions-url-form",
cgi_edit_actions_url_form,
NULL, FALSE /* Form to change a URL pattern in the actionsfile */ },
{ "edit-actions-add-url",
cgi_edit_actions_add_url,
NULL, FALSE /* Add a URL pattern to the actionsfile */ },
{ "edit-actions-add-url-form",
cgi_edit_actions_add_url_form,
NULL, FALSE /* Form to add a URL pattern to the actionsfile */ },
{ "edit-actions-remove-url",
cgi_edit_actions_remove_url,
NULL, FALSE /* Remove a URL pattern from the actionsfile */ },
{ "edit-actions-remove-url-form",
cgi_edit_actions_remove_url_form,
NULL, FALSE /* Form to remove a URL pattern from the actionsfile */ },
{ "edit-actions-section-add",
cgi_edit_actions_section_add,
NULL, FALSE /* Remove a section from the actionsfile */ },
{ "edit-actions-section-remove",
cgi_edit_actions_section_remove,
NULL, FALSE /* Remove a section from the actionsfile */ },
{ "edit-actions-section-swap",
cgi_edit_actions_section_swap,
NULL, FALSE /* Swap two sections in the actionsfile */ },
#endif /* def FEATURE_CGI_EDIT_ACTIONS */
{ "error-favicon.ico",
cgi_send_error_favicon,
NULL, TRUE /* Sends the favicon image for error pages. */ },
{ "favicon.ico",
cgi_send_default_favicon,
NULL, TRUE /* Sends the default favicon image. */ },
{ "robots.txt",
cgi_robots_txt,
NULL, TRUE /* Sends a robots.txt file to tell robots to go away. */ },
{ "send-banner",
cgi_send_banner,
NULL, TRUE /* Send a built-in image */ },
{ "send-stylesheet",
cgi_send_stylesheet,
NULL, FALSE /* Send templates/cgi-style.css */ },
{ "t",
cgi_transparent_image,
NULL, TRUE /* Send a transparent image (short name) */ },
{ "url-info-osd.xml",
cgi_send_url_info_osd,
NULL, TRUE /* Send templates/url-info-osd.xml */ },
{ "user-manual",
cgi_send_user_manual,
NULL, TRUE /* Send user-manual */ },
{ NULL, /* NULL Indicates end of list and default page */
cgi_error_404,
NULL, TRUE /* Unknown CGI page */ }
};
/*
* Built-in images for ad replacement
*
* Hint: You can encode your own images like this:
* cat your-image | perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o", unpack("C", $c)); }'
*/
#ifdef FEATURE_NO_GIFS
/*
* Checkerboard pattern, as a PNG.
*/
const char image_pattern_data[] =
"\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104"
"\122\000\000\000\004\000\000\000\004\010\006\000\000\000\251"
"\361\236\176\000\000\000\006\142\113\107\104\000\000\000\000"
"\000\000\371\103\273\177\000\000\000\033\111\104\101\124\010"
"\327\143\140\140\140\060\377\377\377\077\003\234\106\341\060"
"\060\230\063\020\124\001\000\161\021\031\241\034\364\030\143"
"\000\000\000\000\111\105\116\104\256\102\140\202";
/*
* 1x1 transparant PNG.
*/
const char image_blank_data[] =
"\211\120\116\107\015\012\032\012\000\000\000\015\111\110\104\122"
"\000\000\000\001\000\000\000\001\001\003\000\000\000\045\333\126"
"\312\000\000\000\003\120\114\124\105\377\377\377\247\304\033\310"
"\000\000\000\001\164\122\116\123\000\100\346\330\146\000\000\000"
"\001\142\113\107\104\000\210\005\035\110\000\000\000\012\111\104"
"\101\124\170\001\143\140\000\000\000\002\000\001\163\165\001\030"
"\000\000\000\000\111\105\116\104\256\102\140\202";
#else
/*
* Checkerboard pattern, as a GIF.
*/
const char image_pattern_data[] =
"\107\111\106\070\071\141\004\000\004\000\200\000\000\310\310"
"\310\377\377\377\041\376\016\111\040\167\141\163\040\141\040"
"\142\141\156\156\145\162\000\041\371\004\001\012\000\001\000"
"\054\000\000\000\000\004\000\004\000\000\002\005\104\174\147"
"\270\005\000\073";
/*
* 1x1 transparant GIF.
*/
const char image_blank_data[] =
"GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
"\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
"\000\001\000\000\002\002D\001\000;";
#endif
const size_t image_pattern_length = sizeof(image_pattern_data) - 1;
const size_t image_blank_length = sizeof(image_blank_data) - 1;
#ifdef FEATURE_COMPRESSION
/*
* Minimum length which a buffer has to reach before
* we bother to (re-)compress it. Completely arbitrary.
*/
const size_t LOWER_LENGTH_LIMIT_FOR_COMPRESSION = 1024U;
#endif
static struct http_response cgi_error_memory_response[1];
static struct http_response *dispatch_known_cgi(struct client_state * csp,
const char * path);
static struct map *parse_cgi_parameters(char *argstring);
/*********************************************************************
*
* Function : dispatch_cgi
*
* Description : Checks if a request URL has either the magical
* hostname CGI_SITE_1_HOST (usually http://p.p/) or
* matches CGI_SITE_2_HOST CGI_SITE_2_PATH (usually
* http://config.privoxy.org/). If so, it passes
* the (rest of the) path onto dispatch_known_cgi, which
* calls the relevant CGI handler function.
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
*
* Returns : http_response if match, NULL if nonmatch or handler fail
*
*********************************************************************/
struct http_response *dispatch_cgi(struct client_state *csp)
{
const char *host = csp->http->host;
const char *path = csp->http->path;
/*
* Should we intercept ?
*/
/* Note: "example.com" and "example.com." are equivalent hostnames. */
/* Either the host matches CGI_SITE_1_HOST ..*/
if ( ( (0 == strcmpic(host, CGI_SITE_1_HOST))
|| (0 == strcmpic(host, CGI_SITE_1_HOST ".")))
&& (path[0] == '/'))
{
/* ..then the path will all be for us. Remove leading '/' */
path++;
}
/* Or it's the host part CGI_SITE_2_HOST, and the path CGI_SITE_2_PATH */
else if (( (0 == strcmpic(host, CGI_SITE_2_HOST))
|| (0 == strcmpic(host, CGI_SITE_2_HOST ".")))
&& (0 == strncmpic(path, CGI_SITE_2_PATH, strlen(CGI_SITE_2_PATH))))
{
/* take everything following CGI_SITE_2_PATH */
path += strlen(CGI_SITE_2_PATH);
if (*path == '/')
{
/* skip the forward slash after CGI_SITE_2_PATH */
path++;
}
else if (*path != '\0')
{
/*
* weirdness: URL is /configXXX, where XXX is some string
* Do *NOT* intercept.
*/
return NULL;
}
}
else
{
/* Not a CGI */
return NULL;
}
if (strcmpic(csp->http->gpc, "GET")
&& strcmpic(csp->http->gpc, "HEAD"))
{
log_error(LOG_LEVEL_ERROR,
"CGI request with unsupported method received: %s", csp->http->gpc);
/*
* The CGI pages currently only support GET and HEAD requests.
*
* If the client used a different method, ditch any data following
* the current headers to reduce the likelihood of parse errors
* with the following request.
*/
csp->client_iob->eod = csp->client_iob->cur;
}
/*
* This is a CGI call.
*/
return dispatch_known_cgi(csp, path);
}
/*********************************************************************
*
* Function : grep_cgi_referrer
*
* Description : Ugly provisorical fix that greps the value of the
* referer HTTP header field out of a linked list of
* strings like found at csp->headers. Will disappear
* in Privoxy 3.1.
*
* FIXME: csp->headers ought to be csp->http->headers
* FIXME: Parsing all client header lines should
* happen right after the request is received!
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
*
* Returns : pointer to value (no copy!), or NULL if none found.
*
*********************************************************************/
static char *grep_cgi_referrer(const struct client_state *csp)
{
struct list_entry *p;
for (p = csp->headers->first; p != NULL; p = p->next)
{
if (p->str == NULL) continue;
if (strncmpic(p->str, "Referer: ", 9) == 0)
{
return ((p->str) + 9);
}
}
return NULL;
}
/*********************************************************************
*
* Function : referrer_is_safe
*
* Description : Decides whether we trust the Referer for
* CGI pages which are only meant to be reachable
* through Privoxy's web interface directly.
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
*
* Returns : TRUE if the referrer is safe, or
* FALSE if the referrer is unsafe or not set.
*
*********************************************************************/
static int referrer_is_safe(const struct client_state *csp)
{
char *referrer;
static const char alternative_prefix[] = "http://" CGI_SITE_1_HOST "/";
const char *trusted_cgi_referrer = csp->config->trusted_cgi_referrer;
referrer = grep_cgi_referrer(csp);
if (NULL == referrer)
{
/* No referrer, no access */
log_error(LOG_LEVEL_ERROR, "Denying access to %s. No referrer found.",
csp->http->url);
}
else if ((0 == strncmp(referrer, CGI_PREFIX, sizeof(CGI_PREFIX)-1)
|| (0 == strncmp(referrer, alternative_prefix, strlen(alternative_prefix)))))
{
/* Trustworthy referrer */
log_error(LOG_LEVEL_CGI, "Granting access to %s, referrer %s is trustworthy.",
csp->http->url, referrer);
return TRUE;
}
else if ((trusted_cgi_referrer != NULL) && (0 == strncmp(referrer,
trusted_cgi_referrer, strlen(trusted_cgi_referrer))))
{
/*
* After some more testing this block should be merged with
* the previous one or the log level should bedowngraded.
*/
log_error(LOG_LEVEL_INFO, "Granting access to %s based on trusted referrer %s",
csp->http->url, referrer);
return TRUE;
}
else
{
/* Untrustworthy referrer */
log_error(LOG_LEVEL_ERROR, "Denying access to %s, referrer %s isn't trustworthy.",
csp->http->url, referrer);
}
return FALSE;
}
/*********************************************************************
*
* Function : dispatch_known_cgi
*
* Description : Processes a CGI once dispatch_cgi has determined that
* it matches one of the magic prefixes. Parses the path
* as a cgi name plus query string, prepares a map that
* maps CGI parameter names to their values, initializes
* the http_response struct, and calls the relevant CGI
* handler function.
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
* 2 : path = Path of CGI, with the CGI prefix removed.
* Should not have a leading "/".
*
* Returns : http_response, or NULL on handler failure or out of
* memory.
*
*********************************************************************/
static struct http_response *dispatch_known_cgi(struct client_state * csp,
const char * path)
{
const struct cgi_dispatcher *d;
struct map *param_list;
struct http_response *rsp;
char *query_args_start;
char *path_copy;
jb_err err;
if (NULL == (path_copy = strdup(path)))
{
return cgi_error_memory();
}
query_args_start = path_copy;
while (*query_args_start && *query_args_start != '?' && *query_args_start != '/')
{
query_args_start++;
}
if (*query_args_start == '/')
{
*query_args_start++ = '\0';
param_list = new_map();
err = map(param_list, "file", 1, url_decode(query_args_start), 0);
if (JB_ERR_OK != err) {
free(param_list);
free(path_copy);
return cgi_error_memory();
}
}
else
{
if (*query_args_start == '?')
{
*query_args_start++ = '\0';
}
if (NULL == (param_list = parse_cgi_parameters(query_args_start)))
{
free(path_copy);
return cgi_error_memory();
}
}
/*
* At this point:
* path_copy = CGI call name
* param_list = CGI params, as map
*/
/* Get mem for response or fail*/
if (NULL == (rsp = alloc_http_response()))
{
free(path_copy);
free_map(param_list);
return cgi_error_memory();
}
/*
* Find and start the right CGI function
*/
d = cgi_dispatchers;
for (;;)
{
if ((d->name == NULL) || (strcmp(path_copy, d->name) == 0))
{
/*
* If the called CGI is either harmless, or referred
* from a trusted source, start it.
*/
if (d->harmless || referrer_is_safe(csp))
{
err = (d->handler)(csp, rsp, param_list);
}
else
{
/*
* Else, modify toggle calls so that they only display
* the status, and deny all other calls.
*/
if (0 == strcmp(path_copy, "toggle"))
{
unmap(param_list, "set");
err = (d->handler)(csp, rsp, param_list);
}
else
{
err = cgi_error_disabled(csp, rsp);
}
}
free(path_copy);
free_map(param_list);
if (err == JB_ERR_CGI_PARAMS)
{
err = cgi_error_bad_param(csp, rsp);
}
if (err && (err != JB_ERR_MEMORY))
{
/* Unexpected error! Shouldn't get here */
log_error(LOG_LEVEL_ERROR,
"Unexpected CGI error %d in top-level handler. "
"Please file a bug report!", err);
err = cgi_error_unknown(csp, rsp, err);
}
if (!err)
{
/* It worked */
rsp->crunch_reason = CGI_CALL;
return finish_http_response(csp, rsp);
}
else
{
/* Error in handler, probably out-of-memory */
free_http_response(rsp);
return cgi_error_memory();
}
}
d++;
}
}
/*********************************************************************
*
* Function : parse_cgi_parameters
*
* Description : Parse a URL-encoded argument string into name/value
* pairs and store them in a struct map list.
*
* Parameters :
* 1 : argstring = string to be parsed. Will be trashed.
*
* Returns : pointer to param list, or NULL if out of memory.
*
*********************************************************************/
static struct map *parse_cgi_parameters(char *argstring)
{
char *p;
char **vector;
int pairs, i;
struct map *cgi_params;
/*
* XXX: This estimate is guaranteed to be high enough as we
* let ssplit() ignore empty fields, but also a bit wasteful.
* The same hack is used in get_last_url() so it looks like
* a real solution is needed.
*/
size_t max_segments = strlen(argstring) / 2;
if (max_segments == 0)
{
/*
* XXX: If the argstring is empty, there's really
* no point in creating a param list, but currently
* other parts of Privoxy depend on the list's existence.
*/
max_segments = 1;
}
vector = malloc_or_die(max_segments * sizeof(char *));
cgi_params = new_map();
/*
* IE 5 does, of course, violate RFC 2316 Sect 4.1 and sends
* the fragment identifier along with the request, so we must
* cut it off here, so it won't pollute the CGI params:
*/
if (NULL != (p = strchr(argstring, '#')))
{
*p = '\0';
}
pairs = ssplit(argstring, "&", vector, max_segments);
assert(pairs != -1);
if (pairs == -1)
{
freez(vector);
free_map(cgi_params);
return NULL;
}
for (i = 0; i < pairs; i++)
{
if ((NULL != (p = strchr(vector[i], '='))) && (*(p+1) != '\0'))
{
*p = '\0';
if (map(cgi_params, url_decode(vector[i]), 0, url_decode(++p), 0))
{
freez(vector);
free_map(cgi_params);
return NULL;
}
}
}
freez(vector);
return cgi_params;
}
/*********************************************************************
*
* Function : get_char_param
*
* Description : Get a single-character parameter passed to a CGI
* function.
*
* Parameters :
* 1 : parameters = map of cgi parameters
* 2 : param_name = The name of the parameter to read
*
* Returns : Uppercase character on success, '\0' on error.
*
*********************************************************************/
char get_char_param(const struct map *parameters,
const char *param_name)
{
char ch;
assert(parameters);
assert(param_name);
ch = *(lookup(parameters, param_name));
if ((ch >= 'a') && (ch <= 'z'))
{
ch = (char)(ch - 'a' + 'A');
}
return ch;
}
/*********************************************************************
*
* Function : get_string_param
*
* Description : Get a string paramater, to be used as an
* ACTION_STRING or ACTION_MULTI paramater.
* Validates the input to prevent stupid/malicious
* users from corrupting their action file.
*
* Parameters :
* 1 : parameters = map of cgi parameters
* 2 : param_name = The name of the parameter to read
* 3 : pparam = destination for paramater. Allocated as
* part of the map "parameters", so don't free it.
* Set to NULL if not specified.
*
* Returns : JB_ERR_OK on success, or if the paramater
* was not specified.
* JB_ERR_MEMORY on out-of-memory.
* JB_ERR_CGI_PARAMS if the paramater is not valid.
*
*********************************************************************/
jb_err get_string_param(const struct map *parameters,
const char *param_name,
const char **pparam)
{
const char *param;
const char *s;
char ch;
assert(parameters);
assert(param_name);
assert(pparam);
*pparam = NULL;
param = lookup(parameters, param_name);
if (!*param)
{
return JB_ERR_OK;
}
if (strlen(param) >= CGI_PARAM_LEN_MAX)
{
/*
* Too long.
*
* Note that the length limit is arbitrary, it just seems
* sensible to limit it to *something*. There's no
* technical reason for any limit at all.
*/
return JB_ERR_CGI_PARAMS;
}
/* Check every character to see if it's legal */
s = param;
while ((ch = *s++) != '\0')
{
if (((unsigned char)ch < (unsigned char)' ')
|| (ch == '}'))
{
/* Probable hack attempt, or user accidentally used '}'. */
return JB_ERR_CGI_PARAMS;
}
}
/* Success */
*pparam = param;
return JB_ERR_OK;
}
/*********************************************************************
*
* Function : get_number_param
*
* Description : Get a non-negative integer from the parameters
* passed to a CGI function.
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
* 2 : parameters = map of cgi parameters
* 3 : name = Name of CGI parameter to read
* 4 : pvalue = destination for value.
* Set to -1 on error.
*
* Returns : JB_ERR_OK on success
* JB_ERR_MEMORY on out-of-memory
* JB_ERR_CGI_PARAMS if the parameter was not specified
* or is not valid.
*
*********************************************************************/
jb_err get_number_param(struct client_state *csp,
const struct map *parameters,
char *name,
unsigned *pvalue)
{
const char *param;
char *endptr;
assert(csp);
assert(parameters);
assert(name);
assert(pvalue);
*pvalue = 0;
param = lookup(parameters, name);
if (!*param)
{
return JB_ERR_CGI_PARAMS;
}
*pvalue = (unsigned int)strtol(param, &endptr, 0);
if (*endptr != '\0')
{
return JB_ERR_CGI_PARAMS;
}
return JB_ERR_OK;
}
/*********************************************************************
*
* Function : error_response
*
* Description : returns an http_response that explains the reason
* why a request failed.
*
* Parameters :
* 1 : csp = Current client state (buffers, headers, etc...)
* 2 : templatename = Which template should be used for the answer
*
* Returns : A http_response. If we run out of memory, this
* will be cgi_error_memory().
*
*********************************************************************/
struct http_response *error_response(struct client_state *csp,
const char *templatename)
{
jb_err err;
struct http_response *rsp;
struct map *exports = default_exports(csp, NULL);
char *path = NULL;
if (exports == NULL)
{
return cgi_error_memory();
}
if (NULL == (rsp = alloc_http_response()))
{
free_map(exports);
return cgi_error_memory();
}
#ifdef FEATURE_FORCE_LOAD
if (csp->flags & CSP_FLAG_FORCED)
{
path = strdup(FORCE_PREFIX);
}
else
#endif /* def FEATURE_FORCE_LOAD */
{
path = strdup("");
}
err = string_append(&path, csp->http->path);
if (!err) err = map(exports, "host", 1, html_encode(csp->http->host), 0);
if (!err) err = map(exports, "hostport", 1, html_encode(csp->http->hostport), 0);
if (!err) err = map(exports, "path", 1, html_encode_and_free_original(path), 0);
if (!err) err = map(exports, "protocol", 1, csp->http->ssl ? "https://" : "http://", 1);
if (!err)
{
err = map(exports, "host-ip", 1, html_encode(csp->http->host_ip_addr_str), 0);
if (err)
{
/* Some failures, like "404 no such domain", don't have an IP address. */
err = map(exports, "host-ip", 1, html_encode(csp->http->host), 0);
}
}
if (err)
{
free_map(exports);
free_http_response(rsp);
return cgi_error_memory();
}
if (!strcmp(templatename, "no-such-domain"))
{
rsp->status = strdup("404 No such domain");
rsp->crunch_reason = NO_SUCH_DOMAIN;
}
else if (!strcmp(templatename, "forwarding-failed"))
{
const struct forward_spec *fwd = forward_url(csp, csp->http);
char *socks_type = NULL;
if (fwd == NULL)
{
log_error(LOG_LEVEL_FATAL, "gateway spec is NULL. This shouldn't happen!");
/* Never get here - LOG_LEVEL_FATAL causes program exit */
}
/*
* XXX: While the template is called forwarding-failed,
* it currently only handles socks forwarding failures.
*/
assert(fwd != NULL);
assert(fwd->type != SOCKS_NONE);
/*
* Map failure reason, forwarding type and forwarder.
*/
if (NULL == csp->error_message)
{
/*
* Either we forgot to record the failure reason,
* or the memory allocation failed.
*/
log_error(LOG_LEVEL_ERROR, "Socks failure reason missing.");
csp->error_message = strdup("Failure reason missing. Check the log file for details.");
}
if (!err) err = map(exports, "gateway", 1, fwd->gateway_host, 1);
/*
* XXX: this is almost the same code as in cgi_show_url_info()
* and thus should be factored out and shared.
*/
switch (fwd->type)
{
case SOCKS_4:
socks_type = "socks4-";
break;
case SOCKS_4A:
socks_type = "socks4a-";
break;
case SOCKS_5:
socks_type = "socks5-";
break;
case SOCKS_5T:
socks_type = "socks5t-";
break;
default:
log_error(LOG_LEVEL_FATAL, "Unknown socks type: %d.", fwd->type);
}
if (!err) err = map(exports, "forwarding-type", 1, socks_type, 1);
if (!err) err = map(exports, "error-message", 1, html_encode(csp->error_message), 0);
if ((NULL == csp->error_message) || err)
{
free_map(exports);
free_http_response(rsp);
return cgi_error_memory();
}
rsp->status = strdup("503 Forwarding failure");
rsp->crunch_reason = FORWARDING_FAILED;
}
else if (!strcmp(templatename, "connect-failed"))
{
rsp->status = strdup("503 Connect failed");
rsp->crunch_reason = CONNECT_FAILED;