4 * DEBUG: section 03 Configuration File Parsing
5 * AUTHOR: Harvest Derived
7 * SQUID Web Proxy Cache http://www.squid-cache.org/
8 * ----------------------------------------------------------
10 * Squid is the result of efforts by numerous individuals from
11 * the Internet community; see the CONTRIBUTORS file for full
12 * details. Many organizations have provided support for Squid's
13 * development; see the SPONSORS file for full details. Squid is
14 * Copyrighted (C) 2001 by the Regents of the University of
15 * California; see the COPYRIGHT file for full details. Squid
16 * incorporates software developed and/or copyrighted by other
17 * sources; see the CREDITS file for full details.
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
38 #include "acl/Gadgets.h"
39 #include "acl/MethodData.h"
41 #include "adaptation/Config.h"
44 #include "adaptation/icap/Config.h"
47 #include "adaptation/ecap/Config.h"
50 #include "ssl/support.h"
51 #include "ssl/Config.h"
54 #include "auth/Config.h"
55 #include "auth/Scheme.h"
57 #include "ConfigParser.h"
58 #include "CpuAffinityMap.h"
59 #include "eui/Config.h"
61 #include "esi/Parser.h"
63 #include "HttpRequestMethod.h"
64 #include "ident/Config.h"
65 #include "ip/Intercept.h"
66 #include "ip/QosConfig.h"
68 #include "log/Config.h"
70 #include "mgr/Registration.h"
72 #include "ProtoPort.h"
78 #include "StoreFileSystem.h"
92 #include "ssl/gadgets.h"
96 static void parse_adaptation_service_set_type();
97 static void parse_adaptation_service_chain_type();
98 static void parse_adaptation_access_type();
102 static void parse_icap_service_type(Adaptation::Icap::Config
*);
103 static void dump_icap_service_type(StoreEntry
*, const char *, const Adaptation::Icap::Config
&);
104 static void free_icap_service_type(Adaptation::Icap::Config
*);
105 static void parse_icap_class_type();
106 static void parse_icap_access_type();
108 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*);
109 static void dump_icap_service_failure_limit(StoreEntry
*, const char *, const Adaptation::Icap::Config
&);
110 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*);
114 static void parse_ecap_service_type(Adaptation::Ecap::Config
*);
115 static void dump_ecap_service_type(StoreEntry
*, const char *, const Adaptation::Ecap::Config
&);
116 static void free_ecap_service_type(Adaptation::Ecap::Config
*);
121 static const char *const T_MILLISECOND_STR
= "millisecond";
122 static const char *const T_SECOND_STR
= "second";
123 static const char *const T_MINUTE_STR
= "minute";
124 static const char *const T_HOUR_STR
= "hour";
125 static const char *const T_DAY_STR
= "day";
126 static const char *const T_WEEK_STR
= "week";
127 static const char *const T_FORTNIGHT_STR
= "fortnight";
128 static const char *const T_MONTH_STR
= "month";
129 static const char *const T_YEAR_STR
= "year";
130 static const char *const T_DECADE_STR
= "decade";
132 static const char *const B_BYTES_STR
= "bytes";
133 static const char *const B_KBYTES_STR
= "KB";
134 static const char *const B_MBYTES_STR
= "MB";
135 static const char *const B_GBYTES_STR
= "GB";
137 static const char *const list_sep
= ", \t\n\r";
139 static void parse_access_log(customlog
** customlog_definitions
);
140 static int check_null_access_log(customlog
*customlog_definitions
);
141 static void dump_access_log(StoreEntry
* entry
, const char *name
, customlog
* definitions
);
142 static void free_access_log(customlog
** definitions
);
144 static void update_maxobjsize(void);
145 static void configDoConfigure(void);
146 static void parse_refreshpattern(refresh_t
**);
147 static uint64_t parseTimeUnits(const char *unit
, bool allowMsec
);
148 static void parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
);
149 static void parse_u_short(u_short
* var
);
150 static void parse_string(char **);
151 static void default_all(void);
152 static void defaults_if_none(void);
153 static int parse_line(char *);
154 static void parse_obsolete(const char *);
155 static void parseBytesLine(size_t * bptr
, const char *units
);
157 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
);
160 static void parseBytesLineSigned(ssize_t
* bptr
, const char *units
);
162 static size_t parseBytesUnits(const char *unit
);
163 static void free_all(void);
164 void requirePathnameExists(const char *name
, const char *path
);
165 static OBJH dump_config
;
166 #if USE_HTTP_VIOLATIONS
167 static void dump_http_header_access(StoreEntry
* entry
, const char *name
, header_mangler header
[]);
168 static void parse_http_header_access(header_mangler header
[]);
169 static void free_http_header_access(header_mangler header
[]);
170 static void dump_http_header_replace(StoreEntry
* entry
, const char *name
, header_mangler header
[]);
171 static void parse_http_header_replace(header_mangler
* header
);
172 static void free_http_header_replace(header_mangler
* header
);
174 static void parse_denyinfo(acl_deny_info_list
** var
);
175 static void dump_denyinfo(StoreEntry
* entry
, const char *name
, acl_deny_info_list
* var
);
176 static void free_denyinfo(acl_deny_info_list
** var
);
179 static void parse_IpAddress_list(Ip::Address_list
**);
180 static void dump_IpAddress_list(StoreEntry
*, const char *, const Ip::Address_list
*);
181 static void free_IpAddress_list(Ip::Address_list
**);
183 static int check_null_IpAddress_list(const Ip::Address_list
*);
184 #endif /* CURRENTLY_UNUSED */
185 #endif /* USE_WCCPv2 */
187 static void parse_http_port_list(http_port_list
**);
188 static void dump_http_port_list(StoreEntry
*, const char *, const http_port_list
*);
189 static void free_http_port_list(http_port_list
**);
192 static void parse_https_port_list(https_port_list
**);
193 static void dump_https_port_list(StoreEntry
*, const char *, const https_port_list
*);
194 static void free_https_port_list(https_port_list
**);
196 static int check_null_https_port_list(const https_port_list
*);
200 static void parse_b_size_t(size_t * var
);
201 static void parse_b_int64_t(int64_t * var
);
203 static bool parseNamedIntList(const char *data
, const String
&name
, Vector
<int> &list
);
205 static void parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
);
206 static void dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
);
207 static void free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
);
209 static int parseOneConfigFile(const char *file_name
, unsigned int depth
);
212 * LegacyParser is a parser for legacy code that uses the global
213 * approach. This is static so that it is only exposed to cache_cf.
214 * Other modules needing access to a ConfigParser should have it
215 * provided to them in their parserFOO methods.
217 static ConfigParser LegacyParser
= ConfigParser();
222 LegacyParser
.destruct();
226 update_maxobjsize(void)
231 for (i
= 0; i
< Config
.cacheSwap
.n_configured
; i
++) {
232 assert (Config
.cacheSwap
.swapDirs
[i
].getRaw());
234 if (dynamic_cast<SwapDir
*>(Config
.cacheSwap
.swapDirs
[i
].getRaw())->
236 ms
= dynamic_cast<SwapDir
*>(Config
.cacheSwap
.swapDirs
[i
].getRaw())->max_objsize
;
238 store_maxobjsize
= ms
;
242 SetConfigFilename(char const *file_name
, bool is_pipe
)
244 cfg_filename
= file_name
;
249 cfg_filename
= file_name
+ 1;
250 else if ((token
= strrchr(cfg_filename
, '/')))
251 cfg_filename
= token
+ 1;
255 skip_ws(const char* s
)
264 parseManyConfigFiles(char* files
, int depth
)
267 char* saveptr
= NULL
;
272 memset(&globbuf
, 0, sizeof(globbuf
));
273 for (path
= strwordtok(files
, &saveptr
); path
; path
= strwordtok(NULL
, &saveptr
)) {
274 if (glob(path
, globbuf
.gl_pathc
? GLOB_APPEND
: 0, NULL
, &globbuf
) != 0) {
275 fatalf("Unable to find configuration file: %s: %s",
279 for (i
= 0; i
< (int)globbuf
.gl_pathc
; i
++) {
280 error_count
+= parseOneConfigFile(globbuf
.gl_pathv
[i
], depth
);
284 char* file
= strwordtok(files
, &saveptr
);
285 while (file
!= NULL
) {
286 error_count
+= parseOneConfigFile(file
, depth
);
287 file
= strwordtok(NULL
, &saveptr
);
289 #endif /* HAVE_GLOB */
294 ReplaceSubstr(char*& str
, int& len
, unsigned substrIdx
, unsigned substrLen
, const char* newSubstr
)
297 assert(newSubstr
!= NULL
);
299 unsigned newSubstrLen
= strlen(newSubstr
);
300 if (newSubstrLen
> substrLen
)
301 str
= (char*)realloc(str
, len
- substrLen
+ newSubstrLen
+ 1);
303 // move tail part including zero
304 memmove(str
+ substrIdx
+ newSubstrLen
, str
+ substrIdx
+ substrLen
, len
- substrIdx
- substrLen
+ 1);
305 // copy new substring in place
306 memcpy(str
+ substrIdx
, newSubstr
, newSubstrLen
);
312 SubstituteMacro(char*& line
, int& len
, const char* macroName
, const char* substStr
)
314 assert(line
!= NULL
);
315 assert(macroName
!= NULL
);
316 assert(substStr
!= NULL
);
317 unsigned macroNameLen
= strlen(macroName
);
318 while (const char* macroPos
= strstr(line
, macroName
)) // we would replace all occurrences
319 ReplaceSubstr(line
, len
, macroPos
- line
, macroNameLen
, substStr
);
323 ProcessMacros(char*& line
, int& len
)
325 SubstituteMacro(line
, len
, "${process_name}", TheKidName
);
326 SubstituteMacro(line
, len
, "${process_number}", xitoa(KidIdentifier
));
330 trim_trailing_ws(char* str
)
333 unsigned i
= strlen(str
);
334 while ((i
> 0) && xisspace(str
[i
- 1]))
340 FindStatement(const char* line
, const char* statement
)
342 assert(line
!= NULL
);
343 assert(statement
!= NULL
);
345 const char* str
= skip_ws(line
);
346 unsigned len
= strlen(statement
);
347 if (strncmp(str
, statement
, len
) == 0) {
351 else if (xisspace(*str
))
359 StrToInt(const char* str
, long& number
)
364 number
= strtol(str
, &end
, 0);
366 return (end
!= str
) && (*end
== '\0'); // returns true if string contains nothing except number
370 EvalBoolExpr(const char* expr
)
372 assert(expr
!= NULL
);
373 if (strcmp(expr
, "true") == 0) {
375 } else if (strcmp(expr
, "false") == 0) {
377 } else if (const char* equation
= strchr(expr
, '=')) {
378 const char* rvalue
= skip_ws(equation
+ 1);
379 char* lvalue
= (char*)xmalloc(equation
- expr
+ 1);
380 xstrncpy(lvalue
, expr
, equation
- expr
+ 1);
381 trim_trailing_ws(lvalue
);
384 if (!StrToInt(lvalue
, number1
))
385 fatalf("String is not a integer number: '%s'\n", lvalue
);
387 if (!StrToInt(rvalue
, number2
))
388 fatalf("String is not a integer number: '%s'\n", rvalue
);
391 return number1
== number2
;
393 fatalf("Unable to evaluate expression '%s'\n", expr
);
394 return false; // this place cannot be reached
398 parseOneConfigFile(const char *file_name
, unsigned int depth
)
401 const char *orig_cfg_filename
= cfg_filename
;
402 const int orig_config_lineno
= config_lineno
;
404 char *tmp_line
= NULL
;
405 int tmp_line_len
= 0;
409 debugs(3, 1, "Processing Configuration File: " << file_name
<< " (depth " << depth
<< ")");
411 fatalf("WARNING: can't include %s: includes are nested too deeply (>16)!\n", file_name
);
415 if (file_name
[0] == '!' || file_name
[0] == '|') {
416 fp
= popen(file_name
+ 1, "r");
419 fp
= fopen(file_name
, "r");
423 fatalf("Unable to open configuration file: %s: %s", file_name
, xstrerror());
426 setmode(fileno(fp
), O_TEXT
);
429 SetConfigFilename(file_name
, bool(is_pipe
));
431 memset(config_input_line
, '\0', BUFSIZ
);
435 Vector
<bool> if_states
;
436 while (fgets(config_input_line
, BUFSIZ
, fp
)) {
439 if ((token
= strchr(config_input_line
, '\n')))
442 if ((token
= strchr(config_input_line
, '\r')))
445 if (strncmp(config_input_line
, "#line ", 6) == 0) {
446 static char new_file_name
[1024];
448 static char new_lineno
;
449 token
= config_input_line
+ 6;
450 new_lineno
= strtol(token
, &file
, 0) - 1;
453 continue; /* Not a valid #line directive, may be a comment */
455 while (*file
&& xisspace((unsigned char) *file
))
460 continue; /* Not a valid #line directive, may be a comment */
462 xstrncpy(new_file_name
, file
+ 1, sizeof(new_file_name
));
464 if ((token
= strchr(new_file_name
, '"')))
467 cfg_filename
= new_file_name
;
470 config_lineno
= new_lineno
;
473 if (config_input_line
[0] == '#')
476 if (config_input_line
[0] == '\0')
479 const char* append
= tmp_line_len
? skip_ws(config_input_line
) : config_input_line
;
481 size_t append_len
= strlen(append
);
483 tmp_line
= (char*)xrealloc(tmp_line
, tmp_line_len
+ append_len
+ 1);
485 strcpy(tmp_line
+ tmp_line_len
, append
);
487 tmp_line_len
+= append_len
;
489 if (tmp_line
[tmp_line_len
-1] == '\\') {
490 debugs(3, 5, "parseConfigFile: tmp_line='" << tmp_line
<< "'");
491 tmp_line
[--tmp_line_len
] = '\0';
495 trim_trailing_ws(tmp_line
);
496 ProcessMacros(tmp_line
, tmp_line_len
);
497 debugs(3, 5, "Processing: '" << tmp_line
<< "'");
499 if (const char* expr
= FindStatement(tmp_line
, "if")) {
500 if_states
.push_back(EvalBoolExpr(expr
)); // store last if-statement meaning
501 } else if (FindStatement(tmp_line
, "endif")) {
502 if (!if_states
.empty())
503 if_states
.pop_back(); // remove last if-statement meaning
505 fatalf("'endif' without 'if'\n");
506 } else if (FindStatement(tmp_line
, "else")) {
507 if (!if_states
.empty())
508 if_states
.back() = !if_states
.back();
510 fatalf("'else' without 'if'\n");
511 } else if (if_states
.empty() || if_states
.back()) { // test last if-statement meaning if present
512 /* Handle includes here */
513 if (tmp_line_len
>= 9 && strncmp(tmp_line
, "include", 7) == 0 && xisspace(tmp_line
[7])) {
514 err_count
+= parseManyConfigFiles(tmp_line
+ 8, depth
+ 1);
515 } else if (!parse_line(tmp_line
)) {
516 debugs(3, 0, HERE
<< cfg_filename
<< ":" << config_lineno
<< " unrecognized: '" << tmp_line
<< "'");
525 if (!if_states
.empty())
526 fatalf("if-statement without 'endif'\n");
529 int ret
= pclose(fp
);
532 fatalf("parseConfigFile: '%s' failed with exit code %d\n", file_name
, ret
);
537 cfg_filename
= orig_cfg_filename
;
538 config_lineno
= orig_config_lineno
;
544 parseConfigFile(const char *file_name
)
552 ACLMethodData::ThePurgeCount
= 0;
555 err_count
= parseOneConfigFile(file_name
, 0);
560 * We must call configDoConfigure() before leave_suid() because
561 * configDoConfigure() is where we turn username strings into
566 if (!Config
.chroot_dir
) {
568 setUmask(Config
.umask
);
569 _db_init(Debug::cache_log
, Debug::debugOptions
);
573 if (opt_send_signal
== -1) {
574 Mgr::RegisterAction("config",
575 "Current Squid Configuration",
585 configDoConfigure(void)
587 memset(&Config2
, '\0', sizeof(SquidConfig2
));
588 /* init memory as early as possible */
592 if (Config
.cacheSwap
.swapDirs
== NULL
) {
593 /* Memory-only cache probably in effect. */
594 /* turn off the cache rebuild delays... */
595 StoreController::store_dirs_rebuilding
= 0;
598 if (Debug::rotateNumber
< 0) {
599 Debug::rotateNumber
= Config
.Log
.rotateNumber
;
602 #if SIZEOF_OFF_T <= 4
603 if (Config
.Store
.maxObjectSize
> 0x7FFF0000) {
604 debugs(3, 0, "WARNING: This Squid binary can not handle files larger than 2GB. Limiting maximum_object_size to just below 2GB");
605 Config
.Store
.maxObjectSize
= 0x7FFF0000;
608 if (0 == Store::Root().maxSize())
609 /* people might want a zero-sized cache on purpose */
611 else if (Store::Root().maxSize() < (Config
.memMaxSize
>> 10))
612 /* This is bogus. folk with NULL caches will want this */
613 debugs(3, 0, "WARNING cache_mem is larger than total disk cache space!");
615 if (Config
.Announce
.period
> 0) {
616 Config
.onoff
.announce
= 1;
617 } else if (Config
.Announce
.period
< 1) {
618 Config
.Announce
.period
= 86400 * 365; /* one year */
619 Config
.onoff
.announce
= 0;
622 if (Config
.onoff
.httpd_suppress_version_string
)
623 visible_appname_string
= (char *)appname_string
;
625 visible_appname_string
= (char const *)APP_FULLNAME
;
629 if (Config
.dnsChildren
.n_max
< 1)
630 fatal("No dnsservers allocated");
634 if (Config
.Program
.redirect
) {
635 if (Config
.redirectChildren
.n_max
< 1) {
636 Config
.redirectChildren
.n_max
= 0;
637 wordlistDestroy(&Config
.Program
.redirect
);
641 if (Config
.appendDomain
)
642 if (*Config
.appendDomain
!= '.')
643 fatal("append_domain must begin with a '.'");
645 if (Config
.errHtmlText
== NULL
)
646 Config
.errHtmlText
= xstrdup(null_string
);
648 #if !HAVE_SETRLIMIT || !defined(RLIMIT_NOFILE)
649 if (Config
.max_filedescriptors
> 0) {
650 debugs(0, DBG_IMPORTANT
, "WARNING: max_filedescriptors disabled. Operating System setrlimit(RLIMIT_NOFILE) is missing.");
652 #elif USE_SELECT || USE_SELECT_WIN32
653 if (Config
.max_filedescriptors
> FD_SETSIZE
) {
654 debugs(0, DBG_IMPORTANT
, "WARNING: max_filedescriptors limited to " << FD_SETSIZE
<< " by select() algorithm.");
660 snprintf(ThisCache
, sizeof(ThisCache
), "%s (%s)",
662 visible_appname_string
);
665 * the extra space is for loop detection in client_side.c -- we search
666 * for substrings in the Via header.
668 snprintf(ThisCache2
, sizeof(ThisCache
), " %s (%s)",
670 visible_appname_string
);
672 /* Use visible_hostname as default surrogate_id */
673 if (!Config
.Accel
.surrogate_id
) {
674 const char *t
= getMyHostname();
675 Config
.Accel
.surrogate_id
= xstrdup( (t
?t
:"unset-id") );
678 if (!Config
.udpMaxHitObjsz
|| Config
.udpMaxHitObjsz
> SQUID_UDP_SO_SNDBUF
)
679 Config
.udpMaxHitObjsz
= SQUID_UDP_SO_SNDBUF
;
681 if (Config
.appendDomain
)
682 Config
.appendDomainLen
= strlen(Config
.appendDomain
);
684 Config
.appendDomainLen
= 0;
686 if (Config
.connect_retries
> 10) {
687 debugs(0,DBG_CRITICAL
, "WARNING: connect_retries cannot be larger than 10. Resetting to 10.");
688 Config
.connect_retries
= 10;
691 requirePathnameExists("MIME Config Table", Config
.mimeTablePathname
);
694 requirePathnameExists("cache_dns_program", Config
.Program
.dnsserver
);
698 requirePathnameExists("unlinkd_program", Config
.Program
.unlinkd
);
700 requirePathnameExists("logfile_daemon", Log::TheConfig
.logfile_daemon
);
701 if (Config
.Program
.redirect
)
702 requirePathnameExists("redirect_program", Config
.Program
.redirect
->key
);
704 requirePathnameExists("Icon Directory", Config
.icons
.directory
);
706 if (Config
.errorDirectory
)
707 requirePathnameExists("Error Directory", Config
.errorDirectory
);
709 #if USE_HTTP_VIOLATIONS
714 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
715 if (!R
->flags
.override_expire
)
718 debugs(22, 1, "WARNING: use of 'override-expire' in 'refresh_pattern' violates HTTP");
723 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
724 if (!R
->flags
.override_lastmod
)
727 debugs(22, 1, "WARNING: use of 'override-lastmod' in 'refresh_pattern' violates HTTP");
732 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
733 if (!R
->flags
.reload_into_ims
)
736 debugs(22, 1, "WARNING: use of 'reload-into-ims' in 'refresh_pattern' violates HTTP");
741 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
742 if (!R
->flags
.ignore_reload
)
745 debugs(22, 1, "WARNING: use of 'ignore-reload' in 'refresh_pattern' violates HTTP");
750 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
751 if (!R
->flags
.ignore_no_cache
)
754 debugs(22, 1, "WARNING: use of 'ignore-no-cache' in 'refresh_pattern' violates HTTP");
759 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
760 if (!R
->flags
.ignore_no_store
)
763 debugs(22, 1, "WARNING: use of 'ignore-no-store' in 'refresh_pattern' violates HTTP");
768 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
769 if (!R
->flags
.ignore_must_revalidate
)
771 debugs(22, 1, "WARNING: use of 'ignore-must-revalidate' in 'refresh_pattern' violates HTTP");
775 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
776 if (!R
->flags
.ignore_private
)
779 debugs(22, 1, "WARNING: use of 'ignore-private' in 'refresh_pattern' violates HTTP");
784 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
785 if (!R
->flags
.ignore_auth
)
788 debugs(22, 1, "WARNING: use of 'ignore-auth' in 'refresh_pattern' violates HTTP");
795 #if !USE_HTTP_VIOLATIONS
796 Config
.onoff
.via
= 1;
799 if (!Config
.onoff
.via
)
800 debugs(22, 1, "WARNING: HTTP requires the use of Via");
804 // we enable runtime PURGE checks if there is at least one PURGE method ACL
805 // TODO: replace with a dedicated "purge" ACL option?
806 Config2
.onoff
.enable_purge
= (ACLMethodData::ThePurgeCount
> 0);
808 Config2
.onoff
.mangle_request_headers
= httpReqHdrManglersConfigured();
810 if (geteuid() == 0) {
811 if (NULL
!= Config
.effectiveUser
) {
813 struct passwd
*pwd
= getpwnam(Config
.effectiveUser
);
817 * Andres Kroonmaa <andre@online.ee>:
818 * Some getpwnam() implementations (Solaris?) require
819 * an available FD < 256 for opening a FILE* to the
822 * This should be safe at startup, but might still fail
823 * during reconfigure.
825 fatalf("getpwnam failed to find userid for effective user '%s'",
826 Config
.effectiveUser
);
830 Config2
.effectiveUserID
= pwd
->pw_uid
;
832 Config2
.effectiveGroupID
= pwd
->pw_gid
;
836 if (pwd
->pw_dir
&& *pwd
->pw_dir
) {
838 char *env_str
= (char *)xcalloc((len
= strlen(pwd
->pw_dir
) + 6), 1);
839 snprintf(env_str
, len
, "HOME=%s", pwd
->pw_dir
);
847 Config2
.effectiveUserID
= geteuid();
848 Config2
.effectiveGroupID
= getegid();
851 if (NULL
!= Config
.effectiveGroup
) {
853 struct group
*grp
= getgrnam(Config
.effectiveGroup
);
856 fatalf("getgrnam failed to find groupid for effective group '%s'",
857 Config
.effectiveGroup
);
861 Config2
.effectiveGroupID
= grp
->gr_gid
;
864 HttpRequestMethod::Configure(Config
);
867 debugs(3, 1, "Initializing https proxy context");
869 Config
.ssl_client
.sslContext
= sslCreateClientContext(Config
.ssl_client
.cert
, Config
.ssl_client
.key
, Config
.ssl_client
.version
, Config
.ssl_client
.cipher
, Config
.ssl_client
.options
, Config
.ssl_client
.flags
, Config
.ssl_client
.cafile
, Config
.ssl_client
.capath
, Config
.ssl_client
.crlfile
);
875 for (p
= Config
.peers
; p
!= NULL
; p
= p
->next
) {
877 debugs(3, 1, "Initializing cache_peer " << p
->name
<< " SSL context");
878 p
->sslContext
= sslCreateClientContext(p
->sslcert
, p
->sslkey
, p
->sslversion
, p
->sslcipher
, p
->ssloptions
, p
->sslflags
, p
->sslcafile
, p
->sslcapath
, p
->sslcrlfile
);
887 for (s
= Config
.Sockaddr
.http
; s
!= NULL
; s
= (http_port_list
*) s
->next
) {
888 if (!s
->cert
&& !s
->key
)
891 debugs(3, 1, "Initializing http_port " << s
->http
.s
<< " SSL context");
893 s
->staticSslContext
.reset(
894 sslCreateServerContext(s
->cert
, s
->key
,
895 s
->version
, s
->cipher
, s
->options
, s
->sslflags
, s
->clientca
,
896 s
->cafile
, s
->capath
, s
->crlfile
, s
->dhfile
,
897 s
->sslContextSessionId
));
899 Ssl::readCertAndPrivateKeyFromFiles(s
->signingCert
, s
->signPkey
, s
->cert
, s
->key
);
907 for (s
= Config
.Sockaddr
.https
; s
!= NULL
; s
= (https_port_list
*) s
->http
.next
) {
908 debugs(3, 1, "Initializing https_port " << s
->http
.s
<< " SSL context");
910 s
->staticSslContext
.reset(
911 sslCreateServerContext(s
->cert
, s
->key
,
912 s
->version
, s
->cipher
, s
->options
, s
->sslflags
, s
->clientca
,
913 s
->cafile
, s
->capath
, s
->crlfile
, s
->dhfile
,
914 s
->sslContextSessionId
));
920 // prevent infinite fetch loops in the request parser
921 // due to buffer full but not enough data recived to finish parse
922 if (Config
.maxRequestBufferSize
<= Config
.maxRequestHeaderSize
) {
923 fatalf("Client request buffer of %u bytes cannot hold a request with %u bytes of headers." \
924 " Change client_request_buffer_max or request_header_max_size limits.",
925 (uint32_t)Config
.maxRequestBufferSize
, (uint32_t)Config
.maxRequestHeaderSize
);
930 * disable client side request pipelining. There is a race with
931 * Negotiate and NTLM when the client sends a second request on an
932 * connection before the authenticate challenge is sent. With
933 * pipelining OFF, the client may fail to authenticate, but squid's
934 * state will be preserved.
936 if (Config
.onoff
.pipeline_prefetch
) {
937 Auth::Config
*nego
= Auth::Config::Find("Negotiate");
938 Auth::Config
*ntlm
= Auth::Config::Find("NTLM");
939 if ((nego
&& nego
->active()) || (ntlm
&& ntlm
->active())) {
940 debugs(3, DBG_IMPORTANT
, "WARNING: pipeline_prefetch breaks NTLM and Negotiate authentication. Forced OFF.");
941 Config
.onoff
.pipeline_prefetch
= 0;
947 /** Parse a line containing an obsolete directive.
948 * To upgrade it where possible instead of just "Bungled config" for
949 * directives which cannot be marked as simply aliases of the some name.
950 * For example if the parameter order and content has changed.
951 * Or if the directive has been completely removed.
954 parse_obsolete(const char *name
)
956 // Directives which have been radically changed rather than removed
957 if (!strcmp(name
, "url_rewrite_concurrency")) {
960 debugs(3, DBG_CRITICAL
, "WARNING: url_rewrite_concurrency upgrade overriding url_rewrite_children settings.");
961 Config
.redirectChildren
.concurrency
= cval
;
965 /* Parse a time specification from the config file. Store the
966 * result in 'tptr', after converting it to 'units' */
968 parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
)
975 if ((u
= parseTimeUnits(units
, allowMsec
)) == 0)
978 if ((token
= strtok(NULL
, w_space
)) == NULL
)
983 m
= u
; /* default to 'units' if none specified */
987 else if ((token
= strtok(NULL
, w_space
)) == NULL
)
988 debugs(3, 0, "WARNING: No units on '" <<
989 config_input_line
<< "', assuming " <<
991 else if ((m
= parseTimeUnits(token
, allowMsec
)) == 0)
994 *tptr
= static_cast<time_msec_t
>(m
* d
);
998 parseTimeUnits(const char *unit
, bool allowMsec
)
1000 if (allowMsec
&& !strncasecmp(unit
, T_MILLISECOND_STR
, strlen(T_MILLISECOND_STR
)))
1003 if (!strncasecmp(unit
, T_SECOND_STR
, strlen(T_SECOND_STR
)))
1006 if (!strncasecmp(unit
, T_MINUTE_STR
, strlen(T_MINUTE_STR
)))
1009 if (!strncasecmp(unit
, T_HOUR_STR
, strlen(T_HOUR_STR
)))
1012 if (!strncasecmp(unit
, T_DAY_STR
, strlen(T_DAY_STR
)))
1013 return 86400 * 1000;
1015 if (!strncasecmp(unit
, T_WEEK_STR
, strlen(T_WEEK_STR
)))
1016 return 86400 * 7 * 1000;
1018 if (!strncasecmp(unit
, T_FORTNIGHT_STR
, strlen(T_FORTNIGHT_STR
)))
1019 return 86400 * 14 * 1000;
1021 if (!strncasecmp(unit
, T_MONTH_STR
, strlen(T_MONTH_STR
)))
1022 return static_cast<uint64_t>(86400) * 30 * 1000;
1024 if (!strncasecmp(unit
, T_YEAR_STR
, strlen(T_YEAR_STR
)))
1025 return static_cast<uint64_t>(86400 * 1000 * 365.2522);
1027 if (!strncasecmp(unit
, T_DECADE_STR
, strlen(T_DECADE_STR
)))
1028 return static_cast<uint64_t>(86400 * 1000 * 365.2522 * 10);
1030 debugs(3, 1, "parseTimeUnits: unknown time unit '" << unit
<< "'");
1036 parseBytesLine64(int64_t * bptr
, const char *units
)
1043 if ((u
= parseBytesUnits(units
)) == 0) {
1048 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
1053 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1060 m
= u
; /* default to 'units' if none specified */
1064 else if ((token
= strtok(NULL
, w_space
)) == NULL
)
1065 debugs(3, 0, "WARNING: No units on '" <<
1066 config_input_line
<< "', assuming " <<
1067 d
<< " " << units
);
1068 else if ((m
= parseBytesUnits(token
)) == 0) {
1073 *bptr
= static_cast<int64_t>(m
* d
/ u
);
1075 if (static_cast<double>(*bptr
) * 2 != m
* d
/ u
* 2)
1081 parseBytesLine(size_t * bptr
, const char *units
)
1088 if ((u
= parseBytesUnits(units
)) == 0) {
1093 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
1098 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1099 *bptr
= static_cast<size_t>(-1);
1105 m
= u
; /* default to 'units' if none specified */
1109 else if ((token
= strtok(NULL
, w_space
)) == NULL
)
1110 debugs(3, 0, "WARNING: No units on '" <<
1111 config_input_line
<< "', assuming " <<
1112 d
<< " " << units
);
1113 else if ((m
= parseBytesUnits(token
)) == 0) {
1118 *bptr
= static_cast<size_t>(m
* d
/ u
);
1120 if (static_cast<double>(*bptr
) * 2 != m
* d
/ u
* 2)
1126 parseBytesLineSigned(ssize_t
* bptr
, const char *units
)
1133 if ((u
= parseBytesUnits(units
)) == 0) {
1138 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
1143 if (strcmp(token
, "none") == 0 || token
[0] == '-' /* -N */) {
1150 m
= u
; /* default to 'units' if none specified */
1154 else if ((token
= strtok(NULL
, w_space
)) == NULL
)
1155 debugs(3, 0, "WARNING: No units on '" <<
1156 config_input_line
<< "', assuming " <<
1157 d
<< " " << units
);
1158 else if ((m
= parseBytesUnits(token
)) == 0) {
1163 *bptr
= static_cast<size_t>(m
* d
/ u
);
1165 if (static_cast<double>(*bptr
) * 2 != m
* d
/ u
* 2)
1172 * Parse bytes from a string.
1173 * Similar to the parseBytesLine function but parses the string value instead of
1174 * the current token value.
1176 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
)
1179 if ((u
= parseBytesUnits(units
)) == 0) {
1184 // Find number from string beginning.
1185 char const * number_begin
= value
;
1186 char const * number_end
= value
;
1188 while ((*number_end
>= '0' && *number_end
<= '9')) {
1193 number
.limitInit(number_begin
, number_end
- number_begin
);
1195 int d
= xatoi(number
.termedBuf());
1197 if ((m
= parseBytesUnits(number_end
)) == 0) {
1202 *bptr
= static_cast<size_t>(m
* d
/ u
);
1203 if (static_cast<double>(*bptr
) * 2 != m
* d
/ u
* 2)
1209 parseBytesUnits(const char *unit
)
1211 if (!strncasecmp(unit
, B_BYTES_STR
, strlen(B_BYTES_STR
)))
1214 if (!strncasecmp(unit
, B_KBYTES_STR
, strlen(B_KBYTES_STR
)))
1217 if (!strncasecmp(unit
, B_MBYTES_STR
, strlen(B_MBYTES_STR
)))
1220 if (!strncasecmp(unit
, B_GBYTES_STR
, strlen(B_GBYTES_STR
)))
1223 debugs(3, DBG_CRITICAL
, "WARNING: Unknown bytes unit '" << unit
<< "'");
1228 /*****************************************************************************
1230 *****************************************************************************/
1233 dump_acl(StoreEntry
* entry
, const char *name
, ACL
* ae
)
1238 while (ae
!= NULL
) {
1239 debugs(3, 3, "dump_acl: " << name
<< " " << ae
->name
);
1240 storeAppendPrintf(entry
, "%s %s %s ",
1247 debugs(3, 3, "dump_acl: " << name
<< " " << ae
->name
<< " " << v
->key
);
1248 storeAppendPrintf(entry
, "%s ", v
->key
);
1252 storeAppendPrintf(entry
, "\n");
1253 wordlistDestroy(&w
);
1259 parse_acl(ACL
** ae
)
1261 ACL::ParseAclLine(LegacyParser
, ae
);
1271 dump_acl_list(StoreEntry
* entry
, ACLList
* head
)
1275 for (l
= head
; l
; l
= l
->next
) {
1276 storeAppendPrintf(entry
, " %s%s",
1277 l
->op
? null_string
: "!",
1283 dump_acl_access(StoreEntry
* entry
, const char *name
, acl_access
* head
)
1287 for (l
= head
; l
; l
= l
->next
) {
1288 storeAppendPrintf(entry
, "%s %s",
1290 l
->allow
? "Allow" : "Deny");
1291 dump_acl_list(entry
, l
->aclList
);
1292 storeAppendPrintf(entry
, "\n");
1297 parse_acl_access(acl_access
** head
)
1299 aclParseAccessLine(LegacyParser
, head
);
1303 free_acl_access(acl_access
** head
)
1305 aclDestroyAccessList(head
);
1309 dump_address(StoreEntry
* entry
, const char *name
, Ip::Address
&addr
)
1311 char buf
[MAX_IPSTRLEN
];
1312 storeAppendPrintf(entry
, "%s %s\n", name
, addr
.NtoA(buf
,MAX_IPSTRLEN
) );
1316 parse_address(Ip::Address
*addr
)
1318 char *token
= strtok(NULL
, w_space
);
1325 if (!strcmp(token
,"any_addr")) {
1328 } else if ( (!strcmp(token
,"no_addr")) || (!strcmp(token
,"full_mask")) ) {
1336 free_address(Ip::Address
*addr
)
1341 CBDATA_TYPE(acl_address
);
1344 dump_acl_address(StoreEntry
* entry
, const char *name
, acl_address
* head
)
1346 char buf
[MAX_IPSTRLEN
];
1349 for (l
= head
; l
; l
= l
->next
) {
1350 if (!l
->addr
.IsAnyAddr())
1351 storeAppendPrintf(entry
, "%s %s", name
, l
->addr
.NtoA(buf
,MAX_IPSTRLEN
));
1353 storeAppendPrintf(entry
, "%s autoselect", name
);
1355 dump_acl_list(entry
, l
->aclList
);
1357 storeAppendPrintf(entry
, "\n");
1362 freed_acl_address(void *data
)
1364 acl_address
*l
= static_cast<acl_address
*>(data
);
1365 aclDestroyAclList(&l
->aclList
);
1369 parse_acl_address(acl_address
** head
)
1372 acl_address
**tail
= head
; /* sane name below */
1373 CBDATA_INIT_TYPE_FREECB(acl_address
, freed_acl_address
);
1374 l
= cbdataAlloc(acl_address
);
1375 parse_address(&l
->addr
);
1376 aclParseAclList(LegacyParser
, &l
->aclList
);
1379 tail
= &(*tail
)->next
;
1385 free_acl_address(acl_address
** head
)
1388 acl_address
*l
= *head
;
1394 CBDATA_TYPE(acl_tos
);
1397 dump_acl_tos(StoreEntry
* entry
, const char *name
, acl_tos
* head
)
1401 for (l
= head
; l
; l
= l
->next
) {
1403 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->tos
);
1405 storeAppendPrintf(entry
, "%s none", name
);
1407 dump_acl_list(entry
, l
->aclList
);
1409 storeAppendPrintf(entry
, "\n");
1414 freed_acl_tos(void *data
)
1416 acl_tos
*l
= static_cast<acl_tos
*>(data
);
1417 aclDestroyAclList(&l
->aclList
);
1421 parse_acl_tos(acl_tos
** head
)
1424 acl_tos
**tail
= head
; /* sane name below */
1425 unsigned int tos
; /* Initially uint for strtoui. Casted to tos_t before return */
1426 char *token
= strtok(NULL
, w_space
);
1433 if (!xstrtoui(token
, NULL
, &tos
, 0, std::numeric_limits
<tos_t
>::max())) {
1438 CBDATA_INIT_TYPE_FREECB(acl_tos
, freed_acl_tos
);
1440 l
= cbdataAlloc(acl_tos
);
1442 l
->tos
= (tos_t
)tos
;
1444 aclParseAclList(LegacyParser
, &l
->aclList
);
1447 tail
= &(*tail
)->next
;
1453 free_acl_tos(acl_tos
** head
)
1463 #if SO_MARK && USE_LIBCAP
1465 CBDATA_TYPE(acl_nfmark
);
1468 dump_acl_nfmark(StoreEntry
* entry
, const char *name
, acl_nfmark
* head
)
1472 for (l
= head
; l
; l
= l
->next
) {
1474 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->nfmark
);
1476 storeAppendPrintf(entry
, "%s none", name
);
1478 dump_acl_list(entry
, l
->aclList
);
1480 storeAppendPrintf(entry
, "\n");
1485 freed_acl_nfmark(void *data
)
1487 acl_nfmark
*l
= static_cast<acl_nfmark
*>(data
);
1488 aclDestroyAclList(&l
->aclList
);
1492 parse_acl_nfmark(acl_nfmark
** head
)
1495 acl_nfmark
**tail
= head
; /* sane name below */
1497 char *token
= strtok(NULL
, w_space
);
1504 if (!xstrtoui(token
, NULL
, &mark
, 0, std::numeric_limits
<nfmark_t
>::max())) {
1509 CBDATA_INIT_TYPE_FREECB(acl_nfmark
, freed_acl_nfmark
);
1511 l
= cbdataAlloc(acl_nfmark
);
1515 aclParseAclList(LegacyParser
, &l
->aclList
);
1518 tail
= &(*tail
)->next
;
1524 free_acl_nfmark(acl_nfmark
** head
)
1527 acl_nfmark
*l
= *head
;
1533 #endif /* SO_MARK */
1535 CBDATA_TYPE(acl_size_t
);
1538 dump_acl_b_size_t(StoreEntry
* entry
, const char *name
, acl_size_t
* head
)
1542 for (l
= head
; l
; l
= l
->next
) {
1544 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) l
->size
, B_BYTES_STR
);
1546 storeAppendPrintf(entry
, "%s none", name
);
1548 dump_acl_list(entry
, l
->aclList
);
1550 storeAppendPrintf(entry
, "\n");
1555 freed_acl_b_size_t(void *data
)
1557 acl_size_t
*l
= static_cast<acl_size_t
*>(data
);
1558 aclDestroyAclList(&l
->aclList
);
1562 parse_acl_b_size_t(acl_size_t
** head
)
1565 acl_size_t
**tail
= head
; /* sane name below */
1567 CBDATA_INIT_TYPE_FREECB(acl_size_t
, freed_acl_b_size_t
);
1569 l
= cbdataAlloc(acl_size_t
);
1571 parse_b_int64_t(&l
->size
);
1573 aclParseAclList(LegacyParser
, &l
->aclList
);
1576 tail
= &(*tail
)->next
;
1582 free_acl_b_size_t(acl_size_t
** head
)
1585 acl_size_t
*l
= *head
;
1594 #include "DelayPools.h"
1595 #include "DelayConfig.h"
1596 /* do nothing - free_delay_pool_count is the magic free function.
1597 * this is why delay_pool_count isn't just marked TYPE: u_short
1599 #define free_delay_pool_class(X)
1600 #define free_delay_pool_access(X)
1601 #define free_delay_pool_rates(X)
1602 #define dump_delay_pool_class(X, Y, Z)
1603 #define dump_delay_pool_access(X, Y, Z)
1604 #define dump_delay_pool_rates(X, Y, Z)
1607 free_delay_pool_count(DelayConfig
* cfg
)
1609 cfg
->freePoolCount();
1613 dump_delay_pool_count(StoreEntry
* entry
, const char *name
, DelayConfig
&cfg
)
1615 cfg
.dumpPoolCount (entry
, name
);
1619 parse_delay_pool_count(DelayConfig
* cfg
)
1621 cfg
->parsePoolCount();
1625 parse_delay_pool_class(DelayConfig
* cfg
)
1627 cfg
->parsePoolClass();
1631 parse_delay_pool_rates(DelayConfig
* cfg
)
1633 cfg
->parsePoolRates();
1637 parse_delay_pool_access(DelayConfig
* cfg
)
1639 cfg
->parsePoolAccess(LegacyParser
);
1645 #include "ClientDelayConfig.h"
1646 /* do nothing - free_client_delay_pool_count is the magic free function.
1647 * this is why client_delay_pool_count isn't just marked TYPE: u_short
1650 #define free_client_delay_pool_access(X)
1651 #define free_client_delay_pool_rates(X)
1652 #define dump_client_delay_pool_access(X, Y, Z)
1653 #define dump_client_delay_pool_rates(X, Y, Z)
1656 free_client_delay_pool_count(ClientDelayConfig
* cfg
)
1658 cfg
->freePoolCount();
1662 dump_client_delay_pool_count(StoreEntry
* entry
, const char *name
, ClientDelayConfig
&cfg
)
1664 cfg
.dumpPoolCount (entry
, name
);
1668 parse_client_delay_pool_count(ClientDelayConfig
* cfg
)
1670 cfg
->parsePoolCount();
1674 parse_client_delay_pool_rates(ClientDelayConfig
* cfg
)
1676 cfg
->parsePoolRates();
1680 parse_client_delay_pool_access(ClientDelayConfig
* cfg
)
1682 cfg
->parsePoolAccess(LegacyParser
);
1686 #if USE_HTTP_VIOLATIONS
1688 dump_http_header_access(StoreEntry
* entry
, const char *name
, header_mangler header
[])
1692 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1693 if (header
[i
].access_list
!= NULL
) {
1694 storeAppendPrintf(entry
, "%s ", name
);
1695 dump_acl_access(entry
, httpHeaderNameById(i
),
1696 header
[i
].access_list
);
1702 parse_http_header_access(header_mangler header
[])
1707 if ((t
= strtok(NULL
, w_space
)) == NULL
) {
1708 debugs(3, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1709 debugs(3, 0, "parse_http_header_access: missing header name.");
1713 /* Now lookup index of header. */
1714 id
= httpHeaderIdByNameDef(t
, strlen(t
));
1716 if (strcmp(t
, "All") == 0)
1718 else if (strcmp(t
, "Other") == 0)
1720 else if (id
== -1) {
1721 debugs(3, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1722 debugs(3, 0, "parse_http_header_access: unknown header name '" << t
<< "'");
1726 if (id
!= HDR_ENUM_END
) {
1727 parse_acl_access(&header
[id
].access_list
);
1729 char *next_string
= t
+ strlen(t
) - 1;
1731 *(next_string
+ 1) = ' ';
1733 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1734 char *new_string
= xstrdup(next_string
);
1735 strtok(new_string
, w_space
);
1736 parse_acl_access(&header
[i
].access_list
);
1737 safe_free(new_string
);
1743 free_http_header_access(header_mangler header
[])
1747 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1748 free_acl_access(&header
[i
].access_list
);
1753 dump_http_header_replace(StoreEntry
* entry
, const char *name
, header_mangler
1758 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1759 if (NULL
== header
[i
].replacement
)
1762 storeAppendPrintf(entry
, "%s %s %s\n", name
, httpHeaderNameById(i
),
1763 header
[i
].replacement
);
1768 parse_http_header_replace(header_mangler header
[])
1773 if ((t
= strtok(NULL
, w_space
)) == NULL
) {
1774 debugs(3, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1775 debugs(3, 0, "parse_http_header_replace: missing header name.");
1779 /* Now lookup index of header. */
1780 id
= httpHeaderIdByNameDef(t
, strlen(t
));
1782 if (strcmp(t
, "All") == 0)
1784 else if (strcmp(t
, "Other") == 0)
1786 else if (id
== -1) {
1787 debugs(3, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1788 debugs(3, 0, "parse_http_header_replace: unknown header name " << t
<< ".");
1793 if (id
!= HDR_ENUM_END
) {
1794 if (header
[id
].replacement
!= NULL
)
1795 safe_free(header
[id
].replacement
);
1797 header
[id
].replacement
= xstrdup(t
+ strlen(t
) + 1);
1799 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1800 if (header
[i
].replacement
!= NULL
)
1801 safe_free(header
[i
].replacement
);
1803 header
[i
].replacement
= xstrdup(t
+ strlen(t
) + 1);
1809 free_http_header_replace(header_mangler header
[])
1813 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1814 if (header
[i
].replacement
!= NULL
)
1815 safe_free(header
[i
].replacement
);
1822 dump_cachedir(StoreEntry
* entry
, const char *name
, SquidConfig::_cacheSwap swap
)
1828 for (i
= 0; i
< swap
.n_configured
; i
++) {
1829 s
= dynamic_cast<SwapDir
*>(swap
.swapDirs
[i
].getRaw());
1831 storeAppendPrintf(entry
, "%s %s %s", name
, s
->type(), s
->path
);
1833 storeAppendPrintf(entry
, "\n");
1838 check_null_string(char *s
)
1845 parse_authparam(Auth::ConfigVector
* config
)
1850 if ((type_str
= strtok(NULL
, w_space
)) == NULL
)
1853 if ((param_str
= strtok(NULL
, w_space
)) == NULL
)
1856 /* find a configuration for the scheme in the currently parsed configs... */
1857 Auth::Config
*schemeCfg
= Auth::Config::Find(type_str
);
1859 if (schemeCfg
== NULL
) {
1860 /* Create a configuration based on the scheme info */
1861 Auth::Scheme::Pointer theScheme
= Auth::Scheme::Find(type_str
);
1863 if (theScheme
== NULL
) {
1864 debugs(3, DBG_CRITICAL
, "Parsing Config File: Unknown authentication scheme '" << type_str
<< "'.");
1868 config
->push_back(theScheme
->createConfig());
1869 schemeCfg
= Auth::Config::Find(type_str
);
1870 if (schemeCfg
== NULL
) {
1871 debugs(3, DBG_CRITICAL
, "Parsing Config File: Corruption configuring authentication scheme '" << type_str
<< "'.");
1876 schemeCfg
->parse(schemeCfg
, config
->size(), param_str
);
1880 free_authparam(Auth::ConfigVector
* cfg
)
1882 /* Wipe the Auth globals and Detach/Destruct component config + state. */
1885 /* remove our pointers to the probably-dead sub-configs */
1886 while (cfg
->size()) {
1890 /* on reconfigure initialize new auth schemes for the new config. */
1891 if (reconfiguring
) {
1897 dump_authparam(StoreEntry
* entry
, const char *name
, Auth::ConfigVector cfg
)
1899 for (Auth::ConfigVector::iterator i
= cfg
.begin(); i
!= cfg
.end(); ++i
)
1900 (*i
)->dump(entry
, name
, (*i
));
1902 #endif /* USE_AUTH */
1904 /* TODO: just return the object, the # is irrelevant */
1906 find_fstype(char *type
)
1908 for (size_t i
= 0; i
< StoreFileSystem::FileSystems().size(); ++i
)
1909 if (strcasecmp(type
, StoreFileSystem::FileSystems().items
[i
]->type()) == 0)
1916 parse_cachedir(SquidConfig::_cacheSwap
* swap
)
1918 // The workers option must preceed cache_dir for the IamWorkerProcess check
1919 // below to work. TODO: Redo IamWorkerProcess to work w/o Config and remove
1920 if (KidIdentifier
> 1 && Config
.workers
== 1) {
1921 debugs(3, DBG_CRITICAL
,
1922 "FATAL: cache_dir found before the workers option. Reorder.");
1926 // Among all processes, only workers may need and can handle cache_dir.
1927 if (!IamWorkerProcess())
1932 RefCount
<SwapDir
> sd
;
1936 if ((type_str
= strtok(NULL
, w_space
)) == NULL
)
1939 if ((path_str
= strtok(NULL
, w_space
)) == NULL
)
1942 fs
= find_fstype(type_str
);
1947 /* reconfigure existing dir */
1949 for (i
= 0; i
< swap
->n_configured
; i
++) {
1950 assert (swap
->swapDirs
[i
].getRaw());
1952 if ((strcasecmp(path_str
, dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw())->path
)) == 0) {
1953 /* this is specific to on-fs Stores. The right
1954 * way to handle this is probably to have a mapping
1955 * from paths to stores, and have on-fs stores
1956 * register with that, and lookip in that in their
1957 * own setup logic. RBC 20041225. TODO.
1960 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw());
1962 if (sd
->type() != StoreFileSystem::FileSystems().items
[fs
]->type()) {
1963 debugs(3, 0, "ERROR: Can't change type of existing cache_dir " <<
1964 sd
->type() << " " << sd
->path
<< " to " << type_str
<< ". Restart required");
1968 sd
->reconfigure (i
, path_str
);
1970 update_maxobjsize();
1977 if (swap
->n_configured
> 63) {
1978 /* 7 bits, signed */
1979 debugs(3, DBG_CRITICAL
, "WARNING: There is a fixed maximum of 63 cache_dir entries Squid can handle.");
1980 debugs(3, DBG_CRITICAL
, "WARNING: '" << path_str
<< "' is one to many.");
1985 allocate_new_swapdir(swap
);
1987 swap
->swapDirs
[swap
->n_configured
] = StoreFileSystem::FileSystems().items
[fs
]->createSwapDir();
1989 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[swap
->n_configured
].getRaw());
1991 /* parse the FS parameters and options */
1992 sd
->parse(swap
->n_configured
, path_str
);
1994 ++swap
->n_configured
;
1996 /* Update the max object size */
1997 update_maxobjsize();
2001 peer_type_str(const peer_t type
)
2003 const char * result
;
2015 case PEER_MULTICAST
:
2016 result
= "multicast";
2028 dump_peer(StoreEntry
* entry
, const char *name
, peer
* p
)
2032 LOCAL_ARRAY(char, xname
, 128);
2035 storeAppendPrintf(entry
, "%s %s %s %d %d name=%s",
2042 dump_peer_options(entry
, p
);
2044 for (d
= p
->peer_domain
; d
; d
= d
->next
) {
2045 storeAppendPrintf(entry
, "cache_peer_domain %s %s%s\n",
2047 d
->do_ping
? null_string
: "!",
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.
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
= strtok(NULL
, w_space
);
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((u_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)
2114 return GetService("tcp");
2118 \returns Port the named UDP service is supposed to be listening on.
2119 \copydoc GetService(const char *proto)
2124 return GetService("udp");
2128 parse_peer(peer
** head
)
2132 CBDATA_INIT_TYPE_FREECB(peer
, peerDestroy
);
2133 p
= cbdataAlloc(peer
);
2134 p
->http_port
= CACHE_HTTP_PORT
;
2135 p
->icp
.port
= CACHE_ICP_PORT
;
2138 p
->stats
.logged_state
= PEER_ALIVE
;
2140 if ((token
= strtok(NULL
, w_space
)) == NULL
)
2143 p
->host
= xstrdup(token
);
2145 p
->name
= xstrdup(token
);
2147 if ((token
= strtok(NULL
, w_space
)) == NULL
)
2150 p
->type
= parseNeighborType(token
);
2152 if (p
->type
== PEER_MULTICAST
) {
2153 p
->options
.no_digest
= 1;
2154 p
->options
.no_netdb_exchange
= 1;
2157 p
->http_port
= GetTcpService();
2162 p
->icp
.port
= GetUdpService();
2163 p
->connection_auth
= 2; /* auto */
2165 while ((token
= strtok(NULL
, w_space
))) {
2166 if (!strcasecmp(token
, "proxy-only")) {
2167 p
->options
.proxy_only
= 1;
2168 } else if (!strcasecmp(token
, "no-query")) {
2169 p
->options
.no_query
= 1;
2170 } else if (!strcasecmp(token
, "background-ping")) {
2171 p
->options
.background_ping
= 1;
2172 } else if (!strcasecmp(token
, "no-digest")) {
2173 p
->options
.no_digest
= 1;
2174 } else if (!strcasecmp(token
, "no-tproxy")) {
2175 p
->options
.no_tproxy
= 1;
2176 } else if (!strcasecmp(token
, "multicast-responder")) {
2177 p
->options
.mcast_responder
= 1;
2178 #if PEER_MULTICAST_SIBLINGS
2179 } else if (!strcasecmp(token
, "multicast-siblings")) {
2180 p
->options
.mcast_siblings
= 1;
2182 } else if (!strncasecmp(token
, "weight=", 7)) {
2183 p
->weight
= xatoi(token
+ 7);
2184 } else if (!strncasecmp(token
, "basetime=", 9)) {
2185 p
->basetime
= xatoi(token
+ 9);
2186 } else if (!strcasecmp(token
, "closest-only")) {
2187 p
->options
.closest_only
= 1;
2188 } else if (!strncasecmp(token
, "ttl=", 4)) {
2189 p
->mcast
.ttl
= xatoi(token
+ 4);
2191 if (p
->mcast
.ttl
< 0)
2194 if (p
->mcast
.ttl
> 128)
2196 } else if (!strcasecmp(token
, "default")) {
2197 p
->options
.default_parent
= 1;
2198 } else if (!strcasecmp(token
, "round-robin")) {
2199 p
->options
.roundrobin
= 1;
2200 } else if (!strcasecmp(token
, "weighted-round-robin")) {
2201 p
->options
.weighted_roundrobin
= 1;
2203 } else if (!strcasecmp(token
, "htcp")) {
2204 p
->options
.htcp
= 1;
2205 } else if (!strncasecmp(token
, "htcp=", 5) || !strncasecmp(token
, "htcp-", 5)) {
2206 /* Note: The htcp- form is deprecated, replaced by htcp= */
2207 p
->options
.htcp
= 1;
2208 char *tmp
= xstrdup(token
+5);
2209 char *mode
, *nextmode
;
2210 for (mode
= nextmode
= tmp
; mode
; mode
= nextmode
) {
2211 nextmode
= strchr(mode
, ',');
2214 if (!strcasecmp(mode
, "no-clr")) {
2215 if (p
->options
.htcp_only_clr
)
2216 fatalf("parse_peer: can't set htcp-no-clr and htcp-only-clr simultaneously");
2217 p
->options
.htcp_no_clr
= 1;
2218 } else if (!strcasecmp(mode
, "no-purge-clr")) {
2219 p
->options
.htcp_no_purge_clr
= 1;
2220 } else if (!strcasecmp(mode
, "only-clr")) {
2221 if (p
->options
.htcp_no_clr
)
2222 fatalf("parse_peer: can't set htcp no-clr and only-clr simultaneously");
2223 p
->options
.htcp_only_clr
= 1;
2224 } else if (!strcasecmp(mode
, "forward-clr")) {
2225 p
->options
.htcp_forward_clr
= 1;
2226 } else if (!strcasecmp(mode
, "oldsquid")) {
2227 p
->options
.htcp_oldsquid
= 1;
2229 fatalf("invalid HTCP mode '%s'", mode
);
2234 } else if (!strcasecmp(token
, "no-netdb-exchange")) {
2235 p
->options
.no_netdb_exchange
= 1;
2237 } else if (!strcasecmp(token
, "carp")) {
2238 if (p
->type
!= PEER_PARENT
)
2239 fatalf("parse_peer: non-parent carp peer %s/%d\n", p
->host
, p
->http_port
);
2241 p
->options
.carp
= 1;
2242 } else if (!strcasecmp(token
, "userhash")) {
2244 if (p
->type
!= PEER_PARENT
)
2245 fatalf("parse_peer: non-parent userhash peer %s/%d\n", p
->host
, p
->http_port
);
2247 p
->options
.userhash
= 1;
2249 fatalf("parse_peer: userhash requires authentication. peer %s/%d\n", p
->host
, p
->http_port
);
2251 } else if (!strcasecmp(token
, "sourcehash")) {
2252 if (p
->type
!= PEER_PARENT
)
2253 fatalf("parse_peer: non-parent sourcehash peer %s/%d\n", p
->host
, p
->http_port
);
2255 p
->options
.sourcehash
= 1;
2257 } else if (!strcasecmp(token
, "no-delay")) {
2259 p
->options
.no_delay
= 1;
2261 debugs(0, DBG_CRITICAL
, "WARNING: cache_peer option 'no-delay' requires --enable-delay-pools");
2263 } else if (!strncasecmp(token
, "login=", 6)) {
2264 p
->login
= xstrdup(token
+ 6);
2265 rfc1738_unescape(p
->login
);
2266 } else if (!strncasecmp(token
, "connect-timeout=", 16)) {
2267 p
->connect_timeout
= xatoi(token
+ 16);
2268 } else if (!strncasecmp(token
, "connect-fail-limit=", 19)) {
2269 p
->connect_fail_limit
= xatoi(token
+ 19);
2270 #if USE_CACHE_DIGESTS
2271 } else if (!strncasecmp(token
, "digest-url=", 11)) {
2272 p
->digest_url
= xstrdup(token
+ 11);
2275 } else if (!strcasecmp(token
, "allow-miss")) {
2276 p
->options
.allow_miss
= 1;
2277 } else if (!strncasecmp(token
, "max-conn=", 9)) {
2278 p
->max_conn
= xatoi(token
+ 9);
2279 } else if (!strcasecmp(token
, "originserver")) {
2280 p
->options
.originserver
= 1;
2281 } else if (!strncasecmp(token
, "name=", 5)) {
2285 p
->name
= xstrdup(token
+ 5);
2286 } else if (!strncasecmp(token
, "forceddomain=", 13)) {
2287 safe_free(p
->domain
);
2290 p
->domain
= xstrdup(token
+ 13);
2294 } else if (strcmp(token
, "ssl") == 0) {
2296 } else if (strncmp(token
, "sslcert=", 8) == 0) {
2297 safe_free(p
->sslcert
);
2298 p
->sslcert
= xstrdup(token
+ 8);
2299 } else if (strncmp(token
, "sslkey=", 7) == 0) {
2300 safe_free(p
->sslkey
);
2301 p
->sslkey
= xstrdup(token
+ 7);
2302 } else if (strncmp(token
, "sslversion=", 11) == 0) {
2303 p
->sslversion
= atoi(token
+ 11);
2304 } else if (strncmp(token
, "ssloptions=", 11) == 0) {
2305 safe_free(p
->ssloptions
);
2306 p
->ssloptions
= xstrdup(token
+ 11);
2307 } else if (strncmp(token
, "sslcipher=", 10) == 0) {
2308 safe_free(p
->sslcipher
);
2309 p
->sslcipher
= xstrdup(token
+ 10);
2310 } else if (strncmp(token
, "sslcafile=", 10) == 0) {
2311 safe_free(p
->sslcafile
);
2312 p
->sslcafile
= xstrdup(token
+ 10);
2313 } else if (strncmp(token
, "sslcapath=", 10) == 0) {
2314 safe_free(p
->sslcapath
);
2315 p
->sslcapath
= xstrdup(token
+ 10);
2316 } else if (strncmp(token
, "sslcrlfile=", 11) == 0) {
2317 safe_free(p
->sslcrlfile
);
2318 p
->sslcapath
= xstrdup(token
+ 10);
2319 } else if (strncmp(token
, "sslflags=", 9) == 0) {
2320 safe_free(p
->sslflags
);
2321 p
->sslflags
= xstrdup(token
+ 9);
2322 } else if (strncmp(token
, "ssldomain=", 10) == 0) {
2323 safe_free(p
->ssldomain
);
2324 p
->ssldomain
= xstrdup(token
+ 10);
2327 } else if (strcmp(token
, "front-end-https") == 0) {
2328 p
->front_end_https
= 1;
2329 } else if (strcmp(token
, "front-end-https=on") == 0) {
2330 p
->front_end_https
= 1;
2331 } else if (strcmp(token
, "front-end-https=auto") == 0) {
2332 p
->front_end_https
= 2;
2333 } else if (strcmp(token
, "connection-auth=off") == 0) {
2334 p
->connection_auth
= 0;
2335 } else if (strcmp(token
, "connection-auth") == 0) {
2336 p
->connection_auth
= 1;
2337 } else if (strcmp(token
, "connection-auth=on") == 0) {
2338 p
->connection_auth
= 1;
2339 } else if (strcmp(token
, "connection-auth=auto") == 0) {
2340 p
->connection_auth
= 2;
2342 debugs(3, 0, "parse_peer: token='" << token
<< "'");
2347 if (peerFindByName(p
->name
))
2348 fatalf("ERROR: cache_peer %s specified twice\n", p
->name
);
2353 if (p
->connect_fail_limit
< 1)
2354 p
->connect_fail_limit
= 10;
2356 p
->icp
.version
= ICP_VERSION_CURRENT
;
2358 p
->testing_now
= false;
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(peer
** P
)
2387 while ((p
= *P
) != NULL
) {
2389 #if USE_CACHE_DIGESTS
2391 cbdataReferenceDone(p
->digest
);
2401 dump_cachemgrpasswd(StoreEntry
* entry
, const char *name
, cachemgr_passwd
* list
)
2405 while (list
!= NULL
) {
2406 if (strcmp(list
->passwd
, "none") && strcmp(list
->passwd
, "disable"))
2407 storeAppendPrintf(entry
, "%s XXXXXXXXXX", name
);
2409 storeAppendPrintf(entry
, "%s %s", name
, list
->passwd
);
2411 for (w
= list
->actions
; w
!= NULL
; w
= w
->next
) {
2412 storeAppendPrintf(entry
, " %s", w
->key
);
2415 storeAppendPrintf(entry
, "\n");
2421 parse_cachemgrpasswd(cachemgr_passwd
** head
)
2423 char *passwd
= NULL
;
2424 wordlist
*actions
= NULL
;
2426 cachemgr_passwd
**P
;
2427 parse_string(&passwd
);
2428 parse_wordlist(&actions
);
2429 p
= static_cast<cachemgr_passwd
*>(xcalloc(1, sizeof(cachemgr_passwd
)));
2431 p
->actions
= actions
;
2433 for (P
= head
; *P
; P
= &(*P
)->next
) {
2435 * See if any of the actions from this line already have a
2436 * password from previous lines. The password checking
2437 * routines in cache_manager.c take the the password from
2438 * the first cachemgr_passwd struct that contains the
2439 * requested action. Thus, we should warn users who might
2440 * think they can have two passwords for the same action.
2445 for (w
= (*P
)->actions
; w
; w
= w
->next
) {
2446 for (u
= actions
; u
; u
= u
->next
) {
2447 if (strcmp(w
->key
, u
->key
))
2450 debugs(0, 0, "WARNING: action '" << u
->key
<< "' (line " << config_lineno
<< ") already has a password");
2459 free_cachemgrpasswd(cachemgr_passwd
** head
)
2463 while ((p
= *head
) != NULL
) {
2466 wordlistDestroy(&p
->actions
);
2472 dump_denyinfo(StoreEntry
* entry
, const char *name
, acl_deny_info_list
* var
)
2476 while (var
!= NULL
) {
2477 storeAppendPrintf(entry
, "%s %s", name
, var
->err_page_name
);
2479 for (a
= var
->acl_list
; a
!= NULL
; a
= a
->next
)
2480 storeAppendPrintf(entry
, " %s", a
->name
);
2482 storeAppendPrintf(entry
, "\n");
2489 parse_denyinfo(acl_deny_info_list
** var
)
2491 aclParseDenyInfoLine(var
);
2495 free_denyinfo(acl_deny_info_list
** list
)
2497 acl_deny_info_list
*a
= NULL
;
2498 acl_deny_info_list
*a_next
= NULL
;
2499 acl_name_list
*l
= NULL
;
2500 acl_name_list
*l_next
= NULL
;
2502 for (a
= *list
; a
; a
= a_next
) {
2503 for (l
= a
->acl_list
; l
; l
= l_next
) {
2505 memFree(l
, MEM_ACL_NAME_LIST
);
2510 memFree(a
, MEM_ACL_DENY_INFO_LIST
);
2518 parse_peer_access(void)
2523 if (!(host
= strtok(NULL
, w_space
)))
2526 if ((p
= peerFindByName(host
)) == NULL
) {
2527 debugs(15, 0, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2531 aclParseAccessLine(LegacyParser
, &p
->access
);
2535 parse_hostdomain(void)
2538 char *domain
= NULL
;
2540 if (!(host
= strtok(NULL
, w_space
)))
2543 while ((domain
= strtok(NULL
, list_sep
))) {
2544 domain_ping
*l
= NULL
;
2545 domain_ping
**L
= NULL
;
2548 if ((p
= peerFindByName(host
)) == NULL
) {
2549 debugs(15, 0, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2553 l
= static_cast<domain_ping
*>(xcalloc(1, sizeof(domain_ping
)));
2556 if (*domain
== '!') { /* check for !.edu */
2561 l
->domain
= xstrdup(domain
);
2563 for (L
= &(p
->peer_domain
); *L
; L
= &((*L
)->next
));
2569 parse_hostdomaintype(void)
2573 char *domain
= NULL
;
2575 if (!(host
= strtok(NULL
, w_space
)))
2578 if (!(type
= strtok(NULL
, w_space
)))
2581 while ((domain
= strtok(NULL
, list_sep
))) {
2582 domain_type
*l
= NULL
;
2583 domain_type
**L
= NULL
;
2586 if ((p
= peerFindByName(host
)) == NULL
) {
2587 debugs(15, 0, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2591 l
= static_cast<domain_type
*>(xcalloc(1, sizeof(domain_type
)));
2592 l
->type
= parseNeighborType(type
);
2593 l
->domain
= xstrdup(domain
);
2595 for (L
= &(p
->typelist
); *L
; L
= &((*L
)->next
));
2601 dump_int(StoreEntry
* entry
, const char *name
, int var
)
2603 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
2621 dump_onoff(StoreEntry
* entry
, const char *name
, int var
)
2623 storeAppendPrintf(entry
, "%s %s\n", name
, var
? "on" : "off");
2627 parse_onoff(int *var
)
2629 char *token
= strtok(NULL
, w_space
);
2634 if (!strcasecmp(token
, "on") || !strcasecmp(token
, "enable"))
2640 #define free_onoff free_int
2643 dump_tristate(StoreEntry
* entry
, const char *name
, int var
)
2654 storeAppendPrintf(entry
, "%s %s\n", name
, state
);
2658 parse_tristate(int *var
)
2660 char *token
= strtok(NULL
, w_space
);
2665 if (!strcasecmp(token
, "on") || !strcasecmp(token
, "enable"))
2667 else if (!strcasecmp(token
, "warn"))
2673 #define free_tristate free_int
2676 dump_refreshpattern(StoreEntry
* entry
, const char *name
, refresh_t
* head
)
2678 while (head
!= NULL
) {
2679 storeAppendPrintf(entry
, "%s%s %s %d %d%% %d",
2681 head
->flags
.icase
? " -i" : null_string
,
2683 (int) head
->min
/ 60,
2684 (int) (100.0 * head
->pct
+ 0.5),
2685 (int) head
->max
/ 60);
2687 if (head
->max_stale
>= 0)
2688 storeAppendPrintf(entry
, " max-stale=%d", head
->max_stale
);
2690 if (head
->flags
.refresh_ims
)
2691 storeAppendPrintf(entry
, " refresh-ims");
2693 if (head
->flags
.store_stale
)
2694 storeAppendPrintf(entry
, " store-stale");
2696 #if USE_HTTP_VIOLATIONS
2698 if (head
->flags
.override_expire
)
2699 storeAppendPrintf(entry
, " override-expire");
2701 if (head
->flags
.override_lastmod
)
2702 storeAppendPrintf(entry
, " override-lastmod");
2704 if (head
->flags
.reload_into_ims
)
2705 storeAppendPrintf(entry
, " reload-into-ims");
2707 if (head
->flags
.ignore_reload
)
2708 storeAppendPrintf(entry
, " ignore-reload");
2710 if (head
->flags
.ignore_no_cache
)
2711 storeAppendPrintf(entry
, " ignore-no-cache");
2713 if (head
->flags
.ignore_no_store
)
2714 storeAppendPrintf(entry
, " ignore-no-store");
2716 if (head
->flags
.ignore_must_revalidate
)
2717 storeAppendPrintf(entry
, " ignore-must-revalidate");
2719 if (head
->flags
.ignore_private
)
2720 storeAppendPrintf(entry
, " ignore-private");
2722 if (head
->flags
.ignore_auth
)
2723 storeAppendPrintf(entry
, " ignore-auth");
2727 storeAppendPrintf(entry
, "\n");
2734 parse_refreshpattern(refresh_t
** head
)
2741 int refresh_ims
= 0;
2742 int store_stale
= 0;
2745 #if USE_HTTP_VIOLATIONS
2747 int override_expire
= 0;
2748 int override_lastmod
= 0;
2749 int reload_into_ims
= 0;
2750 int ignore_reload
= 0;
2751 int ignore_no_cache
= 0;
2752 int ignore_no_store
= 0;
2753 int ignore_must_revalidate
= 0;
2754 int ignore_private
= 0;
2755 int ignore_auth
= 0;
2762 int flags
= REG_EXTENDED
| REG_NOSUB
;
2764 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
2769 if (strcmp(token
, "-i") == 0) {
2771 token
= strtok(NULL
, w_space
);
2772 } else if (strcmp(token
, "+i") == 0) {
2773 flags
&= ~REG_ICASE
;
2774 token
= strtok(NULL
, w_space
);
2777 if (token
== NULL
) {
2782 pattern
= xstrdup(token
);
2784 i
= GetInteger(); /* token: min */
2786 /* catch negative and insanely huge values close to 32-bit wrap */
2788 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age negative. Cropped back to zero.");
2791 if (i
> 60*24*365) {
2792 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age too high. Cropped back to 1 year.");
2796 min
= (time_t) (i
* 60); /* convert minutes to seconds */
2798 i
= GetInteger(); /* token: pct */
2800 pct
= (double) i
/ 100.0;
2802 i
= GetInteger(); /* token: max */
2804 /* catch negative and insanely huge values close to 32-bit wrap */
2806 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age negative. Cropped back to zero.");
2809 if (i
> 60*24*365) {
2810 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age too high. Cropped back to 1 year.");
2814 max
= (time_t) (i
* 60); /* convert minutes to seconds */
2817 while ((token
= strtok(NULL
, w_space
)) != NULL
) {
2818 if (!strcmp(token
, "refresh-ims")) {
2820 } else if (!strcmp(token
, "store-stale")) {
2822 } else if (!strncmp(token
, "max-stale=", 10)) {
2823 max_stale
= atoi(token
+ 10);
2824 #if USE_HTTP_VIOLATIONS
2826 } else if (!strcmp(token
, "override-expire"))
2827 override_expire
= 1;
2828 else if (!strcmp(token
, "override-lastmod"))
2829 override_lastmod
= 1;
2830 else if (!strcmp(token
, "ignore-no-cache"))
2831 ignore_no_cache
= 1;
2832 else if (!strcmp(token
, "ignore-no-store"))
2833 ignore_no_store
= 1;
2834 else if (!strcmp(token
, "ignore-must-revalidate"))
2835 ignore_must_revalidate
= 1;
2836 else if (!strcmp(token
, "ignore-private"))
2838 else if (!strcmp(token
, "ignore-auth"))
2840 else if (!strcmp(token
, "reload-into-ims")) {
2841 reload_into_ims
= 1;
2842 refresh_nocache_hack
= 1;
2843 /* tell client_side.c that this is used */
2844 } else if (!strcmp(token
, "ignore-reload")) {
2846 refresh_nocache_hack
= 1;
2847 /* tell client_side.c that this is used */
2851 debugs(22, 0, "refreshAddToList: Unknown option '" << pattern
<< "': " << token
);
2854 if ((errcode
= regcomp(&comp
, pattern
, flags
)) != 0) {
2856 regerror(errcode
, &comp
, errbuf
, sizeof errbuf
);
2857 debugs(22, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
2858 debugs(22, 0, "refreshAddToList: Invalid regular expression '" << pattern
<< "': " << errbuf
);
2862 pct
= pct
< 0.0 ? 0.0 : pct
;
2863 max
= max
< 0 ? 0 : max
;
2864 t
= static_cast<refresh_t
*>(xcalloc(1, sizeof(refresh_t
)));
2865 t
->pattern
= (char *) xstrdup(pattern
);
2866 t
->compiled_pattern
= comp
;
2871 if (flags
& REG_ICASE
)
2875 t
->flags
.refresh_ims
= 1;
2878 t
->flags
.store_stale
= 1;
2880 t
->max_stale
= max_stale
;
2882 #if USE_HTTP_VIOLATIONS
2884 if (override_expire
)
2885 t
->flags
.override_expire
= 1;
2887 if (override_lastmod
)
2888 t
->flags
.override_lastmod
= 1;
2890 if (reload_into_ims
)
2891 t
->flags
.reload_into_ims
= 1;
2894 t
->flags
.ignore_reload
= 1;
2896 if (ignore_no_cache
)
2897 t
->flags
.ignore_no_cache
= 1;
2899 if (ignore_no_store
)
2900 t
->flags
.ignore_no_store
= 1;
2902 if (ignore_must_revalidate
)
2903 t
->flags
.ignore_must_revalidate
= 1;
2906 t
->flags
.ignore_private
= 1;
2909 t
->flags
.ignore_auth
= 1;
2916 head
= &(*head
)->next
;
2924 free_refreshpattern(refresh_t
** head
)
2928 while ((t
= *head
) != NULL
) {
2930 safe_free(t
->pattern
);
2931 regfree(&t
->compiled_pattern
);
2935 #if USE_HTTP_VIOLATIONS
2936 refresh_nocache_hack
= 0;
2942 dump_string(StoreEntry
* entry
, const char *name
, char *var
)
2945 storeAppendPrintf(entry
, "%s %s\n", name
, var
);
2949 parse_string(char **var
)
2951 char *token
= strtok(NULL
, w_space
);
2957 *var
= xstrdup(token
);
2961 ConfigParser::ParseString(char **var
)
2967 ConfigParser::ParseString(String
*var
)
2969 char *token
= strtok(NULL
, w_space
);
2978 free_string(char **var
)
2984 parse_eol(char *volatile *var
)
2986 unsigned char *token
= (unsigned char *) strtok(NULL
, null_string
);
2994 while (*token
&& xisspace(*token
))
3002 *var
= xstrdup((char *) token
);
3005 #define dump_eol dump_string
3006 #define free_eol free_string
3009 dump_time_t(StoreEntry
* entry
, const char *name
, time_t var
)
3011 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int) var
);
3015 parse_time_t(time_t * var
)
3018 parseTimeLine(&tval
, T_SECOND_STR
, false);
3019 *var
= static_cast<time_t>(tval
/1000);
3023 free_time_t(time_t * var
)
3030 dump_time_msec(StoreEntry
* entry
, const char *name
, time_msec_t var
)
3033 storeAppendPrintf(entry
, "%s %"PRId64
" milliseconds\n", name
, var
);
3035 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int)(var
/1000) );
3039 parse_time_msec(time_msec_t
* var
)
3041 parseTimeLine(var
, T_SECOND_STR
, true);
3045 free_time_msec(time_msec_t
* var
)
3053 dump_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3055 storeAppendPrintf(entry
, "%s %d\n", name
, (int) var
);
3060 dump_b_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3062 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3067 dump_b_ssize_t(StoreEntry
* entry
, const char *name
, ssize_t var
)
3069 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3075 dump_kb_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3077 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_KBYTES_STR
);
3082 dump_b_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3084 storeAppendPrintf(entry
, "%s %"PRId64
" %s\n", name
, var
, B_BYTES_STR
);
3088 dump_kb_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3090 storeAppendPrintf(entry
, "%s %"PRId64
" %s\n", name
, var
, B_KBYTES_STR
);
3095 parse_size_t(size_t * var
)
3104 parse_b_size_t(size_t * var
)
3106 parseBytesLine(var
, B_BYTES_STR
);
3111 parse_b_ssize_t(ssize_t
* var
)
3113 parseBytesLineSigned(var
, B_BYTES_STR
);
3119 parse_kb_size_t(size_t * var
)
3121 parseBytesLine(var
, B_KBYTES_STR
);
3126 parse_b_int64_t(int64_t * var
)
3128 parseBytesLine64(var
, B_BYTES_STR
);
3132 parse_kb_int64_t(int64_t * var
)
3134 parseBytesLine64(var
, B_KBYTES_STR
);
3138 free_size_t(size_t * var
)
3145 free_ssize_t(ssize_t
* var
)
3152 free_b_int64_t(int64_t * var
)
3157 #define free_b_size_t free_size_t
3158 #define free_b_ssize_t free_ssize_t
3159 #define free_kb_size_t free_size_t
3160 #define free_mb_size_t free_size_t
3161 #define free_gb_size_t free_size_t
3162 #define free_kb_int64_t free_b_int64_t
3165 dump_u_short(StoreEntry
* entry
, const char *name
, u_short var
)
3167 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
3171 free_u_short(u_short
* u
)
3177 parse_u_short(u_short
* var
)
3179 ConfigParser::ParseUShort(var
);
3183 ConfigParser::ParseUShort(u_short
*var
)
3189 ConfigParser::ParseBool(bool *var
)
3191 int i
= GetInteger();
3202 dump_wordlist(StoreEntry
* entry
, const char *name
, wordlist
* list
)
3204 while (list
!= NULL
) {
3205 storeAppendPrintf(entry
, "%s %s\n", name
, list
->key
);
3211 ConfigParser::ParseWordList(wordlist
** list
)
3213 parse_wordlist(list
);
3217 parse_wordlist(wordlist
** list
)
3220 char *t
= strtok(NULL
, "");
3222 while ((token
= strwordtok(NULL
, &t
)))
3223 wordlistAdd(list
, token
);
3226 #if 0 /* now unused */
3228 check_null_wordlist(wordlist
* w
)
3235 check_null_acl_access(acl_access
* a
)
3240 #define free_wordlist wordlistDestroy
3242 #define free_uri_whitespace free_int
3245 parse_uri_whitespace(int *var
)
3247 char *token
= strtok(NULL
, w_space
);
3252 if (!strcasecmp(token
, "strip"))
3253 *var
= URI_WHITESPACE_STRIP
;
3254 else if (!strcasecmp(token
, "deny"))
3255 *var
= URI_WHITESPACE_DENY
;
3256 else if (!strcasecmp(token
, "allow"))
3257 *var
= URI_WHITESPACE_ALLOW
;
3258 else if (!strcasecmp(token
, "encode"))
3259 *var
= URI_WHITESPACE_ENCODE
;
3260 else if (!strcasecmp(token
, "chop"))
3261 *var
= URI_WHITESPACE_CHOP
;
3267 dump_uri_whitespace(StoreEntry
* entry
, const char *name
, int var
)
3271 if (var
== URI_WHITESPACE_ALLOW
)
3273 else if (var
== URI_WHITESPACE_ENCODE
)
3275 else if (var
== URI_WHITESPACE_CHOP
)
3277 else if (var
== URI_WHITESPACE_DENY
)
3282 storeAppendPrintf(entry
, "%s %s\n", name
, s
);
3286 free_removalpolicy(RemovalPolicySettings
** settings
)
3291 free_string(&(*settings
)->type
);
3293 free_wordlist(&(*settings
)->args
);
3301 parse_removalpolicy(RemovalPolicySettings
** settings
)
3304 free_removalpolicy(settings
);
3306 *settings
= new RemovalPolicySettings
;
3308 parse_string(&(*settings
)->type
);
3310 parse_wordlist(&(*settings
)->args
);
3314 dump_removalpolicy(StoreEntry
* entry
, const char *name
, RemovalPolicySettings
* settings
)
3317 storeAppendPrintf(entry
, "%s %s", name
, settings
->type
);
3318 args
= settings
->args
;
3321 storeAppendPrintf(entry
, " %s", args
->key
);
3325 storeAppendPrintf(entry
, "\n");
3329 free_memcachemode(SquidConfig
* config
)
3335 parse_memcachemode(SquidConfig
* config
)
3337 char *token
= strtok(NULL
, w_space
);
3341 if (strcmp(token
, "always") == 0) {
3342 Config
.onoff
.memory_cache_first
= 1;
3343 Config
.onoff
.memory_cache_disk
= 1;
3344 } else if (strcmp(token
, "disk") == 0) {
3345 Config
.onoff
.memory_cache_first
= 0;
3346 Config
.onoff
.memory_cache_disk
= 1;
3347 } else if (strncmp(token
, "net", 3) == 0) {
3348 Config
.onoff
.memory_cache_first
= 1;
3349 Config
.onoff
.memory_cache_disk
= 0;
3350 } else if (strcmp(token
, "never") == 0) {
3351 Config
.onoff
.memory_cache_first
= 0;
3352 Config
.onoff
.memory_cache_disk
= 0;
3358 dump_memcachemode(StoreEntry
* entry
, const char *name
, SquidConfig
&config
)
3360 storeAppendPrintf(entry
, "%s ", name
);
3361 if (Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3362 storeAppendPrintf(entry
, "always");
3363 else if (!Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3364 storeAppendPrintf(entry
, "disk");
3365 else if (Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3366 storeAppendPrintf(entry
, "network");
3367 else if (!Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3368 storeAppendPrintf(entry
, "none");
3369 storeAppendPrintf(entry
, "\n");
3372 #include "cf_parser.cci"
3375 parseNeighborType(const char *s
)
3377 if (!strcasecmp(s
, "parent"))
3380 if (!strcasecmp(s
, "neighbor"))
3381 return PEER_SIBLING
;
3383 if (!strcasecmp(s
, "neighbour"))
3384 return PEER_SIBLING
;
3386 if (!strcasecmp(s
, "sibling"))
3387 return PEER_SIBLING
;
3389 if (!strcasecmp(s
, "multicast"))
3390 return PEER_MULTICAST
;
3392 debugs(15, 0, "WARNING: Unknown neighbor type: " << s
);
3394 return PEER_SIBLING
;
3399 parse_IpAddress_list(Ip::Address_list
** head
)
3402 Ip::Address_list
*s
;
3405 while ((token
= strtok(NULL
, w_space
))) {
3406 if (GetHostWithPort(token
, &ipa
)) {
3409 head
= &(*head
)->next
;
3411 s
= static_cast<Ip::Address_list
*>(xcalloc(1, sizeof(*s
)));
3421 dump_IpAddress_list(StoreEntry
* e
, const char *n
, const Ip::Address_list
* s
)
3423 char ntoabuf
[MAX_IPSTRLEN
];
3426 storeAppendPrintf(e
, "%s %s\n",
3428 s
->s
.NtoA(ntoabuf
,MAX_IPSTRLEN
));
3434 free_IpAddress_list(Ip::Address_list
** head
)
3436 if (*head
) delete *head
;
3440 #if CURRENTLY_UNUSED
3441 /* This code was previously used by http_port. Left as it really should
3442 * be used by icp_port and htcp_port
3445 check_null_IpAddress_list(const Ip::Address_list
* s
)
3450 #endif /* CURRENTLY_UNUSED */
3451 #endif /* USE_WCCPv2 */
3453 CBDATA_CLASS_INIT(http_port_list
);
3456 parse_http_port_specification(http_port_list
* s
, char *token
)
3459 unsigned short port
= 0;
3463 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3464 s
->name
= xstrdup(token
);
3465 s
->connection_auth_disabled
= false;
3467 if (*token
== '[') {
3470 t
= strchr(host
, ']');
3472 debugs(3, 0, "http(s)_port: missing ']' on IPv6 address: " << token
);
3477 debugs(3, 0, "http(s)_port: missing Port in: " << token
);
3480 if (!Ip::EnableIpv6
) {
3481 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: IPv6 is not available.");
3484 port
= xatos(t
+ 1);
3485 } else if ((t
= strchr(token
, ':'))) {
3490 port
= xatos(t
+ 1);
3492 } else if ((port
= strtol(token
, &junk
, 10)), !*junk
) {
3494 debugs(3, 3, "http(s)_port: found Listen on Port: " << port
);
3496 debugs(3, 0, "http(s)_port: missing Port: " << token
);
3501 debugs(3, 0, "http(s)_port: Port cannot be 0: " << token
);
3508 if (!Ip::EnableIpv6
)
3510 debugs(3, 3, "http(s)_port: found Listen on wildcard address: *:" << s
->s
.GetPort() );
3511 } else if ( s
->s
= host
) { /* check/parse numeric IPA */
3513 if (!Ip::EnableIpv6
)
3515 debugs(3, 3, "http(s)_port: Listen on Host/IP: " << host
<< " --> " << s
->s
);
3516 } else if ( s
->s
.GetHostByName(host
) ) { /* check/parse for FQDN */
3517 /* dont use ipcache */
3518 s
->defaultsite
= xstrdup(host
);
3520 if (!Ip::EnableIpv6
)
3522 debugs(3, 3, "http(s)_port: found Listen as Host " << s
->defaultsite
<< " on IP: " << s
->s
);
3524 debugs(3, 0, "http(s)_port: failed to resolve Host/IP: " << host
);
3530 parse_http_port_option(http_port_list
* s
, char *token
)
3534 if (strcmp(token
, "accel") == 0) {
3535 if (s
->intercepted
|| s
->spoof_client_ip
) {
3536 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: Accelerator mode requires its own port. It cannot be shared with other modes.");
3540 } else if (strcmp(token
, "transparent") == 0 || strcmp(token
, "intercept") == 0) {
3541 if (s
->accel
|| s
->spoof_client_ip
) {
3542 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: Intercept mode requires its own interception port. It cannot be shared with other modes.");
3546 Ip::Interceptor
.StartInterception();
3547 /* Log information regarding the port modes under interception. */
3548 debugs(3, DBG_IMPORTANT
, "Starting Authentication on port " << s
->s
);
3549 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (interception enabled)");
3551 /* INET6: until transparent REDIRECT works on IPv6 SOCKET, force wildcard to IPv4 */
3553 debugs(3, DBG_IMPORTANT
, "Disabling IPv6 on port " << s
->s
<< " (interception enabled)");
3554 if ( !s
->s
.SetIPv4() ) {
3555 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: IPv6 addresses cannot NAT intercept (protocol does not provide NAT)" << s
->s
);
3558 } else if (strcmp(token
, "tproxy") == 0) {
3559 if (s
->intercepted
|| s
->accel
) {
3560 debugs(3,DBG_CRITICAL
, "FATAL: http(s)_port: TPROXY option requires its own interception port. It cannot be shared with other modes.");
3563 s
->spoof_client_ip
= 1;
3564 Ip::Interceptor
.StartTransparency();
3565 /* Log information regarding the port modes under transparency. */
3566 debugs(3, DBG_IMPORTANT
, "Starting IP Spoofing on port " << s
->s
);
3567 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (IP spoofing enabled)");
3569 if (!Ip::Interceptor
.ProbeForTproxy(s
->s
)) {
3570 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: TPROXY support in the system does not work.");
3574 } else if (strncmp(token
, "defaultsite=", 12) == 0) {
3576 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: defaultsite option requires Acceleration mode flag.");
3579 safe_free(s
->defaultsite
);
3580 s
->defaultsite
= xstrdup(token
+ 12);
3581 } else if (strcmp(token
, "vhost") == 0) {
3583 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: vhost option requires Acceleration mode flag.");
3587 } else if (strcmp(token
, "vport") == 0) {
3589 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: vport option requires Acceleration mode flag.");
3593 } else if (strncmp(token
, "vport=", 6) == 0) {
3595 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: vport option requires Acceleration mode flag.");
3598 s
->vport
= xatos(token
+ 6);
3599 } else if (strncmp(token
, "protocol=", 9) == 0) {
3601 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: protocol option requires Acceleration mode flag.");
3604 s
->protocol
= xstrdup(token
+ 9);
3605 } else if (strcmp(token
, "allow-direct") == 0) {
3607 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: vport option requires Acceleration mode flag.");
3610 s
->allow_direct
= 1;
3611 } else if (strcmp(token
, "ignore-cc") == 0) {
3612 #if !USE_HTTP_VIOLATIONS
3614 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: ignore-cc option requires Scceleration mode flag.");
3619 } else if (strncmp(token
, "name=", 5) == 0) {
3621 s
->name
= xstrdup(token
+ 5);
3622 } else if (strcmp(token
, "no-connection-auth") == 0) {
3623 s
->connection_auth_disabled
= true;
3624 } else if (strcmp(token
, "connection-auth=off") == 0) {
3625 s
->connection_auth_disabled
= true;
3626 } else if (strcmp(token
, "connection-auth") == 0) {
3627 s
->connection_auth_disabled
= false;
3628 } else if (strcmp(token
, "connection-auth=on") == 0) {
3629 s
->connection_auth_disabled
= false;
3630 } else if (strncmp(token
, "disable-pmtu-discovery=", 23) == 0) {
3631 if (!strcasecmp(token
+ 23, "off"))
3632 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3633 else if (!strcasecmp(token
+ 23, "transparent"))
3634 s
->disable_pmtu_discovery
= DISABLE_PMTU_TRANSPARENT
;
3635 else if (!strcasecmp(token
+ 23, "always"))
3636 s
->disable_pmtu_discovery
= DISABLE_PMTU_ALWAYS
;
3639 } else if (strcmp(token
, "ipv4") == 0) {
3640 if ( !s
->s
.SetIPv4() ) {
3641 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: IPv6 addresses cannot be used as IPv4-Only. " << s
->s
);
3644 } else if (strcmp(token
, "tcpkeepalive") == 0) {
3645 s
->tcp_keepalive
.enabled
= 1;
3646 } else if (strncmp(token
, "tcpkeepalive=", 13) == 0) {
3647 char *t
= token
+ 13;
3648 s
->tcp_keepalive
.enabled
= 1;
3649 s
->tcp_keepalive
.idle
= atoi(t
);
3653 s
->tcp_keepalive
.interval
= atoi(t
);
3658 s
->tcp_keepalive
.timeout
= atoi(t
);
3662 } else if (strcasecmp(token
, "sslBump") == 0) {
3663 debugs(3, DBG_CRITICAL
, "WARNING: '" << token
<< "' is deprecated " <<
3664 "in http_port. Use 'ssl-bump' instead.");
3665 s
->sslBump
= 1; // accelerated when bumped, otherwise not
3666 } else if (strcmp(token
, "ssl-bump") == 0) {
3667 s
->sslBump
= 1; // accelerated when bumped, otherwise not
3668 } else if (strncmp(token
, "cert=", 5) == 0) {
3670 s
->cert
= xstrdup(token
+ 5);
3671 } else if (strncmp(token
, "key=", 4) == 0) {
3673 s
->key
= xstrdup(token
+ 4);
3674 } else if (strncmp(token
, "version=", 8) == 0) {
3675 s
->version
= xatoi(token
+ 8);
3676 if (s
->version
< 1 || s
->version
> 4)
3678 } else if (strncmp(token
, "options=", 8) == 0) {
3679 safe_free(s
->options
);
3680 s
->options
= xstrdup(token
+ 8);
3681 } else if (strncmp(token
, "cipher=", 7) == 0) {
3682 safe_free(s
->cipher
);
3683 s
->cipher
= xstrdup(token
+ 7);
3684 } else if (strncmp(token
, "clientca=", 9) == 0) {
3685 safe_free(s
->clientca
);
3686 s
->clientca
= xstrdup(token
+ 9);
3687 } else if (strncmp(token
, "cafile=", 7) == 0) {
3688 safe_free(s
->cafile
);
3689 s
->cafile
= xstrdup(token
+ 7);
3690 } else if (strncmp(token
, "capath=", 7) == 0) {
3691 safe_free(s
->capath
);
3692 s
->capath
= xstrdup(token
+ 7);
3693 } else if (strncmp(token
, "crlfile=", 8) == 0) {
3694 safe_free(s
->crlfile
);
3695 s
->crlfile
= xstrdup(token
+ 8);
3696 } else if (strncmp(token
, "dhparams=", 9) == 0) {
3697 safe_free(s
->dhfile
);
3698 s
->dhfile
= xstrdup(token
+ 9);
3699 } else if (strncmp(token
, "sslflags=", 9) == 0) {
3700 safe_free(s
->sslflags
);
3701 s
->sslflags
= xstrdup(token
+ 9);
3702 } else if (strncmp(token
, "sslcontext=", 11) == 0) {
3703 safe_free(s
->sslContextSessionId
);
3704 s
->sslContextSessionId
= xstrdup(token
+ 11);
3705 } else if (strcmp(token
, "generate-host-certificates") == 0) {
3706 s
->generateHostCertificates
= true;
3707 } else if (strcmp(token
, "generate-host-certificates=on") == 0) {
3708 s
->generateHostCertificates
= true;
3709 } else if (strcmp(token
, "generate-host-certificates=off") == 0) {
3710 s
->generateHostCertificates
= false;
3711 } else if (strncmp(token
, "dynamic_cert_mem_cache_size=", 28) == 0) {
3712 parseBytesOptionValue(&s
->dynamicCertMemCacheSize
, B_BYTES_STR
, token
+ 28);
3719 static http_port_list
*
3720 create_http_port(char *portspec
)
3722 http_port_list
*s
= new http_port_list("http");
3723 parse_http_port_specification(s
, portspec
);
3728 add_http_port(char *portspec
)
3730 http_port_list
*s
= create_http_port(portspec
);
3731 // we may need to merge better of the above returns a list with clones
3732 assert(s
->next
== NULL
);
3733 s
->next
= Config
.Sockaddr
.http
;
3734 Config
.Sockaddr
.http
= s
;
3738 clone_http_port_list(http_port_list
*a
)
3740 http_port_list
*b
= new http_port_list(a
->protocol
);
3744 b
->name
= xstrdup(a
->name
);
3746 b
->defaultsite
= xstrdup(a
->defaultsite
);
3748 b
->intercepted
= a
->intercepted
;
3749 b
->spoof_client_ip
= a
->spoof_client_ip
;
3750 b
->accel
= a
->accel
;
3751 b
->allow_direct
= a
->allow_direct
;
3752 b
->vhost
= a
->vhost
;
3753 b
->sslBump
= a
->sslBump
;
3754 b
->vport
= a
->vport
;
3755 b
->connection_auth_disabled
= a
->connection_auth_disabled
;
3756 b
->disable_pmtu_discovery
= a
->disable_pmtu_discovery
;
3758 memcpy( &(b
->tcp_keepalive
), &(a
->tcp_keepalive
), sizeof(a
->tcp_keepalive
));
3761 // AYJ: 2009-07-18: for now SSL does not clone. Configure separate ports with IPs and SSL settings
3764 // XXX: temporary hack to ease move of SSL options to http_port
3765 http_port_list
&http
;
3778 char *sslContextSessionId
;
3779 SSL_CTX
*sslContext
;
3788 parse_http_port_list(http_port_list
** head
)
3790 char *token
= strtok(NULL
, w_space
);
3797 http_port_list
*s
= create_http_port(token
);
3799 /* parse options ... */
3800 while ((token
= strtok(NULL
, w_space
))) {
3801 parse_http_port_option(s
, token
);
3804 if (Ip::EnableIpv6
&IPV6_SPECIAL_SPLITSTACK
&& s
->s
.IsAnyAddr()) {
3805 // clone the port options from *s to *(s->next)
3806 s
->next
= clone_http_port_list(s
);
3807 s
->next
->s
.SetIPv4();
3808 debugs(3, 3, "http(s)_port: clone wildcard address for split-stack: " << s
->s
<< " and " << s
->next
->s
);
3812 head
= &(*head
)->next
;
3818 dump_generic_http_port(StoreEntry
* e
, const char *n
, const http_port_list
* s
)
3820 char buf
[MAX_IPSTRLEN
];
3822 storeAppendPrintf(e
, "%s %s",
3824 s
->s
.ToURL(buf
,MAX_IPSTRLEN
));
3826 // MODES and specific sub-options.
3828 storeAppendPrintf(e
, " intercept");
3830 else if (s
->spoof_client_ip
)
3831 storeAppendPrintf(e
, " tproxy");
3833 else if (s
->accel
) {
3834 storeAppendPrintf(e
, " accel");
3837 storeAppendPrintf(e
, " vhost");
3840 storeAppendPrintf(e
, " vport");
3841 else if (s
->vport
> 0)
3842 storeAppendPrintf(e
, " vport=%d", s
->vport
);
3845 storeAppendPrintf(e
, " defaultsite=%s", s
->defaultsite
);
3847 if (s
->protocol
&& strcmp(s
->protocol
,"http") != 0)
3848 storeAppendPrintf(e
, " protocol=%s", s
->protocol
);
3850 if (s
->allow_direct
)
3851 storeAppendPrintf(e
, " allow-direct");
3854 storeAppendPrintf(e
, " ignore-cc");
3858 // Generic independent options
3861 storeAppendPrintf(e
, " name=%s", s
->name
);
3863 #if USE_HTTP_VIOLATIONS
3864 if (!s
->accel
&& s
->ignore_cc
)
3865 storeAppendPrintf(e
, " ignore-cc");
3868 if (s
->connection_auth_disabled
)
3869 storeAppendPrintf(e
, " connection-auth=off");
3871 storeAppendPrintf(e
, " connection-auth=on");
3873 if (s
->disable_pmtu_discovery
!= DISABLE_PMTU_OFF
) {
3876 if (s
->disable_pmtu_discovery
== DISABLE_PMTU_ALWAYS
)
3879 pmtu
= "transparent";
3881 storeAppendPrintf(e
, " disable-pmtu-discovery=%s", pmtu
);
3884 if (s
->s
.IsAnyAddr() && !s
->s
.IsIPv6())
3885 storeAppendPrintf(e
, " ipv4");
3887 if (s
->tcp_keepalive
.enabled
) {
3888 if (s
->tcp_keepalive
.idle
|| s
->tcp_keepalive
.interval
|| s
->tcp_keepalive
.timeout
) {
3889 storeAppendPrintf(e
, " tcpkeepalive=%d,%d,%d", s
->tcp_keepalive
.idle
, s
->tcp_keepalive
.interval
, s
->tcp_keepalive
.timeout
);
3891 storeAppendPrintf(e
, " tcpkeepalive");
3897 storeAppendPrintf(e
, " ssl-bump");
3900 storeAppendPrintf(e
, " cert=%s", s
->cert
);
3903 storeAppendPrintf(e
, " key=%s", s
->key
);
3906 storeAppendPrintf(e
, " version=%d", s
->version
);
3909 storeAppendPrintf(e
, " options=%s", s
->options
);
3912 storeAppendPrintf(e
, " cipher=%s", s
->cipher
);
3915 storeAppendPrintf(e
, " cafile=%s", s
->cafile
);
3918 storeAppendPrintf(e
, " capath=%s", s
->capath
);
3921 storeAppendPrintf(e
, " crlfile=%s", s
->crlfile
);
3924 storeAppendPrintf(e
, " dhparams=%s", s
->dhfile
);
3927 storeAppendPrintf(e
, " sslflags=%s", s
->sslflags
);
3929 if (s
->sslContextSessionId
)
3930 storeAppendPrintf(e
, " sslcontext=%s", s
->sslContextSessionId
);
3932 if (s
->generateHostCertificates
)
3933 storeAppendPrintf(e
, " generate-host-certificates");
3935 if (s
->dynamicCertMemCacheSize
!= std::numeric_limits
<size_t>::max())
3936 storeAppendPrintf(e
, "dynamic_cert_mem_cache_size=%lu%s\n", (unsigned long)s
->dynamicCertMemCacheSize
, B_BYTES_STR
);
3941 dump_http_port_list(StoreEntry
* e
, const char *n
, const http_port_list
* s
)
3944 dump_generic_http_port(e
, n
, s
);
3945 storeAppendPrintf(e
, "\n");
3951 free_http_port_list(http_port_list
** head
)
3955 while ((s
= *head
) != NULL
) {
3963 // TODO: merge better with parse_http_port_list
3965 parse_https_port_list(https_port_list
** head
)
3970 token
= strtok(NULL
, w_space
);
3975 s
= new https_port_list
;
3976 parse_http_port_specification(&s
->http
, token
);
3978 /* parse options ... */
3979 while ((token
= strtok(NULL
, w_space
))) {
3980 parse_http_port_option(s
, token
);
3984 http_port_list
** headTmp
= &(*head
)->http
.next
;
3985 head
= (https_port_list
**)headTmp
;
3992 dump_https_port_list(StoreEntry
* e
, const char *n
, const https_port_list
* s
)
3994 dump_http_port_list(e
, n
, s
);
3998 free_https_port_list(https_port_list
** head
)
4000 free_http_port_list((http_port_list
**)head
);
4005 check_null_https_port_list(const https_port_list
* s
)
4012 #endif /* USE_SSL */
4015 configFreeMemory(void)
4019 SSL_CTX_free(Config
.ssl_client
.sslContext
);
4024 requirePathnameExists(const char *name
, const char *path
)
4028 char pathbuf
[BUFSIZ
];
4029 assert(path
!= NULL
);
4031 if (Config
.chroot_dir
&& (geteuid() == 0)) {
4032 snprintf(pathbuf
, BUFSIZ
, "%s/%s", Config
.chroot_dir
, path
);
4036 if (stat(path
, &sb
) < 0) {
4037 debugs(0, DBG_CRITICAL
, (opt_parse_cfg_only
?"FATAL ":"") << "ERROR: " << name
<< " " << path
<< ": " << xstrerror());
4038 // keep going to find more issues if we are only checking the config file with "-k parse"
4039 if (opt_parse_cfg_only
)
4041 // this is fatal if it is found during startup or reconfigure
4042 if (opt_send_signal
== -1 || opt_send_signal
== SIGHUP
)
4043 fatalf("%s %s: %s", name
, path
, xstrerror());
4050 return ConfigParser::strtokFile();
4053 #include "AccessLogEntry.h"
4056 parse_access_log(customlog
** logs
)
4058 const char *filename
, *logdef_name
;
4062 cl
= (customlog
*)xcalloc(1, sizeof(*cl
));
4064 if ((filename
= strtok(NULL
, w_space
)) == NULL
) {
4069 if (strcmp(filename
, "none") == 0) {
4070 cl
->type
= Log::Format::CLF_NONE
;
4074 if ((logdef_name
= strtok(NULL
, w_space
)) == NULL
)
4075 logdef_name
= "squid";
4077 debugs(3, 9, "Log definition name '" << logdef_name
<< "' file '" << filename
<< "'");
4079 cl
->filename
= xstrdup(filename
);
4081 /* look for the definition pointer corresponding to this name */
4082 lf
= Log::TheConfig
.logformats
;
4084 while (lf
!= NULL
) {
4085 debugs(3, 9, "Comparing against '" << lf
->name
<< "'");
4087 if (strcmp(lf
->name
, logdef_name
) == 0)
4094 cl
->type
= Log::Format::CLF_CUSTOM
;
4096 } else if (strcmp(logdef_name
, "auto") == 0) {
4097 debugs(0,0, "WARNING: Log format 'auto' no longer exists. Using 'squid' instead.");
4098 cl
->type
= Log::Format::CLF_SQUID
;
4099 } else if (strcmp(logdef_name
, "squid") == 0) {
4100 cl
->type
= Log::Format::CLF_SQUID
;
4101 } else if (strcmp(logdef_name
, "common") == 0) {
4102 cl
->type
= Log::Format::CLF_COMMON
;
4103 } else if (strcmp(logdef_name
, "combined") == 0) {
4104 cl
->type
= Log::Format::CLF_COMBINED
;
4106 } else if (strcmp(logdef_name
, "icap_squid") == 0) {
4107 cl
->type
= Log::Format::CLF_ICAP_SQUID
;
4109 } else if (strcmp(logdef_name
, "useragent") == 0) {
4110 cl
->type
= Log::Format::CLF_USERAGENT
;
4111 } else if (strcmp(logdef_name
, "referrer") == 0) {
4112 cl
->type
= Log::Format::CLF_REFERER
;
4114 debugs(3, 0, "Log format '" << logdef_name
<< "' is not defined");
4120 aclParseAclList(LegacyParser
, &cl
->aclList
);
4123 logs
= &(*logs
)->next
;
4129 check_null_access_log(customlog
*customlog_definitions
)
4131 return customlog_definitions
== NULL
;
4135 dump_access_log(StoreEntry
* entry
, const char *name
, customlog
* logs
)
4139 for (log
= logs
; log
; log
= log
->next
) {
4140 storeAppendPrintf(entry
, "%s ", name
);
4142 switch (log
->type
) {
4144 case Log::Format::CLF_CUSTOM
:
4145 storeAppendPrintf(entry
, "%s %s", log
->filename
, log
->logFormat
->name
);
4148 case Log::Format::CLF_NONE
:
4149 storeAppendPrintf(entry
, "none");
4152 case Log::Format::CLF_SQUID
:
4153 storeAppendPrintf(entry
, "%s squid", log
->filename
);
4156 case Log::Format::CLF_COMBINED
:
4157 storeAppendPrintf(entry
, "%s combined", log
->filename
);
4160 case Log::Format::CLF_COMMON
:
4161 storeAppendPrintf(entry
, "%s common", log
->filename
);
4165 case Log::Format::CLF_ICAP_SQUID
:
4166 storeAppendPrintf(entry
, "%s icap_squid", log
->filename
);
4169 case Log::Format::CLF_USERAGENT
:
4170 storeAppendPrintf(entry
, "%s useragent", log
->filename
);
4173 case Log::Format::CLF_REFERER
:
4174 storeAppendPrintf(entry
, "%s referrer", log
->filename
);
4177 case Log::Format::CLF_UNKNOWN
:
4182 dump_acl_list(entry
, log
->aclList
);
4184 storeAppendPrintf(entry
, "\n");
4189 free_access_log(customlog
** definitions
)
4191 while (*definitions
) {
4192 customlog
*log
= *definitions
;
4193 *definitions
= log
->next
;
4195 log
->logFormat
= NULL
;
4196 log
->type
= Log::Format::CLF_UNKNOWN
;
4199 aclDestroyAclList(&log
->aclList
);
4201 safe_free(log
->filename
);
4207 /// parses list of integers form name=N1,N2,N3,...
4209 parseNamedIntList(const char *data
, const String
&name
, Vector
<int> &list
)
4211 if (data
&& (strncmp(data
, name
.rawBuf(), name
.size()) == 0)) {
4212 data
+= name
.size();
4217 if (!StringToInt(data
, value
, &data
, 10))
4219 list
.push_back(value
);
4220 if (*data
== '\0' || *data
!= ',')
4225 return data
&& *data
== '\0';
4229 parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4231 #if !HAVE_CPU_AFFINITY
4232 debugs(3, DBG_CRITICAL
, "FATAL: Squid built with no CPU affinity " <<
4233 "support, do not set 'cpu_affinity_map'");
4235 #endif /* HAVE_CPU_AFFINITY */
4237 if (!*cpuAffinityMap
)
4238 *cpuAffinityMap
= new CpuAffinityMap
;
4240 const char *const pToken
= strtok(NULL
, w_space
);
4241 const char *const cToken
= strtok(NULL
, w_space
);
4242 Vector
<int> processes
, cores
;
4243 if (!parseNamedIntList(pToken
, "process_numbers", processes
)) {
4244 debugs(3, DBG_CRITICAL
, "FATAL: bad 'process_numbers' parameter " <<
4245 "in 'cpu_affinity_map'");
4247 } else if (!parseNamedIntList(cToken
, "cores", cores
)) {
4248 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cores' parameter in " <<
4249 "'cpu_affinity_map'");
4251 } else if (!(*cpuAffinityMap
)->add(processes
, cores
)) {
4252 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cpu_affinity_map'; " <<
4253 "process_numbers and cores lists differ in length or " <<
4254 "contain numbers <= 0");
4260 dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
)
4262 if (cpuAffinityMap
) {
4263 storeAppendPrintf(entry
, "%s process_numbers=", name
);
4264 for (size_t i
= 0; i
< cpuAffinityMap
->processes().size(); ++i
) {
4265 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4266 cpuAffinityMap
->processes()[i
]);
4268 storeAppendPrintf(entry
, " cores=");
4269 for (size_t i
= 0; i
< cpuAffinityMap
->processes().size(); ++i
) {
4270 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4271 cpuAffinityMap
->cores()[i
]);
4273 storeAppendPrintf(entry
, "\n");
4278 free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4280 delete *cpuAffinityMap
;
4281 *cpuAffinityMap
= NULL
;
4287 parse_adaptation_service_set_type()
4289 Adaptation::Config::ParseServiceSet();
4293 parse_adaptation_service_chain_type()
4295 Adaptation::Config::ParseServiceChain();
4299 parse_adaptation_access_type()
4301 Adaptation::Config::ParseAccess(LegacyParser
);
4304 #endif /* USE_ADAPTATION */
4310 parse_icap_service_type(Adaptation::Icap::Config
* cfg
)
4312 cfg
->parseService();
4316 free_icap_service_type(Adaptation::Icap::Config
* cfg
)
4322 dump_icap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4324 cfg
.dumpService(entry
, name
);
4328 parse_icap_class_type()
4330 debugs(93, 0, "WARNING: 'icap_class' is depricated. " <<
4331 "Use 'adaptation_service_set' instead");
4332 Adaptation::Config::ParseServiceSet();
4336 parse_icap_access_type()
4338 debugs(93, 0, "WARNING: 'icap_access' is depricated. " <<
4339 "Use 'adaptation_access' instead");
4340 Adaptation::Config::ParseAccess(LegacyParser
);
4349 parse_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4351 cfg
->parseService();
4355 free_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4361 dump_ecap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Ecap::Config
&cfg
)
4363 cfg
.dumpService(entry
, name
);
4366 #endif /* USE_ECAP */
4369 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4374 cfg
->service_failure_limit
= GetInteger();
4376 if ((token
= strtok(NULL
, w_space
)) == NULL
)
4379 if (strcmp(token
,"in") != 0) {
4380 debugs(3, 0, "expecting 'in' on'" << config_input_line
<< "'");
4384 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
4388 d
= static_cast<time_t> (xatoi(token
));
4390 m
= static_cast<time_t> (1);
4394 else if ((token
= strtok(NULL
, w_space
)) == NULL
) {
4395 debugs(3, 0, "No time-units on '" << config_input_line
<< "'");
4397 } else if ((m
= parseTimeUnits(token
, false)) == 0)
4400 cfg
->oldest_service_failure
= (m
* d
);
4403 static void dump_icap_service_failure_limit(StoreEntry
*entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4405 storeAppendPrintf(entry
, "%s %d", name
, cfg
.service_failure_limit
);
4406 if (cfg
.oldest_service_failure
> 0) {
4407 storeAppendPrintf(entry
, " in %d seconds", (int)cfg
.oldest_service_failure
);
4409 storeAppendPrintf(entry
, "\n");
4412 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4414 cfg
->oldest_service_failure
= 0;
4415 cfg
->service_failure_limit
= 0;