src/format/ByteCode.h

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