src/format/ByteCode.h

   1 /*
   2  * Copyright (C) 1996-2019 The Squid Software Foundation and contributors
   3  *
   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.
   7  */
   8
   9 #ifndef _SQUID_FMT_BYTECODE_H
  10 #define _SQUID_FMT_BYTECODE_H
  11
  12 /*
  13  * Squid configuration allows users to define custom formats in
  14  * several components.
  15  * - logging
  16  * - external ACL input
  17  * - deny page URL
  18  *
  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.
  22  */
  23
  24 namespace Format
  25 {
  26
  27 /*
  28  * Bytecodes for the configureable format stuff
  29  */
  30 typedef enum {
  31     LFT_NONE,           /* dummy */
  32
  33     /* arbitrary string between tokens */
  34     LFT_STRING,
  35
  36     /* client TCP connection remote end details */
  37     LFT_CLIENT_IP_ADDRESS,
  38     LFT_CLIENT_FQDN,
  39     LFT_CLIENT_PORT,
  40     LFT_CLIENT_EUI,
  41
  42     /* client TCP connection local end details */
  43     LFT_CLIENT_LOCAL_IP,
  44     LFT_CLIENT_LOCAL_PORT,
  45     /*LFT_CLIENT_LOCAL_FQDN, (rDNS) */
  46     LFT_CLIENT_LOCAL_TOS,
  47     LFT_CLIENT_LOCAL_NFMARK,
  48
  49     LFT_CLIENT_HANDSHAKE,
  50
  51     /* client connection local squid.conf details */
  52     LFT_LOCAL_LISTENING_IP,
  53     LFT_LOCAL_LISTENING_PORT,
  54     /*LFT_LOCAL_LISTENING_NAME, (myportname) */
  55
  56     /* server TCP connection remote end details */
  57     LFT_SERVER_IP_ADDRESS,
  58     LFT_SERVER_FQDN_OR_PEER_NAME,
  59     LFT_SERVER_PORT,
  60
  61     /* server TCP connection local end details */
  62     LFT_SERVER_LOCAL_IP,
  63     LFT_SERVER_LOCAL_IP_OLD_27,
  64     LFT_SERVER_LOCAL_PORT,
  65     LFT_SERVER_LOCAL_TOS,
  66     LFT_SERVER_LOCAL_NFMARK,
  67
  68     /* original Request-Line details recieved from client */
  69     LFT_CLIENT_REQ_METHOD,
  70     LFT_CLIENT_REQ_URI,
  71     LFT_CLIENT_REQ_URLSCHEME,
  72     LFT_CLIENT_REQ_URLDOMAIN,
  73     LFT_CLIENT_REQ_URLPORT,
  74     LFT_CLIENT_REQ_URLPATH,
  75     /* LFT_CLIENT_REQ_QUERY, */
  76     LFT_CLIENT_REQ_VERSION,
  77
  78     /* Request-Line details recieved from client (legacy, filtered) */
  79     LFT_REQUEST_METHOD,
  80     LFT_REQUEST_URI,
  81     LFT_REQUEST_URLPATH_OLD_31,
  82     /*LFT_REQUEST_QUERY, */
  83     LFT_REQUEST_VERSION_OLD_2X,
  84     LFT_REQUEST_VERSION,
  85     LFT_REQUEST_URLGROUP_OLD_2X,
  86
  87     /* request header details pre-adaptation */
  88     LFT_REQUEST_HEADER,
  89     LFT_REQUEST_HEADER_ELEM,
  90     LFT_REQUEST_ALL_HEADERS,
  91
  92     /* request header details post-adaptation */
  93     LFT_ADAPTED_REQUEST_HEADER,
  94     LFT_ADAPTED_REQUEST_HEADER_ELEM,
  95     LFT_ADAPTED_REQUEST_ALL_HEADERS,
  96
  97     /* Request-Line details sent to the server/peer */
  98     LFT_SERVER_REQ_METHOD,
  99     LFT_SERVER_REQ_URI,
 100     LFT_SERVER_REQ_URLSCHEME,
 101     LFT_SERVER_REQ_URLDOMAIN,
 102     LFT_SERVER_REQ_URLPORT,
 103     LFT_SERVER_REQ_URLPATH,
 104     /*LFT_SERVER_REQ_QUERY, */
 105     LFT_SERVER_REQ_VERSION,
 106
 107     /* request meta details */
 108     LFT_CLIENT_REQUEST_SIZE_TOTAL,
 109     LFT_CLIENT_REQUEST_SIZE_HEADERS,
 110     /*LFT_REQUEST_SIZE_BODY, */
 111     /*LFT_REQUEST_SIZE_BODY_NO_TE, */
 112
 113     /* original Status-Line details recieved from server */
 114     // XXX: todo
 115
 116     /* Status-Line details sent to the client */
 117     // XXX: todo
 118
 119     /* response Status-Line details (legacy, filtered) */
 120     LFT_HTTP_SENT_STATUS_CODE_OLD_30,
 121     LFT_HTTP_SENT_STATUS_CODE,
 122     LFT_HTTP_RECEIVED_STATUS_CODE,
 123     /*LFT_HTTP_STATUS, */
 124     LFT_HTTP_BODY_BYTES_READ,
 125
 126     /* response header details pre-adaptation */
 127     LFT_REPLY_HEADER,
 128     LFT_REPLY_HEADER_ELEM,
 129     LFT_REPLY_ALL_HEADERS,
 130
 131     /* response header details post-adaptation */
 132     /* LFT_ADAPTED_REPLY_HEADER, */
 133     /* LFT_ADAPTED_REPLY_HEADER_ELEM, */
 134     /* LFT_ADAPTED_REPLY_ALL_HEADERS, */
 135
 136     /* response meta details */
 137     LFT_ADAPTED_REPLY_SIZE_TOTAL,
 138     LFT_REPLY_HIGHOFFSET,
 139     LFT_REPLY_OBJECTSIZE,
 140     LFT_ADAPTED_REPLY_SIZE_HEADERS,
 141     /*LFT_REPLY_SIZE_BODY, */
 142     /*LFT_REPLY_SIZE_BODY_NO_TE, */
 143
 144     LFT_CLIENT_IO_SIZE_TOTAL,
 145
 146     /* client credentials */
 147     LFT_USER_NAME,   /* any source will do */
 148     LFT_USER_LOGIN,
 149     LFT_USER_IDENT,
 150     /*LFT_USER_REALM, */
 151     /*LFT_USER_SCHEME, */
 152     LFT_USER_EXTERNAL,
 153     /* LFT_USER_SSL_CERT, */
 154
 155     /* global time details */
 156     LFT_TIME_SECONDS_SINCE_EPOCH,
 157     LFT_TIME_SUBSECOND,
 158     LFT_TIME_LOCALTIME,
 159     LFT_TIME_GMT,
 160     LFT_TIME_START, // the time the master transaction started
 161
 162     /* processing time details */
 163     LFT_TIME_TO_HANDLE_REQUEST,
 164     LFT_PEER_RESPONSE_TIME,
 165     LFT_TOTAL_SERVER_SIDE_RESPONSE_TIME,
 166     LFT_DNS_WAIT_TIME,
 167
 168     /* Squid internal processing details */
 169     LFT_SQUID_STATUS,
 170     LFT_SQUID_ERROR,
 171     LFT_SQUID_ERROR_DETAIL,
 172     LFT_SQUID_HIERARCHY,
 173
 174     LFT_MIME_TYPE,
 175     LFT_TAG,
 176     LFT_EXT_LOG,
 177
 178     LFT_SEQUENCE_NUMBER,
 179
 180 #if USE_ADAPTATION
 181     LFT_ADAPTATION_SUM_XACT_TIMES,
 182     LFT_ADAPTATION_ALL_XACT_TIMES,
 183     LFT_ADAPTATION_LAST_HEADER,
 184     LFT_ADAPTATION_LAST_HEADER_ELEM,
 185     LFT_ADAPTATION_LAST_ALL_HEADERS,
 186 #endif
 187
 188 #if ICAP_CLIENT
 189
 190     LFT_ICAP_TOTAL_TIME,
 191
 192     LFT_ICAP_ADDR,
 193     LFT_ICAP_SERV_NAME,
 194     LFT_ICAP_REQUEST_URI,
 195     LFT_ICAP_REQUEST_METHOD,
 196     LFT_ICAP_BYTES_SENT,
 197     LFT_ICAP_BYTES_READ,
 198     LFT_ICAP_BODY_BYTES_READ,
 199
 200     LFT_ICAP_REQ_HEADER,
 201     LFT_ICAP_REQ_HEADER_ELEM,
 202     LFT_ICAP_REQ_ALL_HEADERS,
 203
 204     LFT_ICAP_REP_HEADER,
 205     LFT_ICAP_REP_HEADER_ELEM,
 206     LFT_ICAP_REP_ALL_HEADERS,
 207
 208     LFT_ICAP_TR_RESPONSE_TIME,
 209     LFT_ICAP_IO_TIME,
 210     LFT_ICAP_OUTCOME,
 211     LFT_ICAP_STATUS_CODE,
 212 #endif
 213     LFT_CREDENTIALS,
 214
 215 #if USE_OPENSSL
 216     LFT_SSL_BUMP_MODE,
 217     LFT_SSL_USER_CERT_SUBJECT,
 218     LFT_SSL_USER_CERT_ISSUER,
 219     LFT_SSL_CLIENT_SNI,
 220     LFT_SSL_SERVER_CERT_SUBJECT,
 221     LFT_SSL_SERVER_CERT_ISSUER,
 222     LFT_SSL_SERVER_CERT_ERRORS,
 223     LFT_SSL_SERVER_CERT_WHOLE,
 224     LFT_TLS_CLIENT_NEGOTIATED_VERSION,
 225     LFT_TLS_SERVER_NEGOTIATED_VERSION,
 226     LFT_TLS_CLIENT_NEGOTIATED_CIPHER,
 227     LFT_TLS_SERVER_NEGOTIATED_CIPHER,
 228     LFT_TLS_CLIENT_RECEIVED_HELLO_VERSION,
 229     LFT_TLS_SERVER_RECEIVED_HELLO_VERSION,
 230     LFT_TLS_CLIENT_SUPPORTED_VERSION,
 231     LFT_TLS_SERVER_SUPPORTED_VERSION,
 232 #endif
 233
 234     LFT_NOTE,
 235     LFT_PERCENT,            /* special string cases for escaped chars */
 236
 237     // TODO assign better bytecode names and Token strings for these
 238 #if USE_OPENSSL
 239     LFT_EXT_ACL_USER_CERT_RAW,
 240     LFT_EXT_ACL_USER_CERTCHAIN_RAW,
 241     LFT_EXT_ACL_USER_CERT,
 242     LFT_EXT_ACL_USER_CA_CERT,
 243 #endif
 244     LFT_EXT_ACL_CLIENT_EUI48,
 245     LFT_EXT_ACL_CLIENT_EUI64,
 246     LFT_EXT_ACL_NAME,
 247     LFT_EXT_ACL_DATA,
 248
 249     /* PROXY protocol details */
 250     LFT_PROXY_PROTOCOL_RECEIVED_HEADER,
 251     LFT_PROXY_PROTOCOL_RECEIVED_HEADER_ELEM,
 252     LFT_PROXY_PROTOCOL_RECEIVED_ALL_HEADERS
 253 } ByteCode_t;
 254
 255 /// Quoting style for a format output.
 256 enum Quoting {
 257     LOG_QUOTE_NONE = 0,
 258     LOG_QUOTE_QUOTES,
 259     LOG_QUOTE_MIMEBLOB,
 260     LOG_QUOTE_URL,
 261     LOG_QUOTE_SHELL,
 262     LOG_QUOTE_RAW
 263 };
 264
 265 } // namespace Format
 266
 267 #endif /* _SQUID_FMT_BYTECODE_H */
 268