]> git.ipfire.org Git - thirdparty/squid.git/blob - src/cache_cf.cc
SourceFormat Enforcement
[thirdparty/squid.git] / src / cache_cf.cc
1 /*
2 * Copyright (C) 1996-2016 The Squid Software Foundation and contributors
3 *
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
7 */
8
9 /* DEBUG: section 03 Configuration File Parsing */
10
11 #include "squid.h"
12 #include "acl/Acl.h"
13 #include "acl/AclDenyInfoList.h"
14 #include "acl/AclNameList.h"
15 #include "acl/AclSizeLimit.h"
16 #include "acl/Address.h"
17 #include "acl/Gadgets.h"
18 #include "acl/MethodData.h"
19 #include "acl/Tree.h"
20 #include "anyp/PortCfg.h"
21 #include "anyp/UriScheme.h"
22 #include "AuthReg.h"
23 #include "base/RunnersRegistry.h"
24 #include "cache_cf.h"
25 #include "CachePeer.h"
26 #include "ConfigParser.h"
27 #include "CpuAffinityMap.h"
28 #include "DiskIO/DiskIOModule.h"
29 #include "eui/Config.h"
30 #include "ExternalACL.h"
31 #include "format/Format.h"
32 #include "ftp/Elements.h"
33 #include "globals.h"
34 #include "HttpHeaderTools.h"
35 #include "icmp/IcmpConfig.h"
36 #include "ident/Config.h"
37 #include "ip/Intercept.h"
38 #include "ip/QosConfig.h"
39 #include "ip/tools.h"
40 #include "ipc/Kids.h"
41 #include "log/Config.h"
42 #include "log/CustomLog.h"
43 #include "MemBuf.h"
44 #include "mgr/ActionPasswordList.h"
45 #include "mgr/Registration.h"
46 #include "neighbors.h"
47 #include "NeighborTypeDomainList.h"
48 #include "Parsing.h"
49 #include "pconn.h"
50 #include "PeerDigest.h"
51 #include "PeerPoolMgr.h"
52 #include "redirect.h"
53 #include "RefreshPattern.h"
54 #include "rfc1738.h"
55 #include "SBufList.h"
56 #include "SquidConfig.h"
57 #include "SquidString.h"
58 #include "ssl/ProxyCerts.h"
59 #include "Store.h"
60 #include "store/Disk.h"
61 #include "store/Disks.h"
62 #include "StoreFileSystem.h"
63 #include "tools.h"
64 #include "util.h"
65 #include "wordlist.h"
66 /* wccp2 has its own conditional definitions */
67 #include "wccp2.h"
68 #if USE_ADAPTATION
69 #include "adaptation/Config.h"
70 #endif
71 #if ICAP_CLIENT
72 #include "adaptation/icap/Config.h"
73 #endif
74 #if USE_ECAP
75 #include "adaptation/ecap/Config.h"
76 #endif
77 #if USE_OPENSSL
78 #include "ssl/Config.h"
79 #include "ssl/support.h"
80 #endif
81 #if USE_AUTH
82 #include "auth/Config.h"
83 #include "auth/Scheme.h"
84 #endif
85 #if USE_SQUID_ESI
86 #include "esi/Parser.h"
87 #endif
88 #if SQUID_SNMP
89 #include "snmp.h"
90 #endif
91
92 #if HAVE_GLOB_H
93 #include <glob.h>
94 #endif
95 #include <limits>
96 #include <list>
97 #if HAVE_PWD_H
98 #include <pwd.h>
99 #endif
100 #if HAVE_GRP_H
101 #include <grp.h>
102 #endif
103 #if HAVE_SYS_STAT_H
104 #include <sys/stat.h>
105 #endif
106
107 #if USE_OPENSSL
108 #include "ssl/gadgets.h"
109 #endif
110
111 #if USE_ADAPTATION
112 static void parse_adaptation_service_set_type();
113 static void parse_adaptation_service_chain_type();
114 static void parse_adaptation_access_type();
115 #endif
116
117 #if ICAP_CLIENT
118 static void parse_icap_service_type(Adaptation::Icap::Config *);
119 static void dump_icap_service_type(StoreEntry *, const char *, const Adaptation::Icap::Config &);
120 static void free_icap_service_type(Adaptation::Icap::Config *);
121 static void parse_icap_class_type();
122 static void parse_icap_access_type();
123
124 static void parse_icap_service_failure_limit(Adaptation::Icap::Config *);
125 static void dump_icap_service_failure_limit(StoreEntry *, const char *, const Adaptation::Icap::Config &);
126 static void free_icap_service_failure_limit(Adaptation::Icap::Config *);
127 #endif
128
129 #if USE_ECAP
130 static void parse_ecap_service_type(Adaptation::Ecap::Config *);
131 static void dump_ecap_service_type(StoreEntry *, const char *, const Adaptation::Ecap::Config &);
132 static void free_ecap_service_type(Adaptation::Ecap::Config *);
133 #endif
134
135 static peer_t parseNeighborType(const char *s);
136
137 static const char *const T_MILLISECOND_STR = "millisecond";
138 static const char *const T_SECOND_STR = "second";
139 static const char *const T_MINUTE_STR = "minute";
140 static const char *const T_HOUR_STR = "hour";
141 static const char *const T_DAY_STR = "day";
142 static const char *const T_WEEK_STR = "week";
143 static const char *const T_FORTNIGHT_STR = "fortnight";
144 static const char *const T_MONTH_STR = "month";
145 static const char *const T_YEAR_STR = "year";
146 static const char *const T_DECADE_STR = "decade";
147
148 static const char *const B_BYTES_STR = "bytes";
149 static const char *const B_KBYTES_STR = "KB";
150 static const char *const B_MBYTES_STR = "MB";
151 static const char *const B_GBYTES_STR = "GB";
152
153 static const char *const list_sep = ", \t\n\r";
154
155 static void parse_access_log(CustomLog ** customlog_definitions);
156 static int check_null_access_log(CustomLog *customlog_definitions);
157 static void dump_access_log(StoreEntry * entry, const char *name, CustomLog * definitions);
158 static void free_access_log(CustomLog ** definitions);
159 static bool setLogformat(CustomLog *cl, const char *name, const bool dieWhenMissing);
160
161 static void configDoConfigure(void);
162 static void parse_refreshpattern(RefreshPattern **);
163 static uint64_t parseTimeUnits(const char *unit, bool allowMsec);
164 static void parseTimeLine(time_msec_t * tptr, const char *units, bool allowMsec, bool expectMoreArguments);
165 static void parse_u_short(unsigned short * var);
166 static void parse_string(char **);
167 static void default_all(void);
168 static void defaults_if_none(void);
169 static void defaults_postscriptum(void);
170 static int parse_line(char *);
171 static void parse_obsolete(const char *);
172 static void parseBytesLine(size_t * bptr, const char *units);
173 #if USE_OPENSSL
174 static void parseBytesOptionValue(size_t * bptr, const char *units, char const * value);
175 #endif
176 static void parseBytesLineSigned(ssize_t * bptr, const char *units);
177 static size_t parseBytesUnits(const char *unit);
178 static void free_all(void);
179 void requirePathnameExists(const char *name, const char *path);
180 static OBJH dump_config;
181 #if USE_HTTP_VIOLATIONS
182 static void free_HeaderManglers(HeaderManglers **pm);
183 static void dump_http_header_access(StoreEntry * entry, const char *name, const HeaderManglers *manglers);
184 static void parse_http_header_access(HeaderManglers **manglers);
185 #define free_http_header_access free_HeaderManglers
186 static void dump_http_header_replace(StoreEntry * entry, const char *name, const HeaderManglers *manglers);
187 static void parse_http_header_replace(HeaderManglers **manglers);
188 #define free_http_header_replace free_HeaderManglers
189 #endif
190 static void dump_HeaderWithAclList(StoreEntry * entry, const char *name, HeaderWithAclList *headers);
191 static void parse_HeaderWithAclList(HeaderWithAclList **header);
192 static void free_HeaderWithAclList(HeaderWithAclList **header);
193 static void parse_note(Notes *);
194 static void dump_note(StoreEntry *, const char *, Notes &);
195 static void free_note(Notes *);
196 static void parse_denyinfo(AclDenyInfoList ** var);
197 static void dump_denyinfo(StoreEntry * entry, const char *name, AclDenyInfoList * var);
198 static void free_denyinfo(AclDenyInfoList ** var);
199
200 #if USE_WCCPv2
201 static void parse_IpAddress_list(Ip::Address_list **);
202 static void dump_IpAddress_list(StoreEntry *, const char *, const Ip::Address_list *);
203 static void free_IpAddress_list(Ip::Address_list **);
204 #if CURRENTLY_UNUSED
205 static int check_null_IpAddress_list(const Ip::Address_list *);
206 #endif /* CURRENTLY_UNUSED */
207 #endif /* USE_WCCPv2 */
208
209 static void parsePortCfg(AnyP::PortCfgPointer *, const char *protocol);
210 #define parse_PortCfg(l) parsePortCfg((l), token)
211 static void dump_PortCfg(StoreEntry *, const char *, const AnyP::PortCfgPointer &);
212 #define free_PortCfg(h) *(h)=NULL
213
214 #if USE_OPENSSL
215 static void parse_sslproxy_cert_sign(sslproxy_cert_sign **cert_sign);
216 static void dump_sslproxy_cert_sign(StoreEntry *entry, const char *name, sslproxy_cert_sign *cert_sign);
217 static void free_sslproxy_cert_sign(sslproxy_cert_sign **cert_sign);
218 static void parse_sslproxy_cert_adapt(sslproxy_cert_adapt **cert_adapt);
219 static void dump_sslproxy_cert_adapt(StoreEntry *entry, const char *name, sslproxy_cert_adapt *cert_adapt);
220 static void free_sslproxy_cert_adapt(sslproxy_cert_adapt **cert_adapt);
221 static void parse_sslproxy_ssl_bump(acl_access **ssl_bump);
222 static void dump_sslproxy_ssl_bump(StoreEntry *entry, const char *name, acl_access *ssl_bump);
223 static void free_sslproxy_ssl_bump(acl_access **ssl_bump);
224 #endif /* USE_OPENSSL */
225
226 static void parse_ftp_epsv(acl_access **ftp_epsv);
227 static void dump_ftp_epsv(StoreEntry *entry, const char *name, acl_access *ftp_epsv);
228 static void free_ftp_epsv(acl_access **ftp_epsv);
229
230 static void parse_b_size_t(size_t * var);
231 static void parse_b_int64_t(int64_t * var);
232
233 static bool parseNamedIntList(const char *data, const String &name, std::vector<int> &list);
234
235 static void parse_CpuAffinityMap(CpuAffinityMap **const cpuAffinityMap);
236 static void dump_CpuAffinityMap(StoreEntry *const entry, const char *const name, const CpuAffinityMap *const cpuAffinityMap);
237 static void free_CpuAffinityMap(CpuAffinityMap **const cpuAffinityMap);
238
239 static void parse_UrlHelperTimeout(SquidConfig::UrlHelperTimeout *);
240 static void dump_UrlHelperTimeout(StoreEntry *, const char *, SquidConfig::UrlHelperTimeout &);
241 static void free_UrlHelperTimeout(SquidConfig::UrlHelperTimeout *);
242
243 static int parseOneConfigFile(const char *file_name, unsigned int depth);
244
245 static void parse_configuration_includes_quoted_values(bool *recognizeQuotedValues);
246 static void dump_configuration_includes_quoted_values(StoreEntry *const entry, const char *const name, bool recognizeQuotedValues);
247 static void free_configuration_includes_quoted_values(bool *recognizeQuotedValues);
248 static void parse_on_unsupported_protocol(acl_access **access);
249 static void dump_on_unsupported_protocol(StoreEntry *entry, const char *name, acl_access *access);
250 static void free_on_unsupported_protocol(acl_access **access);
251
252 /*
253 * LegacyParser is a parser for legacy code that uses the global
254 * approach. This is static so that it is only exposed to cache_cf.
255 * Other modules needing access to a ConfigParser should have it
256 * provided to them in their parserFOO methods.
257 */
258 static ConfigParser LegacyParser = ConfigParser();
259
260 void
261 self_destruct(void)
262 {
263 LegacyParser.destruct();
264 }
265
266 static void
267 SetConfigFilename(char const *file_name, bool is_pipe)
268 {
269 if (is_pipe)
270 cfg_filename = file_name + 1;
271 else
272 cfg_filename = file_name;
273 }
274
275 static const char*
276 skip_ws(const char* s)
277 {
278 while (xisspace(*s))
279 ++s;
280
281 return s;
282 }
283
284 static int
285 parseManyConfigFiles(char* files, int depth)
286 {
287 int error_count = 0;
288 char* saveptr = NULL;
289 #if HAVE_GLOB
290 char *path;
291 glob_t globbuf;
292 int i;
293 memset(&globbuf, 0, sizeof(globbuf));
294 for (path = strwordtok(files, &saveptr); path; path = strwordtok(NULL, &saveptr)) {
295 if (glob(path, globbuf.gl_pathc ? GLOB_APPEND : 0, NULL, &globbuf) != 0) {
296 fatalf("Unable to find configuration file: %s: %s",
297 path, xstrerror());
298 }
299 }
300 for (i = 0; i < (int)globbuf.gl_pathc; ++i) {
301 error_count += parseOneConfigFile(globbuf.gl_pathv[i], depth);
302 }
303 globfree(&globbuf);
304 #else
305 char* file = strwordtok(files, &saveptr);
306 while (file != NULL) {
307 error_count += parseOneConfigFile(file, depth);
308 file = strwordtok(NULL, &saveptr);
309 }
310 #endif /* HAVE_GLOB */
311 return error_count;
312 }
313
314 static void
315 ReplaceSubstr(char*& str, int& len, unsigned substrIdx, unsigned substrLen, const char* newSubstr)
316 {
317 assert(str != NULL);
318 assert(newSubstr != NULL);
319
320 unsigned newSubstrLen = strlen(newSubstr);
321 if (newSubstrLen > substrLen)
322 str = (char*)realloc(str, len - substrLen + newSubstrLen + 1);
323
324 // move tail part including zero
325 memmove(str + substrIdx + newSubstrLen, str + substrIdx + substrLen, len - substrIdx - substrLen + 1);
326 // copy new substring in place
327 memcpy(str + substrIdx, newSubstr, newSubstrLen);
328
329 len = strlen(str);
330 }
331
332 static void
333 SubstituteMacro(char*& line, int& len, const char* macroName, const char* substStr)
334 {
335 assert(line != NULL);
336 assert(macroName != NULL);
337 assert(substStr != NULL);
338 unsigned macroNameLen = strlen(macroName);
339 while (const char* macroPos = strstr(line, macroName)) // we would replace all occurrences
340 ReplaceSubstr(line, len, macroPos - line, macroNameLen, substStr);
341 }
342
343 static void
344 ProcessMacros(char*& line, int& len)
345 {
346 SubstituteMacro(line, len, "${service_name}", service_name.c_str());
347 SubstituteMacro(line, len, "${process_name}", TheKidName);
348 SubstituteMacro(line, len, "${process_number}", xitoa(KidIdentifier));
349 }
350
351 static void
352 trim_trailing_ws(char* str)
353 {
354 assert(str != NULL);
355 unsigned i = strlen(str);
356 while ((i > 0) && xisspace(str[i - 1]))
357 --i;
358 str[i] = '\0';
359 }
360
361 static const char*
362 FindStatement(const char* line, const char* statement)
363 {
364 assert(line != NULL);
365 assert(statement != NULL);
366
367 const char* str = skip_ws(line);
368 unsigned len = strlen(statement);
369 if (strncmp(str, statement, len) == 0) {
370 str += len;
371 if (*str == '\0')
372 return str;
373 else if (xisspace(*str))
374 return skip_ws(str);
375 }
376
377 return NULL;
378 }
379
380 static bool
381 StrToInt(const char* str, long& number)
382 {
383 assert(str != NULL);
384
385 char* end;
386 number = strtol(str, &end, 0);
387
388 return (end != str) && (*end == '\0'); // returns true if string contains nothing except number
389 }
390
391 static bool
392 EvalBoolExpr(const char* expr)
393 {
394 assert(expr != NULL);
395 if (strcmp(expr, "true") == 0) {
396 return true;
397 } else if (strcmp(expr, "false") == 0) {
398 return false;
399 } else if (const char* equation = strchr(expr, '=')) {
400 const char* rvalue = skip_ws(equation + 1);
401 char* lvalue = (char*)xmalloc(equation - expr + 1);
402 xstrncpy(lvalue, expr, equation - expr + 1);
403 trim_trailing_ws(lvalue);
404
405 long number1;
406 if (!StrToInt(lvalue, number1))
407 fatalf("String is not a integer number: '%s'\n", lvalue);
408 long number2;
409 if (!StrToInt(rvalue, number2))
410 fatalf("String is not a integer number: '%s'\n", rvalue);
411
412 xfree(lvalue);
413 return number1 == number2;
414 }
415 fatalf("Unable to evaluate expression '%s'\n", expr);
416 return false; // this place cannot be reached
417 }
418
419 static int
420 parseOneConfigFile(const char *file_name, unsigned int depth)
421 {
422 FILE *fp = NULL;
423 const char *orig_cfg_filename = cfg_filename;
424 const int orig_config_lineno = config_lineno;
425 char *token = NULL;
426 char *tmp_line = NULL;
427 int tmp_line_len = 0;
428 int err_count = 0;
429 int is_pipe = 0;
430
431 debugs(3, DBG_IMPORTANT, "Processing Configuration File: " << file_name << " (depth " << depth << ")");
432 if (depth > 16) {
433 fatalf("WARNING: can't include %s: includes are nested too deeply (>16)!\n", file_name);
434 return 1;
435 }
436
437 if (file_name[0] == '!' || file_name[0] == '|') {
438 fp = popen(file_name + 1, "r");
439 is_pipe = 1;
440 } else {
441 fp = fopen(file_name, "r");
442 }
443
444 if (fp == NULL)
445 fatalf("Unable to open configuration file: %s: %s", file_name, xstrerror());
446
447 #if _SQUID_WINDOWS_
448 setmode(fileno(fp), O_TEXT);
449 #endif
450
451 SetConfigFilename(file_name, bool(is_pipe));
452
453 memset(config_input_line, '\0', BUFSIZ);
454
455 config_lineno = 0;
456
457 std::vector<bool> if_states;
458 while (fgets(config_input_line, BUFSIZ, fp)) {
459 ++config_lineno;
460
461 if ((token = strchr(config_input_line, '\n')))
462 *token = '\0';
463
464 if ((token = strchr(config_input_line, '\r')))
465 *token = '\0';
466
467 // strip any prefix whitespace off the line.
468 const char *p = skip_ws(config_input_line);
469 if (config_input_line != p)
470 memmove(config_input_line, p, strlen(p)+1);
471
472 if (strncmp(config_input_line, "#line ", 6) == 0) {
473 static char new_file_name[1024];
474 static char *file;
475 static char new_lineno;
476 token = config_input_line + 6;
477 new_lineno = strtol(token, &file, 0) - 1;
478
479 if (file == token)
480 continue; /* Not a valid #line directive, may be a comment */
481
482 while (*file && xisspace((unsigned char) *file))
483 ++file;
484
485 if (*file) {
486 if (*file != '"')
487 continue; /* Not a valid #line directive, may be a comment */
488
489 xstrncpy(new_file_name, file + 1, sizeof(new_file_name));
490
491 if ((token = strchr(new_file_name, '"')))
492 *token = '\0';
493
494 SetConfigFilename(new_file_name, false);
495 }
496
497 config_lineno = new_lineno;
498 }
499
500 if (config_input_line[0] == '#')
501 continue;
502
503 if (config_input_line[0] == '\0')
504 continue;
505
506 const char* append = tmp_line_len ? skip_ws(config_input_line) : config_input_line;
507
508 size_t append_len = strlen(append);
509
510 tmp_line = (char*)xrealloc(tmp_line, tmp_line_len + append_len + 1);
511
512 strcpy(tmp_line + tmp_line_len, append);
513
514 tmp_line_len += append_len;
515
516 if (tmp_line[tmp_line_len-1] == '\\') {
517 debugs(3, 5, "parseConfigFile: tmp_line='" << tmp_line << "'");
518 tmp_line[--tmp_line_len] = '\0';
519 continue;
520 }
521
522 trim_trailing_ws(tmp_line);
523 ProcessMacros(tmp_line, tmp_line_len);
524 debugs(3, (opt_parse_cfg_only?1:5), "Processing: " << tmp_line);
525
526 if (const char* expr = FindStatement(tmp_line, "if")) {
527 if_states.push_back(EvalBoolExpr(expr)); // store last if-statement meaning
528 } else if (FindStatement(tmp_line, "endif")) {
529 if (!if_states.empty())
530 if_states.pop_back(); // remove last if-statement meaning
531 else
532 fatalf("'endif' without 'if'\n");
533 } else if (FindStatement(tmp_line, "else")) {
534 if (!if_states.empty())
535 if_states.back() = !if_states.back();
536 else
537 fatalf("'else' without 'if'\n");
538 } else if (if_states.empty() || if_states.back()) { // test last if-statement meaning if present
539 /* Handle includes here */
540 if (tmp_line_len >= 9 && strncmp(tmp_line, "include", 7) == 0 && xisspace(tmp_line[7])) {
541 err_count += parseManyConfigFiles(tmp_line + 8, depth + 1);
542 } else if (!parse_line(tmp_line)) {
543 debugs(3, DBG_CRITICAL, HERE << cfg_filename << ":" << config_lineno << " unrecognized: '" << tmp_line << "'");
544 ++err_count;
545 }
546 }
547
548 safe_free(tmp_line);
549 tmp_line_len = 0;
550
551 }
552 if (!if_states.empty())
553 fatalf("if-statement without 'endif'\n");
554
555 if (is_pipe) {
556 int ret = pclose(fp);
557
558 if (ret != 0)
559 fatalf("parseConfigFile: '%s' failed with exit code %d\n", file_name, ret);
560 } else {
561 fclose(fp);
562 }
563
564 SetConfigFilename(orig_cfg_filename, false);
565 config_lineno = orig_config_lineno;
566
567 xfree(tmp_line);
568 return err_count;
569 }
570
571 int
572 parseConfigFile(const char *file_name)
573 {
574 int err_count = 0;
575
576 debugs(5, 4, HERE);
577
578 configFreeMemory();
579
580 ACLMethodData::ThePurgeCount = 0;
581 default_all();
582
583 err_count = parseOneConfigFile(file_name, 0);
584
585 defaults_if_none();
586
587 defaults_postscriptum();
588
589 /*
590 * We must call configDoConfigure() before leave_suid() because
591 * configDoConfigure() is where we turn username strings into
592 * uid values.
593 */
594 configDoConfigure();
595
596 if (!Config.chroot_dir) {
597 leave_suid();
598 setUmask(Config.umask);
599 _db_init(Debug::cache_log, Debug::debugOptions);
600 enter_suid();
601 }
602
603 if (opt_send_signal == -1) {
604 Mgr::RegisterAction("config",
605 "Current Squid Configuration",
606 dump_config,
607 1, 1);
608 }
609
610 return err_count;
611 }
612
613 static void
614 configDoConfigure(void)
615 {
616 memset(&Config2, '\0', sizeof(SquidConfig2));
617 /* init memory as early as possible */
618 memConfigure();
619 /* Sanity checks */
620
621 Config.cacheSwap.n_strands = 0; // no diskers by default
622 if (Config.cacheSwap.swapDirs == NULL) {
623 /* Memory-only cache probably in effect. */
624 /* turn off the cache rebuild delays... */
625 StoreController::store_dirs_rebuilding = 0;
626 } else if (InDaemonMode()) { // no diskers in non-daemon mode
627 for (int i = 0; i < Config.cacheSwap.n_configured; ++i) {
628 const RefCount<SwapDir> sd = Config.cacheSwap.swapDirs[i];
629 if (sd->needsDiskStrand())
630 sd->disker = Config.workers + (++Config.cacheSwap.n_strands);
631 }
632 }
633
634 if (Debug::rotateNumber < 0) {
635 Debug::rotateNumber = Config.Log.rotateNumber;
636 }
637
638 #if SIZEOF_OFF_T <= 4
639 if (Config.Store.maxObjectSize > 0x7FFF0000) {
640 debugs(3, DBG_CRITICAL, "WARNING: This Squid binary can not handle files larger than 2GB. Limiting maximum_object_size to just below 2GB");
641 Config.Store.maxObjectSize = 0x7FFF0000;
642 }
643 #endif
644
645 if (Config.Announce.period > 0) {
646 Config.onoff.announce = 1;
647 } else {
648 Config.Announce.period = 86400 * 365; /* one year */
649 Config.onoff.announce = 0;
650 }
651
652 if (Config.onoff.httpd_suppress_version_string)
653 visible_appname_string = (char *)appname_string;
654 else
655 visible_appname_string = (char const *)APP_FULLNAME;
656
657 if (Config.Program.redirect) {
658 if (Config.redirectChildren.n_max < 1) {
659 Config.redirectChildren.n_max = 0;
660 wordlistDestroy(&Config.Program.redirect);
661 }
662 }
663
664 if (Config.Program.store_id) {
665 if (Config.storeIdChildren.n_max < 1) {
666 Config.storeIdChildren.n_max = 0;
667 wordlistDestroy(&Config.Program.store_id);
668 }
669 }
670
671 if (Config.appendDomain)
672 if (*Config.appendDomain != '.')
673 fatal("append_domain must begin with a '.'");
674
675 if (Config.errHtmlText == NULL)
676 Config.errHtmlText = xstrdup(null_string);
677
678 #if !HAVE_SETRLIMIT || !defined(RLIMIT_NOFILE)
679 if (Config.max_filedescriptors > 0) {
680 debugs(0, DBG_IMPORTANT, "WARNING: max_filedescriptors disabled. Operating System setrlimit(RLIMIT_NOFILE) is missing.");
681 }
682 #elif USE_SELECT || USE_SELECT_WIN32
683 if (Config.max_filedescriptors > FD_SETSIZE) {
684 debugs(0, DBG_IMPORTANT, "WARNING: max_filedescriptors limited to " << FD_SETSIZE << " by select() algorithm.");
685 }
686 #endif
687
688 storeConfigure();
689
690 snprintf(ThisCache, sizeof(ThisCache), "%s (%s)",
691 uniqueHostname(),
692 visible_appname_string);
693
694 /*
695 * the extra space is for loop detection in client_side.c -- we search
696 * for substrings in the Via header.
697 */
698 snprintf(ThisCache2, sizeof(ThisCache), " %s (%s)",
699 uniqueHostname(),
700 visible_appname_string);
701
702 /* Use visible_hostname as default surrogate_id */
703 if (!Config.Accel.surrogate_id) {
704 const char *t = getMyHostname();
705 Config.Accel.surrogate_id = xstrdup( (t?t:"unset-id") );
706 }
707
708 if (!Config.udpMaxHitObjsz || Config.udpMaxHitObjsz > SQUID_UDP_SO_SNDBUF)
709 Config.udpMaxHitObjsz = SQUID_UDP_SO_SNDBUF;
710
711 if (Config.appendDomain)
712 Config.appendDomainLen = strlen(Config.appendDomain);
713 else
714 Config.appendDomainLen = 0;
715
716 if (Config.connect_retries > 10) {
717 debugs(0,DBG_CRITICAL, "WARNING: connect_retries cannot be larger than 10. Resetting to 10.");
718 Config.connect_retries = 10;
719 }
720
721 requirePathnameExists("MIME Config Table", Config.mimeTablePathname);
722 #if USE_UNLINKD
723
724 requirePathnameExists("unlinkd_program", Config.Program.unlinkd);
725 #endif
726 requirePathnameExists("logfile_daemon", Log::TheConfig.logfile_daemon);
727 if (Config.Program.redirect)
728 requirePathnameExists("redirect_program", Config.Program.redirect->key);
729
730 if (Config.Program.store_id)
731 requirePathnameExists("store_id_program", Config.Program.store_id->key);
732
733 requirePathnameExists("Icon Directory", Config.icons.directory);
734
735 if (Config.errorDirectory)
736 requirePathnameExists("Error Directory", Config.errorDirectory);
737
738 #if USE_HTTP_VIOLATIONS
739
740 {
741 const RefreshPattern *R;
742
743 for (R = Config.Refresh; R; R = R->next) {
744 if (!R->flags.override_expire)
745 continue;
746
747 debugs(22, DBG_IMPORTANT, "WARNING: use of 'override-expire' in 'refresh_pattern' violates HTTP");
748
749 break;
750 }
751
752 for (R = Config.Refresh; R; R = R->next) {
753 if (!R->flags.override_lastmod)
754 continue;
755
756 debugs(22, DBG_IMPORTANT, "WARNING: use of 'override-lastmod' in 'refresh_pattern' violates HTTP");
757
758 break;
759 }
760
761 for (R = Config.Refresh; R; R = R->next) {
762 if (!R->flags.reload_into_ims)
763 continue;
764
765 debugs(22, DBG_IMPORTANT, "WARNING: use of 'reload-into-ims' in 'refresh_pattern' violates HTTP");
766
767 break;
768 }
769
770 for (R = Config.Refresh; R; R = R->next) {
771 if (!R->flags.ignore_reload)
772 continue;
773
774 debugs(22, DBG_IMPORTANT, "WARNING: use of 'ignore-reload' in 'refresh_pattern' violates HTTP");
775
776 break;
777 }
778
779 for (R = Config.Refresh; R; R = R->next) {
780 if (!R->flags.ignore_no_store)
781 continue;
782
783 debugs(22, DBG_IMPORTANT, "WARNING: use of 'ignore-no-store' in 'refresh_pattern' violates HTTP");
784
785 break;
786 }
787
788 for (R = Config.Refresh; R; R = R->next) {
789 if (!R->flags.ignore_private)
790 continue;
791
792 debugs(22, DBG_IMPORTANT, "WARNING: use of 'ignore-private' in 'refresh_pattern' violates HTTP");
793
794 break;
795 }
796 }
797 #endif
798 #if !USE_HTTP_VIOLATIONS
799 Config.onoff.via = 1;
800 #else
801
802 if (!Config.onoff.via)
803 debugs(22, DBG_IMPORTANT, "WARNING: HTTP requires the use of Via");
804
805 #endif
806
807 // we enable runtime PURGE checks if there is at least one PURGE method ACL
808 // TODO: replace with a dedicated "purge" ACL option?
809 Config2.onoff.enable_purge = (ACLMethodData::ThePurgeCount > 0);
810
811 Config2.onoff.mangle_request_headers = (Config.request_header_access != NULL);
812
813 if (geteuid() == 0) {
814 if (NULL != Config.effectiveUser) {
815
816 struct passwd *pwd = getpwnam(Config.effectiveUser);
817
818 if (NULL == pwd) {
819 /*
820 * Andres Kroonmaa <andre@online.ee>:
821 * Some getpwnam() implementations (Solaris?) require
822 * an available FD < 256 for opening a FILE* to the
823 * passwd file.
824 * DW:
825 * This should be safe at startup, but might still fail
826 * during reconfigure.
827 */
828 fatalf("getpwnam failed to find userid for effective user '%s'",
829 Config.effectiveUser);
830 return;
831 }
832
833 Config2.effectiveUserID = pwd->pw_uid;
834
835 Config2.effectiveGroupID = pwd->pw_gid;
836
837 #if HAVE_PUTENV
838 if (pwd->pw_dir && *pwd->pw_dir) {
839 // putenv() leaks by design; avoid leaks when nothing changes
840 static SBuf lastDir;
841 if (lastDir.isEmpty() || !lastDir.cmp(pwd->pw_dir)) {
842 lastDir = pwd->pw_dir;
843 int len = strlen(pwd->pw_dir) + 6;
844 char *env_str = (char *)xcalloc(len, 1);
845 snprintf(env_str, len, "HOME=%s", pwd->pw_dir);
846 putenv(env_str);
847 }
848 }
849 #endif
850 }
851 } else {
852 Config2.effectiveUserID = geteuid();
853 Config2.effectiveGroupID = getegid();
854 }
855
856 if (NULL != Config.effectiveGroup) {
857
858 struct group *grp = getgrnam(Config.effectiveGroup);
859
860 if (NULL == grp) {
861 fatalf("getgrnam failed to find groupid for effective group '%s'",
862 Config.effectiveGroup);
863 return;
864 }
865
866 Config2.effectiveGroupID = grp->gr_gid;
867 }
868
869 #if USE_OPENSSL
870 if (Config.ssl_client.foreignIntermediateCertsPath)
871 Ssl::loadSquidUntrusted(Config.ssl_client.foreignIntermediateCertsPath);
872 #endif
873
874 if (Security::ProxyOutgoingConfig.encryptTransport) {
875 debugs(3, DBG_IMPORTANT, "Initializing https:// proxy context");
876 Config.ssl_client.sslContext = Security::ProxyOutgoingConfig.createClientContext(false);
877 if (!Config.ssl_client.sslContext) {
878 #if USE_OPENSSL
879 fatal("ERROR: Could not initialize https:// proxy context");
880 #else
881 debugs(3, DBG_IMPORTANT, "ERROR: proxying https:// currently still requires --with-openssl");
882 #endif
883 }
884 #if USE_OPENSSL
885 Ssl::useSquidUntrusted(Config.ssl_client.sslContext);
886 #endif
887 }
888
889 for (CachePeer *p = Config.peers; p != NULL; p = p->next) {
890
891 // default value for ssldomain= is the peer host/IP
892 if (p->secure.sslDomain.isEmpty())
893 p->secure.sslDomain = p->host;
894
895 if (p->secure.encryptTransport) {
896 debugs(3, DBG_IMPORTANT, "Initializing cache_peer " << p->name << " TLS context");
897 p->sslContext = p->secure.createClientContext(true);
898 if (!p->sslContext) {
899 debugs(3, DBG_CRITICAL, "ERROR: Could not initialize cache_peer " << p->name << " TLS context");
900 self_destruct();
901 }
902 }
903 }
904
905 #if USE_OPENSSL
906 for (AnyP::PortCfgPointer s = HttpPortList; s != NULL; s = s->next) {
907 if (!s->secure.encryptTransport)
908 continue;
909 debugs(3, DBG_IMPORTANT, "Initializing " << AnyP::UriScheme(s->transport.protocol) << "_port " << s->s << " TLS context");
910 s->configureSslServerContext();
911 }
912 #endif
913
914 // prevent infinite fetch loops in the request parser
915 // due to buffer full but not enough data recived to finish parse
916 if (Config.maxRequestBufferSize <= Config.maxRequestHeaderSize) {
917 fatalf("Client request buffer of %u bytes cannot hold a request with %u bytes of headers." \
918 " Change client_request_buffer_max or request_header_max_size limits.",
919 (uint32_t)Config.maxRequestBufferSize, (uint32_t)Config.maxRequestHeaderSize);
920 }
921
922 /*
923 * Disable client side request pipelining if client_persistent_connections OFF.
924 * Waste of resources queueing any pipelined requests when the first will close the connection.
925 */
926 if (Config.pipeline_max_prefetch > 0 && !Config.onoff.client_pconns) {
927 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: pipeline_prefetch " << Config.pipeline_max_prefetch <<
928 " requires client_persistent_connections ON. Forced pipeline_prefetch 0.");
929 Config.pipeline_max_prefetch = 0;
930 }
931
932 #if USE_AUTH
933 /*
934 * disable client side request pipelining. There is a race with
935 * Negotiate and NTLM when the client sends a second request on an
936 * connection before the authenticate challenge is sent. With
937 * pipelining OFF, the client may fail to authenticate, but squid's
938 * state will be preserved.
939 */
940 if (Config.pipeline_max_prefetch > 0) {
941 Auth::Config *nego = Auth::Config::Find("Negotiate");
942 Auth::Config *ntlm = Auth::Config::Find("NTLM");
943 if ((nego && nego->active()) || (ntlm && ntlm->active())) {
944 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: pipeline_prefetch breaks NTLM and Negotiate authentication. Forced pipeline_prefetch 0.");
945 Config.pipeline_max_prefetch = 0;
946 }
947 }
948 #endif
949 }
950
951 /** Parse a line containing an obsolete directive.
952 * To upgrade it where possible instead of just "Bungled config" for
953 * directives which cannot be marked as simply aliases of the some name.
954 * For example if the parameter order and content has changed.
955 * Or if the directive has been completely removed.
956 */
957 void
958 parse_obsolete(const char *name)
959 {
960 // Directives which have been radically changed rather than removed
961 if (!strcmp(name, "url_rewrite_concurrency")) {
962 int cval;
963 parse_int(&cval);
964 debugs(3, DBG_CRITICAL, "WARNING: url_rewrite_concurrency upgrade overriding url_rewrite_children settings.");
965 Config.redirectChildren.concurrency = cval;
966 }
967
968 if (!strcmp(name, "log_access"))
969 self_destruct();
970
971 if (!strcmp(name, "log_icap"))
972 self_destruct();
973
974 if (!strcmp(name, "ignore_ims_on_miss")) {
975 // the replacement directive cache_revalidate_on_miss has opposite meanings for ON/OFF value
976 // than the 2.7 directive. We need to parse and invert the configured value.
977 int temp = 0;
978 parse_onoff(&temp);
979 Config.onoff.cache_miss_revalidate = !temp;
980 }
981
982 if (!strncmp(name, "sslproxy_", 9)) {
983 // the replacement directive tls_outgoing_options uses options instead of whole-line input
984 SBuf tmp;
985 if (!strcmp(name, "sslproxy_cafile"))
986 tmp.append("cafile=");
987 else if (!strcmp(name, "sslproxy_capath"))
988 tmp.append("capath=");
989 else if (!strcmp(name, "sslproxy_cipher"))
990 tmp.append("cipher=");
991 else if (!strcmp(name, "sslproxy_client_certificate"))
992 tmp.append("cert=");
993 else if (!strcmp(name, "sslproxy_client_key"))
994 tmp.append("key=");
995 else if (!strcmp(name, "sslproxy_flags"))
996 tmp.append("flags=");
997 else if (!strcmp(name, "sslproxy_options"))
998 tmp.append("options=");
999 else if (!strcmp(name, "sslproxy_version"))
1000 tmp.append("version=");
1001 else {
1002 debugs(3, DBG_CRITICAL, "ERROR: unknown directive: " << name);
1003 self_destruct();
1004 }
1005
1006 // add the value as unquoted-string because the old values did not support whitespace
1007 const char *token = ConfigParser::NextQuotedOrToEol();
1008 tmp.append(token, strlen(token));
1009 Security::ProxyOutgoingConfig.parse(tmp.c_str());
1010 }
1011 }
1012
1013 /* Parse a time specification from the config file. Store the
1014 * result in 'tptr', after converting it to 'units' */
1015 static void
1016 parseTimeLine(time_msec_t * tptr, const char *units, bool allowMsec, bool expectMoreArguments = false)
1017 {
1018 time_msec_t u;
1019 if ((u = parseTimeUnits(units, allowMsec)) == 0)
1020 self_destruct();
1021
1022 char *token;
1023 if ((token = ConfigParser::NextToken()) == NULL)
1024 self_destruct();
1025
1026 double d = xatof(token);
1027
1028 time_msec_t m = u; /* default to 'units' if none specified */
1029
1030 if (d) {
1031 if ((token = ConfigParser::PeekAtToken()) && (m = parseTimeUnits(token, allowMsec))) {
1032 (void)ConfigParser::NextToken();
1033
1034 } else if (!expectMoreArguments) {
1035 self_destruct();
1036
1037 } else {
1038 token = NULL; // show default units if dying below
1039 debugs(3, DBG_CRITICAL, "WARNING: No units on '" << config_input_line << "', assuming " << d << " " << units);
1040 }
1041 } else
1042 token = NULL; // show default units if dying below.
1043
1044 *tptr = static_cast<time_msec_t>(m * d);
1045
1046 if (static_cast<double>(*tptr) * 2 != m * d * 2) {
1047 debugs(3, DBG_CRITICAL, "FATAL: Invalid value '" <<
1048 d << " " << (token ? token : units) << ": integer overflow (time_msec_t).");
1049 self_destruct();
1050 }
1051 }
1052
1053 static uint64_t
1054 parseTimeUnits(const char *unit, bool allowMsec)
1055 {
1056 if (allowMsec && !strncasecmp(unit, T_MILLISECOND_STR, strlen(T_MILLISECOND_STR)))
1057 return 1;
1058
1059 if (!strncasecmp(unit, T_SECOND_STR, strlen(T_SECOND_STR)))
1060 return 1000;
1061
1062 if (!strncasecmp(unit, T_MINUTE_STR, strlen(T_MINUTE_STR)))
1063 return 60 * 1000;
1064
1065 if (!strncasecmp(unit, T_HOUR_STR, strlen(T_HOUR_STR)))
1066 return 3600 * 1000;
1067
1068 if (!strncasecmp(unit, T_DAY_STR, strlen(T_DAY_STR)))
1069 return 86400 * 1000;
1070
1071 if (!strncasecmp(unit, T_WEEK_STR, strlen(T_WEEK_STR)))
1072 return 86400 * 7 * 1000;
1073
1074 if (!strncasecmp(unit, T_FORTNIGHT_STR, strlen(T_FORTNIGHT_STR)))
1075 return 86400 * 14 * 1000;
1076
1077 if (!strncasecmp(unit, T_MONTH_STR, strlen(T_MONTH_STR)))
1078 return static_cast<uint64_t>(86400) * 30 * 1000;
1079
1080 if (!strncasecmp(unit, T_YEAR_STR, strlen(T_YEAR_STR)))
1081 return static_cast<uint64_t>(86400 * 1000 * 365.2522);
1082
1083 if (!strncasecmp(unit, T_DECADE_STR, strlen(T_DECADE_STR)))
1084 return static_cast<uint64_t>(86400 * 1000 * 365.2522 * 10);
1085
1086 debugs(3, DBG_IMPORTANT, "parseTimeUnits: unknown time unit '" << unit << "'");
1087
1088 return 0;
1089 }
1090
1091 static void
1092 parseBytesLine64(int64_t * bptr, const char *units)
1093 {
1094 char *token;
1095 double d;
1096 int64_t m;
1097 int64_t u;
1098
1099 if ((u = parseBytesUnits(units)) == 0) {
1100 self_destruct();
1101 return;
1102 }
1103
1104 if ((token = ConfigParser::NextToken()) == NULL) {
1105 self_destruct();
1106 return;
1107 }
1108
1109 if (strcmp(token, "none") == 0 || strcmp(token, "-1") == 0) {
1110 *bptr = -1;
1111 return;
1112 }
1113
1114 d = xatof(token);
1115
1116 m = u; /* default to 'units' if none specified */
1117
1118 if (0.0 == d)
1119 (void) 0;
1120 else if ((token = ConfigParser::NextToken()) == NULL)
1121 debugs(3, DBG_CRITICAL, "WARNING: No units on '" <<
1122 config_input_line << "', assuming " <<
1123 d << " " << units );
1124 else if ((m = parseBytesUnits(token)) == 0) {
1125 self_destruct();
1126 return;
1127 }
1128
1129 *bptr = static_cast<int64_t>(m * d / u);
1130
1131 if (static_cast<double>(*bptr) * 2 != (m * d / u) * 2) {
1132 debugs(3, DBG_CRITICAL, "ERROR: Invalid value '" <<
1133 d << " " << token << ": integer overflow (int64_t).");
1134 self_destruct();
1135 }
1136 }
1137
1138 static void
1139 parseBytesLine(size_t * bptr, const char *units)
1140 {
1141 char *token;
1142 double d;
1143 int m;
1144 int u;
1145
1146 if ((u = parseBytesUnits(units)) == 0) {
1147 self_destruct();
1148 return;
1149 }
1150
1151 if ((token = ConfigParser::NextToken()) == NULL) {
1152 self_destruct();
1153 return;
1154 }
1155
1156 if (strcmp(token, "none") == 0 || strcmp(token, "-1") == 0) {
1157 *bptr = static_cast<size_t>(-1);
1158 return;
1159 }
1160
1161 d = xatof(token);
1162
1163 m = u; /* default to 'units' if none specified */
1164
1165 if (0.0 == d)
1166 (void) 0;
1167 else if ((token = ConfigParser::NextToken()) == NULL)
1168 debugs(3, DBG_CRITICAL, "WARNING: No units on '" <<
1169 config_input_line << "', assuming " <<
1170 d << " " << units );
1171 else if ((m = parseBytesUnits(token)) == 0) {
1172 self_destruct();
1173 return;
1174 }
1175
1176 *bptr = static_cast<size_t>(m * d / u);
1177
1178 if (static_cast<double>(*bptr) * 2 != (m * d / u) * 2) {
1179 debugs(3, DBG_CRITICAL, "ERROR: Invalid value '" <<
1180 d << " " << token << ": integer overflow (size_t).");
1181 self_destruct();
1182 }
1183 }
1184
1185 static void
1186 parseBytesLineSigned(ssize_t * bptr, const char *units)
1187 {
1188 char *token;
1189 double d;
1190 int m;
1191 int u;
1192
1193 if ((u = parseBytesUnits(units)) == 0) {
1194 self_destruct();
1195 return;
1196 }
1197
1198 if ((token = ConfigParser::NextToken()) == NULL) {
1199 self_destruct();
1200 return;
1201 }
1202
1203 if (strcmp(token, "none") == 0 || token[0] == '-' /* -N */) {
1204 *bptr = -1;
1205 return;
1206 }
1207
1208 d = xatof(token);
1209
1210 m = u; /* default to 'units' if none specified */
1211
1212 if (0.0 == d)
1213 (void) 0;
1214 else if ((token = ConfigParser::NextToken()) == NULL)
1215 debugs(3, DBG_CRITICAL, "WARNING: No units on '" <<
1216 config_input_line << "', assuming " <<
1217 d << " " << units );
1218 else if ((m = parseBytesUnits(token)) == 0) {
1219 self_destruct();
1220 return;
1221 }
1222
1223 *bptr = static_cast<ssize_t>(m * d / u);
1224
1225 if (static_cast<double>(*bptr) * 2 != (m * d / u) * 2) {
1226 debugs(3, DBG_CRITICAL, "ERROR: Invalid value '" <<
1227 d << " " << token << ": integer overflow (ssize_t).");
1228 self_destruct();
1229 }
1230 }
1231
1232 /**
1233 * Parse bytes from a string.
1234 * Similar to the parseBytesLine function but parses the string value instead of
1235 * the current token value.
1236 */
1237 static void parseBytesOptionValue(size_t * bptr, const char *units, char const * value)
1238 {
1239 int u;
1240 if ((u = parseBytesUnits(units)) == 0) {
1241 self_destruct();
1242 return;
1243 }
1244
1245 // Find number from string beginning.
1246 char const * number_begin = value;
1247 char const * number_end = value;
1248
1249 while ((*number_end >= '0' && *number_end <= '9')) {
1250 ++number_end;
1251 }
1252
1253 String number;
1254 number.limitInit(number_begin, number_end - number_begin);
1255
1256 int d = xatoi(number.termedBuf());
1257 int m;
1258 if ((m = parseBytesUnits(number_end)) == 0) {
1259 self_destruct();
1260 return;
1261 }
1262
1263 *bptr = static_cast<size_t>(m * d / u);
1264 if (static_cast<double>(*bptr) * 2 != (m * d / u) * 2)
1265 self_destruct();
1266 }
1267
1268 static size_t
1269 parseBytesUnits(const char *unit)
1270 {
1271 if (!strncasecmp(unit, B_BYTES_STR, strlen(B_BYTES_STR)))
1272 return 1;
1273
1274 if (!strncasecmp(unit, B_KBYTES_STR, strlen(B_KBYTES_STR)))
1275 return 1 << 10;
1276
1277 if (!strncasecmp(unit, B_MBYTES_STR, strlen(B_MBYTES_STR)))
1278 return 1 << 20;
1279
1280 if (!strncasecmp(unit, B_GBYTES_STR, strlen(B_GBYTES_STR)))
1281 return 1 << 30;
1282
1283 debugs(3, DBG_CRITICAL, "WARNING: Unknown bytes unit '" << unit << "'");
1284
1285 return 0;
1286 }
1287
1288 static void
1289 dump_SBufList(StoreEntry * entry, const SBufList &words)
1290 {
1291 for (SBufList::const_iterator i = words.begin(); i != words.end(); ++i) {
1292 entry->append(i->rawContent(), i->length());
1293 entry->append(" ",1);
1294 }
1295 entry->append("\n",1);
1296 }
1297
1298 static void
1299 dump_acl(StoreEntry * entry, const char *name, ACL * ae)
1300 {
1301 while (ae != NULL) {
1302 debugs(3, 3, "dump_acl: " << name << " " << ae->name);
1303 storeAppendPrintf(entry, "%s %s %s %s ",
1304 name,
1305 ae->name,
1306 ae->typeString(),
1307 ae->flags.flagsStr());
1308 dump_SBufList(entry, ae->dump());
1309 ae = ae->next;
1310 }
1311 }
1312
1313 static void
1314 parse_acl(ACL ** ae)
1315 {
1316 ACL::ParseAclLine(LegacyParser, ae);
1317 }
1318
1319 static void
1320 free_acl(ACL ** ae)
1321 {
1322 aclDestroyAcls(ae);
1323 }
1324
1325 void
1326 dump_acl_list(StoreEntry * entry, ACLList * head)
1327 {
1328 dump_SBufList(entry, head->dump());
1329 }
1330
1331 void
1332 dump_acl_access(StoreEntry * entry, const char *name, acl_access * head)
1333 {
1334 if (head)
1335 dump_SBufList(entry, head->treeDump(name,NULL));
1336 }
1337
1338 static void
1339 parse_acl_access(acl_access ** head)
1340 {
1341 aclParseAccessLine(cfg_directive, LegacyParser, head);
1342 }
1343
1344 static void
1345 free_acl_access(acl_access ** head)
1346 {
1347 aclDestroyAccessList(head);
1348 }
1349
1350 static void
1351 dump_address(StoreEntry * entry, const char *name, Ip::Address &addr)
1352 {
1353 char buf[MAX_IPSTRLEN];
1354 storeAppendPrintf(entry, "%s %s\n", name, addr.toStr(buf,MAX_IPSTRLEN) );
1355 }
1356
1357 static void
1358 parse_address(Ip::Address *addr)
1359 {
1360 char *token = ConfigParser::NextToken();
1361
1362 if (!token) {
1363 self_destruct();
1364 return;
1365 }
1366
1367 if (!strcmp(token,"any_addr"))
1368 addr->setAnyAddr();
1369 else if ( (!strcmp(token,"no_addr")) || (!strcmp(token,"full_mask")) )
1370 addr->setNoAddr();
1371 else if ( (*addr = token) ) // try parse numeric/IPA
1372 (void) 0;
1373 else if (addr->GetHostByName(token)) // dont use ipcache
1374 (void) 0;
1375 else { // not an IP and not a hostname
1376 debugs(3, DBG_CRITICAL, "FATAL: invalid IP address or domain name '" << token << "'");
1377 self_destruct();
1378 }
1379 }
1380
1381 static void
1382 free_address(Ip::Address *addr)
1383 {
1384 addr->setEmpty();
1385 }
1386
1387 static void
1388 dump_acl_address(StoreEntry * entry, const char *name, Acl::Address * head)
1389 {
1390 char buf[MAX_IPSTRLEN];
1391
1392 for (Acl::Address *l = head; l; l = l->next) {
1393 if (!l->addr.isAnyAddr())
1394 storeAppendPrintf(entry, "%s %s", name, l->addr.toStr(buf,MAX_IPSTRLEN));
1395 else
1396 storeAppendPrintf(entry, "%s autoselect", name);
1397
1398 dump_acl_list(entry, l->aclList);
1399
1400 storeAppendPrintf(entry, "\n");
1401 }
1402 }
1403
1404 static void
1405 parse_acl_address(Acl::Address ** head)
1406 {
1407 Acl::Address *l = new Acl::Address;
1408 parse_address(&l->addr);
1409 aclParseAclList(LegacyParser, &l->aclList, l->addr);
1410
1411 Acl::Address **tail = head;
1412 while (*tail)
1413 tail = &(*tail)->next;
1414
1415 *tail = l;
1416 }
1417
1418 static void
1419 free_acl_address(Acl::Address ** head)
1420 {
1421 delete *head;
1422 *head = NULL;
1423 }
1424
1425 static void
1426 dump_acl_tos(StoreEntry * entry, const char *name, acl_tos * head)
1427 {
1428 acl_tos *l;
1429
1430 for (l = head; l; l = l->next) {
1431 if (l->tos > 0)
1432 storeAppendPrintf(entry, "%s 0x%02X", name, l->tos);
1433 else
1434 storeAppendPrintf(entry, "%s none", name);
1435
1436 dump_acl_list(entry, l->aclList);
1437
1438 storeAppendPrintf(entry, "\n");
1439 }
1440 }
1441
1442 static void
1443 parse_acl_tos(acl_tos ** head)
1444 {
1445 unsigned int tos; /* Initially uint for strtoui. Casted to tos_t before return */
1446 char *token = ConfigParser::NextToken();
1447
1448 if (!token) {
1449 self_destruct();
1450 return;
1451 }
1452
1453 if (!xstrtoui(token, NULL, &tos, 0, std::numeric_limits<tos_t>::max())) {
1454 self_destruct();
1455 return;
1456 }
1457
1458 const unsigned int chTos = tos & 0xFC;
1459 if (chTos != tos) {
1460 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: Tos value '" << tos << "' adjusted to '" << chTos << "'");
1461 tos = chTos;
1462 }
1463
1464 acl_tos *l = new acl_tos;
1465
1466 l->tos = (tos_t)tos;
1467
1468 aclParseAclList(LegacyParser, &l->aclList, token);
1469
1470 acl_tos **tail = head; /* sane name below */
1471 while (*tail)
1472 tail = &(*tail)->next;
1473
1474 *tail = l;
1475 }
1476
1477 static void
1478 free_acl_tos(acl_tos ** head)
1479 {
1480 delete *head;
1481 head = NULL;
1482 }
1483
1484 #if SO_MARK && USE_LIBCAP
1485
1486 static void
1487 dump_acl_nfmark(StoreEntry * entry, const char *name, acl_nfmark * head)
1488 {
1489 for (acl_nfmark *l = head; l; l = l->next) {
1490 if (l->nfmark > 0)
1491 storeAppendPrintf(entry, "%s 0x%02X", name, l->nfmark);
1492 else
1493 storeAppendPrintf(entry, "%s none", name);
1494
1495 dump_acl_list(entry, l->aclList);
1496
1497 storeAppendPrintf(entry, "\n");
1498 }
1499 }
1500
1501 static void
1502 parse_acl_nfmark(acl_nfmark ** head)
1503 {
1504 nfmark_t mark;
1505 char *token = ConfigParser::NextToken();
1506
1507 if (!token) {
1508 self_destruct();
1509 return;
1510 }
1511
1512 if (!xstrtoui(token, NULL, &mark, 0, std::numeric_limits<nfmark_t>::max())) {
1513 self_destruct();
1514 return;
1515 }
1516
1517 acl_nfmark *l = new acl_nfmark;
1518
1519 l->nfmark = mark;
1520
1521 aclParseAclList(LegacyParser, &l->aclList, token);
1522
1523 acl_nfmark **tail = head; /* sane name below */
1524 while (*tail)
1525 tail = &(*tail)->next;
1526
1527 *tail = l;
1528 }
1529
1530 static void
1531 free_acl_nfmark(acl_nfmark ** head)
1532 {
1533 delete *head;
1534 head = NULL;
1535 }
1536 #endif /* SO_MARK */
1537
1538 static void
1539 dump_acl_b_size_t(StoreEntry * entry, const char *name, AclSizeLimit * head)
1540 {
1541 for (AclSizeLimit *l = head; l; l = l->next) {
1542 if (l->size != -1)
1543 storeAppendPrintf(entry, "%s %d %s\n", name, (int) l->size, B_BYTES_STR);
1544 else
1545 storeAppendPrintf(entry, "%s none", name);
1546
1547 dump_acl_list(entry, l->aclList);
1548
1549 storeAppendPrintf(entry, "\n");
1550 }
1551 }
1552
1553 static void
1554 parse_acl_b_size_t(AclSizeLimit ** head)
1555 {
1556 AclSizeLimit *l = new AclSizeLimit;
1557
1558 parse_b_int64_t(&l->size);
1559
1560 aclParseAclList(LegacyParser, &l->aclList, l->size);
1561
1562 AclSizeLimit **tail = head; /* sane name below */
1563 while (*tail)
1564 tail = &(*tail)->next;
1565
1566 *tail = l;
1567 }
1568
1569 static void
1570 free_acl_b_size_t(AclSizeLimit ** head)
1571 {
1572 delete *head;
1573 *head = NULL;
1574 }
1575
1576 #if USE_DELAY_POOLS
1577
1578 #include "DelayConfig.h"
1579 #include "DelayPools.h"
1580 /* do nothing - free_delay_pool_count is the magic free function.
1581 * this is why delay_pool_count isn't just marked TYPE: u_short
1582 */
1583 #define free_delay_pool_class(X)
1584 #define free_delay_pool_access(X)
1585 #define free_delay_pool_rates(X)
1586 #define dump_delay_pool_class(X, Y, Z)
1587 #define dump_delay_pool_access(X, Y, Z)
1588 #define dump_delay_pool_rates(X, Y, Z)
1589
1590 static void
1591 free_delay_pool_count(DelayConfig * cfg)
1592 {
1593 cfg->freePoolCount();
1594 }
1595
1596 static void
1597 dump_delay_pool_count(StoreEntry * entry, const char *name, DelayConfig &cfg)
1598 {
1599 cfg.dumpPoolCount (entry, name);
1600 }
1601
1602 static void
1603 parse_delay_pool_count(DelayConfig * cfg)
1604 {
1605 cfg->parsePoolCount();
1606 }
1607
1608 static void
1609 parse_delay_pool_class(DelayConfig * cfg)
1610 {
1611 cfg->parsePoolClass();
1612 }
1613
1614 static void
1615 parse_delay_pool_rates(DelayConfig * cfg)
1616 {
1617 cfg->parsePoolRates();
1618 }
1619
1620 static void
1621 parse_delay_pool_access(DelayConfig * cfg)
1622 {
1623 cfg->parsePoolAccess(LegacyParser);
1624 }
1625
1626 #endif
1627
1628 #if USE_DELAY_POOLS
1629 #include "ClientDelayConfig.h"
1630 /* do nothing - free_client_delay_pool_count is the magic free function.
1631 * this is why client_delay_pool_count isn't just marked TYPE: u_short
1632 */
1633
1634 #define free_client_delay_pool_access(X)
1635 #define free_client_delay_pool_rates(X)
1636 #define dump_client_delay_pool_access(X, Y, Z)
1637 #define dump_client_delay_pool_rates(X, Y, Z)
1638
1639 static void
1640 free_client_delay_pool_count(ClientDelayConfig * cfg)
1641 {
1642 cfg->freePoolCount();
1643 }
1644
1645 static void
1646 dump_client_delay_pool_count(StoreEntry * entry, const char *name, ClientDelayConfig &cfg)
1647 {
1648 cfg.dumpPoolCount (entry, name);
1649 }
1650
1651 static void
1652 parse_client_delay_pool_count(ClientDelayConfig * cfg)
1653 {
1654 cfg->parsePoolCount();
1655 }
1656
1657 static void
1658 parse_client_delay_pool_rates(ClientDelayConfig * cfg)
1659 {
1660 cfg->parsePoolRates();
1661 }
1662
1663 static void
1664 parse_client_delay_pool_access(ClientDelayConfig * cfg)
1665 {
1666 cfg->parsePoolAccess(LegacyParser);
1667 }
1668 #endif
1669
1670 #if USE_HTTP_VIOLATIONS
1671 static void
1672 dump_http_header_access(StoreEntry * entry, const char *name, const HeaderManglers *manglers)
1673 {
1674 if (manglers)
1675 manglers->dumpAccess(entry, name);
1676 }
1677
1678 static void
1679 parse_http_header_access(HeaderManglers **pm)
1680 {
1681 char *t = NULL;
1682
1683 if ((t = ConfigParser::NextToken()) == NULL) {
1684 debugs(3, DBG_CRITICAL, "" << cfg_filename << " line " << config_lineno << ": " << config_input_line);
1685 debugs(3, DBG_CRITICAL, "parse_http_header_access: missing header name.");
1686 return;
1687 }
1688
1689 if (!*pm)
1690 *pm = new HeaderManglers;
1691 HeaderManglers *manglers = *pm;
1692 headerMangler *mangler = manglers->track(t);
1693 assert(mangler);
1694
1695 std::string directive = "http_header_access ";
1696 directive += t;
1697 aclParseAccessLine(directive.c_str(), LegacyParser, &mangler->access_list);
1698 }
1699
1700 static void
1701 free_HeaderManglers(HeaderManglers **pm)
1702 {
1703 // we delete the entire http_header_* mangler configuration at once
1704 if (const HeaderManglers *manglers = *pm) {
1705 delete manglers;
1706 *pm = NULL;
1707 }
1708 }
1709
1710 static void
1711 dump_http_header_replace(StoreEntry * entry, const char *name, const HeaderManglers *manglers)
1712 {
1713 if (manglers)
1714 manglers->dumpReplacement(entry, name);
1715 }
1716
1717 static void
1718 parse_http_header_replace(HeaderManglers **pm)
1719 {
1720 char *t = NULL;
1721
1722 if ((t = ConfigParser::NextToken()) == NULL) {
1723 debugs(3, DBG_CRITICAL, "" << cfg_filename << " line " << config_lineno << ": " << config_input_line);
1724 debugs(3, DBG_CRITICAL, "parse_http_header_replace: missing header name.");
1725 return;
1726 }
1727
1728 const char *value = ConfigParser::NextQuotedOrToEol();
1729
1730 if (!*pm)
1731 *pm = new HeaderManglers;
1732 HeaderManglers *manglers = *pm;
1733 manglers->setReplacement(t, value);
1734 }
1735
1736 #endif
1737
1738 static void
1739 dump_cachedir(StoreEntry * entry, const char *name, const Store::DiskConfig &swap)
1740 {
1741 SwapDir *s;
1742 int i;
1743 assert (entry);
1744
1745 for (i = 0; i < swap.n_configured; ++i) {
1746 s = dynamic_cast<SwapDir *>(swap.swapDirs[i].getRaw());
1747 if (!s) continue;
1748 storeAppendPrintf(entry, "%s %s %s", name, s->type(), s->path);
1749 s->dump(*entry);
1750 storeAppendPrintf(entry, "\n");
1751 }
1752 }
1753
1754 static int
1755 check_null_string(char *s)
1756 {
1757 return s == NULL;
1758 }
1759
1760 #if USE_AUTH
1761 static void
1762 parse_authparam(Auth::ConfigVector * config)
1763 {
1764 char *type_str;
1765 char *param_str;
1766
1767 if ((type_str = ConfigParser::NextToken()) == NULL)
1768 self_destruct();
1769
1770 if ((param_str = ConfigParser::NextToken()) == NULL)
1771 self_destruct();
1772
1773 /* find a configuration for the scheme in the currently parsed configs... */
1774 Auth::Config *schemeCfg = Auth::Config::Find(type_str);
1775
1776 if (schemeCfg == NULL) {
1777 /* Create a configuration based on the scheme info */
1778 Auth::Scheme::Pointer theScheme = Auth::Scheme::Find(type_str);
1779
1780 if (theScheme == NULL) {
1781 debugs(3, DBG_CRITICAL, "Parsing Config File: Unknown authentication scheme '" << type_str << "'.");
1782 self_destruct();
1783 }
1784
1785 config->push_back(theScheme->createConfig());
1786 schemeCfg = Auth::Config::Find(type_str);
1787 if (schemeCfg == NULL) {
1788 debugs(3, DBG_CRITICAL, "Parsing Config File: Corruption configuring authentication scheme '" << type_str << "'.");
1789 self_destruct();
1790 }
1791 }
1792
1793 schemeCfg->parse(schemeCfg, config->size(), param_str);
1794 }
1795
1796 static void
1797 free_authparam(Auth::ConfigVector * cfg)
1798 {
1799 /* Wipe the Auth globals and Detach/Destruct component config + state. */
1800 cfg->clear();
1801
1802 /* on reconfigure initialize new auth schemes for the new config. */
1803 if (reconfiguring) {
1804 Auth::Init();
1805 }
1806 }
1807
1808 static void
1809 dump_authparam(StoreEntry * entry, const char *name, Auth::ConfigVector cfg)
1810 {
1811 for (Auth::ConfigVector::iterator i = cfg.begin(); i != cfg.end(); ++i)
1812 (*i)->dump(entry, name, (*i));
1813 }
1814 #endif /* USE_AUTH */
1815
1816 /* TODO: just return the object, the # is irrelevant */
1817 static int
1818 find_fstype(char *type)
1819 {
1820 for (size_t i = 0; i < StoreFileSystem::FileSystems().size(); ++i)
1821 if (strcasecmp(type, StoreFileSystem::FileSystems().at(i)->type()) == 0)
1822 return (int)i;
1823
1824 return (-1);
1825 }
1826
1827 static void
1828 parse_cachedir(Store::DiskConfig *swap)
1829 {
1830 char *type_str;
1831 char *path_str;
1832 RefCount<SwapDir> sd;
1833 int i;
1834 int fs;
1835
1836 if ((type_str = ConfigParser::NextToken()) == NULL)
1837 self_destruct();
1838
1839 if ((path_str = ConfigParser::NextToken()) == NULL)
1840 self_destruct();
1841
1842 fs = find_fstype(type_str);
1843
1844 if (fs < 0) {
1845 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT), "ERROR: This proxy does not support the '" << type_str << "' cache type. Ignoring.");
1846 return;
1847 }
1848
1849 /* reconfigure existing dir */
1850
1851 for (i = 0; i < swap->n_configured; ++i) {
1852 assert (swap->swapDirs[i].getRaw());
1853
1854 if ((strcasecmp(path_str, dynamic_cast<SwapDir *>(swap->swapDirs[i].getRaw())->path)) == 0) {
1855 /* this is specific to on-fs Stores. The right
1856 * way to handle this is probably to have a mapping
1857 * from paths to stores, and have on-fs stores
1858 * register with that, and lookip in that in their
1859 * own setup logic. RBC 20041225. TODO.
1860 */
1861
1862 sd = dynamic_cast<SwapDir *>(swap->swapDirs[i].getRaw());
1863
1864 if (strcmp(sd->type(), StoreFileSystem::FileSystems().at(fs)->type()) != 0) {
1865 debugs(3, DBG_CRITICAL, "ERROR: Can't change type of existing cache_dir " <<
1866 sd->type() << " " << sd->path << " to " << type_str << ". Restart required");
1867 return;
1868 }
1869
1870 sd->reconfigure();
1871 return;
1872 }
1873 }
1874
1875 /* new cache_dir */
1876 if (swap->n_configured > 63) {
1877 /* 7 bits, signed */
1878 debugs(3, DBG_CRITICAL, "WARNING: There is a fixed maximum of 63 cache_dir entries Squid can handle.");
1879 debugs(3, DBG_CRITICAL, "WARNING: '" << path_str << "' is one to many.");
1880 self_destruct();
1881 return;
1882 }
1883
1884 allocate_new_swapdir(swap);
1885
1886 swap->swapDirs[swap->n_configured] = StoreFileSystem::FileSystems().at(fs)->createSwapDir();
1887
1888 sd = dynamic_cast<SwapDir *>(swap->swapDirs[swap->n_configured].getRaw());
1889
1890 /* parse the FS parameters and options */
1891 sd->parse(swap->n_configured, path_str);
1892
1893 ++swap->n_configured;
1894 }
1895
1896 static const char *
1897 peer_type_str(const peer_t type)
1898 {
1899 const char * result;
1900
1901 switch (type) {
1902
1903 case PEER_PARENT:
1904 result = "parent";
1905 break;
1906
1907 case PEER_SIBLING:
1908 result = "sibling";
1909 break;
1910
1911 case PEER_MULTICAST:
1912 result = "multicast";
1913 break;
1914
1915 default:
1916 result = "unknown";
1917 break;
1918 }
1919
1920 return result;
1921 }
1922
1923 static void
1924 dump_peer(StoreEntry * entry, const char *name, CachePeer * p)
1925 {
1926 NeighborTypeDomainList *t;
1927 LOCAL_ARRAY(char, xname, 128);
1928
1929 while (p != NULL) {
1930 storeAppendPrintf(entry, "%s %s %s %d %d name=%s",
1931 name,
1932 p->host,
1933 neighborTypeStr(p),
1934 p->http_port,
1935 p->icp.port,
1936 p->name);
1937 dump_peer_options(entry, p);
1938
1939 if (p->access) {
1940 snprintf(xname, 128, "cache_peer_access %s", p->name);
1941 dump_acl_access(entry, xname, p->access);
1942 }
1943
1944 for (t = p->typelist; t; t = t->next) {
1945 storeAppendPrintf(entry, "neighbor_type_domain %s %s %s\n",
1946 p->host,
1947 peer_type_str(t->type),
1948 t->domain);
1949 }
1950
1951 p = p->next;
1952 }
1953 }
1954
1955 /**
1956 * utility function to prevent getservbyname() being called with a numeric value
1957 * on Windows at least it returns garage results.
1958 */
1959 static bool
1960 isUnsignedNumeric(const char *str, size_t len)
1961 {
1962 if (len < 1) return false;
1963
1964 for (; len >0 && *str; ++str, --len) {
1965 if (! isdigit(*str))
1966 return false;
1967 }
1968 return true;
1969 }
1970
1971 /**
1972 \param proto 'tcp' or 'udp' for protocol
1973 \returns Port the named service is supposed to be listening on.
1974 */
1975 static unsigned short
1976 GetService(const char *proto)
1977 {
1978 struct servent *port = NULL;
1979 /** Parses a port number or service name from the squid.conf */
1980 char *token = ConfigParser::NextToken();
1981 if (token == NULL) {
1982 self_destruct();
1983 return 0; /* NEVER REACHED */
1984 }
1985 /** Returns either the service port number from /etc/services */
1986 if ( !isUnsignedNumeric(token, strlen(token)) )
1987 port = getservbyname(token, proto);
1988 if (port != NULL) {
1989 return ntohs((unsigned short)port->s_port);
1990 }
1991 /** Or a numeric translation of the config text. */
1992 return xatos(token);
1993 }
1994
1995 /**
1996 \returns Port the named TCP service is supposed to be listening on.
1997 \copydoc GetService(const char *proto)
1998 */
1999 inline unsigned short
2000 GetTcpService(void)
2001 {
2002 return GetService("tcp");
2003 }
2004
2005 /**
2006 \returns Port the named UDP service is supposed to be listening on.
2007 \copydoc GetService(const char *proto)
2008 */
2009 inline unsigned short
2010 GetUdpService(void)
2011 {
2012 return GetService("udp");
2013 }
2014
2015 static void
2016 parse_peer(CachePeer ** head)
2017 {
2018 char *token = NULL;
2019 CachePeer *p = new CachePeer;
2020
2021 if ((token = ConfigParser::NextToken()) == NULL)
2022 self_destruct();
2023
2024 p->host = xstrdup(token);
2025
2026 p->name = xstrdup(token);
2027
2028 if ((token = ConfigParser::NextToken()) == NULL)
2029 self_destruct();
2030
2031 p->type = parseNeighborType(token);
2032
2033 if (p->type == PEER_MULTICAST) {
2034 p->options.no_digest = true;
2035 p->options.no_netdb_exchange = true;
2036 }
2037
2038 p->http_port = GetTcpService();
2039
2040 if (!p->http_port)
2041 self_destruct();
2042
2043 p->icp.port = GetUdpService();
2044
2045 while ((token = ConfigParser::NextToken())) {
2046 if (!strcmp(token, "proxy-only")) {
2047 p->options.proxy_only = true;
2048 } else if (!strcmp(token, "no-query")) {
2049 p->options.no_query = true;
2050 } else if (!strcmp(token, "background-ping")) {
2051 p->options.background_ping = true;
2052 } else if (!strcmp(token, "no-digest")) {
2053 p->options.no_digest = true;
2054 } else if (!strcmp(token, "no-tproxy")) {
2055 p->options.no_tproxy = true;
2056 } else if (!strcmp(token, "multicast-responder")) {
2057 p->options.mcast_responder = true;
2058 #if PEER_MULTICAST_SIBLINGS
2059 } else if (!strcmp(token, "multicast-siblings")) {
2060 p->options.mcast_siblings = true;
2061 #endif
2062 } else if (!strncmp(token, "weight=", 7)) {
2063 p->weight = xatoi(token + 7);
2064 } else if (!strncmp(token, "basetime=", 9)) {
2065 p->basetime = xatoi(token + 9);
2066 } else if (!strcmp(token, "closest-only")) {
2067 p->options.closest_only = true;
2068 } else if (!strncmp(token, "ttl=", 4)) {
2069 p->mcast.ttl = xatoi(token + 4);
2070
2071 if (p->mcast.ttl < 0)
2072 p->mcast.ttl = 0;
2073
2074 if (p->mcast.ttl > 128)
2075 p->mcast.ttl = 128;
2076 } else if (!strcmp(token, "default")) {
2077 p->options.default_parent = true;
2078 } else if (!strcmp(token, "round-robin")) {
2079 p->options.roundrobin = true;
2080 } else if (!strcmp(token, "weighted-round-robin")) {
2081 p->options.weighted_roundrobin = true;
2082 #if USE_HTCP
2083 } else if (!strcmp(token, "htcp")) {
2084 p->options.htcp = true;
2085 } else if (!strncmp(token, "htcp=", 5) || !strncmp(token, "htcp-", 5)) {
2086 /* Note: The htcp- form is deprecated, replaced by htcp= */
2087 p->options.htcp = true;
2088 char *tmp = xstrdup(token+5);
2089 char *mode, *nextmode;
2090 for (mode = nextmode = tmp; mode; mode = nextmode) {
2091 nextmode = strchr(mode, ',');
2092 if (nextmode) {
2093 *nextmode = '\0';
2094 ++nextmode;
2095 }
2096 if (!strcmp(mode, "no-clr")) {
2097 if (p->options.htcp_only_clr)
2098 fatalf("parse_peer: can't set htcp-no-clr and htcp-only-clr simultaneously");
2099 p->options.htcp_no_clr = true;
2100 } else if (!strcmp(mode, "no-purge-clr")) {
2101 p->options.htcp_no_purge_clr = true;
2102 } else if (!strcmp(mode, "only-clr")) {
2103 if (p->options.htcp_no_clr)
2104 fatalf("parse_peer: can't set htcp no-clr and only-clr simultaneously");
2105 p->options.htcp_only_clr = true;
2106 } else if (!strcmp(mode, "forward-clr")) {
2107 p->options.htcp_forward_clr = true;
2108 } else if (!strcmp(mode, "oldsquid")) {
2109 p->options.htcp_oldsquid = true;
2110 } else {
2111 fatalf("invalid HTCP mode '%s'", mode);
2112 }
2113 }
2114 safe_free(tmp);
2115 #endif
2116 } else if (!strcmp(token, "no-netdb-exchange")) {
2117 p->options.no_netdb_exchange = true;
2118
2119 } else if (!strcmp(token, "carp")) {
2120 if (p->type != PEER_PARENT)
2121 fatalf("parse_peer: non-parent carp peer %s/%d\n", p->host, p->http_port);
2122
2123 p->options.carp = true;
2124 } else if (!strncmp(token, "carp-key=", 9)) {
2125 if (p->options.carp != true)
2126 fatalf("parse_peer: carp-key specified on non-carp peer %s/%d\n", p->host, p->http_port);
2127 p->options.carp_key.set = true;
2128 char *nextkey=token+strlen("carp-key="), *key=nextkey;
2129 for (; key; key = nextkey) {
2130 nextkey=strchr(key,',');
2131 if (nextkey) ++nextkey; // skip the comma, any
2132 if (0==strncmp(key,"scheme",6)) {
2133 p->options.carp_key.scheme = true;
2134 } else if (0==strncmp(key,"host",4)) {
2135 p->options.carp_key.host = true;
2136 } else if (0==strncmp(key,"port",4)) {
2137 p->options.carp_key.port = true;
2138 } else if (0==strncmp(key,"path",4)) {
2139 p->options.carp_key.path = true;
2140 } else if (0==strncmp(key,"params",6)) {
2141 p->options.carp_key.params = true;
2142 } else {
2143 fatalf("invalid carp-key '%s'",key);
2144 }
2145 }
2146 } else if (!strcmp(token, "userhash")) {
2147 #if USE_AUTH
2148 if (p->type != PEER_PARENT)
2149 fatalf("parse_peer: non-parent userhash peer %s/%d\n", p->host, p->http_port);
2150
2151 p->options.userhash = true;
2152 #else
2153 fatalf("parse_peer: userhash requires authentication. peer %s/%d\n", p->host, p->http_port);
2154 #endif
2155 } else if (!strcmp(token, "sourcehash")) {
2156 if (p->type != PEER_PARENT)
2157 fatalf("parse_peer: non-parent sourcehash peer %s/%d\n", p->host, p->http_port);
2158
2159 p->options.sourcehash = true;
2160
2161 } else if (!strcmp(token, "no-delay")) {
2162 #if USE_DELAY_POOLS
2163 p->options.no_delay = true;
2164 #else
2165 debugs(0, DBG_CRITICAL, "WARNING: cache_peer option 'no-delay' requires --enable-delay-pools");
2166 #endif
2167 } else if (!strncmp(token, "login=", 6)) {
2168 p->login = xstrdup(token + 6);
2169 rfc1738_unescape(p->login);
2170 } else if (!strcmp(token, "auth-no-keytab")) {
2171 p->options.auth_no_keytab = 1;
2172 } else if (!strncmp(token, "connect-timeout=", 16)) {
2173 p->connect_timeout = xatoi(token + 16);
2174 } else if (!strncmp(token, "connect-fail-limit=", 19)) {
2175 p->connect_fail_limit = xatoi(token + 19);
2176 #if USE_CACHE_DIGESTS
2177 } else if (!strncmp(token, "digest-url=", 11)) {
2178 p->digest_url = xstrdup(token + 11);
2179 #endif
2180
2181 } else if (!strcmp(token, "allow-miss")) {
2182 p->options.allow_miss = true;
2183 } else if (!strncmp(token, "max-conn=", 9)) {
2184 p->max_conn = xatoi(token + 9);
2185 } else if (!strncmp(token, "standby=", 8)) {
2186 p->standby.limit = xatoi(token + 8);
2187 } else if (!strcmp(token, "originserver")) {
2188 p->options.originserver = true;
2189 } else if (!strncmp(token, "name=", 5)) {
2190 safe_free(p->name);
2191
2192 if (token[5])
2193 p->name = xstrdup(token + 5);
2194 } else if (!strncmp(token, "forceddomain=", 13)) {
2195 safe_free(p->domain);
2196 if (token[13])
2197 p->domain = xstrdup(token + 13);
2198
2199 } else if (strncmp(token, "ssl", 3) == 0) {
2200 #if !USE_OPENSSL
2201 debugs(0, DBG_CRITICAL, "WARNING: cache_peer option '" << token << "' requires --with-openssl");
2202 #else
2203 p->secure.parse(token+3);
2204 #endif
2205 } else if (strncmp(token, "tls-", 4) == 0) {
2206 p->secure.parse(token+4);
2207 } else if (strcmp(token, "front-end-https") == 0) {
2208 p->front_end_https = 1;
2209 } else if (strcmp(token, "front-end-https=on") == 0) {
2210 p->front_end_https = 1;
2211 } else if (strcmp(token, "front-end-https=auto") == 0) {
2212 p->front_end_https = 2;
2213 } else if (strcmp(token, "connection-auth=off") == 0) {
2214 p->connection_auth = 0;
2215 } else if (strcmp(token, "connection-auth") == 0) {
2216 p->connection_auth = 1;
2217 } else if (strcmp(token, "connection-auth=on") == 0) {
2218 p->connection_auth = 1;
2219 } else if (strcmp(token, "connection-auth=auto") == 0) {
2220 p->connection_auth = 2;
2221 } else if (token[0] == '#') {
2222 // start of a text comment. stop reading this line.
2223 break;
2224 } else {
2225 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT), "ERROR: Ignoring unknown cache_peer option '" << token << "'");
2226 }
2227 }
2228
2229 if (peerFindByName(p->name))
2230 fatalf("ERROR: cache_peer %s specified twice\n", p->name);
2231
2232 if (p->max_conn > 0 && p->max_conn < p->standby.limit)
2233 fatalf("ERROR: cache_peer %s max-conn=%d is lower than its standby=%d\n", p->host, p->max_conn, p->standby.limit);
2234
2235 if (p->weight < 1)
2236 p->weight = 1;
2237
2238 if (p->connect_fail_limit < 1)
2239 p->connect_fail_limit = 10;
2240
2241 #if USE_CACHE_DIGESTS
2242
2243 if (!p->options.no_digest) {
2244 /* XXX This looks odd.. who has the original pointer
2245 * then?
2246 */
2247 PeerDigest *pd = peerDigestCreate(p);
2248 p->digest = cbdataReference(pd);
2249 }
2250
2251 #endif
2252
2253 p->index = ++Config.npeers;
2254
2255 while (*head != NULL)
2256 head = &(*head)->next;
2257
2258 *head = p;
2259
2260 peerClearRRStart();
2261 }
2262
2263 static void
2264 free_peer(CachePeer ** P)
2265 {
2266 delete *P;
2267 *P = NULL;
2268 Config.npeers = 0;
2269 }
2270
2271 static void
2272 dump_cachemgrpasswd(StoreEntry * entry, const char *name, Mgr::ActionPasswordList * list)
2273 {
2274 wordlist *w;
2275
2276 while (list != NULL) {
2277 if (strcmp(list->passwd, "none") && strcmp(list->passwd, "disable"))
2278 storeAppendPrintf(entry, "%s XXXXXXXXXX", name);
2279 else
2280 storeAppendPrintf(entry, "%s %s", name, list->passwd);
2281
2282 for (w = list->actions; w != NULL; w = w->next) {
2283 storeAppendPrintf(entry, " %s", w->key);
2284 }
2285
2286 storeAppendPrintf(entry, "\n");
2287 list = list->next;
2288 }
2289 }
2290
2291 static void
2292 parse_cachemgrpasswd(Mgr::ActionPasswordList ** head)
2293 {
2294 char *passwd = NULL;
2295 wordlist *actions = NULL;
2296 Mgr::ActionPasswordList *p;
2297 Mgr::ActionPasswordList **P;
2298 parse_string(&passwd);
2299 parse_wordlist(&actions);
2300 p = new Mgr::ActionPasswordList;
2301 p->passwd = passwd;
2302 p->actions = actions;
2303
2304 for (P = head; *P; P = &(*P)->next) {
2305 /*
2306 * See if any of the actions from this line already have a
2307 * password from previous lines. The password checking
2308 * routines in cache_manager.c take the the password from
2309 * the first Mgr::ActionPasswordList that contains the
2310 * requested action. Thus, we should warn users who might
2311 * think they can have two passwords for the same action.
2312 */
2313 wordlist *w;
2314 wordlist *u;
2315
2316 for (w = (*P)->actions; w; w = w->next) {
2317 for (u = actions; u; u = u->next) {
2318 if (strcmp(w->key, u->key))
2319 continue;
2320
2321 debugs(0, DBG_CRITICAL, "WARNING: action '" << u->key << "' (line " << config_lineno << ") already has a password");
2322 }
2323 }
2324 }
2325
2326 *P = p;
2327 }
2328
2329 static void
2330 free_cachemgrpasswd(Mgr::ActionPasswordList ** head)
2331 {
2332 Mgr::ActionPasswordList *p;
2333
2334 while ((p = *head) != NULL) {
2335 *head = p->next;
2336 xfree(p->passwd);
2337 wordlistDestroy(&p->actions);
2338 xfree(p);
2339 }
2340 }
2341
2342 static void
2343 dump_denyinfo(StoreEntry * entry, const char *name, AclDenyInfoList * var)
2344 {
2345 AclNameList *a;
2346
2347 while (var != NULL) {
2348 storeAppendPrintf(entry, "%s %s", name, var->err_page_name);
2349
2350 for (a = var->acl_list; a != NULL; a = a->next)
2351 storeAppendPrintf(entry, " %s", a->name);
2352
2353 storeAppendPrintf(entry, "\n");
2354
2355 var = var->next;
2356 }
2357 }
2358
2359 static void
2360 parse_denyinfo(AclDenyInfoList ** var)
2361 {
2362 aclParseDenyInfoLine(var);
2363 }
2364
2365 void
2366 free_denyinfo(AclDenyInfoList ** list)
2367 {
2368 AclDenyInfoList *a = NULL;
2369 AclDenyInfoList *a_next = NULL;
2370 AclNameList *l = NULL;
2371 AclNameList *l_next = NULL;
2372
2373 for (a = *list; a; a = a_next) {
2374 for (l = a->acl_list; l; l = l_next) {
2375 l_next = l->next;
2376 memFree(l, MEM_ACL_NAME_LIST);
2377 l = NULL;
2378 }
2379
2380 a_next = a->next;
2381 memFree(a, MEM_ACL_DENY_INFO_LIST);
2382 a = NULL;
2383 }
2384
2385 *list = NULL;
2386 }
2387
2388 static void
2389 parse_peer_access(void)
2390 {
2391 char *host = NULL;
2392 CachePeer *p;
2393
2394 if (!(host = ConfigParser::NextToken()))
2395 self_destruct();
2396
2397 if ((p = peerFindByName(host)) == NULL) {
2398 debugs(15, DBG_CRITICAL, "" << cfg_filename << ", line " << config_lineno << ": No cache_peer '" << host << "'");
2399 return;
2400 }
2401
2402 std::string directive = "peer_access ";
2403 directive += host;
2404 aclParseAccessLine(directive.c_str(), LegacyParser, &p->access);
2405 }
2406
2407 static void
2408 parse_hostdomaintype(void)
2409 {
2410 char *host = NULL;
2411 char *type = NULL;
2412 char *domain = NULL;
2413
2414 if (!(host = ConfigParser::NextToken()))
2415 self_destruct();
2416
2417 if (!(type = ConfigParser::NextToken()))
2418 self_destruct();
2419
2420 while ((domain = ConfigParser::NextToken())) {
2421 NeighborTypeDomainList *l = NULL;
2422 NeighborTypeDomainList **L = NULL;
2423 CachePeer *p;
2424
2425 if ((p = peerFindByName(host)) == NULL) {
2426 debugs(15, DBG_CRITICAL, "" << cfg_filename << ", line " << config_lineno << ": No cache_peer '" << host << "'");
2427 return;
2428 }
2429
2430 l = static_cast<NeighborTypeDomainList *>(xcalloc(1, sizeof(NeighborTypeDomainList)));
2431 l->type = parseNeighborType(type);
2432 l->domain = xstrdup(domain);
2433
2434 for (L = &(p->typelist); *L; L = &((*L)->next));
2435 *L = l;
2436 }
2437 }
2438
2439 static void
2440 dump_int(StoreEntry * entry, const char *name, int var)
2441 {
2442 storeAppendPrintf(entry, "%s %d\n", name, var);
2443 }
2444
2445 void
2446 parse_int(int *var)
2447 {
2448 int i;
2449 i = GetInteger();
2450 *var = i;
2451 }
2452
2453 static void
2454 free_int(int *var)
2455 {
2456 *var = 0;
2457 }
2458
2459 static void
2460 dump_onoff(StoreEntry * entry, const char *name, int var)
2461 {
2462 storeAppendPrintf(entry, "%s %s\n", name, var ? "on" : "off");
2463 }
2464
2465 void
2466 parse_onoff(int *var)
2467 {
2468 char *token = ConfigParser::NextToken();
2469
2470 if (token == NULL)
2471 self_destruct();
2472
2473 if (!strcmp(token, "on")) {
2474 *var = 1;
2475 } else if (!strcmp(token, "enable")) {
2476 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: 'enable' is deprecated. Please update to use 'on'.");
2477 *var = 1;
2478 } else if (!strcmp(token, "off")) {
2479 *var = 0;
2480 } else if (!strcmp(token, "disable")) {
2481 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: 'disable' is deprecated. Please update to use 'off'.");
2482 *var = 0;
2483 } else {
2484 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT), "ERROR: Invalid option: Boolean options can only be 'on' or 'off'.");
2485 self_destruct();
2486 }
2487 }
2488
2489 #define free_onoff free_int
2490
2491 static void
2492 dump_tristate(StoreEntry * entry, const char *name, int var)
2493 {
2494 const char *state;
2495
2496 if (var > 0)
2497 state = "on";
2498 else if (var < 0)
2499 state = "warn";
2500 else
2501 state = "off";
2502
2503 storeAppendPrintf(entry, "%s %s\n", name, state);
2504 }
2505
2506 static void
2507 parse_tristate(int *var)
2508 {
2509 char *token = ConfigParser::NextToken();
2510
2511 if (token == NULL)
2512 self_destruct();
2513
2514 if (!strcmp(token, "on")) {
2515 *var = 1;
2516 } else if (!strcmp(token, "enable")) {
2517 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: 'enable' is deprecated. Please update to use value 'on'.");
2518 *var = 1;
2519 } else if (!strcmp(token, "warn")) {
2520 *var = -1;
2521 } else if (!strcmp(token, "off")) {
2522 *var = 0;
2523 } else if (!strcmp(token, "disable")) {
2524 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: 'disable' is deprecated. Please update to use value 'off'.");
2525 *var = 0;
2526 } else {
2527 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT), "ERROR: Invalid option: Tristate options can only be 'on', 'off', or 'warn'.");
2528 self_destruct();
2529 }
2530 }
2531
2532 #define free_tristate free_int
2533
2534 void
2535 parse_pipelinePrefetch(int *var)
2536 {
2537 char *token = ConfigParser::PeekAtToken();
2538
2539 if (token == NULL)
2540 self_destruct();
2541
2542 if (!strcmp(token, "on")) {
2543 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: 'pipeline_prefetch on' is deprecated. Please update to use 1 (or a higher number).");
2544 *var = 1;
2545 //pop the token
2546 (void)ConfigParser::NextToken();
2547 } else if (!strcmp(token, "off")) {
2548 debugs(0, DBG_PARSE_NOTE(2), "WARNING: 'pipeline_prefetch off' is deprecated. Please update to use '0'.");
2549 *var = 0;
2550 //pop the token
2551 (void)ConfigParser::NextToken();
2552 } else
2553 parse_int(var);
2554 }
2555
2556 #define free_pipelinePrefetch free_int
2557 #define dump_pipelinePrefetch dump_int
2558
2559 static void
2560 dump_refreshpattern(StoreEntry * entry, const char *name, RefreshPattern * head)
2561 {
2562 while (head != NULL) {
2563 storeAppendPrintf(entry, "%s%s %s %d %d%% %d",
2564 name,
2565 head->pattern.flags&REG_ICASE ? " -i" : null_string,
2566 head->pattern.c_str(),
2567 (int) head->min / 60,
2568 (int) (100.0 * head->pct + 0.5),
2569 (int) head->max / 60);
2570
2571 if (head->max_stale >= 0)
2572 storeAppendPrintf(entry, " max-stale=%d", head->max_stale);
2573
2574 if (head->flags.refresh_ims)
2575 storeAppendPrintf(entry, " refresh-ims");
2576
2577 if (head->flags.store_stale)
2578 storeAppendPrintf(entry, " store-stale");
2579
2580 #if USE_HTTP_VIOLATIONS
2581
2582 if (head->flags.override_expire)
2583 storeAppendPrintf(entry, " override-expire");
2584
2585 if (head->flags.override_lastmod)
2586 storeAppendPrintf(entry, " override-lastmod");
2587
2588 if (head->flags.reload_into_ims)
2589 storeAppendPrintf(entry, " reload-into-ims");
2590
2591 if (head->flags.ignore_reload)
2592 storeAppendPrintf(entry, " ignore-reload");
2593
2594 if (head->flags.ignore_no_store)
2595 storeAppendPrintf(entry, " ignore-no-store");
2596
2597 if (head->flags.ignore_private)
2598 storeAppendPrintf(entry, " ignore-private");
2599 #endif
2600
2601 storeAppendPrintf(entry, "\n");
2602
2603 head = head->next;
2604 }
2605 }
2606
2607 static void
2608 parse_refreshpattern(RefreshPattern ** head)
2609 {
2610 char *token;
2611 char *pattern;
2612 time_t min = 0;
2613 double pct = 0.0;
2614 time_t max = 0;
2615 int refresh_ims = 0;
2616 int store_stale = 0;
2617 int max_stale = -1;
2618
2619 #if USE_HTTP_VIOLATIONS
2620
2621 int override_expire = 0;
2622 int override_lastmod = 0;
2623 int reload_into_ims = 0;
2624 int ignore_reload = 0;
2625 int ignore_no_store = 0;
2626 int ignore_private = 0;
2627 #endif
2628
2629 int i;
2630 RefreshPattern *t;
2631 regex_t comp;
2632 int errcode;
2633 int flags = REG_EXTENDED | REG_NOSUB;
2634
2635 if ((token = ConfigParser::RegexPattern()) != NULL) {
2636
2637 if (strcmp(token, "-i") == 0) {
2638 flags |= REG_ICASE;
2639 token = ConfigParser::RegexPattern();
2640 } else if (strcmp(token, "+i") == 0) {
2641 flags &= ~REG_ICASE;
2642 token = ConfigParser::RegexPattern();
2643 }
2644
2645 }
2646
2647 if (token == NULL) {
2648 debugs(3, DBG_CRITICAL, "FATAL: refresh_pattern missing the regex pattern parameter");
2649 self_destruct();
2650 return;
2651 }
2652
2653 pattern = xstrdup(token);
2654
2655 i = GetInteger(); /* token: min */
2656
2657 /* catch negative and insanely huge values close to 32-bit wrap */
2658 if (i < 0) {
2659 debugs(3, DBG_IMPORTANT, "WARNING: refresh_pattern minimum age negative. Cropped back to zero.");
2660 i = 0;
2661 }
2662 if (i > 60*24*365) {
2663 debugs(3, DBG_IMPORTANT, "WARNING: refresh_pattern minimum age too high. Cropped back to 1 year.");
2664 i = 60*24*365;
2665 }
2666
2667 min = (time_t) (i * 60); /* convert minutes to seconds */
2668
2669 pct = GetPercentage(false); /* token: pct . with no limit on size */
2670
2671 i = GetInteger(); /* token: max */
2672
2673 /* catch negative and insanely huge values close to 32-bit wrap */
2674 if (i < 0) {
2675 debugs(3, DBG_IMPORTANT, "WARNING: refresh_pattern maximum age negative. Cropped back to zero.");
2676 i = 0;
2677 }
2678 if (i > 60*24*365) {
2679 debugs(3, DBG_IMPORTANT, "WARNING: refresh_pattern maximum age too high. Cropped back to 1 year.");
2680 i = 60*24*365;
2681 }
2682
2683 max = (time_t) (i * 60); /* convert minutes to seconds */
2684
2685 /* Options */
2686 while ((token = ConfigParser::NextToken()) != NULL) {
2687 if (!strcmp(token, "refresh-ims")) {
2688 refresh_ims = 1;
2689 } else if (!strcmp(token, "store-stale")) {
2690 store_stale = 1;
2691 } else if (!strncmp(token, "max-stale=", 10)) {
2692 max_stale = xatoi(token + 10);
2693
2694 #if USE_HTTP_VIOLATIONS
2695
2696 } else if (!strcmp(token, "override-expire"))
2697 override_expire = 1;
2698 else if (!strcmp(token, "override-lastmod"))
2699 override_lastmod = 1;
2700 else if (!strcmp(token, "ignore-no-store"))
2701 ignore_no_store = 1;
2702 else if (!strcmp(token, "ignore-private"))
2703 ignore_private = 1;
2704 else if (!strcmp(token, "reload-into-ims")) {
2705 reload_into_ims = 1;
2706 refresh_nocache_hack = 1;
2707 /* tell client_side.c that this is used */
2708 } else if (!strcmp(token, "ignore-reload")) {
2709 ignore_reload = 1;
2710 refresh_nocache_hack = 1;
2711 /* tell client_side.c that this is used */
2712 #endif
2713
2714 } else if (!strcmp(token, "ignore-no-cache") ||
2715 !strcmp(token, "ignore-must-revalidate") ||
2716 !strcmp(token, "ignore-auth")
2717 ) {
2718 debugs(22, DBG_PARSE_NOTE(2), "UPGRADE: refresh_pattern option '" << token << "' is obsolete. Remove it.");
2719 } else
2720 debugs(22, DBG_CRITICAL, "refreshAddToList: Unknown option '" << pattern << "': " << token);
2721 }
2722
2723 if ((errcode = regcomp(&comp, pattern, flags)) != 0) {
2724 char errbuf[256];
2725 regerror(errcode, &comp, errbuf, sizeof errbuf);
2726 debugs(22, DBG_CRITICAL, "" << cfg_filename << " line " << config_lineno << ": " << config_input_line);
2727 debugs(22, DBG_CRITICAL, "refreshAddToList: Invalid regular expression '" << pattern << "': " << errbuf);
2728 xfree(pattern);
2729 return;
2730 }
2731
2732 pct = pct < 0.0 ? 0.0 : pct;
2733 max = max < 0 ? 0 : max;
2734 t = new RefreshPattern(pattern, flags);
2735 t->pattern.regex = comp;
2736 t->min = min;
2737 t->pct = pct;
2738 t->max = max;
2739
2740 if (refresh_ims)
2741 t->flags.refresh_ims = true;
2742
2743 if (store_stale)
2744 t->flags.store_stale = true;
2745
2746 t->max_stale = max_stale;
2747
2748 #if USE_HTTP_VIOLATIONS
2749
2750 if (override_expire)
2751 t->flags.override_expire = true;
2752
2753 if (override_lastmod)
2754 t->flags.override_lastmod = true;
2755
2756 if (reload_into_ims)
2757 t->flags.reload_into_ims = true;
2758
2759 if (ignore_reload)
2760 t->flags.ignore_reload = true;
2761
2762 if (ignore_no_store)
2763 t->flags.ignore_no_store = true;
2764
2765 if (ignore_private)
2766 t->flags.ignore_private = true;
2767 #endif
2768
2769 t->next = NULL;
2770
2771 while (*head)
2772 head = &(*head)->next;
2773
2774 *head = t;
2775
2776 xfree(pattern);
2777 }
2778
2779 static void
2780 free_refreshpattern(RefreshPattern ** head)
2781 {
2782 delete *head;
2783 *head = nullptr;
2784
2785 #if USE_HTTP_VIOLATIONS
2786 refresh_nocache_hack = 0;
2787
2788 #endif
2789 }
2790
2791 static void
2792 dump_string(StoreEntry * entry, const char *name, char *var)
2793 {
2794 if (var != NULL)
2795 storeAppendPrintf(entry, "%s %s\n", name, var);
2796 }
2797
2798 static void
2799 parse_string(char **var)
2800 {
2801 char *token = ConfigParser::NextToken();
2802 safe_free(*var);
2803
2804 if (token == NULL)
2805 self_destruct();
2806
2807 *var = xstrdup(token);
2808 }
2809
2810 static void
2811 free_string(char **var)
2812 {
2813 safe_free(*var);
2814 }
2815
2816 void
2817 parse_eol(char *volatile *var)
2818 {
2819 if (!var) {
2820 self_destruct();
2821 return;
2822 }
2823
2824 unsigned char *token = (unsigned char *) ConfigParser::NextQuotedOrToEol();
2825 safe_free(*var);
2826
2827 if (!token) {
2828 self_destruct();
2829 return;
2830 }
2831
2832 while (*token && xisspace(*token))
2833 ++token;
2834
2835 if (!*token) {
2836 self_destruct();
2837 return;
2838 }
2839
2840 *var = xstrdup((char *) token);
2841 }
2842
2843 #define dump_eol dump_string
2844 #define free_eol free_string
2845
2846 static void
2847 parse_TokenOrQuotedString(char **var)
2848 {
2849 char *token = ConfigParser::NextQuotedToken();
2850 safe_free(*var);
2851
2852 if (token == NULL)
2853 self_destruct();
2854
2855 *var = xstrdup(token);
2856 }
2857
2858 #define dump_TokenOrQuotedString dump_string
2859 #define free_TokenOrQuotedString free_string
2860
2861 static void
2862 dump_time_t(StoreEntry * entry, const char *name, time_t var)
2863 {
2864 storeAppendPrintf(entry, "%s %d seconds\n", name, (int) var);
2865 }
2866
2867 void
2868 parse_time_t(time_t * var)
2869 {
2870 time_msec_t tval;
2871 parseTimeLine(&tval, T_SECOND_STR, false);
2872 *var = static_cast<time_t>(tval/1000);
2873 }
2874
2875 static void
2876 free_time_t(time_t * var)
2877 {
2878 *var = 0;
2879 }
2880
2881 static void
2882 dump_time_msec(StoreEntry * entry, const char *name, time_msec_t var)
2883 {
2884 if (var % 1000)
2885 storeAppendPrintf(entry, "%s %" PRId64 " milliseconds\n", name, var);
2886 else
2887 storeAppendPrintf(entry, "%s %d seconds\n", name, (int)(var/1000) );
2888 }
2889
2890 void
2891 parse_time_msec(time_msec_t * var)
2892 {
2893 parseTimeLine(var, T_SECOND_STR, true);
2894 }
2895
2896 static void
2897 free_time_msec(time_msec_t * var)
2898 {
2899 *var = 0;
2900 }
2901
2902 #if UNUSED_CODE
2903 static void
2904 dump_size_t(StoreEntry * entry, const char *name, size_t var)
2905 {
2906 storeAppendPrintf(entry, "%s %d\n", name, (int) var);
2907 }
2908 #endif
2909
2910 static void
2911 dump_b_size_t(StoreEntry * entry, const char *name, size_t var)
2912 {
2913 storeAppendPrintf(entry, "%s %d %s\n", name, (int) var, B_BYTES_STR);
2914 }
2915
2916 static void
2917 dump_b_ssize_t(StoreEntry * entry, const char *name, ssize_t var)
2918 {
2919 storeAppendPrintf(entry, "%s %d %s\n", name, (int) var, B_BYTES_STR);
2920 }
2921
2922 #if UNUSED_CODE
2923 static void
2924 dump_kb_size_t(StoreEntry * entry, const char *name, size_t var)
2925 {
2926 storeAppendPrintf(entry, "%s %d %s\n", name, (int) var, B_KBYTES_STR);
2927 }
2928 #endif
2929
2930 static void
2931 dump_b_int64_t(StoreEntry * entry, const char *name, int64_t var)
2932 {
2933 storeAppendPrintf(entry, "%s %" PRId64 " %s\n", name, var, B_BYTES_STR);
2934 }
2935
2936 static void
2937 dump_kb_int64_t(StoreEntry * entry, const char *name, int64_t var)
2938 {
2939 storeAppendPrintf(entry, "%s %" PRId64 " %s\n", name, var, B_KBYTES_STR);
2940 }
2941
2942 #if UNUSED_CODE
2943 static void
2944 parse_size_t(size_t * var)
2945 {
2946 int i;
2947 i = GetInteger();
2948 *var = (size_t) i;
2949 }
2950 #endif
2951
2952 static void
2953 parse_b_size_t(size_t * var)
2954 {
2955 parseBytesLine(var, B_BYTES_STR);
2956 }
2957
2958 static void
2959 parse_b_ssize_t(ssize_t * var)
2960 {
2961 parseBytesLineSigned(var, B_BYTES_STR);
2962 }
2963
2964 #if UNUSED_CODE
2965 static void
2966 parse_kb_size_t(size_t * var)
2967 {
2968 parseBytesLine(var, B_KBYTES_STR);
2969 }
2970 #endif
2971
2972 static void
2973 parse_b_int64_t(int64_t * var)
2974 {
2975 parseBytesLine64(var, B_BYTES_STR);
2976 }
2977
2978 static void
2979 parse_kb_int64_t(int64_t * var)
2980 {
2981 parseBytesLine64(var, B_KBYTES_STR);
2982 }
2983
2984 static void
2985 free_size_t(size_t * var)
2986 {
2987 *var = 0;
2988 }
2989
2990 static void
2991 free_ssize_t(ssize_t * var)
2992 {
2993 *var = 0;
2994 }
2995
2996 static void
2997 free_b_int64_t(int64_t * var)
2998 {
2999 *var = 0;
3000 }
3001
3002 #define free_b_size_t free_size_t
3003 #define free_b_ssize_t free_ssize_t
3004 #define free_kb_size_t free_size_t
3005 #define free_mb_size_t free_size_t
3006 #define free_gb_size_t free_size_t
3007 #define free_kb_int64_t free_b_int64_t
3008
3009 static void
3010 dump_u_short(StoreEntry * entry, const char *name, unsigned short var)
3011 {
3012 storeAppendPrintf(entry, "%s %d\n", name, var);
3013 }
3014
3015 static void
3016 free_u_short(unsigned short * u)
3017 {
3018 *u = 0;
3019 }
3020
3021 static void
3022 parse_u_short(unsigned short * var)
3023 {
3024 ConfigParser::ParseUShort(var);
3025 }
3026
3027 void
3028 ConfigParser::ParseUShort(unsigned short *var)
3029 {
3030 *var = GetShort();
3031 }
3032
3033 void
3034 ConfigParser::ParseBool(bool *var)
3035 {
3036 int i = GetInteger();
3037
3038 if (0 == i)
3039 *var = false;
3040 else if (1 == i)
3041 *var = true;
3042 else
3043 self_destruct();
3044 }
3045
3046 static void
3047 dump_wordlist(StoreEntry * entry, const char *name, wordlist * list)
3048 {
3049 while (list != NULL) {
3050 storeAppendPrintf(entry, "%s %s\n", name, list->key);
3051 list = list->next;
3052 }
3053 }
3054
3055 void
3056 ConfigParser::ParseWordList(wordlist ** list)
3057 {
3058 parse_wordlist(list);
3059 }
3060
3061 void
3062 parse_wordlist(wordlist ** list)
3063 {
3064 char *token;
3065 while ((token = ConfigParser::NextQuotedToken()))
3066 wordlistAdd(list, token);
3067 }
3068
3069 #if 0 /* now unused */
3070 static int
3071 check_null_wordlist(wordlist * w)
3072 {
3073 return w == NULL;
3074 }
3075 #endif
3076
3077 static int
3078 check_null_acl_access(acl_access * a)
3079 {
3080 return a == NULL;
3081 }
3082
3083 #define free_wordlist wordlistDestroy
3084
3085 #define free_uri_whitespace free_int
3086
3087 static void
3088 parse_uri_whitespace(int *var)
3089 {
3090 char *token = ConfigParser::NextToken();
3091
3092 if (token == NULL)
3093 self_destruct();
3094
3095 if (!strcmp(token, "strip"))
3096 *var = URI_WHITESPACE_STRIP;
3097 else if (!strcmp(token, "deny"))
3098 *var = URI_WHITESPACE_DENY;
3099 else if (!strcmp(token, "allow"))
3100 *var = URI_WHITESPACE_ALLOW;
3101 else if (!strcmp(token, "encode"))
3102 *var = URI_WHITESPACE_ENCODE;
3103 else if (!strcmp(token, "chop"))
3104 *var = URI_WHITESPACE_CHOP;
3105 else {
3106 debugs(0, DBG_PARSE_NOTE(2), "ERROR: Invalid option '" << token << "': 'uri_whitespace' accepts 'strip', 'deny', 'allow', 'encode', and 'chop'.");
3107 self_destruct();
3108 }
3109 }
3110
3111 static void
3112 dump_uri_whitespace(StoreEntry * entry, const char *name, int var)
3113 {
3114 const char *s;
3115
3116 if (var == URI_WHITESPACE_ALLOW)
3117 s = "allow";
3118 else if (var == URI_WHITESPACE_ENCODE)
3119 s = "encode";
3120 else if (var == URI_WHITESPACE_CHOP)
3121 s = "chop";
3122 else if (var == URI_WHITESPACE_DENY)
3123 s = "deny";
3124 else
3125 s = "strip";
3126
3127 storeAppendPrintf(entry, "%s %s\n", name, s);
3128 }
3129
3130 static void
3131 free_removalpolicy(RemovalPolicySettings ** settings)
3132 {
3133 if (!*settings)
3134 return;
3135
3136 free_string(&(*settings)->type);
3137
3138 free_wordlist(&(*settings)->args);
3139
3140 delete *settings;
3141
3142 *settings = NULL;
3143 }
3144
3145 static void
3146 parse_removalpolicy(RemovalPolicySettings ** settings)
3147 {
3148 if (*settings)
3149 free_removalpolicy(settings);
3150
3151 *settings = new RemovalPolicySettings;
3152
3153 parse_string(&(*settings)->type);
3154
3155 parse_wordlist(&(*settings)->args);
3156 }
3157
3158 static void
3159 dump_removalpolicy(StoreEntry * entry, const char *name, RemovalPolicySettings * settings)
3160 {
3161 wordlist *args;
3162 storeAppendPrintf(entry, "%s %s", name, settings->type);
3163 args = settings->args;
3164
3165 while (args) {
3166 storeAppendPrintf(entry, " %s", args->key);
3167 args = args->next;
3168 }
3169
3170 storeAppendPrintf(entry, "\n");
3171 }
3172
3173 inline void
3174 free_YesNoNone(YesNoNone *)
3175 {}
3176
3177 static void
3178 parse_YesNoNone(YesNoNone *option)
3179 {
3180 int value = 0;
3181 parse_onoff(&value);
3182 option->configure(value > 0);
3183 }
3184
3185 static void
3186 dump_YesNoNone(StoreEntry * entry, const char *name, YesNoNone &option)
3187 {
3188 if (option.configured())
3189 dump_onoff(entry, name, option ? 1 : 0);
3190 }
3191
3192 static void
3193 free_memcachemode(SquidConfig *)
3194 {}
3195
3196 static void
3197 parse_memcachemode(SquidConfig *)
3198 {
3199 char *token = ConfigParser::NextToken();
3200 if (!token)
3201 self_destruct();
3202
3203 if (strcmp(token, "always") == 0) {
3204 Config.onoff.memory_cache_first = 1;
3205 Config.onoff.memory_cache_disk = 1;
3206 } else if (strcmp(token, "disk") == 0) {
3207 Config.onoff.memory_cache_first = 0;
3208 Config.onoff.memory_cache_disk = 1;
3209 } else if (strncmp(token, "net", 3) == 0) {
3210 Config.onoff.memory_cache_first = 1;
3211 Config.onoff.memory_cache_disk = 0;
3212 } else if (strcmp(token, "never") == 0) {
3213 Config.onoff.memory_cache_first = 0;
3214 Config.onoff.memory_cache_disk = 0;
3215 } else {
3216 debugs(0, DBG_PARSE_NOTE(2), "ERROR: Invalid option '" << token << "': 'memory_cache_mode' accepts 'always', 'disk', 'network', and 'never'.");
3217 self_destruct();
3218 }
3219 }
3220
3221 static void
3222 dump_memcachemode(StoreEntry * entry, const char *name, SquidConfig &)
3223 {
3224 storeAppendPrintf(entry, "%s ", name);
3225 if (Config.onoff.memory_cache_first && Config.onoff.memory_cache_disk)
3226 storeAppendPrintf(entry, "always");
3227 else if (!Config.onoff.memory_cache_first && Config.onoff.memory_cache_disk)
3228 storeAppendPrintf(entry, "disk");
3229 else if (Config.onoff.memory_cache_first && !Config.onoff.memory_cache_disk)
3230 storeAppendPrintf(entry, "network");
3231 else if (!Config.onoff.memory_cache_first && !Config.onoff.memory_cache_disk)
3232 storeAppendPrintf(entry, "none");
3233 storeAppendPrintf(entry, "\n");
3234 }
3235
3236 #include "cf_parser.cci"
3237
3238 peer_t
3239 parseNeighborType(const char *s)
3240 {
3241 if (!strcmp(s, "parent"))
3242 return PEER_PARENT;
3243
3244 if (!strcmp(s, "neighbor"))
3245 return PEER_SIBLING;
3246
3247 if (!strcmp(s, "neighbour"))
3248 return PEER_SIBLING;
3249
3250 if (!strcmp(s, "sibling"))
3251 return PEER_SIBLING;
3252
3253 if (!strcmp(s, "multicast"))
3254 return PEER_MULTICAST;
3255
3256 debugs(15, DBG_CRITICAL, "WARNING: Unknown neighbor type: " << s);
3257
3258 return PEER_SIBLING;
3259 }
3260
3261 #if USE_WCCPv2
3262 static void
3263 parse_IpAddress_list(Ip::Address_list ** head)
3264 {
3265 char *token;
3266 Ip::Address_list *s;
3267 Ip::Address ipa;
3268
3269 while ((token = ConfigParser::NextToken())) {
3270 if (GetHostWithPort(token, &ipa)) {
3271
3272 while (*head)
3273 head = &(*head)->next;
3274
3275 s = static_cast<Ip::Address_list *>(xcalloc(1, sizeof(*s)));
3276 s->s = ipa;
3277
3278 *head = s;
3279 } else
3280 self_destruct();
3281 }
3282 }
3283
3284 static void
3285 dump_IpAddress_list(StoreEntry * e, const char *n, const Ip::Address_list * s)
3286 {
3287 char ntoabuf[MAX_IPSTRLEN];
3288
3289 while (s) {
3290 storeAppendPrintf(e, "%s %s\n",
3291 n,
3292 s->s.toStr(ntoabuf,MAX_IPSTRLEN));
3293 s = s->next;
3294 }
3295 }
3296
3297 static void
3298 free_IpAddress_list(Ip::Address_list ** head)
3299 {
3300 if (*head) delete *head;
3301 *head = NULL;
3302 }
3303
3304 #if CURRENTLY_UNUSED
3305 /* This code was previously used by http_port. Left as it really should
3306 * be used by icp_port and htcp_port
3307 */
3308 static int
3309 check_null_IpAddress_list(const Ip::Address_list * s)
3310 {
3311 return NULL == s;
3312 }
3313
3314 #endif /* CURRENTLY_UNUSED */
3315 #endif /* USE_WCCPv2 */
3316
3317 static void
3318 parsePortSpecification(const AnyP::PortCfgPointer &s, char *token)
3319 {
3320 char *host = NULL;
3321 unsigned short port = 0;
3322 char *t = NULL;
3323 char *junk = NULL;
3324
3325 s->disable_pmtu_discovery = DISABLE_PMTU_OFF;
3326 s->name = xstrdup(token);
3327 s->connection_auth_disabled = false;
3328
3329 const char *portType = AnyP::UriScheme(s->transport.protocol).c_str();
3330
3331 if (*token == '[') {
3332 /* [ipv6]:port */
3333 host = token + 1;
3334 t = strchr(host, ']');
3335 if (!t) {
3336 debugs(3, DBG_CRITICAL, "FATAL: " << portType << "_port: missing ']' on IPv6 address: " << token);
3337 self_destruct();
3338 }
3339 *t = '\0';
3340 ++t;
3341 if (*t != ':') {
3342 debugs(3, DBG_CRITICAL, "FATAL: " << portType << "_port: missing Port in: " << token);
3343 self_destruct();
3344 }
3345 if (!Ip::EnableIpv6) {
3346 debugs(3, DBG_CRITICAL, "FATAL: " << portType << "_port: IPv6 is not available.");
3347 self_destruct();
3348 }
3349 port = xatos(t + 1);
3350 } else if ((t = strchr(token, ':'))) {
3351 /* host:port */
3352 /* ipv4:port */
3353 host = token;
3354 *t = '\0';
3355 port = xatos(t + 1);
3356
3357 } else if (strtol(token, &junk, 10) && !*junk) {
3358 port = xatos(token);
3359 debugs(3, 3, portType << "_port: found Listen on Port: " << port);
3360 } else {
3361 debugs(3, DBG_CRITICAL, "FATAL: " << portType << "_port: missing Port: " << token);
3362 self_destruct();
3363 }
3364
3365 if (port == 0 && host != NULL) {
3366 debugs(3, DBG_CRITICAL, "FATAL: " << portType << "_port: Port cannot be 0: " << token);
3367 self_destruct();
3368 }
3369
3370 if (NULL == host) {
3371 s->s.setAnyAddr();
3372 s->s.port(port);
3373 if (!Ip::EnableIpv6)
3374 s->s.setIPv4();
3375 debugs(3, 3, portType << "_port: found Listen on wildcard address: *:" << s->s.port());
3376 } else if ( (s->s = host) ) { /* check/parse numeric IPA */
3377 s->s.port(port);
3378 if (!Ip::EnableIpv6)
3379 s->s.setIPv4();
3380 debugs(3, 3, portType << "_port: Listen on Host/IP: " << host << " --> " << s->s);
3381 } else if ( s->s.GetHostByName(host) ) { /* check/parse for FQDN */
3382 /* dont use ipcache */
3383 s->defaultsite = xstrdup(host);
3384 s->s.port(port);
3385 if (!Ip::EnableIpv6)
3386 s->s.setIPv4();
3387 debugs(3, 3, portType << "_port: found Listen as Host " << s->defaultsite << " on IP: " << s->s);
3388 } else {
3389 debugs(3, DBG_CRITICAL, "FATAL: " << portType << "_port: failed to resolve Host/IP: " << host);
3390 self_destruct();
3391 }
3392 }
3393
3394 /// parses the protocol= option of the *_port directive, returning parsed value
3395 /// unsupported option values result in a fatal error message
3396 /// upper case values required; caller may convert for backward compatibility
3397 static AnyP::ProtocolVersion
3398 parsePortProtocol(const SBuf &value)
3399 {
3400 // HTTP/1.0 not supported because we are version 1.1 which contains a superset of 1.0
3401 // and RFC 2616 requires us to upgrade 1.0 to 1.1
3402 if (value.cmp("HTTP") == 0 || value.cmp("HTTP/1.1") == 0)
3403 return AnyP::ProtocolVersion(AnyP::PROTO_HTTP, 1,1);
3404
3405 if (value.cmp("HTTPS") == 0 || value.cmp("HTTPS/1.1") == 0)
3406 return AnyP::ProtocolVersion(AnyP::PROTO_HTTPS, 1,1);
3407
3408 if (value.cmp("FTP") == 0)
3409 return Ftp::ProtocolVersion();
3410
3411 fatalf("%s directive does not support protocol=" SQUIDSBUFPH "\n", cfg_directive, SQUIDSBUFPRINT(value));
3412 return AnyP::ProtocolVersion(); // not reached
3413 }
3414
3415 static void
3416 parse_port_option(AnyP::PortCfgPointer &s, char *token)
3417 {
3418 /* modes first */
3419
3420 if (strcmp(token, "accel") == 0) {
3421 if (s->flags.isIntercepted()) {
3422 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": Accelerator mode requires its own port. It cannot be shared with other modes.");
3423 self_destruct();
3424 }
3425 s->flags.accelSurrogate = true;
3426 s->vhost = true;
3427 } else if (strcmp(token, "transparent") == 0 || strcmp(token, "intercept") == 0) {
3428 if (s->flags.accelSurrogate || s->flags.tproxyIntercept) {
3429 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": Intercept mode requires its own interception port. It cannot be shared with other modes.");
3430 self_destruct();
3431 }
3432 s->flags.natIntercept = true;
3433 Ip::Interceptor.StartInterception();
3434 /* Log information regarding the port modes under interception. */
3435 debugs(3, DBG_IMPORTANT, "Starting Authentication on port " << s->s);
3436 debugs(3, DBG_IMPORTANT, "Disabling Authentication on port " << s->s << " (interception enabled)");
3437 } else if (strcmp(token, "tproxy") == 0) {
3438 if (s->flags.natIntercept || s->flags.accelSurrogate) {
3439 debugs(3,DBG_CRITICAL, "FATAL: " << cfg_directive << ": TPROXY option requires its own interception port. It cannot be shared with other modes.");
3440 self_destruct();
3441 }
3442 s->flags.tproxyIntercept = true;
3443 Ip::Interceptor.StartTransparency();
3444 /* Log information regarding the port modes under transparency. */
3445 debugs(3, DBG_IMPORTANT, "Disabling Authentication on port " << s->s << " (TPROXY enabled)");
3446
3447 if (s->flags.proxySurrogate) {
3448 debugs(3, DBG_IMPORTANT, "Disabling TPROXY Spoofing on port " << s->s << " (require-proxy-header enabled)");
3449 }
3450
3451 if (!Ip::Interceptor.ProbeForTproxy(s->s)) {
3452 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": TPROXY support in the system does not work.");
3453 self_destruct();
3454 }
3455
3456 } else if (strcmp(token, "require-proxy-header") == 0) {
3457 s->flags.proxySurrogate = true;
3458 if (s->flags.tproxyIntercept) {
3459 // receiving is still permitted, so we do not unset the TPROXY flag
3460 // spoofing access control override takes care of the spoof disable later
3461 debugs(3, DBG_IMPORTANT, "Disabling TPROXY Spoofing on port " << s->s << " (require-proxy-header enabled)");
3462 }
3463
3464 } else if (strncmp(token, "defaultsite=", 12) == 0) {
3465 if (!s->flags.accelSurrogate) {
3466 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": defaultsite option requires Acceleration mode flag.");
3467 self_destruct();
3468 }
3469 safe_free(s->defaultsite);
3470 s->defaultsite = xstrdup(token + 12);
3471 } else if (strcmp(token, "vhost") == 0) {
3472 if (!s->flags.accelSurrogate) {
3473 debugs(3, DBG_CRITICAL, "WARNING: " << cfg_directive << ": vhost option is deprecated. Use 'accel' mode flag instead.");
3474 }
3475 s->flags.accelSurrogate = true;
3476 s->vhost = true;
3477 } else if (strcmp(token, "no-vhost") == 0) {
3478 if (!s->flags.accelSurrogate) {
3479 debugs(3, DBG_IMPORTANT, "ERROR: " << cfg_directive << ": no-vhost option requires Acceleration mode flag.");
3480 }
3481 s->vhost = false;
3482 } else if (strcmp(token, "vport") == 0) {
3483 if (!s->flags.accelSurrogate) {
3484 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": vport option requires Acceleration mode flag.");
3485 self_destruct();
3486 }
3487 s->vport = -1;
3488 } else if (strncmp(token, "vport=", 6) == 0) {
3489 if (!s->flags.accelSurrogate) {
3490 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": vport option requires Acceleration mode flag.");
3491 self_destruct();
3492 }
3493 s->vport = xatos(token + 6);
3494 } else if (strncmp(token, "protocol=", 9) == 0) {
3495 if (!s->flags.accelSurrogate) {
3496 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": protocol option requires Acceleration mode flag.");
3497 self_destruct();
3498 }
3499 s->transport = parsePortProtocol(ToUpper(SBuf(token + 9)));
3500 } else if (strcmp(token, "allow-direct") == 0) {
3501 if (!s->flags.accelSurrogate) {
3502 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": allow-direct option requires Acceleration mode flag.");
3503 self_destruct();
3504 }
3505 s->allow_direct = true;
3506 } else if (strcmp(token, "act-as-origin") == 0) {
3507 if (!s->flags.accelSurrogate) {
3508 debugs(3, DBG_IMPORTANT, "ERROR: " << cfg_directive << ": act-as-origin option requires Acceleration mode flag.");
3509 } else
3510 s->actAsOrigin = true;
3511 } else if (strcmp(token, "ignore-cc") == 0) {
3512 #if !USE_HTTP_VIOLATIONS
3513 if (!s->flags.accelSurrogate) {
3514 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": ignore-cc option requires Acceleration mode flag.");
3515 self_destruct();
3516 }
3517 #endif
3518 s->ignore_cc = true;
3519 } else if (strncmp(token, "name=", 5) == 0) {
3520 safe_free(s->name);
3521 s->name = xstrdup(token + 5);
3522 } else if (strcmp(token, "no-connection-auth") == 0) {
3523 s->connection_auth_disabled = true;
3524 } else if (strcmp(token, "connection-auth=off") == 0) {
3525 s->connection_auth_disabled = true;
3526 } else if (strcmp(token, "connection-auth") == 0) {
3527 s->connection_auth_disabled = false;
3528 } else if (strcmp(token, "connection-auth=on") == 0) {
3529 s->connection_auth_disabled = false;
3530 } else if (strncmp(token, "disable-pmtu-discovery=", 23) == 0) {
3531 if (!strcmp(token + 23, "off"))
3532 s->disable_pmtu_discovery = DISABLE_PMTU_OFF;
3533 else if (!strcmp(token + 23, "transparent"))
3534 s->disable_pmtu_discovery = DISABLE_PMTU_TRANSPARENT;
3535 else if (!strcmp(token + 23, "always"))
3536 s->disable_pmtu_discovery = DISABLE_PMTU_ALWAYS;
3537 else
3538 self_destruct();
3539 } else if (strcmp(token, "ipv4") == 0) {
3540 if ( !s->s.setIPv4() ) {
3541 debugs(3, DBG_CRITICAL, "FATAL: " << cfg_directive << ": IPv6 addresses cannot be used as IPv4-Only. " << s->s );
3542 self_destruct();
3543 }
3544 } else if (strcmp(token, "tcpkeepalive") == 0) {
3545 s->tcp_keepalive.enabled = true;
3546 } else if (strncmp(token, "tcpkeepalive=", 13) == 0) {
3547 char *t = token + 13;
3548 s->tcp_keepalive.enabled = true;
3549 s->tcp_keepalive.idle = xatoui(t,',');
3550 t = strchr(t, ',');
3551 if (t) {
3552 ++t;
3553 s->tcp_keepalive.interval = xatoui(t,',');
3554 t = strchr(t, ',');
3555 }
3556 if (t) {
3557 ++t;
3558 s->tcp_keepalive.timeout = xatoui(t);
3559 }
3560 #if USE_OPENSSL
3561 } else if (strcmp(token, "sslBump") == 0) {
3562 debugs(3, DBG_PARSE_NOTE(1), "WARNING: '" << token << "' is deprecated " <<
3563 "in " << cfg_directive << ". Use 'ssl-bump' instead.");
3564 s->flags.tunnelSslBumping = true;
3565 } else if (strcmp(token, "ssl-bump") == 0) {
3566 s->flags.tunnelSslBumping = true;
3567 } else if (strncmp(token, "cert=", 5) == 0) {
3568 s->secure.parse(token);
3569 } else if (strncmp(token, "key=", 4) == 0) {
3570 s->secure.parse(token);
3571 } else if (strncmp(token, "version=", 8) == 0) {
3572 debugs(3, DBG_PARSE_NOTE(1), "UPGRADE WARNING: '" << token << "' is deprecated " <<
3573 "in " << cfg_directive << ". Use 'options=' instead.");
3574 s->secure.parse(token);
3575 } else if (strncmp(token, "options=", 8) == 0) {
3576 s->secure.parse(token);
3577 } else if (strncmp(token, "cipher=", 7) == 0) {
3578 s->secure.parse(token);
3579 } else if (strncmp(token, "clientca=", 9) == 0) {
3580 safe_free(s->clientca);
3581 s->clientca = xstrdup(token + 9);
3582 } else if (strncmp(token, "cafile=", 7) == 0) {
3583 debugs(3, DBG_PARSE_NOTE(1), "UPGRADE WARNING: '" << token << "' is deprecated " <<
3584 "in " << cfg_directive << ". Use 'tls-cafile=' instead.");
3585 s->secure.parse(token);
3586 } else if (strncmp(token, "capath=", 7) == 0) {
3587 s->secure.parse(token);
3588 } else if (strncmp(token, "crlfile=", 8) == 0) {
3589 s->secure.parse(token);
3590 } else if (strncmp(token, "dhparams=", 9) == 0) {
3591 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT), "WARNING: '" << token << "' is deprecated " <<
3592 "in " << cfg_directive << ". Use 'tls-dh=' instead.");
3593 s->secure.parse(token);
3594 } else if (strncmp(token, "sslflags=", 9) == 0) {
3595 // NP: deprecation warnings output by secure.parse() when relevant
3596 s->secure.parse(token+3);
3597 } else if (strncmp(token, "sslcontext=", 11) == 0) {
3598 safe_free(s->sslContextSessionId);
3599 s->sslContextSessionId = xstrdup(token + 11);
3600 } else if (strcmp(token, "generate-host-certificates") == 0) {
3601 s->generateHostCertificates = true;
3602 } else if (strcmp(token, "generate-host-certificates=on") == 0) {
3603 s->generateHostCertificates = true;
3604 } else if (strcmp(token, "generate-host-certificates=off") == 0) {
3605 s->generateHostCertificates = false;
3606 } else if (strncmp(token, "dynamic_cert_mem_cache_size=", 28) == 0) {
3607 parseBytesOptionValue(&s->dynamicCertMemCacheSize, B_BYTES_STR, token + 28);
3608 #endif
3609 } else if (strncmp(token, "tls-", 4) == 0) {
3610 s->secure.parse(token+4);
3611 } else if (strcmp(token, "ftp-track-dirs") == 0) {
3612 s->ftp_track_dirs = true;
3613 } else {
3614 debugs(3, DBG_CRITICAL, "FATAL: Unknown " << cfg_directive << " option '" << token << "'.");
3615 self_destruct();
3616 }
3617 }
3618
3619 void
3620 add_http_port(char *portspec)
3621 {
3622 AnyP::PortCfgPointer s = new AnyP::PortCfg();
3623 s->transport = parsePortProtocol(SBuf("HTTP"));
3624 parsePortSpecification(s, portspec);
3625 // we may need to merge better if the above returns a list with clones
3626 assert(s->next == NULL);
3627 s->next = HttpPortList;
3628 HttpPortList = s;
3629 }
3630
3631 static void
3632 parsePortCfg(AnyP::PortCfgPointer *head, const char *optionName)
3633 {
3634 SBuf protoName;
3635 if (strcmp(optionName, "http_port") == 0 ||
3636 strcmp(optionName, "ascii_port") == 0)
3637 protoName = "HTTP";
3638 else if (strcmp(optionName, "https_port") == 0)
3639 protoName = "HTTPS";
3640 else if (strcmp(optionName, "ftp_port") == 0)
3641 protoName = "FTP";
3642 if (protoName.isEmpty()) {
3643 self_destruct();
3644 return;
3645 }
3646
3647 char *token = ConfigParser::NextToken();
3648
3649 if (!token) {
3650 self_destruct();
3651 return;
3652 }
3653
3654 AnyP::PortCfgPointer s = new AnyP::PortCfg();
3655 s->transport = parsePortProtocol(protoName); // default; protocol=... overwrites
3656 parsePortSpecification(s, token);
3657
3658 /* parse options ... */
3659 while ((token = ConfigParser::NextToken())) {
3660 parse_port_option(s, token);
3661 }
3662
3663 #if USE_OPENSSL
3664 // if clientca has been defined but not cafile, then use it to verify
3665 // but if cafile has been defined, only use that to verify
3666 if (s->clientca && !s->secure.caFiles.size())
3667 s->secure.caFiles.emplace_back(SBuf(s->clientca));
3668 #endif
3669
3670 if (s->transport.protocol == AnyP::PROTO_HTTPS) {
3671 s->secure.encryptTransport = true;
3672 #if USE_OPENSSL
3673 /* ssl-bump on https_port configuration requires either tproxy or intercept, and vice versa */
3674 const bool hijacked = s->flags.isIntercepted();
3675 if (s->flags.tunnelSslBumping && !hijacked) {
3676 debugs(3, DBG_CRITICAL, "FATAL: ssl-bump on https_port requires tproxy/intercept which is missing.");
3677 self_destruct();
3678 }
3679 if (hijacked && !s->flags.tunnelSslBumping) {
3680 debugs(3, DBG_CRITICAL, "FATAL: tproxy/intercept on https_port requires ssl-bump which is missing.");
3681 self_destruct();
3682 }
3683 #endif
3684 if (s->flags.proxySurrogate) {
3685 debugs(3,DBG_CRITICAL, "FATAL: https_port: require-proxy-header option is not supported on HTTPS ports.");
3686 self_destruct();
3687 }
3688 } else if (protoName.cmp("FTP") == 0) {
3689 /* ftp_port does not support ssl-bump */
3690 if (s->flags.tunnelSslBumping) {
3691 debugs(3, DBG_CRITICAL, "FATAL: ssl-bump is not supported for ftp_port.");
3692 self_destruct();
3693 }
3694 if (s->flags.proxySurrogate) {
3695 // Passive FTP data channel does not work without deep protocol inspection in the frontend.
3696 debugs(3,DBG_CRITICAL, "FATAL: require-proxy-header option is not supported on ftp_port.");
3697 self_destruct();
3698 }
3699 }
3700
3701 if (Ip::EnableIpv6&IPV6_SPECIAL_SPLITSTACK && s->s.isAnyAddr()) {
3702 // clone the port options from *s to *(s->next)
3703 s->next = s->clone();
3704 s->next->s.setIPv4();
3705 debugs(3, 3, AnyP::UriScheme(s->transport.protocol).c_str() << "_port: clone wildcard address for split-stack: " << s->s << " and " << s->next->s);
3706 }
3707
3708 while (*head != NULL)
3709 head = &((*head)->next);
3710
3711 *head = s;
3712 }
3713
3714 static void
3715 dump_generic_port(StoreEntry * e, const char *n, const AnyP::PortCfgPointer &s)
3716 {
3717 char buf[MAX_IPSTRLEN];
3718
3719 storeAppendPrintf(e, "%s %s",
3720 n,
3721 s->s.toUrl(buf,MAX_IPSTRLEN));
3722
3723 // MODES and specific sub-options.
3724 if (s->flags.natIntercept)
3725 storeAppendPrintf(e, " intercept");
3726
3727 else if (s->flags.tproxyIntercept)
3728 storeAppendPrintf(e, " tproxy");
3729
3730 else if (s->flags.proxySurrogate)
3731 storeAppendPrintf(e, " require-proxy-header");
3732
3733 else if (s->flags.accelSurrogate) {
3734 storeAppendPrintf(e, " accel");
3735
3736 if (s->vhost)
3737 storeAppendPrintf(e, " vhost");
3738
3739 if (s->vport < 0)
3740 storeAppendPrintf(e, " vport");
3741 else if (s->vport > 0)
3742 storeAppendPrintf(e, " vport=%d", s->vport);
3743
3744 if (s->defaultsite)
3745 storeAppendPrintf(e, " defaultsite=%s", s->defaultsite);
3746
3747 // TODO: compare against prefix of 'n' instead of assuming http_port
3748 if (s->transport.protocol != AnyP::PROTO_HTTP)
3749 storeAppendPrintf(e, " protocol=%s", AnyP::UriScheme(s->transport.protocol).c_str());
3750
3751 if (s->allow_direct)
3752 storeAppendPrintf(e, " allow-direct");
3753
3754 if (s->ignore_cc)
3755 storeAppendPrintf(e, " ignore-cc");
3756
3757 }
3758
3759 // Generic independent options
3760
3761 if (s->name)
3762 storeAppendPrintf(e, " name=%s", s->name);
3763
3764 #if USE_HTTP_VIOLATIONS
3765 if (!s->flags.accelSurrogate && s->ignore_cc)
3766 storeAppendPrintf(e, " ignore-cc");
3767 #endif
3768
3769 if (s->connection_auth_disabled)
3770 storeAppendPrintf(e, " connection-auth=off");
3771 else
3772 storeAppendPrintf(e, " connection-auth=on");
3773
3774 if (s->disable_pmtu_discovery != DISABLE_PMTU_OFF) {
3775 const char *pmtu;
3776
3777 if (s->disable_pmtu_discovery == DISABLE_PMTU_ALWAYS)
3778 pmtu = "always";
3779 else
3780 pmtu = "transparent";
3781
3782 storeAppendPrintf(e, " disable-pmtu-discovery=%s", pmtu);
3783 }
3784
3785 if (s->s.isAnyAddr() && !s->s.isIPv6())
3786 storeAppendPrintf(e, " ipv4");
3787
3788 if (s->tcp_keepalive.enabled) {
3789 if (s->tcp_keepalive.idle || s->tcp_keepalive.interval || s->tcp_keepalive.timeout) {
3790 storeAppendPrintf(e, " tcpkeepalive=%d,%d,%d", s->tcp_keepalive.idle, s->tcp_keepalive.interval, s->tcp_keepalive.timeout);
3791 } else {
3792 storeAppendPrintf(e, " tcpkeepalive");
3793 }
3794 }
3795
3796 #if USE_OPENSSL
3797 if (s->flags.tunnelSslBumping)
3798 storeAppendPrintf(e, " ssl-bump");
3799 #endif
3800
3801 s->secure.dumpCfg(e, "tls-");
3802
3803 #if USE_OPENSSL
3804 if (s->sslContextSessionId)
3805 storeAppendPrintf(e, " sslcontext=%s", s->sslContextSessionId);
3806
3807 if (s->generateHostCertificates)
3808 storeAppendPrintf(e, " generate-host-certificates");
3809
3810 if (s->dynamicCertMemCacheSize != std::numeric_limits<size_t>::max())
3811 storeAppendPrintf(e, "dynamic_cert_mem_cache_size=%lu%s\n", (unsigned long)s->dynamicCertMemCacheSize, B_BYTES_STR);
3812 #endif
3813 }
3814
3815 static void
3816 dump_PortCfg(StoreEntry * e, const char *n, const AnyP::PortCfgPointer &s)
3817 {
3818 for (AnyP::PortCfgPointer p = s; p != NULL; p = p->next) {
3819 dump_generic_port(e, n, p);
3820 storeAppendPrintf(e, "\n");
3821 }
3822 }
3823
3824 void
3825 configFreeMemory(void)
3826 {
3827 free_all();
3828 #if USE_OPENSSL
3829 SSL_CTX_free(Config.ssl_client.sslContext);
3830 Ssl::unloadSquidUntrusted();
3831 #endif
3832 }
3833
3834 void
3835 requirePathnameExists(const char *name, const char *path)
3836 {
3837
3838 struct stat sb;
3839 char pathbuf[BUFSIZ];
3840 assert(path != NULL);
3841
3842 if (Config.chroot_dir && (geteuid() == 0)) {
3843 snprintf(pathbuf, BUFSIZ, "%s/%s", Config.chroot_dir, path);
3844 path = pathbuf;
3845 }
3846
3847 if (stat(path, &sb) < 0) {
3848 debugs(0, DBG_CRITICAL, (opt_parse_cfg_only?"FATAL: ":"ERROR: ") << name << " " << path << ": " << xstrerror());
3849 // keep going to find more issues if we are only checking the config file with "-k parse"
3850 if (opt_parse_cfg_only)
3851 return;
3852 // this is fatal if it is found during startup or reconfigure
3853 if (opt_send_signal == -1 || opt_send_signal == SIGHUP)
3854 fatalf("%s %s: %s", name, path, xstrerror());
3855 }
3856 }
3857
3858 #include "AccessLogEntry.h"
3859
3860 /**
3861 * We support several access_log configuration styles:
3862 *
3863 * #1: Deprecated ancient style without an explicit logging module:
3864 * access_log /var/log/access.log
3865 *
3866 * #2: The "none" logging module (i.e., no logging [of matching transactions]):
3867 * access_log none [acl ...]
3868 *
3869 * #3: Configurable logging module without named options:
3870 * Logformat or the first ACL name, whichever comes first, may not contain '='.
3871 * If no explicit logformat name is given, the first ACL name, if any,
3872 * should not be an existing logformat name or it will be treated as such.
3873 * access_log module:place [logformat_name] [acl ...]
3874 *
3875 * #4: Configurable logging module with name=value options such as logformat=x:
3876 * The first ACL name may not contain '='.
3877 * access_log module:place [option ...] [acl ...]
3878 *
3879 */
3880 static void
3881 parse_access_log(CustomLog ** logs)
3882 {
3883 CustomLog *cl = (CustomLog *)xcalloc(1, sizeof(*cl));
3884
3885 // default buffer size and fatal settings
3886 cl->bufferSize = 8*MAX_URL;
3887 cl->fatal = true;
3888
3889 /* determine configuration style */
3890
3891 const char *filename = ConfigParser::NextToken();
3892 if (!filename) {
3893 self_destruct();
3894 return;
3895 }
3896
3897 if (strcmp(filename, "none") == 0) {
3898 cl->type = Log::Format::CLF_NONE;
3899 aclParseAclList(LegacyParser, &cl->aclList, filename);
3900 while (*logs)
3901 logs = &(*logs)->next;
3902 *logs = cl;
3903 return;
3904 }
3905
3906 cl->filename = xstrdup(filename);
3907 cl->type = Log::Format::CLF_UNKNOWN;
3908 cl->rotateCount = -1; // default: use global logfile_rotate setting.
3909
3910 const char *token = ConfigParser::PeekAtToken();
3911 if (!token) { // style #1
3912 // no options to deal with
3913 } else if (!strchr(token, '=')) { // style #3
3914 // if logformat name is recognized,
3915 // pop the previewed token; Else it must be an ACL name
3916 if (setLogformat(cl, token, false))
3917 (void)ConfigParser::NextToken();
3918 } else { // style #4
3919 do {
3920 if (strncasecmp(token, "on-error=", 9) == 0) {
3921 if (strncasecmp(token+9, "die", 3) == 0) {
3922 cl->fatal = true;
3923 } else if (strncasecmp(token+9, "drop", 4) == 0) {
3924 cl->fatal = false;
3925 } else {
3926 debugs(3, DBG_CRITICAL, "Unknown value for on-error '" <<
3927 token << "' expected 'drop' or 'die'");
3928 self_destruct();
3929 }
3930 } else if (strncasecmp(token, "buffer-size=", 12) == 0) {
3931 parseBytesOptionValue(&cl->bufferSize, B_BYTES_STR, token+12);
3932 } else if (strncasecmp(token, "rotate=", 7) == 0) {
3933 cl->rotateCount = xatoi(token + 7);
3934 } else if (strncasecmp(token, "logformat=", 10) == 0) {
3935 setLogformat(cl, token+10, true);
3936 } else if (!strchr(token, '=')) {
3937 // Do not pop the token; it must be an ACL name
3938 break; // done with name=value options, now to ACLs
3939 } else {
3940 debugs(3, DBG_CRITICAL, "Unknown access_log option " << token);
3941 self_destruct();
3942 }
3943 // Pop the token, it was a valid "name=value" option
3944 (void)ConfigParser::NextToken();
3945 // Get next with preview ConfigParser::NextToken call.
3946 } while ((token = ConfigParser::PeekAtToken()) != NULL);
3947 }
3948
3949 // set format if it has not been specified explicitly
3950 if (cl->type == Log::Format::CLF_UNKNOWN)
3951 setLogformat(cl, "squid", true);
3952
3953 aclParseAclList(LegacyParser, &cl->aclList, cl->filename);
3954
3955 while (*logs)
3956 logs = &(*logs)->next;
3957
3958 *logs = cl;
3959 }
3960
3961 /// sets CustomLog::type and, if needed, CustomLog::lf
3962 /// returns false iff there is no named log format
3963 static bool
3964 setLogformat(CustomLog *cl, const char *logdef_name, const bool dieWhenMissing)
3965 {
3966 assert(cl);
3967 assert(logdef_name);
3968
3969 debugs(3, 9, "possible " << cl->filename << " logformat: " << logdef_name);
3970
3971 if (cl->type != Log::Format::CLF_UNKNOWN) {
3972 debugs(3, DBG_CRITICAL, "Second logformat name in one access_log: " <<
3973 logdef_name << " " << cl->type << " ? " << Log::Format::CLF_NONE);
3974 self_destruct();
3975 return false;
3976 }
3977
3978 /* look for the definition pointer corresponding to this name */
3979 Format::Format *lf = Log::TheConfig.logformats;
3980
3981 while (lf != NULL) {
3982 debugs(3, 9, "Comparing against '" << lf->name << "'");
3983
3984 if (strcmp(lf->name, logdef_name) == 0)
3985 break;
3986
3987 lf = lf->next;
3988 }
3989
3990 if (lf != NULL) {
3991 cl->type = Log::Format::CLF_CUSTOM;
3992 cl->logFormat = lf;
3993 } else if (strcmp(logdef_name, "auto") == 0) {
3994 debugs(0, DBG_CRITICAL, "WARNING: Log format 'auto' no longer exists. Using 'squid' instead.");
3995 cl->type = Log::Format::CLF_SQUID;
3996 } else if (strcmp(logdef_name, "squid") == 0) {
3997 cl->type = Log::Format::CLF_SQUID;
3998 } else if (strcmp(logdef_name, "common") == 0) {
3999 cl->type = Log::Format::CLF_COMMON;
4000 } else if (strcmp(logdef_name, "combined") == 0) {
4001 cl->type = Log::Format::CLF_COMBINED;
4002 #if ICAP_CLIENT
4003 } else if (strcmp(logdef_name, "icap_squid") == 0) {
4004 cl->type = Log::Format::CLF_ICAP_SQUID;
4005 #endif
4006 } else if (strcmp(logdef_name, "useragent") == 0) {
4007 cl->type = Log::Format::CLF_USERAGENT;
4008 } else if (strcmp(logdef_name, "referrer") == 0) {
4009 cl->type = Log::Format::CLF_REFERER;
4010 } else if (dieWhenMissing) {
4011 debugs(3, DBG_CRITICAL, "Log format '" << logdef_name << "' is not defined");
4012 self_destruct();
4013 return false;
4014 } else {
4015 return false;
4016 }
4017
4018 return true;
4019 }
4020
4021 static int
4022 check_null_access_log(CustomLog *customlog_definitions)
4023 {
4024 return customlog_definitions == NULL;
4025 }
4026
4027 static void
4028 dump_access_log(StoreEntry * entry, const char *name, CustomLog * logs)
4029 {
4030 CustomLog *log;
4031
4032 for (log = logs; log; log = log->next) {
4033 storeAppendPrintf(entry, "%s ", name);
4034
4035 switch (log->type) {
4036
4037 case Log::Format::CLF_CUSTOM:
4038 storeAppendPrintf(entry, "%s logformat=%s", log->filename, log->logFormat->name);
4039 break;
4040
4041 case Log::Format::CLF_NONE:
4042 storeAppendPrintf(entry, "logformat=none");
4043 break;
4044
4045 case Log::Format::CLF_SQUID:
4046 storeAppendPrintf(entry, "%s logformat=squid", log->filename);
4047 break;
4048
4049 case Log::Format::CLF_COMBINED:
4050 storeAppendPrintf(entry, "%s logformat=combined", log->filename);
4051 break;
4052
4053 case Log::Format::CLF_COMMON:
4054 storeAppendPrintf(entry, "%s logformat=common", log->filename);
4055 break;
4056
4057 #if ICAP_CLIENT
4058 case Log::Format::CLF_ICAP_SQUID:
4059 storeAppendPrintf(entry, "%s logformat=icap_squid", log->filename);
4060 break;
4061 #endif
4062 case Log::Format::CLF_USERAGENT:
4063 storeAppendPrintf(entry, "%s logformat=useragent", log->filename);
4064 break;
4065
4066 case Log::Format::CLF_REFERER:
4067 storeAppendPrintf(entry, "%s logformat=referrer", log->filename);
4068 break;
4069
4070 case Log::Format::CLF_UNKNOWN:
4071 break;
4072 }
4073
4074 // default is on-error=die
4075 if (!log->fatal)
4076 storeAppendPrintf(entry, " on-error=drop");
4077
4078 // default: 64KB
4079 if (log->bufferSize != 64*1024)
4080 storeAppendPrintf(entry, " buffer-size=%" PRIuSIZE, log->bufferSize);
4081
4082 if (log->rotateCount >= 0)
4083 storeAppendPrintf(entry, " rotate=%d", log->rotateCount);
4084
4085 if (log->aclList)
4086 dump_acl_list(entry, log->aclList);
4087
4088 storeAppendPrintf(entry, "\n");
4089 }
4090 }
4091
4092 static void
4093 free_access_log(CustomLog ** definitions)
4094 {
4095 while (*definitions) {
4096 CustomLog *log = *definitions;
4097 *definitions = log->next;
4098
4099 log->logFormat = NULL;
4100 log->type = Log::Format::CLF_UNKNOWN;
4101
4102 if (log->aclList)
4103 aclDestroyAclList(&log->aclList);
4104
4105 safe_free(log->filename);
4106
4107 xfree(log);
4108 }
4109 }
4110
4111 /// parses list of integers form name=N1,N2,N3,...
4112 static bool
4113 parseNamedIntList(const char *data, const String &name, std::vector<int> &list)
4114 {
4115 if (data && (strncmp(data, name.rawBuf(), name.size()) == 0)) {
4116 data += name.size();
4117 if (*data == '=') {
4118 while (true) {
4119 ++data;
4120 int value = 0;
4121 if (!StringToInt(data, value, &data, 10))
4122 break;
4123 list.push_back(value);
4124 if (*data == '\0' || *data != ',')
4125 break;
4126 }
4127 }
4128 }
4129 return data && *data == '\0';
4130 }
4131
4132 static void
4133 parse_CpuAffinityMap(CpuAffinityMap **const cpuAffinityMap)
4134 {
4135 #if !HAVE_CPU_AFFINITY
4136 debugs(3, DBG_CRITICAL, "FATAL: Squid built with no CPU affinity " <<
4137 "support, do not set 'cpu_affinity_map'");
4138 self_destruct();
4139 #endif /* HAVE_CPU_AFFINITY */
4140
4141 if (!*cpuAffinityMap)
4142 *cpuAffinityMap = new CpuAffinityMap;
4143
4144 const char *const pToken = ConfigParser::NextToken();
4145 const char *const cToken = ConfigParser::NextToken();
4146 std::vector<int> processes, cores;
4147 if (!parseNamedIntList(pToken, "process_numbers", processes)) {
4148 debugs(3, DBG_CRITICAL, "FATAL: bad 'process_numbers' parameter " <<
4149 "in 'cpu_affinity_map'");
4150 self_destruct();
4151 } else if (!parseNamedIntList(cToken, "cores", cores)) {
4152 debugs(3, DBG_CRITICAL, "FATAL: bad 'cores' parameter in " <<
4153 "'cpu_affinity_map'");
4154 self_destruct();
4155 } else if (!(*cpuAffinityMap)->add(processes, cores)) {
4156 debugs(3, DBG_CRITICAL, "FATAL: bad 'cpu_affinity_map'; " <<
4157 "process_numbers and cores lists differ in length or " <<
4158 "contain numbers <= 0");
4159 self_destruct();
4160 }
4161 }
4162
4163 static void
4164 dump_CpuAffinityMap(StoreEntry *const entry, const char *const name, const CpuAffinityMap *const cpuAffinityMap)
4165 {
4166 if (cpuAffinityMap) {
4167 storeAppendPrintf(entry, "%s process_numbers=", name);
4168 for (size_t i = 0; i < cpuAffinityMap->processes().size(); ++i) {
4169 storeAppendPrintf(entry, "%s%i", (i ? "," : ""),
4170 cpuAffinityMap->processes()[i]);
4171 }
4172 storeAppendPrintf(entry, " cores=");
4173 for (size_t i = 0; i < cpuAffinityMap->cores().size(); ++i) {
4174 storeAppendPrintf(entry, "%s%i", (i ? "," : ""),
4175 cpuAffinityMap->cores()[i]);
4176 }
4177 storeAppendPrintf(entry, "\n");
4178 }
4179 }
4180
4181 static void
4182 free_CpuAffinityMap(CpuAffinityMap **const cpuAffinityMap)
4183 {
4184 delete *cpuAffinityMap;
4185 *cpuAffinityMap = NULL;
4186 }
4187
4188 #if USE_ADAPTATION
4189
4190 static void
4191 parse_adaptation_service_set_type()
4192 {
4193 Adaptation::Config::ParseServiceSet();
4194 }
4195
4196 static void
4197 parse_adaptation_service_chain_type()
4198 {
4199 Adaptation::Config::ParseServiceChain();
4200 }
4201
4202 static void
4203 parse_adaptation_access_type()
4204 {
4205 Adaptation::Config::ParseAccess(LegacyParser);
4206 }
4207 #endif /* USE_ADAPTATION */
4208
4209 #if ICAP_CLIENT
4210
4211 static void
4212 parse_icap_service_type(Adaptation::Icap::Config * cfg)
4213 {
4214 cfg->parseService();
4215 }
4216
4217 static void
4218 free_icap_service_type(Adaptation::Icap::Config * cfg)
4219 {
4220 cfg->freeService();
4221 }
4222
4223 static void
4224 dump_icap_service_type(StoreEntry * entry, const char *name, const Adaptation::Icap::Config &cfg)
4225 {
4226 cfg.dumpService(entry, name);
4227 }
4228
4229 static void
4230 parse_icap_class_type()
4231 {
4232 debugs(93, DBG_CRITICAL, "WARNING: 'icap_class' is depricated. " <<
4233 "Use 'adaptation_service_set' instead");
4234 Adaptation::Config::ParseServiceSet();
4235 }
4236
4237 static void
4238 parse_icap_access_type()
4239 {
4240 debugs(93, DBG_CRITICAL, "WARNING: 'icap_access' is depricated. " <<
4241 "Use 'adaptation_access' instead");
4242 Adaptation::Config::ParseAccess(LegacyParser);
4243 }
4244
4245 #endif
4246
4247 #if USE_ECAP
4248
4249 static void
4250 parse_ecap_service_type(Adaptation::Ecap::Config * cfg)
4251 {
4252 cfg->parseService();
4253 }
4254
4255 static void
4256 free_ecap_service_type(Adaptation::Ecap::Config * cfg)
4257 {
4258 cfg->freeService();
4259 }
4260
4261 static void
4262 dump_ecap_service_type(StoreEntry * entry, const char *name, const Adaptation::Ecap::Config &cfg)
4263 {
4264 cfg.dumpService(entry, name);
4265 }
4266
4267 #endif /* USE_ECAP */
4268
4269 #if ICAP_CLIENT
4270 static void parse_icap_service_failure_limit(Adaptation::Icap::Config *cfg)
4271 {
4272 char *token;
4273 time_t d;
4274 time_t m;
4275 cfg->service_failure_limit = GetInteger();
4276
4277 if ((token = ConfigParser::NextToken()) == NULL)
4278 return;
4279
4280 if (strcmp(token,"in") != 0) {
4281 debugs(3, DBG_CRITICAL, "expecting 'in' on'" << config_input_line << "'");
4282 self_destruct();
4283 }
4284
4285 if ((token = ConfigParser::NextToken()) == NULL) {
4286 self_destruct();
4287 }
4288
4289 d = static_cast<time_t> (xatoi(token));
4290
4291 m = static_cast<time_t> (1);
4292
4293 if (0 == d)
4294 (void) 0;
4295 else if ((token = ConfigParser::NextToken()) == NULL) {
4296 debugs(3, DBG_CRITICAL, "No time-units on '" << config_input_line << "'");
4297 self_destruct();
4298 } else if ((m = parseTimeUnits(token, false)) == 0)
4299 self_destruct();
4300
4301 cfg->oldest_service_failure = (m * d);
4302 }
4303
4304 static void dump_icap_service_failure_limit(StoreEntry *entry, const char *name, const Adaptation::Icap::Config &cfg)
4305 {
4306 storeAppendPrintf(entry, "%s %d", name, cfg.service_failure_limit);
4307 if (cfg.oldest_service_failure > 0) {
4308 storeAppendPrintf(entry, " in %d seconds", (int)cfg.oldest_service_failure);
4309 }
4310 storeAppendPrintf(entry, "\n");
4311 }
4312
4313 static void free_icap_service_failure_limit(Adaptation::Icap::Config *cfg)
4314 {
4315 cfg->oldest_service_failure = 0;
4316 cfg->service_failure_limit = 0;
4317 }
4318 #endif
4319
4320 #if USE_OPENSSL
4321 static void parse_sslproxy_cert_adapt(sslproxy_cert_adapt **cert_adapt)
4322 {
4323 char *al;
4324 sslproxy_cert_adapt *ca = (sslproxy_cert_adapt *) xcalloc(1, sizeof(sslproxy_cert_adapt));
4325 if ((al = ConfigParser::NextToken()) == NULL) {
4326 self_destruct();
4327 return;
4328 }
4329
4330 const char *param;
4331 if ( char *s = strchr(al, '{')) {
4332 *s = '\0'; // terminate the al string
4333 ++s;
4334 param = s;
4335 s = strchr(s, '}');
4336 if (!s) {
4337 self_destruct();
4338 return;
4339 }
4340 *s = '\0';
4341 } else
4342 param = NULL;
4343
4344 if (strcmp(al, Ssl::CertAdaptAlgorithmStr[Ssl::algSetValidAfter]) == 0) {
4345 ca->alg = Ssl::algSetValidAfter;
4346 ca->param = xstrdup("on");
4347 } else if (strcmp(al, Ssl::CertAdaptAlgorithmStr[Ssl::algSetValidBefore]) == 0) {
4348 ca->alg = Ssl::algSetValidBefore;
4349 ca->param = xstrdup("on");
4350 } else if (strcmp(al, Ssl::CertAdaptAlgorithmStr[Ssl::algSetCommonName]) == 0) {
4351 ca->alg = Ssl::algSetCommonName;
4352 if (param) {
4353 if (strlen(param) > 64) {
4354 debugs(3, DBG_CRITICAL, "FATAL: sslproxy_cert_adapt: setCommonName{" <<param << "} : using common name longer than 64 bytes is not supported");
4355 self_destruct();
4356 return;
4357 }
4358 ca->param = xstrdup(param);
4359 }
4360 } else {
4361 debugs(3, DBG_CRITICAL, "FATAL: sslproxy_cert_adapt: unknown cert adaptation algorithm: " << al);
4362 self_destruct();
4363 return;
4364 }
4365
4366 aclParseAclList(LegacyParser, &ca->aclList, al);
4367
4368 while (*cert_adapt)
4369 cert_adapt = &(*cert_adapt)->next;
4370
4371 *cert_adapt = ca;
4372 }
4373
4374 static void dump_sslproxy_cert_adapt(StoreEntry *entry, const char *name, sslproxy_cert_adapt *cert_adapt)
4375 {
4376 for (sslproxy_cert_adapt *ca = cert_adapt; ca != NULL; ca = ca->next) {
4377 storeAppendPrintf(entry, "%s ", name);
4378 storeAppendPrintf(entry, "%s{%s} ", Ssl::sslCertAdaptAlgoritm(ca->alg), ca->param);
4379 if (ca->aclList)
4380 dump_acl_list(entry, ca->aclList);
4381 storeAppendPrintf(entry, "\n");
4382 }
4383 }
4384
4385 static void free_sslproxy_cert_adapt(sslproxy_cert_adapt **cert_adapt)
4386 {
4387 while (*cert_adapt) {
4388 sslproxy_cert_adapt *ca = *cert_adapt;
4389 *cert_adapt = ca->next;
4390 safe_free(ca->param);
4391
4392 if (ca->aclList)
4393 aclDestroyAclList(&ca->aclList);
4394
4395 safe_free(ca);
4396 }
4397 }
4398
4399 static void parse_sslproxy_cert_sign(sslproxy_cert_sign **cert_sign)
4400 {
4401 char *al;
4402 sslproxy_cert_sign *cs = (sslproxy_cert_sign *) xcalloc(1, sizeof(sslproxy_cert_sign));
4403 if ((al = ConfigParser::NextToken()) == NULL) {
4404 self_destruct();
4405 return;
4406 }
4407
4408 if (strcmp(al, Ssl::CertSignAlgorithmStr[Ssl::algSignTrusted]) == 0)
4409 cs->alg = Ssl::algSignTrusted;
4410 else if (strcmp(al, Ssl::CertSignAlgorithmStr[Ssl::algSignUntrusted]) == 0)
4411 cs->alg = Ssl::algSignUntrusted;
4412 else if (strcmp(al, Ssl::CertSignAlgorithmStr[Ssl::algSignSelf]) == 0)
4413 cs->alg = Ssl::algSignSelf;
4414 else {
4415 debugs(3, DBG_CRITICAL, "FATAL: sslproxy_cert_sign: unknown cert signing algorithm: " << al);
4416 self_destruct();
4417 return;
4418 }
4419
4420 aclParseAclList(LegacyParser, &cs->aclList, al);
4421
4422 while (*cert_sign)
4423 cert_sign = &(*cert_sign)->next;
4424
4425 *cert_sign = cs;
4426 }
4427
4428 static void dump_sslproxy_cert_sign(StoreEntry *entry, const char *name, sslproxy_cert_sign *cert_sign)
4429 {
4430 sslproxy_cert_sign *cs;
4431 for (cs = cert_sign; cs != NULL; cs = cs->next) {
4432 storeAppendPrintf(entry, "%s ", name);
4433 storeAppendPrintf(entry, "%s ", Ssl::certSignAlgorithm(cs->alg));
4434 if (cs->aclList)
4435 dump_acl_list(entry, cs->aclList);
4436 storeAppendPrintf(entry, "\n");
4437 }
4438 }
4439
4440 static void free_sslproxy_cert_sign(sslproxy_cert_sign **cert_sign)
4441 {
4442 while (*cert_sign) {
4443 sslproxy_cert_sign *cs = *cert_sign;
4444 *cert_sign = cs->next;
4445
4446 if (cs->aclList)
4447 aclDestroyAclList(&cs->aclList);
4448
4449 safe_free(cs);
4450 }
4451 }
4452
4453 class sslBumpCfgRr: public ::RegisteredRunner
4454 {
4455 public:
4456 static Ssl::BumpMode lastDeprecatedRule;
4457 /* RegisteredRunner API */
4458 virtual void finalizeConfig();
4459 };
4460
4461 Ssl::BumpMode sslBumpCfgRr::lastDeprecatedRule = Ssl::bumpEnd;
4462
4463 RunnerRegistrationEntry(sslBumpCfgRr);
4464
4465 void
4466 sslBumpCfgRr::finalizeConfig()
4467 {
4468 if (lastDeprecatedRule != Ssl::bumpEnd) {
4469 assert( lastDeprecatedRule == Ssl::bumpClientFirst || lastDeprecatedRule == Ssl::bumpNone);
4470 static char buf[1024];
4471 if (lastDeprecatedRule == Ssl::bumpClientFirst) {
4472 strcpy(buf, "ssl_bump deny all");
4473 debugs(3, DBG_CRITICAL, "WARNING: auto-converting deprecated implicit "
4474 "\"ssl_bump deny all\" to \"ssl_bump none all\". New ssl_bump configurations "
4475 "must not use implicit rules. Update your ssl_bump rules.");
4476 } else {
4477 strcpy(buf, "ssl_bump allow all");
4478 debugs(3, DBG_CRITICAL, "SECURITY NOTICE: auto-converting deprecated implicit "
4479 "\"ssl_bump allow all\" to \"ssl_bump client-first all\" which is usually "
4480 "inferior to the newer server-first bumping mode. New ssl_bump"
4481 " configurations must not use implicit rules. Update your ssl_bump rules.");
4482 }
4483 parse_line(buf);
4484 }
4485 }
4486
4487 static void parse_sslproxy_ssl_bump(acl_access **ssl_bump)
4488 {
4489 typedef const char *BumpCfgStyle;
4490 BumpCfgStyle bcsNone = NULL;
4491 BumpCfgStyle bcsNew = "new client/server-first/none";
4492 BumpCfgStyle bcsOld = "deprecated allow/deny";
4493 static BumpCfgStyle bumpCfgStyleLast = bcsNone;
4494 BumpCfgStyle bumpCfgStyleNow = bcsNone;
4495 char *bm;
4496 if ((bm = ConfigParser::NextToken()) == NULL) {
4497 self_destruct();
4498 return;
4499 }
4500
4501 // if this is the first rule proccessed
4502 if (*ssl_bump == NULL) {
4503 bumpCfgStyleLast = bcsNone;
4504 sslBumpCfgRr::lastDeprecatedRule = Ssl::bumpEnd;
4505 }
4506
4507 allow_t action = allow_t(ACCESS_ALLOWED);
4508
4509 if (strcmp(bm, Ssl::BumpModeStr[Ssl::bumpClientFirst]) == 0) {
4510 action.kind = Ssl::bumpClientFirst;
4511 bumpCfgStyleNow = bcsNew;
4512 } else if (strcmp(bm, Ssl::BumpModeStr[Ssl::bumpServerFirst]) == 0) {
4513 action.kind = Ssl::bumpServerFirst;
4514 bumpCfgStyleNow = bcsNew;
4515 } else if (strcmp(bm, Ssl::BumpModeStr[Ssl::bumpPeek]) == 0) {
4516 action.kind = Ssl::bumpPeek;
4517 bumpCfgStyleNow = bcsNew;
4518 } else if (strcmp(bm, Ssl::BumpModeStr[Ssl::bumpStare]) == 0) {
4519 action.kind = Ssl::bumpStare;
4520 bumpCfgStyleNow = bcsNew;
4521 } else if (strcmp(bm, Ssl::BumpModeStr[Ssl::bumpSplice]) == 0) {
4522 action.kind = Ssl::bumpSplice;
4523 bumpCfgStyleNow = bcsNew;
4524 } else if (strcmp(bm, Ssl::BumpModeStr[Ssl::bumpBump]) == 0) {
4525 action.kind = Ssl::bumpBump;
4526 bumpCfgStyleNow = bcsNew;
4527 } else if (strcmp(bm, Ssl::BumpModeStr[Ssl::bumpTerminate]) == 0) {
4528 action.kind = Ssl::bumpTerminate;
4529 bumpCfgStyleNow = bcsNew;
4530 } else if (strcmp(bm, Ssl::BumpModeStr[Ssl::bumpNone]) == 0) {
4531 action.kind = Ssl::bumpNone;
4532 bumpCfgStyleNow = bcsNew;
4533 } else if (strcmp(bm, "allow") == 0) {
4534 debugs(3, DBG_CRITICAL, "SECURITY NOTICE: auto-converting deprecated "
4535 "\"ssl_bump allow <acl>\" to \"ssl_bump client-first <acl>\" which "
4536 "is usually inferior to the newer server-first "
4537 "bumping mode. Update your ssl_bump rules.");
4538 action.kind = Ssl::bumpClientFirst;
4539 bumpCfgStyleNow = bcsOld;
4540 sslBumpCfgRr::lastDeprecatedRule = Ssl::bumpClientFirst;
4541 } else if (strcmp(bm, "deny") == 0) {
4542 debugs(3, DBG_CRITICAL, "WARNING: auto-converting deprecated "
4543 "\"ssl_bump deny <acl>\" to \"ssl_bump none <acl>\". Update "
4544 "your ssl_bump rules.");
4545 action.kind = Ssl::bumpNone;
4546 bumpCfgStyleNow = bcsOld;
4547 sslBumpCfgRr::lastDeprecatedRule = Ssl::bumpNone;
4548 } else {
4549 debugs(3, DBG_CRITICAL, "FATAL: unknown ssl_bump mode: " << bm);
4550 self_destruct();
4551 return;
4552 }
4553
4554 if (bumpCfgStyleLast != bcsNone && bumpCfgStyleNow != bumpCfgStyleLast) {
4555 debugs(3, DBG_CRITICAL, "FATAL: do not mix " << bumpCfgStyleNow << " actions with " <<
4556 bumpCfgStyleLast << " actions. Update your ssl_bump rules.");
4557 self_destruct();
4558 return;
4559 }
4560
4561 bumpCfgStyleLast = bumpCfgStyleNow;
4562
4563 Acl::AndNode *rule = new Acl::AndNode;
4564 rule->context("(ssl_bump rule)", config_input_line);
4565 rule->lineParse();
4566 // empty rule OK
4567
4568 assert(ssl_bump);
4569 if (!*ssl_bump) {
4570 *ssl_bump = new Acl::Tree;
4571 (*ssl_bump)->context("(ssl_bump rules)", config_input_line);
4572 }
4573
4574 (*ssl_bump)->add(rule, action);
4575 }
4576
4577 static void dump_sslproxy_ssl_bump(StoreEntry *entry, const char *name, acl_access *ssl_bump)
4578 {
4579 if (ssl_bump)
4580 dump_SBufList(entry, ssl_bump->treeDump(name, Ssl::BumpModeStr));
4581 }
4582
4583 static void free_sslproxy_ssl_bump(acl_access **ssl_bump)
4584 {
4585 free_acl_access(ssl_bump);
4586 }
4587
4588 #endif
4589
4590 static void dump_HeaderWithAclList(StoreEntry * entry, const char *name, HeaderWithAclList *headers)
4591 {
4592 if (!headers)
4593 return;
4594
4595 for (HeaderWithAclList::iterator hwa = headers->begin(); hwa != headers->end(); ++hwa) {
4596 storeAppendPrintf(entry, "%s %s %s", name, hwa->fieldName.c_str(), hwa->fieldValue.c_str());
4597 if (hwa->aclList)
4598 dump_acl_list(entry, hwa->aclList);
4599 storeAppendPrintf(entry, "\n");
4600 }
4601 }
4602
4603 static void parse_HeaderWithAclList(HeaderWithAclList **headers)
4604 {
4605 char *fn;
4606 if (!*headers) {
4607 *headers = new HeaderWithAclList;
4608 }
4609 if ((fn = ConfigParser::NextToken()) == NULL) {
4610 self_destruct();
4611 return;
4612 }
4613 HeaderWithAcl hwa;
4614 hwa.fieldName = fn;
4615 hwa.fieldId = Http::HeaderLookupTable.lookup(hwa.fieldName).id;
4616 if (hwa.fieldId == Http::HdrType::BAD_HDR)
4617 hwa.fieldId = Http::HdrType::OTHER;
4618
4619 Format::Format *nlf = new ::Format::Format("hdrWithAcl");
4620 ConfigParser::EnableMacros();
4621 String buf = ConfigParser::NextQuotedToken();
4622 ConfigParser::DisableMacros();
4623 hwa.fieldValue = buf.termedBuf();
4624 hwa.quoted = ConfigParser::LastTokenWasQuoted();
4625 if (hwa.quoted) {
4626 if (!nlf->parse(hwa.fieldValue.c_str())) {
4627 self_destruct();
4628 return;
4629 }
4630 hwa.valueFormat = nlf;
4631 } else
4632 delete nlf;
4633 aclParseAclList(LegacyParser, &hwa.aclList, (hwa.fieldName + ':' + hwa.fieldValue).c_str());
4634 (*headers)->push_back(hwa);
4635 }
4636
4637 static void free_HeaderWithAclList(HeaderWithAclList **header)
4638 {
4639 if (!(*header))
4640 return;
4641
4642 for (HeaderWithAclList::iterator hwa = (*header)->begin(); hwa != (*header)->end(); ++hwa) {
4643 if (hwa->aclList)
4644 aclDestroyAclList(&hwa->aclList);
4645
4646 if (hwa->valueFormat) {
4647 delete hwa->valueFormat;
4648 hwa->valueFormat = NULL;
4649 }
4650 }
4651 delete *header;
4652 *header = NULL;
4653 }
4654
4655 static void parse_note(Notes *notes)
4656 {
4657 assert(notes);
4658 notes->parse(LegacyParser);
4659 }
4660
4661 static void dump_note(StoreEntry *entry, const char *name, Notes &notes)
4662 {
4663 notes.dump(entry, name);
4664 }
4665
4666 static void free_note(Notes *notes)
4667 {
4668 notes->clean();
4669 }
4670
4671 static bool FtpEspvDeprecated = false;
4672 static void parse_ftp_epsv(acl_access **ftp_epsv)
4673 {
4674 allow_t ftpEpsvDeprecatedAction;
4675 bool ftpEpsvIsDeprecatedRule = false;
4676
4677 char *t = ConfigParser::PeekAtToken();
4678 if (!t) {
4679 self_destruct();
4680 return;
4681 }
4682
4683 if (!strcmp(t, "off")) {
4684 (void)ConfigParser::NextToken();
4685 ftpEpsvIsDeprecatedRule = true;
4686 ftpEpsvDeprecatedAction = allow_t(ACCESS_DENIED);
4687 } else if (!strcmp(t, "on")) {
4688 (void)ConfigParser::NextToken();
4689 ftpEpsvIsDeprecatedRule = true;
4690 ftpEpsvDeprecatedAction = allow_t(ACCESS_ALLOWED);
4691 }
4692
4693 // Check for mixing "ftp_epsv on|off" and "ftp_epsv allow|deny .." rules:
4694 // 1) if this line is "ftp_epsv allow|deny ..." and already exist rules of "ftp_epsv on|off"
4695 // 2) if this line is "ftp_epsv on|off" and already exist rules of "ftp_epsv allow|deny ..."
4696 // then abort
4697 if ((!ftpEpsvIsDeprecatedRule && FtpEspvDeprecated) ||
4698 (ftpEpsvIsDeprecatedRule && !FtpEspvDeprecated && *ftp_epsv != NULL)) {
4699 debugs(3, DBG_CRITICAL, "FATAL: do not mix \"ftp_epsv on|off\" cfg lines with \"ftp_epsv allow|deny ...\" cfg lines. Update your ftp_epsv rules.");
4700 self_destruct();
4701 }
4702
4703 if (ftpEpsvIsDeprecatedRule) {
4704 // overwrite previous ftp_epsv lines
4705 delete *ftp_epsv;
4706 if (ftpEpsvDeprecatedAction == allow_t(ACCESS_DENIED)) {
4707 Acl::AndNode *ftpEpsvRule = new Acl::AndNode;
4708 ftpEpsvRule->context("(ftp_epsv rule)", config_input_line);
4709 ACL *a = ACL::FindByName("all");
4710 if (!a) {
4711 self_destruct();
4712 return;
4713 }
4714 ftpEpsvRule->add(a);
4715 *ftp_epsv = new Acl::Tree;
4716 (*ftp_epsv)->context("(ftp_epsv rules)", config_input_line);
4717 (*ftp_epsv)->add(ftpEpsvRule, ftpEpsvDeprecatedAction);
4718 } else
4719 *ftp_epsv = NULL;
4720 FtpEspvDeprecated = true;
4721 } else {
4722 aclParseAccessLine(cfg_directive, LegacyParser, ftp_epsv);
4723 }
4724 }
4725
4726 static void dump_ftp_epsv(StoreEntry *entry, const char *name, acl_access *ftp_epsv)
4727 {
4728 if (ftp_epsv)
4729 dump_SBufList(entry, ftp_epsv->treeDump(name, NULL));
4730 }
4731
4732 static void free_ftp_epsv(acl_access **ftp_epsv)
4733 {
4734 free_acl_access(ftp_epsv);
4735 FtpEspvDeprecated = false;
4736 }
4737
4738 static void
4739 parse_UrlHelperTimeout(SquidConfig::UrlHelperTimeout *config)
4740 {
4741 time_msec_t tval;
4742 parseTimeLine(&tval, T_SECOND_STR, false, true);
4743 Config.Timeout.urlRewrite = static_cast<time_t>(tval/1000);
4744
4745 char *key, *value;
4746 while(ConfigParser::NextKvPair(key, value)) {
4747 if (strcasecmp(key, "on_timeout") == 0) {
4748 if (strcasecmp(value, "bypass") == 0)
4749 config->action = toutActBypass;
4750 else if (strcasecmp(value, "fail") == 0)
4751 config->action = toutActFail;
4752 else if (strcasecmp(value, "retry") == 0)
4753 config->action = toutActRetry;
4754 else if (strcasecmp(value, "use_configured_response") == 0) {
4755 config->action = toutActUseConfiguredResponse;
4756 } else {
4757 debugs(3, DBG_CRITICAL, "FATAL: unsuported \"on_timeout\" action:" << value);
4758 self_destruct();
4759 }
4760 } else if (strcasecmp(key, "response") == 0) {
4761 config->response = xstrdup(value);
4762 } else {
4763 debugs(3, DBG_CRITICAL, "FATAL: unsuported option " << key);
4764 self_destruct();
4765 }
4766 }
4767
4768 if (config->action == toutActUseConfiguredResponse && !config->response) {
4769 debugs(3, DBG_CRITICAL, "FATAL: Expected 'response=' option after 'on_timeout=use_configured_response' option");
4770 self_destruct();
4771 }
4772
4773 if (config->action != toutActUseConfiguredResponse && config->response) {
4774 debugs(3, DBG_CRITICAL, "FATAL: 'response=' option is valid only when used with the 'on_timeout=use_configured_response' option");
4775 self_destruct();
4776 }
4777 }
4778
4779 static void
4780 dump_UrlHelperTimeout(StoreEntry *entry, const char *name, SquidConfig::UrlHelperTimeout &config)
4781 {
4782 const char *onTimedOutActions[] = {"bypass", "fail", "retry", "use_configured_response"};
4783 assert(config.action >= 0 && config.action <= toutActUseConfiguredResponse);
4784
4785 dump_time_t(entry, name, Config.Timeout.urlRewrite);
4786 storeAppendPrintf(entry, " on_timeout=%s", onTimedOutActions[config.action]);
4787
4788 if (config.response)
4789 storeAppendPrintf(entry, " response=\"%s\"", config.response);
4790
4791 storeAppendPrintf(entry, "\n");
4792 }
4793
4794 static void
4795 free_UrlHelperTimeout(SquidConfig::UrlHelperTimeout *config)
4796 {
4797 Config.Timeout.urlRewrite = 0;
4798 config->action = 0;
4799 safe_free(config->response);
4800 }
4801
4802 static void
4803 parse_configuration_includes_quoted_values(bool *)
4804 {
4805 int val = 0;
4806 parse_onoff(&val);
4807
4808 // If quoted values is set to on then enable new strict mode parsing
4809 if (val) {
4810 ConfigParser::RecognizeQuotedValues = true;
4811 ConfigParser::StrictMode = true;
4812 } else {
4813 ConfigParser::RecognizeQuotedValues = false;
4814 ConfigParser::StrictMode = false;
4815 }
4816 }
4817
4818 static void
4819 dump_configuration_includes_quoted_values(StoreEntry *const entry, const char *const name, bool)
4820 {
4821 int val = ConfigParser::RecognizeQuotedValues ? 1 : 0;
4822 dump_onoff(entry, name, val);
4823 }
4824
4825 static void
4826 free_configuration_includes_quoted_values(bool *)
4827 {
4828 ConfigParser::RecognizeQuotedValues = false;
4829 ConfigParser::StrictMode = false;
4830 }
4831
4832 static void
4833 parse_on_unsupported_protocol(acl_access **access)
4834 {
4835 char *tm;
4836 if ((tm = ConfigParser::NextToken()) == NULL) {
4837 self_destruct();
4838 return;
4839 }
4840
4841 allow_t action = allow_t(ACCESS_ALLOWED);
4842 if (strcmp(tm, "tunnel") == 0)
4843 action.kind = 1;
4844 else if (strcmp(tm, "respond") == 0)
4845 action.kind = 2;
4846 else {
4847 debugs(3, DBG_CRITICAL, "FATAL: unknown on_unsupported_protocol mode: " << tm);
4848 self_destruct();
4849 return;
4850 }
4851
4852 Acl::AndNode *rule = new Acl::AndNode;
4853 rule->context("(on_unsupported_protocol rule)", config_input_line);
4854 rule->lineParse();
4855 // empty rule OK
4856
4857 assert(access);
4858 if (!*access) {
4859 *access = new Acl::Tree;
4860 (*access)->context("(on_unsupported_protocol rules)", config_input_line);
4861 }
4862
4863 (*access)->add(rule, action);
4864 }
4865
4866 static void
4867 dump_on_unsupported_protocol(StoreEntry *entry, const char *name, acl_access *access)
4868 {
4869 const char *on_error_tunnel_mode_str[] = {
4870 "none",
4871 "tunnel",
4872 "respond",
4873 NULL
4874 };
4875 if (access) {
4876 SBufList lines = access->treeDump(name, on_error_tunnel_mode_str);
4877 dump_SBufList(entry, lines);
4878 }
4879 }
4880
4881 static void
4882 free_on_unsupported_protocol(acl_access **access)
4883 {
4884 free_acl_access(access);
4885 }
4886