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, (opt_parse_cfg_only
?1: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
.retry
.maxtries
> 10)
687 fatal("maximum_single_addr_tries cannot be larger than 10");
689 if (Config
.retry
.maxtries
< 1) {
690 debugs(3, 0, "WARNING: resetting 'maximum_single_addr_tries to 1");
691 Config
.retry
.maxtries
= 1;
694 requirePathnameExists("MIME Config Table", Config
.mimeTablePathname
);
697 requirePathnameExists("cache_dns_program", Config
.Program
.dnsserver
);
701 requirePathnameExists("unlinkd_program", Config
.Program
.unlinkd
);
703 requirePathnameExists("logfile_daemon", Log::TheConfig
.logfile_daemon
);
704 if (Config
.Program
.redirect
)
705 requirePathnameExists("redirect_program", Config
.Program
.redirect
->key
);
707 requirePathnameExists("Icon Directory", Config
.icons
.directory
);
709 if (Config
.errorDirectory
)
710 requirePathnameExists("Error Directory", Config
.errorDirectory
);
712 #if USE_HTTP_VIOLATIONS
717 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
718 if (!R
->flags
.override_expire
)
721 debugs(22, 1, "WARNING: use of 'override-expire' in 'refresh_pattern' violates HTTP");
726 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
727 if (!R
->flags
.override_lastmod
)
730 debugs(22, 1, "WARNING: use of 'override-lastmod' in 'refresh_pattern' violates HTTP");
735 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
736 if (!R
->flags
.reload_into_ims
)
739 debugs(22, 1, "WARNING: use of 'reload-into-ims' in 'refresh_pattern' violates HTTP");
744 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
745 if (!R
->flags
.ignore_reload
)
748 debugs(22, 1, "WARNING: use of 'ignore-reload' in 'refresh_pattern' violates HTTP");
753 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
754 if (!R
->flags
.ignore_no_cache
)
757 debugs(22, 1, "WARNING: use of 'ignore-no-cache' in 'refresh_pattern' violates HTTP");
762 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
763 if (!R
->flags
.ignore_no_store
)
766 debugs(22, 1, "WARNING: use of 'ignore-no-store' in 'refresh_pattern' violates HTTP");
771 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
772 if (!R
->flags
.ignore_must_revalidate
)
774 debugs(22, 1, "WARNING: use of 'ignore-must-revalidate' in 'refresh_pattern' violates HTTP");
778 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
779 if (!R
->flags
.ignore_private
)
782 debugs(22, 1, "WARNING: use of 'ignore-private' in 'refresh_pattern' violates HTTP");
787 for (R
= Config
.Refresh
; R
; R
= R
->next
) {
788 if (!R
->flags
.ignore_auth
)
791 debugs(22, 1, "WARNING: use of 'ignore-auth' in 'refresh_pattern' violates HTTP");
798 #if !USE_HTTP_VIOLATIONS
799 Config
.onoff
.via
= 1;
802 if (!Config
.onoff
.via
)
803 debugs(22, 1, "WARNING: HTTP requires the use of Via");
807 // we enable runtime PURGE checks if there is at least one PURGE method ACL
808 // TODO: replace with a dedicated "purge" ACL option?
809 Config2
.onoff
.enable_purge
= (ACLMethodData::ThePurgeCount
> 0);
811 Config2
.onoff
.mangle_request_headers
= httpReqHdrManglersConfigured();
813 if (geteuid() == 0) {
814 if (NULL
!= Config
.effectiveUser
) {
816 struct passwd
*pwd
= getpwnam(Config
.effectiveUser
);
820 * Andres Kroonmaa <andre@online.ee>:
821 * Some getpwnam() implementations (Solaris?) require
822 * an available FD < 256 for opening a FILE* to the
825 * This should be safe at startup, but might still fail
826 * during reconfigure.
828 fatalf("getpwnam failed to find userid for effective user '%s'",
829 Config
.effectiveUser
);
833 Config2
.effectiveUserID
= pwd
->pw_uid
;
835 Config2
.effectiveGroupID
= pwd
->pw_gid
;
839 if (pwd
->pw_dir
&& *pwd
->pw_dir
) {
841 char *env_str
= (char *)xcalloc((len
= strlen(pwd
->pw_dir
) + 6), 1);
842 snprintf(env_str
, len
, "HOME=%s", pwd
->pw_dir
);
850 Config2
.effectiveUserID
= geteuid();
851 Config2
.effectiveGroupID
= getegid();
854 if (NULL
!= Config
.effectiveGroup
) {
856 struct group
*grp
= getgrnam(Config
.effectiveGroup
);
859 fatalf("getgrnam failed to find groupid for effective group '%s'",
860 Config
.effectiveGroup
);
864 Config2
.effectiveGroupID
= grp
->gr_gid
;
867 HttpRequestMethod::Configure(Config
);
870 debugs(3, 1, "Initializing https proxy context");
872 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
);
878 for (p
= Config
.peers
; p
!= NULL
; p
= p
->next
) {
880 debugs(3, 1, "Initializing cache_peer " << p
->name
<< " SSL context");
881 p
->sslContext
= sslCreateClientContext(p
->sslcert
, p
->sslkey
, p
->sslversion
, p
->sslcipher
, p
->ssloptions
, p
->sslflags
, p
->sslcafile
, p
->sslcapath
, p
->sslcrlfile
);
890 for (s
= Config
.Sockaddr
.http
; s
!= NULL
; s
= (http_port_list
*) s
->next
) {
891 if (!s
->cert
&& !s
->key
)
894 debugs(3, 1, "Initializing http_port " << s
->http
.s
<< " SSL context");
896 s
->staticSslContext
.reset(
897 sslCreateServerContext(s
->cert
, s
->key
,
898 s
->version
, s
->cipher
, s
->options
, s
->sslflags
, s
->clientca
,
899 s
->cafile
, s
->capath
, s
->crlfile
, s
->dhfile
,
900 s
->sslContextSessionId
));
902 Ssl::readCertAndPrivateKeyFromFiles(s
->signingCert
, s
->signPkey
, s
->cert
, s
->key
);
910 for (s
= Config
.Sockaddr
.https
; s
!= NULL
; s
= (https_port_list
*) s
->http
.next
) {
911 debugs(3, 1, "Initializing https_port " << s
->http
.s
<< " SSL context");
913 s
->staticSslContext
.reset(
914 sslCreateServerContext(s
->cert
, s
->key
,
915 s
->version
, s
->cipher
, s
->options
, s
->sslflags
, s
->clientca
,
916 s
->cafile
, s
->capath
, s
->crlfile
, s
->dhfile
,
917 s
->sslContextSessionId
));
923 // prevent infinite fetch loops in the request parser
924 // due to buffer full but not enough data recived to finish parse
925 if (Config
.maxRequestBufferSize
<= Config
.maxRequestHeaderSize
) {
926 fatalf("Client request buffer of %u bytes cannot hold a request with %u bytes of headers." \
927 " Change client_request_buffer_max or request_header_max_size limits.",
928 (uint32_t)Config
.maxRequestBufferSize
, (uint32_t)Config
.maxRequestHeaderSize
);
933 * disable client side request pipelining. There is a race with
934 * Negotiate and NTLM when the client sends a second request on an
935 * connection before the authenticate challenge is sent. With
936 * pipelining OFF, the client may fail to authenticate, but squid's
937 * state will be preserved.
939 if (Config
.onoff
.pipeline_prefetch
) {
940 Auth::Config
*nego
= Auth::Config::Find("Negotiate");
941 Auth::Config
*ntlm
= Auth::Config::Find("NTLM");
942 if ((nego
&& nego
->active()) || (ntlm
&& ntlm
->active())) {
943 debugs(3, DBG_IMPORTANT
, "WARNING: pipeline_prefetch breaks NTLM and Negotiate authentication. Forced OFF.");
944 Config
.onoff
.pipeline_prefetch
= 0;
950 /** Parse a line containing an obsolete directive.
951 * To upgrade it where possible instead of just "Bungled config" for
952 * directives which cannot be marked as simply aliases of the some name.
953 * For example if the parameter order and content has changed.
954 * Or if the directive has been completely removed.
957 parse_obsolete(const char *name
)
959 // Directives which have been radically changed rather than removed
960 if (!strcmp(name
, "url_rewrite_concurrency")) {
963 debugs(3, DBG_CRITICAL
, "WARNING: url_rewrite_concurrency upgrade overriding url_rewrite_children settings.");
964 Config
.redirectChildren
.concurrency
= cval
;
968 /* Parse a time specification from the config file. Store the
969 * result in 'tptr', after converting it to 'units' */
971 parseTimeLine(time_msec_t
* tptr
, const char *units
, bool allowMsec
)
978 if ((u
= parseTimeUnits(units
, allowMsec
)) == 0)
981 if ((token
= strtok(NULL
, w_space
)) == NULL
)
986 m
= u
; /* default to 'units' if none specified */
990 else if ((token
= strtok(NULL
, w_space
)) == NULL
)
991 debugs(3, 0, "WARNING: No units on '" <<
992 config_input_line
<< "', assuming " <<
994 else if ((m
= parseTimeUnits(token
, allowMsec
)) == 0)
997 *tptr
= static_cast<time_msec_t
>(m
* d
);
1001 parseTimeUnits(const char *unit
, bool allowMsec
)
1003 if (allowMsec
&& !strncasecmp(unit
, T_MILLISECOND_STR
, strlen(T_MILLISECOND_STR
)))
1006 if (!strncasecmp(unit
, T_SECOND_STR
, strlen(T_SECOND_STR
)))
1009 if (!strncasecmp(unit
, T_MINUTE_STR
, strlen(T_MINUTE_STR
)))
1012 if (!strncasecmp(unit
, T_HOUR_STR
, strlen(T_HOUR_STR
)))
1015 if (!strncasecmp(unit
, T_DAY_STR
, strlen(T_DAY_STR
)))
1016 return 86400 * 1000;
1018 if (!strncasecmp(unit
, T_WEEK_STR
, strlen(T_WEEK_STR
)))
1019 return 86400 * 7 * 1000;
1021 if (!strncasecmp(unit
, T_FORTNIGHT_STR
, strlen(T_FORTNIGHT_STR
)))
1022 return 86400 * 14 * 1000;
1024 if (!strncasecmp(unit
, T_MONTH_STR
, strlen(T_MONTH_STR
)))
1025 return static_cast<uint64_t>(86400) * 30 * 1000;
1027 if (!strncasecmp(unit
, T_YEAR_STR
, strlen(T_YEAR_STR
)))
1028 return static_cast<uint64_t>(86400 * 1000 * 365.2522);
1030 if (!strncasecmp(unit
, T_DECADE_STR
, strlen(T_DECADE_STR
)))
1031 return static_cast<uint64_t>(86400 * 1000 * 365.2522 * 10);
1033 debugs(3, 1, "parseTimeUnits: unknown time unit '" << unit
<< "'");
1039 parseBytesLine64(int64_t * bptr
, const char *units
)
1046 if ((u
= parseBytesUnits(units
)) == 0) {
1051 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
1056 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1063 m
= u
; /* default to 'units' if none specified */
1067 else if ((token
= strtok(NULL
, w_space
)) == NULL
)
1068 debugs(3, 0, "WARNING: No units on '" <<
1069 config_input_line
<< "', assuming " <<
1070 d
<< " " << units
);
1071 else if ((m
= parseBytesUnits(token
)) == 0) {
1076 *bptr
= static_cast<int64_t>(m
* d
/ u
);
1078 if (static_cast<double>(*bptr
) * 2 != m
* d
/ u
* 2)
1084 parseBytesLine(size_t * bptr
, const char *units
)
1091 if ((u
= parseBytesUnits(units
)) == 0) {
1096 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
1101 if (strcmp(token
, "none") == 0 || strcmp(token
, "-1") == 0) {
1102 *bptr
= static_cast<size_t>(-1);
1108 m
= u
; /* default to 'units' if none specified */
1112 else if ((token
= strtok(NULL
, w_space
)) == NULL
)
1113 debugs(3, 0, "WARNING: No units on '" <<
1114 config_input_line
<< "', assuming " <<
1115 d
<< " " << units
);
1116 else if ((m
= parseBytesUnits(token
)) == 0) {
1121 *bptr
= static_cast<size_t>(m
* d
/ u
);
1123 if (static_cast<double>(*bptr
) * 2 != m
* d
/ u
* 2)
1129 parseBytesLineSigned(ssize_t
* bptr
, const char *units
)
1136 if ((u
= parseBytesUnits(units
)) == 0) {
1141 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
1146 if (strcmp(token
, "none") == 0 || token
[0] == '-' /* -N */) {
1153 m
= u
; /* default to 'units' if none specified */
1157 else if ((token
= strtok(NULL
, w_space
)) == NULL
)
1158 debugs(3, 0, "WARNING: No units on '" <<
1159 config_input_line
<< "', assuming " <<
1160 d
<< " " << units
);
1161 else if ((m
= parseBytesUnits(token
)) == 0) {
1166 *bptr
= static_cast<size_t>(m
* d
/ u
);
1168 if (static_cast<double>(*bptr
) * 2 != m
* d
/ u
* 2)
1175 * Parse bytes from a string.
1176 * Similar to the parseBytesLine function but parses the string value instead of
1177 * the current token value.
1179 static void parseBytesOptionValue(size_t * bptr
, const char *units
, char const * value
)
1182 if ((u
= parseBytesUnits(units
)) == 0) {
1187 // Find number from string beginning.
1188 char const * number_begin
= value
;
1189 char const * number_end
= value
;
1191 while ((*number_end
>= '0' && *number_end
<= '9')) {
1196 number
.limitInit(number_begin
, number_end
- number_begin
);
1198 int d
= xatoi(number
.termedBuf());
1200 if ((m
= parseBytesUnits(number_end
)) == 0) {
1205 *bptr
= static_cast<size_t>(m
* d
/ u
);
1206 if (static_cast<double>(*bptr
) * 2 != m
* d
/ u
* 2)
1212 parseBytesUnits(const char *unit
)
1214 if (!strncasecmp(unit
, B_BYTES_STR
, strlen(B_BYTES_STR
)))
1217 if (!strncasecmp(unit
, B_KBYTES_STR
, strlen(B_KBYTES_STR
)))
1220 if (!strncasecmp(unit
, B_MBYTES_STR
, strlen(B_MBYTES_STR
)))
1223 if (!strncasecmp(unit
, B_GBYTES_STR
, strlen(B_GBYTES_STR
)))
1226 debugs(3, DBG_CRITICAL
, "WARNING: Unknown bytes unit '" << unit
<< "'");
1231 /*****************************************************************************
1233 *****************************************************************************/
1236 dump_acl(StoreEntry
* entry
, const char *name
, ACL
* ae
)
1241 while (ae
!= NULL
) {
1242 debugs(3, 3, "dump_acl: " << name
<< " " << ae
->name
);
1243 storeAppendPrintf(entry
, "%s %s %s ",
1250 debugs(3, 3, "dump_acl: " << name
<< " " << ae
->name
<< " " << v
->key
);
1251 storeAppendPrintf(entry
, "%s ", v
->key
);
1255 storeAppendPrintf(entry
, "\n");
1256 wordlistDestroy(&w
);
1262 parse_acl(ACL
** ae
)
1264 ACL::ParseAclLine(LegacyParser
, ae
);
1274 dump_acl_list(StoreEntry
* entry
, ACLList
* head
)
1278 for (l
= head
; l
; l
= l
->next
) {
1279 storeAppendPrintf(entry
, " %s%s",
1280 l
->op
? null_string
: "!",
1286 dump_acl_access(StoreEntry
* entry
, const char *name
, acl_access
* head
)
1290 for (l
= head
; l
; l
= l
->next
) {
1291 storeAppendPrintf(entry
, "%s %s",
1293 l
->allow
? "Allow" : "Deny");
1294 dump_acl_list(entry
, l
->aclList
);
1295 storeAppendPrintf(entry
, "\n");
1300 parse_acl_access(acl_access
** head
)
1302 aclParseAccessLine(LegacyParser
, head
);
1306 free_acl_access(acl_access
** head
)
1308 aclDestroyAccessList(head
);
1312 dump_address(StoreEntry
* entry
, const char *name
, Ip::Address
&addr
)
1314 char buf
[MAX_IPSTRLEN
];
1315 storeAppendPrintf(entry
, "%s %s\n", name
, addr
.NtoA(buf
,MAX_IPSTRLEN
) );
1319 parse_address(Ip::Address
*addr
)
1321 char *token
= strtok(NULL
, w_space
);
1328 if (!strcmp(token
,"any_addr")) {
1331 } else if ( (!strcmp(token
,"no_addr")) || (!strcmp(token
,"full_mask")) ) {
1339 free_address(Ip::Address
*addr
)
1344 CBDATA_TYPE(acl_address
);
1347 dump_acl_address(StoreEntry
* entry
, const char *name
, acl_address
* head
)
1349 char buf
[MAX_IPSTRLEN
];
1352 for (l
= head
; l
; l
= l
->next
) {
1353 if (!l
->addr
.IsAnyAddr())
1354 storeAppendPrintf(entry
, "%s %s", name
, l
->addr
.NtoA(buf
,MAX_IPSTRLEN
));
1356 storeAppendPrintf(entry
, "%s autoselect", name
);
1358 dump_acl_list(entry
, l
->aclList
);
1360 storeAppendPrintf(entry
, "\n");
1365 freed_acl_address(void *data
)
1367 acl_address
*l
= static_cast<acl_address
*>(data
);
1368 aclDestroyAclList(&l
->aclList
);
1372 parse_acl_address(acl_address
** head
)
1375 acl_address
**tail
= head
; /* sane name below */
1376 CBDATA_INIT_TYPE_FREECB(acl_address
, freed_acl_address
);
1377 l
= cbdataAlloc(acl_address
);
1378 parse_address(&l
->addr
);
1379 aclParseAclList(LegacyParser
, &l
->aclList
);
1382 tail
= &(*tail
)->next
;
1388 free_acl_address(acl_address
** head
)
1391 acl_address
*l
= *head
;
1397 CBDATA_TYPE(acl_tos
);
1400 dump_acl_tos(StoreEntry
* entry
, const char *name
, acl_tos
* head
)
1404 for (l
= head
; l
; l
= l
->next
) {
1406 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->tos
);
1408 storeAppendPrintf(entry
, "%s none", name
);
1410 dump_acl_list(entry
, l
->aclList
);
1412 storeAppendPrintf(entry
, "\n");
1417 freed_acl_tos(void *data
)
1419 acl_tos
*l
= static_cast<acl_tos
*>(data
);
1420 aclDestroyAclList(&l
->aclList
);
1424 parse_acl_tos(acl_tos
** head
)
1427 acl_tos
**tail
= head
; /* sane name below */
1428 unsigned int tos
; /* Initially uint for strtoui. Casted to tos_t before return */
1429 char *token
= strtok(NULL
, w_space
);
1436 if (!xstrtoui(token
, NULL
, &tos
, 0, std::numeric_limits
<tos_t
>::max())) {
1441 CBDATA_INIT_TYPE_FREECB(acl_tos
, freed_acl_tos
);
1443 l
= cbdataAlloc(acl_tos
);
1445 l
->tos
= (tos_t
)tos
;
1447 aclParseAclList(LegacyParser
, &l
->aclList
);
1450 tail
= &(*tail
)->next
;
1456 free_acl_tos(acl_tos
** head
)
1466 #if SO_MARK && USE_LIBCAP
1468 CBDATA_TYPE(acl_nfmark
);
1471 dump_acl_nfmark(StoreEntry
* entry
, const char *name
, acl_nfmark
* head
)
1475 for (l
= head
; l
; l
= l
->next
) {
1477 storeAppendPrintf(entry
, "%s 0x%02X", name
, l
->nfmark
);
1479 storeAppendPrintf(entry
, "%s none", name
);
1481 dump_acl_list(entry
, l
->aclList
);
1483 storeAppendPrintf(entry
, "\n");
1488 freed_acl_nfmark(void *data
)
1490 acl_nfmark
*l
= static_cast<acl_nfmark
*>(data
);
1491 aclDestroyAclList(&l
->aclList
);
1495 parse_acl_nfmark(acl_nfmark
** head
)
1498 acl_nfmark
**tail
= head
; /* sane name below */
1500 char *token
= strtok(NULL
, w_space
);
1507 if (!xstrtoui(token
, NULL
, &mark
, 0, std::numeric_limits
<nfmark_t
>::max())) {
1512 CBDATA_INIT_TYPE_FREECB(acl_nfmark
, freed_acl_nfmark
);
1514 l
= cbdataAlloc(acl_nfmark
);
1518 aclParseAclList(LegacyParser
, &l
->aclList
);
1521 tail
= &(*tail
)->next
;
1527 free_acl_nfmark(acl_nfmark
** head
)
1530 acl_nfmark
*l
= *head
;
1536 #endif /* SO_MARK */
1538 CBDATA_TYPE(acl_size_t
);
1541 dump_acl_b_size_t(StoreEntry
* entry
, const char *name
, acl_size_t
* head
)
1545 for (l
= head
; l
; l
= l
->next
) {
1547 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) l
->size
, B_BYTES_STR
);
1549 storeAppendPrintf(entry
, "%s none", name
);
1551 dump_acl_list(entry
, l
->aclList
);
1553 storeAppendPrintf(entry
, "\n");
1558 freed_acl_b_size_t(void *data
)
1560 acl_size_t
*l
= static_cast<acl_size_t
*>(data
);
1561 aclDestroyAclList(&l
->aclList
);
1565 parse_acl_b_size_t(acl_size_t
** head
)
1568 acl_size_t
**tail
= head
; /* sane name below */
1570 CBDATA_INIT_TYPE_FREECB(acl_size_t
, freed_acl_b_size_t
);
1572 l
= cbdataAlloc(acl_size_t
);
1574 parse_b_int64_t(&l
->size
);
1576 aclParseAclList(LegacyParser
, &l
->aclList
);
1579 tail
= &(*tail
)->next
;
1585 free_acl_b_size_t(acl_size_t
** head
)
1588 acl_size_t
*l
= *head
;
1597 #include "DelayPools.h"
1598 #include "DelayConfig.h"
1599 /* do nothing - free_delay_pool_count is the magic free function.
1600 * this is why delay_pool_count isn't just marked TYPE: u_short
1602 #define free_delay_pool_class(X)
1603 #define free_delay_pool_access(X)
1604 #define free_delay_pool_rates(X)
1605 #define dump_delay_pool_class(X, Y, Z)
1606 #define dump_delay_pool_access(X, Y, Z)
1607 #define dump_delay_pool_rates(X, Y, Z)
1610 free_delay_pool_count(DelayConfig
* cfg
)
1612 cfg
->freePoolCount();
1616 dump_delay_pool_count(StoreEntry
* entry
, const char *name
, DelayConfig
&cfg
)
1618 cfg
.dumpPoolCount (entry
, name
);
1622 parse_delay_pool_count(DelayConfig
* cfg
)
1624 cfg
->parsePoolCount();
1628 parse_delay_pool_class(DelayConfig
* cfg
)
1630 cfg
->parsePoolClass();
1634 parse_delay_pool_rates(DelayConfig
* cfg
)
1636 cfg
->parsePoolRates();
1640 parse_delay_pool_access(DelayConfig
* cfg
)
1642 cfg
->parsePoolAccess(LegacyParser
);
1648 #include "ClientDelayConfig.h"
1649 /* do nothing - free_client_delay_pool_count is the magic free function.
1650 * this is why client_delay_pool_count isn't just marked TYPE: u_short
1653 #define free_client_delay_pool_access(X)
1654 #define free_client_delay_pool_rates(X)
1655 #define dump_client_delay_pool_access(X, Y, Z)
1656 #define dump_client_delay_pool_rates(X, Y, Z)
1659 free_client_delay_pool_count(ClientDelayConfig
* cfg
)
1661 cfg
->freePoolCount();
1665 dump_client_delay_pool_count(StoreEntry
* entry
, const char *name
, ClientDelayConfig
&cfg
)
1667 cfg
.dumpPoolCount (entry
, name
);
1671 parse_client_delay_pool_count(ClientDelayConfig
* cfg
)
1673 cfg
->parsePoolCount();
1677 parse_client_delay_pool_rates(ClientDelayConfig
* cfg
)
1679 cfg
->parsePoolRates();
1683 parse_client_delay_pool_access(ClientDelayConfig
* cfg
)
1685 cfg
->parsePoolAccess(LegacyParser
);
1689 #if USE_HTTP_VIOLATIONS
1691 dump_http_header_access(StoreEntry
* entry
, const char *name
, header_mangler header
[])
1695 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1696 if (header
[i
].access_list
!= NULL
) {
1697 storeAppendPrintf(entry
, "%s ", name
);
1698 dump_acl_access(entry
, httpHeaderNameById(i
),
1699 header
[i
].access_list
);
1705 parse_http_header_access(header_mangler header
[])
1710 if ((t
= strtok(NULL
, w_space
)) == NULL
) {
1711 debugs(3, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1712 debugs(3, 0, "parse_http_header_access: missing header name.");
1716 /* Now lookup index of header. */
1717 id
= httpHeaderIdByNameDef(t
, strlen(t
));
1719 if (strcmp(t
, "All") == 0)
1721 else if (strcmp(t
, "Other") == 0)
1723 else if (id
== -1) {
1724 debugs(3, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1725 debugs(3, 0, "parse_http_header_access: unknown header name '" << t
<< "'");
1729 if (id
!= HDR_ENUM_END
) {
1730 parse_acl_access(&header
[id
].access_list
);
1732 char *next_string
= t
+ strlen(t
) - 1;
1734 *(next_string
+ 1) = ' ';
1736 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1737 char *new_string
= xstrdup(next_string
);
1738 strtok(new_string
, w_space
);
1739 parse_acl_access(&header
[i
].access_list
);
1740 safe_free(new_string
);
1746 free_http_header_access(header_mangler header
[])
1750 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1751 free_acl_access(&header
[i
].access_list
);
1756 dump_http_header_replace(StoreEntry
* entry
, const char *name
, header_mangler
1761 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1762 if (NULL
== header
[i
].replacement
)
1765 storeAppendPrintf(entry
, "%s %s %s\n", name
, httpHeaderNameById(i
),
1766 header
[i
].replacement
);
1771 parse_http_header_replace(header_mangler header
[])
1776 if ((t
= strtok(NULL
, w_space
)) == NULL
) {
1777 debugs(3, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1778 debugs(3, 0, "parse_http_header_replace: missing header name.");
1782 /* Now lookup index of header. */
1783 id
= httpHeaderIdByNameDef(t
, strlen(t
));
1785 if (strcmp(t
, "All") == 0)
1787 else if (strcmp(t
, "Other") == 0)
1789 else if (id
== -1) {
1790 debugs(3, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
1791 debugs(3, 0, "parse_http_header_replace: unknown header name " << t
<< ".");
1796 if (id
!= HDR_ENUM_END
) {
1797 if (header
[id
].replacement
!= NULL
)
1798 safe_free(header
[id
].replacement
);
1800 header
[id
].replacement
= xstrdup(t
+ strlen(t
) + 1);
1802 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1803 if (header
[i
].replacement
!= NULL
)
1804 safe_free(header
[i
].replacement
);
1806 header
[i
].replacement
= xstrdup(t
+ strlen(t
) + 1);
1812 free_http_header_replace(header_mangler header
[])
1816 for (i
= 0; i
< HDR_ENUM_END
; i
++) {
1817 if (header
[i
].replacement
!= NULL
)
1818 safe_free(header
[i
].replacement
);
1825 dump_cachedir(StoreEntry
* entry
, const char *name
, SquidConfig::_cacheSwap swap
)
1831 for (i
= 0; i
< swap
.n_configured
; i
++) {
1832 s
= dynamic_cast<SwapDir
*>(swap
.swapDirs
[i
].getRaw());
1834 storeAppendPrintf(entry
, "%s %s %s", name
, s
->type(), s
->path
);
1836 storeAppendPrintf(entry
, "\n");
1841 check_null_string(char *s
)
1848 parse_authparam(Auth::ConfigVector
* config
)
1853 if ((type_str
= strtok(NULL
, w_space
)) == NULL
)
1856 if ((param_str
= strtok(NULL
, w_space
)) == NULL
)
1859 /* find a configuration for the scheme in the currently parsed configs... */
1860 Auth::Config
*schemeCfg
= Auth::Config::Find(type_str
);
1862 if (schemeCfg
== NULL
) {
1863 /* Create a configuration based on the scheme info */
1864 Auth::Scheme::Pointer theScheme
= Auth::Scheme::Find(type_str
);
1866 if (theScheme
== NULL
) {
1867 debugs(3, DBG_CRITICAL
, "Parsing Config File: Unknown authentication scheme '" << type_str
<< "'.");
1871 config
->push_back(theScheme
->createConfig());
1872 schemeCfg
= Auth::Config::Find(type_str
);
1873 if (schemeCfg
== NULL
) {
1874 debugs(3, DBG_CRITICAL
, "Parsing Config File: Corruption configuring authentication scheme '" << type_str
<< "'.");
1879 schemeCfg
->parse(schemeCfg
, config
->size(), param_str
);
1883 free_authparam(Auth::ConfigVector
* cfg
)
1885 /* Wipe the Auth globals and Detach/Destruct component config + state. */
1888 /* remove our pointers to the probably-dead sub-configs */
1889 while (cfg
->size()) {
1893 /* on reconfigure initialize new auth schemes for the new config. */
1894 if (reconfiguring
) {
1900 dump_authparam(StoreEntry
* entry
, const char *name
, Auth::ConfigVector cfg
)
1902 for (Auth::ConfigVector::iterator i
= cfg
.begin(); i
!= cfg
.end(); ++i
)
1903 (*i
)->dump(entry
, name
, (*i
));
1905 #endif /* USE_AUTH */
1907 /* TODO: just return the object, the # is irrelevant */
1909 find_fstype(char *type
)
1911 for (size_t i
= 0; i
< StoreFileSystem::FileSystems().size(); ++i
)
1912 if (strcasecmp(type
, StoreFileSystem::FileSystems().items
[i
]->type()) == 0)
1919 parse_cachedir(SquidConfig::_cacheSwap
* swap
)
1921 // The workers option must preceed cache_dir for the IamWorkerProcess check
1922 // below to work. TODO: Redo IamWorkerProcess to work w/o Config and remove
1923 if (KidIdentifier
> 1 && Config
.workers
== 1) {
1924 debugs(3, DBG_CRITICAL
,
1925 "FATAL: cache_dir found before the workers option. Reorder.");
1929 // Among all processes, only workers may need and can handle cache_dir.
1930 if (!IamWorkerProcess())
1935 RefCount
<SwapDir
> sd
;
1939 if ((type_str
= strtok(NULL
, w_space
)) == NULL
)
1942 if ((path_str
= strtok(NULL
, w_space
)) == NULL
)
1945 fs
= find_fstype(type_str
);
1950 /* reconfigure existing dir */
1952 for (i
= 0; i
< swap
->n_configured
; i
++) {
1953 assert (swap
->swapDirs
[i
].getRaw());
1955 if ((strcasecmp(path_str
, dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw())->path
)) == 0) {
1956 /* this is specific to on-fs Stores. The right
1957 * way to handle this is probably to have a mapping
1958 * from paths to stores, and have on-fs stores
1959 * register with that, and lookip in that in their
1960 * own setup logic. RBC 20041225. TODO.
1963 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[i
].getRaw());
1965 if (sd
->type() != StoreFileSystem::FileSystems().items
[fs
]->type()) {
1966 debugs(3, 0, "ERROR: Can't change type of existing cache_dir " <<
1967 sd
->type() << " " << sd
->path
<< " to " << type_str
<< ". Restart required");
1971 sd
->reconfigure (i
, path_str
);
1973 update_maxobjsize();
1980 if (swap
->n_configured
> 63) {
1981 /* 7 bits, signed */
1982 debugs(3, DBG_CRITICAL
, "WARNING: There is a fixed maximum of 63 cache_dir entries Squid can handle.");
1983 debugs(3, DBG_CRITICAL
, "WARNING: '" << path_str
<< "' is one to many.");
1988 allocate_new_swapdir(swap
);
1990 swap
->swapDirs
[swap
->n_configured
] = StoreFileSystem::FileSystems().items
[fs
]->createSwapDir();
1992 sd
= dynamic_cast<SwapDir
*>(swap
->swapDirs
[swap
->n_configured
].getRaw());
1994 /* parse the FS parameters and options */
1995 sd
->parse(swap
->n_configured
, path_str
);
1997 ++swap
->n_configured
;
1999 /* Update the max object size */
2000 update_maxobjsize();
2004 peer_type_str(const peer_t type
)
2006 const char * result
;
2018 case PEER_MULTICAST
:
2019 result
= "multicast";
2031 dump_peer(StoreEntry
* entry
, const char *name
, peer
* p
)
2035 LOCAL_ARRAY(char, xname
, 128);
2038 storeAppendPrintf(entry
, "%s %s %s %d %d name=%s",
2045 dump_peer_options(entry
, p
);
2047 for (d
= p
->peer_domain
; d
; d
= d
->next
) {
2048 storeAppendPrintf(entry
, "cache_peer_domain %s %s%s\n",
2050 d
->do_ping
? null_string
: "!",
2055 snprintf(xname
, 128, "cache_peer_access %s", p
->name
);
2056 dump_acl_access(entry
, xname
, p
->access
);
2059 for (t
= p
->typelist
; t
; t
= t
->next
) {
2060 storeAppendPrintf(entry
, "neighbor_type_domain %s %s %s\n",
2062 peer_type_str(t
->type
),
2071 * utility function to prevent getservbyname() being called with a numeric value
2072 * on Windows at least it returns garage results.
2075 isUnsignedNumeric(const char *str
, size_t len
)
2077 if (len
< 1) return false;
2079 for (; len
>0 && *str
; str
++, len
--) {
2080 if (! isdigit(*str
))
2087 \param proto 'tcp' or 'udp' for protocol
2088 \returns Port the named service is supposed to be listening on.
2091 GetService(const char *proto
)
2093 struct servent
*port
= NULL
;
2094 /** Parses a port number or service name from the squid.conf */
2095 char *token
= strtok(NULL
, w_space
);
2096 if (token
== NULL
) {
2098 return 0; /* NEVER REACHED */
2100 /** Returns either the service port number from /etc/services */
2101 if ( !isUnsignedNumeric(token
, strlen(token
)) )
2102 port
= getservbyname(token
, proto
);
2104 return ntohs((u_short
)port
->s_port
);
2106 /** Or a numeric translation of the config text. */
2107 return xatos(token
);
2111 \returns Port the named TCP service is supposed to be listening on.
2112 \copydoc GetService(const char *proto)
2117 return GetService("tcp");
2121 \returns Port the named UDP service is supposed to be listening on.
2122 \copydoc GetService(const char *proto)
2127 return GetService("udp");
2131 parse_peer(peer
** head
)
2135 CBDATA_INIT_TYPE_FREECB(peer
, peerDestroy
);
2136 p
= cbdataAlloc(peer
);
2137 p
->http_port
= CACHE_HTTP_PORT
;
2138 p
->icp
.port
= CACHE_ICP_PORT
;
2141 p
->stats
.logged_state
= PEER_ALIVE
;
2143 if ((token
= strtok(NULL
, w_space
)) == NULL
)
2146 p
->host
= xstrdup(token
);
2148 p
->name
= xstrdup(token
);
2150 if ((token
= strtok(NULL
, w_space
)) == NULL
)
2153 p
->type
= parseNeighborType(token
);
2155 if (p
->type
== PEER_MULTICAST
) {
2156 p
->options
.no_digest
= 1;
2157 p
->options
.no_netdb_exchange
= 1;
2160 p
->http_port
= GetTcpService();
2165 p
->icp
.port
= GetUdpService();
2166 p
->connection_auth
= 2; /* auto */
2168 while ((token
= strtok(NULL
, w_space
))) {
2169 if (!strcasecmp(token
, "proxy-only")) {
2170 p
->options
.proxy_only
= 1;
2171 } else if (!strcasecmp(token
, "no-query")) {
2172 p
->options
.no_query
= 1;
2173 } else if (!strcasecmp(token
, "background-ping")) {
2174 p
->options
.background_ping
= 1;
2175 } else if (!strcasecmp(token
, "no-digest")) {
2176 p
->options
.no_digest
= 1;
2177 } else if (!strcasecmp(token
, "no-tproxy")) {
2178 p
->options
.no_tproxy
= 1;
2179 } else if (!strcasecmp(token
, "multicast-responder")) {
2180 p
->options
.mcast_responder
= 1;
2181 #if PEER_MULTICAST_SIBLINGS
2182 } else if (!strcasecmp(token
, "multicast-siblings")) {
2183 p
->options
.mcast_siblings
= 1;
2185 } else if (!strncasecmp(token
, "weight=", 7)) {
2186 p
->weight
= xatoi(token
+ 7);
2187 } else if (!strncasecmp(token
, "basetime=", 9)) {
2188 p
->basetime
= xatoi(token
+ 9);
2189 } else if (!strcasecmp(token
, "closest-only")) {
2190 p
->options
.closest_only
= 1;
2191 } else if (!strncasecmp(token
, "ttl=", 4)) {
2192 p
->mcast
.ttl
= xatoi(token
+ 4);
2194 if (p
->mcast
.ttl
< 0)
2197 if (p
->mcast
.ttl
> 128)
2199 } else if (!strcasecmp(token
, "default")) {
2200 p
->options
.default_parent
= 1;
2201 } else if (!strcasecmp(token
, "round-robin")) {
2202 p
->options
.roundrobin
= 1;
2203 } else if (!strcasecmp(token
, "weighted-round-robin")) {
2204 p
->options
.weighted_roundrobin
= 1;
2206 } else if (!strcasecmp(token
, "htcp")) {
2207 p
->options
.htcp
= 1;
2208 } else if (!strncasecmp(token
, "htcp=", 5) || !strncasecmp(token
, "htcp-", 5)) {
2209 /* Note: The htcp- form is deprecated, replaced by htcp= */
2210 p
->options
.htcp
= 1;
2211 char *tmp
= xstrdup(token
+5);
2212 char *mode
, *nextmode
;
2213 for (mode
= nextmode
= tmp
; mode
; mode
= nextmode
) {
2214 nextmode
= strchr(mode
, ',');
2217 if (!strcasecmp(mode
, "no-clr")) {
2218 if (p
->options
.htcp_only_clr
)
2219 fatalf("parse_peer: can't set htcp-no-clr and htcp-only-clr simultaneously");
2220 p
->options
.htcp_no_clr
= 1;
2221 } else if (!strcasecmp(mode
, "no-purge-clr")) {
2222 p
->options
.htcp_no_purge_clr
= 1;
2223 } else if (!strcasecmp(mode
, "only-clr")) {
2224 if (p
->options
.htcp_no_clr
)
2225 fatalf("parse_peer: can't set htcp no-clr and only-clr simultaneously");
2226 p
->options
.htcp_only_clr
= 1;
2227 } else if (!strcasecmp(mode
, "forward-clr")) {
2228 p
->options
.htcp_forward_clr
= 1;
2229 } else if (!strcasecmp(mode
, "oldsquid")) {
2230 p
->options
.htcp_oldsquid
= 1;
2232 fatalf("invalid HTCP mode '%s'", mode
);
2237 } else if (!strcasecmp(token
, "no-netdb-exchange")) {
2238 p
->options
.no_netdb_exchange
= 1;
2240 } else if (!strcasecmp(token
, "carp")) {
2241 if (p
->type
!= PEER_PARENT
)
2242 fatalf("parse_peer: non-parent carp peer %s/%d\n", p
->host
, p
->http_port
);
2244 p
->options
.carp
= 1;
2245 } else if (!strcasecmp(token
, "userhash")) {
2247 if (p
->type
!= PEER_PARENT
)
2248 fatalf("parse_peer: non-parent userhash peer %s/%d\n", p
->host
, p
->http_port
);
2250 p
->options
.userhash
= 1;
2252 fatalf("parse_peer: userhash requires authentication. peer %s/%d\n", p
->host
, p
->http_port
);
2254 } else if (!strcasecmp(token
, "sourcehash")) {
2255 if (p
->type
!= PEER_PARENT
)
2256 fatalf("parse_peer: non-parent sourcehash peer %s/%d\n", p
->host
, p
->http_port
);
2258 p
->options
.sourcehash
= 1;
2260 } else if (!strcasecmp(token
, "no-delay")) {
2262 p
->options
.no_delay
= 1;
2264 debugs(0, DBG_CRITICAL
, "WARNING: cache_peer option 'no-delay' requires --enable-delay-pools");
2266 } else if (!strncasecmp(token
, "login=", 6)) {
2267 p
->login
= xstrdup(token
+ 6);
2268 rfc1738_unescape(p
->login
);
2269 } else if (!strncasecmp(token
, "connect-timeout=", 16)) {
2270 p
->connect_timeout
= xatoi(token
+ 16);
2271 } else if (!strncasecmp(token
, "connect-fail-limit=", 19)) {
2272 p
->connect_fail_limit
= xatoi(token
+ 19);
2273 #if USE_CACHE_DIGESTS
2274 } else if (!strncasecmp(token
, "digest-url=", 11)) {
2275 p
->digest_url
= xstrdup(token
+ 11);
2278 } else if (!strcasecmp(token
, "allow-miss")) {
2279 p
->options
.allow_miss
= 1;
2280 } else if (!strncasecmp(token
, "max-conn=", 9)) {
2281 p
->max_conn
= xatoi(token
+ 9);
2282 } else if (!strcasecmp(token
, "originserver")) {
2283 p
->options
.originserver
= 1;
2284 } else if (!strncasecmp(token
, "name=", 5)) {
2288 p
->name
= xstrdup(token
+ 5);
2289 } else if (!strncasecmp(token
, "forceddomain=", 13)) {
2290 safe_free(p
->domain
);
2293 p
->domain
= xstrdup(token
+ 13);
2297 } else if (strcmp(token
, "ssl") == 0) {
2299 } else if (strncmp(token
, "sslcert=", 8) == 0) {
2300 safe_free(p
->sslcert
);
2301 p
->sslcert
= xstrdup(token
+ 8);
2302 } else if (strncmp(token
, "sslkey=", 7) == 0) {
2303 safe_free(p
->sslkey
);
2304 p
->sslkey
= xstrdup(token
+ 7);
2305 } else if (strncmp(token
, "sslversion=", 11) == 0) {
2306 p
->sslversion
= atoi(token
+ 11);
2307 } else if (strncmp(token
, "ssloptions=", 11) == 0) {
2308 safe_free(p
->ssloptions
);
2309 p
->ssloptions
= xstrdup(token
+ 11);
2310 } else if (strncmp(token
, "sslcipher=", 10) == 0) {
2311 safe_free(p
->sslcipher
);
2312 p
->sslcipher
= xstrdup(token
+ 10);
2313 } else if (strncmp(token
, "sslcafile=", 10) == 0) {
2314 safe_free(p
->sslcafile
);
2315 p
->sslcafile
= xstrdup(token
+ 10);
2316 } else if (strncmp(token
, "sslcapath=", 10) == 0) {
2317 safe_free(p
->sslcapath
);
2318 p
->sslcapath
= xstrdup(token
+ 10);
2319 } else if (strncmp(token
, "sslcrlfile=", 11) == 0) {
2320 safe_free(p
->sslcrlfile
);
2321 p
->sslcapath
= xstrdup(token
+ 10);
2322 } else if (strncmp(token
, "sslflags=", 9) == 0) {
2323 safe_free(p
->sslflags
);
2324 p
->sslflags
= xstrdup(token
+ 9);
2325 } else if (strncmp(token
, "ssldomain=", 10) == 0) {
2326 safe_free(p
->ssldomain
);
2327 p
->ssldomain
= xstrdup(token
+ 10);
2330 } else if (strcmp(token
, "front-end-https") == 0) {
2331 p
->front_end_https
= 1;
2332 } else if (strcmp(token
, "front-end-https=on") == 0) {
2333 p
->front_end_https
= 1;
2334 } else if (strcmp(token
, "front-end-https=auto") == 0) {
2335 p
->front_end_https
= 2;
2336 } else if (strcmp(token
, "connection-auth=off") == 0) {
2337 p
->connection_auth
= 0;
2338 } else if (strcmp(token
, "connection-auth") == 0) {
2339 p
->connection_auth
= 1;
2340 } else if (strcmp(token
, "connection-auth=on") == 0) {
2341 p
->connection_auth
= 1;
2342 } else if (strcmp(token
, "connection-auth=auto") == 0) {
2343 p
->connection_auth
= 2;
2345 debugs(3, 0, "parse_peer: token='" << token
<< "'");
2350 if (peerFindByName(p
->name
))
2351 fatalf("ERROR: cache_peer %s specified twice\n", p
->name
);
2356 if (p
->connect_fail_limit
< 1)
2357 p
->connect_fail_limit
= 10;
2359 p
->icp
.version
= ICP_VERSION_CURRENT
;
2363 #if USE_CACHE_DIGESTS
2365 if (!p
->options
.no_digest
) {
2366 /* XXX This looks odd.. who has the original pointer
2369 PeerDigest
*pd
= peerDigestCreate(p
);
2370 p
->digest
= cbdataReference(pd
);
2375 p
->index
= ++Config
.npeers
;
2377 while (*head
!= NULL
)
2378 head
= &(*head
)->next
;
2386 free_peer(peer
** P
)
2390 while ((p
= *P
) != NULL
) {
2392 #if USE_CACHE_DIGESTS
2394 cbdataReferenceDone(p
->digest
);
2404 dump_cachemgrpasswd(StoreEntry
* entry
, const char *name
, cachemgr_passwd
* list
)
2408 while (list
!= NULL
) {
2409 if (strcmp(list
->passwd
, "none") && strcmp(list
->passwd
, "disable"))
2410 storeAppendPrintf(entry
, "%s XXXXXXXXXX", name
);
2412 storeAppendPrintf(entry
, "%s %s", name
, list
->passwd
);
2414 for (w
= list
->actions
; w
!= NULL
; w
= w
->next
) {
2415 storeAppendPrintf(entry
, " %s", w
->key
);
2418 storeAppendPrintf(entry
, "\n");
2424 parse_cachemgrpasswd(cachemgr_passwd
** head
)
2426 char *passwd
= NULL
;
2427 wordlist
*actions
= NULL
;
2429 cachemgr_passwd
**P
;
2430 parse_string(&passwd
);
2431 parse_wordlist(&actions
);
2432 p
= static_cast<cachemgr_passwd
*>(xcalloc(1, sizeof(cachemgr_passwd
)));
2434 p
->actions
= actions
;
2436 for (P
= head
; *P
; P
= &(*P
)->next
) {
2438 * See if any of the actions from this line already have a
2439 * password from previous lines. The password checking
2440 * routines in cache_manager.c take the the password from
2441 * the first cachemgr_passwd struct that contains the
2442 * requested action. Thus, we should warn users who might
2443 * think they can have two passwords for the same action.
2448 for (w
= (*P
)->actions
; w
; w
= w
->next
) {
2449 for (u
= actions
; u
; u
= u
->next
) {
2450 if (strcmp(w
->key
, u
->key
))
2453 debugs(0, 0, "WARNING: action '" << u
->key
<< "' (line " << config_lineno
<< ") already has a password");
2462 free_cachemgrpasswd(cachemgr_passwd
** head
)
2466 while ((p
= *head
) != NULL
) {
2469 wordlistDestroy(&p
->actions
);
2475 dump_denyinfo(StoreEntry
* entry
, const char *name
, acl_deny_info_list
* var
)
2479 while (var
!= NULL
) {
2480 storeAppendPrintf(entry
, "%s %s", name
, var
->err_page_name
);
2482 for (a
= var
->acl_list
; a
!= NULL
; a
= a
->next
)
2483 storeAppendPrintf(entry
, " %s", a
->name
);
2485 storeAppendPrintf(entry
, "\n");
2492 parse_denyinfo(acl_deny_info_list
** var
)
2494 aclParseDenyInfoLine(var
);
2498 free_denyinfo(acl_deny_info_list
** list
)
2500 acl_deny_info_list
*a
= NULL
;
2501 acl_deny_info_list
*a_next
= NULL
;
2502 acl_name_list
*l
= NULL
;
2503 acl_name_list
*l_next
= NULL
;
2505 for (a
= *list
; a
; a
= a_next
) {
2506 for (l
= a
->acl_list
; l
; l
= l_next
) {
2508 memFree(l
, MEM_ACL_NAME_LIST
);
2513 memFree(a
, MEM_ACL_DENY_INFO_LIST
);
2521 parse_peer_access(void)
2526 if (!(host
= strtok(NULL
, w_space
)))
2529 if ((p
= peerFindByName(host
)) == NULL
) {
2530 debugs(15, 0, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2534 aclParseAccessLine(LegacyParser
, &p
->access
);
2538 parse_hostdomain(void)
2541 char *domain
= NULL
;
2543 if (!(host
= strtok(NULL
, w_space
)))
2546 while ((domain
= strtok(NULL
, list_sep
))) {
2547 domain_ping
*l
= NULL
;
2548 domain_ping
**L
= NULL
;
2551 if ((p
= peerFindByName(host
)) == NULL
) {
2552 debugs(15, 0, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2556 l
= static_cast<domain_ping
*>(xcalloc(1, sizeof(domain_ping
)));
2559 if (*domain
== '!') { /* check for !.edu */
2564 l
->domain
= xstrdup(domain
);
2566 for (L
= &(p
->peer_domain
); *L
; L
= &((*L
)->next
));
2572 parse_hostdomaintype(void)
2576 char *domain
= NULL
;
2578 if (!(host
= strtok(NULL
, w_space
)))
2581 if (!(type
= strtok(NULL
, w_space
)))
2584 while ((domain
= strtok(NULL
, list_sep
))) {
2585 domain_type
*l
= NULL
;
2586 domain_type
**L
= NULL
;
2589 if ((p
= peerFindByName(host
)) == NULL
) {
2590 debugs(15, 0, "" << cfg_filename
<< ", line " << config_lineno
<< ": No cache_peer '" << host
<< "'");
2594 l
= static_cast<domain_type
*>(xcalloc(1, sizeof(domain_type
)));
2595 l
->type
= parseNeighborType(type
);
2596 l
->domain
= xstrdup(domain
);
2598 for (L
= &(p
->typelist
); *L
; L
= &((*L
)->next
));
2604 dump_int(StoreEntry
* entry
, const char *name
, int var
)
2606 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
2624 dump_onoff(StoreEntry
* entry
, const char *name
, int var
)
2626 storeAppendPrintf(entry
, "%s %s\n", name
, var
? "on" : "off");
2630 parse_onoff(int *var
)
2632 char *token
= strtok(NULL
, w_space
);
2637 if (!strcasecmp(token
, "on") || !strcasecmp(token
, "enable"))
2643 #define free_onoff free_int
2646 dump_tristate(StoreEntry
* entry
, const char *name
, int var
)
2657 storeAppendPrintf(entry
, "%s %s\n", name
, state
);
2661 parse_tristate(int *var
)
2663 char *token
= strtok(NULL
, w_space
);
2668 if (!strcasecmp(token
, "on") || !strcasecmp(token
, "enable"))
2670 else if (!strcasecmp(token
, "warn"))
2676 #define free_tristate free_int
2679 dump_refreshpattern(StoreEntry
* entry
, const char *name
, refresh_t
* head
)
2681 while (head
!= NULL
) {
2682 storeAppendPrintf(entry
, "%s%s %s %d %d%% %d",
2684 head
->flags
.icase
? " -i" : null_string
,
2686 (int) head
->min
/ 60,
2687 (int) (100.0 * head
->pct
+ 0.5),
2688 (int) head
->max
/ 60);
2690 if (head
->max_stale
>= 0)
2691 storeAppendPrintf(entry
, " max-stale=%d", head
->max_stale
);
2693 if (head
->flags
.refresh_ims
)
2694 storeAppendPrintf(entry
, " refresh-ims");
2696 if (head
->flags
.store_stale
)
2697 storeAppendPrintf(entry
, " store-stale");
2699 #if USE_HTTP_VIOLATIONS
2701 if (head
->flags
.override_expire
)
2702 storeAppendPrintf(entry
, " override-expire");
2704 if (head
->flags
.override_lastmod
)
2705 storeAppendPrintf(entry
, " override-lastmod");
2707 if (head
->flags
.reload_into_ims
)
2708 storeAppendPrintf(entry
, " reload-into-ims");
2710 if (head
->flags
.ignore_reload
)
2711 storeAppendPrintf(entry
, " ignore-reload");
2713 if (head
->flags
.ignore_no_cache
)
2714 storeAppendPrintf(entry
, " ignore-no-cache");
2716 if (head
->flags
.ignore_no_store
)
2717 storeAppendPrintf(entry
, " ignore-no-store");
2719 if (head
->flags
.ignore_must_revalidate
)
2720 storeAppendPrintf(entry
, " ignore-must-revalidate");
2722 if (head
->flags
.ignore_private
)
2723 storeAppendPrintf(entry
, " ignore-private");
2725 if (head
->flags
.ignore_auth
)
2726 storeAppendPrintf(entry
, " ignore-auth");
2730 storeAppendPrintf(entry
, "\n");
2737 parse_refreshpattern(refresh_t
** head
)
2744 int refresh_ims
= 0;
2745 int store_stale
= 0;
2748 #if USE_HTTP_VIOLATIONS
2750 int override_expire
= 0;
2751 int override_lastmod
= 0;
2752 int reload_into_ims
= 0;
2753 int ignore_reload
= 0;
2754 int ignore_no_cache
= 0;
2755 int ignore_no_store
= 0;
2756 int ignore_must_revalidate
= 0;
2757 int ignore_private
= 0;
2758 int ignore_auth
= 0;
2765 int flags
= REG_EXTENDED
| REG_NOSUB
;
2767 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
2772 if (strcmp(token
, "-i") == 0) {
2774 token
= strtok(NULL
, w_space
);
2775 } else if (strcmp(token
, "+i") == 0) {
2776 flags
&= ~REG_ICASE
;
2777 token
= strtok(NULL
, w_space
);
2780 if (token
== NULL
) {
2785 pattern
= xstrdup(token
);
2787 i
= GetInteger(); /* token: min */
2789 /* catch negative and insanely huge values close to 32-bit wrap */
2791 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age negative. Cropped back to zero.");
2794 if (i
> 60*24*365) {
2795 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern minimum age too high. Cropped back to 1 year.");
2799 min
= (time_t) (i
* 60); /* convert minutes to seconds */
2801 i
= GetInteger(); /* token: pct */
2803 pct
= (double) i
/ 100.0;
2805 i
= GetInteger(); /* token: max */
2807 /* catch negative and insanely huge values close to 32-bit wrap */
2809 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age negative. Cropped back to zero.");
2812 if (i
> 60*24*365) {
2813 debugs(3, DBG_IMPORTANT
, "WARNING: refresh_pattern maximum age too high. Cropped back to 1 year.");
2817 max
= (time_t) (i
* 60); /* convert minutes to seconds */
2820 while ((token
= strtok(NULL
, w_space
)) != NULL
) {
2821 if (!strcmp(token
, "refresh-ims")) {
2823 } else if (!strcmp(token
, "store-stale")) {
2825 } else if (!strncmp(token
, "max-stale=", 10)) {
2826 max_stale
= atoi(token
+ 10);
2827 #if USE_HTTP_VIOLATIONS
2829 } else if (!strcmp(token
, "override-expire"))
2830 override_expire
= 1;
2831 else if (!strcmp(token
, "override-lastmod"))
2832 override_lastmod
= 1;
2833 else if (!strcmp(token
, "ignore-no-cache"))
2834 ignore_no_cache
= 1;
2835 else if (!strcmp(token
, "ignore-no-store"))
2836 ignore_no_store
= 1;
2837 else if (!strcmp(token
, "ignore-must-revalidate"))
2838 ignore_must_revalidate
= 1;
2839 else if (!strcmp(token
, "ignore-private"))
2841 else if (!strcmp(token
, "ignore-auth"))
2843 else if (!strcmp(token
, "reload-into-ims")) {
2844 reload_into_ims
= 1;
2845 refresh_nocache_hack
= 1;
2846 /* tell client_side.c that this is used */
2847 } else if (!strcmp(token
, "ignore-reload")) {
2849 refresh_nocache_hack
= 1;
2850 /* tell client_side.c that this is used */
2854 debugs(22, 0, "refreshAddToList: Unknown option '" << pattern
<< "': " << token
);
2857 if ((errcode
= regcomp(&comp
, pattern
, flags
)) != 0) {
2859 regerror(errcode
, &comp
, errbuf
, sizeof errbuf
);
2860 debugs(22, 0, "" << cfg_filename
<< " line " << config_lineno
<< ": " << config_input_line
);
2861 debugs(22, 0, "refreshAddToList: Invalid regular expression '" << pattern
<< "': " << errbuf
);
2865 pct
= pct
< 0.0 ? 0.0 : pct
;
2866 max
= max
< 0 ? 0 : max
;
2867 t
= static_cast<refresh_t
*>(xcalloc(1, sizeof(refresh_t
)));
2868 t
->pattern
= (char *) xstrdup(pattern
);
2869 t
->compiled_pattern
= comp
;
2874 if (flags
& REG_ICASE
)
2878 t
->flags
.refresh_ims
= 1;
2881 t
->flags
.store_stale
= 1;
2883 t
->max_stale
= max_stale
;
2885 #if USE_HTTP_VIOLATIONS
2887 if (override_expire
)
2888 t
->flags
.override_expire
= 1;
2890 if (override_lastmod
)
2891 t
->flags
.override_lastmod
= 1;
2893 if (reload_into_ims
)
2894 t
->flags
.reload_into_ims
= 1;
2897 t
->flags
.ignore_reload
= 1;
2899 if (ignore_no_cache
)
2900 t
->flags
.ignore_no_cache
= 1;
2902 if (ignore_no_store
)
2903 t
->flags
.ignore_no_store
= 1;
2905 if (ignore_must_revalidate
)
2906 t
->flags
.ignore_must_revalidate
= 1;
2909 t
->flags
.ignore_private
= 1;
2912 t
->flags
.ignore_auth
= 1;
2919 head
= &(*head
)->next
;
2927 free_refreshpattern(refresh_t
** head
)
2931 while ((t
= *head
) != NULL
) {
2933 safe_free(t
->pattern
);
2934 regfree(&t
->compiled_pattern
);
2938 #if USE_HTTP_VIOLATIONS
2939 refresh_nocache_hack
= 0;
2945 dump_string(StoreEntry
* entry
, const char *name
, char *var
)
2948 storeAppendPrintf(entry
, "%s %s\n", name
, var
);
2952 parse_string(char **var
)
2954 char *token
= strtok(NULL
, w_space
);
2960 *var
= xstrdup(token
);
2964 ConfigParser::ParseString(char **var
)
2970 ConfigParser::ParseString(String
*var
)
2972 char *token
= strtok(NULL
, w_space
);
2981 free_string(char **var
)
2987 parse_eol(char *volatile *var
)
2989 unsigned char *token
= (unsigned char *) strtok(NULL
, null_string
);
2997 while (*token
&& xisspace(*token
))
3005 *var
= xstrdup((char *) token
);
3008 #define dump_eol dump_string
3009 #define free_eol free_string
3012 dump_time_t(StoreEntry
* entry
, const char *name
, time_t var
)
3014 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int) var
);
3018 parse_time_t(time_t * var
)
3021 parseTimeLine(&tval
, T_SECOND_STR
, false);
3022 *var
= static_cast<time_t>(tval
/1000);
3026 free_time_t(time_t * var
)
3033 dump_time_msec(StoreEntry
* entry
, const char *name
, time_msec_t var
)
3036 storeAppendPrintf(entry
, "%s %"PRId64
" milliseconds\n", name
, var
);
3038 storeAppendPrintf(entry
, "%s %d seconds\n", name
, (int)(var
/1000) );
3042 parse_time_msec(time_msec_t
* var
)
3044 parseTimeLine(var
, T_SECOND_STR
, true);
3048 free_time_msec(time_msec_t
* var
)
3056 dump_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3058 storeAppendPrintf(entry
, "%s %d\n", name
, (int) var
);
3063 dump_b_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3065 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3070 dump_b_ssize_t(StoreEntry
* entry
, const char *name
, ssize_t var
)
3072 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_BYTES_STR
);
3078 dump_kb_size_t(StoreEntry
* entry
, const char *name
, size_t var
)
3080 storeAppendPrintf(entry
, "%s %d %s\n", name
, (int) var
, B_KBYTES_STR
);
3085 dump_b_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3087 storeAppendPrintf(entry
, "%s %"PRId64
" %s\n", name
, var
, B_BYTES_STR
);
3091 dump_kb_int64_t(StoreEntry
* entry
, const char *name
, int64_t var
)
3093 storeAppendPrintf(entry
, "%s %"PRId64
" %s\n", name
, var
, B_KBYTES_STR
);
3098 parse_size_t(size_t * var
)
3107 parse_b_size_t(size_t * var
)
3109 parseBytesLine(var
, B_BYTES_STR
);
3114 parse_b_ssize_t(ssize_t
* var
)
3116 parseBytesLineSigned(var
, B_BYTES_STR
);
3122 parse_kb_size_t(size_t * var
)
3124 parseBytesLine(var
, B_KBYTES_STR
);
3129 parse_b_int64_t(int64_t * var
)
3131 parseBytesLine64(var
, B_BYTES_STR
);
3135 parse_kb_int64_t(int64_t * var
)
3137 parseBytesLine64(var
, B_KBYTES_STR
);
3141 free_size_t(size_t * var
)
3148 free_ssize_t(ssize_t
* var
)
3155 free_b_int64_t(int64_t * var
)
3160 #define free_b_size_t free_size_t
3161 #define free_b_ssize_t free_ssize_t
3162 #define free_kb_size_t free_size_t
3163 #define free_mb_size_t free_size_t
3164 #define free_gb_size_t free_size_t
3165 #define free_kb_int64_t free_b_int64_t
3168 dump_u_short(StoreEntry
* entry
, const char *name
, u_short var
)
3170 storeAppendPrintf(entry
, "%s %d\n", name
, var
);
3174 free_u_short(u_short
* u
)
3180 parse_u_short(u_short
* var
)
3182 ConfigParser::ParseUShort(var
);
3186 ConfigParser::ParseUShort(u_short
*var
)
3192 ConfigParser::ParseBool(bool *var
)
3194 int i
= GetInteger();
3205 dump_wordlist(StoreEntry
* entry
, const char *name
, wordlist
* list
)
3207 while (list
!= NULL
) {
3208 storeAppendPrintf(entry
, "%s %s\n", name
, list
->key
);
3214 ConfigParser::ParseWordList(wordlist
** list
)
3216 parse_wordlist(list
);
3220 parse_wordlist(wordlist
** list
)
3223 char *t
= strtok(NULL
, "");
3225 while ((token
= strwordtok(NULL
, &t
)))
3226 wordlistAdd(list
, token
);
3229 #if 0 /* now unused */
3231 check_null_wordlist(wordlist
* w
)
3238 check_null_acl_access(acl_access
* a
)
3243 #define free_wordlist wordlistDestroy
3245 #define free_uri_whitespace free_int
3248 parse_uri_whitespace(int *var
)
3250 char *token
= strtok(NULL
, w_space
);
3255 if (!strcasecmp(token
, "strip"))
3256 *var
= URI_WHITESPACE_STRIP
;
3257 else if (!strcasecmp(token
, "deny"))
3258 *var
= URI_WHITESPACE_DENY
;
3259 else if (!strcasecmp(token
, "allow"))
3260 *var
= URI_WHITESPACE_ALLOW
;
3261 else if (!strcasecmp(token
, "encode"))
3262 *var
= URI_WHITESPACE_ENCODE
;
3263 else if (!strcasecmp(token
, "chop"))
3264 *var
= URI_WHITESPACE_CHOP
;
3270 dump_uri_whitespace(StoreEntry
* entry
, const char *name
, int var
)
3274 if (var
== URI_WHITESPACE_ALLOW
)
3276 else if (var
== URI_WHITESPACE_ENCODE
)
3278 else if (var
== URI_WHITESPACE_CHOP
)
3280 else if (var
== URI_WHITESPACE_DENY
)
3285 storeAppendPrintf(entry
, "%s %s\n", name
, s
);
3289 free_removalpolicy(RemovalPolicySettings
** settings
)
3294 free_string(&(*settings
)->type
);
3296 free_wordlist(&(*settings
)->args
);
3304 parse_removalpolicy(RemovalPolicySettings
** settings
)
3307 free_removalpolicy(settings
);
3309 *settings
= new RemovalPolicySettings
;
3311 parse_string(&(*settings
)->type
);
3313 parse_wordlist(&(*settings
)->args
);
3317 dump_removalpolicy(StoreEntry
* entry
, const char *name
, RemovalPolicySettings
* settings
)
3320 storeAppendPrintf(entry
, "%s %s", name
, settings
->type
);
3321 args
= settings
->args
;
3324 storeAppendPrintf(entry
, " %s", args
->key
);
3328 storeAppendPrintf(entry
, "\n");
3332 free_memcachemode(SquidConfig
* config
)
3338 parse_memcachemode(SquidConfig
* config
)
3340 char *token
= strtok(NULL
, w_space
);
3344 if (strcmp(token
, "always") == 0) {
3345 Config
.onoff
.memory_cache_first
= 1;
3346 Config
.onoff
.memory_cache_disk
= 1;
3347 } else if (strcmp(token
, "disk") == 0) {
3348 Config
.onoff
.memory_cache_first
= 0;
3349 Config
.onoff
.memory_cache_disk
= 1;
3350 } else if (strncmp(token
, "net", 3) == 0) {
3351 Config
.onoff
.memory_cache_first
= 1;
3352 Config
.onoff
.memory_cache_disk
= 0;
3353 } else if (strcmp(token
, "never") == 0) {
3354 Config
.onoff
.memory_cache_first
= 0;
3355 Config
.onoff
.memory_cache_disk
= 0;
3361 dump_memcachemode(StoreEntry
* entry
, const char *name
, SquidConfig
&config
)
3363 storeAppendPrintf(entry
, "%s ", name
);
3364 if (Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3365 storeAppendPrintf(entry
, "always");
3366 else if (!Config
.onoff
.memory_cache_first
&& Config
.onoff
.memory_cache_disk
)
3367 storeAppendPrintf(entry
, "disk");
3368 else if (Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3369 storeAppendPrintf(entry
, "network");
3370 else if (!Config
.onoff
.memory_cache_first
&& !Config
.onoff
.memory_cache_disk
)
3371 storeAppendPrintf(entry
, "none");
3372 storeAppendPrintf(entry
, "\n");
3375 #include "cf_parser.cci"
3378 parseNeighborType(const char *s
)
3380 if (!strcasecmp(s
, "parent"))
3383 if (!strcasecmp(s
, "neighbor"))
3384 return PEER_SIBLING
;
3386 if (!strcasecmp(s
, "neighbour"))
3387 return PEER_SIBLING
;
3389 if (!strcasecmp(s
, "sibling"))
3390 return PEER_SIBLING
;
3392 if (!strcasecmp(s
, "multicast"))
3393 return PEER_MULTICAST
;
3395 debugs(15, 0, "WARNING: Unknown neighbor type: " << s
);
3397 return PEER_SIBLING
;
3402 parse_IpAddress_list(Ip::Address_list
** head
)
3405 Ip::Address_list
*s
;
3408 while ((token
= strtok(NULL
, w_space
))) {
3409 if (GetHostWithPort(token
, &ipa
)) {
3412 head
= &(*head
)->next
;
3414 s
= static_cast<Ip::Address_list
*>(xcalloc(1, sizeof(*s
)));
3424 dump_IpAddress_list(StoreEntry
* e
, const char *n
, const Ip::Address_list
* s
)
3426 char ntoabuf
[MAX_IPSTRLEN
];
3429 storeAppendPrintf(e
, "%s %s\n",
3431 s
->s
.NtoA(ntoabuf
,MAX_IPSTRLEN
));
3437 free_IpAddress_list(Ip::Address_list
** head
)
3439 if (*head
) delete *head
;
3443 #if CURRENTLY_UNUSED
3444 /* This code was previously used by http_port. Left as it really should
3445 * be used by icp_port and htcp_port
3448 check_null_IpAddress_list(const Ip::Address_list
* s
)
3453 #endif /* CURRENTLY_UNUSED */
3454 #endif /* USE_WCCPv2 */
3456 CBDATA_CLASS_INIT(http_port_list
);
3459 parse_http_port_specification(http_port_list
* s
, char *token
)
3462 unsigned short port
= 0;
3466 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3467 s
->name
= xstrdup(token
);
3468 s
->connection_auth_disabled
= false;
3470 if (*token
== '[') {
3473 t
= strchr(host
, ']');
3475 debugs(3, 0, "http(s)_port: missing ']' on IPv6 address: " << token
);
3480 debugs(3, 0, "http(s)_port: missing Port in: " << token
);
3483 if (!Ip::EnableIpv6
) {
3484 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: IPv6 is not available.");
3487 port
= xatos(t
+ 1);
3488 } else if ((t
= strchr(token
, ':'))) {
3493 port
= xatos(t
+ 1);
3495 } else if ((port
= strtol(token
, &junk
, 10)), !*junk
) {
3497 debugs(3, 3, "http(s)_port: found Listen on Port: " << port
);
3499 debugs(3, 0, "http(s)_port: missing Port: " << token
);
3504 debugs(3, 0, "http(s)_port: Port cannot be 0: " << token
);
3511 if (!Ip::EnableIpv6
)
3513 debugs(3, 3, "http(s)_port: found Listen on wildcard address: *:" << s
->s
.GetPort() );
3514 } else if ( s
->s
= host
) { /* check/parse numeric IPA */
3516 if (!Ip::EnableIpv6
)
3518 debugs(3, 3, "http(s)_port: Listen on Host/IP: " << host
<< " --> " << s
->s
);
3519 } else if ( s
->s
.GetHostByName(host
) ) { /* check/parse for FQDN */
3520 /* dont use ipcache */
3521 s
->defaultsite
= xstrdup(host
);
3523 if (!Ip::EnableIpv6
)
3525 debugs(3, 3, "http(s)_port: found Listen as Host " << s
->defaultsite
<< " on IP: " << s
->s
);
3527 debugs(3, 0, "http(s)_port: failed to resolve Host/IP: " << host
);
3533 parse_http_port_option(http_port_list
* s
, char *token
)
3537 if (strcmp(token
, "accel") == 0) {
3538 if (s
->intercepted
|| s
->spoof_client_ip
) {
3539 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: Accelerator mode requires its own port. It cannot be shared with other modes.");
3543 } else if (strcmp(token
, "transparent") == 0 || strcmp(token
, "intercept") == 0) {
3544 if (s
->accel
|| s
->spoof_client_ip
) {
3545 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: Intercept mode requires its own interception port. It cannot be shared with other modes.");
3549 Ip::Interceptor
.StartInterception();
3550 /* Log information regarding the port modes under interception. */
3551 debugs(3, DBG_IMPORTANT
, "Starting Authentication on port " << s
->s
);
3552 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (interception enabled)");
3554 /* INET6: until transparent REDIRECT works on IPv6 SOCKET, force wildcard to IPv4 */
3556 debugs(3, DBG_IMPORTANT
, "Disabling IPv6 on port " << s
->s
<< " (interception enabled)");
3557 if ( !s
->s
.SetIPv4() ) {
3558 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: IPv6 addresses cannot be transparent (protocol does not provide NAT)" << s
->s
);
3561 } else if (strcmp(token
, "tproxy") == 0) {
3562 if (s
->intercepted
|| s
->accel
) {
3563 debugs(3,DBG_CRITICAL
, "FATAL: http(s)_port: TPROXY option requires its own interception port. It cannot be shared with other modes.");
3566 s
->spoof_client_ip
= 1;
3567 Ip::Interceptor
.StartTransparency();
3568 /* Log information regarding the port modes under transparency. */
3569 debugs(3, DBG_IMPORTANT
, "Starting IP Spoofing on port " << s
->s
);
3570 debugs(3, DBG_IMPORTANT
, "Disabling Authentication on port " << s
->s
<< " (IP spoofing enabled)");
3572 if (!Ip::Interceptor
.ProbeForTproxy(s
->s
)) {
3573 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: TPROXY support in the system does not work.");
3577 } else if (strncmp(token
, "defaultsite=", 12) == 0) {
3579 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: defaultsite option requires Acceleration mode flag.");
3582 safe_free(s
->defaultsite
);
3583 s
->defaultsite
= xstrdup(token
+ 12);
3584 } else if (strcmp(token
, "vhost") == 0) {
3586 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: vhost option requires Acceleration mode flag.");
3590 } else if (strcmp(token
, "vport") == 0) {
3592 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: vport option requires Acceleration mode flag.");
3596 } else if (strncmp(token
, "vport=", 6) == 0) {
3598 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: vport option requires Acceleration mode flag.");
3601 s
->vport
= xatos(token
+ 6);
3602 } else if (strncmp(token
, "protocol=", 9) == 0) {
3604 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: protocol option requires Acceleration mode flag.");
3607 s
->protocol
= xstrdup(token
+ 9);
3608 } else if (strcmp(token
, "allow-direct") == 0) {
3610 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: vport option requires Acceleration mode flag.");
3613 s
->allow_direct
= 1;
3614 } else if (strcmp(token
, "ignore-cc") == 0) {
3615 #if !USE_HTTP_VIOLATIONS
3617 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: ignore-cc option requires Scceleration mode flag.");
3622 } else if (strncmp(token
, "name=", 5) == 0) {
3624 s
->name
= xstrdup(token
+ 5);
3625 } else if (strcmp(token
, "no-connection-auth") == 0) {
3626 s
->connection_auth_disabled
= true;
3627 } else if (strcmp(token
, "connection-auth=off") == 0) {
3628 s
->connection_auth_disabled
= true;
3629 } else if (strcmp(token
, "connection-auth") == 0) {
3630 s
->connection_auth_disabled
= false;
3631 } else if (strcmp(token
, "connection-auth=on") == 0) {
3632 s
->connection_auth_disabled
= false;
3633 } else if (strncmp(token
, "disable-pmtu-discovery=", 23) == 0) {
3634 if (!strcasecmp(token
+ 23, "off"))
3635 s
->disable_pmtu_discovery
= DISABLE_PMTU_OFF
;
3636 else if (!strcasecmp(token
+ 23, "transparent"))
3637 s
->disable_pmtu_discovery
= DISABLE_PMTU_TRANSPARENT
;
3638 else if (!strcasecmp(token
+ 23, "always"))
3639 s
->disable_pmtu_discovery
= DISABLE_PMTU_ALWAYS
;
3642 } else if (strcmp(token
, "ipv4") == 0) {
3643 if ( !s
->s
.SetIPv4() ) {
3644 debugs(3, DBG_CRITICAL
, "FATAL: http(s)_port: IPv6 addresses cannot be used as IPv4-Only. " << s
->s
);
3647 } else if (strcmp(token
, "tcpkeepalive") == 0) {
3648 s
->tcp_keepalive
.enabled
= 1;
3649 } else if (strncmp(token
, "tcpkeepalive=", 13) == 0) {
3650 char *t
= token
+ 13;
3651 s
->tcp_keepalive
.enabled
= 1;
3652 s
->tcp_keepalive
.idle
= atoi(t
);
3656 s
->tcp_keepalive
.interval
= atoi(t
);
3661 s
->tcp_keepalive
.timeout
= atoi(t
);
3665 } else if (strcasecmp(token
, "sslBump") == 0) {
3666 debugs(3, DBG_CRITICAL
, "WARNING: '" << token
<< "' is deprecated " <<
3667 "in http_port. Use 'ssl-bump' instead.");
3668 s
->sslBump
= 1; // accelerated when bumped, otherwise not
3669 } else if (strcmp(token
, "ssl-bump") == 0) {
3670 s
->sslBump
= 1; // accelerated when bumped, otherwise not
3671 } else if (strncmp(token
, "cert=", 5) == 0) {
3673 s
->cert
= xstrdup(token
+ 5);
3674 } else if (strncmp(token
, "key=", 4) == 0) {
3676 s
->key
= xstrdup(token
+ 4);
3677 } else if (strncmp(token
, "version=", 8) == 0) {
3678 s
->version
= xatoi(token
+ 8);
3679 if (s
->version
< 1 || s
->version
> 4)
3681 } else if (strncmp(token
, "options=", 8) == 0) {
3682 safe_free(s
->options
);
3683 s
->options
= xstrdup(token
+ 8);
3684 } else if (strncmp(token
, "cipher=", 7) == 0) {
3685 safe_free(s
->cipher
);
3686 s
->cipher
= xstrdup(token
+ 7);
3687 } else if (strncmp(token
, "clientca=", 9) == 0) {
3688 safe_free(s
->clientca
);
3689 s
->clientca
= xstrdup(token
+ 9);
3690 } else if (strncmp(token
, "cafile=", 7) == 0) {
3691 safe_free(s
->cafile
);
3692 s
->cafile
= xstrdup(token
+ 7);
3693 } else if (strncmp(token
, "capath=", 7) == 0) {
3694 safe_free(s
->capath
);
3695 s
->capath
= xstrdup(token
+ 7);
3696 } else if (strncmp(token
, "crlfile=", 8) == 0) {
3697 safe_free(s
->crlfile
);
3698 s
->crlfile
= xstrdup(token
+ 8);
3699 } else if (strncmp(token
, "dhparams=", 9) == 0) {
3700 safe_free(s
->dhfile
);
3701 s
->dhfile
= xstrdup(token
+ 9);
3702 } else if (strncmp(token
, "sslflags=", 9) == 0) {
3703 safe_free(s
->sslflags
);
3704 s
->sslflags
= xstrdup(token
+ 9);
3705 } else if (strncmp(token
, "sslcontext=", 11) == 0) {
3706 safe_free(s
->sslContextSessionId
);
3707 s
->sslContextSessionId
= xstrdup(token
+ 11);
3708 } else if (strcmp(token
, "generate-host-certificates") == 0) {
3709 s
->generateHostCertificates
= true;
3710 } else if (strcmp(token
, "generate-host-certificates=on") == 0) {
3711 s
->generateHostCertificates
= true;
3712 } else if (strcmp(token
, "generate-host-certificates=off") == 0) {
3713 s
->generateHostCertificates
= false;
3714 } else if (strncmp(token
, "dynamic_cert_mem_cache_size=", 28) == 0) {
3715 parseBytesOptionValue(&s
->dynamicCertMemCacheSize
, B_BYTES_STR
, token
+ 28);
3722 static http_port_list
*
3723 create_http_port(char *portspec
)
3725 http_port_list
*s
= new http_port_list("http");
3726 parse_http_port_specification(s
, portspec
);
3731 add_http_port(char *portspec
)
3733 http_port_list
*s
= create_http_port(portspec
);
3734 // we may need to merge better of the above returns a list with clones
3735 assert(s
->next
== NULL
);
3736 s
->next
= Config
.Sockaddr
.http
;
3737 Config
.Sockaddr
.http
= s
;
3741 clone_http_port_list(http_port_list
*a
)
3743 http_port_list
*b
= new http_port_list(a
->protocol
);
3747 b
->name
= xstrdup(a
->name
);
3749 b
->defaultsite
= xstrdup(a
->defaultsite
);
3751 b
->intercepted
= a
->intercepted
;
3752 b
->spoof_client_ip
= a
->spoof_client_ip
;
3753 b
->accel
= a
->accel
;
3754 b
->allow_direct
= a
->allow_direct
;
3755 b
->vhost
= a
->vhost
;
3756 b
->sslBump
= a
->sslBump
;
3757 b
->vport
= a
->vport
;
3758 b
->connection_auth_disabled
= a
->connection_auth_disabled
;
3759 b
->disable_pmtu_discovery
= a
->disable_pmtu_discovery
;
3761 memcpy( &(b
->tcp_keepalive
), &(a
->tcp_keepalive
), sizeof(a
->tcp_keepalive
));
3764 // AYJ: 2009-07-18: for now SSL does not clone. Configure separate ports with IPs and SSL settings
3767 // XXX: temporary hack to ease move of SSL options to http_port
3768 http_port_list
&http
;
3781 char *sslContextSessionId
;
3782 SSL_CTX
*sslContext
;
3791 parse_http_port_list(http_port_list
** head
)
3793 char *token
= strtok(NULL
, w_space
);
3800 http_port_list
*s
= create_http_port(token
);
3802 /* parse options ... */
3803 while ((token
= strtok(NULL
, w_space
))) {
3804 parse_http_port_option(s
, token
);
3807 if (Ip::EnableIpv6
&IPV6_SPECIAL_SPLITSTACK
&& s
->s
.IsAnyAddr()) {
3808 // clone the port options from *s to *(s->next)
3809 s
->next
= clone_http_port_list(s
);
3810 s
->next
->s
.SetIPv4();
3811 debugs(3, 3, "http(s)_port: clone wildcard address for split-stack: " << s
->s
<< " and " << s
->next
->s
);
3815 head
= &(*head
)->next
;
3821 dump_generic_http_port(StoreEntry
* e
, const char *n
, const http_port_list
* s
)
3823 char buf
[MAX_IPSTRLEN
];
3825 storeAppendPrintf(e
, "%s %s",
3827 s
->s
.ToURL(buf
,MAX_IPSTRLEN
));
3829 // MODES and specific sub-options.
3831 storeAppendPrintf(e
, " intercept");
3833 else if (s
->spoof_client_ip
)
3834 storeAppendPrintf(e
, " tproxy");
3836 else if (s
->accel
) {
3837 storeAppendPrintf(e
, " accel");
3840 storeAppendPrintf(e
, " vhost");
3843 storeAppendPrintf(e
, " vport");
3844 else if (s
->vport
> 0)
3845 storeAppendPrintf(e
, " vport=%d", s
->vport
);
3848 storeAppendPrintf(e
, " defaultsite=%s", s
->defaultsite
);
3850 if (s
->protocol
&& strcmp(s
->protocol
,"http") != 0)
3851 storeAppendPrintf(e
, " protocol=%s", s
->protocol
);
3853 if (s
->allow_direct
)
3854 storeAppendPrintf(e
, " allow-direct");
3857 storeAppendPrintf(e
, " ignore-cc");
3861 // Generic independent options
3864 storeAppendPrintf(e
, " name=%s", s
->name
);
3866 #if USE_HTTP_VIOLATIONS
3867 if (!s
->accel
&& s
->ignore_cc
)
3868 storeAppendPrintf(e
, " ignore-cc");
3871 if (s
->connection_auth_disabled
)
3872 storeAppendPrintf(e
, " connection-auth=off");
3874 storeAppendPrintf(e
, " connection-auth=on");
3876 if (s
->disable_pmtu_discovery
!= DISABLE_PMTU_OFF
) {
3879 if (s
->disable_pmtu_discovery
== DISABLE_PMTU_ALWAYS
)
3882 pmtu
= "transparent";
3884 storeAppendPrintf(e
, " disable-pmtu-discovery=%s", pmtu
);
3887 if (s
->s
.IsAnyAddr() && !s
->s
.IsIPv6())
3888 storeAppendPrintf(e
, " ipv4");
3890 if (s
->tcp_keepalive
.enabled
) {
3891 if (s
->tcp_keepalive
.idle
|| s
->tcp_keepalive
.interval
|| s
->tcp_keepalive
.timeout
) {
3892 storeAppendPrintf(e
, " tcpkeepalive=%d,%d,%d", s
->tcp_keepalive
.idle
, s
->tcp_keepalive
.interval
, s
->tcp_keepalive
.timeout
);
3894 storeAppendPrintf(e
, " tcpkeepalive");
3900 storeAppendPrintf(e
, " ssl-bump");
3903 storeAppendPrintf(e
, " cert=%s", s
->cert
);
3906 storeAppendPrintf(e
, " key=%s", s
->key
);
3909 storeAppendPrintf(e
, " version=%d", s
->version
);
3912 storeAppendPrintf(e
, " options=%s", s
->options
);
3915 storeAppendPrintf(e
, " cipher=%s", s
->cipher
);
3918 storeAppendPrintf(e
, " cafile=%s", s
->cafile
);
3921 storeAppendPrintf(e
, " capath=%s", s
->capath
);
3924 storeAppendPrintf(e
, " crlfile=%s", s
->crlfile
);
3927 storeAppendPrintf(e
, " dhparams=%s", s
->dhfile
);
3930 storeAppendPrintf(e
, " sslflags=%s", s
->sslflags
);
3932 if (s
->sslContextSessionId
)
3933 storeAppendPrintf(e
, " sslcontext=%s", s
->sslContextSessionId
);
3935 if (s
->generateHostCertificates
)
3936 storeAppendPrintf(e
, " generate-host-certificates");
3938 if (s
->dynamicCertMemCacheSize
!= std::numeric_limits
<size_t>::max())
3939 storeAppendPrintf(e
, "dynamic_cert_mem_cache_size=%lu%s\n", (unsigned long)s
->dynamicCertMemCacheSize
, B_BYTES_STR
);
3944 dump_http_port_list(StoreEntry
* e
, const char *n
, const http_port_list
* s
)
3947 dump_generic_http_port(e
, n
, s
);
3948 storeAppendPrintf(e
, "\n");
3954 free_http_port_list(http_port_list
** head
)
3958 while ((s
= *head
) != NULL
) {
3966 // TODO: merge better with parse_http_port_list
3968 parse_https_port_list(https_port_list
** head
)
3973 token
= strtok(NULL
, w_space
);
3978 s
= new https_port_list
;
3979 parse_http_port_specification(&s
->http
, token
);
3981 /* parse options ... */
3982 while ((token
= strtok(NULL
, w_space
))) {
3983 parse_http_port_option(s
, token
);
3987 http_port_list
** headTmp
= &(*head
)->http
.next
;
3988 head
= (https_port_list
**)headTmp
;
3995 dump_https_port_list(StoreEntry
* e
, const char *n
, const https_port_list
* s
)
3997 dump_http_port_list(e
, n
, s
);
4001 free_https_port_list(https_port_list
** head
)
4003 free_http_port_list((http_port_list
**)head
);
4008 check_null_https_port_list(const https_port_list
* s
)
4015 #endif /* USE_SSL */
4018 configFreeMemory(void)
4022 SSL_CTX_free(Config
.ssl_client
.sslContext
);
4027 requirePathnameExists(const char *name
, const char *path
)
4031 char pathbuf
[BUFSIZ
];
4032 assert(path
!= NULL
);
4034 if (Config
.chroot_dir
&& (geteuid() == 0)) {
4035 snprintf(pathbuf
, BUFSIZ
, "%s/%s", Config
.chroot_dir
, path
);
4039 if (stat(path
, &sb
) < 0) {
4040 debugs(0, DBG_CRITICAL
, (opt_parse_cfg_only
?"FATAL ":"") << "ERROR: " << name
<< " " << path
<< ": " << xstrerror());
4041 // keep going to find more issues if we are only checking the config file with "-k parse"
4042 if (opt_parse_cfg_only
)
4044 // this is fatal if it is found during startup or reconfigure
4045 if (opt_send_signal
== -1 || opt_send_signal
== SIGHUP
)
4046 fatalf("%s %s: %s", name
, path
, xstrerror());
4053 return ConfigParser::strtokFile();
4056 #include "AccessLogEntry.h"
4059 parse_access_log(customlog
** logs
)
4061 const char *filename
, *logdef_name
;
4065 cl
= (customlog
*)xcalloc(1, sizeof(*cl
));
4067 if ((filename
= strtok(NULL
, w_space
)) == NULL
) {
4072 if (strcmp(filename
, "none") == 0) {
4073 cl
->type
= Log::Format::CLF_NONE
;
4077 if ((logdef_name
= strtok(NULL
, w_space
)) == NULL
)
4078 logdef_name
= "squid";
4080 debugs(3, 9, "Log definition name '" << logdef_name
<< "' file '" << filename
<< "'");
4082 cl
->filename
= xstrdup(filename
);
4084 /* look for the definition pointer corresponding to this name */
4085 lf
= Log::TheConfig
.logformats
;
4087 while (lf
!= NULL
) {
4088 debugs(3, 9, "Comparing against '" << lf
->name
<< "'");
4090 if (strcmp(lf
->name
, logdef_name
) == 0)
4097 cl
->type
= Log::Format::CLF_CUSTOM
;
4099 } else if (strcmp(logdef_name
, "auto") == 0) {
4100 debugs(0,0, "WARNING: Log format 'auto' no longer exists. Using 'squid' instead.");
4101 cl
->type
= Log::Format::CLF_SQUID
;
4102 } else if (strcmp(logdef_name
, "squid") == 0) {
4103 cl
->type
= Log::Format::CLF_SQUID
;
4104 } else if (strcmp(logdef_name
, "common") == 0) {
4105 cl
->type
= Log::Format::CLF_COMMON
;
4106 } else if (strcmp(logdef_name
, "combined") == 0) {
4107 cl
->type
= Log::Format::CLF_COMBINED
;
4109 } else if (strcmp(logdef_name
, "icap_squid") == 0) {
4110 cl
->type
= Log::Format::CLF_ICAP_SQUID
;
4112 } else if (strcmp(logdef_name
, "useragent") == 0) {
4113 cl
->type
= Log::Format::CLF_USERAGENT
;
4114 } else if (strcmp(logdef_name
, "referrer") == 0) {
4115 cl
->type
= Log::Format::CLF_REFERER
;
4117 debugs(3, 0, "Log format '" << logdef_name
<< "' is not defined");
4123 aclParseAclList(LegacyParser
, &cl
->aclList
);
4126 logs
= &(*logs
)->next
;
4132 check_null_access_log(customlog
*customlog_definitions
)
4134 return customlog_definitions
== NULL
;
4138 dump_access_log(StoreEntry
* entry
, const char *name
, customlog
* logs
)
4142 for (log
= logs
; log
; log
= log
->next
) {
4143 storeAppendPrintf(entry
, "%s ", name
);
4145 switch (log
->type
) {
4147 case Log::Format::CLF_CUSTOM
:
4148 storeAppendPrintf(entry
, "%s %s", log
->filename
, log
->logFormat
->name
);
4151 case Log::Format::CLF_NONE
:
4152 storeAppendPrintf(entry
, "none");
4155 case Log::Format::CLF_SQUID
:
4156 storeAppendPrintf(entry
, "%s squid", log
->filename
);
4159 case Log::Format::CLF_COMBINED
:
4160 storeAppendPrintf(entry
, "%s combined", log
->filename
);
4163 case Log::Format::CLF_COMMON
:
4164 storeAppendPrintf(entry
, "%s common", log
->filename
);
4168 case Log::Format::CLF_ICAP_SQUID
:
4169 storeAppendPrintf(entry
, "%s icap_squid", log
->filename
);
4172 case Log::Format::CLF_USERAGENT
:
4173 storeAppendPrintf(entry
, "%s useragent", log
->filename
);
4176 case Log::Format::CLF_REFERER
:
4177 storeAppendPrintf(entry
, "%s referrer", log
->filename
);
4180 case Log::Format::CLF_UNKNOWN
:
4185 dump_acl_list(entry
, log
->aclList
);
4187 storeAppendPrintf(entry
, "\n");
4192 free_access_log(customlog
** definitions
)
4194 while (*definitions
) {
4195 customlog
*log
= *definitions
;
4196 *definitions
= log
->next
;
4198 log
->logFormat
= NULL
;
4199 log
->type
= Log::Format::CLF_UNKNOWN
;
4202 aclDestroyAclList(&log
->aclList
);
4204 safe_free(log
->filename
);
4210 /// parses list of integers form name=N1,N2,N3,...
4212 parseNamedIntList(const char *data
, const String
&name
, Vector
<int> &list
)
4214 if (data
&& (strncmp(data
, name
.rawBuf(), name
.size()) == 0)) {
4215 data
+= name
.size();
4220 if (!StringToInt(data
, value
, &data
, 10))
4222 list
.push_back(value
);
4223 if (*data
== '\0' || *data
!= ',')
4228 return data
&& *data
== '\0';
4232 parse_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4234 #if !HAVE_CPU_AFFINITY
4235 debugs(3, DBG_CRITICAL
, "FATAL: Squid built with no CPU affinity " <<
4236 "support, do not set 'cpu_affinity_map'");
4238 #endif /* HAVE_CPU_AFFINITY */
4240 if (!*cpuAffinityMap
)
4241 *cpuAffinityMap
= new CpuAffinityMap
;
4243 const char *const pToken
= strtok(NULL
, w_space
);
4244 const char *const cToken
= strtok(NULL
, w_space
);
4245 Vector
<int> processes
, cores
;
4246 if (!parseNamedIntList(pToken
, "process_numbers", processes
)) {
4247 debugs(3, DBG_CRITICAL
, "FATAL: bad 'process_numbers' parameter " <<
4248 "in 'cpu_affinity_map'");
4250 } else if (!parseNamedIntList(cToken
, "cores", cores
)) {
4251 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cores' parameter in " <<
4252 "'cpu_affinity_map'");
4254 } else if (!(*cpuAffinityMap
)->add(processes
, cores
)) {
4255 debugs(3, DBG_CRITICAL
, "FATAL: bad 'cpu_affinity_map'; " <<
4256 "process_numbers and cores lists differ in length or " <<
4257 "contain numbers <= 0");
4263 dump_CpuAffinityMap(StoreEntry
*const entry
, const char *const name
, const CpuAffinityMap
*const cpuAffinityMap
)
4265 if (cpuAffinityMap
) {
4266 storeAppendPrintf(entry
, "%s process_numbers=", name
);
4267 for (size_t i
= 0; i
< cpuAffinityMap
->processes().size(); ++i
) {
4268 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4269 cpuAffinityMap
->processes()[i
]);
4271 storeAppendPrintf(entry
, " cores=");
4272 for (size_t i
= 0; i
< cpuAffinityMap
->processes().size(); ++i
) {
4273 storeAppendPrintf(entry
, "%s%i", (i
? "," : ""),
4274 cpuAffinityMap
->cores()[i
]);
4276 storeAppendPrintf(entry
, "\n");
4281 free_CpuAffinityMap(CpuAffinityMap
**const cpuAffinityMap
)
4283 delete *cpuAffinityMap
;
4284 *cpuAffinityMap
= NULL
;
4290 parse_adaptation_service_set_type()
4292 Adaptation::Config::ParseServiceSet();
4296 parse_adaptation_service_chain_type()
4298 Adaptation::Config::ParseServiceChain();
4302 parse_adaptation_access_type()
4304 Adaptation::Config::ParseAccess(LegacyParser
);
4307 #endif /* USE_ADAPTATION */
4313 parse_icap_service_type(Adaptation::Icap::Config
* cfg
)
4315 cfg
->parseService();
4319 free_icap_service_type(Adaptation::Icap::Config
* cfg
)
4325 dump_icap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4327 cfg
.dumpService(entry
, name
);
4331 parse_icap_class_type()
4333 debugs(93, 0, "WARNING: 'icap_class' is depricated. " <<
4334 "Use 'adaptation_service_set' instead");
4335 Adaptation::Config::ParseServiceSet();
4339 parse_icap_access_type()
4341 debugs(93, 0, "WARNING: 'icap_access' is depricated. " <<
4342 "Use 'adaptation_access' instead");
4343 Adaptation::Config::ParseAccess(LegacyParser
);
4352 parse_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4354 cfg
->parseService();
4358 free_ecap_service_type(Adaptation::Ecap::Config
* cfg
)
4364 dump_ecap_service_type(StoreEntry
* entry
, const char *name
, const Adaptation::Ecap::Config
&cfg
)
4366 cfg
.dumpService(entry
, name
);
4369 #endif /* USE_ECAP */
4372 static void parse_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4377 cfg
->service_failure_limit
= GetInteger();
4379 if ((token
= strtok(NULL
, w_space
)) == NULL
)
4382 if (strcmp(token
,"in") != 0) {
4383 debugs(3, 0, "expecting 'in' on'" << config_input_line
<< "'");
4387 if ((token
= strtok(NULL
, w_space
)) == NULL
) {
4391 d
= static_cast<time_t> (xatoi(token
));
4393 m
= static_cast<time_t> (1);
4397 else if ((token
= strtok(NULL
, w_space
)) == NULL
) {
4398 debugs(3, 0, "No time-units on '" << config_input_line
<< "'");
4400 } else if ((m
= parseTimeUnits(token
, false)) == 0)
4403 cfg
->oldest_service_failure
= (m
* d
);
4406 static void dump_icap_service_failure_limit(StoreEntry
*entry
, const char *name
, const Adaptation::Icap::Config
&cfg
)
4408 storeAppendPrintf(entry
, "%s %d", name
, cfg
.service_failure_limit
);
4409 if (cfg
.oldest_service_failure
> 0) {
4410 storeAppendPrintf(entry
, " in %d seconds", (int)cfg
.oldest_service_failure
);
4412 storeAppendPrintf(entry
, "\n");
4415 static void free_icap_service_failure_limit(Adaptation::Icap::Config
*cfg
)
4417 cfg
->oldest_service_failure
= 0;
4418 cfg
->service_failure_limit
= 0;