xref: /lighttpd1.4/src/http_header.c (revision 34709192)
1 /*
2  * http_header - HTTP header manipulation interfaces
3  *
4  * Copyright(c) 2018 Glenn Strauss gstrauss()gluelogic.com  All rights reserved
5  * License: BSD 3-clause (same as lighttpd)
6  */
7 #include "first.h"
8 
9 #include <string.h>
10 #include "sys-strings.h"
11 
12 #include "http_header.h"
13 #include "base.h"
14 #include "array.h"
15 #include "buffer.h"
16 
17 
18 typedef struct keyvlenvalue {
19     const int key;
20     const uint32_t vlen;
21     const char value[24];
22 } keyvlenvalue;
23 
24 /* Note: must be sorted by length */
25 /* Note: must be kept in sync with http_header.h enum http_header_e */
26 /* Note: must be kept in sync http_headers[] and http_headers_off[] */
27 /* http_headers_off lists first offset at which string of specific len occur */
28 int8_t http_headers_off[] = {
29   -1, -1, -1, -1, 0, 4, 5, 9, 10, 11, 12, -1, 15, 16, 20, 21, 23, 25
30 };
31 static const keyvlenvalue http_headers[] = {
32   { HTTP_HEADER_HOST,                 CONST_LEN_STR("Host") }
33  ,{ HTTP_HEADER_DATE,                 CONST_LEN_STR("Date") }
34  ,{ HTTP_HEADER_ETAG,                 CONST_LEN_STR("ETag") }
35  ,{ HTTP_HEADER_VARY,                 CONST_LEN_STR("Vary") }
36  ,{ HTTP_HEADER_RANGE,                CONST_LEN_STR("Range") }
37  ,{ HTTP_HEADER_COOKIE,               CONST_LEN_STR("Cookie") }
38  ,{ HTTP_HEADER_EXPECT,               CONST_LEN_STR("Expect") }
39  ,{ HTTP_HEADER_STATUS,               CONST_LEN_STR("Status") }
40  ,{ HTTP_HEADER_SERVER,               CONST_LEN_STR("Server") }
41  ,{ HTTP_HEADER_UPGRADE,              CONST_LEN_STR("Upgrade") }
42  ,{ HTTP_HEADER_LOCATION,             CONST_LEN_STR("Location") }
43  ,{ HTTP_HEADER_FORWARDED,            CONST_LEN_STR("Forwarded") }
44  ,{ HTTP_HEADER_CONNECTION,           CONST_LEN_STR("Connection") }
45  ,{ HTTP_HEADER_SET_COOKIE,           CONST_LEN_STR("Set-Cookie") }
46  ,{ HTTP_HEADER_USER_AGENT,           CONST_LEN_STR("User-Agent") }
47  ,{ HTTP_HEADER_CONTENT_TYPE,         CONST_LEN_STR("Content-Type") }
48  ,{ HTTP_HEADER_LAST_MODIFIED,        CONST_LEN_STR("Last-Modified") }
49  ,{ HTTP_HEADER_AUTHORIZATION,        CONST_LEN_STR("Authorization") }
50  ,{ HTTP_HEADER_IF_NONE_MATCH,        CONST_LEN_STR("If-None-Match") }
51  ,{ HTTP_HEADER_CACHE_CONTROL,        CONST_LEN_STR("Cache-Control") }
52  ,{ HTTP_HEADER_CONTENT_LENGTH,       CONST_LEN_STR("Content-Length") }
53  ,{ HTTP_HEADER_ACCEPT_ENCODING,      CONST_LEN_STR("Accept-Encoding") }
54  ,{ HTTP_HEADER_X_FORWARDED_FOR,      CONST_LEN_STR("X-Forwarded-For") }
55  ,{ HTTP_HEADER_CONTENT_ENCODING,     CONST_LEN_STR("Content-Encoding") }
56  ,{ HTTP_HEADER_CONTENT_LOCATION,     CONST_LEN_STR("Content-Location") }
57  ,{ HTTP_HEADER_IF_MODIFIED_SINCE,    CONST_LEN_STR("If-Modified-Since") }
58  ,{ HTTP_HEADER_TRANSFER_ENCODING,    CONST_LEN_STR("Transfer-Encoding") }
59  ,{ HTTP_HEADER_X_FORWARDED_PROTO,    CONST_LEN_STR("X-Forwarded-Proto") }
60  ,{ HTTP_HEADER_OTHER, 0, "" }
61 };
62 
63 enum http_header_e http_header_hkey_get(const char * const s, const uint32_t slen) {
64     const struct keyvlenvalue * const kv = http_headers;
65     int i = slen < sizeof(http_headers_off) ? http_headers_off[slen] : -1;
66     if (i < 0) return HTTP_HEADER_OTHER;
67     do {
68         if (buffer_eq_icase_ssn(s, kv[i].value, slen))
69             return (enum http_header_e)kv[i].key;
70     } while (slen == kv[++i].vlen);
71     return HTTP_HEADER_OTHER;
72 }
73 
74 
75 int http_header_str_to_code (const char * const s)
76 {
77     /*(more strict than strtol(); exactly 3 digits followed by SP/TAB/NIL)*/
78     return (light_isdigit(s[0]) && light_isdigit(s[1]) && light_isdigit(s[2])
79             && (s[3] == '\0' || s[3] == ' ' || s[3] == '\t'))
80       ? (s[0]-'0')*100 + (s[1]-'0')*10 + (s[2]-'0')
81       : -1;
82 }
83 
84 int http_header_str_contains_token (const char * const s, const uint32_t slen, const char * const m, const uint32_t mlen)
85 {
86     /*if (slen < mlen) return 0;*//*(possible optimizations for caller)*/
87     /*if (slen == mlen && buffer_eq_icase_ssn(s, m, mlen)) return 1;*/
88     uint32_t i = 0;
89     do {
90         while (i < slen &&  (s[i]==' ' || s[i]=='\t' || s[i]==',')) ++i;
91         if (i == slen) return 0;
92         if (buffer_eq_icase_ssn(s+i, m, mlen)) {
93             i += mlen;
94             if (i == slen || s[i]==' ' || s[i]=='\t' || s[i]==',' || s[i]==';')
95                 return 1;
96         }
97         while (i < slen &&   s[i]!=',') ++i;
98     } while (i < slen);
99     return 0;
100 }
101 
102 
103 int http_header_remove_token (buffer * const b, const char * const m, const uint32_t mlen)
104 {
105     /*(remove all instance of token from string)*/
106     /*(note: does not handle quoted-string)*/
107     int rc = 0;
108     for (char *s = b->ptr; s; ) {
109         while (*s == ' ' || *s == '\t' || *s == ',') ++s;
110         if (0 == strncasecmp(s, m, mlen)) {
111             s += mlen;
112             if (*s=='\0' || *s==' ' || *s=='\t' || *s==',' || *s==';') {
113                 memset(s-mlen, ' ', mlen);
114                 while (*s != '\0' && *s != ',') ++s;
115                 rc = 1;
116                 if (*s == ',') {
117                     *s++ = ' ';
118                     continue;
119                 }
120                 else {
121                     for (s -= mlen; *s != ',' && s != b->ptr; --s) ;
122                     buffer_string_set_length(b, (size_t)(s - b->ptr));
123                     break;
124                 }
125             }
126         }
127         s = strchr(s, ',');
128     }
129     return rc;
130 }
131 
132 
133 static inline void http_header_token_append(buffer * const vb, const char * const v, const uint32_t vlen) {
134     if (!buffer_string_is_empty(vb))
135         buffer_append_string_len(vb, CONST_STR_LEN(", "));
136     buffer_append_string_len(vb, v, vlen);
137 }
138 
139 __attribute_pure__
140 static inline buffer * http_header_generic_get_ifnotempty(const array * const a, const char * const k, const uint32_t klen) {
141     data_string * const ds =
142       (data_string *)array_get_element_klen(a, k, klen);
143     return ds && !buffer_string_is_empty(&ds->value) ? &ds->value : NULL;
144 }
145 
146 
147 buffer * http_header_response_get(const request_st * const r, enum http_header_e id, const char *k, uint32_t klen) {
148     return (id <= HTTP_HEADER_OTHER || (r->resp_htags & id))
149       ? http_header_generic_get_ifnotempty(&r->resp_headers, k, klen)
150       : NULL;
151 }
152 
153 void http_header_response_unset(request_st * const r, enum http_header_e id, const char *k, uint32_t klen) {
154     if (id <= HTTP_HEADER_OTHER || (r->resp_htags & id)) {
155         if (id > HTTP_HEADER_OTHER) r->resp_htags &= ~id;
156         array_set_key_value(&r->resp_headers, k, klen, CONST_STR_LEN(""));
157     }
158 }
159 
160 void http_header_response_set(request_st * const r, enum http_header_e id, const char *k, uint32_t klen, const char *v, uint32_t vlen) {
161     /* set value, including setting blank value if 0 == vlen
162      * (note: if 0 == vlen, header is still inserted with blank value,
163      *  which is used to indicate a "removed" header)
164      */
165     if (id > HTTP_HEADER_OTHER)
166         (vlen) ? (r->resp_htags |= id) : (r->resp_htags &= ~id);
167     array_set_key_value(&r->resp_headers, k, klen, v, vlen);
168 }
169 
170 void http_header_response_append(request_st * const r, enum http_header_e id, const char *k, uint32_t klen, const char *v, uint32_t vlen) {
171     if (0 == vlen) return;
172     if (id > HTTP_HEADER_OTHER) r->resp_htags |= id;
173     buffer * const vb = array_get_buf_ptr(&r->resp_headers, k, klen);
174     http_header_token_append(vb, v, vlen);
175 }
176 
177 void http_header_response_insert(request_st * const r, enum http_header_e id, const char *k, uint32_t klen, const char *v, uint32_t vlen) {
178     if (0 == vlen) return;
179     if (id > HTTP_HEADER_OTHER) r->resp_htags |= id;
180     buffer * const vb = array_get_buf_ptr(&r->resp_headers, k, klen);
181     if (!buffer_string_is_empty(vb)) { /* append value */
182         buffer_append_string_len(vb, CONST_STR_LEN("\r\n"));
183         buffer_append_string_len(vb, k, klen);
184         buffer_append_string_len(vb, CONST_STR_LEN(": "));
185     }
186     buffer_append_string_len(vb, v, vlen);
187 }
188 
189 
190 buffer * http_header_request_get(const request_st * const r, enum http_header_e id, const char *k, uint32_t klen) {
191     return (id <= HTTP_HEADER_OTHER || (r->rqst_htags & id))
192       ? http_header_generic_get_ifnotempty(&r->rqst_headers, k, klen)
193       : NULL;
194 }
195 
196 void http_header_request_unset(request_st * const r, enum http_header_e id, const char *k, uint32_t klen) {
197     if (id <= HTTP_HEADER_OTHER || (r->rqst_htags & id)) {
198         if (id > HTTP_HEADER_OTHER) r->rqst_htags &= ~id;
199         array_set_key_value(&r->rqst_headers, k, klen, CONST_STR_LEN(""));
200     }
201 }
202 
203 void http_header_request_set(request_st * const r, enum http_header_e id, const char *k, uint32_t klen, const char *v, uint32_t vlen) {
204     /* set value, including setting blank value if 0 == vlen
205      * (note: if 0 == vlen, header is still inserted with blank value,
206      *  which is used to indicate a "removed" header)
207      */
208     if (id > HTTP_HEADER_OTHER)
209         (vlen) ? (r->rqst_htags |= id) : (r->rqst_htags &= ~id);
210     array_set_key_value(&r->rqst_headers, k, klen, v, vlen);
211 }
212 
213 void http_header_request_append(request_st * const r, enum http_header_e id, const char *k, uint32_t klen, const char *v, uint32_t vlen) {
214     if (0 == vlen) return;
215     if (id > HTTP_HEADER_OTHER) r->rqst_htags |= id;
216     buffer * const vb = array_get_buf_ptr(&r->rqst_headers, k, klen);
217     http_header_token_append(vb, v, vlen);
218 }
219 
220 
221 buffer * http_header_env_get(const request_st * const r, const char *k, uint32_t klen) {
222     return http_header_generic_get_ifnotempty(&r->env, k, klen);
223 }
224 
225 void http_header_env_set(request_st * const r, const char *k, uint32_t klen, const char *v, uint32_t vlen) {
226     array_set_key_value(&r->env, k, klen, v, vlen);
227 }
228 
229 void http_header_env_append(request_st * const r, const char *k, uint32_t klen, const char *v, uint32_t vlen) {
230     /*if (0 == vlen) return;*//* skip check; permit env var w/ blank value */
231     buffer * const vb = array_get_buf_ptr(&r->env, k, klen);
232     if (0 == vlen) return;
233     http_header_token_append(vb, v, vlen);
234 }
235