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