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 #ifndef _SQUID_FMT_BYTECODE_H
10 #define _SQUID_FMT_BYTECODE_H
13 * Squid configuration allows users to define custom formats in
16 * - external ACL input
19 * These enumerations and classes define the API for parsing of
20 * format directives to define these patterns. Along with output
21 * functionality to produce formatted buffers.
28 * Bytecodes for the configurable format stuff
33 /* arbitrary string between tokens */
36 /* client TCP connection remote end details */
37 LFT_CLIENT_IP_ADDRESS
,
42 /* client TCP connection local end details */
44 LFT_CLIENT_LOCAL_PORT
,
45 /*LFT_CLIENT_LOCAL_FQDN, (rDNS) */
47 LFT_CLIENT_LOCAL_NFMARK
,
49 LFT_TRANSPORT_CLIENT_CONNECTION_ID
,
53 /* client connection local squid.conf details */
54 LFT_LOCAL_LISTENING_IP
,
55 LFT_LOCAL_LISTENING_PORT
,
56 /*LFT_LOCAL_LISTENING_NAME, (myportname) */
58 /* server TCP connection remote end details */
59 LFT_SERVER_IP_ADDRESS
,
60 LFT_SERVER_FQDN_OR_PEER_NAME
,
63 /* server TCP connection local end details */
65 LFT_SERVER_LOCAL_IP_OLD_27
,
66 LFT_SERVER_LOCAL_PORT
,
68 LFT_SERVER_LOCAL_NFMARK
,
70 /* original Request-Line details received from client */
71 LFT_CLIENT_REQ_METHOD
,
73 LFT_CLIENT_REQ_URLSCHEME
,
74 LFT_CLIENT_REQ_URLDOMAIN
,
75 LFT_CLIENT_REQ_URLPORT
,
76 LFT_CLIENT_REQ_URLPATH
,
77 /* LFT_CLIENT_REQ_QUERY, */
78 LFT_CLIENT_REQ_VERSION
,
80 /* Request-Line details received from client (legacy, filtered) */
83 LFT_REQUEST_URLPATH_OLD_31
,
84 /*LFT_REQUEST_QUERY, */
85 LFT_REQUEST_VERSION_OLD_2X
,
87 LFT_REQUEST_URLGROUP_OLD_2X
,
89 /* request header details pre-adaptation */
91 LFT_REQUEST_HEADER_ELEM
,
92 LFT_REQUEST_ALL_HEADERS
,
94 /* request header details post-adaptation */
95 LFT_ADAPTED_REQUEST_HEADER
,
96 LFT_ADAPTED_REQUEST_HEADER_ELEM
,
97 LFT_ADAPTED_REQUEST_ALL_HEADERS
,
99 /* Request-Line details sent to the server/peer */
100 LFT_SERVER_REQ_METHOD
,
102 LFT_SERVER_REQ_URLSCHEME
,
103 LFT_SERVER_REQ_URLDOMAIN
,
104 LFT_SERVER_REQ_URLPORT
,
105 LFT_SERVER_REQ_URLPATH
,
106 /*LFT_SERVER_REQ_QUERY, */
107 LFT_SERVER_REQ_VERSION
,
109 /* request meta details */
110 LFT_CLIENT_REQUEST_SIZE_TOTAL
,
111 LFT_CLIENT_REQUEST_SIZE_HEADERS
,
112 /*LFT_REQUEST_SIZE_BODY, */
113 /*LFT_REQUEST_SIZE_BODY_NO_TE, */
115 /* original Status-Line details received from server */
116 // TODO: implement server detail logging
118 /* Status-Line details sent to the client */
119 // TODO: implement server detail logging
121 /* response Status-Line details (legacy, filtered) */
122 LFT_HTTP_SENT_STATUS_CODE_OLD_30
,
123 LFT_HTTP_SENT_STATUS_CODE
,
124 LFT_HTTP_RECEIVED_STATUS_CODE
,
125 /*LFT_HTTP_STATUS, */
126 LFT_HTTP_BODY_BYTES_READ
,
128 /* response header details pre-adaptation */
130 LFT_REPLY_HEADER_ELEM
,
131 LFT_REPLY_ALL_HEADERS
,
133 /* response header details post-adaptation */
134 /* LFT_ADAPTED_REPLY_HEADER, */
135 /* LFT_ADAPTED_REPLY_HEADER_ELEM, */
136 /* LFT_ADAPTED_REPLY_ALL_HEADERS, */
138 /* response meta details */
139 LFT_ADAPTED_REPLY_SIZE_TOTAL
,
140 LFT_REPLY_HIGHOFFSET
,
141 LFT_REPLY_OBJECTSIZE
,
142 LFT_ADAPTED_REPLY_SIZE_HEADERS
,
143 /*LFT_REPLY_SIZE_BODY, */
144 /*LFT_REPLY_SIZE_BODY_NO_TE, */
146 LFT_CLIENT_IO_SIZE_TOTAL
,
148 /* client credentials */
149 LFT_USER_NAME
, /* any source will do */
153 /*LFT_USER_SCHEME, */
155 /* LFT_USER_SSL_CERT, */
157 /* global time details */
158 LFT_TIME_SECONDS_SINCE_EPOCH
,
162 LFT_TIME_START
, // the time the master transaction started
164 /* processing time details */
165 LFT_TIME_TO_HANDLE_REQUEST
,
166 LFT_PEER_RESPONSE_TIME
,
167 LFT_TOTAL_SERVER_SIDE_RESPONSE_TIME
,
171 /* Squid internal processing details */
174 LFT_SQUID_ERROR_DETAIL
,
184 LFT_ADAPTATION_SUM_XACT_TIMES
,
185 LFT_ADAPTATION_ALL_XACT_TIMES
,
186 LFT_ADAPTATION_LAST_HEADER
,
187 LFT_ADAPTATION_LAST_HEADER_ELEM
,
188 LFT_ADAPTATION_LAST_ALL_HEADERS
,
197 LFT_ICAP_REQUEST_URI
,
198 LFT_ICAP_REQUEST_METHOD
,
201 LFT_ICAP_BODY_BYTES_READ
,
204 LFT_ICAP_REQ_HEADER_ELEM
,
205 LFT_ICAP_REQ_ALL_HEADERS
,
208 LFT_ICAP_REP_HEADER_ELEM
,
209 LFT_ICAP_REP_ALL_HEADERS
,
211 LFT_ICAP_TR_RESPONSE_TIME
,
214 LFT_ICAP_STATUS_CODE
,
220 LFT_SSL_USER_CERT_SUBJECT
,
221 LFT_SSL_USER_CERT_ISSUER
,
223 LFT_SSL_SERVER_CERT_SUBJECT
,
224 LFT_SSL_SERVER_CERT_ISSUER
,
225 LFT_SSL_SERVER_CERT_ERRORS
,
226 LFT_SSL_SERVER_CERT_WHOLE
,
227 LFT_TLS_CLIENT_NEGOTIATED_VERSION
,
228 LFT_TLS_SERVER_NEGOTIATED_VERSION
,
229 LFT_TLS_CLIENT_NEGOTIATED_CIPHER
,
230 LFT_TLS_SERVER_NEGOTIATED_CIPHER
,
231 LFT_TLS_CLIENT_RECEIVED_HELLO_VERSION
,
232 LFT_TLS_SERVER_RECEIVED_HELLO_VERSION
,
233 LFT_TLS_CLIENT_SUPPORTED_VERSION
,
234 LFT_TLS_SERVER_SUPPORTED_VERSION
,
238 LFT_PERCENT
, /* special string cases for escaped chars */
241 // TODO assign better bytecode names and Token strings for these
243 LFT_EXT_ACL_USER_CERT_RAW
,
244 LFT_EXT_ACL_USER_CERTCHAIN_RAW
,
245 LFT_EXT_ACL_USER_CERT
,
246 LFT_EXT_ACL_USER_CA_CERT
,
248 LFT_EXT_ACL_CLIENT_EUI48
,
249 LFT_EXT_ACL_CLIENT_EUI64
,
253 /* PROXY protocol details */
254 LFT_PROXY_PROTOCOL_RECEIVED_HEADER
,
255 LFT_PROXY_PROTOCOL_RECEIVED_HEADER_ELEM
,
256 LFT_PROXY_PROTOCOL_RECEIVED_ALL_HEADERS
259 /// Quoting style for a format output.
269 } // namespace Format
271 #endif /* _SQUID_FMT_BYTECODE_H */