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