2 * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 #ifndef SQUID_SQUIDCONFIG_H_
10 #define SQUID_SQUIDCONFIG_H_
12 #include "acl/forward.h"
13 #include "base/RefCount.h"
14 #include "base/YesNoNone.h"
15 #include "ClientDelayConfig.h"
16 #include "DelayConfig.h"
17 #include "helper/ChildConfig.h"
18 #include "HttpHeaderTools.h"
19 #include "ip/Address.h"
21 #include "security/forward.h"
22 #include "SquidTime.h"
24 #include "ssl/support.h"
26 #include "store/forward.h"
29 class sslproxy_cert_sign
;
30 class sslproxy_cert_adapt
;
35 class ActionPasswordList
;
43 class RemovalPolicySettings
;
53 RefCount
<SwapDir
> *swapDirs
;
56 /// number of disk processes required to support all cache_dirs
59 #define INDEXSD(i) (Config.cacheSwap.swapDirs[i].getRaw())
62 /// the representation of the configuration. POD.
67 /* These should be for the Store::Root instance.
68 * this needs pluggable parsing to be done smoothly.
74 YesNoNone memShared
; ///< whether the memory cache is shared among workers
75 YesNoNone shmLocking
; ///< shared_memory_locking
84 RemovalPolicySettings
*replPolicy
;
85 RemovalPolicySettings
*memPolicy
;
86 #if USE_HTTP_VIOLATIONS
90 time_t negativeDnsTtl
;
91 time_t positiveDnsTtl
;
92 time_t shutdownLifetime
;
93 time_t backgroundPingRate
;
103 time_t clientIdlePconn
;
104 time_t serverIdlePconn
;
105 time_t ftpClientIdle
;
106 time_t pconnLifetime
; ///< pconn_lifetime in squid.conf
109 time_t request_start_timeout
;
110 int icp_query
; /* msec */
111 int icp_query_max
; /* msec */
112 int icp_query_min
; /* msec */
113 int mcast_icp_query
; /* msec */
114 time_msec_t idns_retransmit
;
115 time_msec_t idns_query
;
118 size_t maxRequestHeaderSize
;
119 int64_t maxRequestBodySize
;
120 size_t maxRequestBufferSize
;
121 size_t maxReplyHeaderSize
;
122 AclSizeLimit
*ReplyBodySize
;
154 Ip::Address_list
*router
;
156 int forwarding_method
;
158 int assignment_method
;
165 char *as_whois_server
;
170 CustomLog
*accesslogs
;
180 char *visible_appname_string
;
181 char *effectiveGroup
;
199 Helper::ChildConfig redirectChildren
;
200 Helper::ChildConfig storeIdChildren
;
206 size_t appendDomainLen
;
209 char *mimeTablePathname
;
211 char *visibleHostname
;
212 char *uniqueHostname
;
213 wordlist
*hostnameAliases
;
225 Ip::Address udp_incoming
;
226 Ip::Address udp_outgoing
;
228 Ip::Address snmp_incoming
;
229 Ip::Address snmp_outgoing
;
231 /* FIXME INET6 : this should really be a CIDR value */
232 Ip::Address client_netmask
;
235 size_t udpMaxHitObjsz
;
236 wordlist
*mcast_group_list
;
237 wordlist
*dns_nameservers
;
252 Mgr::ActionPasswordList
*passwd_list
;
255 int objectsPerBucket
;
256 int64_t avgObjectSize
;
257 int64_t maxObjectSize
;
258 int64_t minObjectSize
;
259 size_t maxInMemObjSize
;
281 int test_reachability
;
282 int half_closed_clients
;
284 #if USE_HTTP_VIOLATIONS
290 int redir_rewrites_host
;
292 int nonhierarchical_direct
;
293 int strip_query_terms
;
294 int redirector_bypass
;
296 int ignore_unknown_nameservers
;
300 #if USE_CACHE_DIGESTS
302 int digest_generation
;
305 int vary_ignore_expire
;
306 int surrogate_is_remote
;
307 int request_entities
;
308 int detect_broken_server_pconns
;
309 int balance_on_multiple_ip
;
310 int relaxed_header_parser
;
312 int allow_underscore
;
314 int cache_miss_revalidate
;
316 int httpd_suppress_version_string
;
317 int global_internal_static
;
318 int collapsed_forwarding
;
320 #if FOLLOW_X_FORWARDED_FOR
321 int acl_uses_indirect_client
;
322 int delay_pool_uses_indirect_client
;
323 int log_uses_indirect_client
;
325 int tproxy_uses_indirect_client
;
327 #endif /* FOLLOW_X_FORWARDED_FOR */
329 int WIN32_IpAddrChangeMonitor
;
330 int memory_cache_first
;
331 int memory_cache_disk
;
332 int hostStrictVerify
;
333 int client_dst_passthru
;
336 bool logTlsServerHelloDetails
;
340 int64_t collapsed_forwarding_shared_entries_limit
;
342 int pipeline_max_prefetch
;
344 int forward_max_tries
;
351 acl_access
*adapted_http
;
354 acl_access
*NeverDirect
;
355 acl_access
*AlwaysDirect
;
359 acl_access
*storeMiss
;
360 acl_access
*stats_collection
;
365 #if USE_HTTP_VIOLATIONS
366 acl_access
*brokenPosts
;
368 acl_access
*redirector
;
369 acl_access
*store_id
;
371 Acl::Address
*outgoing_address
;
375 acl_access
*htcp_clr
;
379 acl_access
*ssl_bump
;
381 #if FOLLOW_X_FORWARDED_FOR
382 acl_access
*followXFF
;
383 #endif /* FOLLOW_X_FORWARDED_FOR */
385 /// acceptible PROXY protocol clients
386 acl_access
*proxyProtocol
;
388 /// spoof_client_ip squid.conf acl.
389 /// nil unless configured
390 acl_access
* spoof_client_ip
;
391 acl_access
*on_unsupported_protocol
;
393 acl_access
*ftp_epsv
;
395 acl_access
*forceRequestBodyContinuation
;
396 acl_access
*serverPconnForNonretriable
;
398 AclDenyInfoList
*denyInfoList
;
411 RefreshPattern
*Refresh
;
413 Store::DiskConfig cacheSwap
;
419 char *errorDirectory
;
421 char *errorDefaultLanguage
;
422 int errorLogMissingLanguages
;
424 char *errorStylesheet
;
436 ClientDelayConfig ClientDelay
;
445 int max_open_disk_fds
;
447 AclSizeLimit
*rangeOffsetLimit
;
448 #if MULTICAST_MISS_STREAM
459 /// request_header_access and request_header_replace
460 HeaderManglers
*request_header_access
;
461 /// reply_header_access and reply_header_replace
462 HeaderManglers
*reply_header_access
;
463 ///request_header_add access list
464 HeaderWithAclList
*request_header_add
;
465 ///reply_header_add access list
466 HeaderWithAclList
*reply_header_add
;
471 #if USE_CACHE_DIGESTS
475 time_t rebuild_period
;
476 time_t rewrite_period
;
477 size_t swapout_chunk_size
;
478 int rebuild_chunk_percentage
;
484 int unclean_shutdown
;
487 size_t sessionCacheSize
;
497 char *store_dir_select_algorithm
;
498 int sleep_after_fork
; /* microseconds */
499 time_t minimum_expiry_time
; /* seconds */
500 external_acl
*externalAclHelperList
;
503 Security::ContextPointer sslContext
;
505 char *foreignIntermediateCertsPath
;
506 acl_access
*cert_error
;
507 sslproxy_cert_sign
*cert_sign
;
508 sslproxy_cert_adapt
*cert_adapt
;
514 int max_filedescriptors
;
516 CpuAffinityMap
*cpuAffinityMap
;
518 #if USE_LOADABLE_MODULES
519 wordlist
*loadable_module_names
;
522 int client_ip_max_connections
;
524 char *redirector_extras
;
526 struct UrlHelperTimeout
{
529 } onUrlRewriteTimeout
;
531 char *storeId_extras
;
534 int v4_first
; ///< Place IPv4 first in the order of DNS results.
535 ssize_t packet_max
; ///< maximum size EDNS advertised for DNS replies.
539 extern SquidConfig Config
;
545 *this = SquidConfig2();
549 int enable_purge
= 0;
551 uid_t effectiveUserID
= 0;
552 gid_t effectiveGroupID
= 0;
555 extern SquidConfig2 Config2
;
557 #endif /* SQUID_SQUIDCONFIG_H_ */