2 * Copyright (C) 1996-2015 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/AclAddress.h"
14 #include "acl/AclDenyInfoList.h"
15 #include "acl/AclNameList.h"
16 #include "acl/AclSizeLimit.h"
17 #include "acl/Gadgets.h"
18 #include "acl/MethodData.h"
20 #include "anyp/PortCfg.h"
21 #include "anyp/UriScheme.h"
23 #include "base/RunnersRegistry.h"
25 #include "CachePeer.h"
26 #include "CachePeerDomainList.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 "ident/Config.h"
37 #include "ip/Intercept.h"
38 #include "ip/QosConfig.h"
41 #include "log/Config.h"
42 #include "log/CustomLog.h"
44 #include "mgr/ActionPasswordList.h"
45 #include "mgr/Registration.h"
46 #include "neighbors.h"
47 #include "NeighborTypeDomainList.h"
50 #include "PeerDigest.h"
51 #include "PeerPoolMgr.h"
53 #include "RefreshPattern.h"
56 #include "SquidConfig.h"
57 #include "SquidString.h"
58 #include "ssl/ProxyCerts.h"
60 #include "StoreFileSystem.h"
65 /* wccp2 has its own conditional definitions */
68 #include "adaptation/Config.h"
71 #include "adaptation/icap/Config.h"
74 #include "adaptation/ecap/Config.h"
77 #include "ssl/Config.h"
78 #include "ssl/support.h"
81 #include "auth/Config.h"
82 #include "auth/Scheme.h"
85 #include "esi/Parser.h"
103 #include <sys/stat.h>
107 #include "ssl/gadgets.h"
111 static void parse_adaptation_service_set_type();
112 static void parse_adaptation_service_chain_type();
113 static void parse_adaptation_access_type();
117 static void parse_icap_service_type(Adaptation::Icap::Config
*);
118 static void dump_icap_service_type(StoreEntry
*, const char *, const Adaptation::Icap::Config
&);
119 static void free_icap_service_type(Adaptation::Icap::Config
*);
120 static void parse_icap_class_type();
121 static void parse_icap_access_type();
123 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*);
124 static void dump_icap_service_failure_limit(StoreEntry
*, const char *, const Adaptation::Icap::Config
&);
125 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*);
129 static void parse_ecap_service_type(Adaptation::Ecap::Config
*);
130 static void dump_ecap_service_type(StoreEntry
*, const char *, const Adaptation::Ecap::Config
&);
131 static void free_ecap_service_type(Adaptation::Ecap::Config
*);
134 static peer_t
parseNeighborType(const char *s
);
136 CBDATA_TYPE(CachePeer
);
138 static const char *const T_MILLISECOND_STR
= "millisecond";
139 static const char *const T_SECOND_STR
= "second";
140 static const char *const T_MINUTE_STR
= "minute";
141 static const char *const T_HOUR_STR
= "hour";
142 static const char *const T_DAY_STR
= "day";
143 static const char *const T_WEEK_STR
= "week";
144 static const char *const T_FORTNIGHT_STR
= "fortnight";
145 static const char *const T_MONTH_STR
= "month";
146 static const char *const T_YEAR_STR
= "year";
147 static const char *const T_DECADE_STR
= "decade";
149 static const char *const B_BYTES_STR
= "bytes";
150 static const char *const B_KBYTES_STR
= "KB";
151 static const char *const B_MBYTES_STR
= "MB";
152 static const char *const B_GBYTES_STR
= "GB";
154 static const char *const list_sep
= ", \t\n\r";
156 static void parse_access_log(CustomLog
** customlog_definitions
);
157 static int check_null_access_log(CustomLog
*customlog_definitions
);
158 static void dump_access_log(StoreEntry
* entry
, const char *name
, CustomLog
* definitions
);
159 static void free_access_log(CustomLog
** definitions
);
160 static bool setLogformat(CustomLog
*cl
, const char *name
, const bool dieWhenMissing
);
162 static void configDoConfigure(void);
163 static void parse_refreshpattern(RefreshPattern
**);
164 static uint64_t parseTimeUnits(const char *unit
, bool allowMsec
);
165 static void parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
, bool expectMoreArguments
);
166 static void parse_u_short(unsigned short * var
);
167 static void parse_string(char **);
168 static void default_all(void);
169 static void defaults_if_none(void);
170 static void defaults_postscriptum(void);
171 static int parse_line(char *);
172 static void parse_obsolete(const char *);
173 static void parseBytesLine(size_t * bptr
, const char *units
);
175 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
);
177 static void parseBytesLineSigned(ssize_t
* bptr
, const char *units
);
178 static size_t parseBytesUnits(const char *unit
);
179 static void free_all(void);
180 void requirePathnameExists(const char *name
, const char *path
);
181 static OBJH dump_config
;
182 #if USE_HTTP_VIOLATIONS
183 static void free_HeaderManglers(HeaderManglers
**pm
);
184 static void dump_http_header_access(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
);
185 static void parse_http_header_access(HeaderManglers
**manglers
);
186 #define free_http_header_access free_HeaderManglers
187 static void dump_http_header_replace(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
);
188 static void parse_http_header_replace(HeaderManglers
**manglers
);
189 #define free_http_header_replace free_HeaderManglers
191 static void dump_HeaderWithAclList(StoreEntry
* entry
, const char *name
, HeaderWithAclList
*headers
);
192 static void parse_HeaderWithAclList(HeaderWithAclList
**header
);
193 static void free_HeaderWithAclList(HeaderWithAclList
**header
);
194 static void parse_note(Notes
*);
195 static void dump_note(StoreEntry
*, const char *, Notes
&);
196 static void free_note(Notes
*);
197 static void parse_denyinfo(AclDenyInfoList
** var
);
198 static void dump_denyinfo(StoreEntry
* entry
, const char *name
, AclDenyInfoList
* var
);
199 static void free_denyinfo(AclDenyInfoList
** var
);
202 static void parse_IpAddress_list(Ip::Address_list
**);
203 static void dump_IpAddress_list(StoreEntry
*, const char *, const Ip::Address_list
*);
204 static void free_IpAddress_list(Ip::Address_list
**);
206 static int check_null_IpAddress_list(const Ip::Address_list
*);
207 #endif /* CURRENTLY_UNUSED */
208 #endif /* USE_WCCPv2 */
210 static void parsePortCfg(AnyP::PortCfgPointer
*, const char *protocol
);
211 #define parse_PortCfg(l) parsePortCfg((l), token)
212 static void dump_PortCfg(StoreEntry
*, const char *, const AnyP::PortCfgPointer
&);
213 #define free_PortCfg(h) *(h)=NULL
216 static void parse_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
);
217 static void dump_sslproxy_cert_sign(StoreEntry
*entry
, const char *name
, sslproxy_cert_sign
*cert_sign
);
218 static void free_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
);
219 static void parse_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
);
220 static void dump_sslproxy_cert_adapt(StoreEntry
*entry
, const char *name
, sslproxy_cert_adapt
*cert_adapt
);
221 static void free_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
);
222 static void parse_sslproxy_ssl_bump(acl_access
**ssl_bump
);
223 static void dump_sslproxy_ssl_bump(StoreEntry
*entry
, const char *name
, acl_access
*ssl_bump
);
224 static void free_sslproxy_ssl_bump(acl_access
**ssl_bump
);
225 #endif /* USE_OPENSSL */
227 static void parse_ftp_epsv(acl_access
**ftp_epsv
);
228 static void dump_ftp_epsv(StoreEntry
*entry
, const char *name
, acl_access
*ftp_epsv
);
229 static void free_ftp_epsv(acl_access
**ftp_epsv
);
231 static void parse_b_size_t(size_t * var
);
232 static void parse_b_int64_t(int64_t * var
);
234 static bool parseNamedIntList(const char *data
, const String
&name
, std::vector
<int> &list
);
236 static void parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
);
237 static void dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
);
238 static void free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
);
240 static void parse_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*);
241 static void dump_UrlHelperTimeout(StoreEntry
*, const char *, SquidConfig::UrlHelperTimeout
&);
242 static void free_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*);
244 static int parseOneConfigFile(const char *file_name
, unsigned int depth
);
246 static void parse_configuration_includes_quoted_values(bool *recognizeQuotedValues
);
247 static void dump_configuration_includes_quoted_values(StoreEntry
*const entry
, const char *const name
, bool recognizeQuotedValues
);
248 static void free_configuration_includes_quoted_values(bool *recognizeQuotedValues
);
251 * LegacyParser is a parser for legacy code that uses the global
252 * approach. This is static so that it is only exposed to cache_cf.
253 * Other modules needing access to a ConfigParser should have it
254 * provided to them in their parserFOO methods.
256 static ConfigParser LegacyParser
= ConfigParser();
261 LegacyParser
.destruct();
265 SetConfigFilename(char const *file_name
, bool is_pipe
)
268 cfg_filename
= file_name
+ 1;
270 cfg_filename
= file_name
;
274 skip_ws(const char* s
)
283 parseManyConfigFiles(char* files
, int depth
)
286 char* saveptr
= NULL
;
291 memset(&globbuf
, 0, sizeof(globbuf
));
292 for (path
= strwordtok(files
, &saveptr
); path
; path
= strwordtok(NULL
, &saveptr
)) {
293 if (glob(path
, globbuf
.gl_pathc
? GLOB_APPEND
: 0, NULL
, &globbuf
) != 0) {
294 fatalf("Unable to find configuration file: %s: %s",
298 for (i
= 0; i
< (int)globbuf
.gl_pathc
; ++i
) {
299 error_count
+= parseOneConfigFile(globbuf
.gl_pathv
[i
], depth
);
303 char* file
= strwordtok(files
, &saveptr
);
304 while (file
!= NULL
) {
305 error_count
+= parseOneConfigFile(file
, depth
);
306 file
= strwordtok(NULL
, &saveptr
);
308 #endif /* HAVE_GLOB */
313 ReplaceSubstr(char*& str
, int& len
, unsigned substrIdx
, unsigned substrLen
, const char* newSubstr
)
316 assert(newSubstr
!= NULL
);
318 unsigned newSubstrLen
= strlen(newSubstr
);
319 if (newSubstrLen
> substrLen
)
320 str
= (char*)realloc(str
, len
- substrLen
+ newSubstrLen
+ 1);
322 // move tail part including zero
323 memmove(str
+ substrIdx
+ newSubstrLen
, str
+ substrIdx
+ substrLen
, len
- substrIdx
- substrLen
+ 1);
324 // copy new substring in place
325 memcpy(str
+ substrIdx
, newSubstr
, newSubstrLen
);
331 SubstituteMacro(char*& line
, int& len
, const char* macroName
, const char* substStr
)
333 assert(line
!= NULL
);
334 assert(macroName
!= NULL
);
335 assert(substStr
!= NULL
);
336 unsigned macroNameLen
= strlen(macroName
);
337 while (const char* macroPos
= strstr(line
, macroName
)) // we would replace all occurrences
338 ReplaceSubstr(line
, len
, macroPos
- line
, macroNameLen
, substStr
);
342 ProcessMacros(char*& line
, int& len
)
344 SubstituteMacro(line
, len
, "${service_name}", service_name
.c_str());
345 SubstituteMacro(line
, len
, "${process_name}", TheKidName
);
346 SubstituteMacro(line
, len
, "${process_number}", xitoa(KidIdentifier
));
350 trim_trailing_ws(char* str
)
353 unsigned i
= strlen(str
);
354 while ((i
> 0) && xisspace(str
[i
- 1]))
360 FindStatement(const char* line
, const char* statement
)
362 assert(line
!= NULL
);
363 assert(statement
!= NULL
);
365 const char* str
= skip_ws(line
);
366 unsigned len
= strlen(statement
);
367 if (strncmp(str
, statement
, len
) == 0) {
371 else if (xisspace(*str
))
379 StrToInt(const char* str
, long& number
)
384 number
= strtol(str
, &end
, 0);
386 return (end
!= str
) && (*end
== '\0'); // returns true if string contains nothing except number
390 EvalBoolExpr(const char* expr
)
392 assert(expr
!= NULL
);
393 if (strcmp(expr
, "true") == 0) {
395 } else if (strcmp(expr
, "false") == 0) {
397 } else if (const char* equation
= strchr(expr
, '=')) {
398 const char* rvalue
= skip_ws(equation
+ 1);
399 char* lvalue
= (char*)xmalloc(equation
- expr
+ 1);
400 xstrncpy(lvalue
, expr
, equation
- expr
+ 1);
401 trim_trailing_ws(lvalue
);
404 if (!StrToInt(lvalue
, number1
))
405 fatalf("String is not a integer number: '%s'\n", lvalue
);
407 if (!StrToInt(rvalue
, number2
))
408 fatalf("String is not a integer number: '%s'\n", rvalue
);
411 return number1
== number2
;
413 fatalf("Unable to evaluate expression '%s'\n", expr
);
414 return false; // this place cannot be reached
418 parseOneConfigFile(const char *file_name
, unsigned int depth
)
421 const char *orig_cfg_filename
= cfg_filename
;
422 const int orig_config_lineno
= config_lineno
;
424 char *tmp_line
= NULL
;
425 int tmp_line_len
= 0;
429 debugs(3, DBG_IMPORTANT
, "Processing Configuration File: " << file_name
<< " (depth " << depth
<< ")");
431 fatalf("WARNING: can't include %s: includes are nested too deeply (>16)!\n", file_name
);
435 if (file_name
[0] == '!' || file_name
[0] == '|') {
436 fp
= popen(file_name
+ 1, "r");
439 fp
= fopen(file_name
, "r");
443 fatalf("Unable to open configuration file: %s: %s", file_name
, xstrerror());
446 setmode(fileno(fp
), O_TEXT
);
449 SetConfigFilename(file_name
, bool(is_pipe
));
451 memset(config_input_line
, '\0', BUFSIZ
);
455 std::vector
<bool> if_states
;
456 while (fgets(config_input_line
, BUFSIZ
, fp
)) {
459 if ((token
= strchr(config_input_line
, '\n')))
462 if ((token
= strchr(config_input_line
, '\r')))
465 // strip any prefix whitespace off the line.
466 const char *p
= skip_ws(config_input_line
);
467 if (config_input_line
!= p
)
468 memmove(config_input_line
, p
, strlen(p
)+1);
470 if (strncmp(config_input_line
, "#line ", 6) == 0) {
471 static char new_file_name
[1024];
473 static char new_lineno
;
474 token
= config_input_line
+ 6;
475 new_lineno
= strtol(token
, &file
, 0) - 1;
478 continue; /* Not a valid #line directive, may be a comment */
480 while (*file
&& xisspace((unsigned char) *file
))
485 continue; /* Not a valid #line directive, may be a comment */
487 xstrncpy(new_file_name
, file
+ 1, sizeof(new_file_name
));
489 if ((token
= strchr(new_file_name
, '"')))
492 SetConfigFilename(new_file_name
, false);
495 config_lineno
= new_lineno
;
498 if (config_input_line
[0] == '#')
501 if (config_input_line
[0] == '\0')
504 const char* append
= tmp_line_len
? skip_ws(config_input_line
) : config_input_line
;
506 size_t append_len
= strlen(append
);
508 tmp_line
= (char*)xrealloc(tmp_line
, tmp_line_len
+ append_len
+ 1);
510 strcpy(tmp_line
+ tmp_line_len
, append
);
512 tmp_line_len
+= append_len
;
514 if (tmp_line
[tmp_line_len
-1] == '\\') {
515 debugs(3, 5, "parseConfigFile: tmp_line='" << tmp_line
<< "'");
516 tmp_line
[--tmp_line_len
] = '\0';
520 trim_trailing_ws(tmp_line
);
521 ProcessMacros(tmp_line
, tmp_line_len
);
522 debugs(3, (opt_parse_cfg_only
?1:5), "Processing: " << tmp_line
);
524 if (const char* expr
= FindStatement(tmp_line
, "if")) {
525 if_states
.push_back(EvalBoolExpr(expr
)); // store last if-statement meaning
526 } else if (FindStatement(tmp_line
, "endif")) {
527 if (!if_states
.empty())
528 if_states
.pop_back(); // remove last if-statement meaning
530 fatalf("'endif' without 'if'\n");
531 } else if (FindStatement(tmp_line
, "else")) {
532 if (!if_states
.empty())
533 if_states
.back() = !if_states
.back();
535 fatalf("'else' without 'if'\n");
536 } else if (if_states
.empty() || if_states
.back()) { // test last if-statement meaning if present
537 /* Handle includes here */
538 if (tmp_line_len
>= 9 && strncmp(tmp_line
, "include", 7) == 0 && xisspace(tmp_line
[7])) {
539 err_count
+= parseManyConfigFiles(tmp_line
+ 8, depth
+ 1);
540 } else if (!parse_line(tmp_line
)) {
541 debugs(3, DBG_CRITICAL
, HERE
<< cfg_filename
<< ":" << config_lineno
<< " unrecognized: '" << tmp_line
<< "'");
550 if (!if_states
.empty())
551 fatalf("if-statement without 'endif'\n");
554 int ret
= pclose(fp
);
557 fatalf("parseConfigFile: '%s' failed with exit code %d\n", file_name
, ret
);
562 SetConfigFilename(orig_cfg_filename
, false);
563 config_lineno
= orig_config_lineno
;
570 parseConfigFile(const char *file_name
)
578 ACLMethodData::ThePurgeCount
= 0;
581 err_count
= parseOneConfigFile(file_name
, 0);
585 defaults_postscriptum();
588 * We must call configDoConfigure() before leave_suid() because
589 * configDoConfigure() is where we turn username strings into
594 if (!Config
.chroot_dir
) {
596 setUmask(Config
.umask
);
597 _db_init(Debug::cache_log
, Debug::debugOptions
);
601 if (opt_send_signal
== -1) {
602 Mgr::RegisterAction("config",
603 "Current Squid Configuration",
612 configDoConfigure(void)
614 memset(&Config2
, '\0', sizeof(SquidConfig2
));
615 /* init memory as early as possible */
619 Config
.cacheSwap
.n_strands
= 0; // no diskers by default
620 if (Config
.cacheSwap
.swapDirs
== NULL
) {
621 /* Memory-only cache probably in effect. */
622 /* turn off the cache rebuild delays... */
623 StoreController::store_dirs_rebuilding
= 0;
624 } else if (InDaemonMode()) { // no diskers in non-daemon mode
625 for (int i
= 0; i
< Config
.cacheSwap
.n_configured
; ++i
) {
626 const RefCount
<SwapDir
> sd
= Config
.cacheSwap
.swapDirs
[i
];
627 if (sd
->needsDiskStrand())
628 sd
->disker
= Config
.workers
+ (++Config
.cacheSwap
.n_strands
);
632 if (Debug::rotateNumber
< 0) {
633 Debug::rotateNumber
= Config
.Log
.rotateNumber
;
636 #if SIZEOF_OFF_T <= 4
637 if (Config
.Store
.maxObjectSize
> 0x7FFF0000) {
638 debugs(3, DBG_CRITICAL
, "WARNING: This Squid binary can not handle files larger than 2GB. Limiting maximum_object_size to just below 2GB");
639 Config
.Store
.maxObjectSize
= 0x7FFF0000;
643 if (Config
.Announce
.period
> 0) {
644 Config
.onoff
.announce
= 1;
646 Config
.Announce
.period
= 86400 * 365; /* one year */
647 Config
.onoff
.announce
= 0;
650 if (Config
.onoff
.httpd_suppress_version_string
)
651 visible_appname_string
= (char *)appname_string
;
653 visible_appname_string
= (char const *)APP_FULLNAME
;
655 if (Config
.Program
.redirect
) {
656 if (Config
.redirectChildren
.n_max
< 1) {
657 Config
.redirectChildren
.n_max
= 0;
658 wordlistDestroy(&Config
.Program
.redirect
);
662 if (Config
.Program
.store_id
) {
663 if (Config
.storeIdChildren
.n_max
< 1) {
664 Config
.storeIdChildren
.n_max
= 0;
665 wordlistDestroy(&Config
.Program
.store_id
);
669 if (Config
.appendDomain
)
670 if (*Config
.appendDomain
!= '.')
671 fatal("append_domain must begin with a '.'");
673 if (Config
.errHtmlText
== NULL
)
674 Config
.errHtmlText
= xstrdup(null_string
);
676 #if !HAVE_SETRLIMIT || !defined(RLIMIT_NOFILE)
677 if (Config
.max_filedescriptors
> 0) {
678 debugs(0, DBG_IMPORTANT
, "WARNING: max_filedescriptors disabled. Operating System setrlimit(RLIMIT_NOFILE) is missing.");
680 #elif USE_SELECT || USE_SELECT_WIN32
681 if (Config
.max_filedescriptors
> FD_SETSIZE
) {
682 debugs(0, DBG_IMPORTANT
, "WARNING: max_filedescriptors limited to " << FD_SETSIZE
<< " by select() algorithm.");
688 snprintf(ThisCache
, sizeof(ThisCache
), "%s (%s)",
690 visible_appname_string
);
693 * the extra space is for loop detection in client_side.c -- we search
694 * for substrings in the Via header.
696 snprintf(ThisCache2
, sizeof(ThisCache
), " %s (%s)",
698 visible_appname_string
);
700 /* Use visible_hostname as default surrogate_id */
701 if (!Config
.Accel
.surrogate_id
) {
702 const char *t
= getMyHostname();
703 Config
.Accel
.surrogate_id
= xstrdup( (t
?t
:"unset-id") );
706 if (!Config
.udpMaxHitObjsz
|| Config
.udpMaxHitObjsz
> SQUID_UDP_SO_SNDBUF
)
707 Config
.udpMaxHitObjsz
= SQUID_UDP_SO_SNDBUF
;
709 if (Config
.appendDomain
)
710 Config
.appendDomainLen
= strlen(Config
.appendDomain
);
712 Config
.appendDomainLen
= 0;
714 if (Config
.connect_retries
> 10) {
715 debugs(0,DBG_CRITICAL
, "WARNING: connect_retries cannot be larger than 10. Resetting to 10.");
716 Config
.connect_retries
= 10;
719 requirePathnameExists("MIME Config Table", Config
.mimeTablePathname
);
722 requirePathnameExists("unlinkd_program", Config
.Program
.unlinkd
);
724 requirePathnameExists("logfile_daemon", Log::TheConfig
.logfile_daemon
);
725 if (Config
.Program
.redirect
)
726 requirePathnameExists("redirect_program", Config
.Program
.redirect
->key
);
728 if (Config
.Program
.store_id
)
729 requirePathnameExists("store_id_program", Config
.Program
.store_id
->key
);
731 requirePathnameExists("Icon Directory", Config
.icons
.directory
);
733 if (Config
.errorDirectory
)
734 requirePathnameExists("Error Directory", Config
.errorDirectory
);
736 #if USE_HTTP_VIOLATIONS
739 const RefreshPattern
*R
;
741 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
742 if (!R
->flags
.override_expire
)
745 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'override-expire' in 'refresh_pattern' violates HTTP");
750 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
751 if (!R
->flags
.override_lastmod
)
754 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'override-lastmod' in 'refresh_pattern' violates HTTP");
759 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
760 if (!R
->flags
.reload_into_ims
)
763 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'reload-into-ims' in 'refresh_pattern' violates HTTP");
768 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
769 if (!R
->flags
.ignore_reload
)
772 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-reload' in 'refresh_pattern' violates HTTP");
777 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
778 if (!R
->flags
.ignore_no_store
)
781 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-no-store' in 'refresh_pattern' violates HTTP");
786 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
787 if (!R
->flags
.ignore_must_revalidate
)
789 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-must-revalidate' in 'refresh_pattern' violates HTTP");
793 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
794 if (!R
->flags
.ignore_private
)
797 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-private' in 'refresh_pattern' violates HTTP");
802 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
803 if (!R
->flags
.ignore_auth
)
806 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-auth' in 'refresh_pattern' violates HTTP");
813 #if !USE_HTTP_VIOLATIONS
814 Config
.onoff
.via
= 1;
817 if (!Config
.onoff
.via
)
818 debugs(22, DBG_IMPORTANT
, "WARNING: HTTP requires the use of Via");
822 // we enable runtime PURGE checks if there is at least one PURGE method ACL
823 // TODO: replace with a dedicated "purge" ACL option?
824 Config2
.onoff
.enable_purge
= (ACLMethodData::ThePurgeCount
> 0);
826 Config2
.onoff
.mangle_request_headers
= (Config
.request_header_access
!= NULL
);
828 if (geteuid() == 0) {
829 if (NULL
!= Config
.effectiveUser
) {
831 struct passwd
*pwd
= getpwnam(Config
.effectiveUser
);
835 * Andres Kroonmaa <andre@online.ee>:
836 * Some getpwnam() implementations (Solaris?) require
837 * an available FD < 256 for opening a FILE* to the
840 * This should be safe at startup, but might still fail
841 * during reconfigure.
843 fatalf("getpwnam failed to find userid for effective user '%s'",
844 Config
.effectiveUser
);
848 Config2
.effectiveUserID
= pwd
->pw_uid
;
850 Config2
.effectiveGroupID
= pwd
->pw_gid
;
853 if (pwd
->pw_dir
&& *pwd
->pw_dir
) {
854 // putenv() leaks by design; avoid leaks when nothing changes
856 if (lastDir
.isEmpty() || !lastDir
.cmp(pwd
->pw_dir
)) {
857 lastDir
= pwd
->pw_dir
;
858 int len
= strlen(pwd
->pw_dir
) + 6;
859 char *env_str
= (char *)xcalloc(len
, 1);
860 snprintf(env_str
, len
, "HOME=%s", pwd
->pw_dir
);
867 Config2
.effectiveUserID
= geteuid();
868 Config2
.effectiveGroupID
= getegid();
871 if (NULL
!= Config
.effectiveGroup
) {
873 struct group
*grp
= getgrnam(Config
.effectiveGroup
);
876 fatalf("getgrnam failed to find groupid for effective group '%s'",
877 Config
.effectiveGroup
);
881 Config2
.effectiveGroupID
= grp
->gr_gid
;
886 debugs(3, DBG_IMPORTANT
, "Initializing https proxy context");
888 Config
.ssl_client
.sslContext
= sslCreateClientContext(Config
.ssl_client
.cert
, Config
.ssl_client
.key
, Config
.ssl_client
.version
, Config
.ssl_client
.cipher
, Config
.ssl_client
.options
, Config
.ssl_client
.flags
, Config
.ssl_client
.cafile
, Config
.ssl_client
.capath
, Config
.ssl_client
.crlfile
);
890 for (CachePeer
*p
= Config
.peers
; p
!= NULL
; p
= p
->next
) {
892 debugs(3, DBG_IMPORTANT
, "Initializing cache_peer " << p
->name
<< " SSL context");
893 p
->sslContext
= sslCreateClientContext(p
->sslcert
, p
->sslkey
, p
->sslversion
, p
->sslcipher
, p
->ssloptions
, p
->sslflags
, p
->sslcafile
, p
->sslcapath
, p
->sslcrlfile
);
897 for (AnyP::PortCfgPointer s
= HttpPortList
; s
!= NULL
; s
= s
->next
) {
898 if (!s
->flags
.tunnelSslBumping
)
901 debugs(3, DBG_IMPORTANT
, "Initializing http_port " << s
->s
<< " SSL context");
902 s
->configureSslServerContext();
905 for (AnyP::PortCfgPointer s
= HttpsPortList
; s
!= NULL
; s
= s
->next
) {
906 debugs(3, DBG_IMPORTANT
, "Initializing https_port " << s
->s
<< " SSL context");
907 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::Config
*nego
= Auth::Config::Find("Negotiate");
940 Auth::Config
*ntlm
= Auth::Config::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;
949 /** Parse a line containing an obsolete directive.
950 * To upgrade it where possible instead of just "Bungled config" for
951 * directives which cannot be marked as simply aliases of the some name.
952 * For example if the parameter order and content has changed.
953 * Or if the directive has been completely removed.
956 parse_obsolete(const char *name
)
958 // Directives which have been radically changed rather than removed
959 if (!strcmp(name
, "url_rewrite_concurrency")) {
962 debugs(3, DBG_CRITICAL
, "WARNING: url_rewrite_concurrency upgrade overriding url_rewrite_children settings.");
963 Config
.redirectChildren
.concurrency
= cval
;
966 if (!strcmp(name
, "log_access"))
969 if (!strcmp(name
, "log_icap"))
972 if (!strcmp(name
, "ignore_ims_on_miss")) {
973 // the replacement directive cache_revalidate_on_miss has opposite meanings for ON/OFF value
974 // than the 2.7 directive. We need to parse and invert the configured value.
977 Config
.onoff
.cache_miss_revalidate
= !temp
;
981 /* Parse a time specification from the config file. Store the
982 * result in 'tptr', after converting it to 'units' */
984 parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
, bool expectMoreArguments
= false)
991 if ((u
= parseTimeUnits(units
, allowMsec
)) == 0)
994 if ((token
= ConfigParser::NextToken()) == NULL
)
999 m
= u
; /* default to 'units' if none specified */
1001 bool hasUnits
= false;
1004 else if ((token
= ConfigParser::PeekAtToken()) == NULL
)
1006 else if ((m
= parseTimeUnits(token
, allowMsec
)) == 0) {
1007 if (!expectMoreArguments
)
1009 } else { //pop the token
1010 (void)ConfigParser::NextToken();
1014 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1015 config_input_line
<< "', assuming " <<
1016 d
<< " " << units
);
1018 *tptr
= static_cast<time_msec_t
>(m
* d
);
1020 if (static_cast<double>(*tptr
) * 2 != m
* d
* 2) {
1021 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1022 d
<< " " << token
<< ": integer overflow (time_msec_t).");
1028 parseTimeUnits(const char *unit
, bool allowMsec
)
1030 if (allowMsec
&& !strncasecmp(unit
, T_MILLISECOND_STR
, strlen(T_MILLISECOND_STR
)))
1033 if (!strncasecmp(unit
, T_SECOND_STR
, strlen(T_SECOND_STR
)))
1036 if (!strncasecmp(unit
, T_MINUTE_STR
, strlen(T_MINUTE_STR
)))
1039 if (!strncasecmp(unit
, T_HOUR_STR
, strlen(T_HOUR_STR
)))
1042 if (!strncasecmp(unit
, T_DAY_STR
, strlen(T_DAY_STR
)))
1043 return 86400 * 1000;
1045 if (!strncasecmp(unit
, T_WEEK_STR
, strlen(T_WEEK_STR
)))
1046 return 86400 * 7 * 1000;
1048 if (!strncasecmp(unit
, T_FORTNIGHT_STR
, strlen(T_FORTNIGHT_STR
)))
1049 return 86400 * 14 * 1000;
1051 if (!strncasecmp(unit
, T_MONTH_STR
, strlen(T_MONTH_STR
)))
1052 return static_cast<uint64_t>(86400) * 30 * 1000;
1054 if (!strncasecmp(unit
, T_YEAR_STR
, strlen(T_YEAR_STR
)))
1055 return static_cast<uint64_t>(86400 * 1000 * 365.2522);
1057 if (!strncasecmp(unit
, T_DECADE_STR
, strlen(T_DECADE_STR
)))
1058 return static_cast<uint64_t>(86400 * 1000 * 365.2522 * 10);
1060 debugs(3, DBG_IMPORTANT
, "parseTimeUnits: unknown time unit '" << unit
<< "'");
1066 parseBytesLine64(int64_t * bptr
, const char *units
)
1073 if ((u
= parseBytesUnits(units
)) == 0) {
1078 if ((token
= ConfigParser::NextToken()) == NULL
) {
1083 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1090 m
= u
; /* default to 'units' if none specified */
1094 else if ((token
= ConfigParser::NextToken()) == NULL
)
1095 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1096 config_input_line
<< "', assuming " <<
1097 d
<< " " << units
);
1098 else if ((m
= parseBytesUnits(token
)) == 0) {
1103 *bptr
= static_cast<int64_t>(m
* d
/ u
);
1105 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1106 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1107 d
<< " " << token
<< ": integer overflow (int64_t).");
1113 parseBytesLine(size_t * bptr
, const char *units
)
1120 if ((u
= parseBytesUnits(units
)) == 0) {
1125 if ((token
= ConfigParser::NextToken()) == NULL
) {
1130 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1131 *bptr
= static_cast<size_t>(-1);
1137 m
= u
; /* default to 'units' if none specified */
1141 else if ((token
= ConfigParser::NextToken()) == NULL
)
1142 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1143 config_input_line
<< "', assuming " <<
1144 d
<< " " << units
);
1145 else if ((m
= parseBytesUnits(token
)) == 0) {
1150 *bptr
= static_cast<size_t>(m
* d
/ u
);
1152 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1153 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1154 d
<< " " << token
<< ": integer overflow (size_t).");
1160 parseBytesLineSigned(ssize_t
* bptr
, const char *units
)
1167 if ((u
= parseBytesUnits(units
)) == 0) {
1172 if ((token
= ConfigParser::NextToken()) == NULL
) {
1177 if (strcmp(token
, "none") == 0 || token
[0] == '-' /* -N */) {
1184 m
= u
; /* default to 'units' if none specified */
1188 else if ((token
= ConfigParser::NextToken()) == NULL
)
1189 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1190 config_input_line
<< "', assuming " <<
1191 d
<< " " << units
);
1192 else if ((m
= parseBytesUnits(token
)) == 0) {
1197 *bptr
= static_cast<ssize_t
>(m
* d
/ u
);
1199 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1200 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1201 d
<< " " << token
<< ": integer overflow (ssize_t).");
1207 * Parse bytes from a string.
1208 * Similar to the parseBytesLine function but parses the string value instead of
1209 * the current token value.
1211 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
)
1214 if ((u
= parseBytesUnits(units
)) == 0) {
1219 // Find number from string beginning.
1220 char const * number_begin
= value
;
1221 char const * number_end
= value
;
1223 while ((*number_end
>= '0' && *number_end
<= '9')) {
1228 number
.limitInit(number_begin
, number_end
- number_begin
);
1230 int d
= xatoi(number
.termedBuf());
1232 if ((m
= parseBytesUnits(number_end
)) == 0) {
1237 *bptr
= static_cast<size_t>(m
* d
/ u
);
1238 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2)
1243 parseBytesUnits(const char *unit
)
1245 if (!strncasecmp(unit
, B_BYTES_STR
, strlen(B_BYTES_STR
)))
1248 if (!strncasecmp(unit
, B_KBYTES_STR
, strlen(B_KBYTES_STR
)))
1251 if (!strncasecmp(unit
, B_MBYTES_STR
, strlen(B_MBYTES_STR
)))
1254 if (!strncasecmp(unit
, B_GBYTES_STR
, strlen(B_GBYTES_STR
)))
1257 debugs(3, DBG_CRITICAL
, "WARNING: Unknown bytes unit '" << unit
<< "'");
1263 dump_SBufList(StoreEntry
* entry
, const SBufList
&words
)
1265 for (SBufList::const_iterator i
= words
.begin(); i
!= words
.end(); ++i
) {
1266 entry
->append(i
->rawContent(), i
->length());
1267 entry
->append(" ",1);
1269 entry
->append("\n",1);
1273 dump_acl(StoreEntry
* entry
, const char *name
, ACL
* ae
)
1275 while (ae
!= NULL
) {
1276 debugs(3, 3, "dump_acl: " << name
<< " " << ae
->name
);
1277 storeAppendPrintf(entry
, "%s %s %s %s ",
1281 ae
->flags
.flagsStr());
1282 dump_SBufList(entry
, ae
->dump());
1288 parse_acl(ACL
** ae
)
1290 ACL::ParseAclLine(LegacyParser
, ae
);
1300 dump_acl_list(StoreEntry
* entry
, ACLList
* head
)
1302 dump_SBufList(entry
, head
->dump());
1306 dump_acl_access(StoreEntry
* entry
, const char *name
, acl_access
* head
)
1309 dump_SBufList(entry
, head
->treeDump(name
,NULL
));
1313 parse_acl_access(acl_access
** head
)
1315 aclParseAccessLine(cfg_directive
, LegacyParser
, head
);
1319 free_acl_access(acl_access
** head
)
1321 aclDestroyAccessList(head
);
1325 dump_address(StoreEntry
* entry
, const char *name
, Ip::Address
&addr
)
1327 char buf
[MAX_IPSTRLEN
];
1328 storeAppendPrintf(entry
, "%s %s\n", name
, addr
.toStr(buf
,MAX_IPSTRLEN
) );
1332 parse_address(Ip::Address
*addr
)
1334 char *token
= ConfigParser::NextToken();
1341 if (!strcmp(token
,"any_addr"))
1343 else if ( (!strcmp(token
,"no_addr")) || (!strcmp(token
,"full_mask")) )
1345 else if ( (*addr
= token
) ) // try parse numeric/IPA
1347 else if (addr
->GetHostByName(token
)) // dont use ipcache
1349 else { // not an IP and not a hostname
1350 debugs(3, DBG_CRITICAL
, "FATAL: invalid IP address or domain name '" << token
<< "'");
1356 free_address(Ip::Address
*addr
)
1361 CBDATA_TYPE(AclAddress
);
1364 dump_acl_address(StoreEntry
* entry
, const char *name
, AclAddress
* head
)
1366 char buf
[MAX_IPSTRLEN
];
1369 for (l
= head
; l
; l
= l
->next
) {
1370 if (!l
->addr
.isAnyAddr())
1371 storeAppendPrintf(entry
, "%s %s", name
, l
->addr
.toStr(buf
,MAX_IPSTRLEN
));
1373 storeAppendPrintf(entry
, "%s autoselect", name
);
1375 dump_acl_list(entry
, l
->aclList
);
1377 storeAppendPrintf(entry
, "\n");
1382 freed_acl_address(void *data
)
1384 AclAddress
*l
= static_cast<AclAddress
*>(data
);
1385 aclDestroyAclList(&l
->aclList
);
1389 parse_acl_address(AclAddress
** head
)
1392 AclAddress
**tail
= head
; /* sane name below */
1393 CBDATA_INIT_TYPE_FREECB(AclAddress
, freed_acl_address
);
1394 l
= cbdataAlloc(AclAddress
);
1395 parse_address(&l
->addr
);
1396 aclParseAclList(LegacyParser
, &l
->aclList
, l
->addr
);
1399 tail
= &(*tail
)->next
;
1405 free_acl_address(AclAddress
** head
)
1408 AclAddress
*l
= *head
;
1414 CBDATA_TYPE(acl_tos
);
1417 dump_acl_tos(StoreEntry
* entry
, const char *name
, acl_tos
* head
)
1421 for (l
= head
; l
; l
= l
->next
) {
1423 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->tos
);
1425 storeAppendPrintf(entry
, "%s none", name
);
1427 dump_acl_list(entry
, l
->aclList
);
1429 storeAppendPrintf(entry
, "\n");
1434 freed_acl_tos(void *data
)
1436 acl_tos
*l
= static_cast<acl_tos
*>(data
);
1437 aclDestroyAclList(&l
->aclList
);
1441 parse_acl_tos(acl_tos
** head
)
1444 acl_tos
**tail
= head
; /* sane name below */
1445 unsigned int tos
; /* Initially uint for strtoui. Casted to tos_t before return */
1446 char *token
= ConfigParser::NextToken();
1453 if (!xstrtoui(token
, NULL
, &tos
, 0, std::numeric_limits
<tos_t
>::max())) {
1458 const unsigned int chTos
= tos
& 0xFC;
1460 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: Tos value '" << tos
<< "' adjusted to '" << chTos
<< "'");
1464 CBDATA_INIT_TYPE_FREECB(acl_tos
, freed_acl_tos
);
1466 l
= cbdataAlloc(acl_tos
);
1468 l
->tos
= (tos_t
)tos
;
1470 aclParseAclList(LegacyParser
, &l
->aclList
, token
);
1473 tail
= &(*tail
)->next
;
1479 free_acl_tos(acl_tos
** head
)
1489 #if SO_MARK && USE_LIBCAP
1491 CBDATA_TYPE(acl_nfmark
);
1494 dump_acl_nfmark(StoreEntry
* entry
, const char *name
, acl_nfmark
* head
)
1498 for (l
= head
; l
; l
= l
->next
) {
1500 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->nfmark
);
1502 storeAppendPrintf(entry
, "%s none", name
);
1504 dump_acl_list(entry
, l
->aclList
);
1506 storeAppendPrintf(entry
, "\n");
1511 freed_acl_nfmark(void *data
)
1513 acl_nfmark
*l
= static_cast<acl_nfmark
*>(data
);
1514 aclDestroyAclList(&l
->aclList
);
1518 parse_acl_nfmark(acl_nfmark
** head
)
1521 acl_nfmark
**tail
= head
; /* sane name below */
1523 char *token
= ConfigParser::NextToken();
1530 if (!xstrtoui(token
, NULL
, &mark
, 0, std::numeric_limits
<nfmark_t
>::max())) {
1535 CBDATA_INIT_TYPE_FREECB(acl_nfmark
, freed_acl_nfmark
);
1537 l
= cbdataAlloc(acl_nfmark
);
1541 aclParseAclList(LegacyParser
, &l
->aclList
, token
);
1544 tail
= &(*tail
)->next
;
1550 free_acl_nfmark(acl_nfmark
** head
)
1553 acl_nfmark
*l
= *head
;
1559 #endif /* SO_MARK */
1561 CBDATA_TYPE(AclSizeLimit
);
1564 dump_acl_b_size_t(StoreEntry
* entry
, const char *name
, AclSizeLimit
* head
)
1568 for (l
= head
; l
; l
= l
->next
) {
1570 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) l
->size
, B_BYTES_STR
);
1572 storeAppendPrintf(entry
, "%s none", name
);
1574 dump_acl_list(entry
, l
->aclList
);
1576 storeAppendPrintf(entry
, "\n");
1581 freed_acl_b_size_t(void *data
)
1583 AclSizeLimit
*l
= static_cast<AclSizeLimit
*>(data
);
1584 aclDestroyAclList(&l
->aclList
);
1588 parse_acl_b_size_t(AclSizeLimit
** head
)
1591 AclSizeLimit
**tail
= head
; /* sane name below */
1593 CBDATA_INIT_TYPE_FREECB(AclSizeLimit
, freed_acl_b_size_t
);
1595 l
= cbdataAlloc(AclSizeLimit
);
1597 parse_b_int64_t(&l
->size
);
1599 aclParseAclList(LegacyParser
, &l
->aclList
, l
->size
);
1602 tail
= &(*tail
)->next
;
1608 free_acl_b_size_t(AclSizeLimit
** head
)
1611 AclSizeLimit
*l
= *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
)
1684 cfg
->freePoolCount();
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
, SquidConfig::_cacheSwap 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
)
1809 if ((type_str
= ConfigParser::NextToken()) == NULL
)
1812 if ((param_str
= ConfigParser::NextToken()) == NULL
)
1815 /* find a configuration for the scheme in the currently parsed configs... */
1816 Auth::Config
*schemeCfg
= Auth::Config::Find(type_str
);
1818 if (schemeCfg
== NULL
) {
1819 /* Create a configuration based on the scheme info */
1820 Auth::Scheme::Pointer theScheme
= Auth::Scheme::Find(type_str
);
1822 if (theScheme
== NULL
) {
1823 debugs(3, DBG_CRITICAL
, "Parsing Config File: Unknown authentication scheme '" << type_str
<< "'.");
1827 config
->push_back(theScheme
->createConfig());
1828 schemeCfg
= Auth::Config::Find(type_str
);
1829 if (schemeCfg
== NULL
) {
1830 debugs(3, DBG_CRITICAL
, "Parsing Config File: Corruption configuring authentication scheme '" << type_str
<< "'.");
1835 schemeCfg
->parse(schemeCfg
, config
->size(), param_str
);
1839 free_authparam(Auth::ConfigVector
* cfg
)
1841 /* Wipe the Auth globals and Detach/Destruct component config + state. */
1844 /* on reconfigure initialize new auth schemes for the new config. */
1845 if (reconfiguring
) {
1851 dump_authparam(StoreEntry
* entry
, const char *name
, Auth::ConfigVector cfg
)
1853 for (Auth::ConfigVector::iterator i
= cfg
.begin(); i
!= cfg
.end(); ++i
)
1854 (*i
)->dump(entry
, name
, (*i
));
1856 #endif /* USE_AUTH */
1858 /* TODO: just return the object, the # is irrelevant */
1860 find_fstype(char *type
)
1862 for (size_t i
= 0; i
< StoreFileSystem::FileSystems().size(); ++i
)
1863 if (strcasecmp(type
, StoreFileSystem::FileSystems().at(i
)->type()) == 0)
1870 parse_cachedir(SquidConfig::_cacheSwap
* swap
)
1874 RefCount
<SwapDir
> sd
;
1878 if ((type_str
= ConfigParser::NextToken()) == NULL
)
1881 if ((path_str
= ConfigParser::NextToken()) == NULL
)
1884 fs
= find_fstype(type_str
);
1887 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: This proxy does not support the '" << type_str
<< "' cache type. Ignoring.");
1891 /* reconfigure existing dir */
1893 for (i
= 0; i
< swap
->n_configured
; ++i
) {
1894 assert (swap
->swapDirs
[i
].getRaw());
1896 if ((strcasecmp(path_str
, dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw())->path
)) == 0) {
1897 /* this is specific to on-fs Stores. The right
1898 * way to handle this is probably to have a mapping
1899 * from paths to stores, and have on-fs stores
1900 * register with that, and lookip in that in their
1901 * own setup logic. RBC 20041225. TODO.
1904 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw());
1906 if (strcmp(sd
->type(), StoreFileSystem::FileSystems().at(fs
)->type()) != 0) {
1907 debugs(3, DBG_CRITICAL
, "ERROR: Can't change type of existing cache_dir " <<
1908 sd
->type() << " " << sd
->path
<< " to " << type_str
<< ". Restart required");
1918 if (swap
->n_configured
> 63) {
1919 /* 7 bits, signed */
1920 debugs(3, DBG_CRITICAL
, "WARNING: There is a fixed maximum of 63 cache_dir entries Squid can handle.");
1921 debugs(3, DBG_CRITICAL
, "WARNING: '" << path_str
<< "' is one to many.");
1926 allocate_new_swapdir(swap
);
1928 swap
->swapDirs
[swap
->n_configured
] = StoreFileSystem::FileSystems().at(fs
)->createSwapDir();
1930 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[swap
->n_configured
].getRaw());
1932 /* parse the FS parameters and options */
1933 sd
->parse(swap
->n_configured
, path_str
);
1935 ++swap
->n_configured
;
1939 peer_type_str(const peer_t type
)
1941 const char * result
;
1953 case PEER_MULTICAST
:
1954 result
= "multicast";
1966 dump_peer(StoreEntry
* entry
, const char *name
, CachePeer
* p
)
1968 CachePeerDomainList
*d
;
1969 NeighborTypeDomainList
*t
;
1970 LOCAL_ARRAY(char, xname
, 128);
1973 storeAppendPrintf(entry
, "%s %s %s %d %d name=%s",
1980 dump_peer_options(entry
, p
);
1982 for (d
= p
->peer_domain
; d
; d
= d
->next
) {
1983 storeAppendPrintf(entry
, "cache_peer_domain %s %s%s\n",
1985 d
->do_ping
? null_string
: "!",
1990 snprintf(xname
, 128, "cache_peer_access %s", p
->name
);
1991 dump_acl_access(entry
, xname
, p
->access
);
1994 for (t
= p
->typelist
; t
; t
= t
->next
) {
1995 storeAppendPrintf(entry
, "neighbor_type_domain %s %s %s\n",
1997 peer_type_str(t
->type
),
2006 * utility function to prevent getservbyname() being called with a numeric value
2007 * on Windows at least it returns garage results.
2010 isUnsignedNumeric(const char *str
, size_t len
)
2012 if (len
< 1) return false;
2014 for (; len
>0 && *str
; ++str
, --len
) {
2015 if (! isdigit(*str
))
2022 \param proto 'tcp' or 'udp' for protocol
2023 \returns Port the named service is supposed to be listening on.
2025 static unsigned short
2026 GetService(const char *proto
)
2028 struct servent
*port
= NULL
;
2029 /** Parses a port number or service name from the squid.conf */
2030 char *token
= ConfigParser::NextToken();
2031 if (token
== NULL
) {
2033 return 0; /* NEVER REACHED */
2035 /** Returns either the service port number from /etc/services */
2036 if ( !isUnsignedNumeric(token
, strlen(token
)) )
2037 port
= getservbyname(token
, proto
);
2039 return ntohs((unsigned short)port
->s_port
);
2041 /** Or a numeric translation of the config text. */
2042 return xatos(token
);
2046 \returns Port the named TCP service is supposed to be listening on.
2047 \copydoc GetService(const char *proto)
2049 inline unsigned short
2052 return GetService("tcp");
2056 \returns Port the named UDP service is supposed to be listening on.
2057 \copydoc GetService(const char *proto)
2059 inline unsigned short
2062 return GetService("udp");
2066 parse_peer(CachePeer
** head
)
2070 CBDATA_INIT_TYPE_FREECB(CachePeer
, peerDestroy
);
2071 p
= cbdataAlloc(CachePeer
);
2072 p
->http_port
= CACHE_HTTP_PORT
;
2073 p
->icp
.port
= CACHE_ICP_PORT
;
2076 p
->stats
.logged_state
= PEER_ALIVE
;
2078 if ((token
= ConfigParser::NextToken()) == NULL
)
2081 p
->host
= xstrdup(token
);
2083 p
->name
= xstrdup(token
);
2085 if ((token
= ConfigParser::NextToken()) == NULL
)
2088 p
->type
= parseNeighborType(token
);
2090 if (p
->type
== PEER_MULTICAST
) {
2091 p
->options
.no_digest
= true;
2092 p
->options
.no_netdb_exchange
= true;
2095 p
->http_port
= GetTcpService();
2100 p
->icp
.port
= GetUdpService();
2101 p
->connection_auth
= 2; /* auto */
2103 while ((token
= ConfigParser::NextToken())) {
2104 if (!strcmp(token
, "proxy-only")) {
2105 p
->options
.proxy_only
= true;
2106 } else if (!strcmp(token
, "no-query")) {
2107 p
->options
.no_query
= true;
2108 } else if (!strcmp(token
, "background-ping")) {
2109 p
->options
.background_ping
= true;
2110 } else if (!strcmp(token
, "no-digest")) {
2111 p
->options
.no_digest
= true;
2112 } else if (!strcmp(token
, "no-tproxy")) {
2113 p
->options
.no_tproxy
= true;
2114 } else if (!strcmp(token
, "multicast-responder")) {
2115 p
->options
.mcast_responder
= true;
2116 #if PEER_MULTICAST_SIBLINGS
2117 } else if (!strcmp(token
, "multicast-siblings")) {
2118 p
->options
.mcast_siblings
= true;
2120 } else if (!strncmp(token
, "weight=", 7)) {
2121 p
->weight
= xatoi(token
+ 7);
2122 } else if (!strncmp(token
, "basetime=", 9)) {
2123 p
->basetime
= xatoi(token
+ 9);
2124 } else if (!strcmp(token
, "closest-only")) {
2125 p
->options
.closest_only
= true;
2126 } else if (!strncmp(token
, "ttl=", 4)) {
2127 p
->mcast
.ttl
= xatoi(token
+ 4);
2129 if (p
->mcast
.ttl
< 0)
2132 if (p
->mcast
.ttl
> 128)
2134 } else if (!strcmp(token
, "default")) {
2135 p
->options
.default_parent
= true;
2136 } else if (!strcmp(token
, "round-robin")) {
2137 p
->options
.roundrobin
= true;
2138 } else if (!strcmp(token
, "weighted-round-robin")) {
2139 p
->options
.weighted_roundrobin
= true;
2141 } else if (!strcmp(token
, "htcp")) {
2142 p
->options
.htcp
= true;
2143 } else if (!strncmp(token
, "htcp=", 5) || !strncmp(token
, "htcp-", 5)) {
2144 /* Note: The htcp- form is deprecated, replaced by htcp= */
2145 p
->options
.htcp
= true;
2146 char *tmp
= xstrdup(token
+5);
2147 char *mode
, *nextmode
;
2148 for (mode
= nextmode
= tmp
; mode
; mode
= nextmode
) {
2149 nextmode
= strchr(mode
, ',');
2154 if (!strcmp(mode
, "no-clr")) {
2155 if (p
->options
.htcp_only_clr
)
2156 fatalf("parse_peer: can't set htcp-no-clr and htcp-only-clr simultaneously");
2157 p
->options
.htcp_no_clr
= true;
2158 } else if (!strcmp(mode
, "no-purge-clr")) {
2159 p
->options
.htcp_no_purge_clr
= true;
2160 } else if (!strcmp(mode
, "only-clr")) {
2161 if (p
->options
.htcp_no_clr
)
2162 fatalf("parse_peer: can't set htcp no-clr and only-clr simultaneously");
2163 p
->options
.htcp_only_clr
= true;
2164 } else if (!strcmp(mode
, "forward-clr")) {
2165 p
->options
.htcp_forward_clr
= true;
2166 } else if (!strcmp(mode
, "oldsquid")) {
2167 p
->options
.htcp_oldsquid
= true;
2169 fatalf("invalid HTCP mode '%s'", mode
);
2174 } else if (!strcmp(token
, "no-netdb-exchange")) {
2175 p
->options
.no_netdb_exchange
= true;
2177 } else if (!strcmp(token
, "carp")) {
2178 if (p
->type
!= PEER_PARENT
)
2179 fatalf("parse_peer: non-parent carp peer %s/%d\n", p
->host
, p
->http_port
);
2181 p
->options
.carp
= true;
2182 } else if (!strncmp(token
, "carp-key=", 9)) {
2183 if (p
->options
.carp
!= true)
2184 fatalf("parse_peer: carp-key specified on non-carp peer %s/%d\n", p
->host
, p
->http_port
);
2185 p
->options
.carp_key
.set
= true;
2186 char *nextkey
=token
+strlen("carp-key="), *key
=nextkey
;
2187 for (; key
; key
= nextkey
) {
2188 nextkey
=strchr(key
,',');
2189 if (nextkey
) ++nextkey
; // skip the comma, any
2190 if (0==strncmp(key
,"scheme",6)) {
2191 p
->options
.carp_key
.scheme
= true;
2192 } else if (0==strncmp(key
,"host",4)) {
2193 p
->options
.carp_key
.host
= true;
2194 } else if (0==strncmp(key
,"port",4)) {
2195 p
->options
.carp_key
.port
= true;
2196 } else if (0==strncmp(key
,"path",4)) {
2197 p
->options
.carp_key
.path
= true;
2198 } else if (0==strncmp(key
,"params",6)) {
2199 p
->options
.carp_key
.params
= true;
2201 fatalf("invalid carp-key '%s'",key
);
2204 } else if (!strcmp(token
, "userhash")) {
2206 if (p
->type
!= PEER_PARENT
)
2207 fatalf("parse_peer: non-parent userhash peer %s/%d\n", p
->host
, p
->http_port
);
2209 p
->options
.userhash
= true;
2211 fatalf("parse_peer: userhash requires authentication. peer %s/%d\n", p
->host
, p
->http_port
);
2213 } else if (!strcmp(token
, "sourcehash")) {
2214 if (p
->type
!= PEER_PARENT
)
2215 fatalf("parse_peer: non-parent sourcehash peer %s/%d\n", p
->host
, p
->http_port
);
2217 p
->options
.sourcehash
= true;
2219 } else if (!strcmp(token
, "no-delay")) {
2221 p
->options
.no_delay
= true;
2223 debugs(0, DBG_CRITICAL
, "WARNING: cache_peer option 'no-delay' requires --enable-delay-pools");
2225 } else if (!strncmp(token
, "login=", 6)) {
2226 p
->login
= xstrdup(token
+ 6);
2227 rfc1738_unescape(p
->login
);
2228 } else if (!strncmp(token
, "connect-timeout=", 16)) {
2229 p
->connect_timeout
= xatoi(token
+ 16);
2230 } else if (!strncmp(token
, "connect-fail-limit=", 19)) {
2231 p
->connect_fail_limit
= xatoi(token
+ 19);
2232 #if USE_CACHE_DIGESTS
2233 } else if (!strncmp(token
, "digest-url=", 11)) {
2234 p
->digest_url
= xstrdup(token
+ 11);
2237 } else if (!strcmp(token
, "allow-miss")) {
2238 p
->options
.allow_miss
= true;
2239 } else if (!strncmp(token
, "max-conn=", 9)) {
2240 p
->max_conn
= xatoi(token
+ 9);
2241 } else if (!strncmp(token
, "standby=", 8)) {
2242 p
->standby
.limit
= xatoi(token
+ 8);
2243 } else if (!strcmp(token
, "originserver")) {
2244 p
->options
.originserver
= true;
2245 } else if (!strncmp(token
, "name=", 5)) {
2249 p
->name
= xstrdup(token
+ 5);
2250 } else if (!strncmp(token
, "forceddomain=", 13)) {
2251 safe_free(p
->domain
);
2254 p
->domain
= xstrdup(token
+ 13);
2258 } else if (strcmp(token
, "ssl") == 0) {
2260 } else if (strncmp(token
, "sslcert=", 8) == 0) {
2261 safe_free(p
->sslcert
);
2262 p
->sslcert
= xstrdup(token
+ 8);
2263 } else if (strncmp(token
, "sslkey=", 7) == 0) {
2264 safe_free(p
->sslkey
);
2265 p
->sslkey
= xstrdup(token
+ 7);
2266 } else if (strncmp(token
, "sslversion=", 11) == 0) {
2267 p
->sslversion
= xatoi(token
+ 11);
2268 } else if (strncmp(token
, "ssloptions=", 11) == 0) {
2269 safe_free(p
->ssloptions
);
2270 p
->ssloptions
= xstrdup(token
+ 11);
2271 } else if (strncmp(token
, "sslcipher=", 10) == 0) {
2272 safe_free(p
->sslcipher
);
2273 p
->sslcipher
= xstrdup(token
+ 10);
2274 } else if (strncmp(token
, "sslcafile=", 10) == 0) {
2275 safe_free(p
->sslcafile
);
2276 p
->sslcafile
= xstrdup(token
+ 10);
2277 } else if (strncmp(token
, "sslcapath=", 10) == 0) {
2278 safe_free(p
->sslcapath
);
2279 p
->sslcapath
= xstrdup(token
+ 10);
2280 } else if (strncmp(token
, "sslcrlfile=", 11) == 0) {
2281 safe_free(p
->sslcrlfile
);
2282 p
->sslcrlfile
= xstrdup(token
+ 11);
2283 } else if (strncmp(token
, "sslflags=", 9) == 0) {
2284 safe_free(p
->sslflags
);
2285 p
->sslflags
= xstrdup(token
+ 9);
2286 } else if (strncmp(token
, "ssldomain=", 10) == 0) {
2287 safe_free(p
->ssldomain
);
2288 p
->ssldomain
= xstrdup(token
+ 10);
2291 } else if (strcmp(token
, "front-end-https") == 0) {
2292 p
->front_end_https
= 1;
2293 } else if (strcmp(token
, "front-end-https=on") == 0) {
2294 p
->front_end_https
= 1;
2295 } else if (strcmp(token
, "front-end-https=auto") == 0) {
2296 p
->front_end_https
= 2;
2297 } else if (strcmp(token
, "connection-auth=off") == 0) {
2298 p
->connection_auth
= 0;
2299 } else if (strcmp(token
, "connection-auth") == 0) {
2300 p
->connection_auth
= 1;
2301 } else if (strcmp(token
, "connection-auth=on") == 0) {
2302 p
->connection_auth
= 1;
2303 } else if (strcmp(token
, "connection-auth=auto") == 0) {
2304 p
->connection_auth
= 2;
2305 } else if (token
[0] == '#') {
2306 // start of a text comment. stop reading this line.
2309 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Ignoring unknown cache_peer option '" << token
<< "'");
2313 if (peerFindByName(p
->name
))
2314 fatalf("ERROR: cache_peer %s specified twice\n", p
->name
);
2316 if (p
->max_conn
> 0 && p
->max_conn
< p
->standby
.limit
)
2317 fatalf("ERROR: cache_peer %s max-conn=%d is lower than its standby=%d\n", p
->host
, p
->max_conn
, p
->standby
.limit
);
2322 if (p
->connect_fail_limit
< 1)
2323 p
->connect_fail_limit
= 10;
2325 p
->icp
.version
= ICP_VERSION_CURRENT
;
2327 p
->testing_now
= false;
2329 #if USE_CACHE_DIGESTS
2331 if (!p
->options
.no_digest
) {
2332 /* XXX This looks odd.. who has the original pointer
2335 PeerDigest
*pd
= peerDigestCreate(p
);
2336 p
->digest
= cbdataReference(pd
);
2341 p
->index
= ++Config
.npeers
;
2343 while (*head
!= NULL
)
2344 head
= &(*head
)->next
;
2352 free_peer(CachePeer
** P
)
2356 while ((p
= *P
) != NULL
) {
2358 #if USE_CACHE_DIGESTS
2360 cbdataReferenceDone(p
->digest
);
2363 // the mgr job will notice that its owner is gone and stop
2364 PeerPoolMgr::Checkpoint(p
->standby
.mgr
, "peer gone");
2365 delete p
->standby
.pool
;
2373 dump_cachemgrpasswd(StoreEntry
* entry
, const char *name
, Mgr::ActionPasswordList
* list
)
2377 while (list
!= NULL
) {
2378 if (strcmp(list
->passwd
, "none") && strcmp(list
->passwd
, "disable"))
2379 storeAppendPrintf(entry
, "%s XXXXXXXXXX", name
);
2381 storeAppendPrintf(entry
, "%s %s", name
, list
->passwd
);
2383 for (w
= list
->actions
; w
!= NULL
; w
= w
->next
) {
2384 storeAppendPrintf(entry
, " %s", w
->key
);
2387 storeAppendPrintf(entry
, "\n");
2393 parse_cachemgrpasswd(Mgr::ActionPasswordList
** head
)
2395 char *passwd
= NULL
;
2396 wordlist
*actions
= NULL
;
2397 Mgr::ActionPasswordList
*p
;
2398 Mgr::ActionPasswordList
**P
;
2399 parse_string(&passwd
);
2400 parse_wordlist(&actions
);
2401 p
= new Mgr::ActionPasswordList
;
2403 p
->actions
= actions
;
2405 for (P
= head
; *P
; P
= &(*P
)->next
) {
2407 * See if any of the actions from this line already have a
2408 * password from previous lines. The password checking
2409 * routines in cache_manager.c take the the password from
2410 * the first Mgr::ActionPasswordList that contains the
2411 * requested action. Thus, we should warn users who might
2412 * think they can have two passwords for the same action.
2417 for (w
= (*P
)->actions
; w
; w
= w
->next
) {
2418 for (u
= actions
; u
; u
= u
->next
) {
2419 if (strcmp(w
->key
, u
->key
))
2422 debugs(0, DBG_CRITICAL
, "WARNING: action '" << u
->key
<< "' (line " << config_lineno
<< ") already has a password");
2431 free_cachemgrpasswd(Mgr::ActionPasswordList
** head
)
2433 Mgr::ActionPasswordList
*p
;
2435 while ((p
= *head
) != NULL
) {
2438 wordlistDestroy(&p
->actions
);
2444 dump_denyinfo(StoreEntry
* entry
, const char *name
, AclDenyInfoList
* var
)
2448 while (var
!= NULL
) {
2449 storeAppendPrintf(entry
, "%s %s", name
, var
->err_page_name
);
2451 for (a
= var
->acl_list
; a
!= NULL
; a
= a
->next
)
2452 storeAppendPrintf(entry
, " %s", a
->name
);
2454 storeAppendPrintf(entry
, "\n");
2461 parse_denyinfo(AclDenyInfoList
** var
)
2463 aclParseDenyInfoLine(var
);
2467 free_denyinfo(AclDenyInfoList
** list
)
2469 AclDenyInfoList
*a
= NULL
;
2470 AclDenyInfoList
*a_next
= NULL
;
2471 AclNameList
*l
= NULL
;
2472 AclNameList
*l_next
= NULL
;
2474 for (a
= *list
; a
; a
= a_next
) {
2475 for (l
= a
->acl_list
; l
; l
= l_next
) {
2477 memFree(l
, MEM_ACL_NAME_LIST
);
2482 memFree(a
, MEM_ACL_DENY_INFO_LIST
);
2490 parse_peer_access(void)
2495 if (!(host
= ConfigParser::NextToken()))
2498 if ((p
= peerFindByName(host
)) == NULL
) {
2499 debugs(15, DBG_CRITICAL
, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2503 std::string directive
= "peer_access ";
2505 aclParseAccessLine(directive
.c_str(), LegacyParser
, &p
->access
);
2509 parse_hostdomain(void)
2512 char *domain
= NULL
;
2514 if (!(host
= ConfigParser::NextToken()))
2517 while ((domain
= ConfigParser::NextToken())) {
2518 CachePeerDomainList
*l
= NULL
;
2519 CachePeerDomainList
**L
= NULL
;
2522 if ((p
= peerFindByName(host
)) == NULL
) {
2523 debugs(15, DBG_CRITICAL
, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2527 l
= static_cast<CachePeerDomainList
*>(xcalloc(1, sizeof(CachePeerDomainList
)));
2530 if (*domain
== '!') { /* check for !.edu */
2535 l
->domain
= xstrdup(domain
);
2537 for (L
= &(p
->peer_domain
); *L
; L
= &((*L
)->next
));
2543 parse_hostdomaintype(void)
2547 char *domain
= NULL
;
2549 if (!(host
= ConfigParser::NextToken()))
2552 if (!(type
= ConfigParser::NextToken()))
2555 while ((domain
= ConfigParser::NextToken())) {
2556 NeighborTypeDomainList
*l
= NULL
;
2557 NeighborTypeDomainList
**L
= NULL
;
2560 if ((p
= peerFindByName(host
)) == NULL
) {
2561 debugs(15, DBG_CRITICAL
, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2565 l
= static_cast<NeighborTypeDomainList
*>(xcalloc(1, sizeof(NeighborTypeDomainList
)));
2566 l
->type
= parseNeighborType(type
);
2567 l
->domain
= xstrdup(domain
);
2569 for (L
= &(p
->typelist
); *L
; L
= &((*L
)->next
));
2575 dump_int(StoreEntry
* entry
, const char *name
, int var
)
2577 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
2595 dump_onoff(StoreEntry
* entry
, const char *name
, int var
)
2597 storeAppendPrintf(entry
, "%s %s\n", name
, var
? "on" : "off");
2601 parse_onoff(int *var
)
2603 char *token
= ConfigParser::NextToken();
2608 if (!strcmp(token
, "on")) {
2610 } else if (!strcmp(token
, "enable")) {
2611 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'enable' is deprecated. Please update to use 'on'.");
2613 } else if (!strcmp(token
, "off")) {
2615 } else if (!strcmp(token
, "disable")) {
2616 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'disable' is deprecated. Please update to use 'off'.");
2619 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Invalid option: Boolean options can only be 'on' or 'off'.");
2624 #define free_onoff free_int
2627 dump_tristate(StoreEntry
* entry
, const char *name
, int var
)
2638 storeAppendPrintf(entry
, "%s %s\n", name
, state
);
2642 parse_tristate(int *var
)
2644 char *token
= ConfigParser::NextToken();
2649 if (!strcmp(token
, "on")) {
2651 } else if (!strcmp(token
, "enable")) {
2652 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'enable' is deprecated. Please update to use value 'on'.");
2654 } else if (!strcmp(token
, "warn")) {
2656 } else if (!strcmp(token
, "off")) {
2658 } else if (!strcmp(token
, "disable")) {
2659 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'disable' is deprecated. Please update to use value 'off'.");
2662 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Invalid option: Tristate options can only be 'on', 'off', or 'warn'.");
2667 #define free_tristate free_int
2670 parse_pipelinePrefetch(int *var
)
2672 char *token
= ConfigParser::PeekAtToken();
2677 if (!strcmp(token
, "on")) {
2678 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'pipeline_prefetch on' is deprecated. Please update to use 1 (or a higher number).");
2681 (void)ConfigParser::NextToken();
2682 } else if (!strcmp(token
, "off")) {
2683 debugs(0, DBG_PARSE_NOTE(2), "WARNING: 'pipeline_prefetch off' is deprecated. Please update to use '0'.");
2686 (void)ConfigParser::NextToken();
2691 #define free_pipelinePrefetch free_int
2692 #define dump_pipelinePrefetch dump_int
2695 dump_refreshpattern(StoreEntry
* entry
, const char *name
, RefreshPattern
* head
)
2697 while (head
!= NULL
) {
2698 storeAppendPrintf(entry
, "%s%s %s %d %d%% %d",
2700 head
->flags
.icase
? " -i" : null_string
,
2702 (int) head
->min
/ 60,
2703 (int) (100.0 * head
->pct
+ 0.5),
2704 (int) head
->max
/ 60);
2706 if (head
->max_stale
>= 0)
2707 storeAppendPrintf(entry
, " max-stale=%d", head
->max_stale
);
2709 if (head
->flags
.refresh_ims
)
2710 storeAppendPrintf(entry
, " refresh-ims");
2712 if (head
->flags
.store_stale
)
2713 storeAppendPrintf(entry
, " store-stale");
2715 #if USE_HTTP_VIOLATIONS
2717 if (head
->flags
.override_expire
)
2718 storeAppendPrintf(entry
, " override-expire");
2720 if (head
->flags
.override_lastmod
)
2721 storeAppendPrintf(entry
, " override-lastmod");
2723 if (head
->flags
.reload_into_ims
)
2724 storeAppendPrintf(entry
, " reload-into-ims");
2726 if (head
->flags
.ignore_reload
)
2727 storeAppendPrintf(entry
, " ignore-reload");
2729 if (head
->flags
.ignore_no_store
)
2730 storeAppendPrintf(entry
, " ignore-no-store");
2732 if (head
->flags
.ignore_must_revalidate
)
2733 storeAppendPrintf(entry
, " ignore-must-revalidate");
2735 if (head
->flags
.ignore_private
)
2736 storeAppendPrintf(entry
, " ignore-private");
2738 if (head
->flags
.ignore_auth
)
2739 storeAppendPrintf(entry
, " ignore-auth");
2743 storeAppendPrintf(entry
, "\n");
2750 parse_refreshpattern(RefreshPattern
** head
)
2757 int refresh_ims
= 0;
2758 int store_stale
= 0;
2761 #if USE_HTTP_VIOLATIONS
2763 int override_expire
= 0;
2764 int override_lastmod
= 0;
2765 int reload_into_ims
= 0;
2766 int ignore_reload
= 0;
2767 int ignore_no_store
= 0;
2768 int ignore_must_revalidate
= 0;
2769 int ignore_private
= 0;
2770 int ignore_auth
= 0;
2777 int flags
= REG_EXTENDED
| REG_NOSUB
;
2779 if ((token
= ConfigParser::RegexPattern()) != NULL
) {
2781 if (strcmp(token
, "-i") == 0) {
2783 token
= ConfigParser::RegexPattern();
2784 } else if (strcmp(token
, "+i") == 0) {
2785 flags
&= ~REG_ICASE
;
2786 token
= ConfigParser::RegexPattern();
2791 if (token
== NULL
) {
2792 debugs(3, DBG_CRITICAL
, "FATAL: refresh_pattern missing the regex pattern parameter");
2797 pattern
= xstrdup(token
);
2799 i
= GetInteger(); /* token: min */
2801 /* catch negative and insanely huge values close to 32-bit wrap */
2803 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age negative. Cropped back to zero.");
2806 if (i
> 60*24*365) {
2807 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age too high. Cropped back to 1 year.");
2811 min
= (time_t) (i
* 60); /* convert minutes to seconds */
2813 i
= GetPercentage(); /* token: pct */
2815 pct
= (double) i
/ 100.0;
2817 i
= GetInteger(); /* token: max */
2819 /* catch negative and insanely huge values close to 32-bit wrap */
2821 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age negative. Cropped back to zero.");
2824 if (i
> 60*24*365) {
2825 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age too high. Cropped back to 1 year.");
2829 max
= (time_t) (i
* 60); /* convert minutes to seconds */
2832 while ((token
= ConfigParser::NextToken()) != NULL
) {
2833 if (!strcmp(token
, "refresh-ims")) {
2835 } else if (!strcmp(token
, "store-stale")) {
2837 } else if (!strncmp(token
, "max-stale=", 10)) {
2838 max_stale
= xatoi(token
+ 10);
2839 #if USE_HTTP_VIOLATIONS
2841 } else if (!strcmp(token
, "override-expire"))
2842 override_expire
= 1;
2843 else if (!strcmp(token
, "override-lastmod"))
2844 override_lastmod
= 1;
2845 else if (!strcmp(token
, "ignore-no-store"))
2846 ignore_no_store
= 1;
2847 else if (!strcmp(token
, "ignore-must-revalidate"))
2848 ignore_must_revalidate
= 1;
2849 else if (!strcmp(token
, "ignore-private"))
2851 else if (!strcmp(token
, "ignore-auth"))
2853 else if (!strcmp(token
, "reload-into-ims")) {
2854 reload_into_ims
= 1;
2855 refresh_nocache_hack
= 1;
2856 /* tell client_side.c that this is used */
2857 } else if (!strcmp(token
, "ignore-reload")) {
2859 refresh_nocache_hack
= 1;
2860 /* tell client_side.c that this is used */
2863 } else if (!strcmp(token
, "ignore-no-cache")) {
2864 debugs(22, DBG_PARSE_NOTE(2), "UPGRADE: refresh_pattern option 'ignore-no-cache' is obsolete. Remove it.");
2866 debugs(22, DBG_CRITICAL
, "refreshAddToList: Unknown option '" << pattern
<< "': " << token
);
2869 if ((errcode
= regcomp(&comp
, pattern
, flags
)) != 0) {
2871 regerror(errcode
, &comp
, errbuf
, sizeof errbuf
);
2872 debugs(22, DBG_CRITICAL
, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
2873 debugs(22, DBG_CRITICAL
, "refreshAddToList: Invalid regular expression '" << pattern
<< "': " << errbuf
);
2878 pct
= pct
< 0.0 ? 0.0 : pct
;
2879 max
= max
< 0 ? 0 : max
;
2880 t
= static_cast<RefreshPattern
*>(xcalloc(1, sizeof(RefreshPattern
)));
2881 t
->pattern
= (char *) xstrdup(pattern
);
2882 t
->compiled_pattern
= comp
;
2887 if (flags
& REG_ICASE
)
2888 t
->flags
.icase
= true;
2891 t
->flags
.refresh_ims
= true;
2894 t
->flags
.store_stale
= true;
2896 t
->max_stale
= max_stale
;
2898 #if USE_HTTP_VIOLATIONS
2900 if (override_expire
)
2901 t
->flags
.override_expire
= true;
2903 if (override_lastmod
)
2904 t
->flags
.override_lastmod
= true;
2906 if (reload_into_ims
)
2907 t
->flags
.reload_into_ims
= true;
2910 t
->flags
.ignore_reload
= true;
2912 if (ignore_no_store
)
2913 t
->flags
.ignore_no_store
= true;
2915 if (ignore_must_revalidate
)
2916 t
->flags
.ignore_must_revalidate
= true;
2919 t
->flags
.ignore_private
= true;
2922 t
->flags
.ignore_auth
= true;
2929 head
= &(*head
)->next
;
2937 free_refreshpattern(RefreshPattern
** head
)
2941 while ((t
= *head
) != NULL
) {
2943 safe_free(t
->pattern
);
2944 regfree(&t
->compiled_pattern
);
2948 #if USE_HTTP_VIOLATIONS
2949 refresh_nocache_hack
= 0;
2955 dump_string(StoreEntry
* entry
, const char *name
, char *var
)
2958 storeAppendPrintf(entry
, "%s %s\n", name
, var
);
2962 parse_string(char **var
)
2964 char *token
= ConfigParser::NextToken();
2970 *var
= xstrdup(token
);
2974 free_string(char **var
)
2980 parse_eol(char *volatile *var
)
2987 unsigned char *token
= (unsigned char *) ConfigParser::NextQuotedOrToEol();
2995 while (*token
&& xisspace(*token
))
3003 *var
= xstrdup((char *) token
);
3006 #define dump_eol dump_string
3007 #define free_eol free_string
3010 parse_TokenOrQuotedString(char **var
)
3012 char *token
= ConfigParser::NextQuotedToken();
3018 *var
= xstrdup(token
);
3021 #define dump_TokenOrQuotedString dump_string
3022 #define free_TokenOrQuotedString free_string
3025 dump_time_t(StoreEntry
* entry
, const char *name
, time_t var
)
3027 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int) var
);
3031 parse_time_t(time_t * var
)
3034 parseTimeLine(&tval
, T_SECOND_STR
, false);
3035 *var
= static_cast<time_t>(tval
/1000);
3039 free_time_t(time_t * var
)
3045 dump_time_msec(StoreEntry
* entry
, const char *name
, time_msec_t var
)
3048 storeAppendPrintf(entry
, "%s %" PRId64
" milliseconds\n", name
, var
);
3050 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int)(var
/1000) );
3054 parse_time_msec(time_msec_t
* var
)
3056 parseTimeLine(var
, T_SECOND_STR
, true);
3060 free_time_msec(time_msec_t
* var
)
3067 dump_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3069 storeAppendPrintf(entry
, "%s %d\n", name
, (int) var
);
3074 dump_b_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3076 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3080 dump_b_ssize_t(StoreEntry
* entry
, const char *name
, ssize_t var
)
3082 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3087 dump_kb_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3089 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_KBYTES_STR
);
3094 dump_b_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3096 storeAppendPrintf(entry
, "%s %" PRId64
" %s\n", name
, var
, B_BYTES_STR
);
3100 dump_kb_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3102 storeAppendPrintf(entry
, "%s %" PRId64
" %s\n", name
, var
, B_KBYTES_STR
);
3107 parse_size_t(size_t * var
)
3116 parse_b_size_t(size_t * var
)
3118 parseBytesLine(var
, B_BYTES_STR
);
3122 parse_b_ssize_t(ssize_t
* var
)
3124 parseBytesLineSigned(var
, B_BYTES_STR
);
3129 parse_kb_size_t(size_t * var
)
3131 parseBytesLine(var
, B_KBYTES_STR
);
3136 parse_b_int64_t(int64_t * var
)
3138 parseBytesLine64(var
, B_BYTES_STR
);
3142 parse_kb_int64_t(int64_t * var
)
3144 parseBytesLine64(var
, B_KBYTES_STR
);
3148 free_size_t(size_t * var
)
3154 free_ssize_t(ssize_t
* var
)
3160 free_b_int64_t(int64_t * var
)
3165 #define free_b_size_t free_size_t
3166 #define free_b_ssize_t free_ssize_t
3167 #define free_kb_size_t free_size_t
3168 #define free_mb_size_t free_size_t
3169 #define free_gb_size_t free_size_t
3170 #define free_kb_int64_t free_b_int64_t
3173 dump_u_short(StoreEntry
* entry
, const char *name
, unsigned short var
)
3175 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
3179 free_u_short(unsigned short * u
)
3185 parse_u_short(unsigned short * var
)
3187 ConfigParser::ParseUShort(var
);
3191 ConfigParser::ParseUShort(unsigned short *var
)
3197 ConfigParser::ParseBool(bool *var
)
3199 int i
= GetInteger();
3210 dump_wordlist(StoreEntry
* entry
, const char *name
, wordlist
* list
)
3212 while (list
!= NULL
) {
3213 storeAppendPrintf(entry
, "%s %s\n", name
, list
->key
);
3219 ConfigParser::ParseWordList(wordlist
** list
)
3221 parse_wordlist(list
);
3225 parse_wordlist(wordlist
** list
)
3228 while ((token
= ConfigParser::NextQuotedToken()))
3229 wordlistAdd(list
, token
);
3232 #if 0 /* now unused */
3234 check_null_wordlist(wordlist
* w
)
3241 check_null_acl_access(acl_access
* a
)
3246 #define free_wordlist wordlistDestroy
3248 #define free_uri_whitespace free_int
3251 parse_uri_whitespace(int *var
)
3253 char *token
= ConfigParser::NextToken();
3258 if (!strcmp(token
, "strip"))
3259 *var
= URI_WHITESPACE_STRIP
;
3260 else if (!strcmp(token
, "deny"))
3261 *var
= URI_WHITESPACE_DENY
;
3262 else if (!strcmp(token
, "allow"))
3263 *var
= URI_WHITESPACE_ALLOW
;
3264 else if (!strcmp(token
, "encode"))
3265 *var
= URI_WHITESPACE_ENCODE
;
3266 else if (!strcmp(token
, "chop"))
3267 *var
= URI_WHITESPACE_CHOP
;
3269 debugs(0, DBG_PARSE_NOTE(2), "ERROR: Invalid option '" << token
<< "': 'uri_whitespace' accepts 'strip', 'deny', 'allow', 'encode', and 'chop'.");
3275 dump_uri_whitespace(StoreEntry
* entry
, const char *name
, int var
)
3279 if (var
== URI_WHITESPACE_ALLOW
)
3281 else if (var
== URI_WHITESPACE_ENCODE
)
3283 else if (var
== URI_WHITESPACE_CHOP
)
3285 else if (var
== URI_WHITESPACE_DENY
)
3290 storeAppendPrintf(entry
, "%s %s\n", name
, s
);
3294 free_removalpolicy(RemovalPolicySettings
** settings
)
3299 free_string(&(*settings
)->type
);
3301 free_wordlist(&(*settings
)->args
);
3309 parse_removalpolicy(RemovalPolicySettings
** settings
)
3312 free_removalpolicy(settings
);
3314 *settings
= new RemovalPolicySettings
;
3316 parse_string(&(*settings
)->type
);
3318 parse_wordlist(&(*settings
)->args
);
3322 dump_removalpolicy(StoreEntry
* entry
, const char *name
, RemovalPolicySettings
* settings
)
3325 storeAppendPrintf(entry
, "%s %s", name
, settings
->type
);
3326 args
= settings
->args
;
3329 storeAppendPrintf(entry
, " %s", args
->key
);
3333 storeAppendPrintf(entry
, "\n");
3337 free_YesNoNone(YesNoNone
*)
3341 parse_YesNoNone(YesNoNone
*option
)
3344 parse_onoff(&value
);
3345 option
->configure(value
> 0);
3349 dump_YesNoNone(StoreEntry
* entry
, const char *name
, YesNoNone
&option
)
3351 if (option
.configured())
3352 dump_onoff(entry
, name
, option
? 1 : 0);
3356 free_memcachemode(SquidConfig
*)
3360 parse_memcachemode(SquidConfig
*)
3362 char *token
= ConfigParser::NextToken();
3366 if (strcmp(token
, "always") == 0) {
3367 Config
.onoff
.memory_cache_first
= 1;
3368 Config
.onoff
.memory_cache_disk
= 1;
3369 } else if (strcmp(token
, "disk") == 0) {
3370 Config
.onoff
.memory_cache_first
= 0;
3371 Config
.onoff
.memory_cache_disk
= 1;
3372 } else if (strncmp(token
, "net", 3) == 0) {
3373 Config
.onoff
.memory_cache_first
= 1;
3374 Config
.onoff
.memory_cache_disk
= 0;
3375 } else if (strcmp(token
, "never") == 0) {
3376 Config
.onoff
.memory_cache_first
= 0;
3377 Config
.onoff
.memory_cache_disk
= 0;
3379 debugs(0, DBG_PARSE_NOTE(2), "ERROR: Invalid option '" << token
<< "': 'memory_cache_mode' accepts 'always', 'disk', 'network', and 'never'.");
3385 dump_memcachemode(StoreEntry
* entry
, const char *name
, SquidConfig
&)
3387 storeAppendPrintf(entry
, "%s ", name
);
3388 if (Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3389 storeAppendPrintf(entry
, "always");
3390 else if (!Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3391 storeAppendPrintf(entry
, "disk");
3392 else if (Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3393 storeAppendPrintf(entry
, "network");
3394 else if (!Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3395 storeAppendPrintf(entry
, "none");
3396 storeAppendPrintf(entry
, "\n");
3399 #include "cf_parser.cci"
3402 parseNeighborType(const char *s
)
3404 if (!strcmp(s
, "parent"))
3407 if (!strcmp(s
, "neighbor"))
3408 return PEER_SIBLING
;
3410 if (!strcmp(s
, "neighbour"))
3411 return PEER_SIBLING
;
3413 if (!strcmp(s
, "sibling"))
3414 return PEER_SIBLING
;
3416 if (!strcmp(s
, "multicast"))
3417 return PEER_MULTICAST
;
3419 debugs(15, DBG_CRITICAL
, "WARNING: Unknown neighbor type: " << s
);
3421 return PEER_SIBLING
;
3426 parse_IpAddress_list(Ip::Address_list
** head
)
3429 Ip::Address_list
*s
;
3432 while ((token
= ConfigParser::NextToken())) {
3433 if (GetHostWithPort(token
, &ipa
)) {
3436 head
= &(*head
)->next
;
3438 s
= static_cast<Ip::Address_list
*>(xcalloc(1, sizeof(*s
)));
3448 dump_IpAddress_list(StoreEntry
* e
, const char *n
, const Ip::Address_list
* s
)
3450 char ntoabuf
[MAX_IPSTRLEN
];
3453 storeAppendPrintf(e
, "%s %s\n",
3455 s
->s
.toStr(ntoabuf
,MAX_IPSTRLEN
));
3461 free_IpAddress_list(Ip::Address_list
** head
)
3463 if (*head
) delete *head
;
3467 #if CURRENTLY_UNUSED
3468 /* This code was previously used by http_port. Left as it really should
3469 * be used by icp_port and htcp_port
3472 check_null_IpAddress_list(const Ip::Address_list
* s
)
3477 #endif /* CURRENTLY_UNUSED */
3478 #endif /* USE_WCCPv2 */
3481 parsePortSpecification(const AnyP::PortCfgPointer
&s
, char *token
)
3484 unsigned short port
= 0;
3488 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3489 s
->name
= xstrdup(token
);
3490 s
->connection_auth_disabled
= false;
3492 const char *portType
= AnyP::UriScheme(s
->transport
.protocol
).c_str();
3494 if (*token
== '[') {
3497 t
= strchr(host
, ']');
3499 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing ']' on IPv6 address: " << token
);
3505 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing Port in: " << token
);
3508 if (!Ip::EnableIpv6
) {
3509 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: IPv6 is not available.");
3512 port
= xatos(t
+ 1);
3513 } else if ((t
= strchr(token
, ':'))) {
3518 port
= xatos(t
+ 1);
3520 } else if (strtol(token
, &junk
, 10) && !*junk
) {
3521 port
= xatos(token
);
3522 debugs(3, 3, portType
<< "_port: found Listen on Port: " << port
);
3524 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing Port: " << token
);
3528 if (port
== 0 && host
!= NULL
) {
3529 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: Port cannot be 0: " << token
);
3536 if (!Ip::EnableIpv6
)
3538 debugs(3, 3, portType
<< "_port: found Listen on wildcard address: *:" << s
->s
.port());
3539 } else if ( (s
->s
= host
) ) { /* check/parse numeric IPA */
3541 if (!Ip::EnableIpv6
)
3543 debugs(3, 3, portType
<< "_port: Listen on Host/IP: " << host
<< " --> " << s
->s
);
3544 } else if ( s
->s
.GetHostByName(host
) ) { /* check/parse for FQDN */
3545 /* dont use ipcache */
3546 s
->defaultsite
= xstrdup(host
);
3548 if (!Ip::EnableIpv6
)
3550 debugs(3, 3, portType
<< "_port: found Listen as Host " << s
->defaultsite
<< " on IP: " << s
->s
);
3552 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: failed to resolve Host/IP: " << host
);
3557 /// parses the protocol= option of the *_port directive, returning parsed value
3558 /// unsupported option values result in a fatal error message
3559 /// upper case values required; caller may convert for backward compatibility
3560 static AnyP::ProtocolVersion
3561 parsePortProtocol(const SBuf
&value
)
3563 // HTTP/1.0 not supported because we are version 1.1 which contains a superset of 1.0
3564 // and RFC 2616 requires us to upgrade 1.0 to 1.1
3565 if (value
.cmp("HTTP") == 0 || value
.cmp("HTTP/1.1") == 0)
3566 return AnyP::ProtocolVersion(AnyP::PROTO_HTTP
, 1,1);
3568 if (value
.cmp("HTTPS") == 0 || value
.cmp("HTTPS/1.1") == 0)
3569 return AnyP::ProtocolVersion(AnyP::PROTO_HTTPS
, 1,1);
3571 if (value
.cmp("FTP") == 0)
3572 return Ftp::ProtocolVersion();
3574 fatalf("%s directive does not support protocol=" SQUIDSBUFPH
"\n", cfg_directive
, SQUIDSBUFPRINT(value
));
3575 return AnyP::ProtocolVersion(); // not reached
3579 parse_port_option(AnyP::PortCfgPointer
&s
, char *token
)
3583 if (strcmp(token
, "accel") == 0) {
3584 if (s
->flags
.isIntercepted()) {
3585 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": Accelerator mode requires its own port. It cannot be shared with other modes.");
3588 s
->flags
.accelSurrogate
= true;
3590 } else if (strcmp(token
, "transparent") == 0 || strcmp(token
, "intercept") == 0) {
3591 if (s
->flags
.accelSurrogate
|| s
->flags
.tproxyIntercept
) {
3592 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": Intercept mode requires its own interception port. It cannot be shared with other modes.");
3595 s
->flags
.natIntercept
= true;
3596 Ip::Interceptor
.StartInterception();
3597 /* Log information regarding the port modes under interception. */
3598 debugs(3, DBG_IMPORTANT
, "Starting Authentication on port " << s
->s
);
3599 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (interception enabled)");
3600 } else if (strcmp(token
, "tproxy") == 0) {
3601 if (s
->flags
.natIntercept
|| s
->flags
.accelSurrogate
) {
3602 debugs(3,DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": TPROXY option requires its own interception port. It cannot be shared with other modes.");
3605 s
->flags
.tproxyIntercept
= true;
3606 Ip::Interceptor
.StartTransparency();
3607 /* Log information regarding the port modes under transparency. */
3608 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (TPROXY enabled)");
3610 if (s
->flags
.proxySurrogate
) {
3611 debugs(3, DBG_IMPORTANT
, "Disabling TPROXY Spoofing on port " << s
->s
<< " (require-proxy-header enabled)");
3614 if (!Ip::Interceptor
.ProbeForTproxy(s
->s
)) {
3615 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": TPROXY support in the system does not work.");
3619 } else if (strcmp(token
, "require-proxy-header") == 0) {
3620 s
->flags
.proxySurrogate
= true;
3621 if (s
->flags
.tproxyIntercept
) {
3622 // receiving is still permitted, so we do not unset the TPROXY flag
3623 // spoofing access control override takes care of the spoof disable later
3624 debugs(3, DBG_IMPORTANT
, "Disabling TPROXY Spoofing on port " << s
->s
<< " (require-proxy-header enabled)");
3627 } else if (strncmp(token
, "defaultsite=", 12) == 0) {
3628 if (!s
->flags
.accelSurrogate
) {
3629 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": defaultsite option requires Acceleration mode flag.");
3632 safe_free(s
->defaultsite
);
3633 s
->defaultsite
= xstrdup(token
+ 12);
3634 } else if (strcmp(token
, "vhost") == 0) {
3635 if (!s
->flags
.accelSurrogate
) {
3636 debugs(3, DBG_CRITICAL
, "WARNING: " << cfg_directive
<< ": vhost option is deprecated. Use 'accel' mode flag instead.");
3638 s
->flags
.accelSurrogate
= true;
3640 } else if (strcmp(token
, "no-vhost") == 0) {
3641 if (!s
->flags
.accelSurrogate
) {
3642 debugs(3, DBG_IMPORTANT
, "ERROR: " << cfg_directive
<< ": no-vhost option requires Acceleration mode flag.");
3645 } else if (strcmp(token
, "vport") == 0) {
3646 if (!s
->flags
.accelSurrogate
) {
3647 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": vport option requires Acceleration mode flag.");
3651 } else if (strncmp(token
, "vport=", 6) == 0) {
3652 if (!s
->flags
.accelSurrogate
) {
3653 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": vport option requires Acceleration mode flag.");
3656 s
->vport
= xatos(token
+ 6);
3657 } else if (strncmp(token
, "protocol=", 9) == 0) {
3658 if (!s
->flags
.accelSurrogate
) {
3659 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": protocol option requires Acceleration mode flag.");
3662 s
->transport
= parsePortProtocol(ToUpper(SBuf(token
+ 9)));
3663 } else if (strcmp(token
, "allow-direct") == 0) {
3664 if (!s
->flags
.accelSurrogate
) {
3665 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": allow-direct option requires Acceleration mode flag.");
3668 s
->allow_direct
= true;
3669 } else if (strcmp(token
, "act-as-origin") == 0) {
3670 if (!s
->flags
.accelSurrogate
) {
3671 debugs(3, DBG_IMPORTANT
, "ERROR: " << cfg_directive
<< ": act-as-origin option requires Acceleration mode flag.");
3673 s
->actAsOrigin
= true;
3674 } else if (strcmp(token
, "ignore-cc") == 0) {
3675 #if !USE_HTTP_VIOLATIONS
3676 if (!s
->flags
.accelSurrogate
) {
3677 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": ignore-cc option requires Acceleration mode flag.");
3681 s
->ignore_cc
= true;
3682 } else if (strncmp(token
, "name=", 5) == 0) {
3684 s
->name
= xstrdup(token
+ 5);
3685 } else if (strcmp(token
, "no-connection-auth") == 0) {
3686 s
->connection_auth_disabled
= true;
3687 } else if (strcmp(token
, "connection-auth=off") == 0) {
3688 s
->connection_auth_disabled
= true;
3689 } else if (strcmp(token
, "connection-auth") == 0) {
3690 s
->connection_auth_disabled
= false;
3691 } else if (strcmp(token
, "connection-auth=on") == 0) {
3692 s
->connection_auth_disabled
= false;
3693 } else if (strncmp(token
, "disable-pmtu-discovery=", 23) == 0) {
3694 if (!strcmp(token
+ 23, "off"))
3695 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3696 else if (!strcmp(token
+ 23, "transparent"))
3697 s
->disable_pmtu_discovery
= DISABLE_PMTU_TRANSPARENT
;
3698 else if (!strcmp(token
+ 23, "always"))
3699 s
->disable_pmtu_discovery
= DISABLE_PMTU_ALWAYS
;
3702 } else if (strcmp(token
, "ipv4") == 0) {
3703 if ( !s
->s
.setIPv4() ) {
3704 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": IPv6 addresses cannot be used as IPv4-Only. " << s
->s
);
3707 } else if (strcmp(token
, "tcpkeepalive") == 0) {
3708 s
->tcp_keepalive
.enabled
= true;
3709 } else if (strncmp(token
, "tcpkeepalive=", 13) == 0) {
3710 char *t
= token
+ 13;
3711 s
->tcp_keepalive
.enabled
= true;
3712 s
->tcp_keepalive
.idle
= xatoui(t
,',');
3716 s
->tcp_keepalive
.interval
= xatoui(t
,',');
3721 s
->tcp_keepalive
.timeout
= xatoui(t
);
3724 } else if (strcmp(token
, "sslBump") == 0) {
3725 debugs(3, DBG_CRITICAL
, "WARNING: '" << token
<< "' is deprecated " <<
3726 "in " << cfg_directive
<< ". Use 'ssl-bump' instead.");
3727 s
->flags
.tunnelSslBumping
= true;
3728 } else if (strcmp(token
, "ssl-bump") == 0) {
3729 s
->flags
.tunnelSslBumping
= true;
3730 } else if (strncmp(token
, "cert=", 5) == 0) {
3732 s
->cert
= xstrdup(token
+ 5);
3733 } else if (strncmp(token
, "key=", 4) == 0) {
3735 s
->key
= xstrdup(token
+ 4);
3736 } else if (strncmp(token
, "version=", 8) == 0) {
3737 s
->version
= xatoi(token
+ 8);
3738 if (s
->version
< 1 || s
->version
> 4)
3740 } else if (strncmp(token
, "options=", 8) == 0) {
3741 safe_free(s
->options
);
3742 s
->options
= xstrdup(token
+ 8);
3743 } else if (strncmp(token
, "cipher=", 7) == 0) {
3744 safe_free(s
->cipher
);
3745 s
->cipher
= xstrdup(token
+ 7);
3746 } else if (strncmp(token
, "clientca=", 9) == 0) {
3747 safe_free(s
->clientca
);
3748 s
->clientca
= xstrdup(token
+ 9);
3749 } else if (strncmp(token
, "cafile=", 7) == 0) {
3750 safe_free(s
->cafile
);
3751 s
->cafile
= xstrdup(token
+ 7);
3752 } else if (strncmp(token
, "capath=", 7) == 0) {
3753 safe_free(s
->capath
);
3754 s
->capath
= xstrdup(token
+ 7);
3755 } else if (strncmp(token
, "crlfile=", 8) == 0) {
3756 safe_free(s
->crlfile
);
3757 s
->crlfile
= xstrdup(token
+ 8);
3758 } else if (strncmp(token
, "dhparams=", 9) == 0) {
3759 safe_free(s
->dhfile
);
3760 s
->dhfile
= xstrdup(token
+ 9);
3761 } else if (strncmp(token
, "sslflags=", 9) == 0) {
3762 safe_free(s
->sslflags
);
3763 s
->sslflags
= xstrdup(token
+ 9);
3764 } else if (strncmp(token
, "sslcontext=", 11) == 0) {
3765 safe_free(s
->sslContextSessionId
);
3766 s
->sslContextSessionId
= xstrdup(token
+ 11);
3767 } else if (strcmp(token
, "generate-host-certificates") == 0) {
3768 s
->generateHostCertificates
= true;
3769 } else if (strcmp(token
, "generate-host-certificates=on") == 0) {
3770 s
->generateHostCertificates
= true;
3771 } else if (strcmp(token
, "generate-host-certificates=off") == 0) {
3772 s
->generateHostCertificates
= false;
3773 } else if (strncmp(token
, "dynamic_cert_mem_cache_size=", 28) == 0) {
3774 parseBytesOptionValue(&s
->dynamicCertMemCacheSize
, B_BYTES_STR
, token
+ 28);
3776 } else if (strcmp(token
, "ftp-track-dirs") == 0) {
3777 s
->ftp_track_dirs
= true;
3779 debugs(3, DBG_CRITICAL
, "FATAL: Unknown " << cfg_directive
<< " option '" << token
<< "'.");
3785 add_http_port(char *portspec
)
3787 AnyP::PortCfgPointer s
= new AnyP::PortCfg();
3788 s
->transport
= parsePortProtocol(SBuf("HTTP"));
3789 parsePortSpecification(s
, portspec
);
3790 // we may need to merge better if the above returns a list with clones
3791 assert(s
->next
== NULL
);
3792 s
->next
= HttpPortList
;
3797 parsePortCfg(AnyP::PortCfgPointer
*head
, const char *optionName
)
3800 if (strcmp(optionName
, "http_port") == 0 ||
3801 strcmp(optionName
, "ascii_port") == 0)
3803 else if (strcmp(optionName
, "https_port") == 0)
3804 protoName
= "HTTPS";
3805 else if (strcmp(optionName
, "ftp_port") == 0)
3807 if (protoName
.isEmpty()) {
3812 char *token
= ConfigParser::NextToken();
3819 AnyP::PortCfgPointer s
= new AnyP::PortCfg();
3820 s
->transport
= parsePortProtocol(protoName
); // default; protocol=... overwrites
3821 parsePortSpecification(s
, token
);
3823 /* parse options ... */
3824 while ((token
= ConfigParser::NextToken())) {
3825 parse_port_option(s
, token
);
3828 if (s
->transport
.protocol
== AnyP::PROTO_HTTPS
) {
3830 /* ssl-bump on https_port configuration requires either tproxy or intercept, and vice versa */
3831 const bool hijacked
= s
->flags
.isIntercepted();
3832 if (s
->flags
.tunnelSslBumping
&& !hijacked
) {
3833 debugs(3, DBG_CRITICAL
, "FATAL: ssl-bump on https_port requires tproxy/intercept which is missing.");
3836 if (hijacked
&& !s
->flags
.tunnelSslBumping
) {
3837 debugs(3, DBG_CRITICAL
, "FATAL: tproxy/intercept on https_port requires ssl-bump which is missing.");
3841 if (s
->flags
.proxySurrogate
) {
3842 debugs(3,DBG_CRITICAL
, "FATAL: https_port: require-proxy-header option is not supported on HTTPS ports.");
3845 } else if (protoName
.cmp("FTP") == 0) {
3846 /* ftp_port does not support ssl-bump */
3847 if (s
->flags
.tunnelSslBumping
) {
3848 debugs(3, DBG_CRITICAL
, "FATAL: ssl-bump is not supported for ftp_port.");
3851 if (s
->flags
.proxySurrogate
) {
3852 // Passive FTP data channel does not work without deep protocol inspection in the frontend.
3853 debugs(3,DBG_CRITICAL
, "FATAL: require-proxy-header option is not supported on ftp_port.");
3858 if (Ip::EnableIpv6
&IPV6_SPECIAL_SPLITSTACK
&& s
->s
.isAnyAddr()) {
3859 // clone the port options from *s to *(s->next)
3860 s
->next
= s
->clone();
3861 s
->next
->s
.setIPv4();
3862 debugs(3, 3, AnyP::UriScheme(s
->transport
.protocol
).c_str() << "_port: clone wildcard address for split-stack: " << s
->s
<< " and " << s
->next
->s
);
3865 while (*head
!= NULL
)
3866 head
= &((*head
)->next
);
3872 dump_generic_port(StoreEntry
* e
, const char *n
, const AnyP::PortCfgPointer
&s
)
3874 char buf
[MAX_IPSTRLEN
];
3876 storeAppendPrintf(e
, "%s %s",
3878 s
->s
.toUrl(buf
,MAX_IPSTRLEN
));
3880 // MODES and specific sub-options.
3881 if (s
->flags
.natIntercept
)
3882 storeAppendPrintf(e
, " intercept");
3884 else if (s
->flags
.tproxyIntercept
)
3885 storeAppendPrintf(e
, " tproxy");
3887 else if (s
->flags
.proxySurrogate
)
3888 storeAppendPrintf(e
, " require-proxy-header");
3890 else if (s
->flags
.accelSurrogate
) {
3891 storeAppendPrintf(e
, " accel");
3894 storeAppendPrintf(e
, " vhost");
3897 storeAppendPrintf(e
, " vport");
3898 else if (s
->vport
> 0)
3899 storeAppendPrintf(e
, " vport=%d", s
->vport
);
3902 storeAppendPrintf(e
, " defaultsite=%s", s
->defaultsite
);
3904 // TODO: compare against prefix of 'n' instead of assuming http_port
3905 if (s
->transport
.protocol
!= AnyP::PROTO_HTTP
)
3906 storeAppendPrintf(e
, " protocol=%s", AnyP::UriScheme(s
->transport
.protocol
).c_str());
3908 if (s
->allow_direct
)
3909 storeAppendPrintf(e
, " allow-direct");
3912 storeAppendPrintf(e
, " ignore-cc");
3916 // Generic independent options
3919 storeAppendPrintf(e
, " name=%s", s
->name
);
3921 #if USE_HTTP_VIOLATIONS
3922 if (!s
->flags
.accelSurrogate
&& s
->ignore_cc
)
3923 storeAppendPrintf(e
, " ignore-cc");
3926 if (s
->connection_auth_disabled
)
3927 storeAppendPrintf(e
, " connection-auth=off");
3929 storeAppendPrintf(e
, " connection-auth=on");
3931 if (s
->disable_pmtu_discovery
!= DISABLE_PMTU_OFF
) {
3934 if (s
->disable_pmtu_discovery
== DISABLE_PMTU_ALWAYS
)
3937 pmtu
= "transparent";
3939 storeAppendPrintf(e
, " disable-pmtu-discovery=%s", pmtu
);
3942 if (s
->s
.isAnyAddr() && !s
->s
.isIPv6())
3943 storeAppendPrintf(e
, " ipv4");
3945 if (s
->tcp_keepalive
.enabled
) {
3946 if (s
->tcp_keepalive
.idle
|| s
->tcp_keepalive
.interval
|| s
->tcp_keepalive
.timeout
) {
3947 storeAppendPrintf(e
, " tcpkeepalive=%d,%d,%d", s
->tcp_keepalive
.idle
, s
->tcp_keepalive
.interval
, s
->tcp_keepalive
.timeout
);
3949 storeAppendPrintf(e
, " tcpkeepalive");
3954 if (s
->flags
.tunnelSslBumping
)
3955 storeAppendPrintf(e
, " ssl-bump");
3958 storeAppendPrintf(e
, " cert=%s", s
->cert
);
3961 storeAppendPrintf(e
, " key=%s", s
->key
);
3964 storeAppendPrintf(e
, " version=%d", s
->version
);
3967 storeAppendPrintf(e
, " options=%s", s
->options
);
3970 storeAppendPrintf(e
, " cipher=%s", s
->cipher
);
3973 storeAppendPrintf(e
, " cafile=%s", s
->cafile
);
3976 storeAppendPrintf(e
, " capath=%s", s
->capath
);
3979 storeAppendPrintf(e
, " crlfile=%s", s
->crlfile
);
3982 storeAppendPrintf(e
, " dhparams=%s", s
->dhfile
);
3985 storeAppendPrintf(e
, " sslflags=%s", s
->sslflags
);
3987 if (s
->sslContextSessionId
)
3988 storeAppendPrintf(e
, " sslcontext=%s", s
->sslContextSessionId
);
3990 if (s
->generateHostCertificates
)
3991 storeAppendPrintf(e
, " generate-host-certificates");
3993 if (s
->dynamicCertMemCacheSize
!= std::numeric_limits
<size_t>::max())
3994 storeAppendPrintf(e
, "dynamic_cert_mem_cache_size=%lu%s\n", (unsigned long)s
->dynamicCertMemCacheSize
, B_BYTES_STR
);
3999 dump_PortCfg(StoreEntry
* e
, const char *n
, const AnyP::PortCfgPointer
&s
)
4001 for (AnyP::PortCfgPointer p
= s
; p
!= NULL
; p
= p
->next
) {
4002 dump_generic_port(e
, n
, p
);
4003 storeAppendPrintf(e
, "\n");
4008 configFreeMemory(void)
4012 SSL_CTX_free(Config
.ssl_client
.sslContext
);
4017 requirePathnameExists(const char *name
, const char *path
)
4021 char pathbuf
[BUFSIZ
];
4022 assert(path
!= NULL
);
4024 if (Config
.chroot_dir
&& (geteuid() == 0)) {
4025 snprintf(pathbuf
, BUFSIZ
, "%s/%s", Config
.chroot_dir
, path
);
4029 if (stat(path
, &sb
) < 0) {
4030 debugs(0, DBG_CRITICAL
, (opt_parse_cfg_only
?"FATAL ":"") << "ERROR: " << name
<< " " << path
<< ": " << xstrerror());
4031 // keep going to find more issues if we are only checking the config file with "-k parse"
4032 if (opt_parse_cfg_only
)
4034 // this is fatal if it is found during startup or reconfigure
4035 if (opt_send_signal
== -1 || opt_send_signal
== SIGHUP
)
4036 fatalf("%s %s: %s", name
, path
, xstrerror());
4043 return ConfigParser::strtokFile();
4046 #include "AccessLogEntry.h"
4049 * We support several access_log configuration styles:
4051 * #1: Deprecated ancient style without an explicit logging module:
4052 * access_log /var/log/access.log
4054 * #2: The "none" logging module (i.e., no logging [of matching transactions]):
4055 * access_log none [acl ...]
4057 * #3: Configurable logging module without named options:
4058 * Logformat or the first ACL name, whichever comes first, may not contain '='.
4059 * If no explicit logformat name is given, the first ACL name, if any,
4060 * should not be an existing logformat name or it will be treated as such.
4061 * access_log module:place [logformat_name] [acl ...]
4063 * #4: Configurable logging module with name=value options such as logformat=x:
4064 * The first ACL name may not contain '='.
4065 * access_log module:place [option ...] [acl ...]
4069 parse_access_log(CustomLog
** logs
)
4071 CustomLog
*cl
= (CustomLog
*)xcalloc(1, sizeof(*cl
));
4073 // default buffer size and fatal settings
4074 cl
->bufferSize
= 8*MAX_URL
;
4077 /* determine configuration style */
4079 const char *filename
= ConfigParser::NextToken();
4085 if (strcmp(filename
, "none") == 0) {
4086 cl
->type
= Log::Format::CLF_NONE
;
4087 aclParseAclList(LegacyParser
, &cl
->aclList
, filename
);
4089 logs
= &(*logs
)->next
;
4094 cl
->filename
= xstrdup(filename
);
4095 cl
->type
= Log::Format::CLF_UNKNOWN
;
4097 const char *token
= ConfigParser::PeekAtToken();
4098 if (!token
) { // style #1
4099 // no options to deal with
4100 } else if (!strchr(token
, '=')) { // style #3
4101 // if logformat name is recognized,
4102 // pop the previewed token; Else it must be an ACL name
4103 if (setLogformat(cl
, token
, false))
4104 (void)ConfigParser::NextToken();
4105 } else { // style #4
4107 if (strncasecmp(token
, "on-error=", 9) == 0) {
4108 if (strncasecmp(token
+9, "die", 3) == 0) {
4110 } else if (strncasecmp(token
+9, "drop", 4) == 0) {
4113 debugs(3, DBG_CRITICAL
, "Unknown value for on-error '" <<
4114 token
<< "' expected 'drop' or 'die'");
4117 } else if (strncasecmp(token
, "buffer-size=", 12) == 0) {
4118 parseBytesOptionValue(&cl
->bufferSize
, B_BYTES_STR
, token
+12);
4119 } else if (strncasecmp(token
, "logformat=", 10) == 0) {
4120 setLogformat(cl
, token
+10, true);
4121 } else if (!strchr(token
, '=')) {
4122 // Do not pop the token; it must be an ACL name
4123 break; // done with name=value options, now to ACLs
4125 debugs(3, DBG_CRITICAL
, "Unknown access_log option " << token
);
4128 // Pop the token, it was a valid "name=value" option
4129 (void)ConfigParser::NextToken();
4130 // Get next with preview ConfigParser::NextToken call.
4131 } while ((token
= ConfigParser::PeekAtToken()) != NULL
);
4134 // set format if it has not been specified explicitly
4135 if (cl
->type
== Log::Format::CLF_UNKNOWN
)
4136 setLogformat(cl
, "squid", true);
4138 aclParseAclList(LegacyParser
, &cl
->aclList
, cl
->filename
);
4141 logs
= &(*logs
)->next
;
4146 /// sets CustomLog::type and, if needed, CustomLog::lf
4147 /// returns false iff there is no named log format
4149 setLogformat(CustomLog
*cl
, const char *logdef_name
, const bool dieWhenMissing
)
4152 assert(logdef_name
);
4154 debugs(3, 9, "possible " << cl
->filename
<< " logformat: " << logdef_name
);
4156 if (cl
->type
!= Log::Format::CLF_UNKNOWN
) {
4157 debugs(3, DBG_CRITICAL
, "Second logformat name in one access_log: " <<
4158 logdef_name
<< " " << cl
->type
<< " ? " << Log::Format::CLF_NONE
);
4163 /* look for the definition pointer corresponding to this name */
4164 Format::Format
*lf
= Log::TheConfig
.logformats
;
4166 while (lf
!= NULL
) {
4167 debugs(3, 9, "Comparing against '" << lf
->name
<< "'");
4169 if (strcmp(lf
->name
, logdef_name
) == 0)
4176 cl
->type
= Log::Format::CLF_CUSTOM
;
4178 } else if (strcmp(logdef_name
, "auto") == 0) {
4179 debugs(0, DBG_CRITICAL
, "WARNING: Log format 'auto' no longer exists. Using 'squid' instead.");
4180 cl
->type
= Log::Format::CLF_SQUID
;
4181 } else if (strcmp(logdef_name
, "squid") == 0) {
4182 cl
->type
= Log::Format::CLF_SQUID
;
4183 } else if (strcmp(logdef_name
, "common") == 0) {
4184 cl
->type
= Log::Format::CLF_COMMON
;
4185 } else if (strcmp(logdef_name
, "combined") == 0) {
4186 cl
->type
= Log::Format::CLF_COMBINED
;
4188 } else if (strcmp(logdef_name
, "icap_squid") == 0) {
4189 cl
->type
= Log::Format::CLF_ICAP_SQUID
;
4191 } else if (strcmp(logdef_name
, "useragent") == 0) {
4192 cl
->type
= Log::Format::CLF_USERAGENT
;
4193 } else if (strcmp(logdef_name
, "referrer") == 0) {
4194 cl
->type
= Log::Format::CLF_REFERER
;
4195 } else if (dieWhenMissing
) {
4196 debugs(3, DBG_CRITICAL
, "Log format '" << logdef_name
<< "' is not defined");
4207 check_null_access_log(CustomLog
*customlog_definitions
)
4209 return customlog_definitions
== NULL
;
4213 dump_access_log(StoreEntry
* entry
, const char *name
, CustomLog
* logs
)
4217 for (log
= logs
; log
; log
= log
->next
) {
4218 storeAppendPrintf(entry
, "%s ", name
);
4220 switch (log
->type
) {
4222 case Log::Format::CLF_CUSTOM
:
4223 storeAppendPrintf(entry
, "%s %s", log
->filename
, log
->logFormat
->name
);
4226 case Log::Format::CLF_NONE
:
4227 storeAppendPrintf(entry
, "none");
4230 case Log::Format::CLF_SQUID
:
4231 storeAppendPrintf(entry
, "%s squid", log
->filename
);
4234 case Log::Format::CLF_COMBINED
:
4235 storeAppendPrintf(entry
, "%s combined", log
->filename
);
4238 case Log::Format::CLF_COMMON
:
4239 storeAppendPrintf(entry
, "%s common", log
->filename
);
4243 case Log::Format::CLF_ICAP_SQUID
:
4244 storeAppendPrintf(entry
, "%s icap_squid", log
->filename
);
4247 case Log::Format::CLF_USERAGENT
:
4248 storeAppendPrintf(entry
, "%s useragent", log
->filename
);
4251 case Log::Format::CLF_REFERER
:
4252 storeAppendPrintf(entry
, "%s referrer", log
->filename
);
4255 case Log::Format::CLF_UNKNOWN
:
4260 dump_acl_list(entry
, log
->aclList
);
4262 storeAppendPrintf(entry
, "\n");
4267 free_access_log(CustomLog
** definitions
)
4269 while (*definitions
) {
4270 CustomLog
*log
= *definitions
;
4271 *definitions
= log
->next
;
4273 log
->logFormat
= NULL
;
4274 log
->type
= Log::Format::CLF_UNKNOWN
;
4277 aclDestroyAclList(&log
->aclList
);
4279 safe_free(log
->filename
);
4285 /// parses list of integers form name=N1,N2,N3,...
4287 parseNamedIntList(const char *data
, const String
&name
, std::vector
<int> &list
)
4289 if (data
&& (strncmp(data
, name
.rawBuf(), name
.size()) == 0)) {
4290 data
+= name
.size();
4295 if (!StringToInt(data
, value
, &data
, 10))
4297 list
.push_back(value
);
4298 if (*data
== '\0' || *data
!= ',')
4303 return data
&& *data
== '\0';
4307 parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4309 #if !HAVE_CPU_AFFINITY
4310 debugs(3, DBG_CRITICAL
, "FATAL: Squid built with no CPU affinity " <<
4311 "support, do not set 'cpu_affinity_map'");
4313 #endif /* HAVE_CPU_AFFINITY */
4315 if (!*cpuAffinityMap
)
4316 *cpuAffinityMap
= new CpuAffinityMap
;
4318 const char *const pToken
= ConfigParser::NextToken();
4319 const char *const cToken
= ConfigParser::NextToken();
4320 std::vector
<int> processes
, cores
;
4321 if (!parseNamedIntList(pToken
, "process_numbers", processes
)) {
4322 debugs(3, DBG_CRITICAL
, "FATAL: bad 'process_numbers' parameter " <<
4323 "in 'cpu_affinity_map'");
4325 } else if (!parseNamedIntList(cToken
, "cores", cores
)) {
4326 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cores' parameter in " <<
4327 "'cpu_affinity_map'");
4329 } else if (!(*cpuAffinityMap
)->add(processes
, cores
)) {
4330 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cpu_affinity_map'; " <<
4331 "process_numbers and cores lists differ in length or " <<
4332 "contain numbers <= 0");
4338 dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
)
4340 if (cpuAffinityMap
) {
4341 storeAppendPrintf(entry
, "%s process_numbers=", name
);
4342 for (size_t i
= 0; i
< cpuAffinityMap
->processes().size(); ++i
) {
4343 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4344 cpuAffinityMap
->processes()[i
]);
4346 storeAppendPrintf(entry
, " cores=");
4347 for (size_t i
= 0; i
< cpuAffinityMap
->cores().size(); ++i
) {
4348 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4349 cpuAffinityMap
->cores()[i
]);
4351 storeAppendPrintf(entry
, "\n");
4356 free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4358 delete *cpuAffinityMap
;
4359 *cpuAffinityMap
= NULL
;
4365 parse_adaptation_service_set_type()
4367 Adaptation::Config::ParseServiceSet();
4371 parse_adaptation_service_chain_type()
4373 Adaptation::Config::ParseServiceChain();
4377 parse_adaptation_access_type()
4379 Adaptation::Config::ParseAccess(LegacyParser
);
4381 #endif /* USE_ADAPTATION */
4386 parse_icap_service_type(Adaptation::Icap::Config
* cfg
)
4388 cfg
->parseService();
4392 free_icap_service_type(Adaptation::Icap::Config
* cfg
)
4398 dump_icap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4400 cfg
.dumpService(entry
, name
);
4404 parse_icap_class_type()
4406 debugs(93, DBG_CRITICAL
, "WARNING: 'icap_class' is depricated. " <<
4407 "Use 'adaptation_service_set' instead");
4408 Adaptation::Config::ParseServiceSet();
4412 parse_icap_access_type()
4414 debugs(93, DBG_CRITICAL
, "WARNING: 'icap_access' is depricated. " <<
4415 "Use 'adaptation_access' instead");
4416 Adaptation::Config::ParseAccess(LegacyParser
);
4424 parse_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4426 cfg
->parseService();
4430 free_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4436 dump_ecap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Ecap::Config
&cfg
)
4438 cfg
.dumpService(entry
, name
);
4441 #endif /* USE_ECAP */
4444 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4449 cfg
->service_failure_limit
= GetInteger();
4451 if ((token
= ConfigParser::NextToken()) == NULL
)
4454 if (strcmp(token
,"in") != 0) {
4455 debugs(3, DBG_CRITICAL
, "expecting 'in' on'" << config_input_line
<< "'");
4459 if ((token
= ConfigParser::NextToken()) == NULL
) {
4463 d
= static_cast<time_t> (xatoi(token
));
4465 m
= static_cast<time_t> (1);
4469 else if ((token
= ConfigParser::NextToken()) == NULL
) {
4470 debugs(3, DBG_CRITICAL
, "No time-units on '" << config_input_line
<< "'");
4472 } else if ((m
= parseTimeUnits(token
, false)) == 0)
4475 cfg
->oldest_service_failure
= (m
* d
);
4478 static void dump_icap_service_failure_limit(StoreEntry
*entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4480 storeAppendPrintf(entry
, "%s %d", name
, cfg
.service_failure_limit
);
4481 if (cfg
.oldest_service_failure
> 0) {
4482 storeAppendPrintf(entry
, " in %d seconds", (int)cfg
.oldest_service_failure
);
4484 storeAppendPrintf(entry
, "\n");
4487 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4489 cfg
->oldest_service_failure
= 0;
4490 cfg
->service_failure_limit
= 0;
4495 static void parse_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
)
4498 sslproxy_cert_adapt
*ca
= (sslproxy_cert_adapt
*) xcalloc(1, sizeof(sslproxy_cert_adapt
));
4499 if ((al
= ConfigParser::NextToken()) == NULL
) {
4505 if ( char *s
= strchr(al
, '{')) {
4506 *s
= '\0'; // terminate the al string
4518 if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetValidAfter
]) == 0) {
4519 ca
->alg
= Ssl::algSetValidAfter
;
4520 ca
->param
= xstrdup("on");
4521 } else if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetValidBefore
]) == 0) {
4522 ca
->alg
= Ssl::algSetValidBefore
;
4523 ca
->param
= xstrdup("on");
4524 } else if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetCommonName
]) == 0) {
4525 ca
->alg
= Ssl::algSetCommonName
;
4527 if (strlen(param
) > 64) {
4528 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_adapt: setCommonName{" <<param
<< "} : using common name longer than 64 bytes is not supported");
4532 ca
->param
= xstrdup(param
);
4535 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_adapt: unknown cert adaptation algorithm: " << al
);
4540 aclParseAclList(LegacyParser
, &ca
->aclList
, al
);
4543 cert_adapt
= &(*cert_adapt
)->next
;
4548 static void dump_sslproxy_cert_adapt(StoreEntry
*entry
, const char *name
, sslproxy_cert_adapt
*cert_adapt
)
4550 for (sslproxy_cert_adapt
*ca
= cert_adapt
; ca
!= NULL
; ca
= ca
->next
) {
4551 storeAppendPrintf(entry
, "%s ", name
);
4552 storeAppendPrintf(entry
, "%s{%s} ", Ssl::sslCertAdaptAlgoritm(ca
->alg
), ca
->param
);
4554 dump_acl_list(entry
, ca
->aclList
);
4555 storeAppendPrintf(entry
, "\n");
4559 static void free_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
)
4561 while (*cert_adapt
) {
4562 sslproxy_cert_adapt
*ca
= *cert_adapt
;
4563 *cert_adapt
= ca
->next
;
4564 safe_free(ca
->param
);
4567 aclDestroyAclList(&ca
->aclList
);
4573 static void parse_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
)
4576 sslproxy_cert_sign
*cs
= (sslproxy_cert_sign
*) xcalloc(1, sizeof(sslproxy_cert_sign
));
4577 if ((al
= ConfigParser::NextToken()) == NULL
) {
4582 if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignTrusted
]) == 0)
4583 cs
->alg
= Ssl::algSignTrusted
;
4584 else if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignUntrusted
]) == 0)
4585 cs
->alg
= Ssl::algSignUntrusted
;
4586 else if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignSelf
]) == 0)
4587 cs
->alg
= Ssl::algSignSelf
;
4589 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_sign: unknown cert signing algorithm: " << al
);
4594 aclParseAclList(LegacyParser
, &cs
->aclList
, al
);
4597 cert_sign
= &(*cert_sign
)->next
;
4602 static void dump_sslproxy_cert_sign(StoreEntry
*entry
, const char *name
, sslproxy_cert_sign
*cert_sign
)
4604 sslproxy_cert_sign
*cs
;
4605 for (cs
= cert_sign
; cs
!= NULL
; cs
= cs
->next
) {
4606 storeAppendPrintf(entry
, "%s ", name
);
4607 storeAppendPrintf(entry
, "%s ", Ssl::certSignAlgorithm(cs
->alg
));
4609 dump_acl_list(entry
, cs
->aclList
);
4610 storeAppendPrintf(entry
, "\n");
4614 static void free_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
)
4616 while (*cert_sign
) {
4617 sslproxy_cert_sign
*cs
= *cert_sign
;
4618 *cert_sign
= cs
->next
;
4621 aclDestroyAclList(&cs
->aclList
);
4627 class sslBumpCfgRr
: public ::RegisteredRunner
4630 static Ssl::BumpMode lastDeprecatedRule
;
4631 /* RegisteredRunner API */
4632 virtual void finalizeConfig();
4635 Ssl::BumpMode
sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpEnd
;
4637 RunnerRegistrationEntry(sslBumpCfgRr
);
4640 sslBumpCfgRr::finalizeConfig()
4642 if (lastDeprecatedRule
!= Ssl::bumpEnd
) {
4643 assert( lastDeprecatedRule
== Ssl::bumpClientFirst
|| lastDeprecatedRule
== Ssl::bumpNone
);
4644 static char buf
[1024];
4645 if (lastDeprecatedRule
== Ssl::bumpClientFirst
) {
4646 strcpy(buf
, "ssl_bump deny all");
4647 debugs(3, DBG_CRITICAL
, "WARNING: auto-converting deprecated implicit "
4648 "\"ssl_bump deny all\" to \"ssl_bump none all\". New ssl_bump configurations "
4649 "must not use implicit rules. Update your ssl_bump rules.");
4651 strcpy(buf
, "ssl_bump allow all");
4652 debugs(3, DBG_CRITICAL
, "SECURITY NOTICE: auto-converting deprecated implicit "
4653 "\"ssl_bump allow all\" to \"ssl_bump client-first all\" which is usually "
4654 "inferior to the newer server-first bumping mode. New ssl_bump"
4655 " configurations must not use implicit rules. Update your ssl_bump rules.");
4661 static void parse_sslproxy_ssl_bump(acl_access
**ssl_bump
)
4663 typedef const char *BumpCfgStyle
;
4664 BumpCfgStyle bcsNone
= NULL
;
4665 BumpCfgStyle bcsNew
= "new client/server-first/none";
4666 BumpCfgStyle bcsOld
= "deprecated allow/deny";
4667 static BumpCfgStyle bumpCfgStyleLast
= bcsNone
;
4668 BumpCfgStyle bumpCfgStyleNow
= bcsNone
;
4670 if ((bm
= ConfigParser::NextToken()) == NULL
) {
4675 // if this is the first rule proccessed
4676 if (*ssl_bump
== NULL
) {
4677 bumpCfgStyleLast
= bcsNone
;
4678 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpEnd
;
4681 allow_t action
= allow_t(ACCESS_ALLOWED
);
4683 if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpClientFirst
]) == 0) {
4684 action
.kind
= Ssl::bumpClientFirst
;
4685 bumpCfgStyleNow
= bcsNew
;
4686 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpServerFirst
]) == 0) {
4687 action
.kind
= Ssl::bumpServerFirst
;
4688 bumpCfgStyleNow
= bcsNew
;
4689 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpPeek
]) == 0) {
4690 action
.kind
= Ssl::bumpPeek
;
4691 bumpCfgStyleNow
= bcsNew
;
4692 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpStare
]) == 0) {
4693 action
.kind
= Ssl::bumpStare
;
4694 bumpCfgStyleNow
= bcsNew
;
4695 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpSplice
]) == 0) {
4696 action
.kind
= Ssl::bumpSplice
;
4697 bumpCfgStyleNow
= bcsNew
;
4698 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpBump
]) == 0) {
4699 action
.kind
= Ssl::bumpBump
;
4700 bumpCfgStyleNow
= bcsNew
;
4701 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpTerminate
]) == 0) {
4702 action
.kind
= Ssl::bumpTerminate
;
4703 bumpCfgStyleNow
= bcsNew
;
4704 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpNone
]) == 0) {
4705 action
.kind
= Ssl::bumpNone
;
4706 bumpCfgStyleNow
= bcsNew
;
4707 } else if (strcmp(bm
, "allow") == 0) {
4708 debugs(3, DBG_CRITICAL
, "SECURITY NOTICE: auto-converting deprecated "
4709 "\"ssl_bump allow <acl>\" to \"ssl_bump client-first <acl>\" which "
4710 "is usually inferior to the newer server-first "
4711 "bumping mode. Update your ssl_bump rules.");
4712 action
.kind
= Ssl::bumpClientFirst
;
4713 bumpCfgStyleNow
= bcsOld
;
4714 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpClientFirst
;
4715 } else if (strcmp(bm
, "deny") == 0) {
4716 debugs(3, DBG_CRITICAL
, "WARNING: auto-converting deprecated "
4717 "\"ssl_bump deny <acl>\" to \"ssl_bump none <acl>\". Update "
4718 "your ssl_bump rules.");
4719 action
.kind
= Ssl::bumpNone
;
4720 bumpCfgStyleNow
= bcsOld
;
4721 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpNone
;
4723 debugs(3, DBG_CRITICAL
, "FATAL: unknown ssl_bump mode: " << bm
);
4728 if (bumpCfgStyleLast
!= bcsNone
&& bumpCfgStyleNow
!= bumpCfgStyleLast
) {
4729 debugs(3, DBG_CRITICAL
, "FATAL: do not mix " << bumpCfgStyleNow
<< " actions with " <<
4730 bumpCfgStyleLast
<< " actions. Update your ssl_bump rules.");
4735 bumpCfgStyleLast
= bumpCfgStyleNow
;
4737 Acl::AndNode
*rule
= new Acl::AndNode
;
4738 rule
->context("(ssl_bump rule)", config_input_line
);
4744 *ssl_bump
= new Acl::Tree
;
4745 (*ssl_bump
)->context("(ssl_bump rules)", config_input_line
);
4748 (*ssl_bump
)->add(rule
, action
);
4751 static void dump_sslproxy_ssl_bump(StoreEntry
*entry
, const char *name
, acl_access
*ssl_bump
)
4754 dump_SBufList(entry
, ssl_bump
->treeDump(name
, Ssl::BumpModeStr
));
4757 static void free_sslproxy_ssl_bump(acl_access
**ssl_bump
)
4759 free_acl_access(ssl_bump
);
4764 static void dump_HeaderWithAclList(StoreEntry
* entry
, const char *name
, HeaderWithAclList
*headers
)
4769 for (HeaderWithAclList::iterator hwa
= headers
->begin(); hwa
!= headers
->end(); ++hwa
) {
4770 storeAppendPrintf(entry
, "%s %s %s", name
, hwa
->fieldName
.c_str(), hwa
->fieldValue
.c_str());
4772 dump_acl_list(entry
, hwa
->aclList
);
4773 storeAppendPrintf(entry
, "\n");
4777 static void parse_HeaderWithAclList(HeaderWithAclList
**headers
)
4781 *headers
= new HeaderWithAclList
;
4783 if ((fn
= ConfigParser::NextToken()) == NULL
) {
4789 hwa
.fieldId
= httpHeaderIdByNameDef(fn
, strlen(fn
));
4790 if (hwa
.fieldId
== HDR_BAD_HDR
)
4791 hwa
.fieldId
= HDR_OTHER
;
4793 Format::Format
*nlf
= new ::Format::Format("hdrWithAcl");
4794 ConfigParser::EnableMacros();
4795 String buf
= ConfigParser::NextQuotedToken();
4796 ConfigParser::DisableMacros();
4797 hwa
.fieldValue
= buf
.termedBuf();
4798 hwa
.quoted
= ConfigParser::LastTokenWasQuoted();
4800 if (!nlf
->parse(hwa
.fieldValue
.c_str())) {
4804 hwa
.valueFormat
= nlf
;
4807 aclParseAclList(LegacyParser
, &hwa
.aclList
, (hwa
.fieldName
+ ':' + hwa
.fieldValue
).c_str());
4808 (*headers
)->push_back(hwa
);
4811 static void free_HeaderWithAclList(HeaderWithAclList
**header
)
4816 for (HeaderWithAclList::iterator hwa
= (*header
)->begin(); hwa
!= (*header
)->end(); ++hwa
) {
4818 aclDestroyAclList(&hwa
->aclList
);
4820 if (hwa
->valueFormat
) {
4821 delete hwa
->valueFormat
;
4822 hwa
->valueFormat
= NULL
;
4829 static void parse_note(Notes
*notes
)
4832 notes
->parse(LegacyParser
);
4835 static void dump_note(StoreEntry
*entry
, const char *name
, Notes
¬es
)
4837 notes
.dump(entry
, name
);
4840 static void free_note(Notes
*notes
)
4845 static bool FtpEspvDeprecated
= false;
4846 static void parse_ftp_epsv(acl_access
**ftp_epsv
)
4848 allow_t ftpEpsvDeprecatedAction
;
4849 bool ftpEpsvIsDeprecatedRule
= false;
4851 char *t
= ConfigParser::PeekAtToken();
4857 if (!strcmp(t
, "off")) {
4858 (void)ConfigParser::NextToken();
4859 ftpEpsvIsDeprecatedRule
= true;
4860 ftpEpsvDeprecatedAction
= allow_t(ACCESS_DENIED
);
4861 } else if (!strcmp(t
, "on")) {
4862 (void)ConfigParser::NextToken();
4863 ftpEpsvIsDeprecatedRule
= true;
4864 ftpEpsvDeprecatedAction
= allow_t(ACCESS_ALLOWED
);
4867 // Check for mixing "ftp_epsv on|off" and "ftp_epsv allow|deny .." rules:
4868 // 1) if this line is "ftp_epsv allow|deny ..." and already exist rules of "ftp_epsv on|off"
4869 // 2) if this line is "ftp_epsv on|off" and already exist rules of "ftp_epsv allow|deny ..."
4871 if ((!ftpEpsvIsDeprecatedRule
&& FtpEspvDeprecated
) ||
4872 (ftpEpsvIsDeprecatedRule
&& !FtpEspvDeprecated
&& *ftp_epsv
!= NULL
)) {
4873 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.");
4877 if (ftpEpsvIsDeprecatedRule
) {
4878 // overwrite previous ftp_epsv lines
4880 if (ftpEpsvDeprecatedAction
== allow_t(ACCESS_DENIED
)) {
4881 Acl::AndNode
*ftpEpsvRule
= new Acl::AndNode
;
4882 ftpEpsvRule
->context("(ftp_epsv rule)", config_input_line
);
4883 ACL
*a
= ACL::FindByName("all");
4888 ftpEpsvRule
->add(a
);
4889 *ftp_epsv
= new Acl::Tree
;
4890 (*ftp_epsv
)->context("(ftp_epsv rules)", config_input_line
);
4891 (*ftp_epsv
)->add(ftpEpsvRule
, ftpEpsvDeprecatedAction
);
4894 FtpEspvDeprecated
= true;
4896 aclParseAccessLine(cfg_directive
, LegacyParser
, ftp_epsv
);
4900 static void dump_ftp_epsv(StoreEntry
*entry
, const char *name
, acl_access
*ftp_epsv
)
4903 dump_SBufList(entry
, ftp_epsv
->treeDump(name
, NULL
));
4906 static void free_ftp_epsv(acl_access
**ftp_epsv
)
4908 free_acl_access(ftp_epsv
);
4909 FtpEspvDeprecated
= false;
4913 parse_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*config
)
4916 parseTimeLine(&tval
, T_SECOND_STR
, false, true);
4917 Config
.Timeout
.urlRewrite
= static_cast<time_t>(tval
/1000);
4920 while(ConfigParser::NextKvPair(key
, value
)) {
4921 if (strcasecmp(key
, "on_timeout") == 0) {
4922 if (strcasecmp(value
, "bypass") == 0)
4923 config
->action
= toutActBypass
;
4924 else if (strcasecmp(value
, "fail") == 0)
4925 config
->action
= toutActFail
;
4926 else if (strcasecmp(value
, "retry") == 0)
4927 config
->action
= toutActRetry
;
4928 else if (strcasecmp(value
, "use_configured_response") == 0) {
4929 config
->action
= toutActUseConfiguredResponse
;
4931 debugs(3, DBG_CRITICAL
, "FATAL: unsuported \"on_timeout\" action:" << value
);
4934 } else if (strcasecmp(key
, "response") == 0) {
4935 config
->response
= xstrdup(value
);
4937 debugs(3, DBG_CRITICAL
, "FATAL: unsuported option " << key
);
4942 if (config
->action
== toutActUseConfiguredResponse
&& !config
->response
) {
4943 debugs(3, DBG_CRITICAL
, "FATAL: Expected 'response=' option after 'on_timeout=use_configured_response' option");
4947 if (config
->action
!= toutActUseConfiguredResponse
&& config
->response
) {
4948 debugs(3, DBG_CRITICAL
, "FATAL: 'response=' option is valid only when used with the 'on_timeout=use_configured_response' option");
4954 dump_UrlHelperTimeout(StoreEntry
*entry
, const char *name
, SquidConfig::UrlHelperTimeout
&config
)
4956 const char *onTimedOutActions
[] = {"bypass", "fail", "retry", "use_configured_response"};
4957 assert(config
.action
>= 0 && config
.action
<= toutActUseConfiguredResponse
);
4959 dump_time_t(entry
, name
, Config
.Timeout
.urlRewrite
);
4960 storeAppendPrintf(entry
, " on_timeout=%s", onTimedOutActions
[config
.action
]);
4962 if (config
.response
)
4963 storeAppendPrintf(entry
, " response=\"%s\"", config
.response
);
4965 storeAppendPrintf(entry
, "\n");
4969 free_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*config
)
4971 Config
.Timeout
.urlRewrite
= 0;
4973 safe_free(config
->response
);
4977 parse_configuration_includes_quoted_values(bool *)
4982 // If quoted values is set to on then enable new strict mode parsing
4984 ConfigParser::RecognizeQuotedValues
= true;
4985 ConfigParser::StrictMode
= true;
4987 ConfigParser::RecognizeQuotedValues
= false;
4988 ConfigParser::StrictMode
= false;
4993 dump_configuration_includes_quoted_values(StoreEntry
*const entry
, const char *const name
, bool)
4995 int val
= ConfigParser::RecognizeQuotedValues
? 1 : 0;
4996 dump_onoff(entry
, name
, val
);
5000 free_configuration_includes_quoted_values(bool *)
5002 ConfigParser::RecognizeQuotedValues
= false;
5003 ConfigParser::StrictMode
= false;