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