#include "rfc1738.h"
#include "SquidString.h"
-HelperReply::HelperReply(char *buf, size_t len, bool urlQuoting) :
+HelperReply::HelperReply(char *buf, size_t len) :
result(HelperReply::Unknown),
whichServer(NULL)
{
- parse(buf,len,urlQuoting);
+ parse(buf,len);
}
void
-HelperReply::parse(char *buf, size_t len, bool urlQuoting)
+HelperReply::parse(char *buf, size_t len)
{
// check we have something to parse
if (!buf || len < 1) {
// NULL-terminate so the helper callback handlers do not buffer-overrun
other_.terminate();
- parseResponseKeys(urlQuoting);
+ parseResponseKeys();
// Hack for backward-compatibility: BH used to be a text message...
if (other().hasContent() && result == HelperReply::BrokenHelper) {
}
void
-HelperReply::parseResponseKeys(bool urlQuotingValues)
+HelperReply::parseResponseKeys()
{
// parse a "key=value" pair off the 'other()' buffer.
while(other().hasContent()) {
String key(other().content());
// the value may be a quoted string or a token
- // XXX: eww. update strwordtok() to be zero-copy
+ const bool urlDecode = (*p != '"'); // check before moving p.
char *v = strwordtok(NULL, &p);
- if (v != NULL && (p-v) > 2) // 1-octet %-escaped requires 3 bytes
+ if (v != NULL && urlDecode && (p-v) > 2) // 1-octet %-escaped requires 3 bytes
rfc1738_unescape(v);
String value = v;
// create/parse details from the msg buffer provided
// XXX: buf should be const but parse() needs non-const for now
- HelperReply(char *buf, size_t len, bool urlQuoting = false);
+ HelperReply(char *buf, size_t len);
const MemBuf &other() const { return other_; }
* line := [ result ] *#( key-pair )
* key-pair := OWS token '=' ( quoted-string | token )
*
- * \param urlQuoting decode note values using RFC 1738 decoder. (default: use quoted-string instead)
+ * token are URL-decoded.
+ * quoted-string are \-escape decoded and the quotes are stripped.
*/
// XXX: buf should be const but we may need strwordtok() and rfc1738_unescape()
- void parse(char *buf, size_t len, bool urlQuoting = false);
+ void parse(char *buf, size_t len);
public:
/// The helper response 'result' field.
CbcPointer<helper_stateful_server> whichServer;
private:
- void parseResponseKeys(bool urlQuotingValues);
+ void parseResponseKeys();
/// the remainder of the line
MemBuf other_;
General result syntax:
- OK/ERR keyword=value ...
+ [channel-ID] OK/ERR/BH keyword=value ...
Defined keywords:
user= The users name (login)
password= The users password (for login= cache_peer option)
- message= Message describing the reason. Available as %o
- in error pages
- tag= Apply a tag to a request (for both ERR and OK results)
- Only sets a tag, does not alter existing tags.
+ message= Message describing the reason for this response.
+ Available as %o in error pages. Useful on (ERR and BH results).
+ tag= Apply a tag to a request. Only sets a tag once,
+ does not alter existing tags.
log= String to be logged in access.log. Available as
%ea in logformat specifications
- If protocol=3.0 (the default) then URL escaping is used to protect
- each value in both requests and responses.
+ Any keywords may be sent on any response whether OK, ERR or BH.
- If using protocol=2.5 then all values need to be enclosed in quotes
- if they may contain whitespace, or the whitespace escaped using \.
- And quotes or \ characters within the keyword value must be \ escaped.
+ All response keyword values need to be a single token with URL
+ escaping, or enclosed in double quotes (") and escaped using \ on
+ any quotes, whitespace or \ characters within the value
+ For example: user="John\ Smith" or "J.\ O\'Brien"
+
+ Request values sent to the helper are URL escaped to protect
+ each value in requests against whitespaces.
+
+ If using protocol=2.5 then the request sent to the helper is not
+ URL escaped to protect against whitespace.
+
+ NOTE: protocol=3.0 is deprecated as no longer necessary.
When using the concurrency= option the protocol is changed by
introducing a query channel tag infront of the request/response.
} else if (strcmp(token, "protocol=2.5") == 0) {
a->quote = external_acl::QUOTE_METHOD_SHELL;
} else if (strcmp(token, "protocol=3.0") == 0) {
+ debugs(3, DBG_PARSE_NOTE(2), "WARNING: external_acl_type option protocol=3.0 is deprecated. Remove this from your config.");
+ a->quote = external_acl::QUOTE_METHOD_URL;
+ } else if (strcmp(token, "protocol=3.4") == 0) {
+ debugs(3, DBG_PARSE_NOTE(2), "WARNING: external_acl_type option protocol=3.4 is the default. Remove this from your config.");
a->quote = external_acl::QUOTE_METHOD_URL;
} else if (strcmp(token, "quote=url") == 0) {
+ debugs(3, DBG_PARSE_NOTE(2), "WARNING: external_acl_type option quote=url is deprecated. Remove this from your config.");
a->quote = external_acl::QUOTE_METHOD_URL;
} else if (strcmp(token, "quote=shell") == 0) {
+ debugs(3, DBG_PARSE_NOTE(2), "WARNING: external_acl_type option quote=shell is deprecated. Use protocol=2.5 if still needed.");
a->quote = external_acl::QUOTE_METHOD_SHELL;
/* INET6: allow admin to configure some helpers explicitly to
if (node->cache)
storeAppendPrintf(sentry, " cache=%d", node->cache_size);
+ if (node->quote == external_acl::QUOTE_METHOD_SHELL)
+ storeAppendPrintf(sentry, " protocol=2.5");
+
for (format = node->format; format; format = format->next) {
switch (format->type) {
*
* Other keywords may be added to the protocol later
*
- * value needs to be enclosed in quotes if it may contain whitespace, or
- * the whitespace escaped using \ (\ escaping obviously also applies to
- * any " characters)
+ * value needs to be URL-encoded or enclosed in double quotes (")
+ * with \-escaping on any whitespace, quotes, or slashes (\).
*/
static void
externalAclHandleReply(void *data, const HelperReply &reply)
projects / thirdparty / squid.git / commitdiff
