2 * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 /* DEBUG: section 03 Configuration File Parsing */
13 #include "acl/AclDenyInfoList.h"
14 #include "acl/AclSizeLimit.h"
15 #include "acl/Address.h"
16 #include "acl/Gadgets.h"
17 #include "acl/MethodData.h"
19 #include "anyp/PortCfg.h"
20 #include "anyp/UriScheme.h"
21 #include "auth/Config.h"
22 #include "auth/Scheme.h"
24 #include "base/RunnersRegistry.h"
26 #include "CachePeer.h"
27 #include "ConfigParser.h"
28 #include "CpuAffinityMap.h"
29 #include "DiskIO/DiskIOModule.h"
30 #include "eui/Config.h"
31 #include "ExternalACL.h"
32 #include "format/Format.h"
33 #include "ftp/Elements.h"
35 #include "HttpHeaderTools.h"
36 #include "icmp/IcmpConfig.h"
37 #include "ident/Config.h"
38 #include "ip/Intercept.h"
39 #include "ip/QosConfig.h"
42 #include "log/Config.h"
43 #include "log/CustomLog.h"
45 #include "MessageDelayPools.h"
46 #include "mgr/ActionPasswordList.h"
47 #include "mgr/Registration.h"
48 #include "neighbors.h"
49 #include "NeighborTypeDomainList.h"
52 #include "PeerDigest.h"
53 #include "PeerPoolMgr.h"
55 #include "RefreshPattern.h"
57 #include "sbuf/List.h"
58 #include "SquidConfig.h"
59 #include "SquidString.h"
60 #include "ssl/ProxyCerts.h"
62 #include "store/Disk.h"
63 #include "store/Disks.h"
64 #include "StoreFileSystem.h"
68 /* wccp2 has its own conditional definitions */
71 #include "adaptation/Config.h"
74 #include "adaptation/icap/Config.h"
77 #include "adaptation/ecap/Config.h"
80 #include "ssl/Config.h"
81 #include "ssl/support.h"
84 #include "esi/Parser.h"
102 #include <sys/stat.h>
106 #include "ssl/gadgets.h"
110 static void parse_adaptation_service_set_type();
111 static void parse_adaptation_service_chain_type();
112 static void parse_adaptation_access_type();
116 static void parse_icap_service_type(Adaptation::Icap::Config
*);
117 static void dump_icap_service_type(StoreEntry
*, const char *, const Adaptation::Icap::Config
&);
118 static void free_icap_service_type(Adaptation::Icap::Config
*);
119 static void parse_icap_class_type();
120 static void parse_icap_access_type();
122 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*);
123 static void dump_icap_service_failure_limit(StoreEntry
*, const char *, const Adaptation::Icap::Config
&);
124 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*);
128 static void parse_ecap_service_type(Adaptation::Ecap::Config
*);
129 static void dump_ecap_service_type(StoreEntry
*, const char *, const Adaptation::Ecap::Config
&);
130 static void free_ecap_service_type(Adaptation::Ecap::Config
*);
133 static peer_t
parseNeighborType(const char *s
);
135 static const char *const T_MILLISECOND_STR
= "millisecond";
136 static const char *const T_SECOND_STR
= "second";
137 static const char *const T_MINUTE_STR
= "minute";
138 static const char *const T_HOUR_STR
= "hour";
139 static const char *const T_DAY_STR
= "day";
140 static const char *const T_WEEK_STR
= "week";
141 static const char *const T_FORTNIGHT_STR
= "fortnight";
142 static const char *const T_MONTH_STR
= "month";
143 static const char *const T_YEAR_STR
= "year";
144 static const char *const T_DECADE_STR
= "decade";
146 static const char *const B_BYTES_STR
= "bytes";
147 static const char *const B_KBYTES_STR
= "KB";
148 static const char *const B_MBYTES_STR
= "MB";
149 static const char *const B_GBYTES_STR
= "GB";
151 static const char *const list_sep
= ", \t\n\r";
153 static void parse_access_log(CustomLog
** customlog_definitions
);
154 static int check_null_access_log(CustomLog
*customlog_definitions
);
155 static void dump_access_log(StoreEntry
* entry
, const char *name
, CustomLog
* definitions
);
156 static void free_access_log(CustomLog
** definitions
);
157 static bool setLogformat(CustomLog
*cl
, const char *name
, const bool dieWhenMissing
);
159 static void configDoConfigure(void);
160 static void parse_refreshpattern(RefreshPattern
**);
161 static uint64_t parseTimeUnits(const char *unit
, bool allowMsec
);
162 static void parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
, bool expectMoreArguments
);
163 static void parse_u_short(unsigned short * var
);
164 static void parse_string(char **);
165 static void default_all(void);
166 static void defaults_if_none(void);
167 static void defaults_postscriptum(void);
168 static int parse_line(char *);
169 static void parse_obsolete(const char *);
170 static void parseBytesLine(size_t * bptr
, const char *units
);
172 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
);
174 static void parseBytesLineSigned(ssize_t
* bptr
, const char *units
);
175 static size_t parseBytesUnits(const char *unit
);
176 static void free_all(void);
177 void requirePathnameExists(const char *name
, const char *path
);
178 static OBJH dump_config
;
179 #if USE_HTTP_VIOLATIONS
180 static void free_HeaderManglers(HeaderManglers
**pm
);
181 static void dump_http_header_access(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
);
182 static void parse_http_header_access(HeaderManglers
**manglers
);
183 #define free_http_header_access free_HeaderManglers
184 static void dump_http_header_replace(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
);
185 static void parse_http_header_replace(HeaderManglers
**manglers
);
186 #define free_http_header_replace free_HeaderManglers
188 static void dump_HeaderWithAclList(StoreEntry
* entry
, const char *name
, HeaderWithAclList
*headers
);
189 static void parse_HeaderWithAclList(HeaderWithAclList
**header
);
190 static void free_HeaderWithAclList(HeaderWithAclList
**header
);
191 static void parse_note(Notes
*);
192 static void dump_note(StoreEntry
*, const char *, Notes
&);
193 static void free_note(Notes
*);
194 static void parse_denyinfo(AclDenyInfoList
** var
);
195 static void dump_denyinfo(StoreEntry
* entry
, const char *name
, AclDenyInfoList
* var
);
196 static void free_denyinfo(AclDenyInfoList
** var
);
199 static void parse_IpAddress_list(Ip::Address_list
**);
200 static void dump_IpAddress_list(StoreEntry
*, const char *, const Ip::Address_list
*);
201 static void free_IpAddress_list(Ip::Address_list
**);
203 static int check_null_IpAddress_list(const Ip::Address_list
*);
204 #endif /* CURRENTLY_UNUSED */
205 #endif /* USE_WCCPv2 */
207 static void parsePortCfg(AnyP::PortCfgPointer
*, const char *protocol
);
208 #define parse_PortCfg(l) parsePortCfg((l), token)
209 static void dump_PortCfg(StoreEntry
*, const char *, const AnyP::PortCfgPointer
&);
210 #define free_PortCfg(h) *(h)=NULL
213 static void parse_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
);
214 static void dump_sslproxy_cert_sign(StoreEntry
*entry
, const char *name
, sslproxy_cert_sign
*cert_sign
);
215 static void free_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
);
216 static void parse_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
);
217 static void dump_sslproxy_cert_adapt(StoreEntry
*entry
, const char *name
, sslproxy_cert_adapt
*cert_adapt
);
218 static void free_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
);
219 static void parse_sslproxy_ssl_bump(acl_access
**ssl_bump
);
220 static void dump_sslproxy_ssl_bump(StoreEntry
*entry
, const char *name
, acl_access
*ssl_bump
);
221 static void free_sslproxy_ssl_bump(acl_access
**ssl_bump
);
222 #endif /* USE_OPENSSL */
224 static void parse_ftp_epsv(acl_access
**ftp_epsv
);
225 static void dump_ftp_epsv(StoreEntry
*entry
, const char *name
, acl_access
*ftp_epsv
);
226 static void free_ftp_epsv(acl_access
**ftp_epsv
);
228 static void parse_b_size_t(size_t * var
);
229 static void parse_b_int64_t(int64_t * var
);
231 static void parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
);
232 static void dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
);
233 static void free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
);
235 static void parse_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*);
236 static void dump_UrlHelperTimeout(StoreEntry
*, const char *, SquidConfig::UrlHelperTimeout
&);
237 static void free_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*);
239 static int parseOneConfigFile(const char *file_name
, unsigned int depth
);
241 static void parse_configuration_includes_quoted_values(bool *recognizeQuotedValues
);
242 static void dump_configuration_includes_quoted_values(StoreEntry
*const entry
, const char *const name
, bool recognizeQuotedValues
);
243 static void free_configuration_includes_quoted_values(bool *recognizeQuotedValues
);
244 static void parse_on_unsupported_protocol(acl_access
**access
);
245 static void dump_on_unsupported_protocol(StoreEntry
*entry
, const char *name
, acl_access
*access
);
246 static void free_on_unsupported_protocol(acl_access
**access
);
247 static void ParseAclWithAction(acl_access
**access
, const allow_t
&action
, const char *desc
, ACL
*acl
= nullptr);
250 * LegacyParser is a parser for legacy code that uses the global
251 * approach. This is static so that it is only exposed to cache_cf.
252 * Other modules needing access to a ConfigParser should have it
253 * provided to them in their parserFOO methods.
255 static ConfigParser LegacyParser
= ConfigParser();
260 LegacyParser
.destruct();
264 SetConfigFilename(char const *file_name
, bool is_pipe
)
267 cfg_filename
= file_name
+ 1;
269 cfg_filename
= file_name
;
273 skip_ws(const char* s
)
282 parseManyConfigFiles(char* files
, int depth
)
285 char* saveptr
= NULL
;
290 memset(&globbuf
, 0, sizeof(globbuf
));
291 for (path
= strwordtok(files
, &saveptr
); path
; path
= strwordtok(NULL
, &saveptr
)) {
292 if (glob(path
, globbuf
.gl_pathc
? GLOB_APPEND
: 0, NULL
, &globbuf
) != 0) {
294 fatalf("Unable to find configuration file: %s: %s", path
, xstrerr(xerrno
));
297 for (i
= 0; i
< (int)globbuf
.gl_pathc
; ++i
) {
298 error_count
+= parseOneConfigFile(globbuf
.gl_pathv
[i
], depth
);
302 char* file
= strwordtok(files
, &saveptr
);
303 while (file
!= NULL
) {
304 error_count
+= parseOneConfigFile(file
, depth
);
305 file
= strwordtok(NULL
, &saveptr
);
307 #endif /* HAVE_GLOB */
312 ReplaceSubstr(char*& str
, int& len
, unsigned substrIdx
, unsigned substrLen
, const char* newSubstr
)
315 assert(newSubstr
!= NULL
);
317 unsigned newSubstrLen
= strlen(newSubstr
);
318 if (newSubstrLen
> substrLen
)
319 str
= (char*)realloc(str
, len
- substrLen
+ newSubstrLen
+ 1);
321 // move tail part including zero
322 memmove(str
+ substrIdx
+ newSubstrLen
, str
+ substrIdx
+ substrLen
, len
- substrIdx
- substrLen
+ 1);
323 // copy new substring in place
324 memcpy(str
+ substrIdx
, newSubstr
, newSubstrLen
);
330 SubstituteMacro(char*& line
, int& len
, const char* macroName
, const char* substStr
)
332 assert(line
!= NULL
);
333 assert(macroName
!= NULL
);
334 assert(substStr
!= NULL
);
335 unsigned macroNameLen
= strlen(macroName
);
336 while (const char* macroPos
= strstr(line
, macroName
)) // we would replace all occurrences
337 ReplaceSubstr(line
, len
, macroPos
- line
, macroNameLen
, substStr
);
341 ProcessMacros(char*& line
, int& len
)
343 SubstituteMacro(line
, len
, "${service_name}", service_name
.c_str());
344 SubstituteMacro(line
, len
, "${process_name}", TheKidName
);
345 SubstituteMacro(line
, len
, "${process_number}", xitoa(KidIdentifier
));
349 trim_trailing_ws(char* str
)
352 unsigned i
= strlen(str
);
353 while ((i
> 0) && xisspace(str
[i
- 1]))
359 FindStatement(const char* line
, const char* statement
)
361 assert(line
!= NULL
);
362 assert(statement
!= NULL
);
364 const char* str
= skip_ws(line
);
365 unsigned len
= strlen(statement
);
366 if (strncmp(str
, statement
, len
) == 0) {
370 else if (xisspace(*str
))
378 StrToInt(const char* str
, long& number
)
383 number
= strtol(str
, &end
, 0);
385 return (end
!= str
) && (*end
== '\0'); // returns true if string contains nothing except number
389 EvalBoolExpr(const char* expr
)
391 assert(expr
!= NULL
);
392 if (strcmp(expr
, "true") == 0) {
394 } else if (strcmp(expr
, "false") == 0) {
396 } else if (const char* equation
= strchr(expr
, '=')) {
397 const char* rvalue
= skip_ws(equation
+ 1);
398 char* lvalue
= (char*)xmalloc(equation
- expr
+ 1);
399 xstrncpy(lvalue
, expr
, equation
- expr
+ 1);
400 trim_trailing_ws(lvalue
);
403 if (!StrToInt(lvalue
, number1
))
404 fatalf("String is not a integer number: '%s'\n", lvalue
);
406 if (!StrToInt(rvalue
, number2
))
407 fatalf("String is not a integer number: '%s'\n", rvalue
);
410 return number1
== number2
;
412 fatalf("Unable to evaluate expression '%s'\n", expr
);
413 return false; // this place cannot be reached
417 parseOneConfigFile(const char *file_name
, unsigned int depth
)
420 const char *orig_cfg_filename
= cfg_filename
;
421 const int orig_config_lineno
= config_lineno
;
423 char *tmp_line
= NULL
;
424 int tmp_line_len
= 0;
428 debugs(3, DBG_IMPORTANT
, "Processing Configuration File: " << file_name
<< " (depth " << depth
<< ")");
430 fatalf("WARNING: can't include %s: includes are nested too deeply (>16)!\n", file_name
);
434 if (file_name
[0] == '!' || file_name
[0] == '|') {
435 fp
= popen(file_name
+ 1, "r");
438 fp
= fopen(file_name
, "r");
443 fatalf("Unable to open configuration file: %s: %s", file_name
, xstrerr(xerrno
));
447 setmode(fileno(fp
), O_TEXT
);
450 SetConfigFilename(file_name
, bool(is_pipe
));
452 memset(config_input_line
, '\0', BUFSIZ
);
456 std::vector
<bool> if_states
;
457 while (fgets(config_input_line
, BUFSIZ
, fp
)) {
460 if ((token
= strchr(config_input_line
, '\n')))
463 if ((token
= strchr(config_input_line
, '\r')))
466 // strip any prefix whitespace off the line.
467 const char *p
= skip_ws(config_input_line
);
468 if (config_input_line
!= p
)
469 memmove(config_input_line
, p
, strlen(p
)+1);
471 if (strncmp(config_input_line
, "#line ", 6) == 0) {
472 static char new_file_name
[1024];
474 static char new_lineno
;
475 token
= config_input_line
+ 6;
476 new_lineno
= strtol(token
, &file
, 0) - 1;
479 continue; /* Not a valid #line directive, may be a comment */
481 while (*file
&& xisspace((unsigned char) *file
))
486 continue; /* Not a valid #line directive, may be a comment */
488 xstrncpy(new_file_name
, file
+ 1, sizeof(new_file_name
));
490 if ((token
= strchr(new_file_name
, '"')))
493 SetConfigFilename(new_file_name
, false);
496 config_lineno
= new_lineno
;
499 if (config_input_line
[0] == '#')
502 if (config_input_line
[0] == '\0')
505 const char* append
= tmp_line_len
? skip_ws(config_input_line
) : config_input_line
;
507 size_t append_len
= strlen(append
);
509 tmp_line
= (char*)xrealloc(tmp_line
, tmp_line_len
+ append_len
+ 1);
511 strcpy(tmp_line
+ tmp_line_len
, append
);
513 tmp_line_len
+= append_len
;
515 if (tmp_line
[tmp_line_len
-1] == '\\') {
516 debugs(3, 5, "parseConfigFile: tmp_line='" << tmp_line
<< "'");
517 tmp_line
[--tmp_line_len
] = '\0';
521 trim_trailing_ws(tmp_line
);
522 ProcessMacros(tmp_line
, tmp_line_len
);
523 debugs(3, (opt_parse_cfg_only
?1:5), "Processing: " << tmp_line
);
525 if (const char* expr
= FindStatement(tmp_line
, "if")) {
526 if_states
.push_back(EvalBoolExpr(expr
)); // store last if-statement meaning
527 } else if (FindStatement(tmp_line
, "endif")) {
528 if (!if_states
.empty())
529 if_states
.pop_back(); // remove last if-statement meaning
531 fatalf("'endif' without 'if'\n");
532 } else if (FindStatement(tmp_line
, "else")) {
533 if (!if_states
.empty())
534 if_states
.back() = !if_states
.back();
536 fatalf("'else' without 'if'\n");
537 } else if (if_states
.empty() || if_states
.back()) { // test last if-statement meaning if present
538 /* Handle includes here */
539 if (tmp_line_len
>= 9 && strncmp(tmp_line
, "include", 7) == 0 && xisspace(tmp_line
[7])) {
540 err_count
+= parseManyConfigFiles(tmp_line
+ 8, depth
+ 1);
541 } else if (!parse_line(tmp_line
)) {
542 debugs(3, DBG_CRITICAL
, HERE
<< cfg_filename
<< ":" << config_lineno
<< " unrecognized: '" << tmp_line
<< "'");
551 if (!if_states
.empty())
552 fatalf("if-statement without 'endif'\n");
555 int ret
= pclose(fp
);
558 fatalf("parseConfigFile: '%s' failed with exit code %d\n", file_name
, ret
);
563 SetConfigFilename(orig_cfg_filename
, false);
564 config_lineno
= orig_config_lineno
;
572 parseConfigFileOrThrow(const char *file_name
)
580 ACLMethodData::ThePurgeCount
= 0;
583 err_count
= parseOneConfigFile(file_name
, 0);
587 defaults_postscriptum();
590 * We must call configDoConfigure() before leave_suid() because
591 * configDoConfigure() is where we turn username strings into
596 if (!Config
.chroot_dir
) {
598 setUmask(Config
.umask
);
599 _db_init(Debug::cache_log
, Debug::debugOptions
);
603 if (opt_send_signal
== -1) {
604 Mgr::RegisterAction("config",
605 "Current Squid Configuration",
613 // TODO: Refactor main.cc to centrally handle (and report) all exceptions.
615 parseConfigFile(const char *file_name
)
618 return parseConfigFileOrThrow(file_name
);
620 catch (const std::exception
&ex
) {
621 debugs(3, DBG_CRITICAL
, "FATAL: bad configuration: " << ex
.what());
623 return 1; // not reached
628 configDoConfigure(void)
631 /* init memory as early as possible */
635 Config
.cacheSwap
.n_strands
= 0; // no diskers by default
636 if (Config
.cacheSwap
.swapDirs
== NULL
) {
637 /* Memory-only cache probably in effect. */
638 /* turn off the cache rebuild delays... */
639 StoreController::store_dirs_rebuilding
= 0;
640 } else if (InDaemonMode()) { // no diskers in non-daemon mode
641 for (int i
= 0; i
< Config
.cacheSwap
.n_configured
; ++i
) {
642 const RefCount
<SwapDir
> sd
= Config
.cacheSwap
.swapDirs
[i
];
643 if (sd
->needsDiskStrand())
644 sd
->disker
= Config
.workers
+ (++Config
.cacheSwap
.n_strands
);
648 if (Debug::rotateNumber
< 0) {
649 Debug::rotateNumber
= Config
.Log
.rotateNumber
;
652 #if SIZEOF_OFF_T <= 4
653 if (Config
.Store
.maxObjectSize
> 0x7FFF0000) {
654 debugs(3, DBG_CRITICAL
, "WARNING: This Squid binary can not handle files larger than 2GB. Limiting maximum_object_size to just below 2GB");
655 Config
.Store
.maxObjectSize
= 0x7FFF0000;
659 if (Config
.Announce
.period
> 0) {
660 Config
.onoff
.announce
= 1;
662 Config
.Announce
.period
= 86400 * 365; /* one year */
663 Config
.onoff
.announce
= 0;
666 if (Config
.onoff
.httpd_suppress_version_string
)
667 visible_appname_string
= (char *)appname_string
;
669 visible_appname_string
= (char const *)APP_FULLNAME
;
671 if (Config
.Program
.redirect
) {
672 if (Config
.redirectChildren
.n_max
< 1) {
673 Config
.redirectChildren
.n_max
= 0;
674 wordlistDestroy(&Config
.Program
.redirect
);
678 if (Config
.Program
.store_id
) {
679 if (Config
.storeIdChildren
.n_max
< 1) {
680 Config
.storeIdChildren
.n_max
= 0;
681 wordlistDestroy(&Config
.Program
.store_id
);
685 if (Config
.appendDomain
)
686 if (*Config
.appendDomain
!= '.')
687 fatal("append_domain must begin with a '.'");
689 if (Config
.errHtmlText
== NULL
)
690 Config
.errHtmlText
= xstrdup(null_string
);
692 #if !HAVE_SETRLIMIT || !defined(RLIMIT_NOFILE)
693 if (Config
.max_filedescriptors
> 0) {
694 debugs(0, DBG_IMPORTANT
, "WARNING: max_filedescriptors disabled. Operating System setrlimit(RLIMIT_NOFILE) is missing.");
696 #elif USE_SELECT || USE_SELECT_WIN32
697 if (Config
.max_filedescriptors
> FD_SETSIZE
) {
698 debugs(0, DBG_IMPORTANT
, "WARNING: max_filedescriptors limited to " << FD_SETSIZE
<< " by select() algorithm.");
704 snprintf(ThisCache
, sizeof(ThisCache
), "%s (%s)",
706 visible_appname_string
);
709 * the extra space is for loop detection in client_side.c -- we search
710 * for substrings in the Via header.
712 snprintf(ThisCache2
, sizeof(ThisCache
), " %s (%s)",
714 visible_appname_string
);
716 /* Use visible_hostname as default surrogate_id */
717 if (!Config
.Accel
.surrogate_id
) {
718 const char *t
= getMyHostname();
719 Config
.Accel
.surrogate_id
= xstrdup( (t
?t
:"unset-id") );
722 if (!Config
.udpMaxHitObjsz
|| Config
.udpMaxHitObjsz
> SQUID_UDP_SO_SNDBUF
)
723 Config
.udpMaxHitObjsz
= SQUID_UDP_SO_SNDBUF
;
725 if (Config
.appendDomain
)
726 Config
.appendDomainLen
= strlen(Config
.appendDomain
);
728 Config
.appendDomainLen
= 0;
730 if (Config
.connect_retries
> 10) {
731 debugs(0,DBG_CRITICAL
, "WARNING: connect_retries cannot be larger than 10. Resetting to 10.");
732 Config
.connect_retries
= 10;
735 requirePathnameExists("MIME Config Table", Config
.mimeTablePathname
);
738 requirePathnameExists("unlinkd_program", Config
.Program
.unlinkd
);
740 requirePathnameExists("logfile_daemon", Log::TheConfig
.logfile_daemon
);
741 if (Config
.Program
.redirect
)
742 requirePathnameExists("redirect_program", Config
.Program
.redirect
->key
);
744 if (Config
.Program
.store_id
)
745 requirePathnameExists("store_id_program", Config
.Program
.store_id
->key
);
747 requirePathnameExists("Icon Directory", Config
.icons
.directory
);
749 if (Config
.errorDirectory
)
750 requirePathnameExists("Error Directory", Config
.errorDirectory
);
752 #if USE_HTTP_VIOLATIONS
755 const RefreshPattern
*R
;
757 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
758 if (!R
->flags
.override_expire
)
761 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'override-expire' in 'refresh_pattern' violates HTTP");
766 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
767 if (!R
->flags
.override_lastmod
)
770 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'override-lastmod' in 'refresh_pattern' violates HTTP");
775 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
776 if (!R
->flags
.reload_into_ims
)
779 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'reload-into-ims' in 'refresh_pattern' violates HTTP");
784 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
785 if (!R
->flags
.ignore_reload
)
788 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-reload' in 'refresh_pattern' violates HTTP");
793 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
794 if (!R
->flags
.ignore_no_store
)
797 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-no-store' in 'refresh_pattern' violates HTTP");
802 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
803 if (!R
->flags
.ignore_private
)
806 debugs(22, DBG_IMPORTANT
, "WARNING: use of 'ignore-private' in 'refresh_pattern' violates HTTP");
812 #if !USE_HTTP_VIOLATIONS
813 Config
.onoff
.via
= 1;
816 if (!Config
.onoff
.via
)
817 debugs(22, DBG_IMPORTANT
, "WARNING: HTTP requires the use of Via");
821 // we enable runtime PURGE checks if there is at least one PURGE method ACL
822 // TODO: replace with a dedicated "purge" ACL option?
823 Config2
.onoff
.enable_purge
= (ACLMethodData::ThePurgeCount
> 0);
825 if (geteuid() == 0) {
826 if (NULL
!= Config
.effectiveUser
) {
828 struct passwd
*pwd
= getpwnam(Config
.effectiveUser
);
832 * Andres Kroonmaa <andre@online.ee>:
833 * Some getpwnam() implementations (Solaris?) require
834 * an available FD < 256 for opening a FILE* to the
837 * This should be safe at startup, but might still fail
838 * during reconfigure.
840 fatalf("getpwnam failed to find userid for effective user '%s'",
841 Config
.effectiveUser
);
845 Config2
.effectiveUserID
= pwd
->pw_uid
;
847 Config2
.effectiveGroupID
= pwd
->pw_gid
;
850 if (pwd
->pw_dir
&& *pwd
->pw_dir
) {
851 // putenv() leaks by design; avoid leaks when nothing changes
853 if (lastDir
.isEmpty() || lastDir
.cmp(pwd
->pw_dir
) != 0) {
854 lastDir
= pwd
->pw_dir
;
855 int len
= strlen(pwd
->pw_dir
) + 6;
856 char *env_str
= (char *)xcalloc(len
, 1);
857 snprintf(env_str
, len
, "HOME=%s", pwd
->pw_dir
);
864 Config2
.effectiveUserID
= geteuid();
865 Config2
.effectiveGroupID
= getegid();
868 if (NULL
!= Config
.effectiveGroup
) {
870 struct group
*grp
= getgrnam(Config
.effectiveGroup
);
873 fatalf("getgrnam failed to find groupid for effective group '%s'",
874 Config
.effectiveGroup
);
878 Config2
.effectiveGroupID
= grp
->gr_gid
;
882 if (Config
.ssl_client
.foreignIntermediateCertsPath
)
883 Ssl::loadSquidUntrusted(Config
.ssl_client
.foreignIntermediateCertsPath
);
886 if (Security::ProxyOutgoingConfig
.encryptTransport
) {
887 debugs(3, DBG_IMPORTANT
, "Initializing https:// proxy context");
888 Config
.ssl_client
.sslContext
= Security::ProxyOutgoingConfig
.createClientContext(false);
889 if (!Config
.ssl_client
.sslContext
) {
891 fatal("ERROR: Could not initialize https:// proxy context");
893 debugs(3, DBG_IMPORTANT
, "ERROR: proxying https:// currently still requires --with-openssl");
897 Ssl::useSquidUntrusted(Config
.ssl_client
.sslContext
.get());
901 for (CachePeer
*p
= Config
.peers
; p
!= NULL
; p
= p
->next
) {
903 // default value for ssldomain= is the peer host/IP
904 if (p
->secure
.sslDomain
.isEmpty())
905 p
->secure
.sslDomain
= p
->host
;
907 if (p
->secure
.encryptTransport
) {
908 debugs(3, DBG_IMPORTANT
, "Initializing cache_peer " << p
->name
<< " TLS context");
909 p
->sslContext
= p
->secure
.createClientContext(true);
910 if (!p
->sslContext
) {
911 debugs(3, DBG_CRITICAL
, "ERROR: Could not initialize cache_peer " << p
->name
<< " TLS context");
919 for (AnyP::PortCfgPointer s
= HttpPortList
; s
!= NULL
; s
= s
->next
) {
920 if (!s
->secure
.encryptTransport
)
922 debugs(3, DBG_IMPORTANT
, "Initializing " << AnyP::UriScheme(s
->transport
.protocol
) << "_port " << s
->s
<< " TLS context");
923 s
->configureSslServerContext();
927 // prevent infinite fetch loops in the request parser
928 // due to buffer full but not enough data recived to finish parse
929 if (Config
.maxRequestBufferSize
<= Config
.maxRequestHeaderSize
) {
930 fatalf("Client request buffer of %u bytes cannot hold a request with %u bytes of headers." \
931 " Change client_request_buffer_max or request_header_max_size limits.",
932 (uint32_t)Config
.maxRequestBufferSize
, (uint32_t)Config
.maxRequestHeaderSize
);
936 * Disable client side request pipelining if client_persistent_connections OFF.
937 * Waste of resources queueing any pipelined requests when the first will close the connection.
939 if (Config
.pipeline_max_prefetch
> 0 && !Config
.onoff
.client_pconns
) {
940 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: pipeline_prefetch " << Config
.pipeline_max_prefetch
<<
941 " requires client_persistent_connections ON. Forced pipeline_prefetch 0.");
942 Config
.pipeline_max_prefetch
= 0;
947 * disable client side request pipelining. There is a race with
948 * Negotiate and NTLM when the client sends a second request on an
949 * connection before the authenticate challenge is sent. With
950 * pipelining OFF, the client may fail to authenticate, but squid's
951 * state will be preserved.
953 if (Config
.pipeline_max_prefetch
> 0) {
954 Auth::SchemeConfig
*nego
= Auth::SchemeConfig::Find("Negotiate");
955 Auth::SchemeConfig
*ntlm
= Auth::SchemeConfig::Find("NTLM");
956 if ((nego
&& nego
->active()) || (ntlm
&& ntlm
->active())) {
957 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: pipeline_prefetch breaks NTLM and Negotiate authentication. Forced pipeline_prefetch 0.");
958 Config
.pipeline_max_prefetch
= 0;
962 for (auto &authSchemes
: Auth::TheConfig
.schemeLists
) {
963 authSchemes
.expand();
964 if (authSchemes
.authConfigs
.empty()) {
965 debugs(3, DBG_CRITICAL
, "auth_schemes: at least one scheme name is required; got: " << authSchemes
.rawSchemes
);
972 /** Parse a line containing an obsolete directive.
973 * To upgrade it where possible instead of just "Bungled config" for
974 * directives which cannot be marked as simply aliases of the some name.
975 * For example if the parameter order and content has changed.
976 * Or if the directive has been completely removed.
979 parse_obsolete(const char *name
)
981 // Directives which have been radically changed rather than removed
982 if (!strcmp(name
, "url_rewrite_concurrency")) {
985 debugs(3, DBG_CRITICAL
, "WARNING: url_rewrite_concurrency upgrade overriding url_rewrite_children settings.");
986 Config
.redirectChildren
.concurrency
= cval
;
989 if (!strcmp(name
, "log_access")) {
994 if (!strcmp(name
, "log_icap")) {
999 if (!strcmp(name
, "ignore_ims_on_miss")) {
1000 // the replacement directive cache_revalidate_on_miss has opposite meanings for ON/OFF value
1001 // than the 2.7 directive. We need to parse and invert the configured value.
1004 Config
.onoff
.cache_miss_revalidate
= !temp
;
1007 if (!strncmp(name
, "sslproxy_", 9)) {
1008 // the replacement directive tls_outgoing_options uses options instead of whole-line input
1010 if (!strcmp(name
, "sslproxy_cafile"))
1011 tmp
.append("cafile=");
1012 else if (!strcmp(name
, "sslproxy_capath"))
1013 tmp
.append("capath=");
1014 else if (!strcmp(name
, "sslproxy_cipher"))
1015 tmp
.append("cipher=");
1016 else if (!strcmp(name
, "sslproxy_client_certificate"))
1017 tmp
.append("cert=");
1018 else if (!strcmp(name
, "sslproxy_client_key"))
1020 else if (!strcmp(name
, "sslproxy_flags"))
1021 tmp
.append("flags=");
1022 else if (!strcmp(name
, "sslproxy_options"))
1023 tmp
.append("options=");
1024 else if (!strcmp(name
, "sslproxy_version"))
1025 tmp
.append("version=");
1027 debugs(3, DBG_CRITICAL
, "ERROR: unknown directive: " << name
);
1032 // add the value as unquoted-string because the old values did not support whitespace
1033 const char *token
= ConfigParser::NextQuotedOrToEol();
1034 tmp
.append(token
, strlen(token
));
1035 Security::ProxyOutgoingConfig
.parse(tmp
.c_str());
1039 /* Parse a time specification from the config file. Store the
1040 * result in 'tptr', after converting it to 'units' */
1042 parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
, bool expectMoreArguments
= false)
1044 time_msec_t u
= parseTimeUnits(units
, allowMsec
);
1050 char *token
= ConfigParser::NextToken();;
1056 double d
= xatof(token
);
1058 time_msec_t m
= u
; /* default to 'units' if none specified */
1061 if ((token
= ConfigParser::PeekAtToken()) && (m
= parseTimeUnits(token
, allowMsec
))) {
1062 (void)ConfigParser::NextToken();
1064 } else if (!expectMoreArguments
) {
1069 token
= NULL
; // show default units if dying below
1070 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" << config_input_line
<< "', assuming " << d
<< " " << units
);
1073 token
= NULL
; // show default units if dying below.
1075 *tptr
= static_cast<time_msec_t
>(m
* d
);
1077 if (static_cast<double>(*tptr
) * 2 != m
* d
* 2) {
1078 debugs(3, DBG_CRITICAL
, "FATAL: Invalid value '" <<
1079 d
<< " " << (token
? token
: units
) << ": integer overflow (time_msec_t).");
1085 parseTimeUnits(const char *unit
, bool allowMsec
)
1087 if (allowMsec
&& !strncasecmp(unit
, T_MILLISECOND_STR
, strlen(T_MILLISECOND_STR
)))
1090 if (!strncasecmp(unit
, T_SECOND_STR
, strlen(T_SECOND_STR
)))
1093 if (!strncasecmp(unit
, T_MINUTE_STR
, strlen(T_MINUTE_STR
)))
1096 if (!strncasecmp(unit
, T_HOUR_STR
, strlen(T_HOUR_STR
)))
1099 if (!strncasecmp(unit
, T_DAY_STR
, strlen(T_DAY_STR
)))
1100 return 86400 * 1000;
1102 if (!strncasecmp(unit
, T_WEEK_STR
, strlen(T_WEEK_STR
)))
1103 return 86400 * 7 * 1000;
1105 if (!strncasecmp(unit
, T_FORTNIGHT_STR
, strlen(T_FORTNIGHT_STR
)))
1106 return 86400 * 14 * 1000;
1108 if (!strncasecmp(unit
, T_MONTH_STR
, strlen(T_MONTH_STR
)))
1109 return static_cast<uint64_t>(86400) * 30 * 1000;
1111 if (!strncasecmp(unit
, T_YEAR_STR
, strlen(T_YEAR_STR
)))
1112 return static_cast<uint64_t>(86400 * 1000 * 365.2522);
1114 if (!strncasecmp(unit
, T_DECADE_STR
, strlen(T_DECADE_STR
)))
1115 return static_cast<uint64_t>(86400 * 1000 * 365.2522 * 10);
1117 debugs(3, DBG_IMPORTANT
, "parseTimeUnits: unknown time unit '" << unit
<< "'");
1123 parseBytesLine64(int64_t * bptr
, const char *units
)
1130 if ((u
= parseBytesUnits(units
)) == 0) {
1135 if ((token
= ConfigParser::NextToken()) == NULL
) {
1140 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1147 m
= u
; /* default to 'units' if none specified */
1151 else if ((token
= ConfigParser::NextToken()) == NULL
)
1152 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1153 config_input_line
<< "', assuming " <<
1154 d
<< " " << units
);
1155 else if ((m
= parseBytesUnits(token
)) == 0) {
1160 *bptr
= static_cast<int64_t>(m
* d
/ u
);
1162 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1163 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1164 d
<< " " << token
<< ": integer overflow (int64_t).");
1170 parseBytesLine(size_t * bptr
, const char *units
)
1177 if ((u
= parseBytesUnits(units
)) == 0) {
1182 if ((token
= ConfigParser::NextToken()) == NULL
) {
1187 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1188 *bptr
= static_cast<size_t>(-1);
1194 m
= u
; /* default to 'units' if none specified */
1198 else if ((token
= ConfigParser::NextToken()) == NULL
)
1199 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1200 config_input_line
<< "', assuming " <<
1201 d
<< " " << units
);
1202 else if ((m
= parseBytesUnits(token
)) == 0) {
1207 *bptr
= static_cast<size_t>(m
* d
/ u
);
1209 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1210 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1211 d
<< " " << token
<< ": integer overflow (size_t).");
1217 parseBytesLineSigned(ssize_t
* bptr
, const char *units
)
1224 if ((u
= parseBytesUnits(units
)) == 0) {
1229 if ((token
= ConfigParser::NextToken()) == NULL
) {
1234 if (strcmp(token
, "none") == 0 || token
[0] == '-' /* -N */) {
1241 m
= u
; /* default to 'units' if none specified */
1245 else if ((token
= ConfigParser::NextToken()) == NULL
)
1246 debugs(3, DBG_CRITICAL
, "WARNING: No units on '" <<
1247 config_input_line
<< "', assuming " <<
1248 d
<< " " << units
);
1249 else if ((m
= parseBytesUnits(token
)) == 0) {
1254 *bptr
= static_cast<ssize_t
>(m
* d
/ u
);
1256 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2) {
1257 debugs(3, DBG_CRITICAL
, "ERROR: Invalid value '" <<
1258 d
<< " " << token
<< ": integer overflow (ssize_t).");
1264 * Parse bytes from a string.
1265 * Similar to the parseBytesLine function but parses the string value instead of
1266 * the current token value.
1268 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
)
1271 if ((u
= parseBytesUnits(units
)) == 0) {
1276 // Find number from string beginning.
1277 char const * number_begin
= value
;
1278 char const * number_end
= value
;
1280 while ((*number_end
>= '0' && *number_end
<= '9')) {
1285 number
.limitInit(number_begin
, number_end
- number_begin
);
1287 int d
= xatoi(number
.termedBuf());
1289 if ((m
= parseBytesUnits(number_end
)) == 0) {
1294 *bptr
= static_cast<size_t>(m
* d
/ u
);
1295 if (static_cast<double>(*bptr
) * 2 != (m
* d
/ u
) * 2)
1300 parseBytesUnits(const char *unit
)
1302 if (!strncasecmp(unit
, B_BYTES_STR
, strlen(B_BYTES_STR
)))
1305 if (!strncasecmp(unit
, B_KBYTES_STR
, strlen(B_KBYTES_STR
)))
1308 if (!strncasecmp(unit
, B_MBYTES_STR
, strlen(B_MBYTES_STR
)))
1311 if (!strncasecmp(unit
, B_GBYTES_STR
, strlen(B_GBYTES_STR
)))
1314 debugs(3, DBG_CRITICAL
, "WARNING: Unknown bytes unit '" << unit
<< "'");
1320 parse_SBufList(SBufList
* list
)
1322 while (char *token
= ConfigParser::NextQuotedToken())
1323 list
->push_back(SBuf(token
));
1326 // just dump a list, no directive name
1328 dump_SBufList(StoreEntry
* entry
, const SBufList
&words
)
1330 for (const auto &i
: words
) {
1331 entry
->append(i
.rawContent(), i
.length());
1332 entry
->append(" ",1);
1334 entry
->append("\n",1);
1337 // dump a SBufList type directive with name
1339 dump_SBufList(StoreEntry
* entry
, const char *name
, SBufList
&list
)
1341 if (!list
.empty()) {
1342 entry
->append(name
, strlen(name
));
1343 entry
->append(" ", 1);
1344 dump_SBufList(entry
, list
);
1349 free_SBufList(SBufList
*list
)
1356 dump_acl(StoreEntry
* entry
, const char *name
, ACL
* ae
)
1358 while (ae
!= NULL
) {
1359 debugs(3, 3, "dump_acl: " << name
<< " " << ae
->name
);
1360 storeAppendPrintf(entry
, "%s %s %s ",
1365 tail
.splice(tail
.end(), ae
->dumpOptions());
1366 tail
.splice(tail
.end(), ae
->dump()); // ACL parameters
1367 dump_SBufList(entry
, tail
);
1373 parse_acl(ACL
** ae
)
1375 ACL::ParseAclLine(LegacyParser
, ae
);
1385 dump_acl_list(StoreEntry
* entry
, ACLList
* head
)
1387 dump_SBufList(entry
, head
->dump());
1391 dump_acl_access(StoreEntry
* entry
, const char *name
, acl_access
* head
)
1394 dump_SBufList(entry
, head
->treeDump(name
, &Acl::AllowOrDeny
));
1398 parse_acl_access(acl_access
** head
)
1400 aclParseAccessLine(cfg_directive
, LegacyParser
, head
);
1404 free_acl_access(acl_access
** head
)
1406 aclDestroyAccessList(head
);
1410 dump_address(StoreEntry
* entry
, const char *name
, Ip::Address
&addr
)
1412 char buf
[MAX_IPSTRLEN
];
1413 storeAppendPrintf(entry
, "%s %s\n", name
, addr
.toStr(buf
,MAX_IPSTRLEN
) );
1417 parse_address(Ip::Address
*addr
)
1419 char *token
= ConfigParser::NextToken();
1426 if (!strcmp(token
,"any_addr"))
1428 else if ( (!strcmp(token
,"no_addr")) || (!strcmp(token
,"full_mask")) )
1430 else if ( (*addr
= token
) ) // try parse numeric/IPA
1432 else if (addr
->GetHostByName(token
)) // dont use ipcache
1434 else { // not an IP and not a hostname
1435 debugs(3, DBG_CRITICAL
, "FATAL: invalid IP address or domain name '" << token
<< "'");
1441 free_address(Ip::Address
*addr
)
1447 dump_acl_address(StoreEntry
* entry
, const char *name
, Acl::Address
* head
)
1449 char buf
[MAX_IPSTRLEN
];
1451 for (Acl::Address
*l
= head
; l
; l
= l
->next
) {
1452 if (!l
->addr
.isAnyAddr())
1453 storeAppendPrintf(entry
, "%s %s", name
, l
->addr
.toStr(buf
,MAX_IPSTRLEN
));
1455 storeAppendPrintf(entry
, "%s autoselect", name
);
1457 dump_acl_list(entry
, l
->aclList
);
1459 storeAppendPrintf(entry
, "\n");
1464 parse_acl_address(Acl::Address
** head
)
1466 Acl::Address
*l
= new Acl::Address
;
1467 parse_address(&l
->addr
);
1468 aclParseAclList(LegacyParser
, &l
->aclList
, l
->addr
);
1470 Acl::Address
**tail
= head
;
1472 tail
= &(*tail
)->next
;
1478 free_acl_address(Acl::Address
** head
)
1485 dump_acl_tos(StoreEntry
* entry
, const char *name
, acl_tos
* head
)
1489 for (l
= head
; l
; l
= l
->next
) {
1491 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->tos
);
1493 storeAppendPrintf(entry
, "%s none", name
);
1495 dump_acl_list(entry
, l
->aclList
);
1497 storeAppendPrintf(entry
, "\n");
1502 parse_acl_tos(acl_tos
** head
)
1504 unsigned int tos
; /* Initially uint for strtoui. Casted to tos_t before return */
1505 char *token
= ConfigParser::NextToken();
1512 if (!xstrtoui(token
, NULL
, &tos
, 0, std::numeric_limits
<tos_t
>::max())) {
1517 const unsigned int chTos
= tos
& 0xFC;
1519 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: Tos value '" << tos
<< "' adjusted to '" << chTos
<< "'");
1523 acl_tos
*l
= new acl_tos
;
1525 l
->tos
= (tos_t
)tos
;
1527 aclParseAclList(LegacyParser
, &l
->aclList
, token
);
1529 acl_tos
**tail
= head
; /* sane name below */
1531 tail
= &(*tail
)->next
;
1537 free_acl_tos(acl_tos
** head
)
1543 #if SO_MARK && USE_LIBCAP
1546 dump_acl_nfmark(StoreEntry
* entry
, const char *name
, acl_nfmark
* head
)
1548 for (acl_nfmark
*l
= head
; l
; l
= l
->next
) {
1550 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->nfmark
);
1552 storeAppendPrintf(entry
, "%s none", name
);
1554 dump_acl_list(entry
, l
->aclList
);
1556 storeAppendPrintf(entry
, "\n");
1561 parse_acl_nfmark(acl_nfmark
** head
)
1564 char *token
= ConfigParser::NextToken();
1571 if (!xstrtoui(token
, NULL
, &mark
, 0, std::numeric_limits
<nfmark_t
>::max())) {
1576 acl_nfmark
*l
= new acl_nfmark
;
1580 aclParseAclList(LegacyParser
, &l
->aclList
, token
);
1582 acl_nfmark
**tail
= head
; /* sane name below */
1584 tail
= &(*tail
)->next
;
1590 free_acl_nfmark(acl_nfmark
** head
)
1595 #endif /* SO_MARK */
1598 dump_acl_b_size_t(StoreEntry
* entry
, const char *name
, AclSizeLimit
* head
)
1600 for (AclSizeLimit
*l
= head
; l
; l
= l
->next
) {
1602 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) l
->size
, B_BYTES_STR
);
1604 storeAppendPrintf(entry
, "%s none", name
);
1606 dump_acl_list(entry
, l
->aclList
);
1608 storeAppendPrintf(entry
, "\n");
1613 parse_acl_b_size_t(AclSizeLimit
** head
)
1615 AclSizeLimit
*l
= new AclSizeLimit
;
1617 parse_b_int64_t(&l
->size
);
1619 aclParseAclList(LegacyParser
, &l
->aclList
, l
->size
);
1621 AclSizeLimit
**tail
= head
; /* sane name below */
1623 tail
= &(*tail
)->next
;
1629 free_acl_b_size_t(AclSizeLimit
** head
)
1637 #include "DelayConfig.h"
1638 #include "DelayPools.h"
1639 /* do nothing - free_delay_pool_count is the magic free function.
1640 * this is why delay_pool_count isn't just marked TYPE: u_short
1642 #define free_delay_pool_class(X)
1643 #define free_delay_pool_access(X)
1644 #define free_delay_pool_rates(X)
1645 #define dump_delay_pool_class(X, Y, Z)
1646 #define dump_delay_pool_access(X, Y, Z)
1647 #define dump_delay_pool_rates(X, Y, Z)
1650 free_delay_pool_count(DelayConfig
* cfg
)
1652 cfg
->freePoolCount();
1656 dump_delay_pool_count(StoreEntry
* entry
, const char *name
, DelayConfig
&cfg
)
1658 cfg
.dumpPoolCount (entry
, name
);
1662 parse_delay_pool_count(DelayConfig
* cfg
)
1664 cfg
->parsePoolCount();
1668 parse_delay_pool_class(DelayConfig
* cfg
)
1670 cfg
->parsePoolClass();
1674 parse_delay_pool_rates(DelayConfig
* cfg
)
1676 cfg
->parsePoolRates();
1680 parse_delay_pool_access(DelayConfig
* cfg
)
1682 cfg
->parsePoolAccess(LegacyParser
);
1688 #include "ClientDelayConfig.h"
1689 /* do nothing - free_client_delay_pool_count is the magic free function.
1690 * this is why client_delay_pool_count isn't just marked TYPE: u_short
1693 #define free_client_delay_pool_access(X)
1694 #define free_client_delay_pool_rates(X)
1695 #define dump_client_delay_pool_access(X, Y, Z)
1696 #define dump_client_delay_pool_rates(X, Y, Z)
1699 free_client_delay_pool_count(ClientDelayConfig
* cfg
)
1705 dump_client_delay_pool_count(StoreEntry
* entry
, const char *name
, ClientDelayConfig
&cfg
)
1707 cfg
.dumpPoolCount (entry
, name
);
1711 parse_client_delay_pool_count(ClientDelayConfig
* cfg
)
1713 cfg
->parsePoolCount();
1717 parse_client_delay_pool_rates(ClientDelayConfig
* cfg
)
1719 cfg
->parsePoolRates();
1723 parse_client_delay_pool_access(ClientDelayConfig
* cfg
)
1725 cfg
->parsePoolAccess(LegacyParser
);
1729 #if USE_HTTP_VIOLATIONS
1731 dump_http_header_access(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
)
1734 manglers
->dumpAccess(entry
, name
);
1738 parse_http_header_access(HeaderManglers
**pm
)
1742 if ((t
= ConfigParser::NextToken()) == NULL
) {
1743 debugs(3, DBG_CRITICAL
, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1744 debugs(3, DBG_CRITICAL
, "parse_http_header_access: missing header name.");
1749 *pm
= new HeaderManglers
;
1750 HeaderManglers
*manglers
= *pm
;
1751 headerMangler
*mangler
= manglers
->track(t
);
1754 std::string directive
= "http_header_access ";
1756 aclParseAccessLine(directive
.c_str(), LegacyParser
, &mangler
->access_list
);
1760 free_HeaderManglers(HeaderManglers
**pm
)
1762 // we delete the entire http_header_* mangler configuration at once
1763 if (const HeaderManglers
*manglers
= *pm
) {
1770 dump_http_header_replace(StoreEntry
* entry
, const char *name
, const HeaderManglers
*manglers
)
1773 manglers
->dumpReplacement(entry
, name
);
1777 parse_http_header_replace(HeaderManglers
**pm
)
1781 if ((t
= ConfigParser::NextToken()) == NULL
) {
1782 debugs(3, DBG_CRITICAL
, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1783 debugs(3, DBG_CRITICAL
, "parse_http_header_replace: missing header name.");
1787 const char *value
= ConfigParser::NextQuotedOrToEol();
1790 *pm
= new HeaderManglers
;
1791 HeaderManglers
*manglers
= *pm
;
1792 manglers
->setReplacement(t
, value
);
1798 dump_cachedir(StoreEntry
* entry
, const char *name
, const Store::DiskConfig
&swap
)
1804 for (i
= 0; i
< swap
.n_configured
; ++i
) {
1805 s
= dynamic_cast<SwapDir
*>(swap
.swapDirs
[i
].getRaw());
1807 storeAppendPrintf(entry
, "%s %s %s", name
, s
->type(), s
->path
);
1809 storeAppendPrintf(entry
, "\n");
1814 check_null_string(char *s
)
1821 parse_authparam(Auth::ConfigVector
* config
)
1823 char *type_str
= ConfigParser::NextToken();
1829 char *param_str
= ConfigParser::NextToken();
1835 /* find a configuration for the scheme in the currently parsed configs... */
1836 Auth::SchemeConfig
*schemeCfg
= Auth::SchemeConfig::Find(type_str
);
1838 if (schemeCfg
== NULL
) {
1839 /* Create a configuration based on the scheme info */
1840 Auth::Scheme::Pointer theScheme
= Auth::Scheme::Find(type_str
);
1842 if (theScheme
== NULL
) {
1843 debugs(3, DBG_CRITICAL
, "Parsing Config File: Unknown authentication scheme '" << type_str
<< "'.");
1848 config
->push_back(theScheme
->createConfig());
1849 schemeCfg
= Auth::SchemeConfig::Find(type_str
);
1850 if (schemeCfg
== NULL
) {
1851 debugs(3, DBG_CRITICAL
, "Parsing Config File: Corruption configuring authentication scheme '" << type_str
<< "'.");
1857 schemeCfg
->parse(schemeCfg
, config
->size(), param_str
);
1861 free_authparam(Auth::ConfigVector
* cfg
)
1863 /* Wipe the Auth globals and Detach/Destruct component config + state. */
1866 /* on reconfigure initialize new auth schemes for the new config. */
1867 if (reconfiguring
) {
1873 dump_authparam(StoreEntry
* entry
, const char *name
, Auth::ConfigVector cfg
)
1875 for (auto *scheme
: cfg
)
1876 scheme
->dump(entry
, name
, scheme
);
1880 parse_AuthSchemes(acl_access
**authSchemes
)
1882 const char *tok
= ConfigParser::NextQuotedToken();
1884 debugs(29, DBG_CRITICAL
, "FATAL: auth_schemes missing the parameter");
1888 Auth::TheConfig
.schemeLists
.emplace_back(tok
, ConfigParser::LastTokenWasQuoted());
1889 const allow_t action
= allow_t(ACCESS_ALLOWED
, Auth::TheConfig
.schemeLists
.size() - 1);
1890 ParseAclWithAction(authSchemes
, action
, "auth_schemes");
1894 free_AuthSchemes(acl_access
**authSchemes
)
1896 Auth::TheConfig
.schemeLists
.clear();
1897 free_acl_access(authSchemes
);
1901 dump_AuthSchemes(StoreEntry
*entry
, const char *name
, acl_access
*authSchemes
)
1904 dump_SBufList(entry
, authSchemes
->treeDump(name
, [](const allow_t
&action
) {
1905 return Auth::TheConfig
.schemeLists
.at(action
.kind
).rawSchemes
;
1909 #endif /* USE_AUTH */
1912 ParseAclWithAction(acl_access
**access
, const allow_t
&action
, const char *desc
, ACL
*acl
)
1917 *access
= new Acl::Tree
;
1918 name
.Printf("(%s rules)", desc
);
1919 (*access
)->context(name
.c_str(), config_input_line
);
1921 Acl::AndNode
*rule
= new Acl::AndNode
;
1922 name
.Printf("(%s rule)", desc
);
1923 rule
->context(name
.c_str(), config_input_line
);
1924 acl
? rule
->add(acl
) : rule
->lineParse();
1925 (*access
)->add(rule
, action
);
1928 /* TODO: just return the object, the # is irrelevant */
1930 find_fstype(char *type
)
1932 for (size_t i
= 0; i
< StoreFileSystem::FileSystems().size(); ++i
)
1933 if (strcasecmp(type
, StoreFileSystem::FileSystems().at(i
)->type()) == 0)
1940 parse_cachedir(Store::DiskConfig
*swap
)
1942 char *type_str
= ConfigParser::NextToken();
1948 char *path_str
= ConfigParser::NextToken();
1954 int fs
= find_fstype(type_str
);
1956 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: This proxy does not support the '" << type_str
<< "' cache type. Ignoring.");
1960 /* reconfigure existing dir */
1962 RefCount
<SwapDir
> sd
;
1963 for (int i
= 0; i
< swap
->n_configured
; ++i
) {
1964 assert (swap
->swapDirs
[i
].getRaw());
1966 if ((strcasecmp(path_str
, dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw())->path
)) == 0) {
1967 /* this is specific to on-fs Stores. The right
1968 * way to handle this is probably to have a mapping
1969 * from paths to stores, and have on-fs stores
1970 * register with that, and lookip in that in their
1971 * own setup logic. RBC 20041225. TODO.
1974 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw());
1976 if (strcmp(sd
->type(), StoreFileSystem::FileSystems().at(fs
)->type()) != 0) {
1977 debugs(3, DBG_CRITICAL
, "ERROR: Can't change type of existing cache_dir " <<
1978 sd
->type() << " " << sd
->path
<< " to " << type_str
<< ". Restart required");
1988 if (swap
->n_configured
> 63) {
1989 /* 7 bits, signed */
1990 debugs(3, DBG_CRITICAL
, "WARNING: There is a fixed maximum of 63 cache_dir entries Squid can handle.");
1991 debugs(3, DBG_CRITICAL
, "WARNING: '" << path_str
<< "' is one to many.");
1996 allocate_new_swapdir(swap
);
1998 swap
->swapDirs
[swap
->n_configured
] = StoreFileSystem::FileSystems().at(fs
)->createSwapDir();
2000 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[swap
->n_configured
].getRaw());
2002 /* parse the FS parameters and options */
2003 sd
->parse(swap
->n_configured
, path_str
);
2005 ++swap
->n_configured
;
2009 peer_type_str(const peer_t type
)
2011 const char * result
;
2023 case PEER_MULTICAST
:
2024 result
= "multicast";
2036 dump_peer(StoreEntry
* entry
, const char *name
, CachePeer
* p
)
2038 NeighborTypeDomainList
*t
;
2039 LOCAL_ARRAY(char, xname
, 128);
2042 storeAppendPrintf(entry
, "%s %s %s %d %d name=%s",
2049 dump_peer_options(entry
, p
);
2052 snprintf(xname
, 128, "cache_peer_access %s", p
->name
);
2053 dump_acl_access(entry
, xname
, p
->access
);
2056 for (t
= p
->typelist
; t
; t
= t
->next
) {
2057 storeAppendPrintf(entry
, "neighbor_type_domain %s %s %s\n",
2059 peer_type_str(t
->type
),
2068 * utility function to prevent getservbyname() being called with a numeric value
2069 * on Windows at least it returns garage results.
2072 isUnsignedNumeric(const char *str
, size_t len
)
2074 if (len
< 1) return false;
2076 for (; len
>0 && *str
; ++str
, --len
) {
2077 if (! isdigit(*str
))
2084 \param proto 'tcp' or 'udp' for protocol
2085 \returns Port the named service is supposed to be listening on.
2087 static unsigned short
2088 GetService(const char *proto
)
2090 struct servent
*port
= NULL
;
2091 /** Parses a port number or service name from the squid.conf */
2092 char *token
= ConfigParser::NextToken();
2093 if (token
== NULL
) {
2095 return 0; /* NEVER REACHED */
2097 /** Returns either the service port number from /etc/services */
2098 if ( !isUnsignedNumeric(token
, strlen(token
)) )
2099 port
= getservbyname(token
, proto
);
2101 return ntohs((unsigned short)port
->s_port
);
2103 /** Or a numeric translation of the config text. */
2104 return xatos(token
);
2108 \returns Port the named TCP service is supposed to be listening on.
2109 \copydoc GetService(const char *proto)
2111 inline unsigned short
2114 return GetService("tcp");
2118 \returns Port the named UDP service is supposed to be listening on.
2119 \copydoc GetService(const char *proto)
2121 inline unsigned short
2124 return GetService("udp");
2128 parse_peer(CachePeer
** head
)
2130 char *host_str
= ConfigParser::NextToken();
2136 char *token
= ConfigParser::NextToken();
2142 CachePeer
*p
= new CachePeer
;
2143 p
->host
= xstrdup(host_str
);
2144 p
->name
= xstrdup(host_str
);
2145 p
->type
= parseNeighborType(token
);
2147 if (p
->type
== PEER_MULTICAST
) {
2148 p
->options
.no_digest
= true;
2149 p
->options
.no_netdb_exchange
= true;
2152 p
->http_port
= GetTcpService();
2154 if (!p
->http_port
) {
2160 p
->icp
.port
= GetUdpService();
2162 while ((token
= ConfigParser::NextToken())) {
2163 if (!strcmp(token
, "proxy-only")) {
2164 p
->options
.proxy_only
= true;
2165 } else if (!strcmp(token
, "no-query")) {
2166 p
->options
.no_query
= true;
2167 } else if (!strcmp(token
, "background-ping")) {
2168 p
->options
.background_ping
= true;
2169 } else if (!strcmp(token
, "no-digest")) {
2170 p
->options
.no_digest
= true;
2171 } else if (!strcmp(token
, "no-tproxy")) {
2172 p
->options
.no_tproxy
= true;
2173 } else if (!strcmp(token
, "multicast-responder")) {
2174 p
->options
.mcast_responder
= true;
2175 #if PEER_MULTICAST_SIBLINGS
2176 } else if (!strcmp(token
, "multicast-siblings")) {
2177 p
->options
.mcast_siblings
= true;
2179 } else if (!strncmp(token
, "weight=", 7)) {
2180 p
->weight
= xatoi(token
+ 7);
2181 } else if (!strncmp(token
, "basetime=", 9)) {
2182 p
->basetime
= xatoi(token
+ 9);
2183 } else if (!strcmp(token
, "closest-only")) {
2184 p
->options
.closest_only
= true;
2185 } else if (!strncmp(token
, "ttl=", 4)) {
2186 p
->mcast
.ttl
= xatoi(token
+ 4);
2188 if (p
->mcast
.ttl
< 0)
2191 if (p
->mcast
.ttl
> 128)
2193 } else if (!strcmp(token
, "default")) {
2194 p
->options
.default_parent
= true;
2195 } else if (!strcmp(token
, "round-robin")) {
2196 p
->options
.roundrobin
= true;
2197 } else if (!strcmp(token
, "weighted-round-robin")) {
2198 p
->options
.weighted_roundrobin
= true;
2200 } else if (!strcmp(token
, "htcp")) {
2201 p
->options
.htcp
= true;
2202 } else if (!strncmp(token
, "htcp=", 5) || !strncmp(token
, "htcp-", 5)) {
2203 /* Note: The htcp- form is deprecated, replaced by htcp= */
2204 p
->options
.htcp
= true;
2205 char *tmp
= xstrdup(token
+5);
2206 char *mode
, *nextmode
;
2207 for (mode
= nextmode
= tmp
; mode
; mode
= nextmode
) {
2208 nextmode
= strchr(mode
, ',');
2213 if (!strcmp(mode
, "no-clr")) {
2214 if (p
->options
.htcp_only_clr
)
2215 fatalf("parse_peer: can't set htcp-no-clr and htcp-only-clr simultaneously");
2216 p
->options
.htcp_no_clr
= true;
2217 } else if (!strcmp(mode
, "no-purge-clr")) {
2218 p
->options
.htcp_no_purge_clr
= true;
2219 } else if (!strcmp(mode
, "only-clr")) {
2220 if (p
->options
.htcp_no_clr
)
2221 fatalf("parse_peer: can't set htcp no-clr and only-clr simultaneously");
2222 p
->options
.htcp_only_clr
= true;
2223 } else if (!strcmp(mode
, "forward-clr")) {
2224 p
->options
.htcp_forward_clr
= true;
2225 } else if (!strcmp(mode
, "oldsquid")) {
2226 p
->options
.htcp_oldsquid
= true;
2228 fatalf("invalid HTCP mode '%s'", mode
);
2233 } else if (!strcmp(token
, "no-netdb-exchange")) {
2234 p
->options
.no_netdb_exchange
= true;
2236 } else if (!strcmp(token
, "carp")) {
2237 if (p
->type
!= PEER_PARENT
)
2238 fatalf("parse_peer: non-parent carp peer %s/%d\n", p
->host
, p
->http_port
);
2240 p
->options
.carp
= true;
2241 } else if (!strncmp(token
, "carp-key=", 9)) {
2242 if (p
->options
.carp
!= true)
2243 fatalf("parse_peer: carp-key specified on non-carp peer %s/%d\n", p
->host
, p
->http_port
);
2244 p
->options
.carp_key
.set
= true;
2245 char *nextkey
=token
+strlen("carp-key="), *key
=nextkey
;
2246 for (; key
; key
= nextkey
) {
2247 nextkey
=strchr(key
,',');
2248 if (nextkey
) ++nextkey
; // skip the comma, any
2249 if (0==strncmp(key
,"scheme",6)) {
2250 p
->options
.carp_key
.scheme
= true;
2251 } else if (0==strncmp(key
,"host",4)) {
2252 p
->options
.carp_key
.host
= true;
2253 } else if (0==strncmp(key
,"port",4)) {
2254 p
->options
.carp_key
.port
= true;
2255 } else if (0==strncmp(key
,"path",4)) {
2256 p
->options
.carp_key
.path
= true;
2257 } else if (0==strncmp(key
,"params",6)) {
2258 p
->options
.carp_key
.params
= true;
2260 fatalf("invalid carp-key '%s'",key
);
2263 } else if (!strcmp(token
, "userhash")) {
2265 if (p
->type
!= PEER_PARENT
)
2266 fatalf("parse_peer: non-parent userhash peer %s/%d\n", p
->host
, p
->http_port
);
2268 p
->options
.userhash
= true;
2270 fatalf("parse_peer: userhash requires authentication. peer %s/%d\n", p
->host
, p
->http_port
);
2272 } else if (!strcmp(token
, "sourcehash")) {
2273 if (p
->type
!= PEER_PARENT
)
2274 fatalf("parse_peer: non-parent sourcehash peer %s/%d\n", p
->host
, p
->http_port
);
2276 p
->options
.sourcehash
= true;
2278 } else if (!strcmp(token
, "no-delay")) {
2280 p
->options
.no_delay
= true;
2282 debugs(0, DBG_CRITICAL
, "WARNING: cache_peer option 'no-delay' requires --enable-delay-pools");
2284 } else if (!strncmp(token
, "login=", 6)) {
2285 p
->login
= xstrdup(token
+ 6);
2286 rfc1738_unescape(p
->login
);
2287 } else if (!strcmp(token
, "auth-no-keytab")) {
2288 p
->options
.auth_no_keytab
= 1;
2289 } else if (!strncmp(token
, "connect-timeout=", 16)) {
2290 p
->connect_timeout_raw
= xatoi(token
+ 16);
2291 } else if (!strncmp(token
, "connect-fail-limit=", 19)) {
2292 p
->connect_fail_limit
= xatoi(token
+ 19);
2293 #if USE_CACHE_DIGESTS
2294 } else if (!strncmp(token
, "digest-url=", 11)) {
2295 p
->digest_url
= xstrdup(token
+ 11);
2298 } else if (!strcmp(token
, "allow-miss")) {
2299 p
->options
.allow_miss
= true;
2300 } else if (!strncmp(token
, "max-conn=", 9)) {
2301 p
->max_conn
= xatoi(token
+ 9);
2302 } else if (!strncmp(token
, "standby=", 8)) {
2303 p
->standby
.limit
= xatoi(token
+ 8);
2304 } else if (!strcmp(token
, "originserver")) {
2305 p
->options
.originserver
= true;
2306 } else if (!strncmp(token
, "name=", 5)) {
2310 p
->name
= xstrdup(token
+ 5);
2311 } else if (!strncmp(token
, "forceddomain=", 13)) {
2312 safe_free(p
->domain
);
2314 p
->domain
= xstrdup(token
+ 13);
2316 } else if (strncmp(token
, "ssl", 3) == 0) {
2318 debugs(0, DBG_CRITICAL
, "WARNING: cache_peer option '" << token
<< "' requires --with-openssl");
2320 p
->secure
.parse(token
+3);
2322 } else if (strncmp(token
, "tls-", 4) == 0) {
2323 p
->secure
.parse(token
+4);
2324 } else if (strncmp(token
, "tls", 3) == 0) {
2325 p
->secure
.parse(token
+3);
2326 } else if (strcmp(token
, "front-end-https") == 0) {
2327 p
->front_end_https
= 1;
2328 } else if (strcmp(token
, "front-end-https=on") == 0) {
2329 p
->front_end_https
= 1;
2330 } else if (strcmp(token
, "front-end-https=auto") == 0) {
2331 p
->front_end_https
= 2;
2332 } else if (strcmp(token
, "connection-auth=off") == 0) {
2333 p
->connection_auth
= 0;
2334 } else if (strcmp(token
, "connection-auth") == 0) {
2335 p
->connection_auth
= 1;
2336 } else if (strcmp(token
, "connection-auth=on") == 0) {
2337 p
->connection_auth
= 1;
2338 } else if (strcmp(token
, "connection-auth=auto") == 0) {
2339 p
->connection_auth
= 2;
2340 } else if (token
[0] == '#') {
2341 // start of a text comment. stop reading this line.
2344 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Ignoring unknown cache_peer option '" << token
<< "'");
2348 if (peerFindByName(p
->name
))
2349 fatalf("ERROR: cache_peer %s specified twice\n", p
->name
);
2351 if (p
->max_conn
> 0 && p
->max_conn
< p
->standby
.limit
)
2352 fatalf("ERROR: cache_peer %s max-conn=%d is lower than its standby=%d\n", p
->host
, p
->max_conn
, p
->standby
.limit
);
2357 if (p
->connect_fail_limit
< 1)
2358 p
->connect_fail_limit
= 10;
2360 #if USE_CACHE_DIGESTS
2362 if (!p
->options
.no_digest
) {
2363 /* XXX This looks odd.. who has the original pointer
2366 PeerDigest
*pd
= peerDigestCreate(p
);
2367 p
->digest
= cbdataReference(pd
);
2372 p
->index
= ++Config
.npeers
;
2374 while (*head
!= NULL
)
2375 head
= &(*head
)->next
;
2383 free_peer(CachePeer
** P
)
2391 dump_cachemgrpasswd(StoreEntry
* entry
, const char *name
, Mgr::ActionPasswordList
* list
)
2394 if (strcmp(list
->passwd
, "none") && strcmp(list
->passwd
, "disable"))
2395 storeAppendPrintf(entry
, "%s XXXXXXXXXX", name
);
2397 storeAppendPrintf(entry
, "%s %s", name
, list
->passwd
);
2399 for (auto w
: list
->actions
)
2400 entry
->appendf(" " SQUIDSBUFPH
, SQUIDSBUFPRINT(w
));
2402 storeAppendPrintf(entry
, "\n");
2408 parse_cachemgrpasswd(Mgr::ActionPasswordList
** head
)
2410 char *passwd
= nullptr;
2411 parse_string(&passwd
);
2413 Mgr::ActionPasswordList
*p
= new Mgr::ActionPasswordList
;
2416 while (char *token
= ConfigParser::NextQuotedToken())
2417 p
->actions
.push_back(SBuf(token
));
2419 Mgr::ActionPasswordList
**P
;
2420 for (P
= head
; *P
; P
= &(*P
)->next
) {
2422 * See if any of the actions from this line already have a
2423 * password from previous lines. The password checking
2424 * routines in cache_manager.c take the the password from
2425 * the first Mgr::ActionPasswordList that contains the
2426 * requested action. Thus, we should warn users who might
2427 * think they can have two passwords for the same action.
2429 for (const auto &w
: (*P
)->actions
) {
2430 for (const auto &u
: p
->actions
) {
2434 debugs(0, DBG_PARSE_NOTE(1), "ERROR: action '" << u
<< "' (line " << config_lineno
<< ") already has a password");
2443 free_cachemgrpasswd(Mgr::ActionPasswordList
** head
)
2450 dump_denyinfo(StoreEntry
* entry
, const char *name
, AclDenyInfoList
* var
)
2452 while (var
!= NULL
) {
2453 storeAppendPrintf(entry
, "%s %s", name
, var
->err_page_name
);
2455 for (auto *a
= var
->acl_list
; a
!= NULL
; a
= a
->next
)
2456 storeAppendPrintf(entry
, " %s", a
->name
);
2458 storeAppendPrintf(entry
, "\n");
2465 parse_denyinfo(AclDenyInfoList
** var
)
2467 aclParseDenyInfoLine(var
);
2471 free_denyinfo(AclDenyInfoList
** list
)
2478 parse_peer_access(void)
2480 char *host
= ConfigParser::NextToken();
2486 CachePeer
*p
= peerFindByName(host
);
2488 debugs(15, DBG_CRITICAL
, "ERROR: " << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2492 std::string directive
= "peer_access ";
2494 aclParseAccessLine(directive
.c_str(), LegacyParser
, &p
->access
);
2498 parse_hostdomaintype(void)
2500 char *host
= ConfigParser::NextToken();
2506 char *type
= ConfigParser::NextToken();
2512 char *domain
= nullptr;
2513 while ((domain
= ConfigParser::NextToken())) {
2514 CachePeer
*p
= peerFindByName(host
);
2516 debugs(15, DBG_CRITICAL
, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2520 auto *l
= static_cast<NeighborTypeDomainList
*>(xcalloc(1, sizeof(NeighborTypeDomainList
)));
2521 l
->type
= parseNeighborType(type
);
2522 l
->domain
= xstrdup(domain
);
2524 NeighborTypeDomainList
**L
= nullptr;
2525 for (L
= &(p
->typelist
); *L
; L
= &((*L
)->next
));
2531 dump_int(StoreEntry
* entry
, const char *name
, int var
)
2533 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
2551 dump_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
2553 storeAppendPrintf(entry
, "%s %" PRId64
"\n", name
, var
);
2557 parse_int64_t(int64_t *var
)
2565 free_int64_t(int64_t *var
)
2571 dump_onoff(StoreEntry
* entry
, const char *name
, int var
)
2573 storeAppendPrintf(entry
, "%s %s\n", name
, var
? "on" : "off");
2577 parse_onoff(int *var
)
2579 char *token
= ConfigParser::NextToken();
2585 if (!strcmp(token
, "on")) {
2587 } else if (!strcmp(token
, "enable")) {
2588 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'enable' is deprecated. Please update to use 'on'.");
2590 } else if (!strcmp(token
, "off")) {
2592 } else if (!strcmp(token
, "disable")) {
2593 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'disable' is deprecated. Please update to use 'off'.");
2596 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Invalid option: Boolean options can only be 'on' or 'off'.");
2601 #define free_onoff free_int
2604 dump_tristate(StoreEntry
* entry
, const char *name
, int var
)
2615 storeAppendPrintf(entry
, "%s %s\n", name
, state
);
2619 parse_tristate(int *var
)
2621 char *token
= ConfigParser::NextToken();
2627 if (!strcmp(token
, "on")) {
2629 } else if (!strcmp(token
, "enable")) {
2630 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'enable' is deprecated. Please update to use value 'on'.");
2632 } else if (!strcmp(token
, "warn")) {
2634 } else if (!strcmp(token
, "off")) {
2636 } else if (!strcmp(token
, "disable")) {
2637 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'disable' is deprecated. Please update to use value 'off'.");
2640 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "ERROR: Invalid option: Tristate options can only be 'on', 'off', or 'warn'.");
2645 #define free_tristate free_int
2648 parse_pipelinePrefetch(int *var
)
2650 char *token
= ConfigParser::PeekAtToken();
2656 if (!strcmp(token
, "on")) {
2657 debugs(0, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: 'pipeline_prefetch on' is deprecated. Please update to use 1 (or a higher number).");
2660 (void)ConfigParser::NextToken();
2661 } else if (!strcmp(token
, "off")) {
2662 debugs(0, DBG_PARSE_NOTE(2), "WARNING: 'pipeline_prefetch off' is deprecated. Please update to use '0'.");
2665 (void)ConfigParser::NextToken();
2670 #define free_pipelinePrefetch free_int
2671 #define dump_pipelinePrefetch dump_int
2674 dump_refreshpattern(StoreEntry
* entry
, const char *name
, RefreshPattern
* head
)
2676 while (head
!= NULL
) {
2677 storeAppendPrintf(entry
, "%s%s %s %d %d%% %d",
2679 head
->pattern
.flags
®_ICASE
? " -i" : null_string
,
2680 head
->pattern
.c_str(),
2681 (int) head
->min
/ 60,
2682 (int) (100.0 * head
->pct
+ 0.5),
2683 (int) head
->max
/ 60);
2685 if (head
->max_stale
>= 0)
2686 storeAppendPrintf(entry
, " max-stale=%d", head
->max_stale
);
2688 if (head
->flags
.refresh_ims
)
2689 storeAppendPrintf(entry
, " refresh-ims");
2691 if (head
->flags
.store_stale
)
2692 storeAppendPrintf(entry
, " store-stale");
2694 #if USE_HTTP_VIOLATIONS
2696 if (head
->flags
.override_expire
)
2697 storeAppendPrintf(entry
, " override-expire");
2699 if (head
->flags
.override_lastmod
)
2700 storeAppendPrintf(entry
, " override-lastmod");
2702 if (head
->flags
.reload_into_ims
)
2703 storeAppendPrintf(entry
, " reload-into-ims");
2705 if (head
->flags
.ignore_reload
)
2706 storeAppendPrintf(entry
, " ignore-reload");
2708 if (head
->flags
.ignore_no_store
)
2709 storeAppendPrintf(entry
, " ignore-no-store");
2711 if (head
->flags
.ignore_private
)
2712 storeAppendPrintf(entry
, " ignore-private");
2715 storeAppendPrintf(entry
, "\n");
2722 parse_refreshpattern(RefreshPattern
** head
)
2729 int refresh_ims
= 0;
2730 int store_stale
= 0;
2733 #if USE_HTTP_VIOLATIONS
2735 int override_expire
= 0;
2736 int override_lastmod
= 0;
2737 int reload_into_ims
= 0;
2738 int ignore_reload
= 0;
2739 int ignore_no_store
= 0;
2740 int ignore_private
= 0;
2747 int flags
= REG_EXTENDED
| REG_NOSUB
;
2749 if ((token
= ConfigParser::RegexPattern()) != NULL
) {
2751 if (strcmp(token
, "-i") == 0) {
2753 token
= ConfigParser::RegexPattern();
2754 } else if (strcmp(token
, "+i") == 0) {
2755 flags
&= ~REG_ICASE
;
2756 token
= ConfigParser::RegexPattern();
2761 if (token
== NULL
) {
2762 debugs(3, DBG_CRITICAL
, "FATAL: refresh_pattern missing the regex pattern parameter");
2767 pattern
= xstrdup(token
);
2769 i
= GetInteger(); /* token: min */
2771 /* catch negative and insanely huge values close to 32-bit wrap */
2773 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age negative. Cropped back to zero.");
2776 if (i
> 60*24*365) {
2777 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age too high. Cropped back to 1 year.");
2781 min
= (time_t) (i
* 60); /* convert minutes to seconds */
2783 pct
= GetPercentage(false); /* token: pct . with no limit on size */
2785 i
= GetInteger(); /* token: max */
2787 /* catch negative and insanely huge values close to 32-bit wrap */
2789 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age negative. Cropped back to zero.");
2792 if (i
> 60*24*365) {
2793 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age too high. Cropped back to 1 year.");
2797 max
= (time_t) (i
* 60); /* convert minutes to seconds */
2800 while ((token
= ConfigParser::NextToken()) != NULL
) {
2801 if (!strcmp(token
, "refresh-ims")) {
2803 } else if (!strcmp(token
, "store-stale")) {
2805 } else if (!strncmp(token
, "max-stale=", 10)) {
2806 max_stale
= xatoi(token
+ 10);
2808 #if USE_HTTP_VIOLATIONS
2810 } else if (!strcmp(token
, "override-expire"))
2811 override_expire
= 1;
2812 else if (!strcmp(token
, "override-lastmod"))
2813 override_lastmod
= 1;
2814 else if (!strcmp(token
, "ignore-no-store"))
2815 ignore_no_store
= 1;
2816 else if (!strcmp(token
, "ignore-private"))
2818 else if (!strcmp(token
, "reload-into-ims")) {
2819 reload_into_ims
= 1;
2820 refresh_nocache_hack
= 1;
2821 /* tell client_side.c that this is used */
2822 } else if (!strcmp(token
, "ignore-reload")) {
2824 refresh_nocache_hack
= 1;
2825 /* tell client_side.c that this is used */
2828 } else if (!strcmp(token
, "ignore-no-cache") ||
2829 !strcmp(token
, "ignore-must-revalidate") ||
2830 !strcmp(token
, "ignore-auth")
2832 debugs(22, DBG_PARSE_NOTE(2), "UPGRADE: refresh_pattern option '" << token
<< "' is obsolete. Remove it.");
2834 debugs(22, DBG_CRITICAL
, "refreshAddToList: Unknown option '" << pattern
<< "': " << token
);
2837 if ((errcode
= regcomp(&comp
, pattern
, flags
)) != 0) {
2839 regerror(errcode
, &comp
, errbuf
, sizeof errbuf
);
2840 debugs(22, DBG_CRITICAL
, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
2841 debugs(22, DBG_CRITICAL
, "refreshAddToList: Invalid regular expression '" << pattern
<< "': " << errbuf
);
2846 pct
= pct
< 0.0 ? 0.0 : pct
;
2847 max
= max
< 0 ? 0 : max
;
2848 t
= new RefreshPattern(pattern
, flags
);
2849 t
->pattern
.regex
= comp
;
2855 t
->flags
.refresh_ims
= true;
2858 t
->flags
.store_stale
= true;
2860 t
->max_stale
= max_stale
;
2862 #if USE_HTTP_VIOLATIONS
2864 if (override_expire
)
2865 t
->flags
.override_expire
= true;
2867 if (override_lastmod
)
2868 t
->flags
.override_lastmod
= true;
2870 if (reload_into_ims
)
2871 t
->flags
.reload_into_ims
= true;
2874 t
->flags
.ignore_reload
= true;
2876 if (ignore_no_store
)
2877 t
->flags
.ignore_no_store
= true;
2880 t
->flags
.ignore_private
= true;
2886 head
= &(*head
)->next
;
2894 free_refreshpattern(RefreshPattern
** head
)
2899 #if USE_HTTP_VIOLATIONS
2900 refresh_nocache_hack
= 0;
2906 dump_string(StoreEntry
* entry
, const char *name
, char *var
)
2909 storeAppendPrintf(entry
, "%s %s\n", name
, var
);
2913 parse_string(char **var
)
2917 char *token
= ConfigParser::NextToken();
2923 *var
= xstrdup(token
);
2927 free_string(char **var
)
2933 parse_eol(char *volatile *var
)
2940 unsigned char *token
= (unsigned char *) ConfigParser::NextQuotedOrToEol();
2948 while (*token
&& xisspace(*token
))
2956 *var
= xstrdup((char *) token
);
2959 #define dump_eol dump_string
2960 #define free_eol free_string
2963 parse_TokenOrQuotedString(char **var
)
2967 char *token
= ConfigParser::NextQuotedToken();
2973 *var
= xstrdup(token
);
2976 #define dump_TokenOrQuotedString dump_string
2977 #define free_TokenOrQuotedString free_string
2980 dump_time_t(StoreEntry
* entry
, const char *name
, time_t var
)
2982 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int) var
);
2986 parse_time_t(time_t * var
)
2989 parseTimeLine(&tval
, T_SECOND_STR
, false);
2990 *var
= static_cast<time_t>(tval
/1000);
2994 free_time_t(time_t * var
)
3000 dump_time_msec(StoreEntry
* entry
, const char *name
, time_msec_t var
)
3003 storeAppendPrintf(entry
, "%s %" PRId64
" milliseconds\n", name
, var
);
3005 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int)(var
/1000) );
3009 parse_time_msec(time_msec_t
* var
)
3011 parseTimeLine(var
, T_SECOND_STR
, true);
3015 free_time_msec(time_msec_t
* var
)
3022 dump_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3024 storeAppendPrintf(entry
, "%s %d\n", name
, (int) var
);
3029 dump_b_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3031 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3035 dump_b_ssize_t(StoreEntry
* entry
, const char *name
, ssize_t var
)
3037 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3042 dump_kb_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3044 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_KBYTES_STR
);
3049 dump_b_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3051 storeAppendPrintf(entry
, "%s %" PRId64
" %s\n", name
, var
, B_BYTES_STR
);
3055 dump_kb_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3057 storeAppendPrintf(entry
, "%s %" PRId64
" %s\n", name
, var
, B_KBYTES_STR
);
3062 parse_size_t(size_t * var
)
3071 parse_b_size_t(size_t * var
)
3073 parseBytesLine(var
, B_BYTES_STR
);
3077 parse_b_ssize_t(ssize_t
* var
)
3079 parseBytesLineSigned(var
, B_BYTES_STR
);
3084 parse_kb_size_t(size_t * var
)
3086 parseBytesLine(var
, B_KBYTES_STR
);
3091 parse_b_int64_t(int64_t * var
)
3093 parseBytesLine64(var
, B_BYTES_STR
);
3097 parse_kb_int64_t(int64_t * var
)
3099 parseBytesLine64(var
, B_KBYTES_STR
);
3103 free_size_t(size_t * var
)
3109 free_ssize_t(ssize_t
* var
)
3115 free_b_int64_t(int64_t * var
)
3120 #define free_b_size_t free_size_t
3121 #define free_b_ssize_t free_ssize_t
3122 #define free_kb_size_t free_size_t
3123 #define free_mb_size_t free_size_t
3124 #define free_gb_size_t free_size_t
3125 #define free_kb_int64_t free_b_int64_t
3128 dump_u_short(StoreEntry
* entry
, const char *name
, unsigned short var
)
3130 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
3134 free_u_short(unsigned short * u
)
3140 parse_u_short(unsigned short * var
)
3142 ConfigParser::ParseUShort(var
);
3146 ConfigParser::ParseUShort(unsigned short *var
)
3152 ConfigParser::ParseBool(bool *var
)
3154 int i
= GetInteger();
3165 dump_wordlist(StoreEntry
* entry
, const char *name
, wordlist
* list
)
3167 while (list
!= NULL
) {
3168 storeAppendPrintf(entry
, "%s %s\n", name
, list
->key
);
3174 ConfigParser::ParseWordList(wordlist
** list
)
3176 parse_wordlist(list
);
3180 parse_wordlist(wordlist
** list
)
3183 while ((token
= ConfigParser::NextQuotedToken()))
3184 wordlistAdd(list
, token
);
3187 #if 0 /* now unused */
3189 check_null_wordlist(wordlist
* w
)
3196 check_null_acl_access(acl_access
* a
)
3201 #define free_wordlist wordlistDestroy
3203 #define free_uri_whitespace free_int
3206 parse_uri_whitespace(int *var
)
3208 char *token
= ConfigParser::NextToken();
3214 if (!strcmp(token
, "strip"))
3215 *var
= URI_WHITESPACE_STRIP
;
3216 else if (!strcmp(token
, "deny"))
3217 *var
= URI_WHITESPACE_DENY
;
3218 else if (!strcmp(token
, "allow"))
3219 *var
= URI_WHITESPACE_ALLOW
;
3220 else if (!strcmp(token
, "encode"))
3221 *var
= URI_WHITESPACE_ENCODE
;
3222 else if (!strcmp(token
, "chop"))
3223 *var
= URI_WHITESPACE_CHOP
;
3225 debugs(0, DBG_PARSE_NOTE(2), "ERROR: Invalid option '" << token
<< "': 'uri_whitespace' accepts 'strip', 'deny', 'allow', 'encode', and 'chop'.");
3231 dump_uri_whitespace(StoreEntry
* entry
, const char *name
, int var
)
3235 if (var
== URI_WHITESPACE_ALLOW
)
3237 else if (var
== URI_WHITESPACE_ENCODE
)
3239 else if (var
== URI_WHITESPACE_CHOP
)
3241 else if (var
== URI_WHITESPACE_DENY
)
3246 storeAppendPrintf(entry
, "%s %s\n", name
, s
);
3250 free_removalpolicy(RemovalPolicySettings
** settings
)
3255 free_string(&(*settings
)->type
);
3257 free_wordlist(&(*settings
)->args
);
3265 parse_removalpolicy(RemovalPolicySettings
** settings
)
3268 free_removalpolicy(settings
);
3270 *settings
= new RemovalPolicySettings
;
3272 parse_string(&(*settings
)->type
);
3274 parse_wordlist(&(*settings
)->args
);
3278 dump_removalpolicy(StoreEntry
* entry
, const char *name
, RemovalPolicySettings
* settings
)
3281 storeAppendPrintf(entry
, "%s %s", name
, settings
->type
);
3282 args
= settings
->args
;
3285 storeAppendPrintf(entry
, " %s", args
->key
);
3289 storeAppendPrintf(entry
, "\n");
3293 free_YesNoNone(YesNoNone
*)
3297 parse_YesNoNone(YesNoNone
*option
)
3300 parse_onoff(&value
);
3301 option
->configure(value
> 0);
3305 dump_YesNoNone(StoreEntry
* entry
, const char *name
, YesNoNone
&option
)
3307 if (option
.configured())
3308 dump_onoff(entry
, name
, option
? 1 : 0);
3312 free_memcachemode(SquidConfig
*)
3316 parse_memcachemode(SquidConfig
*)
3318 char *token
= ConfigParser::NextToken();
3324 if (strcmp(token
, "always") == 0) {
3325 Config
.onoff
.memory_cache_first
= 1;
3326 Config
.onoff
.memory_cache_disk
= 1;
3327 } else if (strcmp(token
, "disk") == 0) {
3328 Config
.onoff
.memory_cache_first
= 0;
3329 Config
.onoff
.memory_cache_disk
= 1;
3330 } else if (strncmp(token
, "net", 3) == 0) {
3331 Config
.onoff
.memory_cache_first
= 1;
3332 Config
.onoff
.memory_cache_disk
= 0;
3333 } else if (strcmp(token
, "never") == 0) {
3334 Config
.onoff
.memory_cache_first
= 0;
3335 Config
.onoff
.memory_cache_disk
= 0;
3337 debugs(0, DBG_PARSE_NOTE(2), "ERROR: Invalid option '" << token
<< "': 'memory_cache_mode' accepts 'always', 'disk', 'network', and 'never'.");
3343 dump_memcachemode(StoreEntry
* entry
, const char *name
, SquidConfig
&)
3345 storeAppendPrintf(entry
, "%s ", name
);
3346 if (Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3347 storeAppendPrintf(entry
, "always");
3348 else if (!Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3349 storeAppendPrintf(entry
, "disk");
3350 else if (Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3351 storeAppendPrintf(entry
, "network");
3352 else if (!Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3353 storeAppendPrintf(entry
, "none");
3354 storeAppendPrintf(entry
, "\n");
3357 #include "cf_parser.cci"
3360 parseNeighborType(const char *s
)
3362 if (!strcmp(s
, "parent"))
3365 if (!strcmp(s
, "neighbor"))
3366 return PEER_SIBLING
;
3368 if (!strcmp(s
, "neighbour"))
3369 return PEER_SIBLING
;
3371 if (!strcmp(s
, "sibling"))
3372 return PEER_SIBLING
;
3374 if (!strcmp(s
, "multicast"))
3375 return PEER_MULTICAST
;
3377 debugs(15, DBG_CRITICAL
, "WARNING: Unknown neighbor type: " << s
);
3379 return PEER_SIBLING
;
3384 parse_IpAddress_list(Ip::Address_list
** head
)
3387 Ip::Address_list
*s
;
3390 while ((token
= ConfigParser::NextToken())) {
3391 if (GetHostWithPort(token
, &ipa
)) {
3394 head
= &(*head
)->next
;
3396 s
= static_cast<Ip::Address_list
*>(xcalloc(1, sizeof(*s
)));
3408 dump_IpAddress_list(StoreEntry
* e
, const char *n
, const Ip::Address_list
* s
)
3410 char ntoabuf
[MAX_IPSTRLEN
];
3413 storeAppendPrintf(e
, "%s %s\n",
3415 s
->s
.toStr(ntoabuf
,MAX_IPSTRLEN
));
3421 free_IpAddress_list(Ip::Address_list
** head
)
3423 if (*head
) delete *head
;
3427 #if CURRENTLY_UNUSED
3428 /* This code was previously used by http_port. Left as it really should
3429 * be used by icp_port and htcp_port
3432 check_null_IpAddress_list(const Ip::Address_list
* s
)
3437 #endif /* CURRENTLY_UNUSED */
3438 #endif /* USE_WCCPv2 */
3441 parsePortSpecification(const AnyP::PortCfgPointer
&s
, char *token
)
3444 unsigned short port
= 0;
3448 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3449 s
->name
= xstrdup(token
);
3450 s
->connection_auth_disabled
= false;
3452 const SBuf
&portType
= AnyP::UriScheme(s
->transport
.protocol
).image();
3454 if (*token
== '[') {
3457 t
= strchr(host
, ']');
3459 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing ']' on IPv6 address: " << token
);
3466 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing Port in: " << token
);
3470 if (!Ip::EnableIpv6
) {
3471 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: IPv6 is not available.");
3475 port
= xatos(t
+ 1);
3476 } else if ((t
= strchr(token
, ':'))) {
3481 port
= xatos(t
+ 1);
3483 } else if (strtol(token
, &junk
, 10) && !*junk
) {
3484 port
= xatos(token
);
3485 debugs(3, 3, portType
<< "_port: found Listen on Port: " << port
);
3487 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: missing Port: " << token
);
3492 if (port
== 0 && host
!= NULL
) {
3493 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: Port cannot be 0: " << token
);
3501 if (!Ip::EnableIpv6
)
3503 debugs(3, 3, portType
<< "_port: found Listen on wildcard address: *:" << s
->s
.port());
3504 } else if ( (s
->s
= host
) ) { /* check/parse numeric IPA */
3506 if (!Ip::EnableIpv6
)
3508 debugs(3, 3, portType
<< "_port: Listen on Host/IP: " << host
<< " --> " << s
->s
);
3509 } else if ( s
->s
.GetHostByName(host
) ) { /* check/parse for FQDN */
3510 /* dont use ipcache */
3511 s
->defaultsite
= xstrdup(host
);
3513 if (!Ip::EnableIpv6
)
3515 debugs(3, 3, portType
<< "_port: found Listen as Host " << s
->defaultsite
<< " on IP: " << s
->s
);
3517 debugs(3, DBG_CRITICAL
, "FATAL: " << portType
<< "_port: failed to resolve Host/IP: " << host
);
3522 /// parses the protocol= option of the *_port directive, returning parsed value
3523 /// unsupported option values result in a fatal error message
3524 /// upper case values required; caller may convert for backward compatibility
3525 static AnyP::ProtocolVersion
3526 parsePortProtocol(const SBuf
&value
)
3528 // HTTP/1.0 not supported because we are version 1.1 which contains a superset of 1.0
3529 // and RFC 2616 requires us to upgrade 1.0 to 1.1
3530 if (value
.cmp("HTTP") == 0 || value
.cmp("HTTP/1.1") == 0)
3531 return Http::ProtocolVersion(1,1);
3533 if (value
.cmp("HTTPS") == 0 || value
.cmp("HTTPS/1.1") == 0)
3534 return AnyP::ProtocolVersion(AnyP::PROTO_HTTPS
, 1,1);
3536 if (value
.cmp("FTP") == 0)
3537 return Ftp::ProtocolVersion();
3539 fatalf("%s directive does not support protocol=" SQUIDSBUFPH
"\n", cfg_directive
, SQUIDSBUFPRINT(value
));
3540 return AnyP::ProtocolVersion(); // not reached
3544 parse_port_option(AnyP::PortCfgPointer
&s
, char *token
)
3548 if (strcmp(token
, "accel") == 0) {
3549 if (s
->flags
.isIntercepted()) {
3550 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": Accelerator mode requires its own port. It cannot be shared with other modes.");
3554 s
->flags
.accelSurrogate
= true;
3556 } else if (strcmp(token
, "transparent") == 0 || strcmp(token
, "intercept") == 0) {
3557 if (s
->flags
.accelSurrogate
|| s
->flags
.tproxyIntercept
) {
3558 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": Intercept mode requires its own interception port. It cannot be shared with other modes.");
3562 s
->flags
.natIntercept
= true;
3563 Ip::Interceptor
.StartInterception();
3564 /* Log information regarding the port modes under interception. */
3565 debugs(3, DBG_IMPORTANT
, "Starting Authentication on port " << s
->s
);
3566 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (interception enabled)");
3567 } else if (strcmp(token
, "tproxy") == 0) {
3568 if (s
->flags
.natIntercept
|| s
->flags
.accelSurrogate
) {
3569 debugs(3,DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": TPROXY option requires its own interception port. It cannot be shared with other modes.");
3573 s
->flags
.tproxyIntercept
= true;
3574 Ip::Interceptor
.StartTransparency();
3575 /* Log information regarding the port modes under transparency. */
3576 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (TPROXY enabled)");
3578 if (s
->flags
.proxySurrogate
) {
3579 debugs(3, DBG_IMPORTANT
, "Disabling TPROXY Spoofing on port " << s
->s
<< " (require-proxy-header enabled)");
3582 if (!Ip::Interceptor
.ProbeForTproxy(s
->s
)) {
3583 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": TPROXY support in the system does not work.");
3588 } else if (strcmp(token
, "require-proxy-header") == 0) {
3589 s
->flags
.proxySurrogate
= true;
3590 if (s
->flags
.tproxyIntercept
) {
3591 // receiving is still permitted, so we do not unset the TPROXY flag
3592 // spoofing access control override takes care of the spoof disable later
3593 debugs(3, DBG_IMPORTANT
, "Disabling TPROXY Spoofing on port " << s
->s
<< " (require-proxy-header enabled)");
3596 } else if (strncmp(token
, "defaultsite=", 12) == 0) {
3597 if (!s
->flags
.accelSurrogate
) {
3598 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": defaultsite option requires Acceleration mode flag.");
3602 safe_free(s
->defaultsite
);
3603 s
->defaultsite
= xstrdup(token
+ 12);
3604 } else if (strcmp(token
, "vhost") == 0) {
3605 if (!s
->flags
.accelSurrogate
) {
3606 debugs(3, DBG_CRITICAL
, "WARNING: " << cfg_directive
<< ": vhost option is deprecated. Use 'accel' mode flag instead.");
3608 s
->flags
.accelSurrogate
= true;
3610 } else if (strcmp(token
, "no-vhost") == 0) {
3611 if (!s
->flags
.accelSurrogate
) {
3612 debugs(3, DBG_IMPORTANT
, "ERROR: " << cfg_directive
<< ": no-vhost option requires Acceleration mode flag.");
3615 } else if (strcmp(token
, "vport") == 0) {
3616 if (!s
->flags
.accelSurrogate
) {
3617 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": vport option requires Acceleration mode flag.");
3622 } else if (strncmp(token
, "vport=", 6) == 0) {
3623 if (!s
->flags
.accelSurrogate
) {
3624 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": vport option requires Acceleration mode flag.");
3628 s
->vport
= xatos(token
+ 6);
3629 } else if (strncmp(token
, "protocol=", 9) == 0) {
3630 if (!s
->flags
.accelSurrogate
) {
3631 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": protocol option requires Acceleration mode flag.");
3635 s
->transport
= parsePortProtocol(ToUpper(SBuf(token
+ 9)));
3636 } else if (strcmp(token
, "allow-direct") == 0) {
3637 if (!s
->flags
.accelSurrogate
) {
3638 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": allow-direct option requires Acceleration mode flag.");
3642 s
->allow_direct
= true;
3643 } else if (strcmp(token
, "act-as-origin") == 0) {
3644 if (!s
->flags
.accelSurrogate
) {
3645 debugs(3, DBG_IMPORTANT
, "ERROR: " << cfg_directive
<< ": act-as-origin option requires Acceleration mode flag.");
3647 s
->actAsOrigin
= true;
3648 } else if (strcmp(token
, "ignore-cc") == 0) {
3649 #if !USE_HTTP_VIOLATIONS
3650 if (!s
->flags
.accelSurrogate
) {
3651 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": ignore-cc option requires Acceleration mode flag.");
3656 s
->ignore_cc
= true;
3657 } else if (strncmp(token
, "name=", 5) == 0) {
3659 s
->name
= xstrdup(token
+ 5);
3660 } else if (strcmp(token
, "no-connection-auth") == 0) {
3661 s
->connection_auth_disabled
= true;
3662 } else if (strcmp(token
, "connection-auth=off") == 0) {
3663 s
->connection_auth_disabled
= true;
3664 } else if (strcmp(token
, "connection-auth") == 0) {
3665 s
->connection_auth_disabled
= false;
3666 } else if (strcmp(token
, "connection-auth=on") == 0) {
3667 s
->connection_auth_disabled
= false;
3668 } else if (strncmp(token
, "disable-pmtu-discovery=", 23) == 0) {
3669 if (!strcmp(token
+ 23, "off"))
3670 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3671 else if (!strcmp(token
+ 23, "transparent"))
3672 s
->disable_pmtu_discovery
= DISABLE_PMTU_TRANSPARENT
;
3673 else if (!strcmp(token
+ 23, "always"))
3674 s
->disable_pmtu_discovery
= DISABLE_PMTU_ALWAYS
;
3679 } else if (strcmp(token
, "ipv4") == 0) {
3680 if ( !s
->s
.setIPv4() ) {
3681 debugs(3, DBG_CRITICAL
, "FATAL: " << cfg_directive
<< ": IPv6 addresses cannot be used as IPv4-Only. " << s
->s
);
3685 } else if (strcmp(token
, "tcpkeepalive") == 0) {
3686 s
->tcp_keepalive
.enabled
= true;
3687 } else if (strncmp(token
, "tcpkeepalive=", 13) == 0) {
3688 char *t
= token
+ 13;
3689 s
->tcp_keepalive
.enabled
= true;
3690 s
->tcp_keepalive
.idle
= xatoui(t
,',');
3694 s
->tcp_keepalive
.interval
= xatoui(t
,',');
3699 s
->tcp_keepalive
.timeout
= xatoui(t
);
3702 } else if (strcmp(token
, "sslBump") == 0) {
3703 debugs(3, DBG_PARSE_NOTE(1), "WARNING: '" << token
<< "' is deprecated " <<
3704 "in " << cfg_directive
<< ". Use 'ssl-bump' instead.");
3705 s
->flags
.tunnelSslBumping
= true;
3706 } else if (strcmp(token
, "ssl-bump") == 0) {
3707 s
->flags
.tunnelSslBumping
= true;
3708 } else if (strncmp(token
, "cert=", 5) == 0) {
3709 s
->secure
.parse(token
);
3710 } else if (strncmp(token
, "key=", 4) == 0) {
3711 s
->secure
.parse(token
);
3712 } else if (strncmp(token
, "version=", 8) == 0) {
3713 debugs(3, DBG_PARSE_NOTE(1), "UPGRADE WARNING: '" << token
<< "' is deprecated " <<
3714 "in " << cfg_directive
<< ". Use 'options=' instead.");
3715 s
->secure
.parse(token
);
3716 } else if (strncmp(token
, "options=", 8) == 0) {
3717 s
->secure
.parse(token
);
3718 } else if (strncmp(token
, "cipher=", 7) == 0) {
3719 s
->secure
.parse(token
);
3720 } else if (strncmp(token
, "clientca=", 9) == 0) {
3721 s
->secure
.parse(token
);
3722 } else if (strncmp(token
, "cafile=", 7) == 0) {
3723 debugs(3, DBG_PARSE_NOTE(1), "UPGRADE WARNING: '" << token
<< "' is deprecated " <<
3724 "in " << cfg_directive
<< ". Use 'tls-cafile=' instead.");
3725 s
->secure
.parse(token
);
3726 } else if (strncmp(token
, "capath=", 7) == 0) {
3727 s
->secure
.parse(token
);
3728 } else if (strncmp(token
, "crlfile=", 8) == 0) {
3729 s
->secure
.parse(token
);
3730 } else if (strncmp(token
, "dhparams=", 9) == 0) {
3731 debugs(3, DBG_PARSE_NOTE(DBG_IMPORTANT
), "WARNING: '" << token
<< "' is deprecated " <<
3732 "in " << cfg_directive
<< ". Use 'tls-dh=' instead.");
3733 s
->secure
.parse(token
);
3734 } else if (strncmp(token
, "sslflags=", 9) == 0) {
3735 // NP: deprecation warnings output by secure.parse() when relevant
3736 s
->secure
.parse(token
+3);
3737 } else if (strncmp(token
, "sslcontext=", 11) == 0) {
3738 safe_free(s
->sslContextSessionId
);
3739 s
->sslContextSessionId
= xstrdup(token
+ 11);
3740 } else if (strcmp(token
, "generate-host-certificates") == 0) {
3741 s
->generateHostCertificates
= true;
3742 } else if (strcmp(token
, "generate-host-certificates=on") == 0) {
3743 s
->generateHostCertificates
= true;
3744 } else if (strcmp(token
, "generate-host-certificates=off") == 0) {
3745 s
->generateHostCertificates
= false;
3746 } else if (strncmp(token
, "dynamic_cert_mem_cache_size=", 28) == 0) {
3747 parseBytesOptionValue(&s
->dynamicCertMemCacheSize
, B_BYTES_STR
, token
+ 28);
3749 } else if (strncmp(token
, "tls-", 4) == 0) {
3750 s
->secure
.parse(token
+4);
3751 } else if (strcmp(token
, "ftp-track-dirs") == 0) {
3752 s
->ftp_track_dirs
= true;
3754 debugs(3, DBG_CRITICAL
, "FATAL: Unknown " << cfg_directive
<< " option '" << token
<< "'.");
3760 add_http_port(char *portspec
)
3762 AnyP::PortCfgPointer s
= new AnyP::PortCfg();
3763 s
->transport
= parsePortProtocol(SBuf("HTTP"));
3764 parsePortSpecification(s
, portspec
);
3765 // we may need to merge better if the above returns a list with clones
3766 assert(s
->next
== NULL
);
3767 s
->next
= HttpPortList
;
3772 parsePortCfg(AnyP::PortCfgPointer
*head
, const char *optionName
)
3775 if (strcmp(optionName
, "http_port") == 0 ||
3776 strcmp(optionName
, "ascii_port") == 0)
3778 else if (strcmp(optionName
, "https_port") == 0)
3779 protoName
= "HTTPS";
3780 else if (strcmp(optionName
, "ftp_port") == 0)
3782 if (protoName
.isEmpty()) {
3787 char *token
= ConfigParser::NextToken();
3794 AnyP::PortCfgPointer s
= new AnyP::PortCfg();
3795 s
->transport
= parsePortProtocol(protoName
); // default; protocol=... overwrites
3796 parsePortSpecification(s
, token
);
3798 /* parse options ... */
3799 while ((token
= ConfigParser::NextToken())) {
3800 parse_port_option(s
, token
);
3803 s
->secure
.syncCaFiles();
3805 if (s
->transport
.protocol
== AnyP::PROTO_HTTPS
) {
3806 s
->secure
.encryptTransport
= true;
3808 /* ssl-bump on https_port configuration requires either tproxy or intercept, and vice versa */
3809 const bool hijacked
= s
->flags
.isIntercepted();
3810 if (s
->flags
.tunnelSslBumping
&& !hijacked
) {
3811 debugs(3, DBG_CRITICAL
, "FATAL: ssl-bump on https_port requires tproxy/intercept which is missing.");
3815 if (hijacked
&& !s
->flags
.tunnelSslBumping
) {
3816 debugs(3, DBG_CRITICAL
, "FATAL: tproxy/intercept on https_port requires ssl-bump which is missing.");
3821 if (s
->flags
.proxySurrogate
) {
3822 debugs(3,DBG_CRITICAL
, "FATAL: https_port: require-proxy-header option is not supported on HTTPS ports.");
3826 } else if (protoName
.cmp("FTP") == 0) {
3827 /* ftp_port does not support ssl-bump */
3828 if (s
->flags
.tunnelSslBumping
) {
3829 debugs(3, DBG_CRITICAL
, "FATAL: ssl-bump is not supported for ftp_port.");
3833 if (s
->flags
.proxySurrogate
) {
3834 // Passive FTP data channel does not work without deep protocol inspection in the frontend.
3835 debugs(3,DBG_CRITICAL
, "FATAL: require-proxy-header option is not supported on ftp_port.");
3841 if (Ip::EnableIpv6
&IPV6_SPECIAL_SPLITSTACK
&& s
->s
.isAnyAddr()) {
3842 // clone the port options from *s to *(s->next)
3843 s
->next
= s
->clone();
3844 s
->next
->s
.setIPv4();
3845 debugs(3, 3, AnyP::UriScheme(s
->transport
.protocol
).image() << "_port: clone wildcard address for split-stack: " << s
->s
<< " and " << s
->next
->s
);
3848 while (*head
!= NULL
)
3849 head
= &((*head
)->next
);
3855 dump_generic_port(StoreEntry
* e
, const char *n
, const AnyP::PortCfgPointer
&s
)
3857 char buf
[MAX_IPSTRLEN
];
3859 storeAppendPrintf(e
, "%s %s",
3861 s
->s
.toUrl(buf
,MAX_IPSTRLEN
));
3863 // MODES and specific sub-options.
3864 if (s
->flags
.natIntercept
)
3865 storeAppendPrintf(e
, " intercept");
3867 else if (s
->flags
.tproxyIntercept
)
3868 storeAppendPrintf(e
, " tproxy");
3870 else if (s
->flags
.proxySurrogate
)
3871 storeAppendPrintf(e
, " require-proxy-header");
3873 else if (s
->flags
.accelSurrogate
) {
3874 storeAppendPrintf(e
, " accel");
3877 storeAppendPrintf(e
, " vhost");
3880 storeAppendPrintf(e
, " vport");
3881 else if (s
->vport
> 0)
3882 storeAppendPrintf(e
, " vport=%d", s
->vport
);
3885 storeAppendPrintf(e
, " defaultsite=%s", s
->defaultsite
);
3887 // TODO: compare against prefix of 'n' instead of assuming http_port
3888 if (s
->transport
.protocol
!= AnyP::PROTO_HTTP
)
3889 storeAppendPrintf(e
, " protocol=%s", AnyP::ProtocolType_str
[s
->transport
.protocol
]);
3891 if (s
->allow_direct
)
3892 storeAppendPrintf(e
, " allow-direct");
3895 storeAppendPrintf(e
, " ignore-cc");
3899 // Generic independent options
3902 storeAppendPrintf(e
, " name=%s", s
->name
);
3904 #if USE_HTTP_VIOLATIONS
3905 if (!s
->flags
.accelSurrogate
&& s
->ignore_cc
)
3906 storeAppendPrintf(e
, " ignore-cc");
3909 if (s
->connection_auth_disabled
)
3910 storeAppendPrintf(e
, " connection-auth=off");
3912 storeAppendPrintf(e
, " connection-auth=on");
3914 if (s
->disable_pmtu_discovery
!= DISABLE_PMTU_OFF
) {
3917 if (s
->disable_pmtu_discovery
== DISABLE_PMTU_ALWAYS
)
3920 pmtu
= "transparent";
3922 storeAppendPrintf(e
, " disable-pmtu-discovery=%s", pmtu
);
3925 if (s
->s
.isAnyAddr() && !s
->s
.isIPv6())
3926 storeAppendPrintf(e
, " ipv4");
3928 if (s
->tcp_keepalive
.enabled
) {
3929 if (s
->tcp_keepalive
.idle
|| s
->tcp_keepalive
.interval
|| s
->tcp_keepalive
.timeout
) {
3930 storeAppendPrintf(e
, " tcpkeepalive=%d,%d,%d", s
->tcp_keepalive
.idle
, s
->tcp_keepalive
.interval
, s
->tcp_keepalive
.timeout
);
3932 storeAppendPrintf(e
, " tcpkeepalive");
3937 if (s
->flags
.tunnelSslBumping
)
3938 storeAppendPrintf(e
, " ssl-bump");
3941 s
->secure
.dumpCfg(e
, "tls-");
3944 if (s
->sslContextSessionId
)
3945 storeAppendPrintf(e
, " sslcontext=%s", s
->sslContextSessionId
);
3947 if (!s
->generateHostCertificates
)
3948 storeAppendPrintf(e
, " generate-host-certificates=off");
3950 if (s
->dynamicCertMemCacheSize
!= 4*1024*1024) // 4MB default
3951 storeAppendPrintf(e
, "dynamic_cert_mem_cache_size=%" PRIuSIZE
"%s\n", s
->dynamicCertMemCacheSize
, B_BYTES_STR
);
3956 dump_PortCfg(StoreEntry
* e
, const char *n
, const AnyP::PortCfgPointer
&s
)
3958 for (AnyP::PortCfgPointer p
= s
; p
!= NULL
; p
= p
->next
) {
3959 dump_generic_port(e
, n
, p
);
3960 storeAppendPrintf(e
, "\n");
3965 configFreeMemory(void)
3968 Config
.ssl_client
.sslContext
.reset();
3970 Ssl::unloadSquidUntrusted();
3975 requirePathnameExists(const char *name
, const char *path
)
3979 char pathbuf
[BUFSIZ
];
3980 assert(path
!= NULL
);
3982 if (Config
.chroot_dir
&& (geteuid() == 0)) {
3983 snprintf(pathbuf
, BUFSIZ
, "%s/%s", Config
.chroot_dir
, path
);
3987 if (stat(path
, &sb
) < 0) {
3989 debugs(0, DBG_CRITICAL
, (opt_parse_cfg_only
?"FATAL: ":"ERROR: ") << name
<< " " << path
<< ": " << xstrerr(xerrno
));
3990 // keep going to find more issues if we are only checking the config file with "-k parse"
3991 if (opt_parse_cfg_only
)
3993 // this is fatal if it is found during startup or reconfigure
3994 if (opt_send_signal
== -1 || opt_send_signal
== SIGHUP
)
3995 fatalf("%s %s: %s", name
, path
, xstrerr(xerrno
));
3999 #include "AccessLogEntry.h"
4002 * We support several access_log configuration styles:
4004 * #1: Deprecated ancient style without an explicit logging module:
4005 * access_log /var/log/access.log
4007 * #2: The "none" logging module (i.e., no logging [of matching transactions]):
4008 * access_log none [acl ...]
4010 * #3: Configurable logging module without named options:
4011 * Logformat or the first ACL name, whichever comes first, may not contain '='.
4012 * If no explicit logformat name is given, the first ACL name, if any,
4013 * should not be an existing logformat name or it will be treated as such.
4014 * access_log module:place [logformat_name] [acl ...]
4016 * #4: Configurable logging module with name=value options such as logformat=x:
4017 * The first ACL name may not contain '='.
4018 * access_log module:place [option ...] [acl ...]
4022 parse_access_log(CustomLog
** logs
)
4024 const char *filename
= ConfigParser::NextToken();
4030 CustomLog
*cl
= (CustomLog
*)xcalloc(1, sizeof(*cl
));
4032 cl
->filename
= xstrdup(filename
);
4033 // default buffer size and fatal settings
4034 cl
->bufferSize
= 8*MAX_URL
;
4037 if (strcmp(filename
, "none") == 0) {
4038 cl
->type
= Log::Format::CLF_NONE
;
4039 aclParseAclList(LegacyParser
, &cl
->aclList
, filename
);
4041 logs
= &(*logs
)->next
;
4046 cl
->type
= Log::Format::CLF_UNKNOWN
;
4047 cl
->rotateCount
= -1; // default: use global logfile_rotate setting.
4049 const char *token
= ConfigParser::PeekAtToken();
4050 if (!token
) { // style #1
4051 // no options to deal with
4052 } else if (!strchr(token
, '=')) { // style #3
4053 // if logformat name is recognized,
4054 // pop the previewed token; Else it must be an ACL name
4055 if (setLogformat(cl
, token
, false))
4056 (void)ConfigParser::NextToken();
4057 } else { // style #4
4059 if (strncasecmp(token
, "on-error=", 9) == 0) {
4060 if (strncasecmp(token
+9, "die", 3) == 0) {
4062 } else if (strncasecmp(token
+9, "drop", 4) == 0) {
4065 debugs(3, DBG_CRITICAL
, "Unknown value for on-error '" <<
4066 token
<< "' expected 'drop' or 'die'");
4067 xfree(cl
->filename
);
4072 } else if (strncasecmp(token
, "buffer-size=", 12) == 0) {
4073 parseBytesOptionValue(&cl
->bufferSize
, B_BYTES_STR
, token
+12);
4074 } else if (strncasecmp(token
, "rotate=", 7) == 0) {
4075 cl
->rotateCount
= xatoi(token
+ 7);
4076 } else if (strncasecmp(token
, "logformat=", 10) == 0) {
4077 setLogformat(cl
, token
+10, true);
4078 } else if (!strchr(token
, '=')) {
4079 // Do not pop the token; it must be an ACL name
4080 break; // done with name=value options, now to ACLs
4082 debugs(3, DBG_CRITICAL
, "Unknown access_log option " << token
);
4083 xfree(cl
->filename
);
4088 // Pop the token, it was a valid "name=value" option
4089 (void)ConfigParser::NextToken();
4090 // Get next with preview ConfigParser::NextToken call.
4091 } while ((token
= ConfigParser::PeekAtToken()) != NULL
);
4094 // set format if it has not been specified explicitly
4095 if (cl
->type
== Log::Format::CLF_UNKNOWN
)
4096 setLogformat(cl
, "squid", true);
4098 aclParseAclList(LegacyParser
, &cl
->aclList
, cl
->filename
);
4101 logs
= &(*logs
)->next
;
4106 /// sets CustomLog::type and, if needed, CustomLog::lf
4107 /// returns false iff there is no named log format
4109 setLogformat(CustomLog
*cl
, const char *logdef_name
, const bool dieWhenMissing
)
4112 assert(logdef_name
);
4114 debugs(3, 9, "possible " << cl
->filename
<< " logformat: " << logdef_name
);
4116 if (cl
->type
!= Log::Format::CLF_UNKNOWN
) {
4117 debugs(3, DBG_CRITICAL
, "FATAL: Second logformat name in one access_log: " <<
4118 logdef_name
<< " " << cl
->type
<< " ? " << Log::Format::CLF_NONE
);
4123 /* look for the definition pointer corresponding to this name */
4124 Format::Format
*lf
= Log::TheConfig
.logformats
;
4126 while (lf
!= NULL
) {
4127 debugs(3, 9, "Comparing against '" << lf
->name
<< "'");
4129 if (strcmp(lf
->name
, logdef_name
) == 0)
4136 cl
->type
= Log::Format::CLF_CUSTOM
;
4138 } else if (strcmp(logdef_name
, "auto") == 0) {
4139 debugs(0, DBG_CRITICAL
, "WARNING: Log format 'auto' no longer exists. Using 'squid' instead.");
4140 cl
->type
= Log::Format::CLF_SQUID
;
4141 } else if (strcmp(logdef_name
, "squid") == 0) {
4142 cl
->type
= Log::Format::CLF_SQUID
;
4143 } else if (strcmp(logdef_name
, "common") == 0) {
4144 cl
->type
= Log::Format::CLF_COMMON
;
4145 } else if (strcmp(logdef_name
, "combined") == 0) {
4146 cl
->type
= Log::Format::CLF_COMBINED
;
4148 } else if (strcmp(logdef_name
, "icap_squid") == 0) {
4149 cl
->type
= Log::Format::CLF_ICAP_SQUID
;
4151 } else if (strcmp(logdef_name
, "useragent") == 0) {
4152 cl
->type
= Log::Format::CLF_USERAGENT
;
4153 } else if (strcmp(logdef_name
, "referrer") == 0) {
4154 cl
->type
= Log::Format::CLF_REFERER
;
4155 } else if (dieWhenMissing
) {
4156 debugs(3, DBG_CRITICAL
, "FATAL: Log format '" << logdef_name
<< "' is not defined");
4167 check_null_access_log(CustomLog
*customlog_definitions
)
4169 return customlog_definitions
== NULL
;
4173 dump_access_log(StoreEntry
* entry
, const char *name
, CustomLog
* logs
)
4177 for (log
= logs
; log
; log
= log
->next
) {
4178 storeAppendPrintf(entry
, "%s ", name
);
4180 switch (log
->type
) {
4182 case Log::Format::CLF_CUSTOM
:
4183 storeAppendPrintf(entry
, "%s logformat=%s", log
->filename
, log
->logFormat
->name
);
4186 case Log::Format::CLF_NONE
:
4187 storeAppendPrintf(entry
, "logformat=none");
4190 case Log::Format::CLF_SQUID
:
4191 // this is the default, no need to add to the dump
4192 //storeAppendPrintf(entry, "%s logformat=squid", log->filename);
4195 case Log::Format::CLF_COMBINED
:
4196 storeAppendPrintf(entry
, "%s logformat=combined", log
->filename
);
4199 case Log::Format::CLF_COMMON
:
4200 storeAppendPrintf(entry
, "%s logformat=common", log
->filename
);
4204 case Log::Format::CLF_ICAP_SQUID
:
4205 storeAppendPrintf(entry
, "%s logformat=icap_squid", log
->filename
);
4208 case Log::Format::CLF_USERAGENT
:
4209 storeAppendPrintf(entry
, "%s logformat=useragent", log
->filename
);
4212 case Log::Format::CLF_REFERER
:
4213 storeAppendPrintf(entry
, "%s logformat=referrer", log
->filename
);
4216 case Log::Format::CLF_UNKNOWN
:
4220 // default is on-error=die
4222 storeAppendPrintf(entry
, " on-error=drop");
4225 if (log
->bufferSize
!= 64*1024)
4226 storeAppendPrintf(entry
, " buffer-size=%" PRIuSIZE
, log
->bufferSize
);
4228 if (log
->rotateCount
>= 0)
4229 storeAppendPrintf(entry
, " rotate=%d", log
->rotateCount
);
4232 dump_acl_list(entry
, log
->aclList
);
4234 storeAppendPrintf(entry
, "\n");
4239 free_access_log(CustomLog
** definitions
)
4241 while (*definitions
) {
4242 CustomLog
*log
= *definitions
;
4243 *definitions
= log
->next
;
4245 log
->logFormat
= NULL
;
4246 log
->type
= Log::Format::CLF_UNKNOWN
;
4249 aclDestroyAclList(&log
->aclList
);
4251 safe_free(log
->filename
);
4257 #if HAVE_CPU_AFFINITY /* until somebody else needs this general code */
4258 /// parses list of integers form name=N1,N2,N3,...
4260 parseNamedIntList(const char *data
, const String
&name
, std::vector
<int> &list
)
4262 if (data
&& (strncmp(data
, name
.rawBuf(), name
.size()) == 0)) {
4263 data
+= name
.size();
4268 if (!StringToInt(data
, value
, &data
, 10))
4270 list
.push_back(value
);
4271 if (*data
== '\0' || *data
!= ',')
4276 return data
&& *data
== '\0';
4281 parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4283 #if !HAVE_CPU_AFFINITY
4284 debugs(3, DBG_CRITICAL
, "FATAL: Squid built with no CPU affinity " <<
4285 "support, do not set 'cpu_affinity_map'");
4288 #else /* HAVE_CPU_AFFINITY */
4289 if (!*cpuAffinityMap
)
4290 *cpuAffinityMap
= new CpuAffinityMap
;
4292 const char *const pToken
= ConfigParser::NextToken();
4293 const char *const cToken
= ConfigParser::NextToken();
4294 std::vector
<int> processes
, cores
;
4295 if (!parseNamedIntList(pToken
, "process_numbers", processes
)) {
4296 debugs(3, DBG_CRITICAL
, "FATAL: bad 'process_numbers' parameter " <<
4297 "in 'cpu_affinity_map'");
4299 } else if (!parseNamedIntList(cToken
, "cores", cores
)) {
4300 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cores' parameter in " <<
4301 "'cpu_affinity_map'");
4303 } else if (!(*cpuAffinityMap
)->add(processes
, cores
)) {
4304 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cpu_affinity_map'; " <<
4305 "process_numbers and cores lists differ in length or " <<
4306 "contain numbers <= 0");
4313 dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
)
4315 if (cpuAffinityMap
) {
4316 storeAppendPrintf(entry
, "%s process_numbers=", name
);
4317 for (size_t i
= 0; i
< cpuAffinityMap
->processes().size(); ++i
) {
4318 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4319 cpuAffinityMap
->processes()[i
]);
4321 storeAppendPrintf(entry
, " cores=");
4322 for (size_t i
= 0; i
< cpuAffinityMap
->cores().size(); ++i
) {
4323 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4324 cpuAffinityMap
->cores()[i
]);
4326 storeAppendPrintf(entry
, "\n");
4331 free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4333 delete *cpuAffinityMap
;
4334 *cpuAffinityMap
= NULL
;
4340 parse_adaptation_service_set_type()
4342 Adaptation::Config::ParseServiceSet();
4346 parse_adaptation_service_chain_type()
4348 Adaptation::Config::ParseServiceChain();
4352 parse_adaptation_access_type()
4354 Adaptation::Config::ParseAccess(LegacyParser
);
4356 #endif /* USE_ADAPTATION */
4361 parse_icap_service_type(Adaptation::Icap::Config
* cfg
)
4363 cfg
->parseService();
4367 free_icap_service_type(Adaptation::Icap::Config
* cfg
)
4373 dump_icap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4375 cfg
.dumpService(entry
, name
);
4379 parse_icap_class_type()
4381 debugs(93, DBG_CRITICAL
, "WARNING: 'icap_class' is depricated. " <<
4382 "Use 'adaptation_service_set' instead");
4383 Adaptation::Config::ParseServiceSet();
4387 parse_icap_access_type()
4389 debugs(93, DBG_CRITICAL
, "WARNING: 'icap_access' is depricated. " <<
4390 "Use 'adaptation_access' instead");
4391 Adaptation::Config::ParseAccess(LegacyParser
);
4399 parse_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4401 cfg
->parseService();
4405 free_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4411 dump_ecap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Ecap::Config
&cfg
)
4413 cfg
.dumpService(entry
, name
);
4416 #endif /* USE_ECAP */
4419 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4424 cfg
->service_failure_limit
= GetInteger();
4426 if ((token
= ConfigParser::NextToken()) == NULL
)
4429 if (strcmp(token
,"in") != 0) {
4430 debugs(3, DBG_CRITICAL
, "expecting 'in' on'" << config_input_line
<< "'");
4435 if ((token
= ConfigParser::NextToken()) == NULL
) {
4440 d
= static_cast<time_t> (xatoi(token
));
4442 m
= static_cast<time_t> (1);
4446 else if ((token
= ConfigParser::NextToken()) == NULL
) {
4447 debugs(3, DBG_CRITICAL
, "No time-units on '" << config_input_line
<< "'");
4450 } else if ((m
= parseTimeUnits(token
, false)) == 0) {
4455 cfg
->oldest_service_failure
= (m
* d
);
4458 static void dump_icap_service_failure_limit(StoreEntry
*entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4460 storeAppendPrintf(entry
, "%s %d", name
, cfg
.service_failure_limit
);
4461 if (cfg
.oldest_service_failure
> 0) {
4462 storeAppendPrintf(entry
, " in %d seconds", (int)cfg
.oldest_service_failure
);
4464 storeAppendPrintf(entry
, "\n");
4467 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4469 cfg
->oldest_service_failure
= 0;
4470 cfg
->service_failure_limit
= 0;
4475 static void parse_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
)
4478 sslproxy_cert_adapt
*ca
= (sslproxy_cert_adapt
*) xcalloc(1, sizeof(sslproxy_cert_adapt
));
4479 if ((al
= ConfigParser::NextToken()) == NULL
) {
4486 if ( char *s
= strchr(al
, '{')) {
4487 *s
= '\0'; // terminate the al string
4500 if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetValidAfter
]) == 0) {
4501 ca
->alg
= Ssl::algSetValidAfter
;
4502 ca
->param
= xstrdup("on");
4503 } else if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetValidBefore
]) == 0) {
4504 ca
->alg
= Ssl::algSetValidBefore
;
4505 ca
->param
= xstrdup("on");
4506 } else if (strcmp(al
, Ssl::CertAdaptAlgorithmStr
[Ssl::algSetCommonName
]) == 0) {
4507 ca
->alg
= Ssl::algSetCommonName
;
4509 if (strlen(param
) > 64) {
4510 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_adapt: setCommonName{" <<param
<< "} : using common name longer than 64 bytes is not supported");
4515 ca
->param
= xstrdup(param
);
4518 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_adapt: unknown cert adaptation algorithm: " << al
);
4524 aclParseAclList(LegacyParser
, &ca
->aclList
, al
);
4527 cert_adapt
= &(*cert_adapt
)->next
;
4532 static void dump_sslproxy_cert_adapt(StoreEntry
*entry
, const char *name
, sslproxy_cert_adapt
*cert_adapt
)
4534 for (sslproxy_cert_adapt
*ca
= cert_adapt
; ca
!= NULL
; ca
= ca
->next
) {
4535 storeAppendPrintf(entry
, "%s ", name
);
4536 storeAppendPrintf(entry
, "%s{%s} ", Ssl::sslCertAdaptAlgoritm(ca
->alg
), ca
->param
);
4538 dump_acl_list(entry
, ca
->aclList
);
4539 storeAppendPrintf(entry
, "\n");
4543 static void free_sslproxy_cert_adapt(sslproxy_cert_adapt
**cert_adapt
)
4545 while (*cert_adapt
) {
4546 sslproxy_cert_adapt
*ca
= *cert_adapt
;
4547 *cert_adapt
= ca
->next
;
4548 safe_free(ca
->param
);
4551 aclDestroyAclList(&ca
->aclList
);
4557 static void parse_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
)
4560 sslproxy_cert_sign
*cs
= (sslproxy_cert_sign
*) xcalloc(1, sizeof(sslproxy_cert_sign
));
4561 if ((al
= ConfigParser::NextToken()) == NULL
) {
4567 if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignTrusted
]) == 0)
4568 cs
->alg
= Ssl::algSignTrusted
;
4569 else if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignUntrusted
]) == 0)
4570 cs
->alg
= Ssl::algSignUntrusted
;
4571 else if (strcmp(al
, Ssl::CertSignAlgorithmStr
[Ssl::algSignSelf
]) == 0)
4572 cs
->alg
= Ssl::algSignSelf
;
4574 debugs(3, DBG_CRITICAL
, "FATAL: sslproxy_cert_sign: unknown cert signing algorithm: " << al
);
4580 aclParseAclList(LegacyParser
, &cs
->aclList
, al
);
4583 cert_sign
= &(*cert_sign
)->next
;
4588 static void dump_sslproxy_cert_sign(StoreEntry
*entry
, const char *name
, sslproxy_cert_sign
*cert_sign
)
4590 sslproxy_cert_sign
*cs
;
4591 for (cs
= cert_sign
; cs
!= NULL
; cs
= cs
->next
) {
4592 storeAppendPrintf(entry
, "%s ", name
);
4593 storeAppendPrintf(entry
, "%s ", Ssl::certSignAlgorithm(cs
->alg
));
4595 dump_acl_list(entry
, cs
->aclList
);
4596 storeAppendPrintf(entry
, "\n");
4600 static void free_sslproxy_cert_sign(sslproxy_cert_sign
**cert_sign
)
4602 while (*cert_sign
) {
4603 sslproxy_cert_sign
*cs
= *cert_sign
;
4604 *cert_sign
= cs
->next
;
4607 aclDestroyAclList(&cs
->aclList
);
4613 class sslBumpCfgRr
: public ::RegisteredRunner
4616 static Ssl::BumpMode lastDeprecatedRule
;
4617 /* RegisteredRunner API */
4618 virtual void finalizeConfig();
4621 Ssl::BumpMode
sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpEnd
;
4623 RunnerRegistrationEntry(sslBumpCfgRr
);
4626 sslBumpCfgRr::finalizeConfig()
4628 if (lastDeprecatedRule
!= Ssl::bumpEnd
) {
4629 assert( lastDeprecatedRule
== Ssl::bumpClientFirst
|| lastDeprecatedRule
== Ssl::bumpNone
);
4630 static char buf
[1024];
4631 if (lastDeprecatedRule
== Ssl::bumpClientFirst
) {
4632 strcpy(buf
, "ssl_bump deny all");
4633 debugs(3, DBG_CRITICAL
, "WARNING: auto-converting deprecated implicit "
4634 "\"ssl_bump deny all\" to \"ssl_bump none all\". New ssl_bump configurations "
4635 "must not use implicit rules. Update your ssl_bump rules.");
4637 strcpy(buf
, "ssl_bump allow all");
4638 debugs(3, DBG_CRITICAL
, "SECURITY NOTICE: auto-converting deprecated implicit "
4639 "\"ssl_bump allow all\" to \"ssl_bump client-first all\" which is usually "
4640 "inferior to the newer server-first bumping mode. New ssl_bump"
4641 " configurations must not use implicit rules. Update your ssl_bump rules.");
4647 static void parse_sslproxy_ssl_bump(acl_access
**ssl_bump
)
4649 typedef const char *BumpCfgStyle
;
4650 BumpCfgStyle bcsNone
= NULL
;
4651 BumpCfgStyle bcsNew
= "new client/server-first/none";
4652 BumpCfgStyle bcsOld
= "deprecated allow/deny";
4653 static BumpCfgStyle bumpCfgStyleLast
= bcsNone
;
4654 BumpCfgStyle bumpCfgStyleNow
= bcsNone
;
4656 if ((bm
= ConfigParser::NextToken()) == NULL
) {
4661 // if this is the first rule proccessed
4662 if (*ssl_bump
== NULL
) {
4663 bumpCfgStyleLast
= bcsNone
;
4664 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpEnd
;
4667 allow_t action
= allow_t(ACCESS_ALLOWED
);
4669 if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpClientFirst
]) == 0) {
4670 action
.kind
= Ssl::bumpClientFirst
;
4671 bumpCfgStyleNow
= bcsNew
;
4672 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpServerFirst
]) == 0) {
4673 action
.kind
= Ssl::bumpServerFirst
;
4674 bumpCfgStyleNow
= bcsNew
;
4675 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpPeek
]) == 0) {
4676 action
.kind
= Ssl::bumpPeek
;
4677 bumpCfgStyleNow
= bcsNew
;
4678 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpStare
]) == 0) {
4679 action
.kind
= Ssl::bumpStare
;
4680 bumpCfgStyleNow
= bcsNew
;
4681 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpSplice
]) == 0) {
4682 action
.kind
= Ssl::bumpSplice
;
4683 bumpCfgStyleNow
= bcsNew
;
4684 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpBump
]) == 0) {
4685 action
.kind
= Ssl::bumpBump
;
4686 bumpCfgStyleNow
= bcsNew
;
4687 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpTerminate
]) == 0) {
4688 action
.kind
= Ssl::bumpTerminate
;
4689 bumpCfgStyleNow
= bcsNew
;
4690 } else if (strcmp(bm
, Ssl::BumpModeStr
[Ssl::bumpNone
]) == 0) {
4691 action
.kind
= Ssl::bumpNone
;
4692 bumpCfgStyleNow
= bcsNew
;
4693 } else if (strcmp(bm
, "allow") == 0) {
4694 debugs(3, DBG_CRITICAL
, "SECURITY NOTICE: auto-converting deprecated "
4695 "\"ssl_bump allow <acl>\" to \"ssl_bump client-first <acl>\" which "
4696 "is usually inferior to the newer server-first "
4697 "bumping mode. Update your ssl_bump rules.");
4698 action
.kind
= Ssl::bumpClientFirst
;
4699 bumpCfgStyleNow
= bcsOld
;
4700 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpClientFirst
;
4701 } else if (strcmp(bm
, "deny") == 0) {
4702 debugs(3, DBG_CRITICAL
, "WARNING: auto-converting deprecated "
4703 "\"ssl_bump deny <acl>\" to \"ssl_bump none <acl>\". Update "
4704 "your ssl_bump rules.");
4705 action
.kind
= Ssl::bumpNone
;
4706 bumpCfgStyleNow
= bcsOld
;
4707 sslBumpCfgRr::lastDeprecatedRule
= Ssl::bumpNone
;
4709 debugs(3, DBG_CRITICAL
, "FATAL: unknown ssl_bump mode: " << bm
);
4714 if (bumpCfgStyleLast
!= bcsNone
&& bumpCfgStyleNow
!= bumpCfgStyleLast
) {
4715 debugs(3, DBG_CRITICAL
, "FATAL: do not mix " << bumpCfgStyleNow
<< " actions with " <<
4716 bumpCfgStyleLast
<< " actions. Update your ssl_bump rules.");
4721 bumpCfgStyleLast
= bumpCfgStyleNow
;
4724 ParseAclWithAction(ssl_bump
, action
, "ssl_bump");
4727 static void dump_sslproxy_ssl_bump(StoreEntry
*entry
, const char *name
, acl_access
*ssl_bump
)
4730 dump_SBufList(entry
, ssl_bump
->treeDump(name
, [](const allow_t
&action
) {
4731 return Ssl::BumpModeStr
.at(action
.kind
);
4735 static void free_sslproxy_ssl_bump(acl_access
**ssl_bump
)
4737 free_acl_access(ssl_bump
);
4742 static void dump_HeaderWithAclList(StoreEntry
* entry
, const char *name
, HeaderWithAclList
*headers
)
4747 for (HeaderWithAclList::iterator hwa
= headers
->begin(); hwa
!= headers
->end(); ++hwa
) {
4748 storeAppendPrintf(entry
, "%s %s %s", name
, hwa
->fieldName
.c_str(), hwa
->fieldValue
.c_str());
4750 dump_acl_list(entry
, hwa
->aclList
);
4751 storeAppendPrintf(entry
, "\n");
4755 static void parse_HeaderWithAclList(HeaderWithAclList
**headers
)
4759 *headers
= new HeaderWithAclList
;
4761 if ((fn
= ConfigParser::NextToken()) == NULL
) {
4767 hwa
.fieldId
= Http::HeaderLookupTable
.lookup(hwa
.fieldName
).id
;
4768 if (hwa
.fieldId
== Http::HdrType::BAD_HDR
)
4769 hwa
.fieldId
= Http::HdrType::OTHER
;
4771 Format::Format
*nlf
= new ::Format::Format("hdrWithAcl");
4772 ConfigParser::EnableMacros();
4773 String buf
= ConfigParser::NextQuotedToken();
4774 ConfigParser::DisableMacros();
4775 hwa
.fieldValue
= buf
.termedBuf();
4776 hwa
.quoted
= ConfigParser::LastTokenWasQuoted();
4778 if (!nlf
->parse(hwa
.fieldValue
.c_str())) {
4782 hwa
.valueFormat
= nlf
;
4785 aclParseAclList(LegacyParser
, &hwa
.aclList
, (hwa
.fieldName
+ ':' + hwa
.fieldValue
).c_str());
4786 (*headers
)->push_back(hwa
);
4789 static void free_HeaderWithAclList(HeaderWithAclList
**header
)
4794 for (HeaderWithAclList::iterator hwa
= (*header
)->begin(); hwa
!= (*header
)->end(); ++hwa
) {
4796 aclDestroyAclList(&hwa
->aclList
);
4798 if (hwa
->valueFormat
) {
4799 delete hwa
->valueFormat
;
4800 hwa
->valueFormat
= NULL
;
4807 static void parse_note(Notes
*notes
)
4810 notes
->parse(LegacyParser
);
4813 static void dump_note(StoreEntry
*entry
, const char *name
, Notes
¬es
)
4815 notes
.dump(entry
, name
);
4818 static void free_note(Notes
*notes
)
4823 static bool FtpEspvDeprecated
= false;
4824 static void parse_ftp_epsv(acl_access
**ftp_epsv
)
4826 allow_t ftpEpsvDeprecatedAction
;
4827 bool ftpEpsvIsDeprecatedRule
= false;
4829 char *t
= ConfigParser::PeekAtToken();
4835 if (!strcmp(t
, "off")) {
4836 (void)ConfigParser::NextToken();
4837 ftpEpsvIsDeprecatedRule
= true;
4838 ftpEpsvDeprecatedAction
= allow_t(ACCESS_DENIED
);
4839 } else if (!strcmp(t
, "on")) {
4840 (void)ConfigParser::NextToken();
4841 ftpEpsvIsDeprecatedRule
= true;
4842 ftpEpsvDeprecatedAction
= allow_t(ACCESS_ALLOWED
);
4845 // Check for mixing "ftp_epsv on|off" and "ftp_epsv allow|deny .." rules:
4846 // 1) if this line is "ftp_epsv allow|deny ..." and already exist rules of "ftp_epsv on|off"
4847 // 2) if this line is "ftp_epsv on|off" and already exist rules of "ftp_epsv allow|deny ..."
4849 if ((!ftpEpsvIsDeprecatedRule
&& FtpEspvDeprecated
) ||
4850 (ftpEpsvIsDeprecatedRule
&& !FtpEspvDeprecated
&& *ftp_epsv
!= NULL
)) {
4851 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.");
4856 if (ftpEpsvIsDeprecatedRule
) {
4857 // overwrite previous ftp_epsv lines
4859 *ftp_epsv
= nullptr;
4861 if (ftpEpsvDeprecatedAction
== allow_t(ACCESS_DENIED
)) {
4862 if (ACL
*a
= ACL::FindByName("all"))
4863 ParseAclWithAction(ftp_epsv
, ftpEpsvDeprecatedAction
, "ftp_epsv", a
);
4869 FtpEspvDeprecated
= true;
4871 aclParseAccessLine(cfg_directive
, LegacyParser
, ftp_epsv
);
4875 static void dump_ftp_epsv(StoreEntry
*entry
, const char *name
, acl_access
*ftp_epsv
)
4878 dump_SBufList(entry
, ftp_epsv
->treeDump(name
, Acl::AllowOrDeny
));
4881 static void free_ftp_epsv(acl_access
**ftp_epsv
)
4883 free_acl_access(ftp_epsv
);
4884 FtpEspvDeprecated
= false;
4888 parse_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*config
)
4891 parseTimeLine(&tval
, T_SECOND_STR
, false, true);
4892 Config
.Timeout
.urlRewrite
= static_cast<time_t>(tval
/1000);
4895 while(ConfigParser::NextKvPair(key
, value
)) {
4896 if (strcasecmp(key
, "on_timeout") == 0) {
4897 if (strcasecmp(value
, "bypass") == 0)
4898 config
->action
= toutActBypass
;
4899 else if (strcasecmp(value
, "fail") == 0)
4900 config
->action
= toutActFail
;
4901 else if (strcasecmp(value
, "retry") == 0)
4902 config
->action
= toutActRetry
;
4903 else if (strcasecmp(value
, "use_configured_response") == 0) {
4904 config
->action
= toutActUseConfiguredResponse
;
4906 debugs(3, DBG_CRITICAL
, "FATAL: unsuported \"on_timeout\" action:" << value
);
4910 } else if (strcasecmp(key
, "response") == 0) {
4911 config
->response
= xstrdup(value
);
4913 debugs(3, DBG_CRITICAL
, "FATAL: unsuported option " << key
);
4919 if (config
->action
== toutActUseConfiguredResponse
&& !config
->response
) {
4920 debugs(3, DBG_CRITICAL
, "FATAL: Expected 'response=' option after 'on_timeout=use_configured_response' option");
4924 if (config
->action
!= toutActUseConfiguredResponse
&& config
->response
) {
4925 debugs(3, DBG_CRITICAL
, "FATAL: 'response=' option is valid only when used with the 'on_timeout=use_configured_response' option");
4931 dump_UrlHelperTimeout(StoreEntry
*entry
, const char *name
, SquidConfig::UrlHelperTimeout
&config
)
4933 const char *onTimedOutActions
[] = {"bypass", "fail", "retry", "use_configured_response"};
4934 assert(config
.action
>= 0 && config
.action
<= toutActUseConfiguredResponse
);
4936 dump_time_t(entry
, name
, Config
.Timeout
.urlRewrite
);
4937 storeAppendPrintf(entry
, " on_timeout=%s", onTimedOutActions
[config
.action
]);
4939 if (config
.response
)
4940 storeAppendPrintf(entry
, " response=\"%s\"", config
.response
);
4942 storeAppendPrintf(entry
, "\n");
4946 free_UrlHelperTimeout(SquidConfig::UrlHelperTimeout
*config
)
4948 Config
.Timeout
.urlRewrite
= 0;
4950 safe_free(config
->response
);
4954 parse_configuration_includes_quoted_values(bool *)
4959 // If quoted values is set to on then enable new strict mode parsing
4961 ConfigParser::RecognizeQuotedValues
= true;
4962 ConfigParser::StrictMode
= true;
4964 ConfigParser::RecognizeQuotedValues
= false;
4965 ConfigParser::StrictMode
= false;
4970 dump_configuration_includes_quoted_values(StoreEntry
*const entry
, const char *const name
, bool)
4972 int val
= ConfigParser::RecognizeQuotedValues
? 1 : 0;
4973 dump_onoff(entry
, name
, val
);
4977 free_configuration_includes_quoted_values(bool *)
4979 ConfigParser::RecognizeQuotedValues
= false;
4980 ConfigParser::StrictMode
= false;
4984 parse_on_unsupported_protocol(acl_access
**access
)
4987 if ((tm
= ConfigParser::NextToken()) == NULL
) {
4992 allow_t action
= allow_t(ACCESS_ALLOWED
);
4993 if (strcmp(tm
, "tunnel") == 0)
4995 else if (strcmp(tm
, "respond") == 0)
4998 debugs(3, DBG_CRITICAL
, "FATAL: unknown on_unsupported_protocol mode: " << tm
);
5004 ParseAclWithAction(access
, action
, "on_unsupported_protocol");
5008 dump_on_unsupported_protocol(StoreEntry
*entry
, const char *name
, acl_access
*access
)
5010 static const std::vector
<const char *> onErrorTunnelMode
= {
5016 SBufList lines
= access
->treeDump(name
, [](const allow_t
&action
) {
5017 return onErrorTunnelMode
.at(action
.kind
);
5019 dump_SBufList(entry
, lines
);
5024 free_on_unsupported_protocol(acl_access
**access
)
5026 free_acl_access(access
);