xref: /lighttpd1.4/src/http_kv.c (revision 3392e8fb)
1 /*
2  * http_kv - HTTP version, method, status key-value string mapping
3  *
4  * Fully-rewritten from original
5  * Copyright(c) 2018 Glenn Strauss gstrauss()gluelogic.com  All rights reserved
6  * License: BSD 3-clause (same as lighttpd)
7  */
8 #include "first.h"
9 
10 #include "http_kv.h"
11 #include "buffer.h"
12 
13 #include <string.h>
14 
15 typedef struct {
16 	int key;
17 	unsigned int vlen;
18 	const char *value;
19 } keyvalue;
20 
21 static const keyvalue http_versions[] = {
22 	{ HTTP_VERSION_2,   CONST_LEN_STR("HTTP/2.0") }, /* SERVER_PROTOCOL */
23 	{ HTTP_VERSION_1_1, CONST_LEN_STR("HTTP/1.1") },
24 	{ HTTP_VERSION_1_0, CONST_LEN_STR("HTTP/1.0") },
25 	{ HTTP_VERSION_UNSET, 0, NULL }
26 };
27 
28 static const keyvalue http_methods[] = {
29 	{ HTTP_METHOD_GET,                 CONST_LEN_STR("GET") },
30 	{ HTTP_METHOD_HEAD,                CONST_LEN_STR("HEAD") },
31 	{ HTTP_METHOD_POST,                CONST_LEN_STR("POST") },
32 	{ HTTP_METHOD_PUT,                 CONST_LEN_STR("PUT") },
33 	{ HTTP_METHOD_DELETE,              CONST_LEN_STR("DELETE") },
34 	{ HTTP_METHOD_CONNECT,             CONST_LEN_STR("CONNECT") },
35 	{ HTTP_METHOD_OPTIONS,             CONST_LEN_STR("OPTIONS") },
36 	{ HTTP_METHOD_TRACE,               CONST_LEN_STR("TRACE") },
37 	{ HTTP_METHOD_ACL,                 CONST_LEN_STR("ACL") },
38 	{ HTTP_METHOD_BASELINE_CONTROL,    CONST_LEN_STR("BASELINE-CONTROL") },
39 	{ HTTP_METHOD_BIND,                CONST_LEN_STR("BIND") },
40 	{ HTTP_METHOD_CHECKIN,             CONST_LEN_STR("CHECKIN") },
41 	{ HTTP_METHOD_CHECKOUT,            CONST_LEN_STR("CHECKOUT") },
42 	{ HTTP_METHOD_COPY,                CONST_LEN_STR("COPY") },
43 	{ HTTP_METHOD_LABEL,               CONST_LEN_STR("LABEL") },
44 	{ HTTP_METHOD_LINK,                CONST_LEN_STR("LINK") },
45 	{ HTTP_METHOD_LOCK,                CONST_LEN_STR("LOCK") },
46 	{ HTTP_METHOD_MERGE,               CONST_LEN_STR("MERGE") },
47 	{ HTTP_METHOD_MKACTIVITY,          CONST_LEN_STR("MKACTIVITY") },
48 	{ HTTP_METHOD_MKCALENDAR,          CONST_LEN_STR("MKCALENDAR") },
49 	{ HTTP_METHOD_MKCOL,               CONST_LEN_STR("MKCOL") },
50 	{ HTTP_METHOD_MKREDIRECTREF,       CONST_LEN_STR("MKREDIRECTREF") },
51 	{ HTTP_METHOD_MKWORKSPACE,         CONST_LEN_STR("MKWORKSPACE") },
52 	{ HTTP_METHOD_MOVE,                CONST_LEN_STR("MOVE") },
53 	{ HTTP_METHOD_ORDERPATCH,          CONST_LEN_STR("ORDERPATCH") },
54 	{ HTTP_METHOD_PATCH,               CONST_LEN_STR("PATCH") },
55 	{ HTTP_METHOD_PROPFIND,            CONST_LEN_STR("PROPFIND") },
56 	{ HTTP_METHOD_PROPPATCH,           CONST_LEN_STR("PROPPATCH") },
57 	{ HTTP_METHOD_REBIND,              CONST_LEN_STR("REBIND") },
58 	{ HTTP_METHOD_REPORT,              CONST_LEN_STR("REPORT") },
59 	{ HTTP_METHOD_SEARCH,              CONST_LEN_STR("SEARCH") },
60 	{ HTTP_METHOD_UNBIND,              CONST_LEN_STR("UNBIND") },
61 	{ HTTP_METHOD_UNCHECKOUT,          CONST_LEN_STR("UNCHECKOUT") },
62 	{ HTTP_METHOD_UNLINK,              CONST_LEN_STR("UNLINK") },
63 	{ HTTP_METHOD_UNLOCK,              CONST_LEN_STR("UNLOCK") },
64 	{ HTTP_METHOD_UPDATE,              CONST_LEN_STR("UPDATE") },
65 	{ HTTP_METHOD_UPDATEREDIRECTREF,   CONST_LEN_STR("UPDATEREDIRECTREF") },
66 	{ HTTP_METHOD_VERSION_CONTROL,     CONST_LEN_STR("VERSION-CONTROL") },
67 
68 	{ HTTP_METHOD_PRI,                 CONST_LEN_STR("PRI") },
69 	{ HTTP_METHOD_UNSET, 0, NULL }
70 };
71 
72 /* https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml */
73 static const keyvalue http_status[] = {
74 	{ 100, CONST_LEN_STR("100 Continue") },
75 	{ 101, CONST_LEN_STR("101 Switching Protocols") },
76 	{ 102, CONST_LEN_STR("102 Processing") }, /* WebDAV */
77 	{ 103, CONST_LEN_STR("103 Early Hints") },
78 	{ 200, CONST_LEN_STR("200 OK") },
79 	{ 201, CONST_LEN_STR("201 Created") },
80 	{ 202, CONST_LEN_STR("202 Accepted") },
81 	{ 203, CONST_LEN_STR("203 Non-Authoritative Information") },
82 	{ 204, CONST_LEN_STR("204 No Content") },
83 	{ 205, CONST_LEN_STR("205 Reset Content") },
84 	{ 206, CONST_LEN_STR("206 Partial Content") },
85 	{ 207, CONST_LEN_STR("207 Multi-status") }, /* WebDAV */
86 	{ 208, CONST_LEN_STR("208 Already Reported") },
87 	{ 226, CONST_LEN_STR("226 IM Used") },
88 	{ 300, CONST_LEN_STR("300 Multiple Choices") },
89 	{ 301, CONST_LEN_STR("301 Moved Permanently") },
90 	{ 302, CONST_LEN_STR("302 Found") },
91 	{ 303, CONST_LEN_STR("303 See Other") },
92 	{ 304, CONST_LEN_STR("304 Not Modified") },
93 	{ 305, CONST_LEN_STR("305 Use Proxy") },
94 	{ 306, CONST_LEN_STR("306 (Unused)") },
95 	{ 307, CONST_LEN_STR("307 Temporary Redirect") },
96 	{ 308, CONST_LEN_STR("308 Permanent Redirect") },
97 	{ 400, CONST_LEN_STR("400 Bad Request") },
98 	{ 401, CONST_LEN_STR("401 Unauthorized") },
99 	{ 402, CONST_LEN_STR("402 Payment Required") },
100 	{ 403, CONST_LEN_STR("403 Forbidden") },
101 	{ 404, CONST_LEN_STR("404 Not Found") },
102 	{ 405, CONST_LEN_STR("405 Method Not Allowed") },
103 	{ 406, CONST_LEN_STR("406 Not Acceptable") },
104 	{ 407, CONST_LEN_STR("407 Proxy Authentication Required") },
105 	{ 408, CONST_LEN_STR("408 Request Timeout") },
106 	{ 409, CONST_LEN_STR("409 Conflict") },
107 	{ 410, CONST_LEN_STR("410 Gone") },
108 	{ 411, CONST_LEN_STR("411 Length Required") },
109 	{ 412, CONST_LEN_STR("412 Precondition Failed") },
110 	{ 413, CONST_LEN_STR("413 Payload Too Large") },
111 	{ 414, CONST_LEN_STR("414 URI Too Long") },
112 	{ 415, CONST_LEN_STR("415 Unsupported Media Type") },
113 	{ 416, CONST_LEN_STR("416 Range Not Satisfiable") },
114 	{ 417, CONST_LEN_STR("417 Expectation Failed") },
115 	{ 421, CONST_LEN_STR("421 Misdirected Request") }, /* RFC 7540 */
116 	{ 422, CONST_LEN_STR("422 Unprocessable Entity") }, /* WebDAV */
117 	{ 423, CONST_LEN_STR("423 Locked") }, /* WebDAV */
118 	{ 424, CONST_LEN_STR("424 Failed Dependency") }, /* WebDAV */
119 	{ 426, CONST_LEN_STR("426 Upgrade Required") }, /* TLS */
120 	{ 428, CONST_LEN_STR("428 Precondition Required") },
121 	{ 429, CONST_LEN_STR("429 Too Many Requests") },
122 	{ 431, CONST_LEN_STR("431 Request Header Fields Too Large") },
123 	{ 451, CONST_LEN_STR("451 Unavailable For Legal Reasons") },
124 	{ 500, CONST_LEN_STR("500 Internal Server Error") },
125 	{ 501, CONST_LEN_STR("501 Not Implemented") },
126 	{ 502, CONST_LEN_STR("502 Bad Gateway") },
127 	{ 503, CONST_LEN_STR("503 Service Unavailable") },
128 	{ 504, CONST_LEN_STR("504 Gateway Timeout") },
129 	{ 505, CONST_LEN_STR("505 HTTP Version Not Supported") },
130 	{ 506, CONST_LEN_STR("506 Variant Also Negotiates") },
131 	{ 507, CONST_LEN_STR("507 Insufficient Storage") }, /* WebDAV */
132 	{ 508, CONST_LEN_STR("508 Loop Detected") },
133 	{ 510, CONST_LEN_STR("510 Not Extended") },
134 	{ 511, CONST_LEN_STR("511 Network Authentication Required") },
135 
136 	{ -1, 0, NULL }
137 };
138 
139 
140 __attribute_noinline__
141 __attribute_pure__
142 static const keyvalue * keyvalue_from_key (const keyvalue *kv, const int k)
143 {
144     /*(expects sentinel to have key == -1 and value == NULL)*/
145     while (kv->key != k && kv->key != -1) ++kv;
146     return kv;
147 }
148 
149 
150 __attribute_pure__
151 static int keyvalue_get_key(const keyvalue *kv, const char * const s, const unsigned int slen)
152 {
153     /*(expects sentinel to have key == -1 and vlen == 0)*/
154     while (kv->vlen && (kv->vlen != slen || 0 != memcmp(kv->value, s, slen)))
155         ++kv;
156     return kv->key;
157 }
158 
159 
160 const char *get_http_version_name(int i) {
161     return keyvalue_from_key(http_versions, i)->value;
162 }
163 
164 const char *get_http_status_name(int i) {
165     return keyvalue_from_key(http_status, i)->value;
166 }
167 
168 const char *get_http_method_name(http_method_t i) {
169     return keyvalue_from_key(http_methods, i)->value;
170 }
171 
172 #if 0 /*(unused)*/
173 int get_http_version_key(const char *s, size_t slen) {
174     return keyvalue_get_key(http_versions, s, (unsigned int)slen);
175 }
176 #endif
177 
178 http_method_t get_http_method_key(const char *s, const size_t slen) {
179     if (slen == 3 && s[0] == 'G' && s[1] == 'E' && s[2] == 'T')
180         return HTTP_METHOD_GET;
181     return (http_method_t)keyvalue_get_key(http_methods, s, (unsigned int)slen);
182 }
183 
184 
185 void http_status_append(buffer * const b, const int status) {
186     if (200 == status) { /*(short-circuit common case)*/
187         buffer_append_string_len(b, CONST_STR_LEN("200 OK"));
188         return;
189     }
190 
191     const keyvalue * const kv = keyvalue_from_key(http_status, status);
192     if (__builtin_expect( (0 != kv->vlen), 1))
193         buffer_append_string_len(b, kv->value, kv->vlen);
194     else {
195         buffer_append_int(b, status);
196         buffer_append_string_len(b, CONST_STR_LEN(" "));
197     }
198 }
199 
200 void http_method_append(buffer * const b, const http_method_t method) {
201     const keyvalue * const kv = keyvalue_from_key(http_methods, method);
202     if (__builtin_expect( (0 != kv->vlen), 1))
203         buffer_append_string_len(b, kv->value, kv->vlen);
204 }
205 
206 void http_version_append(buffer * const b, const http_version_t version) {
207     const keyvalue * const kv = keyvalue_from_key(http_versions, version);
208     if (__builtin_expect( (0 != kv->vlen), 1))
209         buffer_append_string_len(b, kv->value, kv->vlen);
210 }
211