2 * Copyright (C) 1996-2022 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 /* DEBUG: section 04 Error Generation */
12 #include "AccessLogEntry.h"
14 #include "clients/forward.h"
15 #include "comm/Connection.h"
16 #include "comm/Write.h"
17 #include "error/Detail.h"
18 #include "error/SysErrorDetail.h"
19 #include "errorpage.h"
21 #include "format/Format.h"
23 #include "html_quote.h"
24 #include "HttpHeaderTools.h"
25 #include "HttpReply.h"
26 #include "HttpRequest.h"
28 #include "MemObject.h"
30 #include "sbuf/Stream.h"
31 #include "SquidConfig.h"
36 #include "auth/UserRequest.h"
39 #include "ssl/ErrorDetailManager.h"
45 \defgroup ErrorPageInternal Error Page Internals
48 \section ErrorPagesAbstract Abstract:
49 * These routines are used to generate error messages to be
50 * sent to clients. The error type is used to select between
51 * the various message formats. (formats are stored in the
52 * Config.errorDirectory)
55 #if !defined(DEFAULT_SQUID_ERROR_DIR)
56 /** Where to look for errors if config path fails.
57 \note Please use ./configure --datadir=/path instead of patching
59 #define DEFAULT_SQUID_ERROR_DIR DEFAULT_SQUID_DATA_DIR"/errors"
62 /// \ingroup ErrorPageInternal
63 CBDATA_CLASS_INIT(ErrorState
);
65 const SBuf
ErrorState::LogformatMagic("@Squid{");
69 /// an error page created from admin-configurable metadata (e.g. deny_info)
70 class ErrorDynamicPageInfo
{
72 ErrorDynamicPageInfo(const int anId
, const char *aName
, const SBuf
&aCfgLocation
);
73 ~ErrorDynamicPageInfo() { xfree(page_name
); }
75 /// error_text[] index for response body (unused in redirection responses)
78 /// Primary deny_info parameter:
79 /// * May start with an HTTP status code.
80 /// * Either a well-known error page name, a filename, or a redirect URL.
83 /// admin-configured HTTP Location header value for redirection responses
86 /// admin-configured name for the error page template (custom or standard)
89 /// deny_info directive position in squid.conf (for reporting)
92 // XXX: Misnamed. Not just for redirects.
93 /// admin-configured HTTP status code
94 Http::StatusCode page_redirect
;
97 // no copying of any kind
98 ErrorDynamicPageInfo(ErrorDynamicPageInfo
&&) = delete;
101 namespace ErrorPage
{
103 /// state and parameters shared by several ErrorState::compile*() methods
107 SBuf output
; ///< compilation result
108 const char *input
= nullptr; ///< template bytes that need to be compiled
109 bool building_deny_info_url
= false; ///< whether we compile deny_info URI
110 bool allowRecursion
= false; ///< whether top-level compile() calls are OK
113 /// pretty-prints error page/deny_info building error
114 class BuildErrorPrinter
117 BuildErrorPrinter(const SBuf
&anInputLocation
, int aPage
, const char *aMsg
, const char *aNear
): inputLocation(anInputLocation
), page_id(aPage
), msg(aMsg
), near(aNear
) {}
119 /// reports error details (for admin-visible exceptions and debugging)
120 std::ostream
&print(std::ostream
&) const;
122 /// print() helper to report where the error was found
123 std::ostream
&printLocation(std::ostream
&os
) const;
125 /* saved constructor parameters */
126 const SBuf
&inputLocation
;
132 static inline std::ostream
&
133 operator <<(std::ostream
&os
, const BuildErrorPrinter
&context
)
135 return context
.print(os
);
138 static const char *IsDenyInfoUri(const int page_id
);
140 static void ImportStaticErrorText(const int page_id
, const char *text
, const SBuf
&inputLocation
);
141 static void ValidateStaticError(const int page_id
, const SBuf
&inputLocation
);
143 } // namespace ErrorPage
145 /* local constant and vars */
147 /// an error page (or a part of an error page) with hard-coded template text
148 class HardCodedError
{
150 err_type type
; ///< identifies the error (or a special error template part)
151 const char *text
; ///< a string literal containing the error template
154 /// error messages that cannot be configured/customized externally
155 static const std::array
<HardCodedError
, 7> HardCodedErrors
= {
161 "<div id=\"footer\">\n"
162 "Generated %T by %h (%s)\n"
172 "unexpected client disconnect"
175 ERR_SECURE_ACCEPT_FAIL
,
179 ERR_REQUEST_START_TIMEOUT
,
180 "request start timedout"
183 ERR_REQUEST_PARSE_TIMEOUT
,
184 "request parse timedout"
188 "relay server response"
193 /// \ingroup ErrorPageInternal
194 static std::vector
<ErrorDynamicPageInfo
*> ErrorDynamicPages
;
196 /* local prototypes */
198 /// \ingroup ErrorPageInternal
199 static char **error_text
= nullptr;
201 /// \ingroup ErrorPageInternal
202 static int error_page_count
= 0;
204 /// \ingroup ErrorPageInternal
205 static MemBuf error_stylesheet
;
207 static const char *errorFindHardText(err_type type
);
208 static IOCB errorSendComplete
;
210 /// \ingroup ErrorPageInternal
211 /// manages an error page template
212 class ErrorPageFile
: public TemplateFile
215 ErrorPageFile(const char *name
, const err_type code
) : TemplateFile(name
, code
) {}
217 /// The template text data read from disk
218 const char *text() { return template_
.c_str(); }
221 void setDefault() override
{
222 template_
= "Internal Error: Missing Template ";
223 template_
.append(templateName
.termedBuf());
227 /// \ingroup ErrorPageInternal
229 operator++ (err_type
&anErr
)
231 int tmp
= (int)anErr
;
232 anErr
= (err_type
)(++tmp
);
236 /// \ingroup ErrorPageInternal
238 operator -(err_type
const &anErr
, err_type
const &anErr2
)
240 return (int)anErr
- (int)anErr2
;
243 /// \return deny_info URL if the given page is a deny_info page with a URL
244 /// \return nullptr otherwise
246 ErrorPage::IsDenyInfoUri(const int page_id
)
248 if (ERR_MAX
<= page_id
&& page_id
< error_page_count
)
249 return ErrorDynamicPages
.at(page_id
- ERR_MAX
)->uri
; // may be nil
254 errorInitialize(void)
256 using ErrorPage::ImportStaticErrorText
;
260 error_page_count
= ERR_MAX
+ ErrorDynamicPages
.size();
261 error_text
= static_cast<char **>(xcalloc(error_page_count
, sizeof(char *)));
263 for (i
= ERR_NONE
, ++i
; i
< error_page_count
; ++i
) {
264 safe_free(error_text
[i
]);
266 if ((text
= errorFindHardText(i
))) {
268 * Index any hard-coded error text into defaults.
270 static const SBuf
builtIn("built-in");
271 ImportStaticErrorText(i
, text
, builtIn
);
273 } else if (i
< ERR_MAX
) {
275 * Index precompiled fixed template files from one of two sources:
276 * (a) default language translation directory (error_default_language)
277 * (b) admin specified custom directory (error_directory)
279 ErrorPageFile
errTmpl(err_type_str
[i
], i
);
280 errTmpl
.loadDefault();
281 ImportStaticErrorText(i
, errTmpl
.text(), errTmpl
.filename
);
284 * Index any unknown file names used by deny_info.
286 ErrorDynamicPageInfo
*info
= ErrorDynamicPages
.at(i
- ERR_MAX
);
287 assert(info
&& info
->id
== i
&& info
->page_name
);
289 if (info
->filename
) {
290 /** But only if they are not redirection URL. */
291 ErrorPageFile
errTmpl(info
->filename
, ERR_MAX
);
292 errTmpl
.loadDefault();
293 ImportStaticErrorText(i
, errTmpl
.text(), errTmpl
.filename
);
296 ErrorPage::ValidateStaticError(i
, info
->cfgLocation
);
301 error_stylesheet
.reset();
303 // look for and load stylesheet into global MemBuf for it.
304 if (Config
.errorStylesheet
) {
305 ErrorPageFile
tmpl("StylesSheet", ERR_MAX
);
306 tmpl
.loadFromFile(Config
.errorStylesheet
);
307 error_stylesheet
.appendf("%s",tmpl
.text());
311 Ssl::errorDetailInitialize();
321 for (i
= ERR_NONE
+ 1; i
< error_page_count
; ++i
)
322 safe_free(error_text
[i
]);
324 safe_free(error_text
);
327 while (!ErrorDynamicPages
.empty()) {
328 delete ErrorDynamicPages
.back();
329 ErrorDynamicPages
.pop_back();
332 error_page_count
= 0;
335 Ssl::errorDetailClean();
339 /// \ingroup ErrorPageInternal
341 errorFindHardText(err_type type
)
343 for (const auto &m
: HardCodedErrors
) {
350 TemplateFile::TemplateFile(const char *name
, const err_type code
): silent(false), wasLoaded(false), templateName(name
), templateCode(code
)
356 TemplateFile::loadDefault()
358 if (loaded()) // already loaded?
361 /** test error_directory configured location */
362 if (Config
.errorDirectory
) {
363 char path
[MAXPATHLEN
];
364 snprintf(path
, sizeof(path
), "%s/%s", Config
.errorDirectory
, templateName
.termedBuf());
369 /** test error_default_language location */
370 if (!loaded() && Config
.errorDefaultLanguage
) {
371 if (!tryLoadTemplate(Config
.errorDefaultLanguage
)) {
372 debugs(1, (templateCode
< TCP_RESET
? DBG_CRITICAL
: 3), "ERROR: Unable to load default error language files. Reset to backups.");
377 /* test default location if failed (templates == English translation base templates) */
379 tryLoadTemplate("templates");
382 /* giving up if failed */
384 debugs(1, (templateCode
< TCP_RESET
? DBG_CRITICAL
: 3), "WARNING: failed to find or read error text file " << templateName
);
392 TemplateFile::tryLoadTemplate(const char *lang
)
396 char path
[MAXPATHLEN
];
397 /* TODO: prep the directory path string to prevent snprintf ... */
398 snprintf(path
, sizeof(path
), "%s/%s/%s",
399 DEFAULT_SQUID_ERROR_DIR
, lang
, templateName
.termedBuf());
400 path
[MAXPATHLEN
-1] = '\0';
402 if (loadFromFile(path
))
406 if ( strlen(lang
) == 2) {
407 /* TODO glob the error directory for sub-dirs matching: <tag> '-*' */
408 /* use first result. */
409 debugs(4,2, "wildcard fallback errors not coded yet.");
417 TemplateFile::loadFromFile(const char *path
)
423 if (loaded()) // already loaded?
426 fd
= file_open(path
, O_RDONLY
| O_TEXT
);
429 /* with dynamic locale negotiation we may see some failures before a success. */
430 if (!silent
&& templateCode
< TCP_RESET
) {
432 debugs(4, DBG_CRITICAL
, "ERROR: loading file '" << path
<< "': " << xstrerr(xerrno
));
439 while ((len
= FD_READ_METHOD(fd
, buf
, sizeof(buf
))) > 0) {
440 template_
.append(buf
, len
);
446 debugs(4, DBG_CRITICAL
, MYNAME
<< "ERROR: failed to fully read: '" << path
<< "': " << xstrerr(xerrno
));
453 filename
= SBuf(path
);
456 debugs(4, DBG_CRITICAL
, "ERROR: parsing error in template file: " << path
);
465 bool strHdrAcptLangGetItem(const String
&hdr
, char *lang
, int langLen
, size_t &pos
)
467 while (pos
< hdr
.size()) {
469 /* skip any initial whitespace. */
470 while (pos
< hdr
.size() && xisspace(hdr
[pos
]))
474 * Header value format:
475 * - sequence of whitespace delimited tags
476 * - each tag may suffix with ';'.* which we can ignore.
477 * - IFF a tag contains only two characters we can wildcard ANY translations matching: <it> '-'? .*
478 * with preference given to an exact match.
480 bool invalid_byte
= false;
482 while (pos
< hdr
.size() && hdr
[pos
] != ';' && hdr
[pos
] != ',' && !xisspace(hdr
[pos
]) && dt
< (lang
+ (langLen
-1)) ) {
484 #if USE_HTTP_VIOLATIONS
485 // if accepting violations we may as well accept some broken browsers
486 // which may send us the right code, wrong ISO formatting.
491 *dt
= xtolower(hdr
[pos
]);
492 // valid codes only contain A-Z, hyphen (-) and *
493 if (*dt
!= '-' && *dt
!= '*' && (*dt
< 'a' || *dt
> 'z') )
496 ++dt
; // move to next destination byte.
500 *dt
= '\0'; // nul-terminated the filename content string before system use.
502 // if we terminated the tag on garbage or ';' we need to skip to the next ',' or end of header.
503 while (pos
< hdr
.size() && hdr
[pos
] != ',')
506 if (pos
< hdr
.size() && hdr
[pos
] == ',')
509 debugs(4, 9, "STATE: lang=" << lang
<< ", pos=" << pos
<< ", buf='" << ((pos
< hdr
.size()) ? hdr
.substr(pos
,hdr
.size()) : "") << "'");
511 /* if we found anything we might use, try it. */
512 if (*lang
!= '\0' && !invalid_byte
)
519 TemplateFile::loadFor(const HttpRequest
*request
)
524 if (loaded()) // already loaded?
527 if (!request
|| !request
->header
.getList(Http::HdrType::ACCEPT_LANGUAGE
, &hdr
))
531 size_t pos
= 0; // current parsing position in header string
533 debugs(4, 6, "Testing Header: '" << hdr
<< "'");
535 while ( strHdrAcptLangGetItem(hdr
, lang
, 256, pos
) ) {
537 /* wildcard uses the configured default language */
538 if (lang
[0] == '*' && lang
[1] == '\0') {
539 debugs(4, 6, "Found language '" << lang
<< "'. Using configured default.");
543 debugs(4, 6, "Found language '" << lang
<< "', testing for available template");
545 if (tryLoadTemplate(lang
)) {
546 /* store the language we found for the Content-Language reply header */
549 } else if (Config
.errorLogMissingLanguages
) {
550 debugs(4, DBG_IMPORTANT
, "WARNING: Error Pages Missing Language: " << lang
);
560 ErrorDynamicPageInfo::ErrorDynamicPageInfo(const int anId
, const char *aName
, const SBuf
&aCfgLocation
):
562 page_name(xstrdup(aName
)),
565 cfgLocation(aCfgLocation
),
566 page_redirect(static_cast<Http::StatusCode
>(atoi(page_name
)))
568 const char *filenameOrUri
= nullptr;
569 if (xisdigit(*page_name
)) {
570 if (const char *statusCodeEnd
= strchr(page_name
, ':'))
571 filenameOrUri
= statusCodeEnd
+ 1;
573 assert(!page_redirect
);
574 filenameOrUri
= page_name
;
577 // Guessed uri, filename, or both values may be nil or malformed.
578 // They are validated later.
579 if (!page_redirect
) {
580 if (filenameOrUri
&& strchr(filenameOrUri
, ':')) // looks like a URL
583 filename
= filenameOrUri
;
585 else if (page_redirect
/100 == 3) {
586 // redirects imply a URL
589 // non-redirects imply an error page name
590 filename
= filenameOrUri
;
593 const auto info
= this; // source code change reduction hack
594 // TODO: Move and refactor to avoid self_destruct()s in reconfigure.
596 /* WARNING on redirection status:
597 * 2xx are permitted, but not documented officially.
598 * - might be useful for serving static files (PAC etc) in special cases
599 * 3xx require a URL suitable for Location: header.
600 * - the current design does not allow for a Location: URI as well as a local file template
601 * although this possibility is explicitly permitted in the specs.
602 * 4xx-5xx require a local file template.
603 * - sending Location: on these codes with no body is invalid by the specs.
604 * - current result is Squid crashing or XSS problems as dynamic deny_info load random disk files.
605 * - a future redesign of the file loading may result in loading remote objects sent inline as local body.
607 if (info
->page_redirect
== Http::scNone
)
608 ; // special case okay.
609 else if (info
->page_redirect
< 200 || info
->page_redirect
> 599) {
611 debugs(0, DBG_CRITICAL
, "FATAL: status " << info
->page_redirect
<< " is not valid on '" << page_name
<< "'");
613 } else if ( /* >= 200 && */ info
->page_redirect
< 300 && strchr(&(page_name
[4]), ':')) {
614 // 2xx require a local template file
615 debugs(0, DBG_CRITICAL
, "FATAL: status " << info
->page_redirect
<< " requires a template on '" << page_name
<< "'");
617 } else if (info
->page_redirect
>= 300 && info
->page_redirect
<= 399 && !strchr(&(page_name
[4]), ':')) {
618 // 3xx require an absolute URL
619 debugs(0, DBG_CRITICAL
, "FATAL: status " << info
->page_redirect
<< " requires a URL on '" << page_name
<< "'");
621 } else if (info
->page_redirect
>= 400 /* && <= 599 */ && strchr(&(page_name
[4]), ':')) {
622 // 4xx/5xx require a local template file
623 debugs(0, DBG_CRITICAL
, "FATAL: status " << info
->page_redirect
<< " requires a template on '" << page_name
<< "'");
629 /// \ingroup ErrorPageInternal
631 errorPageId(const char *page_name
)
633 for (int i
= 0; i
< ERR_MAX
; ++i
) {
634 if (strcmp(err_type_str
[i
], page_name
) == 0)
638 for (size_t j
= 0; j
< ErrorDynamicPages
.size(); ++j
) {
639 if (strcmp(ErrorDynamicPages
[j
]->page_name
, page_name
) == 0)
647 errorReservePageId(const char *page_name
, const SBuf
&cfgLocation
)
649 int id
= errorPageId(page_name
);
651 if (id
== ERR_NONE
) {
652 id
= ERR_MAX
+ ErrorDynamicPages
.size();
653 const auto info
= new ErrorDynamicPageInfo(id
, page_name
, cfgLocation
);
654 ErrorDynamicPages
.push_back(info
);
660 /// \ingroup ErrorPageInternal
662 errorPageName(int pageId
)
664 if (pageId
>= ERR_NONE
&& pageId
< ERR_MAX
) /* common case */
665 return err_type_str
[pageId
];
667 if (pageId
>= ERR_MAX
&& pageId
- ERR_MAX
< (ssize_t
)ErrorDynamicPages
.size())
668 return ErrorDynamicPages
[pageId
- ERR_MAX
]->page_name
;
670 return "ERR_UNKNOWN"; /* should not happen */
674 ErrorState::NewForwarding(err_type type
, HttpRequestPointer
&request
, const AccessLogEntry::Pointer
&ale
)
676 const Http::StatusCode status
= (request
&& request
->flags
.needValidation
) ?
677 Http::scGatewayTimeout
: Http::scServiceUnavailable
;
678 return new ErrorState(type
, status
, request
.getRaw(), ale
);
681 ErrorState::ErrorState(err_type t
) :
688 ErrorState::ErrorState(err_type t
, Http::StatusCode status
, HttpRequest
* req
, const AccessLogEntry::Pointer
&anAle
) :
691 if (page_id
>= ERR_MAX
&& ErrorDynamicPages
[page_id
- ERR_MAX
]->page_redirect
!= Http::scNone
)
692 httpStatus
= ErrorDynamicPages
[page_id
- ERR_MAX
]->page_redirect
;
698 src_addr
= req
->client_addr
;
704 ErrorState::ErrorState(HttpRequest
* req
, HttpReply
*errorReply
) :
705 ErrorState(ERR_RELAY_REMOTE
)
708 response_
= errorReply
;
709 httpStatus
= errorReply
->sline
.status();
713 src_addr
= req
->client_addr
;
718 errorAppendEntry(StoreEntry
* entry
, ErrorState
* err
)
720 assert(entry
->mem_obj
!= nullptr);
721 assert (entry
->isEmpty());
722 debugs(4, 4, "storing " << err
<< " in " << *entry
);
724 if (entry
->store_status
!= STORE_PENDING
) {
725 debugs(4, 2, "Skipping error page due to store_status: " << entry
->store_status
);
727 * If the entry is not STORE_PENDING, then no clients
728 * care about it, and we don't need to generate an
731 assert(EBIT_TEST(entry
->flags
, ENTRY_ABORTED
));
732 assert(entry
->mem_obj
->nclients
== 0);
737 if (err
->page_id
== TCP_RESET
) {
739 debugs(4, 2, "RSTing this reply");
740 err
->request
->flags
.resetTcp
= true;
744 entry
->storeErrorResponse(err
->BuildHttpReply());
749 errorSend(const Comm::ConnectionPointer
&conn
, ErrorState
* err
)
751 debugs(4, 3, conn
<< ", err=" << err
);
752 assert(Comm::IsConnOpen(conn
));
754 HttpReplyPointer
rep(err
->BuildHttpReply());
756 MemBuf
*mb
= rep
->pack();
757 AsyncCall::Pointer call
= commCbCall(78, 5, "errorSendComplete",
758 CommIoCbPtrFun(&errorSendComplete
, err
));
759 Comm::Write(conn
, mb
, call
);
764 \ingroup ErrorPageAPI
766 * Called by commHandleWrite() after data has been written
767 * to the client socket.
769 \note If there is a callback, the callback is responsible for
770 * closing the FD, otherwise we do it ourselves.
773 errorSendComplete(const Comm::ConnectionPointer
&conn
, char *, size_t size
, Comm::Flag errflag
, int, void *data
)
775 ErrorState
*err
= static_cast<ErrorState
*>(data
);
776 debugs(4, 3, conn
<< ", size=" << size
);
778 if (errflag
!= Comm::ERR_CLOSING
) {
780 debugs(4, 3, "errorSendComplete: callback");
781 err
->callback(conn
->fd
, err
->callback_data
, size
);
783 debugs(4, 3, "errorSendComplete: comm_close");
791 ErrorState::~ErrorState()
793 safe_free(redirect_url
);
795 safe_free(request_hdrs
);
796 wordlistDestroy(&ftp
.server_msg
);
797 safe_free(ftp
.request
);
798 safe_free(ftp
.reply
);
801 if (err_language
!= Config
.errorDefaultLanguage
)
803 safe_free(err_language
);
807 ErrorState::Dump(MemBuf
* mb
)
810 char ntoabuf
[MAX_IPSTRLEN
];
813 /* email subject line */
814 str
.appendf("CacheErrorInfo - %s", errorPageName(type
));
815 mb
->appendf("?subject=%s", rfc1738_escape_part(str
.buf
));
818 str
.appendf("CacheHost: %s\r\n", getMyHostname());
820 str
.appendf("ErrPage: %s\r\n", errorPageName(type
));
823 str
.appendf("Err: (%d) %s\r\n", xerrno
, strerror(xerrno
));
825 str
.append("Err: [none]\r\n", 13);
828 if (auth_user_request
.getRaw() && auth_user_request
->denyMessage())
829 str
.appendf("Auth ErrMsg: %s\r\n", auth_user_request
->denyMessage());
831 if (dnsError
.size() > 0)
832 str
.appendf("DNS ErrMsg: %s\r\n", dnsError
.termedBuf());
835 str
.appendf("TimeStamp: %s\r\n\r\n", Time::FormatRfc1123(squid_curtime
));
838 str
.appendf("ClientIP: %s\r\n", src_addr
.toStr(ntoabuf
,MAX_IPSTRLEN
));
840 if (request
&& request
->hier
.host
[0] != '\0') {
841 str
.appendf("ServerIP: %s\r\n", request
->hier
.host
);
844 str
.append("\r\n", 2);
846 str
.append("HTTP Request:\r\n", 15);
848 str
.appendf(SQUIDSBUFPH
" " SQUIDSBUFPH
" %s/%d.%d\n",
849 SQUIDSBUFPRINT(request
->method
.image()),
850 SQUIDSBUFPRINT(request
->url
.path()),
851 AnyP::ProtocolType_str
[request
->http_ver
.protocol
],
852 request
->http_ver
.major
, request
->http_ver
.minor
);
853 request
->header
.packInto(&str
);
856 str
.append("\r\n", 2);
860 str
.appendf("FTP Request: %s\r\n", ftp
.request
);
861 str
.appendf("FTP Reply: %s\r\n", (ftp
.reply
? ftp
.reply
:"[none]"));
862 str
.append("FTP Msg: ", 9);
863 wordlistCat(ftp
.server_msg
, &str
);
864 str
.append("\r\n", 2);
867 str
.append("\r\n", 2);
868 mb
->appendf("&body=%s", rfc1738_escape_part(str
.buf
));
873 /// \ingroup ErrorPageInternal
874 #define CVT_BUF_SZ 512
877 ErrorState::compileLogformatCode(Build
&build
)
879 assert(LogformatMagic
.cmp(build
.input
, LogformatMagic
.length()) == 0);
882 const auto logformat
= build
.input
+ LogformatMagic
.length();
884 // Logformat supports undocumented "external" encoding specifications
885 // like [%>h] or "%<a". To preserve the possibility of extending
886 // @Squid{} syntax to non-logformat sequences, we require logformat
887 // sequences to start with '%'. This restriction does not limit
888 // logformat quoting abilities. TODO: Deprecate "external" encoding?
889 if (*logformat
!= '%')
890 throw TexcHere("logformat expressions that do not start with % are not supported");
892 static MemBuf result
;
894 const auto logformatLen
= Format::AssembleOne(logformat
, result
, ale
);
895 assert(logformatLen
> 0);
896 const auto closure
= logformat
+ logformatLen
;
898 throw TexcHere("Missing closing brace (})");
899 build
.output
.append(result
.content(), result
.contentSize());
900 build
.input
= closure
+ 1;
903 noteBuildError("Bad @Squid{logformat} sequence", build
.input
);
906 // we cannot recover reliably so stop interpreting the rest of input
907 const auto remainingSize
= strlen(build
.input
);
908 build
.output
.append(build
.input
, remainingSize
);
909 build
.input
+= remainingSize
;
913 ErrorState::compileLegacyCode(Build
&build
)
916 const char *p
= nullptr; /* takes priority over mb if set */
918 int no_urlescape
= 0; /* if true then item is NOT to be further URL-encoded */
919 char ntoabuf
[MAX_IPSTRLEN
];
923 const auto &building_deny_info_url
= build
.building_deny_info_url
; // a change reduction hack
925 const auto letter
= build
.input
[1];
931 if (request
&& request
->auth_user_request
)
932 p
= request
->auth_user_request
->username();
939 // TODO: When/if we get ALE here, pass it as well
940 if (const auto addr
= FindListeningPortAddress(request
.getRaw(), nullptr))
941 mb
.appendf("%s", addr
->toStr(ntoabuf
, MAX_IPSTRLEN
));
947 mb
.appendf("%u", getMyPort());
951 if (building_deny_info_url
) break;
953 const SBuf
&tmp
= Ftp::UrlWith2f(request
.getRaw());
954 mb
.append(tmp
.rawContent(), tmp
.length());
960 if (building_deny_info_url
) break;
961 p
= errorPageName(type
);
965 if (!build
.allowRecursion
)
966 p
= "%D"; // if recursion is not allowed, do not convert
968 auto rawDetail
= detail
->verbose(request
);
969 // XXX: Performance regression. c_str() reallocates
970 const auto compiledDetail
= compileBody(rawDetail
.c_str(), false);
971 mb
.append(compiledDetail
.rawContent(), compiledDetail
.length());
974 if (!mb
.contentSize())
975 mb
.append("[No Error Detail]", 17);
979 mb
.appendf("%d", xerrno
);
984 mb
.appendf("(%d) %s", xerrno
, strerror(xerrno
));
986 mb
.append("[No Error]", 10);
990 if (building_deny_info_url
) break;
991 /* FTP REQUEST LINE */
999 if (building_deny_info_url
) break;
1000 /* FTP REPLY LINE */
1008 if (building_deny_info_url
) break;
1009 /* FTP SERVER RESPONSE */
1011 mb
.append(ftp
.listing
->content(), ftp
.listing
->contentSize());
1013 } else if (ftp
.server_msg
) {
1014 wordlistCat(ftp
.server_msg
, &mb
);
1019 mb
.appendf("%s", getMyHostname());
1024 if (request
->hier
.host
[0] != '\0') // if non-empty string.
1025 p
= request
->hier
.host
;
1027 p
= request
->url
.host();
1028 } else if (!building_deny_info_url
)
1029 p
= "[unknown host]";
1033 mb
.appendf("%s", src_addr
.toStr(ntoabuf
,MAX_IPSTRLEN
));
1037 if (request
&& request
->hier
.tcpServer
)
1038 p
= request
->hier
.tcpServer
->remote
.toStr(ntoabuf
,MAX_IPSTRLEN
);
1039 else if (!building_deny_info_url
)
1044 if (building_deny_info_url
) break;
1045 mb
.append(error_stylesheet
.content(), error_stylesheet
.contentSize());
1050 if (building_deny_info_url
) break;
1051 if (Config
.errHtmlText
) {
1052 mb
.appendf("%s", Config
.errHtmlText
);
1055 p
= "[not available]";
1059 if (building_deny_info_url
) break;
1061 if (auth_user_request
.getRaw())
1062 p
= auth_user_request
->denyMessage("[not available]");
1064 p
= "[not available]";
1072 const SBuf
&m
= request
->method
.image();
1073 mb
.append(m
.rawContent(), m
.length());
1074 } else if (!building_deny_info_url
)
1075 p
= "[unknown method]";
1079 if (!building_deny_info_url
)
1083 p
= request
? request
->extacl_message
.termedBuf() : external_acl_message
;
1084 if (!p
&& !building_deny_info_url
)
1085 p
= "[not available]";
1090 mb
.appendf("%u", request
->url
.port());
1091 } else if (!building_deny_info_url
) {
1092 p
= "[unknown port]";
1098 const SBuf
&m
= request
->url
.getScheme().image();
1099 mb
.append(m
.rawContent(), m
.length());
1100 } else if (!building_deny_info_url
) {
1101 p
= "[unknown protocol]";
1106 if (building_deny_info_url
) {
1107 if (request
!= nullptr) {
1108 const SBuf
&tmp
= request
->url
.path();
1109 mb
.append(tmp
.rawContent(), tmp
.length());
1116 mb
.appendf(SQUIDSBUFPH
" " SQUIDSBUFPH
" %s/%d.%d\n",
1117 SQUIDSBUFPRINT(request
->method
.image()),
1118 SQUIDSBUFPRINT(request
->url
.path()),
1119 AnyP::ProtocolType_str
[request
->http_ver
.protocol
],
1120 request
->http_ver
.major
, request
->http_ver
.minor
);
1121 request
->header
.packInto(&mb
, true); //hide authorization data
1122 } else if (request_hdrs
) {
1130 /* for backward compat we make %s show the full URL. Drop this in some future release. */
1131 if (building_deny_info_url
) {
1133 const SBuf
&tmp
= request
->effectiveRequestUri();
1134 mb
.append(tmp
.rawContent(), tmp
.length());
1137 debugs(0, DBG_CRITICAL
, "WARNING: deny_info now accepts coded tags. Use %u to get the full URL instead of %s");
1139 p
= visible_appname_string
;
1143 if (building_deny_info_url
) {
1144 p
= visible_appname_string
;
1147 /* signature may contain %-escapes, recursion */
1148 if (page_id
!= ERR_SQUID_SIGNATURE
) {
1149 const int saved_id
= page_id
;
1150 page_id
= ERR_SQUID_SIGNATURE
;
1151 const auto signature
= buildBody();
1152 mb
.append(signature
.rawContent(), signature
.length());
1156 /* wow, somebody put %S into ERR_SIGNATURE, stop recursion */
1162 mb
.appendf("%s", Time::FormatHttpd(squid_curtime
));
1166 mb
.appendf("%s", Time::FormatRfc1123(squid_curtime
));
1170 /* Using the fake-https version of absolute-URI so error pages see https:// */
1171 /* even when the url-path cannot be shown as more than '*' */
1173 p
= urlCanonicalFakeHttps(request
.getRaw());
1176 else if (!building_deny_info_url
)
1182 const SBuf
&tmp
= request
->effectiveRequestUri();
1183 mb
.append(tmp
.rawContent(), tmp
.length());
1186 else if (!building_deny_info_url
)
1191 if (Config
.adminEmail
)
1192 mb
.appendf("%s", Config
.adminEmail
);
1193 else if (!building_deny_info_url
)
1198 if (building_deny_info_url
) break;
1199 if (Config
.adminEmail
&& Config
.onoff
.emailErrData
)
1206 const auto brief
= detail
->brief();
1207 mb
.append(brief
.rawContent(), brief
.length());
1208 } else if (!building_deny_info_url
) {
1209 p
= "[Unknown Error Code]";
1214 if (building_deny_info_url
) break;
1215 if (dnsError
.size() > 0)
1216 p
= dnsError
.termedBuf();
1217 else if (ftp
.cwd_msg
)
1224 if (building_deny_info_url
) break;
1236 if (building_deny_info_url
)
1237 bypassBuildErrorXXX("Unsupported deny_info %code", build
.input
);
1238 else if (letter
!= ';')
1239 bypassBuildErrorXXX("Unsupported error page %code", build
.input
);
1240 // else too many "font-size: 100%;" template errors to report
1242 mb
.append(build
.input
, 2);
1248 p
= mb
.buf
; /* do not use mb after this assignment! */
1252 debugs(4, 3, "%" << letter
<< " --> '" << p
<< "'" );
1257 if (building_deny_info_url
&& !no_urlescape
)
1258 p
= rfc1738_escape_part(p
);
1260 // TODO: Optimize by replacing mb with direct build.output usage.
1261 build
.output
.append(p
, strlen(p
));
1266 ErrorState::validate()
1268 if (const auto urlTemplate
= ErrorPage::IsDenyInfoUri(page_id
)) {
1269 (void)compile(urlTemplate
, true, true);
1271 assert(page_id
> ERR_NONE
);
1272 assert(page_id
< error_page_count
);
1273 (void)compileBody(error_text
[page_id
], true);
1278 ErrorState::BuildHttpReply()
1281 return response_
.getRaw();
1283 HttpReply
*rep
= new HttpReply
;
1284 const char *name
= errorPageName(page_id
);
1285 /* no LMT for error pages; error pages expire immediately */
1287 if (const auto urlTemplate
= ErrorPage::IsDenyInfoUri(page_id
)) {
1289 Http::StatusCode status
= Http::scFound
;
1290 // Use configured 3xx reply status if set.
1292 status
= httpStatus
;
1294 // Use 307 for HTTP/1.1 non-GET/HEAD requests.
1295 if (request
&& request
->method
!= Http::METHOD_GET
&& request
->method
!= Http::METHOD_HEAD
&& request
->http_ver
>= Http::ProtocolVersion(1,1))
1296 status
= Http::scTemporaryRedirect
;
1299 rep
->setHeaders(status
, nullptr, "text/html;charset=utf-8", 0, 0, -1);
1302 auto location
= compile(urlTemplate
, true, true);
1303 rep
->header
.putStr(Http::HdrType::LOCATION
, location
.c_str());
1306 httpHeaderPutStrf(&rep
->header
, Http::HdrType::X_SQUID_ERROR
, "%d %s", httpStatus
, "Access Denied");
1308 const auto body
= buildBody();
1309 rep
->setHeaders(httpStatus
, nullptr, "text/html;charset=utf-8", body
.length(), 0, -1);
1311 * include some information for downstream caches. Implicit
1312 * replaceable content. This isn't quite sufficient. xerrno is not
1313 * necessarily meaningful to another system, so we really should
1314 * expand it. Additionally, we should identify ourselves. Someone
1315 * might want to know. Someone _will_ want to know OTOH, the first
1316 * X-CACHE-MISS entry should tell us who.
1318 httpHeaderPutStrf(&rep
->header
, Http::HdrType::X_SQUID_ERROR
, "%s %d", name
, xerrno
);
1322 * If error page auto-negotiate is enabled in any way, send the Vary.
1323 * RFC 2616 section 13.6 and 14.44 says MAY and SHOULD do this.
1324 * We have even better reasons though:
1325 * see http://wiki.squid-cache.org/KnowledgeBase/VaryNotCaching
1327 if (!Config
.errorDirectory
) {
1328 /* We 'negotiated' this ONLY from the Accept-Language. */
1329 static const SBuf
acceptLanguage("Accept-Language");
1330 rep
->header
.updateOrAddStr(Http::HdrType::VARY
, acceptLanguage
);
1333 /* add the Content-Language header according to RFC section 14.12 */
1335 rep
->header
.putStr(Http::HdrType::CONTENT_LANGUAGE
, err_language
);
1337 #endif /* USE_ERROR_LOCALES */
1339 /* default templates are in English */
1340 /* language is known unless error_directory override used */
1341 if (!Config
.errorDirectory
)
1342 rep
->header
.putStr(Http::HdrType::CONTENT_LANGUAGE
, "en");
1345 rep
->body
.set(body
);
1348 // Make sure error codes get back to the client side for logging and
1352 request
->detailError(type
, detail
);
1354 request
->detailError(type
, SysErrorDetail::NewIfAny(xerrno
));
1361 ErrorState::buildBody()
1363 assert(page_id
> ERR_NONE
&& page_id
< error_page_count
);
1366 /** error_directory option in squid.conf overrides translations.
1367 * Custom errors are always found either in error_directory or the templates directory.
1368 * Otherwise locate the Accept-Language header
1370 if (!Config
.errorDirectory
&& page_id
< ERR_MAX
) {
1371 if (err_language
&& err_language
!= Config
.errorDefaultLanguage
)
1372 safe_free(err_language
);
1374 ErrorPageFile
localeTmpl(err_type_str
[page_id
], static_cast<err_type
>(page_id
));
1375 if (localeTmpl
.loadFor(request
.getRaw())) {
1376 inputLocation
= localeTmpl
.filename
;
1377 assert(localeTmpl
.language());
1378 err_language
= xstrdup(localeTmpl
.language());
1379 return compileBody(localeTmpl
.text(), true);
1382 #endif /* USE_ERR_LOCALES */
1385 * If client-specific error templates are not enabled or available.
1386 * fall back to the old style squid.conf settings.
1389 if (!Config
.errorDirectory
)
1390 err_language
= Config
.errorDefaultLanguage
;
1392 debugs(4, 2, "No existing error page language negotiated for " << this << ". Using default error file.");
1393 return compileBody(error_text
[page_id
], true);
1397 ErrorState::compileBody(const char *input
, bool allowRecursion
)
1399 return compile(input
, false, allowRecursion
);
1403 ErrorState::compile(const char *input
, bool building_deny_info_url
, bool allowRecursion
)
1408 build
.building_deny_info_url
= building_deny_info_url
;
1409 build
.allowRecursion
= allowRecursion
;
1410 build
.input
= input
;
1412 auto blockStart
= build
.input
;
1413 while (const auto letter
= *build
.input
) {
1414 if (letter
== '%') {
1415 build
.output
.append(blockStart
, build
.input
- blockStart
);
1416 compileLegacyCode(build
);
1417 blockStart
= build
.input
;
1419 else if (letter
== '@' && LogformatMagic
.cmp(build
.input
, LogformatMagic
.length()) == 0) {
1420 build
.output
.append(blockStart
, build
.input
- blockStart
);
1421 compileLogformatCode(build
);
1422 blockStart
= build
.input
;
1427 build
.output
.append(blockStart
, build
.input
- blockStart
);
1428 return build
.output
;
1431 /// react to a compile() error
1432 /// \param msg description of what went wrong
1433 /// \param near approximate start of the problematic input
1434 /// \param forceBypass whether detection of this error was introduced late,
1435 /// after old configurations containing this error could have been
1436 /// successfully validated and deployed (i.e. the admin may not be
1437 /// able to fix this newly detected but old problem quickly)
1439 ErrorState::noteBuildError_(const char *msg
, const char *near
, const bool forceBypass
)
1441 using ErrorPage::BuildErrorPrinter
;
1442 const auto runtime
= !starting_up
;
1443 if (runtime
|| forceBypass
) {
1444 // swallow this problem because the admin may not be (and/or the page
1445 // building code is not) ready to handle throwing consequences
1447 static unsigned int seenErrors
= 0;
1450 const auto debugLevel
=
1451 (seenErrors
> 100) ? DBG_DATA
:
1452 (starting_up
|| reconfiguring
) ? DBG_CRITICAL
:
1453 3; // most other errors have been reported as configuration errors
1455 // Error fatality depends on the error context: Reconfiguration errors
1456 // are, like startup ones, DBG_CRITICAL but will never become FATAL.
1457 if (starting_up
&& seenErrors
<= 10)
1458 debugs(4, debugLevel
, "WARNING: The following configuration error will be fatal in future Squid versions");
1460 debugs(4, debugLevel
, "ERROR: " << BuildErrorPrinter(inputLocation
, page_id
, msg
, near
));
1462 throw TexcHere(ToSBuf(BuildErrorPrinter(inputLocation
, page_id
, msg
, near
)));
1466 /* ErrorPage::BuildErrorPrinter */
1469 ErrorPage::BuildErrorPrinter::printLocation(std::ostream
&os
) const {
1470 if (!inputLocation
.isEmpty())
1471 return os
<< inputLocation
;
1473 if (page_id
< ERR_NONE
|| page_id
>= error_page_count
)
1474 return os
<< "[error page " << page_id
<< "]"; // should not happen
1476 if (page_id
< ERR_MAX
)
1477 return os
<< err_type_str
[page_id
];
1479 return os
<< "deny_info " << ErrorDynamicPages
.at(page_id
- ERR_MAX
)->page_name
;
1483 ErrorPage::BuildErrorPrinter::print(std::ostream
&os
) const {
1484 printLocation(os
) << ": " << msg
<< " near ";
1486 // TODO: Add support for prefix printing to Raw
1487 const size_t maxContextLength
= 15; // plus "..."
1488 if (strlen(near
) > maxContextLength
) {
1489 os
.write(near
, maxContextLength
);
1495 // XXX: We should not be converting (inner) exception to text if we are
1496 // going to throw again. See "add arbitrary (re)thrower-supplied details"
1497 // TODO in TextException.h for a long-term in-catcher solution.
1498 if (std::current_exception())
1499 os
<< "\n additional info: " << CurrentException
;
1504 /// add error page template to the global index
1506 ErrorPage::ImportStaticErrorText(const int page_id
, const char *text
, const SBuf
&inputLocation
)
1508 assert(!error_text
[page_id
]);
1509 error_text
[page_id
] = xstrdup(text
);
1510 ValidateStaticError(page_id
, inputLocation
);
1513 /// validate static error page
1515 ErrorPage::ValidateStaticError(const int page_id
, const SBuf
&inputLocation
)
1517 // Supplying nil ALE pointer limits validation to logformat %code
1518 // recognition by Format::Token::parse(). This is probably desirable
1519 // because actual %code assembly is slow and should not affect validation
1520 // when our ALE cannot have any real data (this code is not associated
1521 // with any real transaction).
1522 ErrorState
anErr(err_type(page_id
), Http::scNone
, nullptr, nullptr);
1523 anErr
.inputLocation
= inputLocation
;
1528 operator <<(std::ostream
&os
, const ErrorState
*err
)
1531 os
<< errorPageName(err
->page_id
);