2 * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
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.
9 /* DEBUG: section 03 Configuration File Parsing */
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"
19 #include "anyp/PortCfg.h"
20 #include "anyp/UriScheme.h"
21 #include "auth/Config.h"
22 #include "auth/Scheme.h"
24 #include "base/RunnersRegistry.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"
35 #include "HttpHeaderTools.h"
36 #include "icmp/IcmpConfig.h"
37 #include "ident/Config.h"
38 #include "ip/Intercept.h"
39 #include "ip/QosConfig.h"
42 #include "log/Config.h"
43 #include "log/CustomLog.h"
45 #include "MessageDelayPools.h"
46 #include "mgr/ActionPasswordList.h"
47 #include "mgr/Registration.h"
48 #include "neighbors.h"
49 #include "NeighborTypeDomainList.h"
52 #include "PeerDigest.h"
53 #include "PeerPoolMgr.h"
55 #include "RefreshPattern.h"
57 #include "sbuf/List.h"
58 #include "SquidConfig.h"
59 #include "SquidString.h"
60 #include "ssl/ProxyCerts.h"
62 #include "store/Disk.h"
63 #include "store/Disks.h"
64 #include "StoreFileSystem.h"
68 /* wccp2 has its own conditional definitions */
71 #include "adaptation/Config.h"
74 #include "adaptation/icap/Config.h"
77 #include "adaptation/ecap/Config.h"
80 #include "ssl/Config.h"
81 #include "ssl/support.h"
84 #include "esi/Parser.h"
102 #include <sys/stat.h>
106 #include "ssl/gadgets.h"
110 static void parse_adaptation_service_set_type();
111 static void parse_adaptation_service_chain_type();
112 static void parse_adaptation_access_type();
116 static void parse_icap_service_type(Adaptation::Icap::Config
*);
117 static void dump_icap_service_type(StoreEntry
*, const char *, const Adaptation::Icap::Config
&);
118 static void free_icap_service_type(Adaptation::Icap::Config
*);
119 static void parse_icap_class_type();
120 static void parse_icap_access_type();
122 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*);
123 static void dump_icap_service_failure_limit(StoreEntry
*, const char *, const Adaptation::Icap::Config
&);
124 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*);
128 static void parse_ecap_service_type(Adaptation::Ecap::Config
*);
129 static void dump_ecap_service_type(StoreEntry
*, const char *, const Adaptation::Ecap::Config
&);
130 static void free_ecap_service_type(Adaptation::Ecap::Config
*);
133 static peer_t
parseNeighborType(const char *s
);
135 static const char *const T_MILLISECOND_STR
= "millisecond";
136 static const char *const T_SECOND_STR
= "second";
137 static const char *const T_MINUTE_STR
= "minute";
138 static const char *const T_HOUR_STR
= "hour";
139 static const char *const T_DAY_STR
= "day";
140 static const char *const T_WEEK_STR
= "week";
141 static const char *const T_FORTNIGHT_STR
= "fortnight";
142 static const char *const T_MONTH_STR
= "month";
143 static const char *const T_YEAR_STR
= "year";
144 static const char *const T_DECADE_STR
= "decade";
146 static const char *const B_BYTES_STR
= "bytes";
147 static const char *const B_KBYTES_STR
= "KB";
148 static const char *const B_MBYTES_STR
= "MB";
149 static const char *const B_GBYTES_STR
= "GB";
151 static const char *const list_sep
= ", \t\n\r";
153 static void parse_access_log(CustomLog
** customlog_definitions
);
154 static int check_null_access_log(CustomLog
*customlog_definitions
);
155 static void dump_access_log(StoreEntry
* entry
, const char *name
, CustomLog
* definitions
);
156 static void free_access_log(CustomLog
** definitions
);
157 static bool setLogformat(CustomLog
*cl
, const char *name
, const bool dieWhenMissing
);
159 static void configDoConfigure(void);
160 static void parse_refreshpattern(RefreshPattern
**);
161 static uint64_t parseTimeUnits(const char *unit
, bool allowMsec
);
162 static void parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
, bool expectMoreArguments
);
163 static void parse_u_short(unsigned short * var
);
164 static void parse_string(char **);
165 static void default_all(void);
166 static void defaults_if_none(void);
167 static void defaults_postscriptum(void);
168 static int parse_line(char *);
169 static void parse_obsolete(const char *);
170 static void parseBytesLine(size_t * bptr
, const char *units
);
172 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
);
174 static void parseBytesLineSigned(ssize_t
* bptr
, const char *units
);
175 static size_t parseBytesUnits(const char *unit
);
176 static void free_all(void);
177 void requirePathnameExists(const char *name
, const char *path
);
178 static OBJH dump_config
;
179 #if USE_HTTP_VIOLATIONS
180 static void free_HeaderManglers(HeaderManglers
**pm
);
181 static void dump_http_header_access(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
);
182 static void parse_http_header_access(HeaderManglers
**manglers
);
183 #define free_http_header_access free_HeaderManglers
184 static void dump_http_header_replace(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
);
185 static void parse_http_header_replace(HeaderManglers
**manglers
);
186 #define free_http_header_replace free_HeaderManglers
188 static void dump_HeaderWithAclList(StoreEntry
* entry
, const char *name
, HeaderWithAclList
*headers
);
189 static void parse_HeaderWithAclList(HeaderWithAclList
**header
);
190 static void free_HeaderWithAclList(HeaderWithAclList
**header
);
191 static void parse_note(Notes
*);
192 static void dump_note(StoreEntry
*, const char *, Notes
&);
193 static void free_note(Notes
*);
194 static void parse_denyinfo(AclDenyInfoList
** var
);
195 static void dump_denyinfo(StoreEntry
* entry
, const char *name
, AclDenyInfoList
* var
);
196 static void free_denyinfo(AclDenyInfoList
** var
);
199 static void parse_IpAddress_list(Ip::Address_list
**);
200 static void dump_IpAddress_list(StoreEntry
*, const char *, const Ip::Address_list
*);
201 static void free_IpAddress_list(Ip::Address_list
**);
203 static int check_null_IpAddress_list(const Ip::Address_list
*);
204 #endif /* CURRENTLY_UNUSED */
205 #endif /* USE_WCCPv2 */
207 static void parsePortCfg(AnyP::PortCfgPointer
*, const char *protocol
);
208 #define parse_PortCfg(l) parsePortCfg((l), token)
209 static void dump_PortCfg(StoreEntry
*, const char *, const AnyP::PortCfgPointer
&);
210 #define free_PortCfg(h) *(h)=NULL
213 static void parse_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
);
214 static void dump_sslproxy_cert_sign(StoreEntry
*entry
, const char *name
, sslproxy_cert_sign
*cert_sign
);
215 static void free_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
);
216 static void parse_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
);
217 static void dump_sslproxy_cert_adapt(StoreEntry
*entry
, const char *name
, sslproxy_cert_adapt
*cert_adapt
);
218 static void free_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
);
219 static void parse_sslproxy_ssl_bump(acl_access
**ssl_bump
);
220 static void dump_sslproxy_ssl_bump(StoreEntry
*entry
, const char *name
, acl_access
*ssl_bump
);
221 static void free_sslproxy_ssl_bump(acl_access
**ssl_bump
);
222 #endif /* USE_OPENSSL */
224 static void parse_ftp_epsv(acl_access
**ftp_epsv
);
225 static void dump_ftp_epsv(StoreEntry
*entry
, const char *name
, acl_access
*ftp_epsv
);
226 static void free_ftp_epsv(acl_access
**ftp_epsv
);
228 static void parse_b_size_t(size_t * var
);
229 static void parse_b_int64_t(int64_t * var
);
231 static void parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
);
232 static void dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
);
233 static void free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
);
235 static void parse_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*);
236 static void dump_UrlHelperTimeout(StoreEntry
*, const char *, SquidConfig::UrlHelperTimeout
&);
237 static void free_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*);
239 static int parseOneConfigFile(const char *file_name
, unsigned int depth
);
241 static void parse_configuration_includes_quoted_values(bool *recognizeQuotedValues
);
242 static void dump_configuration_includes_quoted_values(StoreEntry
*const entry
, const char *const name
, bool recognizeQuotedValues
);
243 static void free_configuration_includes_quoted_values(bool *recognizeQuotedValues
);
244 static void parse_on_unsupported_protocol(acl_access
**access
);
245 static void dump_on_unsupported_protocol(StoreEntry
*entry
, const char *name
, acl_access
*access
);
246 static void free_on_unsupported_protocol(acl_access
**access
);
247 static void ParseAclWithAction(acl_access
**access
, const allow_t
&action
, const char *desc
, ACL
*acl
= nullptr);
250 * LegacyParser is a parser for legacy code that uses the global
251 * approach. This is static so that it is only exposed to cache_cf.
252 * Other modules needing access to a ConfigParser should have it
253 * provided to them in their parserFOO methods.
255 static ConfigParser LegacyParser
= ConfigParser();
260 LegacyParser
.destruct();
264 SetConfigFilename(char const *file_name
, bool is_pipe
)
267 cfg_filename
= file_name
+ 1;
269 cfg_filename
= file_name
;
273 skip_ws(const char* s
)
282 parseManyConfigFiles(char* files
, int depth
)
285 char* saveptr
= NULL
;
290 memset(&globbuf
, 0, sizeof(globbuf
));
291 for (path
= strwordtok(files
, &saveptr
); path
; path
= strwordtok(NULL
, &saveptr
)) {
292 if (glob(path
, globbuf
.gl_pathc
? GLOB_APPEND
: 0, NULL
, &globbuf
) != 0) {
294 fatalf("Unable to find configuration file: %s: %s", path
, xstrerr(xerrno
));
297 for (i
= 0; i
< (int)globbuf
.gl_pathc
; ++i
) {
298 error_count
+= parseOneConfigFile(globbuf
.gl_pathv
[i
], depth
);
302 char* file
= strwordtok(files
, &saveptr
);
303 while (file
!= NULL
) {
304 error_count
+= parseOneConfigFile(file
, depth
);
305 file
= strwordtok(NULL
, &saveptr
);
307 #endif /* HAVE_GLOB */
312 ReplaceSubstr(char*& str
, int& len
, unsigned substrIdx
, unsigned substrLen
, const char* newSubstr
)
315 assert(newSubstr
!= NULL
);
317 unsigned newSubstrLen
= strlen(newSubstr
);
318 if (newSubstrLen
> substrLen
)
319 str
= (char*)realloc(str
, len
- substrLen
+ newSubstrLen
+ 1);
321 // move tail part including zero
322 memmove(str
+ substrIdx
+ newSubstrLen
, str
+ substrIdx
+ substrLen
, len
- substrIdx
- substrLen
+ 1);
323 // copy new substring in place
324 memcpy(str
+ substrIdx
, newSubstr
, newSubstrLen
);
330 SubstituteMacro(char*& line
, int& len
, const char* macroName
, const char* substStr
)
332 assert(line
!= NULL
);
333 assert(macroName
!= NULL
);
334 assert(substStr
!= NULL
);
335 unsigned macroNameLen
= strlen(macroName
);
336 while (const char* macroPos
= strstr(line
, macroName
)) // we would replace all occurrences
337 ReplaceSubstr(line
, len
, macroPos
- line
, macroNameLen
, substStr
);
341 ProcessMacros(char*& line
, int& len
)
343 SubstituteMacro(line
, len
, "${service_name}", service_name
.c_str());
344 SubstituteMacro(line
, len
, "${process_name}", TheKidName
);
345 SubstituteMacro(line
, len
, "${process_number}", xitoa(KidIdentifier
));
349 trim_trailing_ws(char* str
)
352 unsigned i
= strlen(str
);
353 while ((i
> 0) && xisspace(str
[i
- 1]))
359 FindStatement(const char* line
, const char* statement
)
361 assert(line
!= NULL
);
362 assert(statement
!= NULL
);
364 const char* str
= skip_ws(line
);
365 unsigned len
= strlen(statement
);
366 if (strncmp(str
, statement
, len
) == 0) {
370 else if (xisspace(*str
))
378 StrToInt(const char* str
, long& number
)
383 number
= strtol(str
, &end
, 0);
385 return (end
!= str
) && (*end
== '\0'); // returns true if string contains nothing except number
389 EvalBoolExpr(const char* expr
)
391 assert(expr
!= NULL
);
392 if (strcmp(expr
, "true") == 0) {
394 } else if (strcmp(expr
, "false") == 0) {
396 } else if (const char* equation
= strchr(expr
, '=')) {
397 const char* rvalue
= skip_ws(equation
+ 1);
398 char* lvalue
= (char*)xmalloc(equation
- expr
+ 1);
399 xstrncpy(lvalue
, expr
, equation
- expr
+ 1);
400 trim_trailing_ws(lvalue
);
403 if (!StrToInt(lvalue
, number1
))
404 fatalf("String is not a integer number: '%s'\n", lvalue
);
406 if (!StrToInt(rvalue
, number2
))
407 fatalf("String is not a integer number: '%s'\n", rvalue
);
410 return number1
== number2
;
412 fatalf("Unable to evaluate expression '%s'\n", expr
);
413 return false; // this place cannot be reached
417 parseOneConfigFile(const char *file_name
, unsigned int depth
)
420 const char *orig_cfg_filename
= cfg_filename
;
421 const int orig_config_lineno
= config_lineno
;
423 char *tmp_line
= NULL
;
424 int tmp_line_len
= 0;
428 debugs(3, DBG_IMPORTANT
, "Processing Configuration File: " << file_name
<< " (depth " << depth
<< ")");
430 fatalf("WARNING: can't include %s: includes are nested too deeply (>16)!\n", file_name
);
434 if (file_name
[0] == '!' || file_name
[0] == '|') {
435 fp
= popen(file_name
+ 1, "r");
438 fp
= fopen(file_name
, "r");
443 fatalf("Unable to open configuration file: %s: %s", file_name
, xstrerr(xerrno
));
447 setmode(fileno(fp
), O_TEXT
);
450 SetConfigFilename(file_name
, bool(is_pipe
));
452 memset(config_input_line
, '\0', BUFSIZ
);
456 std::vector
<bool> if_states
;
457 while (fgets(config_input_line
, BUFSIZ
, fp
)) {
460 if ((token
= strchr(config_input_line
, '\n')))
463 if ((token
= strchr(config_input_line
, '\r')))
466 // strip any prefix whitespace off the line.
467 const char *p
= skip_ws(config_input_line
);
468 if (config_input_line
!= p
)
469 memmove(config_input_line
, p
, strlen(p
)+1);
471 if (strncmp(config_input_line
, "#line ", 6) == 0) {
472 static char new_file_name
[1024];
474 static char new_lineno
;
475 token
= config_input_line
+ 6;
476 new_lineno
= strtol(token
, &file
, 0) - 1;
479 continue; /* Not a valid #line directive, may be a comment */
481 while (*file
&& xisspace((unsigned char) *file
))
486 continue; /* Not a valid #line directive, may be a comment */
488 xstrncpy(new_file_name
, file
+ 1, sizeof(new_file_name
));
490 if ((token
= strchr(new_file_name
, '"')))
493 SetConfigFilename(new_file_name
, false);
496 config_lineno
= new_lineno
;
499 if (config_input_line
[0] == '#')
502 if (config_input_line
[0] == '\0')
505 const char* append
= tmp_line_len
? skip_ws(config_input_line
) : config_input_line
;
507 size_t append_len
= strlen(append
);
509 tmp_line
= (char*)xrealloc(tmp_line
, tmp_line_len
+ append_len
+ 1);
511 strcpy(tmp_line
+ tmp_line_len
, append
);
513 tmp_line_len
+= append_len
;
515 if (tmp_line
[tmp_line_len
-1] == '\\') {
516 debugs(3, 5, "parseConfigFile: tmp_line='" << tmp_line
<< "'");
517 tmp_line
[--tmp_line_len
] = '\0';
521 trim_trailing_ws(tmp_line
);
522 ProcessMacros(tmp_line
, tmp_line_len
);
523 debugs(3, (opt_parse_cfg_only
?1:5), "Processing: " << tmp_line
);
525 if (const char* expr
= FindStatement(tmp_line
, "if")) {
526 if_states
.push_back(EvalBoolExpr(expr
)); // store last if-statement meaning
527 } else if (FindStatement(tmp_line
, "endif")) {
528 if (!if_states
.empty())
529 if_states
.pop_back(); // remove last if-statement meaning
531 fatalf("'endif' without 'if'\n");
532 } else if (FindStatement(tmp_line
, "else")) {
533 if (!if_states
.empty())
534 if_states
.back() = !if_states
.back();
536 fatalf("'else' without 'if'\n");
537 } else if (if_states
.empty() || if_states
.back()) { // test last if-statement meaning if present
538 /* Handle includes here */
539 if (tmp_line_len
>= 9 && strncmp(tmp_line
, "include", 7) == 0 && xisspace(tmp_line
[7])) {
540 err_count
+= parseManyConfigFiles(tmp_line
+ 8, depth
+ 1);
541 } else if (!parse_line(tmp_line
)) {
542 debugs(3, DBG_CRITICAL
, HERE
<< cfg_filename
<< ":" << config_lineno
<< " unrecognized: '" << tmp_line
<< "'");
551 if (!if_states
.empty())
552 fatalf("if-statement without 'endif'\n");
555 int ret
= pclose(fp
);
558 fatalf("parseConfigFile: '%s' failed with exit code %d\n", file_name
, ret
);
563 SetConfigFilename(orig_cfg_filename
, false);
564 config_lineno
= orig_config_lineno
;
571 parseConfigFile(const char *file_name
)
579 ACLMethodData::ThePurgeCount
= 0;
582 err_count
= parseOneConfigFile(file_name
, 0);
586 defaults_postscriptum();
589 * We must call configDoConfigure() before leave_suid() because
590 * configDoConfigure() is where we turn username strings into
595 if (!Config
.chroot_dir
) {
597 setUmask(Config
.umask
);
598 _db_init(Debug::cache_log
, Debug::debugOptions
);
602 if (opt_send_signal
== -1) {
603 Mgr::RegisterAction("config",
604 "Current Squid Configuration",
613 configDoConfigure(void)
616 /* init memory as early as possible */
620 Config
.cacheSwap
.n_strands
= 0; // no diskers by default
621 if (Config
.cacheSwap
.swapDirs
== NULL
) {
622 /* Memory-only cache probably in effect. */
623 /* turn off the cache rebuild delays... */
624 StoreController::store_dirs_rebuilding
= 0;
625 } else if (InDaemonMode()) { // no diskers in non-daemon mode
626 for (int i
= 0; i
< Config
.cacheSwap
.n_configured
; ++i
) {
627 const RefCount
<SwapDir
> sd
= Config
.cacheSwap
.swapDirs
[i
];
628 if (sd
->needsDiskStrand())
629 sd
->disker
= Config
.workers
+ (++Config
.cacheSwap
.n_strands
);
633 if (Debug::rotateNumber
< 0) {
634 Debug::rotateNumber
= Config
.Log
.rotateNumber
;
637 #if SIZEOF_OFF_T <= 4
638 if (Config
.Store
.maxObjectSize
> 0x7FFF0000) {
639 debugs(3, DBG_CRITICAL
, "WARNING: This Squid binary can not handle files larger than 2GB. Limiting maximum_object_size to just below 2GB");
640 Config
.Store
.maxObjectSize
= 0x7FFF0000;
644 if (Config
.Announce
.period
> 0) {
645 Config
.onoff
.announce
= 1;
647 Config
.Announce
.period
= 86400 * 365; /* one year */
648 Config
.onoff
.announce
= 0;
651 if (Config
.onoff
.httpd_suppress_version_string
)
652 visible_appname_string
= (char *)appname_string
;
654 visible_appname_string
= (char const *)APP_FULLNAME
;
656 if (Config
.Program
.redirect
) {
657 if (Config
.redirectChildren
.n_max
< 1) {
658 Config
.redirectChildren
.n_max
= 0;
659 wordlistDestroy(&Config
.Program
.redirect
);
663 if (Config
.Program
.store_id
) {
664 if (Config
.storeIdChildren
.n_max
< 1) {
665 Config
.storeIdChildren
.n_max
= 0;
666 wordlistDestroy(&Config
.Program
.store_id
);
670 if (Config
.appendDomain
)
671 if (*Config
.appendDomain
!= '.')
672 fatal("append_domain must begin with a '.'");
674 if (Config
.errHtmlText
== NULL
)
675 Config
.errHtmlText
= xstrdup(null_string
);
677 #if !HAVE_SETRLIMIT || !defined(RLIMIT_NOFILE)
678 if (Config
.max_filedescriptors
> 0) {
679 debugs(0, DBG_IMPORTANT
, "WARNING: max_filedescriptors disabled. Operating System setrlimit(RLIMIT_NOFILE) is missing.");
681 #elif USE_SELECT || USE_SELECT_WIN32
682 if (Config
.max_filedescriptors
> FD_SETSIZE
) {
683 debugs(0, DBG_IMPORTANT
, "WARNING: max_filedescriptors limited to " << FD_SETSIZE
<< " by select() algorithm.");
689 snprintf(ThisCache
, sizeof(ThisCache
), "%s (%s)",
691 visible_appname_string
);
694 * the extra space is for loop detection in client_side.c -- we search
695 * for substrings in the Via header.
697 snprintf(ThisCache2
, sizeof(ThisCache
), " %s (%s)",
699 visible_appname_string
);
701 /* Use visible_hostname as default surrogate_id */
702 if (!Config
.Accel
.surrogate_id
) {
703 const char *t
= getMyHostname();
704 Config
.Accel
.surrogate_id
= xstrdup( (t
?t
:"unset-id") );
707 if (!Config
.udpMaxHitObjsz
|| Config
.udpMaxHitObjsz
> SQUID_UDP_SO_SNDBUF
)
708 Config
.udpMaxHitObjsz
= SQUID_UDP_SO_SNDBUF
;
710 if (Config
.appendDomain
)
711 Config
.appendDomainLen
= strlen(Config
.appendDomain
);
713 Config
.appendDomainLen
= 0;
715 if (Config
.connect_retries
> 10) {
716 debugs(0,DBG_CRITICAL
, "WARNING: connect_retries cannot be larger than 10. Resetting to 10.");
717 Config
.connect_retries
= 10;
720 requirePathnameExists("MIME Config Table", Config
.mimeTablePathname
);
723 requirePathnameExists("unlinkd_program", Config
.Program
.unlinkd
);
725 requirePathnameExists("logfile_daemon", Log::TheConfig
.logfile_daemon
);
726 if (Config
.Program
.redirect
)
727 requirePathnameExists("redirect_program", Config
.Program
.redirect
->key
);
729 if (Config
.Program
.store_id
)
730 requirePathnameExists("store_id_program", Config
.Program
.store_id
->key
);
732 requirePathnameExists("Icon Directory", Config
.icons
.directory
);
734 if (Config
.errorDirectory
)
735 requirePathnameExists("Error Directory", Config
.errorDirectory
);
737 #if USE_HTTP_VIOLATIONS
740 const RefreshPattern
*R
;
742 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
743 if (!R
->flags
.override_expire
)
746 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'override-expire' in 'refresh_pattern' violates HTTP");
751 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
752 if (!R
->flags
.override_lastmod
)
755 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'override-lastmod' in 'refresh_pattern' violates HTTP");
760 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
761 if (!R
->flags
.reload_into_ims
)
764 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'reload-into-ims' in 'refresh_pattern' violates HTTP");
769 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
770 if (!R
->flags
.ignore_reload
)
773 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-reload' in 'refresh_pattern' violates HTTP");
778 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
779 if (!R
->flags
.ignore_no_store
)
782 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-no-store' in 'refresh_pattern' violates HTTP");
787 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
788 if (!R
->flags
.ignore_private
)
791 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-private' in 'refresh_pattern' violates HTTP");
797 #if !USE_HTTP_VIOLATIONS
798 Config
.onoff
.via
= 1;
801 if (!Config
.onoff
.via
)
802 debugs(22, DBG_IMPORTANT
, "WARNING: HTTP requires the use of Via");
806 // we enable runtime PURGE checks if there is at least one PURGE method ACL
807 // TODO: replace with a dedicated "purge" ACL option?
808 Config2
.onoff
.enable_purge
= (ACLMethodData::ThePurgeCount
> 0);
810 if (geteuid() == 0) {
811 if (NULL
!= Config
.effectiveUser
) {
813 struct passwd
*pwd
= getpwnam(Config
.effectiveUser
);
817 * Andres Kroonmaa <andre@online.ee>:
818 * Some getpwnam() implementations (Solaris?) require
819 * an available FD < 256 for opening a FILE* to the
822 * This should be safe at startup, but might still fail
823 * during reconfigure.
825 fatalf("getpwnam failed to find userid for effective user '%s'",
826 Config
.effectiveUser
);
830 Config2
.effectiveUserID
= pwd
->pw_uid
;
832 Config2
.effectiveGroupID
= pwd
->pw_gid
;
835 if (pwd
->pw_dir
&& *pwd
->pw_dir
) {
836 // putenv() leaks by design; avoid leaks when nothing changes
838 if (lastDir
.isEmpty() || lastDir
.cmp(pwd
->pw_dir
) != 0) {
839 lastDir
= pwd
->pw_dir
;
840 int len
= strlen(pwd
->pw_dir
) + 6;
841 char *env_str
= (char *)xcalloc(len
, 1);
842 snprintf(env_str
, len
, "HOME=%s", pwd
->pw_dir
);
849 Config2
.effectiveUserID
= geteuid();
850 Config2
.effectiveGroupID
= getegid();
853 if (NULL
!= Config
.effectiveGroup
) {
855 struct group
*grp
= getgrnam(Config
.effectiveGroup
);
858 fatalf("getgrnam failed to find groupid for effective group '%s'",
859 Config
.effectiveGroup
);
863 Config2
.effectiveGroupID
= grp
->gr_gid
;
867 if (Config
.ssl_client
.foreignIntermediateCertsPath
)
868 Ssl::loadSquidUntrusted(Config
.ssl_client
.foreignIntermediateCertsPath
);
871 if (Security::ProxyOutgoingConfig
.encryptTransport
) {
872 debugs(3, DBG_IMPORTANT
, "Initializing https:// proxy context");
873 Config
.ssl_client
.sslContext
= Security::ProxyOutgoingConfig
.createClientContext(false);
874 if (!Config
.ssl_client
.sslContext
) {
876 fatal("ERROR: Could not initialize https:// proxy context");
878 debugs(3, DBG_IMPORTANT
, "ERROR: proxying https:// currently still requires --with-openssl");
882 Ssl::useSquidUntrusted(Config
.ssl_client
.sslContext
.get());
886 for (CachePeer
*p
= Config
.peers
; p
!= NULL
; p
= p
->next
) {
888 // default value for ssldomain= is the peer host/IP
889 if (p
->secure
.sslDomain
.isEmpty())
890 p
->secure
.sslDomain
= p
->host
;
892 if (p
->secure
.encryptTransport
) {
893 debugs(3, DBG_IMPORTANT
, "Initializing cache_peer " << p
->name
<< " TLS context");
894 p
->sslContext
= p
->secure
.createClientContext(true);
895 if (!p
->sslContext
) {
896 debugs(3, DBG_CRITICAL
, "ERROR: Could not initialize cache_peer " << p
->name
<< " TLS context");
904 for (AnyP::PortCfgPointer s
= HttpPortList
; s
!= NULL
; s
= s
->next
) {
905 if (!s
->secure
.encryptTransport
)
907 debugs(3, DBG_IMPORTANT
, "Initializing " << AnyP::UriScheme(s
->transport
.protocol
) << "_port " << s
->s
<< " TLS context");
908 s
->configureSslServerContext();
912 // prevent infinite fetch loops in the request parser
913 // due to buffer full but not enough data recived to finish parse
914 if (Config
.maxRequestBufferSize
<= Config
.maxRequestHeaderSize
) {
915 fatalf("Client request buffer of %u bytes cannot hold a request with %u bytes of headers." \
916 " Change client_request_buffer_max or request_header_max_size limits.",
917 (uint32_t)Config
.maxRequestBufferSize
, (uint32_t)Config
.maxRequestHeaderSize
);
921 * Disable client side request pipelining if client_persistent_connections OFF.
922 * Waste of resources queueing any pipelined requests when the first will close the connection.
924 if (Config
.pipeline_max_prefetch
> 0 && !Config
.onoff
.client_pconns
) {
925 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: pipeline_prefetch " << Config
.pipeline_max_prefetch
<<
926 " requires client_persistent_connections ON. Forced pipeline_prefetch 0.");
927 Config
.pipeline_max_prefetch
= 0;
932 * disable client side request pipelining. There is a race with
933 * Negotiate and NTLM when the client sends a second request on an
934 * connection before the authenticate challenge is sent. With
935 * pipelining OFF, the client may fail to authenticate, but squid's
936 * state will be preserved.
938 if (Config
.pipeline_max_prefetch
> 0) {
939 Auth::SchemeConfig
*nego
= Auth::SchemeConfig::Find("Negotiate");
940 Auth::SchemeConfig
*ntlm
= Auth::SchemeConfig::Find("NTLM");
941 if ((nego
&& nego
->active()) || (ntlm
&& ntlm
->active())) {
942 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: pipeline_prefetch breaks NTLM and Negotiate authentication. Forced pipeline_prefetch 0.");
943 Config
.pipeline_max_prefetch
= 0;
947 for (auto &authSchemes
: Auth::TheConfig
.schemeLists
) {
948 authSchemes
.expand();
949 if (authSchemes
.authConfigs
.empty()) {
950 debugs(3, DBG_CRITICAL
, "auth_schemes: at least one scheme name is required; got: " << authSchemes
.rawSchemes
);
957 /** Parse a line containing an obsolete directive.
958 * To upgrade it where possible instead of just "Bungled config" for
959 * directives which cannot be marked as simply aliases of the some name.
960 * For example if the parameter order and content has changed.
961 * Or if the directive has been completely removed.
964 parse_obsolete(const char *name
)
966 // Directives which have been radically changed rather than removed
967 if (!strcmp(name
, "url_rewrite_concurrency")) {
970 debugs(3, DBG_CRITICAL
, "WARNING: url_rewrite_concurrency upgrade overriding url_rewrite_children settings.");
971 Config
.redirectChildren
.concurrency
= cval
;
974 if (!strcmp(name
, "log_access")) {
979 if (!strcmp(name
, "log_icap")) {
984 if (!strcmp(name
, "ignore_ims_on_miss")) {
985 // the replacement directive cache_revalidate_on_miss has opposite meanings for ON/OFF value
986 // than the 2.7 directive. We need to parse and invert the configured value.
989 Config
.onoff
.cache_miss_revalidate
= !temp
;
992 if (!strncmp(name
, "sslproxy_", 9)) {
993 // the replacement directive tls_outgoing_options uses options instead of whole-line input
995 if (!strcmp(name
, "sslproxy_cafile"))
996 tmp
.append("cafile=");
997 else if (!strcmp(name
, "sslproxy_capath"))
998 tmp
.append("capath=");
999 else if (!strcmp(name
, "sslproxy_cipher"))
1000 tmp
.append("cipher=");
1001 else if (!strcmp(name
, "sslproxy_client_certificate"))
1002 tmp
.append("cert=");
1003 else if (!strcmp(name
, "sslproxy_client_key"))
1005 else if (!strcmp(name
, "sslproxy_flags"))
1006 tmp
.append("flags=");
1007 else if (!strcmp(name
, "sslproxy_options"))
1008 tmp
.append("options=");
1009 else if (!strcmp(name
, "sslproxy_version"))
1010 tmp
.append("version=");
1012 debugs(3, DBG_CRITICAL
, "ERROR: unknown directive: " << name
);
1017 // add the value as unquoted-string because the old values did not support whitespace
1018 const char *token
= ConfigParser::NextQuotedOrToEol();
1019 tmp
.append(token
, strlen(token
));
1020 Security::ProxyOutgoingConfig
.parse(tmp
.c_str());
1024 /* Parse a time specification from the config file. Store the
1025 * result in 'tptr', after converting it to 'units' */
1027 parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
, bool expectMoreArguments
= false)
1029 time_msec_t u
= parseTimeUnits(units
, allowMsec
);
1035 char *token
= ConfigParser::NextToken();;
1041 double d
= xatof(token
);
1043 time_msec_t m
= u
; /* default to 'units' if none specified */
1046 if ((token
= ConfigParser::PeekAtToken()) && (m
= parseTimeUnits(token
, allowMsec
))) {
1047 (void)ConfigParser::NextToken();
1049 } else if (!expectMoreArguments
) {
1054 token
= NULL
; // show default units if dying below
1055 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" << config_input_line
<< "', assuming " << d
<< " " << units
);
1058 token
= NULL
; // show default units if dying below.
1060 *tptr
= static_cast<time_msec_t
>(m
* d
);
1062 if (static_cast<double>(*tptr
) * 2 != m
* d
* 2) {
1063 debugs(3, DBG_CRITICAL
, "FATAL: Invalid value '" <<
1064 d
<< " " << (token
? token
: units
) << ": integer overflow (time_msec_t).");
1070 parseTimeUnits(const char *unit
, bool allowMsec
)
1072 if (allowMsec
&& !strncasecmp(unit
, T_MILLISECOND_STR
, strlen(T_MILLISECOND_STR
)))
1075 if (!strncasecmp(unit
, T_SECOND_STR
, strlen(T_SECOND_STR
)))
1078 if (!strncasecmp(unit
, T_MINUTE_STR
, strlen(T_MINUTE_STR
)))
1081 if (!strncasecmp(unit
, T_HOUR_STR
, strlen(T_HOUR_STR
)))
1084 if (!strncasecmp(unit
, T_DAY_STR
, strlen(T_DAY_STR
)))
1085 return 86400 * 1000;
1087 if (!strncasecmp(unit
, T_WEEK_STR
, strlen(T_WEEK_STR
)))
1088 return 86400 * 7 * 1000;
1090 if (!strncasecmp(unit
, T_FORTNIGHT_STR
, strlen(T_FORTNIGHT_STR
)))
1091 return 86400 * 14 * 1000;
1093 if (!strncasecmp(unit
, T_MONTH_STR
, strlen(T_MONTH_STR
)))
1094 return static_cast<uint64_t>(86400) * 30 * 1000;
1096 if (!strncasecmp(unit
, T_YEAR_STR
, strlen(T_YEAR_STR
)))
1097 return static_cast<uint64_t>(86400 * 1000 * 365.2522);
1099 if (!strncasecmp(unit
, T_DECADE_STR
, strlen(T_DECADE_STR
)))
1100 return static_cast<uint64_t>(86400 * 1000 * 365.2522 * 10);
1102 debugs(3, DBG_IMPORTANT
, "parseTimeUnits: unknown time unit '" << unit
<< "'");
1108 parseBytesLine64(int64_t * bptr
, const char *units
)
1115 if ((u
= parseBytesUnits(units
)) == 0) {
1120 if ((token
= ConfigParser::NextToken()) == NULL
) {
1125 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1132 m
= u
; /* default to 'units' if none specified */
1136 else if ((token
= ConfigParser::NextToken()) == NULL
)
1137 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1138 config_input_line
<< "', assuming " <<
1139 d
<< " " << units
);
1140 else if ((m
= parseBytesUnits(token
)) == 0) {
1145 *bptr
= static_cast<int64_t>(m
* d
/ u
);
1147 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1148 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1149 d
<< " " << token
<< ": integer overflow (int64_t).");
1155 parseBytesLine(size_t * bptr
, const char *units
)
1162 if ((u
= parseBytesUnits(units
)) == 0) {
1167 if ((token
= ConfigParser::NextToken()) == NULL
) {
1172 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1173 *bptr
= static_cast<size_t>(-1);
1179 m
= u
; /* default to 'units' if none specified */
1183 else if ((token
= ConfigParser::NextToken()) == NULL
)
1184 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1185 config_input_line
<< "', assuming " <<
1186 d
<< " " << units
);
1187 else if ((m
= parseBytesUnits(token
)) == 0) {
1192 *bptr
= static_cast<size_t>(m
* d
/ u
);
1194 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1195 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1196 d
<< " " << token
<< ": integer overflow (size_t).");
1202 parseBytesLineSigned(ssize_t
* bptr
, const char *units
)
1209 if ((u
= parseBytesUnits(units
)) == 0) {
1214 if ((token
= ConfigParser::NextToken()) == NULL
) {
1219 if (strcmp(token
, "none") == 0 || token
[0] == '-' /* -N */) {
1226 m
= u
; /* default to 'units' if none specified */
1230 else if ((token
= ConfigParser::NextToken()) == NULL
)
1231 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1232 config_input_line
<< "', assuming " <<
1233 d
<< " " << units
);
1234 else if ((m
= parseBytesUnits(token
)) == 0) {
1239 *bptr
= static_cast<ssize_t
>(m
* d
/ u
);
1241 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1242 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1243 d
<< " " << token
<< ": integer overflow (ssize_t).");
1249 * Parse bytes from a string.
1250 * Similar to the parseBytesLine function but parses the string value instead of
1251 * the current token value.
1253 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
)
1256 if ((u
= parseBytesUnits(units
)) == 0) {
1261 // Find number from string beginning.
1262 char const * number_begin
= value
;
1263 char const * number_end
= value
;
1265 while ((*number_end
>= '0' && *number_end
<= '9')) {
1270 number
.limitInit(number_begin
, number_end
- number_begin
);
1272 int d
= xatoi(number
.termedBuf());
1274 if ((m
= parseBytesUnits(number_end
)) == 0) {
1279 *bptr
= static_cast<size_t>(m
* d
/ u
);
1280 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2)
1285 parseBytesUnits(const char *unit
)
1287 if (!strncasecmp(unit
, B_BYTES_STR
, strlen(B_BYTES_STR
)))
1290 if (!strncasecmp(unit
, B_KBYTES_STR
, strlen(B_KBYTES_STR
)))
1293 if (!strncasecmp(unit
, B_MBYTES_STR
, strlen(B_MBYTES_STR
)))
1296 if (!strncasecmp(unit
, B_GBYTES_STR
, strlen(B_GBYTES_STR
)))
1299 debugs(3, DBG_CRITICAL
, "WARNING: Unknown bytes unit '" << unit
<< "'");
1305 parse_SBufList(SBufList
* list
)
1307 while (char *token
= ConfigParser::NextQuotedToken())
1308 list
->push_back(SBuf(token
));
1311 // just dump a list, no directive name
1313 dump_SBufList(StoreEntry
* entry
, const SBufList
&words
)
1315 for (const auto &i
: words
) {
1316 entry
->append(i
.rawContent(), i
.length());
1317 entry
->append(" ",1);
1319 entry
->append("\n",1);
1322 // dump a SBufList type directive with name
1324 dump_SBufList(StoreEntry
* entry
, const char *name
, SBufList
&list
)
1326 if (!list
.empty()) {
1327 entry
->append(name
, strlen(name
));
1328 entry
->append(" ", 1);
1329 dump_SBufList(entry
, list
);
1334 free_SBufList(SBufList
*list
)
1341 dump_acl(StoreEntry
* entry
, const char *name
, ACL
* ae
)
1343 while (ae
!= NULL
) {
1344 debugs(3, 3, "dump_acl: " << name
<< " " << ae
->name
);
1345 storeAppendPrintf(entry
, "%s %s %s %s ",
1349 ae
->flags
.flagsStr());
1350 dump_SBufList(entry
, ae
->dump());
1356 parse_acl(ACL
** ae
)
1358 ACL::ParseAclLine(LegacyParser
, ae
);
1368 dump_acl_list(StoreEntry
* entry
, ACLList
* head
)
1370 dump_SBufList(entry
, head
->dump());
1374 dump_acl_access(StoreEntry
* entry
, const char *name
, acl_access
* head
)
1377 dump_SBufList(entry
, head
->treeDump(name
, &Acl::AllowOrDeny
));
1381 parse_acl_access(acl_access
** head
)
1383 aclParseAccessLine(cfg_directive
, LegacyParser
, head
);
1387 free_acl_access(acl_access
** head
)
1389 aclDestroyAccessList(head
);
1393 dump_address(StoreEntry
* entry
, const char *name
, Ip::Address
&addr
)
1395 char buf
[MAX_IPSTRLEN
];
1396 storeAppendPrintf(entry
, "%s %s\n", name
, addr
.toStr(buf
,MAX_IPSTRLEN
) );
1400 parse_address(Ip::Address
*addr
)
1402 char *token
= ConfigParser::NextToken();
1409 if (!strcmp(token
,"any_addr"))
1411 else if ( (!strcmp(token
,"no_addr")) || (!strcmp(token
,"full_mask")) )
1413 else if ( (*addr
= token
) ) // try parse numeric/IPA
1415 else if (addr
->GetHostByName(token
)) // dont use ipcache
1417 else { // not an IP and not a hostname
1418 debugs(3, DBG_CRITICAL
, "FATAL: invalid IP address or domain name '" << token
<< "'");
1424 free_address(Ip::Address
*addr
)
1430 dump_acl_address(StoreEntry
* entry
, const char *name
, Acl::Address
* head
)
1432 char buf
[MAX_IPSTRLEN
];
1434 for (Acl::Address
*l
= head
; l
; l
= l
->next
) {
1435 if (!l
->addr
.isAnyAddr())
1436 storeAppendPrintf(entry
, "%s %s", name
, l
->addr
.toStr(buf
,MAX_IPSTRLEN
));
1438 storeAppendPrintf(entry
, "%s autoselect", name
);
1440 dump_acl_list(entry
, l
->aclList
);
1442 storeAppendPrintf(entry
, "\n");
1447 parse_acl_address(Acl::Address
** head
)
1449 Acl::Address
*l
= new Acl::Address
;
1450 parse_address(&l
->addr
);
1451 aclParseAclList(LegacyParser
, &l
->aclList
, l
->addr
);
1453 Acl::Address
**tail
= head
;
1455 tail
= &(*tail
)->next
;
1461 free_acl_address(Acl::Address
** head
)
1468 dump_acl_tos(StoreEntry
* entry
, const char *name
, acl_tos
* head
)
1472 for (l
= head
; l
; l
= l
->next
) {
1474 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->tos
);
1476 storeAppendPrintf(entry
, "%s none", name
);
1478 dump_acl_list(entry
, l
->aclList
);
1480 storeAppendPrintf(entry
, "\n");
1485 parse_acl_tos(acl_tos
** head
)
1487 unsigned int tos
; /* Initially uint for strtoui. Casted to tos_t before return */
1488 char *token
= ConfigParser::NextToken();
1495 if (!xstrtoui(token
, NULL
, &tos
, 0, std::numeric_limits
<tos_t
>::max())) {
1500 const unsigned int chTos
= tos
& 0xFC;
1502 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: Tos value '" << tos
<< "' adjusted to '" << chTos
<< "'");
1506 acl_tos
*l
= new acl_tos
;
1508 l
->tos
= (tos_t
)tos
;
1510 aclParseAclList(LegacyParser
, &l
->aclList
, token
);
1512 acl_tos
**tail
= head
; /* sane name below */
1514 tail
= &(*tail
)->next
;
1520 free_acl_tos(acl_tos
** head
)
1526 #if SO_MARK && USE_LIBCAP
1529 dump_acl_nfmark(StoreEntry
* entry
, const char *name
, acl_nfmark
* head
)
1531 for (acl_nfmark
*l
= head
; l
; l
= l
->next
) {
1533 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->nfmark
);
1535 storeAppendPrintf(entry
, "%s none", name
);
1537 dump_acl_list(entry
, l
->aclList
);
1539 storeAppendPrintf(entry
, "\n");
1544 parse_acl_nfmark(acl_nfmark
** head
)
1547 char *token
= ConfigParser::NextToken();
1554 if (!xstrtoui(token
, NULL
, &mark
, 0, std::numeric_limits
<nfmark_t
>::max())) {
1559 acl_nfmark
*l
= new acl_nfmark
;
1563 aclParseAclList(LegacyParser
, &l
->aclList
, token
);
1565 acl_nfmark
**tail
= head
; /* sane name below */
1567 tail
= &(*tail
)->next
;
1573 free_acl_nfmark(acl_nfmark
** head
)
1578 #endif /* SO_MARK */
1581 dump_acl_b_size_t(StoreEntry
* entry
, const char *name
, AclSizeLimit
* head
)
1583 for (AclSizeLimit
*l
= head
; l
; l
= l
->next
) {
1585 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) l
->size
, B_BYTES_STR
);
1587 storeAppendPrintf(entry
, "%s none", name
);
1589 dump_acl_list(entry
, l
->aclList
);
1591 storeAppendPrintf(entry
, "\n");
1596 parse_acl_b_size_t(AclSizeLimit
** head
)
1598 AclSizeLimit
*l
= new AclSizeLimit
;
1600 parse_b_int64_t(&l
->size
);
1602 aclParseAclList(LegacyParser
, &l
->aclList
, l
->size
);
1604 AclSizeLimit
**tail
= head
; /* sane name below */
1606 tail
= &(*tail
)->next
;
1612 free_acl_b_size_t(AclSizeLimit
** head
)
1620 #include "DelayConfig.h"
1621 #include "DelayPools.h"
1622 /* do nothing - free_delay_pool_count is the magic free function.
1623 * this is why delay_pool_count isn't just marked TYPE: u_short
1625 #define free_delay_pool_class(X)
1626 #define free_delay_pool_access(X)
1627 #define free_delay_pool_rates(X)
1628 #define dump_delay_pool_class(X, Y, Z)
1629 #define dump_delay_pool_access(X, Y, Z)
1630 #define dump_delay_pool_rates(X, Y, Z)
1633 free_delay_pool_count(DelayConfig
* cfg
)
1635 cfg
->freePoolCount();
1639 dump_delay_pool_count(StoreEntry
* entry
, const char *name
, DelayConfig
&cfg
)
1641 cfg
.dumpPoolCount (entry
, name
);
1645 parse_delay_pool_count(DelayConfig
* cfg
)
1647 cfg
->parsePoolCount();
1651 parse_delay_pool_class(DelayConfig
* cfg
)
1653 cfg
->parsePoolClass();
1657 parse_delay_pool_rates(DelayConfig
* cfg
)
1659 cfg
->parsePoolRates();
1663 parse_delay_pool_access(DelayConfig
* cfg
)
1665 cfg
->parsePoolAccess(LegacyParser
);
1671 #include "ClientDelayConfig.h"
1672 /* do nothing - free_client_delay_pool_count is the magic free function.
1673 * this is why client_delay_pool_count isn't just marked TYPE: u_short
1676 #define free_client_delay_pool_access(X)
1677 #define free_client_delay_pool_rates(X)
1678 #define dump_client_delay_pool_access(X, Y, Z)
1679 #define dump_client_delay_pool_rates(X, Y, Z)
1682 free_client_delay_pool_count(ClientDelayConfig
* cfg
)
1688 dump_client_delay_pool_count(StoreEntry
* entry
, const char *name
, ClientDelayConfig
&cfg
)
1690 cfg
.dumpPoolCount (entry
, name
);
1694 parse_client_delay_pool_count(ClientDelayConfig
* cfg
)
1696 cfg
->parsePoolCount();
1700 parse_client_delay_pool_rates(ClientDelayConfig
* cfg
)
1702 cfg
->parsePoolRates();
1706 parse_client_delay_pool_access(ClientDelayConfig
* cfg
)
1708 cfg
->parsePoolAccess(LegacyParser
);
1712 #if USE_HTTP_VIOLATIONS
1714 dump_http_header_access(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
)
1717 manglers
->dumpAccess(entry
, name
);
1721 parse_http_header_access(HeaderManglers
**pm
)
1725 if ((t
= ConfigParser::NextToken()) == NULL
) {
1726 debugs(3, DBG_CRITICAL
, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1727 debugs(3, DBG_CRITICAL
, "parse_http_header_access: missing header name.");
1732 *pm
= new HeaderManglers
;
1733 HeaderManglers
*manglers
= *pm
;
1734 headerMangler
*mangler
= manglers
->track(t
);
1737 std::string directive
= "http_header_access ";
1739 aclParseAccessLine(directive
.c_str(), LegacyParser
, &mangler
->access_list
);
1743 free_HeaderManglers(HeaderManglers
**pm
)
1745 // we delete the entire http_header_* mangler configuration at once
1746 if (const HeaderManglers
*manglers
= *pm
) {
1753 dump_http_header_replace(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
)
1756 manglers
->dumpReplacement(entry
, name
);
1760 parse_http_header_replace(HeaderManglers
**pm
)
1764 if ((t
= ConfigParser::NextToken()) == NULL
) {
1765 debugs(3, DBG_CRITICAL
, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1766 debugs(3, DBG_CRITICAL
, "parse_http_header_replace: missing header name.");
1770 const char *value
= ConfigParser::NextQuotedOrToEol();
1773 *pm
= new HeaderManglers
;
1774 HeaderManglers
*manglers
= *pm
;
1775 manglers
->setReplacement(t
, value
);
1781 dump_cachedir(StoreEntry
* entry
, const char *name
, const Store::DiskConfig
&swap
)
1787 for (i
= 0; i
< swap
.n_configured
; ++i
) {
1788 s
= dynamic_cast<SwapDir
*>(swap
.swapDirs
[i
].getRaw());
1790 storeAppendPrintf(entry
, "%s %s %s", name
, s
->type(), s
->path
);
1792 storeAppendPrintf(entry
, "\n");
1797 check_null_string(char *s
)
1804 parse_authparam(Auth::ConfigVector
* config
)
1806 char *type_str
= ConfigParser::NextToken();
1812 char *param_str
= ConfigParser::NextToken();
1818 /* find a configuration for the scheme in the currently parsed configs... */
1819 Auth::SchemeConfig
*schemeCfg
= Auth::SchemeConfig::Find(type_str
);
1821 if (schemeCfg
== NULL
) {
1822 /* Create a configuration based on the scheme info */
1823 Auth::Scheme::Pointer theScheme
= Auth::Scheme::Find(type_str
);
1825 if (theScheme
== NULL
) {
1826 debugs(3, DBG_CRITICAL
, "Parsing Config File: Unknown authentication scheme '" << type_str
<< "'.");
1831 config
->push_back(theScheme
->createConfig());
1832 schemeCfg
= Auth::SchemeConfig::Find(type_str
);
1833 if (schemeCfg
== NULL
) {
1834 debugs(3, DBG_CRITICAL
, "Parsing Config File: Corruption configuring authentication scheme '" << type_str
<< "'.");
1840 schemeCfg
->parse(schemeCfg
, config
->size(), param_str
);
1844 free_authparam(Auth::ConfigVector
* cfg
)
1846 /* Wipe the Auth globals and Detach/Destruct component config + state. */
1849 /* on reconfigure initialize new auth schemes for the new config. */
1850 if (reconfiguring
) {
1856 dump_authparam(StoreEntry
* entry
, const char *name
, Auth::ConfigVector cfg
)
1858 for (auto *scheme
: cfg
)
1859 scheme
->dump(entry
, name
, scheme
);
1863 parse_AuthSchemes(acl_access
**authSchemes
)
1865 const char *tok
= ConfigParser::NextQuotedToken();
1867 debugs(29, DBG_CRITICAL
, "FATAL: auth_schemes missing the parameter");
1871 Auth::TheConfig
.schemeLists
.emplace_back(tok
, ConfigParser::LastTokenWasQuoted());
1872 const allow_t action
= allow_t(ACCESS_ALLOWED
, Auth::TheConfig
.schemeLists
.size() - 1);
1873 ParseAclWithAction(authSchemes
, action
, "auth_schemes");
1877 free_AuthSchemes(acl_access
**authSchemes
)
1879 Auth::TheConfig
.schemeLists
.clear();
1880 free_acl_access(authSchemes
);
1884 dump_AuthSchemes(StoreEntry
*entry
, const char *name
, acl_access
*authSchemes
)
1887 dump_SBufList(entry
, authSchemes
->treeDump(name
, [](const allow_t
&action
) {
1888 return Auth::TheConfig
.schemeLists
.at(action
.kind
).rawSchemes
;
1892 #endif /* USE_AUTH */
1895 ParseAclWithAction(acl_access
**access
, const allow_t
&action
, const char *desc
, ACL
*acl
)
1900 *access
= new Acl::Tree
;
1901 name
.Printf("(%s rules)", desc
);
1902 (*access
)->context(name
.c_str(), config_input_line
);
1904 Acl::AndNode
*rule
= new Acl::AndNode
;
1905 name
.Printf("(%s rule)", desc
);
1906 rule
->context(name
.c_str(), config_input_line
);
1907 acl
? rule
->add(acl
) : rule
->lineParse();
1908 (*access
)->add(rule
, action
);
1911 /* TODO: just return the object, the # is irrelevant */
1913 find_fstype(char *type
)
1915 for (size_t i
= 0; i
< StoreFileSystem::FileSystems().size(); ++i
)
1916 if (strcasecmp(type
, StoreFileSystem::FileSystems().at(i
)->type()) == 0)
1923 parse_cachedir(Store::DiskConfig
*swap
)
1925 char *type_str
= ConfigParser::NextToken();
1931 char *path_str
= ConfigParser::NextToken();
1937 int fs
= find_fstype(type_str
);
1939 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: This proxy does not support the '" << type_str
<< "' cache type. Ignoring.");
1943 /* reconfigure existing dir */
1945 RefCount
<SwapDir
> sd
;
1946 for (int i
= 0; i
< swap
->n_configured
; ++i
) {
1947 assert (swap
->swapDirs
[i
].getRaw());
1949 if ((strcasecmp(path_str
, dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw())->path
)) == 0) {
1950 /* this is specific to on-fs Stores. The right
1951 * way to handle this is probably to have a mapping
1952 * from paths to stores, and have on-fs stores
1953 * register with that, and lookip in that in their
1954 * own setup logic. RBC 20041225. TODO.
1957 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw());
1959 if (strcmp(sd
->type(), StoreFileSystem::FileSystems().at(fs
)->type()) != 0) {
1960 debugs(3, DBG_CRITICAL
, "ERROR: Can't change type of existing cache_dir " <<
1961 sd
->type() << " " << sd
->path
<< " to " << type_str
<< ". Restart required");
1971 if (swap
->n_configured
> 63) {
1972 /* 7 bits, signed */
1973 debugs(3, DBG_CRITICAL
, "WARNING: There is a fixed maximum of 63 cache_dir entries Squid can handle.");
1974 debugs(3, DBG_CRITICAL
, "WARNING: '" << path_str
<< "' is one to many.");
1979 allocate_new_swapdir(swap
);
1981 swap
->swapDirs
[swap
->n_configured
] = StoreFileSystem::FileSystems().at(fs
)->createSwapDir();
1983 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[swap
->n_configured
].getRaw());
1985 /* parse the FS parameters and options */
1986 sd
->parse(swap
->n_configured
, path_str
);
1988 ++swap
->n_configured
;
1992 peer_type_str(const peer_t type
)
1994 const char * result
;
2006 case PEER_MULTICAST
:
2007 result
= "multicast";
2019 dump_peer(StoreEntry
* entry
, const char *name
, CachePeer
* p
)
2021 NeighborTypeDomainList
*t
;
2022 LOCAL_ARRAY(char, xname
, 128);
2025 storeAppendPrintf(entry
, "%s %s %s %d %d name=%s",
2032 dump_peer_options(entry
, p
);
2035 snprintf(xname
, 128, "cache_peer_access %s", p
->name
);
2036 dump_acl_access(entry
, xname
, p
->access
);
2039 for (t
= p
->typelist
; t
; t
= t
->next
) {
2040 storeAppendPrintf(entry
, "neighbor_type_domain %s %s %s\n",
2042 peer_type_str(t
->type
),
2051 * utility function to prevent getservbyname() being called with a numeric value
2052 * on Windows at least it returns garage results.
2055 isUnsignedNumeric(const char *str
, size_t len
)
2057 if (len
< 1) return false;
2059 for (; len
>0 && *str
; ++str
, --len
) {
2060 if (! isdigit(*str
))
2067 \param proto 'tcp' or 'udp' for protocol
2068 \returns Port the named service is supposed to be listening on.
2070 static unsigned short
2071 GetService(const char *proto
)
2073 struct servent
*port
= NULL
;
2074 /** Parses a port number or service name from the squid.conf */
2075 char *token
= ConfigParser::NextToken();
2076 if (token
== NULL
) {
2078 return 0; /* NEVER REACHED */
2080 /** Returns either the service port number from /etc/services */
2081 if ( !isUnsignedNumeric(token
, strlen(token
)) )
2082 port
= getservbyname(token
, proto
);
2084 return ntohs((unsigned short)port
->s_port
);
2086 /** Or a numeric translation of the config text. */
2087 return xatos(token
);
2091 \returns Port the named TCP service is supposed to be listening on.
2092 \copydoc GetService(const char *proto)
2094 inline unsigned short
2097 return GetService("tcp");
2101 \returns Port the named UDP service is supposed to be listening on.
2102 \copydoc GetService(const char *proto)
2104 inline unsigned short
2107 return GetService("udp");
2111 parse_peer(CachePeer
** head
)
2113 char *host_str
= ConfigParser::NextToken();
2119 char *token
= ConfigParser::NextToken();
2125 CachePeer
*p
= new CachePeer
;
2126 p
->host
= xstrdup(host_str
);
2127 p
->name
= xstrdup(host_str
);
2128 p
->type
= parseNeighborType(token
);
2130 if (p
->type
== PEER_MULTICAST
) {
2131 p
->options
.no_digest
= true;
2132 p
->options
.no_netdb_exchange
= true;
2135 p
->http_port
= GetTcpService();
2137 if (!p
->http_port
) {
2143 p
->icp
.port
= GetUdpService();
2145 while ((token
= ConfigParser::NextToken())) {
2146 if (!strcmp(token
, "proxy-only")) {
2147 p
->options
.proxy_only
= true;
2148 } else if (!strcmp(token
, "no-query")) {
2149 p
->options
.no_query
= true;
2150 } else if (!strcmp(token
, "background-ping")) {
2151 p
->options
.background_ping
= true;
2152 } else if (!strcmp(token
, "no-digest")) {
2153 p
->options
.no_digest
= true;
2154 } else if (!strcmp(token
, "no-tproxy")) {
2155 p
->options
.no_tproxy
= true;
2156 } else if (!strcmp(token
, "multicast-responder")) {
2157 p
->options
.mcast_responder
= true;
2158 #if PEER_MULTICAST_SIBLINGS
2159 } else if (!strcmp(token
, "multicast-siblings")) {
2160 p
->options
.mcast_siblings
= true;
2162 } else if (!strncmp(token
, "weight=", 7)) {
2163 p
->weight
= xatoi(token
+ 7);
2164 } else if (!strncmp(token
, "basetime=", 9)) {
2165 p
->basetime
= xatoi(token
+ 9);
2166 } else if (!strcmp(token
, "closest-only")) {
2167 p
->options
.closest_only
= true;
2168 } else if (!strncmp(token
, "ttl=", 4)) {
2169 p
->mcast
.ttl
= xatoi(token
+ 4);
2171 if (p
->mcast
.ttl
< 0)
2174 if (p
->mcast
.ttl
> 128)
2176 } else if (!strcmp(token
, "default")) {
2177 p
->options
.default_parent
= true;
2178 } else if (!strcmp(token
, "round-robin")) {
2179 p
->options
.roundrobin
= true;
2180 } else if (!strcmp(token
, "weighted-round-robin")) {
2181 p
->options
.weighted_roundrobin
= true;
2183 } else if (!strcmp(token
, "htcp")) {
2184 p
->options
.htcp
= true;
2185 } else if (!strncmp(token
, "htcp=", 5) || !strncmp(token
, "htcp-", 5)) {
2186 /* Note: The htcp- form is deprecated, replaced by htcp= */
2187 p
->options
.htcp
= true;
2188 char *tmp
= xstrdup(token
+5);
2189 char *mode
, *nextmode
;
2190 for (mode
= nextmode
= tmp
; mode
; mode
= nextmode
) {
2191 nextmode
= strchr(mode
, ',');
2196 if (!strcmp(mode
, "no-clr")) {
2197 if (p
->options
.htcp_only_clr
)
2198 fatalf("parse_peer: can't set htcp-no-clr and htcp-only-clr simultaneously");
2199 p
->options
.htcp_no_clr
= true;
2200 } else if (!strcmp(mode
, "no-purge-clr")) {
2201 p
->options
.htcp_no_purge_clr
= true;
2202 } else if (!strcmp(mode
, "only-clr")) {
2203 if (p
->options
.htcp_no_clr
)
2204 fatalf("parse_peer: can't set htcp no-clr and only-clr simultaneously");
2205 p
->options
.htcp_only_clr
= true;
2206 } else if (!strcmp(mode
, "forward-clr")) {
2207 p
->options
.htcp_forward_clr
= true;
2208 } else if (!strcmp(mode
, "oldsquid")) {
2209 p
->options
.htcp_oldsquid
= true;
2211 fatalf("invalid HTCP mode '%s'", mode
);
2216 } else if (!strcmp(token
, "no-netdb-exchange")) {
2217 p
->options
.no_netdb_exchange
= true;
2219 } else if (!strcmp(token
, "carp")) {
2220 if (p
->type
!= PEER_PARENT
)
2221 fatalf("parse_peer: non-parent carp peer %s/%d\n", p
->host
, p
->http_port
);
2223 p
->options
.carp
= true;
2224 } else if (!strncmp(token
, "carp-key=", 9)) {
2225 if (p
->options
.carp
!= true)
2226 fatalf("parse_peer: carp-key specified on non-carp peer %s/%d\n", p
->host
, p
->http_port
);
2227 p
->options
.carp_key
.set
= true;
2228 char *nextkey
=token
+strlen("carp-key="), *key
=nextkey
;
2229 for (; key
; key
= nextkey
) {
2230 nextkey
=strchr(key
,',');
2231 if (nextkey
) ++nextkey
; // skip the comma, any
2232 if (0==strncmp(key
,"scheme",6)) {
2233 p
->options
.carp_key
.scheme
= true;
2234 } else if (0==strncmp(key
,"host",4)) {
2235 p
->options
.carp_key
.host
= true;
2236 } else if (0==strncmp(key
,"port",4)) {
2237 p
->options
.carp_key
.port
= true;
2238 } else if (0==strncmp(key
,"path",4)) {
2239 p
->options
.carp_key
.path
= true;
2240 } else if (0==strncmp(key
,"params",6)) {
2241 p
->options
.carp_key
.params
= true;
2243 fatalf("invalid carp-key '%s'",key
);
2246 } else if (!strcmp(token
, "userhash")) {
2248 if (p
->type
!= PEER_PARENT
)
2249 fatalf("parse_peer: non-parent userhash peer %s/%d\n", p
->host
, p
->http_port
);
2251 p
->options
.userhash
= true;
2253 fatalf("parse_peer: userhash requires authentication. peer %s/%d\n", p
->host
, p
->http_port
);
2255 } else if (!strcmp(token
, "sourcehash")) {
2256 if (p
->type
!= PEER_PARENT
)
2257 fatalf("parse_peer: non-parent sourcehash peer %s/%d\n", p
->host
, p
->http_port
);
2259 p
->options
.sourcehash
= true;
2261 } else if (!strcmp(token
, "no-delay")) {
2263 p
->options
.no_delay
= true;
2265 debugs(0, DBG_CRITICAL
, "WARNING: cache_peer option 'no-delay' requires --enable-delay-pools");
2267 } else if (!strncmp(token
, "login=", 6)) {
2268 p
->login
= xstrdup(token
+ 6);
2269 rfc1738_unescape(p
->login
);
2270 } else if (!strcmp(token
, "auth-no-keytab")) {
2271 p
->options
.auth_no_keytab
= 1;
2272 } else if (!strncmp(token
, "connect-timeout=", 16)) {
2273 p
->connect_timeout_raw
= xatoi(token
+ 16);
2274 } else if (!strncmp(token
, "connect-fail-limit=", 19)) {
2275 p
->connect_fail_limit
= xatoi(token
+ 19);
2276 #if USE_CACHE_DIGESTS
2277 } else if (!strncmp(token
, "digest-url=", 11)) {
2278 p
->digest_url
= xstrdup(token
+ 11);
2281 } else if (!strcmp(token
, "allow-miss")) {
2282 p
->options
.allow_miss
= true;
2283 } else if (!strncmp(token
, "max-conn=", 9)) {
2284 p
->max_conn
= xatoi(token
+ 9);
2285 } else if (!strncmp(token
, "standby=", 8)) {
2286 p
->standby
.limit
= xatoi(token
+ 8);
2287 } else if (!strcmp(token
, "originserver")) {
2288 p
->options
.originserver
= true;
2289 } else if (!strncmp(token
, "name=", 5)) {
2293 p
->name
= xstrdup(token
+ 5);
2294 } else if (!strncmp(token
, "forceddomain=", 13)) {
2295 safe_free(p
->domain
);
2297 p
->domain
= xstrdup(token
+ 13);
2299 } else if (strncmp(token
, "ssl", 3) == 0) {
2301 debugs(0, DBG_CRITICAL
, "WARNING: cache_peer option '" << token
<< "' requires --with-openssl");
2303 p
->secure
.parse(token
+3);
2305 } else if (strncmp(token
, "tls-", 4) == 0) {
2306 p
->secure
.parse(token
+4);
2307 } else if (strncmp(token
, "tls", 3) == 0) {
2308 p
->secure
.parse(token
+3);
2309 } else if (strcmp(token
, "front-end-https") == 0) {
2310 p
->front_end_https
= 1;
2311 } else if (strcmp(token
, "front-end-https=on") == 0) {
2312 p
->front_end_https
= 1;
2313 } else if (strcmp(token
, "front-end-https=auto") == 0) {
2314 p
->front_end_https
= 2;
2315 } else if (strcmp(token
, "connection-auth=off") == 0) {
2316 p
->connection_auth
= 0;
2317 } else if (strcmp(token
, "connection-auth") == 0) {
2318 p
->connection_auth
= 1;
2319 } else if (strcmp(token
, "connection-auth=on") == 0) {
2320 p
->connection_auth
= 1;
2321 } else if (strcmp(token
, "connection-auth=auto") == 0) {
2322 p
->connection_auth
= 2;
2323 } else if (token
[0] == '#') {
2324 // start of a text comment. stop reading this line.
2327 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Ignoring unknown cache_peer option '" << token
<< "'");
2331 if (peerFindByName(p
->name
))
2332 fatalf("ERROR: cache_peer %s specified twice\n", p
->name
);
2334 if (p
->max_conn
> 0 && p
->max_conn
< p
->standby
.limit
)
2335 fatalf("ERROR: cache_peer %s max-conn=%d is lower than its standby=%d\n", p
->host
, p
->max_conn
, p
->standby
.limit
);
2340 if (p
->connect_fail_limit
< 1)
2341 p
->connect_fail_limit
= 10;
2343 #if USE_CACHE_DIGESTS
2345 if (!p
->options
.no_digest
) {
2346 /* XXX This looks odd.. who has the original pointer
2349 PeerDigest
*pd
= peerDigestCreate(p
);
2350 p
->digest
= cbdataReference(pd
);
2355 p
->index
= ++Config
.npeers
;
2357 while (*head
!= NULL
)
2358 head
= &(*head
)->next
;
2366 free_peer(CachePeer
** P
)
2374 dump_cachemgrpasswd(StoreEntry
* entry
, const char *name
, Mgr::ActionPasswordList
* list
)
2377 if (strcmp(list
->passwd
, "none") && strcmp(list
->passwd
, "disable"))
2378 storeAppendPrintf(entry
, "%s XXXXXXXXXX", name
);
2380 storeAppendPrintf(entry
, "%s %s", name
, list
->passwd
);
2382 for (auto w
: list
->actions
)
2383 entry
->appendf(" " SQUIDSBUFPH
, SQUIDSBUFPRINT(w
));
2385 storeAppendPrintf(entry
, "\n");
2391 parse_cachemgrpasswd(Mgr::ActionPasswordList
** head
)
2393 char *passwd
= nullptr;
2394 parse_string(&passwd
);
2396 Mgr::ActionPasswordList
*p
= new Mgr::ActionPasswordList
;
2399 while (char *token
= ConfigParser::NextQuotedToken())
2400 p
->actions
.push_back(SBuf(token
));
2402 Mgr::ActionPasswordList
**P
;
2403 for (P
= head
; *P
; P
= &(*P
)->next
) {
2405 * See if any of the actions from this line already have a
2406 * password from previous lines. The password checking
2407 * routines in cache_manager.c take the the password from
2408 * the first Mgr::ActionPasswordList that contains the
2409 * requested action. Thus, we should warn users who might
2410 * think they can have two passwords for the same action.
2412 for (const auto &w
: (*P
)->actions
) {
2413 for (const auto &u
: p
->actions
) {
2417 debugs(0, DBG_PARSE_NOTE(1), "ERROR: action '" << u
<< "' (line " << config_lineno
<< ") already has a password");
2426 free_cachemgrpasswd(Mgr::ActionPasswordList
** head
)
2433 dump_denyinfo(StoreEntry
* entry
, const char *name
, AclDenyInfoList
* var
)
2435 while (var
!= NULL
) {
2436 storeAppendPrintf(entry
, "%s %s", name
, var
->err_page_name
);
2438 for (auto *a
= var
->acl_list
; a
!= NULL
; a
= a
->next
)
2439 storeAppendPrintf(entry
, " %s", a
->name
);
2441 storeAppendPrintf(entry
, "\n");
2448 parse_denyinfo(AclDenyInfoList
** var
)
2450 aclParseDenyInfoLine(var
);
2454 free_denyinfo(AclDenyInfoList
** list
)
2461 parse_peer_access(void)
2463 char *host
= ConfigParser::NextToken();
2469 CachePeer
*p
= peerFindByName(host
);
2471 debugs(15, DBG_CRITICAL
, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2475 std::string directive
= "peer_access ";
2477 aclParseAccessLine(directive
.c_str(), LegacyParser
, &p
->access
);
2481 parse_hostdomaintype(void)
2483 char *host
= ConfigParser::NextToken();
2489 char *type
= ConfigParser::NextToken();
2495 char *domain
= nullptr;
2496 while ((domain
= ConfigParser::NextToken())) {
2497 CachePeer
*p
= peerFindByName(host
);
2499 debugs(15, DBG_CRITICAL
, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2503 auto *l
= static_cast<NeighborTypeDomainList
*>(xcalloc(1, sizeof(NeighborTypeDomainList
)));
2504 l
->type
= parseNeighborType(type
);
2505 l
->domain
= xstrdup(domain
);
2507 NeighborTypeDomainList
**L
= nullptr;
2508 for (L
= &(p
->typelist
); *L
; L
= &((*L
)->next
));
2514 dump_int(StoreEntry
* entry
, const char *name
, int var
)
2516 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
2534 dump_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
2536 storeAppendPrintf(entry
, "%s %" PRId64
"\n", name
, var
);
2540 parse_int64_t(int64_t *var
)
2548 free_int64_t(int64_t *var
)
2554 dump_onoff(StoreEntry
* entry
, const char *name
, int var
)
2556 storeAppendPrintf(entry
, "%s %s\n", name
, var
? "on" : "off");
2560 parse_onoff(int *var
)
2562 char *token
= ConfigParser::NextToken();
2568 if (!strcmp(token
, "on")) {
2570 } else if (!strcmp(token
, "enable")) {
2571 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'enable' is deprecated. Please update to use 'on'.");
2573 } else if (!strcmp(token
, "off")) {
2575 } else if (!strcmp(token
, "disable")) {
2576 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'disable' is deprecated. Please update to use 'off'.");
2579 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Invalid option: Boolean options can only be 'on' or 'off'.");
2584 #define free_onoff free_int
2587 dump_tristate(StoreEntry
* entry
, const char *name
, int var
)
2598 storeAppendPrintf(entry
, "%s %s\n", name
, state
);
2602 parse_tristate(int *var
)
2604 char *token
= ConfigParser::NextToken();
2610 if (!strcmp(token
, "on")) {
2612 } else if (!strcmp(token
, "enable")) {
2613 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'enable' is deprecated. Please update to use value 'on'.");
2615 } else if (!strcmp(token
, "warn")) {
2617 } else if (!strcmp(token
, "off")) {
2619 } else if (!strcmp(token
, "disable")) {
2620 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'disable' is deprecated. Please update to use value 'off'.");
2623 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Invalid option: Tristate options can only be 'on', 'off', or 'warn'.");
2628 #define free_tristate free_int
2631 parse_pipelinePrefetch(int *var
)
2633 char *token
= ConfigParser::PeekAtToken();
2639 if (!strcmp(token
, "on")) {
2640 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'pipeline_prefetch on' is deprecated. Please update to use 1 (or a higher number).");
2643 (void)ConfigParser::NextToken();
2644 } else if (!strcmp(token
, "off")) {
2645 debugs(0, DBG_PARSE_NOTE(2), "WARNING: 'pipeline_prefetch off' is deprecated. Please update to use '0'.");
2648 (void)ConfigParser::NextToken();
2653 #define free_pipelinePrefetch free_int
2654 #define dump_pipelinePrefetch dump_int
2657 dump_refreshpattern(StoreEntry
* entry
, const char *name
, RefreshPattern
* head
)
2659 while (head
!= NULL
) {
2660 storeAppendPrintf(entry
, "%s%s %s %d %d%% %d",
2662 head
->pattern
.flags
®_ICASE
? " -i" : null_string
,
2663 head
->pattern
.c_str(),
2664 (int) head
->min
/ 60,
2665 (int) (100.0 * head
->pct
+ 0.5),
2666 (int) head
->max
/ 60);
2668 if (head
->max_stale
>= 0)
2669 storeAppendPrintf(entry
, " max-stale=%d", head
->max_stale
);
2671 if (head
->flags
.refresh_ims
)
2672 storeAppendPrintf(entry
, " refresh-ims");
2674 if (head
->flags
.store_stale
)
2675 storeAppendPrintf(entry
, " store-stale");
2677 #if USE_HTTP_VIOLATIONS
2679 if (head
->flags
.override_expire
)
2680 storeAppendPrintf(entry
, " override-expire");
2682 if (head
->flags
.override_lastmod
)
2683 storeAppendPrintf(entry
, " override-lastmod");
2685 if (head
->flags
.reload_into_ims
)
2686 storeAppendPrintf(entry
, " reload-into-ims");
2688 if (head
->flags
.ignore_reload
)
2689 storeAppendPrintf(entry
, " ignore-reload");
2691 if (head
->flags
.ignore_no_store
)
2692 storeAppendPrintf(entry
, " ignore-no-store");
2694 if (head
->flags
.ignore_private
)
2695 storeAppendPrintf(entry
, " ignore-private");
2698 storeAppendPrintf(entry
, "\n");
2705 parse_refreshpattern(RefreshPattern
** head
)
2712 int refresh_ims
= 0;
2713 int store_stale
= 0;
2716 #if USE_HTTP_VIOLATIONS
2718 int override_expire
= 0;
2719 int override_lastmod
= 0;
2720 int reload_into_ims
= 0;
2721 int ignore_reload
= 0;
2722 int ignore_no_store
= 0;
2723 int ignore_private
= 0;
2730 int flags
= REG_EXTENDED
| REG_NOSUB
;
2732 if ((token
= ConfigParser::RegexPattern()) != NULL
) {
2734 if (strcmp(token
, "-i") == 0) {
2736 token
= ConfigParser::RegexPattern();
2737 } else if (strcmp(token
, "+i") == 0) {
2738 flags
&= ~REG_ICASE
;
2739 token
= ConfigParser::RegexPattern();
2744 if (token
== NULL
) {
2745 debugs(3, DBG_CRITICAL
, "FATAL: refresh_pattern missing the regex pattern parameter");
2750 pattern
= xstrdup(token
);
2752 i
= GetInteger(); /* token: min */
2754 /* catch negative and insanely huge values close to 32-bit wrap */
2756 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age negative. Cropped back to zero.");
2759 if (i
> 60*24*365) {
2760 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age too high. Cropped back to 1 year.");
2764 min
= (time_t) (i
* 60); /* convert minutes to seconds */
2766 pct
= GetPercentage(false); /* token: pct . with no limit on size */
2768 i
= GetInteger(); /* token: max */
2770 /* catch negative and insanely huge values close to 32-bit wrap */
2772 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age negative. Cropped back to zero.");
2775 if (i
> 60*24*365) {
2776 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age too high. Cropped back to 1 year.");
2780 max
= (time_t) (i
* 60); /* convert minutes to seconds */
2783 while ((token
= ConfigParser::NextToken()) != NULL
) {
2784 if (!strcmp(token
, "refresh-ims")) {
2786 } else if (!strcmp(token
, "store-stale")) {
2788 } else if (!strncmp(token
, "max-stale=", 10)) {
2789 max_stale
= xatoi(token
+ 10);
2791 #if USE_HTTP_VIOLATIONS
2793 } else if (!strcmp(token
, "override-expire"))
2794 override_expire
= 1;
2795 else if (!strcmp(token
, "override-lastmod"))
2796 override_lastmod
= 1;
2797 else if (!strcmp(token
, "ignore-no-store"))
2798 ignore_no_store
= 1;
2799 else if (!strcmp(token
, "ignore-private"))
2801 else if (!strcmp(token
, "reload-into-ims")) {
2802 reload_into_ims
= 1;
2803 refresh_nocache_hack
= 1;
2804 /* tell client_side.c that this is used */
2805 } else if (!strcmp(token
, "ignore-reload")) {
2807 refresh_nocache_hack
= 1;
2808 /* tell client_side.c that this is used */
2811 } else if (!strcmp(token
, "ignore-no-cache") ||
2812 !strcmp(token
, "ignore-must-revalidate") ||
2813 !strcmp(token
, "ignore-auth")
2815 debugs(22, DBG_PARSE_NOTE(2), "UPGRADE: refresh_pattern option '" << token
<< "' is obsolete. Remove it.");
2817 debugs(22, DBG_CRITICAL
, "refreshAddToList: Unknown option '" << pattern
<< "': " << token
);
2820 if ((errcode
= regcomp(&comp
, pattern
, flags
)) != 0) {
2822 regerror(errcode
, &comp
, errbuf
, sizeof errbuf
);
2823 debugs(22, DBG_CRITICAL
, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
2824 debugs(22, DBG_CRITICAL
, "refreshAddToList: Invalid regular expression '" << pattern
<< "': " << errbuf
);
2829 pct
= pct
< 0.0 ? 0.0 : pct
;
2830 max
= max
< 0 ? 0 : max
;
2831 t
= new RefreshPattern(pattern
, flags
);
2832 t
->pattern
.regex
= comp
;
2838 t
->flags
.refresh_ims
= true;
2841 t
->flags
.store_stale
= true;
2843 t
->max_stale
= max_stale
;
2845 #if USE_HTTP_VIOLATIONS
2847 if (override_expire
)
2848 t
->flags
.override_expire
= true;
2850 if (override_lastmod
)
2851 t
->flags
.override_lastmod
= true;
2853 if (reload_into_ims
)
2854 t
->flags
.reload_into_ims
= true;
2857 t
->flags
.ignore_reload
= true;
2859 if (ignore_no_store
)
2860 t
->flags
.ignore_no_store
= true;
2863 t
->flags
.ignore_private
= true;
2869 head
= &(*head
)->next
;
2877 free_refreshpattern(RefreshPattern
** head
)
2882 #if USE_HTTP_VIOLATIONS
2883 refresh_nocache_hack
= 0;
2889 dump_string(StoreEntry
* entry
, const char *name
, char *var
)
2892 storeAppendPrintf(entry
, "%s %s\n", name
, var
);
2896 parse_string(char **var
)
2900 char *token
= ConfigParser::NextToken();
2906 *var
= xstrdup(token
);
2910 free_string(char **var
)
2916 parse_eol(char *volatile *var
)
2923 unsigned char *token
= (unsigned char *) ConfigParser::NextQuotedOrToEol();
2931 while (*token
&& xisspace(*token
))
2939 *var
= xstrdup((char *) token
);
2942 #define dump_eol dump_string
2943 #define free_eol free_string
2946 parse_TokenOrQuotedString(char **var
)
2950 char *token
= ConfigParser::NextQuotedToken();
2956 *var
= xstrdup(token
);
2959 #define dump_TokenOrQuotedString dump_string
2960 #define free_TokenOrQuotedString free_string
2963 dump_time_t(StoreEntry
* entry
, const char *name
, time_t var
)
2965 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int) var
);
2969 parse_time_t(time_t * var
)
2972 parseTimeLine(&tval
, T_SECOND_STR
, false);
2973 *var
= static_cast<time_t>(tval
/1000);
2977 free_time_t(time_t * var
)
2983 dump_time_msec(StoreEntry
* entry
, const char *name
, time_msec_t var
)
2986 storeAppendPrintf(entry
, "%s %" PRId64
" milliseconds\n", name
, var
);
2988 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int)(var
/1000) );
2992 parse_time_msec(time_msec_t
* var
)
2994 parseTimeLine(var
, T_SECOND_STR
, true);
2998 free_time_msec(time_msec_t
* var
)
3005 dump_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3007 storeAppendPrintf(entry
, "%s %d\n", name
, (int) var
);
3012 dump_b_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3014 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3018 dump_b_ssize_t(StoreEntry
* entry
, const char *name
, ssize_t var
)
3020 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3025 dump_kb_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3027 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_KBYTES_STR
);
3032 dump_b_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3034 storeAppendPrintf(entry
, "%s %" PRId64
" %s\n", name
, var
, B_BYTES_STR
);
3038 dump_kb_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3040 storeAppendPrintf(entry
, "%s %" PRId64
" %s\n", name
, var
, B_KBYTES_STR
);
3045 parse_size_t(size_t * var
)
3054 parse_b_size_t(size_t * var
)
3056 parseBytesLine(var
, B_BYTES_STR
);
3060 parse_b_ssize_t(ssize_t
* var
)
3062 parseBytesLineSigned(var
, B_BYTES_STR
);
3067 parse_kb_size_t(size_t * var
)
3069 parseBytesLine(var
, B_KBYTES_STR
);
3074 parse_b_int64_t(int64_t * var
)
3076 parseBytesLine64(var
, B_BYTES_STR
);
3080 parse_kb_int64_t(int64_t * var
)
3082 parseBytesLine64(var
, B_KBYTES_STR
);
3086 free_size_t(size_t * var
)
3092 free_ssize_t(ssize_t
* var
)
3098 free_b_int64_t(int64_t * var
)
3103 #define free_b_size_t free_size_t
3104 #define free_b_ssize_t free_ssize_t
3105 #define free_kb_size_t free_size_t
3106 #define free_mb_size_t free_size_t
3107 #define free_gb_size_t free_size_t
3108 #define free_kb_int64_t free_b_int64_t
3111 dump_u_short(StoreEntry
* entry
, const char *name
, unsigned short var
)
3113 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
3117 free_u_short(unsigned short * u
)
3123 parse_u_short(unsigned short * var
)
3125 ConfigParser::ParseUShort(var
);
3129 ConfigParser::ParseUShort(unsigned short *var
)
3135 ConfigParser::ParseBool(bool *var
)
3137 int i
= GetInteger();
3148 dump_wordlist(StoreEntry
* entry
, const char *name
, wordlist
* list
)
3150 while (list
!= NULL
) {
3151 storeAppendPrintf(entry
, "%s %s\n", name
, list
->key
);
3157 ConfigParser::ParseWordList(wordlist
** list
)
3159 parse_wordlist(list
);
3163 parse_wordlist(wordlist
** list
)
3166 while ((token
= ConfigParser::NextQuotedToken()))
3167 wordlistAdd(list
, token
);
3170 #if 0 /* now unused */
3172 check_null_wordlist(wordlist
* w
)
3179 check_null_acl_access(acl_access
* a
)
3184 #define free_wordlist wordlistDestroy
3186 #define free_uri_whitespace free_int
3189 parse_uri_whitespace(int *var
)
3191 char *token
= ConfigParser::NextToken();
3197 if (!strcmp(token
, "strip"))
3198 *var
= URI_WHITESPACE_STRIP
;
3199 else if (!strcmp(token
, "deny"))
3200 *var
= URI_WHITESPACE_DENY
;
3201 else if (!strcmp(token
, "allow"))
3202 *var
= URI_WHITESPACE_ALLOW
;
3203 else if (!strcmp(token
, "encode"))
3204 *var
= URI_WHITESPACE_ENCODE
;
3205 else if (!strcmp(token
, "chop"))
3206 *var
= URI_WHITESPACE_CHOP
;
3208 debugs(0, DBG_PARSE_NOTE(2), "ERROR: Invalid option '" << token
<< "': 'uri_whitespace' accepts 'strip', 'deny', 'allow', 'encode', and 'chop'.");
3214 dump_uri_whitespace(StoreEntry
* entry
, const char *name
, int var
)
3218 if (var
== URI_WHITESPACE_ALLOW
)
3220 else if (var
== URI_WHITESPACE_ENCODE
)
3222 else if (var
== URI_WHITESPACE_CHOP
)
3224 else if (var
== URI_WHITESPACE_DENY
)
3229 storeAppendPrintf(entry
, "%s %s\n", name
, s
);
3233 free_removalpolicy(RemovalPolicySettings
** settings
)
3238 free_string(&(*settings
)->type
);
3240 free_wordlist(&(*settings
)->args
);
3248 parse_removalpolicy(RemovalPolicySettings
** settings
)
3251 free_removalpolicy(settings
);
3253 *settings
= new RemovalPolicySettings
;
3255 parse_string(&(*settings
)->type
);
3257 parse_wordlist(&(*settings
)->args
);
3261 dump_removalpolicy(StoreEntry
* entry
, const char *name
, RemovalPolicySettings
* settings
)
3264 storeAppendPrintf(entry
, "%s %s", name
, settings
->type
);
3265 args
= settings
->args
;
3268 storeAppendPrintf(entry
, " %s", args
->key
);
3272 storeAppendPrintf(entry
, "\n");
3276 free_YesNoNone(YesNoNone
*)
3280 parse_YesNoNone(YesNoNone
*option
)
3283 parse_onoff(&value
);
3284 option
->configure(value
> 0);
3288 dump_YesNoNone(StoreEntry
* entry
, const char *name
, YesNoNone
&option
)
3290 if (option
.configured())
3291 dump_onoff(entry
, name
, option
? 1 : 0);
3295 free_memcachemode(SquidConfig
*)
3299 parse_memcachemode(SquidConfig
*)
3301 char *token
= ConfigParser::NextToken();
3307 if (strcmp(token
, "always") == 0) {
3308 Config
.onoff
.memory_cache_first
= 1;
3309 Config
.onoff
.memory_cache_disk
= 1;
3310 } else if (strcmp(token
, "disk") == 0) {
3311 Config
.onoff
.memory_cache_first
= 0;
3312 Config
.onoff
.memory_cache_disk
= 1;
3313 } else if (strncmp(token
, "net", 3) == 0) {
3314 Config
.onoff
.memory_cache_first
= 1;
3315 Config
.onoff
.memory_cache_disk
= 0;
3316 } else if (strcmp(token
, "never") == 0) {
3317 Config
.onoff
.memory_cache_first
= 0;
3318 Config
.onoff
.memory_cache_disk
= 0;
3320 debugs(0, DBG_PARSE_NOTE(2), "ERROR: Invalid option '" << token
<< "': 'memory_cache_mode' accepts 'always', 'disk', 'network', and 'never'.");
3326 dump_memcachemode(StoreEntry
* entry
, const char *name
, SquidConfig
&)
3328 storeAppendPrintf(entry
, "%s ", name
);
3329 if (Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3330 storeAppendPrintf(entry
, "always");
3331 else if (!Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3332 storeAppendPrintf(entry
, "disk");
3333 else if (Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3334 storeAppendPrintf(entry
, "network");
3335 else if (!Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3336 storeAppendPrintf(entry
, "none");
3337 storeAppendPrintf(entry
, "\n");
3340 #include "cf_parser.cci"
3343 parseNeighborType(const char *s
)
3345 if (!strcmp(s
, "parent"))
3348 if (!strcmp(s
, "neighbor"))
3349 return PEER_SIBLING
;
3351 if (!strcmp(s
, "neighbour"))
3352 return PEER_SIBLING
;
3354 if (!strcmp(s
, "sibling"))
3355 return PEER_SIBLING
;
3357 if (!strcmp(s
, "multicast"))
3358 return PEER_MULTICAST
;
3360 debugs(15, DBG_CRITICAL
, "WARNING: Unknown neighbor type: " << s
);
3362 return PEER_SIBLING
;
3367 parse_IpAddress_list(Ip::Address_list
** head
)
3370 Ip::Address_list
*s
;
3373 while ((token
= ConfigParser::NextToken())) {
3374 if (GetHostWithPort(token
, &ipa
)) {
3377 head
= &(*head
)->next
;
3379 s
= static_cast<Ip::Address_list
*>(xcalloc(1, sizeof(*s
)));
3391 dump_IpAddress_list(StoreEntry
* e
, const char *n
, const Ip::Address_list
* s
)
3393 char ntoabuf
[MAX_IPSTRLEN
];
3396 storeAppendPrintf(e
, "%s %s\n",
3398 s
->s
.toStr(ntoabuf
,MAX_IPSTRLEN
));
3404 free_IpAddress_list(Ip::Address_list
** head
)
3406 if (*head
) delete *head
;
3410 #if CURRENTLY_UNUSED
3411 /* This code was previously used by http_port. Left as it really should
3412 * be used by icp_port and htcp_port
3415 check_null_IpAddress_list(const Ip::Address_list
* s
)
3420 #endif /* CURRENTLY_UNUSED */
3421 #endif /* USE_WCCPv2 */
3424 parsePortSpecification(const AnyP::PortCfgPointer
&s
, char *token
)
3427 unsigned short port
= 0;
3431 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3432 s
->name
= xstrdup(token
);
3433 s
->connection_auth_disabled
= false;
3435 const SBuf
&portType
= AnyP::UriScheme(s
->transport
.protocol
).image();
3437 if (*token
== '[') {
3440 t
= strchr(host
, ']');
3442 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing ']' on IPv6 address: " << token
);
3449 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing Port in: " << token
);
3453 if (!Ip::EnableIpv6
) {
3454 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: IPv6 is not available.");
3458 port
= xatos(t
+ 1);
3459 } else if ((t
= strchr(token
, ':'))) {
3464 port
= xatos(t
+ 1);
3466 } else if (strtol(token
, &junk
, 10) && !*junk
) {
3467 port
= xatos(token
);
3468 debugs(3, 3, portType
<< "_port: found Listen on Port: " << port
);
3470 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing Port: " << token
);
3475 if (port
== 0 && host
!= NULL
) {
3476 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: Port cannot be 0: " << token
);
3484 if (!Ip::EnableIpv6
)
3486 debugs(3, 3, portType
<< "_port: found Listen on wildcard address: *:" << s
->s
.port());
3487 } else if ( (s
->s
= host
) ) { /* check/parse numeric IPA */
3489 if (!Ip::EnableIpv6
)
3491 debugs(3, 3, portType
<< "_port: Listen on Host/IP: " << host
<< " --> " << s
->s
);
3492 } else if ( s
->s
.GetHostByName(host
) ) { /* check/parse for FQDN */
3493 /* dont use ipcache */
3494 s
->defaultsite
= xstrdup(host
);
3496 if (!Ip::EnableIpv6
)
3498 debugs(3, 3, portType
<< "_port: found Listen as Host " << s
->defaultsite
<< " on IP: " << s
->s
);
3500 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: failed to resolve Host/IP: " << host
);
3505 /// parses the protocol= option of the *_port directive, returning parsed value
3506 /// unsupported option values result in a fatal error message
3507 /// upper case values required; caller may convert for backward compatibility
3508 static AnyP::ProtocolVersion
3509 parsePortProtocol(const SBuf
&value
)
3511 // HTTP/1.0 not supported because we are version 1.1 which contains a superset of 1.0
3512 // and RFC 2616 requires us to upgrade 1.0 to 1.1
3513 if (value
.cmp("HTTP") == 0 || value
.cmp("HTTP/1.1") == 0)
3514 return AnyP::ProtocolVersion(AnyP::PROTO_HTTP
, 1,1);
3516 if (value
.cmp("HTTPS") == 0 || value
.cmp("HTTPS/1.1") == 0)
3517 return AnyP::ProtocolVersion(AnyP::PROTO_HTTPS
, 1,1);
3519 if (value
.cmp("FTP") == 0)
3520 return Ftp::ProtocolVersion();
3522 fatalf("%s directive does not support protocol=" SQUIDSBUFPH
"\n", cfg_directive
, SQUIDSBUFPRINT(value
));
3523 return AnyP::ProtocolVersion(); // not reached
3527 parse_port_option(AnyP::PortCfgPointer
&s
, char *token
)
3531 if (strcmp(token
, "accel") == 0) {
3532 if (s
->flags
.isIntercepted()) {
3533 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": Accelerator mode requires its own port. It cannot be shared with other modes.");
3537 s
->flags
.accelSurrogate
= true;
3539 } else if (strcmp(token
, "transparent") == 0 || strcmp(token
, "intercept") == 0) {
3540 if (s
->flags
.accelSurrogate
|| s
->flags
.tproxyIntercept
) {
3541 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": Intercept mode requires its own interception port. It cannot be shared with other modes.");
3545 s
->flags
.natIntercept
= true;
3546 Ip::Interceptor
.StartInterception();
3547 /* Log information regarding the port modes under interception. */
3548 debugs(3, DBG_IMPORTANT
, "Starting Authentication on port " << s
->s
);
3549 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (interception enabled)");
3550 } else if (strcmp(token
, "tproxy") == 0) {
3551 if (s
->flags
.natIntercept
|| s
->flags
.accelSurrogate
) {
3552 debugs(3,DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": TPROXY option requires its own interception port. It cannot be shared with other modes.");
3556 s
->flags
.tproxyIntercept
= true;
3557 Ip::Interceptor
.StartTransparency();
3558 /* Log information regarding the port modes under transparency. */
3559 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (TPROXY enabled)");
3561 if (s
->flags
.proxySurrogate
) {
3562 debugs(3, DBG_IMPORTANT
, "Disabling TPROXY Spoofing on port " << s
->s
<< " (require-proxy-header enabled)");
3565 if (!Ip::Interceptor
.ProbeForTproxy(s
->s
)) {
3566 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": TPROXY support in the system does not work.");
3571 } else if (strcmp(token
, "require-proxy-header") == 0) {
3572 s
->flags
.proxySurrogate
= true;
3573 if (s
->flags
.tproxyIntercept
) {
3574 // receiving is still permitted, so we do not unset the TPROXY flag
3575 // spoofing access control override takes care of the spoof disable later
3576 debugs(3, DBG_IMPORTANT
, "Disabling TPROXY Spoofing on port " << s
->s
<< " (require-proxy-header enabled)");
3579 } else if (strncmp(token
, "defaultsite=", 12) == 0) {
3580 if (!s
->flags
.accelSurrogate
) {
3581 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": defaultsite option requires Acceleration mode flag.");
3585 safe_free(s
->defaultsite
);
3586 s
->defaultsite
= xstrdup(token
+ 12);
3587 } else if (strcmp(token
, "vhost") == 0) {
3588 if (!s
->flags
.accelSurrogate
) {
3589 debugs(3, DBG_CRITICAL
, "WARNING: " << cfg_directive
<< ": vhost option is deprecated. Use 'accel' mode flag instead.");
3591 s
->flags
.accelSurrogate
= true;
3593 } else if (strcmp(token
, "no-vhost") == 0) {
3594 if (!s
->flags
.accelSurrogate
) {
3595 debugs(3, DBG_IMPORTANT
, "ERROR: " << cfg_directive
<< ": no-vhost option requires Acceleration mode flag.");
3598 } else if (strcmp(token
, "vport") == 0) {
3599 if (!s
->flags
.accelSurrogate
) {
3600 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": vport option requires Acceleration mode flag.");
3605 } else if (strncmp(token
, "vport=", 6) == 0) {
3606 if (!s
->flags
.accelSurrogate
) {
3607 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": vport option requires Acceleration mode flag.");
3611 s
->vport
= xatos(token
+ 6);
3612 } else if (strncmp(token
, "protocol=", 9) == 0) {
3613 if (!s
->flags
.accelSurrogate
) {
3614 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": protocol option requires Acceleration mode flag.");
3618 s
->transport
= parsePortProtocol(ToUpper(SBuf(token
+ 9)));
3619 } else if (strcmp(token
, "allow-direct") == 0) {
3620 if (!s
->flags
.accelSurrogate
) {
3621 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": allow-direct option requires Acceleration mode flag.");
3625 s
->allow_direct
= true;
3626 } else if (strcmp(token
, "act-as-origin") == 0) {
3627 if (!s
->flags
.accelSurrogate
) {
3628 debugs(3, DBG_IMPORTANT
, "ERROR: " << cfg_directive
<< ": act-as-origin option requires Acceleration mode flag.");
3630 s
->actAsOrigin
= true;
3631 } else if (strcmp(token
, "ignore-cc") == 0) {
3632 #if !USE_HTTP_VIOLATIONS
3633 if (!s
->flags
.accelSurrogate
) {
3634 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": ignore-cc option requires Acceleration mode flag.");
3639 s
->ignore_cc
= true;
3640 } else if (strncmp(token
, "name=", 5) == 0) {
3642 s
->name
= xstrdup(token
+ 5);
3643 } else if (strcmp(token
, "no-connection-auth") == 0) {
3644 s
->connection_auth_disabled
= true;
3645 } else if (strcmp(token
, "connection-auth=off") == 0) {
3646 s
->connection_auth_disabled
= true;
3647 } else if (strcmp(token
, "connection-auth") == 0) {
3648 s
->connection_auth_disabled
= false;
3649 } else if (strcmp(token
, "connection-auth=on") == 0) {
3650 s
->connection_auth_disabled
= false;
3651 } else if (strncmp(token
, "disable-pmtu-discovery=", 23) == 0) {
3652 if (!strcmp(token
+ 23, "off"))
3653 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3654 else if (!strcmp(token
+ 23, "transparent"))
3655 s
->disable_pmtu_discovery
= DISABLE_PMTU_TRANSPARENT
;
3656 else if (!strcmp(token
+ 23, "always"))
3657 s
->disable_pmtu_discovery
= DISABLE_PMTU_ALWAYS
;
3662 } else if (strcmp(token
, "ipv4") == 0) {
3663 if ( !s
->s
.setIPv4() ) {
3664 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": IPv6 addresses cannot be used as IPv4-Only. " << s
->s
);
3668 } else if (strcmp(token
, "tcpkeepalive") == 0) {
3669 s
->tcp_keepalive
.enabled
= true;
3670 } else if (strncmp(token
, "tcpkeepalive=", 13) == 0) {
3671 char *t
= token
+ 13;
3672 s
->tcp_keepalive
.enabled
= true;
3673 s
->tcp_keepalive
.idle
= xatoui(t
,',');
3677 s
->tcp_keepalive
.interval
= xatoui(t
,',');
3682 s
->tcp_keepalive
.timeout
= xatoui(t
);
3685 } else if (strcmp(token
, "sslBump") == 0) {
3686 debugs(3, DBG_PARSE_NOTE(1), "WARNING: '" << token
<< "' is deprecated " <<
3687 "in " << cfg_directive
<< ". Use 'ssl-bump' instead.");
3688 s
->flags
.tunnelSslBumping
= true;
3689 } else if (strcmp(token
, "ssl-bump") == 0) {
3690 s
->flags
.tunnelSslBumping
= true;
3691 } else if (strncmp(token
, "cert=", 5) == 0) {
3692 s
->secure
.parse(token
);
3693 } else if (strncmp(token
, "key=", 4) == 0) {
3694 s
->secure
.parse(token
);
3695 } else if (strncmp(token
, "version=", 8) == 0) {
3696 debugs(3, DBG_PARSE_NOTE(1), "UPGRADE WARNING: '" << token
<< "' is deprecated " <<
3697 "in " << cfg_directive
<< ". Use 'options=' instead.");
3698 s
->secure
.parse(token
);
3699 } else if (strncmp(token
, "options=", 8) == 0) {
3700 s
->secure
.parse(token
);
3701 } else if (strncmp(token
, "cipher=", 7) == 0) {
3702 s
->secure
.parse(token
);
3703 } else if (strncmp(token
, "clientca=", 9) == 0) {
3704 safe_free(s
->clientca
);
3705 s
->clientca
= xstrdup(token
+ 9);
3706 } else if (strncmp(token
, "cafile=", 7) == 0) {
3707 debugs(3, DBG_PARSE_NOTE(1), "UPGRADE WARNING: '" << token
<< "' is deprecated " <<
3708 "in " << cfg_directive
<< ". Use 'tls-cafile=' instead.");
3709 s
->secure
.parse(token
);
3710 } else if (strncmp(token
, "capath=", 7) == 0) {
3711 s
->secure
.parse(token
);
3712 } else if (strncmp(token
, "crlfile=", 8) == 0) {
3713 s
->secure
.parse(token
);
3714 } else if (strncmp(token
, "dhparams=", 9) == 0) {
3715 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: '" << token
<< "' is deprecated " <<
3716 "in " << cfg_directive
<< ". Use 'tls-dh=' instead.");
3717 s
->secure
.parse(token
);
3718 } else if (strncmp(token
, "sslflags=", 9) == 0) {
3719 // NP: deprecation warnings output by secure.parse() when relevant
3720 s
->secure
.parse(token
+3);
3721 } else if (strncmp(token
, "sslcontext=", 11) == 0) {
3722 safe_free(s
->sslContextSessionId
);
3723 s
->sslContextSessionId
= xstrdup(token
+ 11);
3724 } else if (strcmp(token
, "generate-host-certificates") == 0) {
3725 s
->generateHostCertificates
= true;
3726 } else if (strcmp(token
, "generate-host-certificates=on") == 0) {
3727 s
->generateHostCertificates
= true;
3728 } else if (strcmp(token
, "generate-host-certificates=off") == 0) {
3729 s
->generateHostCertificates
= false;
3730 } else if (strncmp(token
, "dynamic_cert_mem_cache_size=", 28) == 0) {
3731 parseBytesOptionValue(&s
->dynamicCertMemCacheSize
, B_BYTES_STR
, token
+ 28);
3733 } else if (strncmp(token
, "tls-", 4) == 0) {
3734 s
->secure
.parse(token
+4);
3735 } else if (strcmp(token
, "ftp-track-dirs") == 0) {
3736 s
->ftp_track_dirs
= true;
3738 debugs(3, DBG_CRITICAL
, "FATAL: Unknown " << cfg_directive
<< " option '" << token
<< "'.");
3744 add_http_port(char *portspec
)
3746 AnyP::PortCfgPointer s
= new AnyP::PortCfg();
3747 s
->transport
= parsePortProtocol(SBuf("HTTP"));
3748 parsePortSpecification(s
, portspec
);
3749 // we may need to merge better if the above returns a list with clones
3750 assert(s
->next
== NULL
);
3751 s
->next
= HttpPortList
;
3756 parsePortCfg(AnyP::PortCfgPointer
*head
, const char *optionName
)
3759 if (strcmp(optionName
, "http_port") == 0 ||
3760 strcmp(optionName
, "ascii_port") == 0)
3762 else if (strcmp(optionName
, "https_port") == 0)
3763 protoName
= "HTTPS";
3764 else if (strcmp(optionName
, "ftp_port") == 0)
3766 if (protoName
.isEmpty()) {
3771 char *token
= ConfigParser::NextToken();
3778 AnyP::PortCfgPointer s
= new AnyP::PortCfg();
3779 s
->transport
= parsePortProtocol(protoName
); // default; protocol=... overwrites
3780 parsePortSpecification(s
, token
);
3782 /* parse options ... */
3783 while ((token
= ConfigParser::NextToken())) {
3784 parse_port_option(s
, token
);
3788 // if clientca has been defined but not cafile, then use it to verify
3789 // but if cafile has been defined, only use that to verify
3790 if (s
->clientca
&& !s
->secure
.caFiles
.size())
3791 s
->secure
.caFiles
.emplace_back(SBuf(s
->clientca
));
3794 if (s
->transport
.protocol
== AnyP::PROTO_HTTPS
) {
3795 s
->secure
.encryptTransport
= true;
3797 /* ssl-bump on https_port configuration requires either tproxy or intercept, and vice versa */
3798 const bool hijacked
= s
->flags
.isIntercepted();
3799 if (s
->flags
.tunnelSslBumping
&& !hijacked
) {
3800 debugs(3, DBG_CRITICAL
, "FATAL: ssl-bump on https_port requires tproxy/intercept which is missing.");
3804 if (hijacked
&& !s
->flags
.tunnelSslBumping
) {
3805 debugs(3, DBG_CRITICAL
, "FATAL: tproxy/intercept on https_port requires ssl-bump which is missing.");
3810 if (s
->flags
.proxySurrogate
) {
3811 debugs(3,DBG_CRITICAL
, "FATAL: https_port: require-proxy-header option is not supported on HTTPS ports.");
3815 } else if (protoName
.cmp("FTP") == 0) {
3816 /* ftp_port does not support ssl-bump */
3817 if (s
->flags
.tunnelSslBumping
) {
3818 debugs(3, DBG_CRITICAL
, "FATAL: ssl-bump is not supported for ftp_port.");
3822 if (s
->flags
.proxySurrogate
) {
3823 // Passive FTP data channel does not work without deep protocol inspection in the frontend.
3824 debugs(3,DBG_CRITICAL
, "FATAL: require-proxy-header option is not supported on ftp_port.");
3830 if (Ip::EnableIpv6
&IPV6_SPECIAL_SPLITSTACK
&& s
->s
.isAnyAddr()) {
3831 // clone the port options from *s to *(s->next)
3832 s
->next
= s
->clone();
3833 s
->next
->s
.setIPv4();
3834 debugs(3, 3, AnyP::UriScheme(s
->transport
.protocol
).image() << "_port: clone wildcard address for split-stack: " << s
->s
<< " and " << s
->next
->s
);
3837 while (*head
!= NULL
)
3838 head
= &((*head
)->next
);
3844 dump_generic_port(StoreEntry
* e
, const char *n
, const AnyP::PortCfgPointer
&s
)
3846 char buf
[MAX_IPSTRLEN
];
3848 storeAppendPrintf(e
, "%s %s",
3850 s
->s
.toUrl(buf
,MAX_IPSTRLEN
));
3852 // MODES and specific sub-options.
3853 if (s
->flags
.natIntercept
)
3854 storeAppendPrintf(e
, " intercept");
3856 else if (s
->flags
.tproxyIntercept
)
3857 storeAppendPrintf(e
, " tproxy");
3859 else if (s
->flags
.proxySurrogate
)
3860 storeAppendPrintf(e
, " require-proxy-header");
3862 else if (s
->flags
.accelSurrogate
) {
3863 storeAppendPrintf(e
, " accel");
3866 storeAppendPrintf(e
, " vhost");
3869 storeAppendPrintf(e
, " vport");
3870 else if (s
->vport
> 0)
3871 storeAppendPrintf(e
, " vport=%d", s
->vport
);
3874 storeAppendPrintf(e
, " defaultsite=%s", s
->defaultsite
);
3876 // TODO: compare against prefix of 'n' instead of assuming http_port
3877 if (s
->transport
.protocol
!= AnyP::PROTO_HTTP
)
3878 storeAppendPrintf(e
, " protocol=%s", AnyP::ProtocolType_str
[s
->transport
.protocol
]);
3880 if (s
->allow_direct
)
3881 storeAppendPrintf(e
, " allow-direct");
3884 storeAppendPrintf(e
, " ignore-cc");
3888 // Generic independent options
3891 storeAppendPrintf(e
, " name=%s", s
->name
);
3893 #if USE_HTTP_VIOLATIONS
3894 if (!s
->flags
.accelSurrogate
&& s
->ignore_cc
)
3895 storeAppendPrintf(e
, " ignore-cc");
3898 if (s
->connection_auth_disabled
)
3899 storeAppendPrintf(e
, " connection-auth=off");
3901 storeAppendPrintf(e
, " connection-auth=on");
3903 if (s
->disable_pmtu_discovery
!= DISABLE_PMTU_OFF
) {
3906 if (s
->disable_pmtu_discovery
== DISABLE_PMTU_ALWAYS
)
3909 pmtu
= "transparent";
3911 storeAppendPrintf(e
, " disable-pmtu-discovery=%s", pmtu
);
3914 if (s
->s
.isAnyAddr() && !s
->s
.isIPv6())
3915 storeAppendPrintf(e
, " ipv4");
3917 if (s
->tcp_keepalive
.enabled
) {
3918 if (s
->tcp_keepalive
.idle
|| s
->tcp_keepalive
.interval
|| s
->tcp_keepalive
.timeout
) {
3919 storeAppendPrintf(e
, " tcpkeepalive=%d,%d,%d", s
->tcp_keepalive
.idle
, s
->tcp_keepalive
.interval
, s
->tcp_keepalive
.timeout
);
3921 storeAppendPrintf(e
, " tcpkeepalive");
3926 if (s
->flags
.tunnelSslBumping
)
3927 storeAppendPrintf(e
, " ssl-bump");
3930 s
->secure
.dumpCfg(e
, "tls-");
3933 if (s
->sslContextSessionId
)
3934 storeAppendPrintf(e
, " sslcontext=%s", s
->sslContextSessionId
);
3936 if (!s
->generateHostCertificates
)
3937 storeAppendPrintf(e
, " generate-host-certificates=off");
3939 if (s
->dynamicCertMemCacheSize
!= 4*1024*1024) // 4MB default
3940 storeAppendPrintf(e
, "dynamic_cert_mem_cache_size=%" PRIuSIZE
"%s\n", s
->dynamicCertMemCacheSize
, B_BYTES_STR
);
3945 dump_PortCfg(StoreEntry
* e
, const char *n
, const AnyP::PortCfgPointer
&s
)
3947 for (AnyP::PortCfgPointer p
= s
; p
!= NULL
; p
= p
->next
) {
3948 dump_generic_port(e
, n
, p
);
3949 storeAppendPrintf(e
, "\n");
3954 configFreeMemory(void)
3957 Config
.ssl_client
.sslContext
.reset();
3959 Ssl::unloadSquidUntrusted();
3964 requirePathnameExists(const char *name
, const char *path
)
3968 char pathbuf
[BUFSIZ
];
3969 assert(path
!= NULL
);
3971 if (Config
.chroot_dir
&& (geteuid() == 0)) {
3972 snprintf(pathbuf
, BUFSIZ
, "%s/%s", Config
.chroot_dir
, path
);
3976 if (stat(path
, &sb
) < 0) {
3978 debugs(0, DBG_CRITICAL
, (opt_parse_cfg_only
?"FATAL: ":"ERROR: ") << name
<< " " << path
<< ": " << xstrerr(xerrno
));
3979 // keep going to find more issues if we are only checking the config file with "-k parse"
3980 if (opt_parse_cfg_only
)
3982 // this is fatal if it is found during startup or reconfigure
3983 if (opt_send_signal
== -1 || opt_send_signal
== SIGHUP
)
3984 fatalf("%s %s: %s", name
, path
, xstrerr(xerrno
));
3988 #include "AccessLogEntry.h"
3991 * We support several access_log configuration styles:
3993 * #1: Deprecated ancient style without an explicit logging module:
3994 * access_log /var/log/access.log
3996 * #2: The "none" logging module (i.e., no logging [of matching transactions]):
3997 * access_log none [acl ...]
3999 * #3: Configurable logging module without named options:
4000 * Logformat or the first ACL name, whichever comes first, may not contain '='.
4001 * If no explicit logformat name is given, the first ACL name, if any,
4002 * should not be an existing logformat name or it will be treated as such.
4003 * access_log module:place [logformat_name] [acl ...]
4005 * #4: Configurable logging module with name=value options such as logformat=x:
4006 * The first ACL name may not contain '='.
4007 * access_log module:place [option ...] [acl ...]
4011 parse_access_log(CustomLog
** logs
)
4013 const char *filename
= ConfigParser::NextToken();
4019 CustomLog
*cl
= (CustomLog
*)xcalloc(1, sizeof(*cl
));
4021 cl
->filename
= xstrdup(filename
);
4022 // default buffer size and fatal settings
4023 cl
->bufferSize
= 8*MAX_URL
;
4026 if (strcmp(filename
, "none") == 0) {
4027 cl
->type
= Log::Format::CLF_NONE
;
4028 aclParseAclList(LegacyParser
, &cl
->aclList
, filename
);
4030 logs
= &(*logs
)->next
;
4035 cl
->type
= Log::Format::CLF_UNKNOWN
;
4036 cl
->rotateCount
= -1; // default: use global logfile_rotate setting.
4038 const char *token
= ConfigParser::PeekAtToken();
4039 if (!token
) { // style #1
4040 // no options to deal with
4041 } else if (!strchr(token
, '=')) { // style #3
4042 // if logformat name is recognized,
4043 // pop the previewed token; Else it must be an ACL name
4044 if (setLogformat(cl
, token
, false))
4045 (void)ConfigParser::NextToken();
4046 } else { // style #4
4048 if (strncasecmp(token
, "on-error=", 9) == 0) {
4049 if (strncasecmp(token
+9, "die", 3) == 0) {
4051 } else if (strncasecmp(token
+9, "drop", 4) == 0) {
4054 debugs(3, DBG_CRITICAL
, "Unknown value for on-error '" <<
4055 token
<< "' expected 'drop' or 'die'");
4056 xfree(cl
->filename
);
4061 } else if (strncasecmp(token
, "buffer-size=", 12) == 0) {
4062 parseBytesOptionValue(&cl
->bufferSize
, B_BYTES_STR
, token
+12);
4063 } else if (strncasecmp(token
, "rotate=", 7) == 0) {
4064 cl
->rotateCount
= xatoi(token
+ 7);
4065 } else if (strncasecmp(token
, "logformat=", 10) == 0) {
4066 setLogformat(cl
, token
+10, true);
4067 } else if (!strchr(token
, '=')) {
4068 // Do not pop the token; it must be an ACL name
4069 break; // done with name=value options, now to ACLs
4071 debugs(3, DBG_CRITICAL
, "Unknown access_log option " << token
);
4072 xfree(cl
->filename
);
4077 // Pop the token, it was a valid "name=value" option
4078 (void)ConfigParser::NextToken();
4079 // Get next with preview ConfigParser::NextToken call.
4080 } while ((token
= ConfigParser::PeekAtToken()) != NULL
);
4083 // set format if it has not been specified explicitly
4084 if (cl
->type
== Log::Format::CLF_UNKNOWN
)
4085 setLogformat(cl
, "squid", true);
4087 aclParseAclList(LegacyParser
, &cl
->aclList
, cl
->filename
);
4090 logs
= &(*logs
)->next
;
4095 /// sets CustomLog::type and, if needed, CustomLog::lf
4096 /// returns false iff there is no named log format
4098 setLogformat(CustomLog
*cl
, const char *logdef_name
, const bool dieWhenMissing
)
4101 assert(logdef_name
);
4103 debugs(3, 9, "possible " << cl
->filename
<< " logformat: " << logdef_name
);
4105 if (cl
->type
!= Log::Format::CLF_UNKNOWN
) {
4106 debugs(3, DBG_CRITICAL
, "Second logformat name in one access_log: " <<
4107 logdef_name
<< " " << cl
->type
<< " ? " << Log::Format::CLF_NONE
);
4112 /* look for the definition pointer corresponding to this name */
4113 Format::Format
*lf
= Log::TheConfig
.logformats
;
4115 while (lf
!= NULL
) {
4116 debugs(3, 9, "Comparing against '" << lf
->name
<< "'");
4118 if (strcmp(lf
->name
, logdef_name
) == 0)
4125 cl
->type
= Log::Format::CLF_CUSTOM
;
4127 } else if (strcmp(logdef_name
, "auto") == 0) {
4128 debugs(0, DBG_CRITICAL
, "WARNING: Log format 'auto' no longer exists. Using 'squid' instead.");
4129 cl
->type
= Log::Format::CLF_SQUID
;
4130 } else if (strcmp(logdef_name
, "squid") == 0) {
4131 cl
->type
= Log::Format::CLF_SQUID
;
4132 } else if (strcmp(logdef_name
, "common") == 0) {
4133 cl
->type
= Log::Format::CLF_COMMON
;
4134 } else if (strcmp(logdef_name
, "combined") == 0) {
4135 cl
->type
= Log::Format::CLF_COMBINED
;
4137 } else if (strcmp(logdef_name
, "icap_squid") == 0) {
4138 cl
->type
= Log::Format::CLF_ICAP_SQUID
;
4140 } else if (strcmp(logdef_name
, "useragent") == 0) {
4141 cl
->type
= Log::Format::CLF_USERAGENT
;
4142 } else if (strcmp(logdef_name
, "referrer") == 0) {
4143 cl
->type
= Log::Format::CLF_REFERER
;
4144 } else if (dieWhenMissing
) {
4145 debugs(3, DBG_CRITICAL
, "Log format '" << logdef_name
<< "' is not defined");
4156 check_null_access_log(CustomLog
*customlog_definitions
)
4158 return customlog_definitions
== NULL
;
4162 dump_access_log(StoreEntry
* entry
, const char *name
, CustomLog
* logs
)
4166 for (log
= logs
; log
; log
= log
->next
) {
4167 storeAppendPrintf(entry
, "%s ", name
);
4169 switch (log
->type
) {
4171 case Log::Format::CLF_CUSTOM
:
4172 storeAppendPrintf(entry
, "%s logformat=%s", log
->filename
, log
->logFormat
->name
);
4175 case Log::Format::CLF_NONE
:
4176 storeAppendPrintf(entry
, "logformat=none");
4179 case Log::Format::CLF_SQUID
:
4180 storeAppendPrintf(entry
, "%s logformat=squid", log
->filename
);
4183 case Log::Format::CLF_COMBINED
:
4184 storeAppendPrintf(entry
, "%s logformat=combined", log
->filename
);
4187 case Log::Format::CLF_COMMON
:
4188 storeAppendPrintf(entry
, "%s logformat=common", log
->filename
);
4192 case Log::Format::CLF_ICAP_SQUID
:
4193 storeAppendPrintf(entry
, "%s logformat=icap_squid", log
->filename
);
4196 case Log::Format::CLF_USERAGENT
:
4197 storeAppendPrintf(entry
, "%s logformat=useragent", log
->filename
);
4200 case Log::Format::CLF_REFERER
:
4201 storeAppendPrintf(entry
, "%s logformat=referrer", log
->filename
);
4204 case Log::Format::CLF_UNKNOWN
:
4208 // default is on-error=die
4210 storeAppendPrintf(entry
, " on-error=drop");
4213 if (log
->bufferSize
!= 64*1024)
4214 storeAppendPrintf(entry
, " buffer-size=%" PRIuSIZE
, log
->bufferSize
);
4216 if (log
->rotateCount
>= 0)
4217 storeAppendPrintf(entry
, " rotate=%d", log
->rotateCount
);
4220 dump_acl_list(entry
, log
->aclList
);
4222 storeAppendPrintf(entry
, "\n");
4227 free_access_log(CustomLog
** definitions
)
4229 while (*definitions
) {
4230 CustomLog
*log
= *definitions
;
4231 *definitions
= log
->next
;
4233 log
->logFormat
= NULL
;
4234 log
->type
= Log::Format::CLF_UNKNOWN
;
4237 aclDestroyAclList(&log
->aclList
);
4239 safe_free(log
->filename
);
4245 #if HAVE_CPU_AFFINITY /* until somebody else needs this general code */
4246 /// parses list of integers form name=N1,N2,N3,...
4248 parseNamedIntList(const char *data
, const String
&name
, std::vector
<int> &list
)
4250 if (data
&& (strncmp(data
, name
.rawBuf(), name
.size()) == 0)) {
4251 data
+= name
.size();
4256 if (!StringToInt(data
, value
, &data
, 10))
4258 list
.push_back(value
);
4259 if (*data
== '\0' || *data
!= ',')
4264 return data
&& *data
== '\0';
4269 parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4271 #if !HAVE_CPU_AFFINITY
4272 debugs(3, DBG_CRITICAL
, "FATAL: Squid built with no CPU affinity " <<
4273 "support, do not set 'cpu_affinity_map'");
4276 #else /* HAVE_CPU_AFFINITY */
4277 if (!*cpuAffinityMap
)
4278 *cpuAffinityMap
= new CpuAffinityMap
;
4280 const char *const pToken
= ConfigParser::NextToken();
4281 const char *const cToken
= ConfigParser::NextToken();
4282 std::vector
<int> processes
, cores
;
4283 if (!parseNamedIntList(pToken
, "process_numbers", processes
)) {
4284 debugs(3, DBG_CRITICAL
, "FATAL: bad 'process_numbers' parameter " <<
4285 "in 'cpu_affinity_map'");
4287 } else if (!parseNamedIntList(cToken
, "cores", cores
)) {
4288 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cores' parameter in " <<
4289 "'cpu_affinity_map'");
4291 } else if (!(*cpuAffinityMap
)->add(processes
, cores
)) {
4292 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cpu_affinity_map'; " <<
4293 "process_numbers and cores lists differ in length or " <<
4294 "contain numbers <= 0");
4301 dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
)
4303 if (cpuAffinityMap
) {
4304 storeAppendPrintf(entry
, "%s process_numbers=", name
);
4305 for (size_t i
= 0; i
< cpuAffinityMap
->processes().size(); ++i
) {
4306 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4307 cpuAffinityMap
->processes()[i
]);
4309 storeAppendPrintf(entry
, " cores=");
4310 for (size_t i
= 0; i
< cpuAffinityMap
->cores().size(); ++i
) {
4311 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4312 cpuAffinityMap
->cores()[i
]);
4314 storeAppendPrintf(entry
, "\n");
4319 free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4321 delete *cpuAffinityMap
;
4322 *cpuAffinityMap
= NULL
;
4328 parse_adaptation_service_set_type()
4330 Adaptation::Config::ParseServiceSet();
4334 parse_adaptation_service_chain_type()
4336 Adaptation::Config::ParseServiceChain();
4340 parse_adaptation_access_type()
4342 Adaptation::Config::ParseAccess(LegacyParser
);
4344 #endif /* USE_ADAPTATION */
4349 parse_icap_service_type(Adaptation::Icap::Config
* cfg
)
4351 cfg
->parseService();
4355 free_icap_service_type(Adaptation::Icap::Config
* cfg
)
4361 dump_icap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4363 cfg
.dumpService(entry
, name
);
4367 parse_icap_class_type()
4369 debugs(93, DBG_CRITICAL
, "WARNING: 'icap_class' is depricated. " <<
4370 "Use 'adaptation_service_set' instead");
4371 Adaptation::Config::ParseServiceSet();
4375 parse_icap_access_type()
4377 debugs(93, DBG_CRITICAL
, "WARNING: 'icap_access' is depricated. " <<
4378 "Use 'adaptation_access' instead");
4379 Adaptation::Config::ParseAccess(LegacyParser
);
4387 parse_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4389 cfg
->parseService();
4393 free_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4399 dump_ecap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Ecap::Config
&cfg
)
4401 cfg
.dumpService(entry
, name
);
4404 #endif /* USE_ECAP */
4407 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4412 cfg
->service_failure_limit
= GetInteger();
4414 if ((token
= ConfigParser::NextToken()) == NULL
)
4417 if (strcmp(token
,"in") != 0) {
4418 debugs(3, DBG_CRITICAL
, "expecting 'in' on'" << config_input_line
<< "'");
4423 if ((token
= ConfigParser::NextToken()) == NULL
) {
4428 d
= static_cast<time_t> (xatoi(token
));
4430 m
= static_cast<time_t> (1);
4434 else if ((token
= ConfigParser::NextToken()) == NULL
) {
4435 debugs(3, DBG_CRITICAL
, "No time-units on '" << config_input_line
<< "'");
4438 } else if ((m
= parseTimeUnits(token
, false)) == 0) {
4443 cfg
->oldest_service_failure
= (m
* d
);
4446 static void dump_icap_service_failure_limit(StoreEntry
*entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4448 storeAppendPrintf(entry
, "%s %d", name
, cfg
.service_failure_limit
);
4449 if (cfg
.oldest_service_failure
> 0) {
4450 storeAppendPrintf(entry
, " in %d seconds", (int)cfg
.oldest_service_failure
);
4452 storeAppendPrintf(entry
, "\n");
4455 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4457 cfg
->oldest_service_failure
= 0;
4458 cfg
->service_failure_limit
= 0;
4463 static void parse_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
)
4466 sslproxy_cert_adapt
*ca
= (sslproxy_cert_adapt
*) xcalloc(1, sizeof(sslproxy_cert_adapt
));
4467 if ((al
= ConfigParser::NextToken()) == NULL
) {
4474 if ( char *s
= strchr(al
, '{')) {
4475 *s
= '\0'; // terminate the al string
4488 if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetValidAfter
]) == 0) {
4489 ca
->alg
= Ssl::algSetValidAfter
;
4490 ca
->param
= xstrdup("on");
4491 } else if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetValidBefore
]) == 0) {
4492 ca
->alg
= Ssl::algSetValidBefore
;
4493 ca
->param
= xstrdup("on");
4494 } else if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetCommonName
]) == 0) {
4495 ca
->alg
= Ssl::algSetCommonName
;
4497 if (strlen(param
) > 64) {
4498 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_adapt: setCommonName{" <<param
<< "} : using common name longer than 64 bytes is not supported");
4503 ca
->param
= xstrdup(param
);
4506 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_adapt: unknown cert adaptation algorithm: " << al
);
4512 aclParseAclList(LegacyParser
, &ca
->aclList
, al
);
4515 cert_adapt
= &(*cert_adapt
)->next
;
4520 static void dump_sslproxy_cert_adapt(StoreEntry
*entry
, const char *name
, sslproxy_cert_adapt
*cert_adapt
)
4522 for (sslproxy_cert_adapt
*ca
= cert_adapt
; ca
!= NULL
; ca
= ca
->next
) {
4523 storeAppendPrintf(entry
, "%s ", name
);
4524 storeAppendPrintf(entry
, "%s{%s} ", Ssl::sslCertAdaptAlgoritm(ca
->alg
), ca
->param
);
4526 dump_acl_list(entry
, ca
->aclList
);
4527 storeAppendPrintf(entry
, "\n");
4531 static void free_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
)
4533 while (*cert_adapt
) {
4534 sslproxy_cert_adapt
*ca
= *cert_adapt
;
4535 *cert_adapt
= ca
->next
;
4536 safe_free(ca
->param
);
4539 aclDestroyAclList(&ca
->aclList
);
4545 static void parse_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
)
4548 sslproxy_cert_sign
*cs
= (sslproxy_cert_sign
*) xcalloc(1, sizeof(sslproxy_cert_sign
));
4549 if ((al
= ConfigParser::NextToken()) == NULL
) {
4555 if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignTrusted
]) == 0)
4556 cs
->alg
= Ssl::algSignTrusted
;
4557 else if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignUntrusted
]) == 0)
4558 cs
->alg
= Ssl::algSignUntrusted
;
4559 else if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignSelf
]) == 0)
4560 cs
->alg
= Ssl::algSignSelf
;
4562 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_sign: unknown cert signing algorithm: " << al
);
4568 aclParseAclList(LegacyParser
, &cs
->aclList
, al
);
4571 cert_sign
= &(*cert_sign
)->next
;
4576 static void dump_sslproxy_cert_sign(StoreEntry
*entry
, const char *name
, sslproxy_cert_sign
*cert_sign
)
4578 sslproxy_cert_sign
*cs
;
4579 for (cs
= cert_sign
; cs
!= NULL
; cs
= cs
->next
) {
4580 storeAppendPrintf(entry
, "%s ", name
);
4581 storeAppendPrintf(entry
, "%s ", Ssl::certSignAlgorithm(cs
->alg
));
4583 dump_acl_list(entry
, cs
->aclList
);
4584 storeAppendPrintf(entry
, "\n");
4588 static void free_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
)
4590 while (*cert_sign
) {
4591 sslproxy_cert_sign
*cs
= *cert_sign
;
4592 *cert_sign
= cs
->next
;
4595 aclDestroyAclList(&cs
->aclList
);
4601 class sslBumpCfgRr
: public ::RegisteredRunner
4604 static Ssl::BumpMode lastDeprecatedRule
;
4605 /* RegisteredRunner API */
4606 virtual void finalizeConfig();
4609 Ssl::BumpMode
sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpEnd
;
4611 RunnerRegistrationEntry(sslBumpCfgRr
);
4614 sslBumpCfgRr::finalizeConfig()
4616 if (lastDeprecatedRule
!= Ssl::bumpEnd
) {
4617 assert( lastDeprecatedRule
== Ssl::bumpClientFirst
|| lastDeprecatedRule
== Ssl::bumpNone
);
4618 static char buf
[1024];
4619 if (lastDeprecatedRule
== Ssl::bumpClientFirst
) {
4620 strcpy(buf
, "ssl_bump deny all");
4621 debugs(3, DBG_CRITICAL
, "WARNING: auto-converting deprecated implicit "
4622 "\"ssl_bump deny all\" to \"ssl_bump none all\". New ssl_bump configurations "
4623 "must not use implicit rules. Update your ssl_bump rules.");
4625 strcpy(buf
, "ssl_bump allow all");
4626 debugs(3, DBG_CRITICAL
, "SECURITY NOTICE: auto-converting deprecated implicit "
4627 "\"ssl_bump allow all\" to \"ssl_bump client-first all\" which is usually "
4628 "inferior to the newer server-first bumping mode. New ssl_bump"
4629 " configurations must not use implicit rules. Update your ssl_bump rules.");
4635 static void parse_sslproxy_ssl_bump(acl_access
**ssl_bump
)
4637 typedef const char *BumpCfgStyle
;
4638 BumpCfgStyle bcsNone
= NULL
;
4639 BumpCfgStyle bcsNew
= "new client/server-first/none";
4640 BumpCfgStyle bcsOld
= "deprecated allow/deny";
4641 static BumpCfgStyle bumpCfgStyleLast
= bcsNone
;
4642 BumpCfgStyle bumpCfgStyleNow
= bcsNone
;
4644 if ((bm
= ConfigParser::NextToken()) == NULL
) {
4649 // if this is the first rule proccessed
4650 if (*ssl_bump
== NULL
) {
4651 bumpCfgStyleLast
= bcsNone
;
4652 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpEnd
;
4655 allow_t action
= allow_t(ACCESS_ALLOWED
);
4657 if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpClientFirst
]) == 0) {
4658 action
.kind
= Ssl::bumpClientFirst
;
4659 bumpCfgStyleNow
= bcsNew
;
4660 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpServerFirst
]) == 0) {
4661 action
.kind
= Ssl::bumpServerFirst
;
4662 bumpCfgStyleNow
= bcsNew
;
4663 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpPeek
]) == 0) {
4664 action
.kind
= Ssl::bumpPeek
;
4665 bumpCfgStyleNow
= bcsNew
;
4666 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpStare
]) == 0) {
4667 action
.kind
= Ssl::bumpStare
;
4668 bumpCfgStyleNow
= bcsNew
;
4669 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpSplice
]) == 0) {
4670 action
.kind
= Ssl::bumpSplice
;
4671 bumpCfgStyleNow
= bcsNew
;
4672 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpBump
]) == 0) {
4673 action
.kind
= Ssl::bumpBump
;
4674 bumpCfgStyleNow
= bcsNew
;
4675 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpTerminate
]) == 0) {
4676 action
.kind
= Ssl::bumpTerminate
;
4677 bumpCfgStyleNow
= bcsNew
;
4678 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpNone
]) == 0) {
4679 action
.kind
= Ssl::bumpNone
;
4680 bumpCfgStyleNow
= bcsNew
;
4681 } else if (strcmp(bm
, "allow") == 0) {
4682 debugs(3, DBG_CRITICAL
, "SECURITY NOTICE: auto-converting deprecated "
4683 "\"ssl_bump allow <acl>\" to \"ssl_bump client-first <acl>\" which "
4684 "is usually inferior to the newer server-first "
4685 "bumping mode. Update your ssl_bump rules.");
4686 action
.kind
= Ssl::bumpClientFirst
;
4687 bumpCfgStyleNow
= bcsOld
;
4688 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpClientFirst
;
4689 } else if (strcmp(bm
, "deny") == 0) {
4690 debugs(3, DBG_CRITICAL
, "WARNING: auto-converting deprecated "
4691 "\"ssl_bump deny <acl>\" to \"ssl_bump none <acl>\". Update "
4692 "your ssl_bump rules.");
4693 action
.kind
= Ssl::bumpNone
;
4694 bumpCfgStyleNow
= bcsOld
;
4695 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpNone
;
4697 debugs(3, DBG_CRITICAL
, "FATAL: unknown ssl_bump mode: " << bm
);
4702 if (bumpCfgStyleLast
!= bcsNone
&& bumpCfgStyleNow
!= bumpCfgStyleLast
) {
4703 debugs(3, DBG_CRITICAL
, "FATAL: do not mix " << bumpCfgStyleNow
<< " actions with " <<
4704 bumpCfgStyleLast
<< " actions. Update your ssl_bump rules.");
4709 bumpCfgStyleLast
= bumpCfgStyleNow
;
4712 ParseAclWithAction(ssl_bump
, action
, "ssl_bump");
4715 static void dump_sslproxy_ssl_bump(StoreEntry
*entry
, const char *name
, acl_access
*ssl_bump
)
4718 dump_SBufList(entry
, ssl_bump
->treeDump(name
, [](const allow_t
&action
) {
4719 return Ssl::BumpModeStr
.at(action
.kind
);
4723 static void free_sslproxy_ssl_bump(acl_access
**ssl_bump
)
4725 free_acl_access(ssl_bump
);
4730 static void dump_HeaderWithAclList(StoreEntry
* entry
, const char *name
, HeaderWithAclList
*headers
)
4735 for (HeaderWithAclList::iterator hwa
= headers
->begin(); hwa
!= headers
->end(); ++hwa
) {
4736 storeAppendPrintf(entry
, "%s %s %s", name
, hwa
->fieldName
.c_str(), hwa
->fieldValue
.c_str());
4738 dump_acl_list(entry
, hwa
->aclList
);
4739 storeAppendPrintf(entry
, "\n");
4743 static void parse_HeaderWithAclList(HeaderWithAclList
**headers
)
4747 *headers
= new HeaderWithAclList
;
4749 if ((fn
= ConfigParser::NextToken()) == NULL
) {
4755 hwa
.fieldId
= Http::HeaderLookupTable
.lookup(hwa
.fieldName
).id
;
4756 if (hwa
.fieldId
== Http::HdrType::BAD_HDR
)
4757 hwa
.fieldId
= Http::HdrType::OTHER
;
4759 Format::Format
*nlf
= new ::Format::Format("hdrWithAcl");
4760 ConfigParser::EnableMacros();
4761 String buf
= ConfigParser::NextQuotedToken();
4762 ConfigParser::DisableMacros();
4763 hwa
.fieldValue
= buf
.termedBuf();
4764 hwa
.quoted
= ConfigParser::LastTokenWasQuoted();
4766 if (!nlf
->parse(hwa
.fieldValue
.c_str())) {
4770 hwa
.valueFormat
= nlf
;
4773 aclParseAclList(LegacyParser
, &hwa
.aclList
, (hwa
.fieldName
+ ':' + hwa
.fieldValue
).c_str());
4774 (*headers
)->push_back(hwa
);
4777 static void free_HeaderWithAclList(HeaderWithAclList
**header
)
4782 for (HeaderWithAclList::iterator hwa
= (*header
)->begin(); hwa
!= (*header
)->end(); ++hwa
) {
4784 aclDestroyAclList(&hwa
->aclList
);
4786 if (hwa
->valueFormat
) {
4787 delete hwa
->valueFormat
;
4788 hwa
->valueFormat
= NULL
;
4795 static void parse_note(Notes
*notes
)
4798 notes
->parse(LegacyParser
);
4801 static void dump_note(StoreEntry
*entry
, const char *name
, Notes
¬es
)
4803 notes
.dump(entry
, name
);
4806 static void free_note(Notes
*notes
)
4811 static bool FtpEspvDeprecated
= false;
4812 static void parse_ftp_epsv(acl_access
**ftp_epsv
)
4814 allow_t ftpEpsvDeprecatedAction
;
4815 bool ftpEpsvIsDeprecatedRule
= false;
4817 char *t
= ConfigParser::PeekAtToken();
4823 if (!strcmp(t
, "off")) {
4824 (void)ConfigParser::NextToken();
4825 ftpEpsvIsDeprecatedRule
= true;
4826 ftpEpsvDeprecatedAction
= allow_t(ACCESS_DENIED
);
4827 } else if (!strcmp(t
, "on")) {
4828 (void)ConfigParser::NextToken();
4829 ftpEpsvIsDeprecatedRule
= true;
4830 ftpEpsvDeprecatedAction
= allow_t(ACCESS_ALLOWED
);
4833 // Check for mixing "ftp_epsv on|off" and "ftp_epsv allow|deny .." rules:
4834 // 1) if this line is "ftp_epsv allow|deny ..." and already exist rules of "ftp_epsv on|off"
4835 // 2) if this line is "ftp_epsv on|off" and already exist rules of "ftp_epsv allow|deny ..."
4837 if ((!ftpEpsvIsDeprecatedRule
&& FtpEspvDeprecated
) ||
4838 (ftpEpsvIsDeprecatedRule
&& !FtpEspvDeprecated
&& *ftp_epsv
!= NULL
)) {
4839 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.");
4844 if (ftpEpsvIsDeprecatedRule
) {
4845 // overwrite previous ftp_epsv lines
4847 *ftp_epsv
= nullptr;
4849 if (ftpEpsvDeprecatedAction
== allow_t(ACCESS_DENIED
)) {
4850 if (ACL
*a
= ACL::FindByName("all"))
4851 ParseAclWithAction(ftp_epsv
, ftpEpsvDeprecatedAction
, "ftp_epsv", a
);
4857 FtpEspvDeprecated
= true;
4859 aclParseAccessLine(cfg_directive
, LegacyParser
, ftp_epsv
);
4863 static void dump_ftp_epsv(StoreEntry
*entry
, const char *name
, acl_access
*ftp_epsv
)
4866 dump_SBufList(entry
, ftp_epsv
->treeDump(name
, Acl::AllowOrDeny
));
4869 static void free_ftp_epsv(acl_access
**ftp_epsv
)
4871 free_acl_access(ftp_epsv
);
4872 FtpEspvDeprecated
= false;
4876 parse_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*config
)
4879 parseTimeLine(&tval
, T_SECOND_STR
, false, true);
4880 Config
.Timeout
.urlRewrite
= static_cast<time_t>(tval
/1000);
4883 while(ConfigParser::NextKvPair(key
, value
)) {
4884 if (strcasecmp(key
, "on_timeout") == 0) {
4885 if (strcasecmp(value
, "bypass") == 0)
4886 config
->action
= toutActBypass
;
4887 else if (strcasecmp(value
, "fail") == 0)
4888 config
->action
= toutActFail
;
4889 else if (strcasecmp(value
, "retry") == 0)
4890 config
->action
= toutActRetry
;
4891 else if (strcasecmp(value
, "use_configured_response") == 0) {
4892 config
->action
= toutActUseConfiguredResponse
;
4894 debugs(3, DBG_CRITICAL
, "FATAL: unsuported \"on_timeout\" action:" << value
);
4898 } else if (strcasecmp(key
, "response") == 0) {
4899 config
->response
= xstrdup(value
);
4901 debugs(3, DBG_CRITICAL
, "FATAL: unsuported option " << key
);
4907 if (config
->action
== toutActUseConfiguredResponse
&& !config
->response
) {
4908 debugs(3, DBG_CRITICAL
, "FATAL: Expected 'response=' option after 'on_timeout=use_configured_response' option");
4912 if (config
->action
!= toutActUseConfiguredResponse
&& config
->response
) {
4913 debugs(3, DBG_CRITICAL
, "FATAL: 'response=' option is valid only when used with the 'on_timeout=use_configured_response' option");
4919 dump_UrlHelperTimeout(StoreEntry
*entry
, const char *name
, SquidConfig::UrlHelperTimeout
&config
)
4921 const char *onTimedOutActions
[] = {"bypass", "fail", "retry", "use_configured_response"};
4922 assert(config
.action
>= 0 && config
.action
<= toutActUseConfiguredResponse
);
4924 dump_time_t(entry
, name
, Config
.Timeout
.urlRewrite
);
4925 storeAppendPrintf(entry
, " on_timeout=%s", onTimedOutActions
[config
.action
]);
4927 if (config
.response
)
4928 storeAppendPrintf(entry
, " response=\"%s\"", config
.response
);
4930 storeAppendPrintf(entry
, "\n");
4934 free_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*config
)
4936 Config
.Timeout
.urlRewrite
= 0;
4938 safe_free(config
->response
);
4942 parse_configuration_includes_quoted_values(bool *)
4947 // If quoted values is set to on then enable new strict mode parsing
4949 ConfigParser::RecognizeQuotedValues
= true;
4950 ConfigParser::StrictMode
= true;
4952 ConfigParser::RecognizeQuotedValues
= false;
4953 ConfigParser::StrictMode
= false;
4958 dump_configuration_includes_quoted_values(StoreEntry
*const entry
, const char *const name
, bool)
4960 int val
= ConfigParser::RecognizeQuotedValues
? 1 : 0;
4961 dump_onoff(entry
, name
, val
);
4965 free_configuration_includes_quoted_values(bool *)
4967 ConfigParser::RecognizeQuotedValues
= false;
4968 ConfigParser::StrictMode
= false;
4972 parse_on_unsupported_protocol(acl_access
**access
)
4975 if ((tm
= ConfigParser::NextToken()) == NULL
) {
4980 allow_t action
= allow_t(ACCESS_ALLOWED
);
4981 if (strcmp(tm
, "tunnel") == 0)
4983 else if (strcmp(tm
, "respond") == 0)
4986 debugs(3, DBG_CRITICAL
, "FATAL: unknown on_unsupported_protocol mode: " << tm
);
4992 ParseAclWithAction(access
, action
, "on_unsupported_protocol");
4996 dump_on_unsupported_protocol(StoreEntry
*entry
, const char *name
, acl_access
*access
)
4998 static const std::vector
<const char *> onErrorTunnelMode
= {
5004 SBufList lines
= access
->treeDump(name
, [](const allow_t
&action
) {
5005 return onErrorTunnelMode
.at(action
.kind
);
5007 dump_SBufList(entry
, lines
);
5012 free_on_unsupported_protocol(acl_access
**access
)
5014 free_acl_access(access
);