Classes
class	FmtConfig
	The set of custom formats defined in squid.conf. More...

class	Format

class	Token

class	TokenNamespace

class	TokenTableEntry
	One entry in a table of format tokens. More...

Enumerations
enum	ByteCode_t { LFT_NONE , LFT_STRING , LFT_BYTE , LFT_CLIENT_IP_ADDRESS , LFT_CLIENT_FQDN , LFT_CLIENT_PORT , LFT_CLIENT_EUI , LFT_CLIENT_LOCAL_IP , LFT_CLIENT_LOCAL_PORT , LFT_CLIENT_LOCAL_TOS , LFT_CLIENT_LOCAL_NFMARK , LFT_TRANSPORT_CLIENT_CONNECTION_ID , LFT_CLIENT_HANDSHAKE , LFT_LOCAL_LISTENING_IP , LFT_LOCAL_LISTENING_PORT , LFT_SERVER_IP_ADDRESS , LFT_SERVER_FQDN_OR_PEER_NAME , LFT_SERVER_PORT , LFT_SERVER_LOCAL_IP , LFT_SERVER_LOCAL_IP_OLD_27 , LFT_SERVER_LOCAL_PORT , LFT_SERVER_LOCAL_TOS , LFT_SERVER_LOCAL_NFMARK , LFT_CLIENT_REQ_METHOD , LFT_CLIENT_REQ_URI , LFT_CLIENT_REQ_URLSCHEME , LFT_CLIENT_REQ_URLDOMAIN , LFT_CLIENT_REQ_URLPORT , LFT_CLIENT_REQ_URLPATH , LFT_CLIENT_REQ_VERSION , LFT_REQUEST_METHOD , LFT_REQUEST_URI , LFT_REQUEST_URLPATH_OLD_31 , LFT_REQUEST_VERSION_OLD_2X , LFT_REQUEST_VERSION , LFT_REQUEST_URLGROUP_OLD_2X , LFT_REQUEST_HEADER , LFT_REQUEST_HEADER_ELEM , LFT_REQUEST_ALL_HEADERS , LFT_ADAPTED_REQUEST_HEADER , LFT_ADAPTED_REQUEST_HEADER_ELEM , LFT_ADAPTED_REQUEST_ALL_HEADERS , LFT_SERVER_REQ_METHOD , LFT_SERVER_REQ_URI , LFT_SERVER_REQ_URLSCHEME , LFT_SERVER_REQ_URLDOMAIN , LFT_SERVER_REQ_URLPORT , LFT_SERVER_REQ_URLPATH , LFT_SERVER_REQ_VERSION , LFT_CLIENT_REQUEST_SIZE_TOTAL , LFT_CLIENT_REQUEST_SIZE_HEADERS , LFT_HTTP_SENT_STATUS_CODE_OLD_30 , LFT_HTTP_SENT_STATUS_CODE , LFT_HTTP_RECEIVED_STATUS_CODE , LFT_HTTP_BODY_BYTES_READ , LFT_REPLY_HEADER , LFT_REPLY_HEADER_ELEM , LFT_REPLY_ALL_HEADERS , LFT_ADAPTED_REPLY_SIZE_TOTAL , LFT_REPLY_HIGHOFFSET , LFT_REPLY_OBJECTSIZE , LFT_ADAPTED_REPLY_SIZE_HEADERS , LFT_CLIENT_IO_SIZE_TOTAL , LFT_USER_NAME , LFT_USER_LOGIN , LFT_USER_EXTERNAL , LFT_TIME_SECONDS_SINCE_EPOCH , LFT_TIME_SUBSECOND , LFT_TIME_LOCALTIME , LFT_TIME_GMT , LFT_TIME_START , LFT_TIME_TO_HANDLE_REQUEST , LFT_PEER_RESPONSE_TIME , LFT_TOTAL_SERVER_SIDE_RESPONSE_TIME , LFT_DNS_WAIT_TIME , LFT_BUSY_TIME , LFT_SQUID_STATUS , LFT_SQUID_ERROR , LFT_SQUID_ERROR_DETAIL , LFT_SQUID_HIERARCHY , LFT_SQUID_REQUEST_ATTEMPTS , LFT_MIME_TYPE , LFT_TAG , LFT_EXT_LOG , LFT_SEQUENCE_NUMBER , LFT_ADAPTATION_SUM_XACT_TIMES , LFT_ADAPTATION_ALL_XACT_TIMES , LFT_ADAPTATION_LAST_HEADER , LFT_ADAPTATION_LAST_HEADER_ELEM , LFT_ADAPTATION_LAST_ALL_HEADERS , LFT_ICAP_TOTAL_TIME , LFT_ICAP_ADDR , LFT_ICAP_SERV_NAME , LFT_ICAP_REQUEST_URI , LFT_ICAP_REQUEST_METHOD , LFT_ICAP_BYTES_SENT , LFT_ICAP_BYTES_READ , LFT_ICAP_BODY_BYTES_READ , LFT_ICAP_REQ_HEADER , LFT_ICAP_REQ_HEADER_ELEM , LFT_ICAP_REQ_ALL_HEADERS , LFT_ICAP_REP_HEADER , LFT_ICAP_REP_HEADER_ELEM , LFT_ICAP_REP_ALL_HEADERS , LFT_ICAP_TR_RESPONSE_TIME , LFT_ICAP_IO_TIME , LFT_ICAP_OUTCOME , LFT_ICAP_STATUS_CODE , LFT_CREDENTIALS , LFT_SSL_BUMP_MODE , LFT_SSL_USER_CERT_SUBJECT , LFT_SSL_USER_CERT_ISSUER , LFT_SSL_CLIENT_SNI , LFT_SSL_SERVER_CERT_SUBJECT , LFT_SSL_SERVER_CERT_ISSUER , LFT_SSL_SERVER_CERT_ERRORS , LFT_SSL_SERVER_CERT_WHOLE , LFT_TLS_CLIENT_NEGOTIATED_VERSION , LFT_TLS_SERVER_NEGOTIATED_VERSION , LFT_TLS_CLIENT_NEGOTIATED_CIPHER , LFT_TLS_SERVER_NEGOTIATED_CIPHER , LFT_TLS_CLIENT_RECEIVED_HELLO_VERSION , LFT_TLS_SERVER_RECEIVED_HELLO_VERSION , LFT_TLS_CLIENT_SUPPORTED_VERSION , LFT_TLS_SERVER_SUPPORTED_VERSION , LFT_NOTE , LFT_PERCENT , LFT_MASTER_XACTION , LFT_EXT_ACL_USER_CERT_RAW , LFT_EXT_ACL_USER_CERTCHAIN_RAW , LFT_EXT_ACL_USER_CERT , LFT_EXT_ACL_USER_CA_CERT , LFT_EXT_ACL_CLIENT_EUI48 , LFT_EXT_ACL_CLIENT_EUI64 , LFT_EXT_ACL_NAME , LFT_EXT_ACL_DATA , LFT_PROXY_PROTOCOL_RECEIVED_HEADER , LFT_PROXY_PROTOCOL_RECEIVED_HEADER_ELEM , LFT_PROXY_PROTOCOL_RECEIVED_ALL_HEADERS }

enum	Quoting { LOG_QUOTE_NONE = 0 , LOG_QUOTE_QUOTES , LOG_QUOTE_MIMEBLOB , LOG_QUOTE_URL , LOG_QUOTE_SHELL , LOG_QUOTE_RAW }
	Quoting style for a format output. More...

Functions
size_t	AssembleOne (const char *start, MemBuf &buf, const AccessLogEntryPointer &ale)

char *	QuoteUrlEncodeUsername (const char *name)

char *	QuoteMimeBlob (const char *header)

Variables
FmtConfig	TheConfig

const SBuf	Dash

static TokenTableEntry	TokenTable1C []
	1-char tokens.

static TokenTableEntry	TokenTable2C []
	2-char tokens

static TokenTableEntry	TokenTableMisc []
	Miscellaneous >2 byte tokens.

static TokenTableEntry	TokenTableProxyProtocol []

static TokenTableEntry	TokenTableTransport []

static TokenTableEntry	TokenTableAdapt []

static TokenTableEntry	TokenTableIcap []
	ICAP (icap::) tokens.

static TokenTableEntry	TokenTableSsl []

Enumeration Type Documentation

◆ ByteCode_t

enum Format::ByteCode_t

Enumerator
LFT_NONE
LFT_STRING
LFT_BYTE
LFT_CLIENT_IP_ADDRESS
LFT_CLIENT_FQDN
LFT_CLIENT_PORT
LFT_CLIENT_EUI
LFT_CLIENT_LOCAL_IP
LFT_CLIENT_LOCAL_PORT
LFT_CLIENT_LOCAL_TOS
LFT_CLIENT_LOCAL_NFMARK
LFT_TRANSPORT_CLIENT_CONNECTION_ID
LFT_CLIENT_HANDSHAKE
LFT_LOCAL_LISTENING_IP
LFT_LOCAL_LISTENING_PORT
LFT_SERVER_IP_ADDRESS
LFT_SERVER_FQDN_OR_PEER_NAME
LFT_SERVER_PORT
LFT_SERVER_LOCAL_IP
LFT_SERVER_LOCAL_IP_OLD_27
LFT_SERVER_LOCAL_PORT
LFT_SERVER_LOCAL_TOS
LFT_SERVER_LOCAL_NFMARK
LFT_CLIENT_REQ_METHOD
LFT_CLIENT_REQ_URI
LFT_CLIENT_REQ_URLSCHEME
LFT_CLIENT_REQ_URLDOMAIN
LFT_CLIENT_REQ_URLPORT
LFT_CLIENT_REQ_URLPATH
LFT_CLIENT_REQ_VERSION
LFT_REQUEST_METHOD
LFT_REQUEST_URI
LFT_REQUEST_URLPATH_OLD_31
LFT_REQUEST_VERSION_OLD_2X
LFT_REQUEST_VERSION
LFT_REQUEST_URLGROUP_OLD_2X
LFT_REQUEST_HEADER
LFT_REQUEST_HEADER_ELEM
LFT_REQUEST_ALL_HEADERS
LFT_ADAPTED_REQUEST_HEADER
LFT_ADAPTED_REQUEST_HEADER_ELEM
LFT_ADAPTED_REQUEST_ALL_HEADERS
LFT_SERVER_REQ_METHOD
LFT_SERVER_REQ_URI
LFT_SERVER_REQ_URLSCHEME
LFT_SERVER_REQ_URLDOMAIN
LFT_SERVER_REQ_URLPORT
LFT_SERVER_REQ_URLPATH
LFT_SERVER_REQ_VERSION
LFT_CLIENT_REQUEST_SIZE_TOTAL
LFT_CLIENT_REQUEST_SIZE_HEADERS
LFT_HTTP_SENT_STATUS_CODE_OLD_30
LFT_HTTP_SENT_STATUS_CODE
LFT_HTTP_RECEIVED_STATUS_CODE
LFT_HTTP_BODY_BYTES_READ
LFT_REPLY_HEADER
LFT_REPLY_HEADER_ELEM
LFT_REPLY_ALL_HEADERS
LFT_ADAPTED_REPLY_SIZE_TOTAL
LFT_REPLY_HIGHOFFSET
LFT_REPLY_OBJECTSIZE
LFT_ADAPTED_REPLY_SIZE_HEADERS
LFT_CLIENT_IO_SIZE_TOTAL
LFT_USER_NAME
LFT_USER_LOGIN
LFT_USER_EXTERNAL
LFT_TIME_SECONDS_SINCE_EPOCH
LFT_TIME_SUBSECOND
LFT_TIME_LOCALTIME
LFT_TIME_GMT
LFT_TIME_START
LFT_TIME_TO_HANDLE_REQUEST
LFT_PEER_RESPONSE_TIME
LFT_TOTAL_SERVER_SIDE_RESPONSE_TIME
LFT_DNS_WAIT_TIME
LFT_BUSY_TIME
LFT_SQUID_STATUS
LFT_SQUID_ERROR
LFT_SQUID_ERROR_DETAIL
LFT_SQUID_HIERARCHY
LFT_SQUID_REQUEST_ATTEMPTS
LFT_MIME_TYPE
LFT_TAG
LFT_EXT_LOG
LFT_SEQUENCE_NUMBER
LFT_ADAPTATION_SUM_XACT_TIMES
LFT_ADAPTATION_ALL_XACT_TIMES
LFT_ADAPTATION_LAST_HEADER
LFT_ADAPTATION_LAST_HEADER_ELEM
LFT_ADAPTATION_LAST_ALL_HEADERS
LFT_ICAP_TOTAL_TIME
LFT_ICAP_ADDR
LFT_ICAP_SERV_NAME
LFT_ICAP_REQUEST_URI
LFT_ICAP_REQUEST_METHOD
LFT_ICAP_BYTES_SENT
LFT_ICAP_BYTES_READ
LFT_ICAP_BODY_BYTES_READ
LFT_ICAP_REQ_HEADER
LFT_ICAP_REQ_HEADER_ELEM
LFT_ICAP_REQ_ALL_HEADERS
LFT_ICAP_REP_HEADER
LFT_ICAP_REP_HEADER_ELEM
LFT_ICAP_REP_ALL_HEADERS
LFT_ICAP_TR_RESPONSE_TIME
LFT_ICAP_IO_TIME
LFT_ICAP_OUTCOME
LFT_ICAP_STATUS_CODE
LFT_CREDENTIALS
LFT_SSL_BUMP_MODE
LFT_SSL_USER_CERT_SUBJECT
LFT_SSL_USER_CERT_ISSUER
LFT_SSL_CLIENT_SNI
LFT_SSL_SERVER_CERT_SUBJECT
LFT_SSL_SERVER_CERT_ISSUER
LFT_SSL_SERVER_CERT_ERRORS
LFT_SSL_SERVER_CERT_WHOLE
LFT_TLS_CLIENT_NEGOTIATED_VERSION
LFT_TLS_SERVER_NEGOTIATED_VERSION
LFT_TLS_CLIENT_NEGOTIATED_CIPHER
LFT_TLS_SERVER_NEGOTIATED_CIPHER
LFT_TLS_CLIENT_RECEIVED_HELLO_VERSION
LFT_TLS_SERVER_RECEIVED_HELLO_VERSION
LFT_TLS_CLIENT_SUPPORTED_VERSION
LFT_TLS_SERVER_SUPPORTED_VERSION
LFT_NOTE
LFT_PERCENT
LFT_MASTER_XACTION
LFT_EXT_ACL_USER_CERT_RAW
LFT_EXT_ACL_USER_CERTCHAIN_RAW
LFT_EXT_ACL_USER_CERT
LFT_EXT_ACL_USER_CA_CERT
LFT_EXT_ACL_CLIENT_EUI48
LFT_EXT_ACL_CLIENT_EUI64
LFT_EXT_ACL_NAME
LFT_EXT_ACL_DATA
LFT_PROXY_PROTOCOL_RECEIVED_HEADER
LFT_PROXY_PROTOCOL_RECEIVED_HEADER_ELEM
LFT_PROXY_PROTOCOL_RECEIVED_ALL_HEADERS

Definition at line 30 of file ByteCode.h.

◆ Quoting

enum Format::Quoting

Enumerator
LOG_QUOTE_NONE
LOG_QUOTE_QUOTES
LOG_QUOTE_MIMEBLOB
LOG_QUOTE_URL
LOG_QUOTE_SHELL
LOG_QUOTE_RAW

Definition at line 262 of file ByteCode.h.

Function Documentation

◆ AssembleOne()

size_t Format::AssembleOne	(	const char *	start,
		MemBuf &	buf,
		const AccessLogEntryPointer &	ale
	)

Compiles a single logformat code expression into the given buffer. Ignores any input characters after the expression.

Parameters

start where the logformat expression begins

Returns: the length of the parsed code expression

Definition at line 99 of file Format.cc.

References MemBuf::append(), Format::Format::assemble(), assert, Format::Format::format, LOG_QUOTE_NONE, and Format::Token::parse().

Referenced by ErrorState::compileLogformatCode().

◆ QuoteMimeBlob()

char * Format::QuoteMimeBlob ( const char * header )

URL-style encoding on a MIME headers blob. May accept NULL or empty strings.

Returns: A dynamically allocated string. recipient is responsible for free()'ing

Definition at line 43 of file Quoting.cc.

References c2x, and xcalloc().

Referenced by Format::Format::assemble(), Log::Format::HttpdCombined(), Log::Format::HttpdCommon(), Helper::Client::packStatsInto(), QuoteUrlEncodeUsername(), and Log::Format::SquidNative().

◆ QuoteUrlEncodeUsername()

char * Format::QuoteUrlEncodeUsername ( const char * name )

Safely URL-encode a username. Accepts NULL or empty strings.

Definition at line 31 of file Quoting.cc.

References QuoteMimeBlob().

Referenced by Log::Format::HttpdCombined(), Log::Format::HttpdCommon(), Log::Format::SquidIcap(), and Log::Format::SquidNative().

Variable Documentation

◆ Dash

const SBuf Format::Dash

extern

Referenced by accessLogLogTo(), and Log::Format::SquidReferer().

◆ TheConfig

Format::FmtConfig Format::TheConfig

extern

Definition at line 14 of file Config.cc.

Referenced by Format::Token::Init(), and Format::Token::parse().

◆ TokenTable1C

TokenTableEntry Format::TokenTable1C[]

static

Initial value:

= {
 
    TokenTableEntry(">a", LFT_CLIENT_IP_ADDRESS),
    TokenTableEntry(">p", LFT_CLIENT_PORT),
    TokenTableEntry(">A", LFT_CLIENT_FQDN),
 
    TokenTableEntry("<a", LFT_SERVER_IP_ADDRESS),
    TokenTableEntry("<p", LFT_SERVER_PORT),
    TokenTableEntry("<A", LFT_SERVER_FQDN_OR_PEER_NAME),
 
    TokenTableEntry(">h", LFT_REQUEST_HEADER),
    TokenTableEntry(">h", LFT_REQUEST_ALL_HEADERS),
    TokenTableEntry("<h", LFT_REPLY_HEADER),
    TokenTableEntry("<h", LFT_REPLY_ALL_HEADERS),
 
    TokenTableEntry(">v", LFT_REQUEST_VERSION_OLD_2X),
 
    TokenTableEntry("%", LFT_PERCENT),
 
    TokenTableEntry(nullptr, LFT_NONE)        
}

Definition at line 26 of file Token.cc.

Referenced by Format::Token::parse().

◆ TokenTable2C

TokenTableEntry Format::TokenTable2C[]

static

Definition at line 49 of file Token.cc.

Referenced by Format::Token::parse().

◆ TokenTableAdapt

TokenTableEntry Format::TokenTableAdapt[]

static

Initial value:

= {
    TokenTableEntry("all_trs", LFT_ADAPTATION_ALL_XACT_TIMES),
    TokenTableEntry("sum_trs", LFT_ADAPTATION_SUM_XACT_TIMES),
    TokenTableEntry("<last_h", LFT_ADAPTATION_LAST_HEADER),
    TokenTableEntry(nullptr, LFT_NONE)           
}

Definition at line 195 of file Token.cc.

Referenced by Format::Token::Init().

◆ TokenTableIcap

TokenTableEntry Format::TokenTableIcap[]

static

Initial value:

= {
    TokenTableEntry("tt", LFT_ICAP_TOTAL_TIME),
    TokenTableEntry("<last_h", LFT_ADAPTATION_LAST_HEADER), 
 
    TokenTableEntry("<A",  LFT_ICAP_ADDR),
    TokenTableEntry("<service_name",  LFT_ICAP_SERV_NAME),
    TokenTableEntry("ru",  LFT_ICAP_REQUEST_URI),
    TokenTableEntry("rm",  LFT_ICAP_REQUEST_METHOD),
    TokenTableEntry(">st", LFT_ICAP_BYTES_SENT),
    TokenTableEntry("<st", LFT_ICAP_BYTES_READ),
    TokenTableEntry("<bs", LFT_ICAP_BODY_BYTES_READ),
 
    TokenTableEntry(">h",  LFT_ICAP_REQ_HEADER),
    TokenTableEntry("<h",  LFT_ICAP_REP_HEADER),
 
    TokenTableEntry("tr",  LFT_ICAP_TR_RESPONSE_TIME),
    TokenTableEntry("tio", LFT_ICAP_IO_TIME),
    TokenTableEntry("to",  LFT_ICAP_OUTCOME),
    TokenTableEntry("Hs",  LFT_ICAP_STATUS_CODE),
 
    TokenTableEntry(nullptr, LFT_NONE)           
}

Definition at line 205 of file Token.cc.

Referenced by Format::Token::Init().

◆ TokenTableMisc

TokenTableEntry Format::TokenTableMisc[]

static

Definition at line 141 of file Token.cc.

Referenced by Format::Token::parse().

◆ TokenTableProxyProtocol

TokenTableEntry Format::TokenTableProxyProtocol[]

static

Initial value:

= {
    TokenTableEntry(">h", LFT_PROXY_PROTOCOL_RECEIVED_HEADER),
    TokenTableEntry(nullptr, LFT_NONE)           
}

Definition at line 184 of file Token.cc.

Referenced by Format::Token::Init().

◆ TokenTableSsl

TokenTableEntry Format::TokenTableSsl[]

static

Initial value:

= {
    TokenTableEntry("bump_mode", LFT_SSL_BUMP_MODE),
    TokenTableEntry(">cert_subject", LFT_SSL_USER_CERT_SUBJECT),
    TokenTableEntry(">cert_issuer", LFT_SSL_USER_CERT_ISSUER),
    TokenTableEntry(">sni", LFT_SSL_CLIENT_SNI),
    TokenTableEntry("<cert_subject", LFT_SSL_SERVER_CERT_SUBJECT),
    TokenTableEntry("<cert_issuer", LFT_SSL_SERVER_CERT_ISSUER),
    TokenTableEntry("<cert_errors", LFT_SSL_SERVER_CERT_ERRORS),
    TokenTableEntry("<cert", LFT_SSL_SERVER_CERT_WHOLE),
    TokenTableEntry(">negotiated_version", LFT_TLS_CLIENT_NEGOTIATED_VERSION),
    TokenTableEntry("<negotiated_version", LFT_TLS_SERVER_NEGOTIATED_VERSION),
    TokenTableEntry(">negotiated_cipher", LFT_TLS_CLIENT_NEGOTIATED_CIPHER),
    TokenTableEntry("<negotiated_cipher", LFT_TLS_SERVER_NEGOTIATED_CIPHER),
    TokenTableEntry(">received_hello_version", LFT_TLS_CLIENT_RECEIVED_HELLO_VERSION),
    TokenTableEntry("<received_hello_version", LFT_TLS_SERVER_RECEIVED_HELLO_VERSION),
    TokenTableEntry(">received_supported_version", LFT_TLS_CLIENT_SUPPORTED_VERSION),
    TokenTableEntry("<received_supported_version", LFT_TLS_SERVER_SUPPORTED_VERSION),
    TokenTableEntry(nullptr, LFT_NONE)
}

Definition at line 231 of file Token.cc.

Referenced by Format::Token::Init().

◆ TokenTableTransport

TokenTableEntry Format::TokenTableTransport[]

static

Initial value:

= {
    TokenTableEntry(">connection_id", LFT_TRANSPORT_CLIENT_CONNECTION_ID),
    TokenTableEntry(nullptr, LFT_NONE)           
}

Definition at line 189 of file Token.cc.

Referenced by Format::Token::Init().

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ ByteCode_t

◆ Quoting

Function Documentation

◆ AssembleOne()

◆ QuoteMimeBlob()

◆ QuoteUrlEncodeUsername()

Variable Documentation

◆ Dash

◆ TheConfig

◆ TokenTable1C

◆ TokenTable2C

◆ TokenTableAdapt

◆ TokenTableIcap

◆ TokenTableMisc

◆ TokenTableProxyProtocol

◆ TokenTableSsl

◆ TokenTableTransport