1 2 #ifndef INCLUDE_LLHTTP_H_ 3 #define INCLUDE_LLHTTP_H_ 4 5 #define LLHTTP_VERSION_MAJOR 9 6 #define LLHTTP_VERSION_MINOR 2 7 #define LLHTTP_VERSION_PATCH 1 8 9 #ifndef INCLUDE_LLHTTP_ITSELF_H_ 10 #define INCLUDE_LLHTTP_ITSELF_H_ 11 #ifdef __cplusplus 12 extern "C" { 13 #endif 14 15 #include <stdint.h> 16 17 typedef struct llhttp__internal_s llhttp__internal_t; 18 struct llhttp__internal_s { 19 int32_t _index; 20 void* _span_pos0; 21 void* _span_cb0; 22 int32_t error; 23 const char* reason; 24 const char* error_pos; 25 void* data; 26 void* _current; 27 uint64_t content_length; 28 uint8_t type; 29 uint8_t method; 30 uint8_t http_major; 31 uint8_t http_minor; 32 uint8_t header_state; 33 uint16_t lenient_flags; 34 uint8_t upgrade; 35 uint8_t finish; 36 uint16_t flags; 37 uint16_t status_code; 38 uint8_t initial_message_completed; 39 void* settings; 40 }; 41 42 int llhttp__internal_init(llhttp__internal_t* s); 43 int llhttp__internal_execute(llhttp__internal_t* s, const char* p, const char* endp); 44 45 #ifdef __cplusplus 46 } /* extern "C" */ 47 #endif 48 #endif /* INCLUDE_LLHTTP_ITSELF_H_ */ 49 50 51 #ifndef LLLLHTTP_C_HEADERS_ 52 #define LLLLHTTP_C_HEADERS_ 53 #ifdef __cplusplus 54 extern "C" { 55 #endif 56 57 enum llhttp_errno { 58 HPE_OK = 0, 59 HPE_INTERNAL = 1, 60 HPE_STRICT = 2, 61 HPE_CR_EXPECTED = 25, 62 HPE_LF_EXPECTED = 3, 63 HPE_UNEXPECTED_CONTENT_LENGTH = 4, 64 HPE_UNEXPECTED_SPACE = 30, 65 HPE_CLOSED_CONNECTION = 5, 66 HPE_INVALID_METHOD = 6, 67 HPE_INVALID_URL = 7, 68 HPE_INVALID_CONSTANT = 8, 69 HPE_INVALID_VERSION = 9, 70 HPE_INVALID_HEADER_TOKEN = 10, 71 HPE_INVALID_CONTENT_LENGTH = 11, 72 HPE_INVALID_CHUNK_SIZE = 12, 73 HPE_INVALID_STATUS = 13, 74 HPE_INVALID_EOF_STATE = 14, 75 HPE_INVALID_TRANSFER_ENCODING = 15, 76 HPE_CB_MESSAGE_BEGIN = 16, 77 HPE_CB_HEADERS_COMPLETE = 17, 78 HPE_CB_MESSAGE_COMPLETE = 18, 79 HPE_CB_CHUNK_HEADER = 19, 80 HPE_CB_CHUNK_COMPLETE = 20, 81 HPE_PAUSED = 21, 82 HPE_PAUSED_UPGRADE = 22, 83 HPE_PAUSED_H2_UPGRADE = 23, 84 HPE_USER = 24, 85 HPE_CB_URL_COMPLETE = 26, 86 HPE_CB_STATUS_COMPLETE = 27, 87 HPE_CB_METHOD_COMPLETE = 32, 88 HPE_CB_VERSION_COMPLETE = 33, 89 HPE_CB_HEADER_FIELD_COMPLETE = 28, 90 HPE_CB_HEADER_VALUE_COMPLETE = 29, 91 HPE_CB_CHUNK_EXTENSION_NAME_COMPLETE = 34, 92 HPE_CB_CHUNK_EXTENSION_VALUE_COMPLETE = 35, 93 HPE_CB_RESET = 31 94 }; 95 typedef enum llhttp_errno llhttp_errno_t; 96 97 enum llhttp_flags { 98 F_CONNECTION_KEEP_ALIVE = 0x1, 99 F_CONNECTION_CLOSE = 0x2, 100 F_CONNECTION_UPGRADE = 0x4, 101 F_CHUNKED = 0x8, 102 F_UPGRADE = 0x10, 103 F_CONTENT_LENGTH = 0x20, 104 F_SKIPBODY = 0x40, 105 F_TRAILING = 0x80, 106 F_TRANSFER_ENCODING = 0x200 107 }; 108 typedef enum llhttp_flags llhttp_flags_t; 109 110 enum llhttp_lenient_flags { 111 LENIENT_HEADERS = 0x1, 112 LENIENT_CHUNKED_LENGTH = 0x2, 113 LENIENT_KEEP_ALIVE = 0x4, 114 LENIENT_TRANSFER_ENCODING = 0x8, 115 LENIENT_VERSION = 0x10, 116 LENIENT_DATA_AFTER_CLOSE = 0x20, 117 LENIENT_OPTIONAL_LF_AFTER_CR = 0x40, 118 LENIENT_OPTIONAL_CRLF_AFTER_CHUNK = 0x80, 119 LENIENT_OPTIONAL_CR_BEFORE_LF = 0x100, 120 LENIENT_SPACES_AFTER_CHUNK_SIZE = 0x200 121 }; 122 typedef enum llhttp_lenient_flags llhttp_lenient_flags_t; 123 124 enum llhttp_type { 125 HTTP_BOTH = 0, 126 HTTP_REQUEST = 1, 127 HTTP_RESPONSE = 2 128 }; 129 typedef enum llhttp_type llhttp_type_t; 130 131 enum llhttp_finish { 132 HTTP_FINISH_SAFE = 0, 133 HTTP_FINISH_SAFE_WITH_CB = 1, 134 HTTP_FINISH_UNSAFE = 2 135 }; 136 typedef enum llhttp_finish llhttp_finish_t; 137 138 enum llhttp_method { 139 HTTP_DELETE = 0, 140 HTTP_GET = 1, 141 HTTP_HEAD = 2, 142 HTTP_POST = 3, 143 HTTP_PUT = 4, 144 HTTP_CONNECT = 5, 145 HTTP_OPTIONS = 6, 146 HTTP_TRACE = 7, 147 HTTP_COPY = 8, 148 HTTP_LOCK = 9, 149 HTTP_MKCOL = 10, 150 HTTP_MOVE = 11, 151 HTTP_PROPFIND = 12, 152 HTTP_PROPPATCH = 13, 153 HTTP_SEARCH = 14, 154 HTTP_UNLOCK = 15, 155 HTTP_BIND = 16, 156 HTTP_REBIND = 17, 157 HTTP_UNBIND = 18, 158 HTTP_ACL = 19, 159 HTTP_REPORT = 20, 160 HTTP_MKACTIVITY = 21, 161 HTTP_CHECKOUT = 22, 162 HTTP_MERGE = 23, 163 HTTP_MSEARCH = 24, 164 HTTP_NOTIFY = 25, 165 HTTP_SUBSCRIBE = 26, 166 HTTP_UNSUBSCRIBE = 27, 167 HTTP_PATCH = 28, 168 HTTP_PURGE = 29, 169 HTTP_MKCALENDAR = 30, 170 HTTP_LINK = 31, 171 HTTP_UNLINK = 32, 172 HTTP_SOURCE = 33, 173 HTTP_PRI = 34, 174 HTTP_DESCRIBE = 35, 175 HTTP_ANNOUNCE = 36, 176 HTTP_SETUP = 37, 177 HTTP_PLAY = 38, 178 HTTP_PAUSE = 39, 179 HTTP_TEARDOWN = 40, 180 HTTP_GET_PARAMETER = 41, 181 HTTP_SET_PARAMETER = 42, 182 HTTP_REDIRECT = 43, 183 HTTP_RECORD = 44, 184 HTTP_FLUSH = 45, 185 HTTP_QUERY = 46 186 }; 187 typedef enum llhttp_method llhttp_method_t; 188 189 enum llhttp_status { 190 HTTP_STATUS_CONTINUE = 100, 191 HTTP_STATUS_SWITCHING_PROTOCOLS = 101, 192 HTTP_STATUS_PROCESSING = 102, 193 HTTP_STATUS_EARLY_HINTS = 103, 194 HTTP_STATUS_RESPONSE_IS_STALE = 110, 195 HTTP_STATUS_REVALIDATION_FAILED = 111, 196 HTTP_STATUS_DISCONNECTED_OPERATION = 112, 197 HTTP_STATUS_HEURISTIC_EXPIRATION = 113, 198 HTTP_STATUS_MISCELLANEOUS_WARNING = 199, 199 HTTP_STATUS_OK = 200, 200 HTTP_STATUS_CREATED = 201, 201 HTTP_STATUS_ACCEPTED = 202, 202 HTTP_STATUS_NON_AUTHORITATIVE_INFORMATION = 203, 203 HTTP_STATUS_NO_CONTENT = 204, 204 HTTP_STATUS_RESET_CONTENT = 205, 205 HTTP_STATUS_PARTIAL_CONTENT = 206, 206 HTTP_STATUS_MULTI_STATUS = 207, 207 HTTP_STATUS_ALREADY_REPORTED = 208, 208 HTTP_STATUS_TRANSFORMATION_APPLIED = 214, 209 HTTP_STATUS_IM_USED = 226, 210 HTTP_STATUS_MISCELLANEOUS_PERSISTENT_WARNING = 299, 211 HTTP_STATUS_MULTIPLE_CHOICES = 300, 212 HTTP_STATUS_MOVED_PERMANENTLY = 301, 213 HTTP_STATUS_FOUND = 302, 214 HTTP_STATUS_SEE_OTHER = 303, 215 HTTP_STATUS_NOT_MODIFIED = 304, 216 HTTP_STATUS_USE_PROXY = 305, 217 HTTP_STATUS_SWITCH_PROXY = 306, 218 HTTP_STATUS_TEMPORARY_REDIRECT = 307, 219 HTTP_STATUS_PERMANENT_REDIRECT = 308, 220 HTTP_STATUS_BAD_REQUEST = 400, 221 HTTP_STATUS_UNAUTHORIZED = 401, 222 HTTP_STATUS_PAYMENT_REQUIRED = 402, 223 HTTP_STATUS_FORBIDDEN = 403, 224 HTTP_STATUS_NOT_FOUND = 404, 225 HTTP_STATUS_METHOD_NOT_ALLOWED = 405, 226 HTTP_STATUS_NOT_ACCEPTABLE = 406, 227 HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED = 407, 228 HTTP_STATUS_REQUEST_TIMEOUT = 408, 229 HTTP_STATUS_CONFLICT = 409, 230 HTTP_STATUS_GONE = 410, 231 HTTP_STATUS_LENGTH_REQUIRED = 411, 232 HTTP_STATUS_PRECONDITION_FAILED = 412, 233 HTTP_STATUS_PAYLOAD_TOO_LARGE = 413, 234 HTTP_STATUS_URI_TOO_LONG = 414, 235 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE = 415, 236 HTTP_STATUS_RANGE_NOT_SATISFIABLE = 416, 237 HTTP_STATUS_EXPECTATION_FAILED = 417, 238 HTTP_STATUS_IM_A_TEAPOT = 418, 239 HTTP_STATUS_PAGE_EXPIRED = 419, 240 HTTP_STATUS_ENHANCE_YOUR_CALM = 420, 241 HTTP_STATUS_MISDIRECTED_REQUEST = 421, 242 HTTP_STATUS_UNPROCESSABLE_ENTITY = 422, 243 HTTP_STATUS_LOCKED = 423, 244 HTTP_STATUS_FAILED_DEPENDENCY = 424, 245 HTTP_STATUS_TOO_EARLY = 425, 246 HTTP_STATUS_UPGRADE_REQUIRED = 426, 247 HTTP_STATUS_PRECONDITION_REQUIRED = 428, 248 HTTP_STATUS_TOO_MANY_REQUESTS = 429, 249 HTTP_STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE_UNOFFICIAL = 430, 250 HTTP_STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE = 431, 251 HTTP_STATUS_LOGIN_TIMEOUT = 440, 252 HTTP_STATUS_NO_RESPONSE = 444, 253 HTTP_STATUS_RETRY_WITH = 449, 254 HTTP_STATUS_BLOCKED_BY_PARENTAL_CONTROL = 450, 255 HTTP_STATUS_UNAVAILABLE_FOR_LEGAL_REASONS = 451, 256 HTTP_STATUS_CLIENT_CLOSED_LOAD_BALANCED_REQUEST = 460, 257 HTTP_STATUS_INVALID_X_FORWARDED_FOR = 463, 258 HTTP_STATUS_REQUEST_HEADER_TOO_LARGE = 494, 259 HTTP_STATUS_SSL_CERTIFICATE_ERROR = 495, 260 HTTP_STATUS_SSL_CERTIFICATE_REQUIRED = 496, 261 HTTP_STATUS_HTTP_REQUEST_SENT_TO_HTTPS_PORT = 497, 262 HTTP_STATUS_INVALID_TOKEN = 498, 263 HTTP_STATUS_CLIENT_CLOSED_REQUEST = 499, 264 HTTP_STATUS_INTERNAL_SERVER_ERROR = 500, 265 HTTP_STATUS_NOT_IMPLEMENTED = 501, 266 HTTP_STATUS_BAD_GATEWAY = 502, 267 HTTP_STATUS_SERVICE_UNAVAILABLE = 503, 268 HTTP_STATUS_GATEWAY_TIMEOUT = 504, 269 HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED = 505, 270 HTTP_STATUS_VARIANT_ALSO_NEGOTIATES = 506, 271 HTTP_STATUS_INSUFFICIENT_STORAGE = 507, 272 HTTP_STATUS_LOOP_DETECTED = 508, 273 HTTP_STATUS_BANDWIDTH_LIMIT_EXCEEDED = 509, 274 HTTP_STATUS_NOT_EXTENDED = 510, 275 HTTP_STATUS_NETWORK_AUTHENTICATION_REQUIRED = 511, 276 HTTP_STATUS_WEB_SERVER_UNKNOWN_ERROR = 520, 277 HTTP_STATUS_WEB_SERVER_IS_DOWN = 521, 278 HTTP_STATUS_CONNECTION_TIMEOUT = 522, 279 HTTP_STATUS_ORIGIN_IS_UNREACHABLE = 523, 280 HTTP_STATUS_TIMEOUT_OCCURED = 524, 281 HTTP_STATUS_SSL_HANDSHAKE_FAILED = 525, 282 HTTP_STATUS_INVALID_SSL_CERTIFICATE = 526, 283 HTTP_STATUS_RAILGUN_ERROR = 527, 284 HTTP_STATUS_SITE_IS_OVERLOADED = 529, 285 HTTP_STATUS_SITE_IS_FROZEN = 530, 286 HTTP_STATUS_IDENTITY_PROVIDER_AUTHENTICATION_ERROR = 561, 287 HTTP_STATUS_NETWORK_READ_TIMEOUT = 598, 288 HTTP_STATUS_NETWORK_CONNECT_TIMEOUT = 599 289 }; 290 typedef enum llhttp_status llhttp_status_t; 291 292 #define HTTP_ERRNO_MAP(XX) \ 293 XX(0, OK, OK) \ 294 XX(1, INTERNAL, INTERNAL) \ 295 XX(2, STRICT, STRICT) \ 296 XX(25, CR_EXPECTED, CR_EXPECTED) \ 297 XX(3, LF_EXPECTED, LF_EXPECTED) \ 298 XX(4, UNEXPECTED_CONTENT_LENGTH, UNEXPECTED_CONTENT_LENGTH) \ 299 XX(30, UNEXPECTED_SPACE, UNEXPECTED_SPACE) \ 300 XX(5, CLOSED_CONNECTION, CLOSED_CONNECTION) \ 301 XX(6, INVALID_METHOD, INVALID_METHOD) \ 302 XX(7, INVALID_URL, INVALID_URL) \ 303 XX(8, INVALID_CONSTANT, INVALID_CONSTANT) \ 304 XX(9, INVALID_VERSION, INVALID_VERSION) \ 305 XX(10, INVALID_HEADER_TOKEN, INVALID_HEADER_TOKEN) \ 306 XX(11, INVALID_CONTENT_LENGTH, INVALID_CONTENT_LENGTH) \ 307 XX(12, INVALID_CHUNK_SIZE, INVALID_CHUNK_SIZE) \ 308 XX(13, INVALID_STATUS, INVALID_STATUS) \ 309 XX(14, INVALID_EOF_STATE, INVALID_EOF_STATE) \ 310 XX(15, INVALID_TRANSFER_ENCODING, INVALID_TRANSFER_ENCODING) \ 311 XX(16, CB_MESSAGE_BEGIN, CB_MESSAGE_BEGIN) \ 312 XX(17, CB_HEADERS_COMPLETE, CB_HEADERS_COMPLETE) \ 313 XX(18, CB_MESSAGE_COMPLETE, CB_MESSAGE_COMPLETE) \ 314 XX(19, CB_CHUNK_HEADER, CB_CHUNK_HEADER) \ 315 XX(20, CB_CHUNK_COMPLETE, CB_CHUNK_COMPLETE) \ 316 XX(21, PAUSED, PAUSED) \ 317 XX(22, PAUSED_UPGRADE, PAUSED_UPGRADE) \ 318 XX(23, PAUSED_H2_UPGRADE, PAUSED_H2_UPGRADE) \ 319 XX(24, USER, USER) \ 320 XX(26, CB_URL_COMPLETE, CB_URL_COMPLETE) \ 321 XX(27, CB_STATUS_COMPLETE, CB_STATUS_COMPLETE) \ 322 XX(32, CB_METHOD_COMPLETE, CB_METHOD_COMPLETE) \ 323 XX(33, CB_VERSION_COMPLETE, CB_VERSION_COMPLETE) \ 324 XX(28, CB_HEADER_FIELD_COMPLETE, CB_HEADER_FIELD_COMPLETE) \ 325 XX(29, CB_HEADER_VALUE_COMPLETE, CB_HEADER_VALUE_COMPLETE) \ 326 XX(34, CB_CHUNK_EXTENSION_NAME_COMPLETE, CB_CHUNK_EXTENSION_NAME_COMPLETE) \ 327 XX(35, CB_CHUNK_EXTENSION_VALUE_COMPLETE, CB_CHUNK_EXTENSION_VALUE_COMPLETE) \ 328 XX(31, CB_RESET, CB_RESET) \ 329 330 331 #define HTTP_METHOD_MAP(XX) \ 332 XX(0, DELETE, DELETE) \ 333 XX(1, GET, GET) \ 334 XX(2, HEAD, HEAD) \ 335 XX(3, POST, POST) \ 336 XX(4, PUT, PUT) \ 337 XX(5, CONNECT, CONNECT) \ 338 XX(6, OPTIONS, OPTIONS) \ 339 XX(7, TRACE, TRACE) \ 340 XX(8, COPY, COPY) \ 341 XX(9, LOCK, LOCK) \ 342 XX(10, MKCOL, MKCOL) \ 343 XX(11, MOVE, MOVE) \ 344 XX(12, PROPFIND, PROPFIND) \ 345 XX(13, PROPPATCH, PROPPATCH) \ 346 XX(14, SEARCH, SEARCH) \ 347 XX(15, UNLOCK, UNLOCK) \ 348 XX(16, BIND, BIND) \ 349 XX(17, REBIND, REBIND) \ 350 XX(18, UNBIND, UNBIND) \ 351 XX(19, ACL, ACL) \ 352 XX(20, REPORT, REPORT) \ 353 XX(21, MKACTIVITY, MKACTIVITY) \ 354 XX(22, CHECKOUT, CHECKOUT) \ 355 XX(23, MERGE, MERGE) \ 356 XX(24, MSEARCH, M-SEARCH) \ 357 XX(25, NOTIFY, NOTIFY) \ 358 XX(26, SUBSCRIBE, SUBSCRIBE) \ 359 XX(27, UNSUBSCRIBE, UNSUBSCRIBE) \ 360 XX(28, PATCH, PATCH) \ 361 XX(29, PURGE, PURGE) \ 362 XX(30, MKCALENDAR, MKCALENDAR) \ 363 XX(31, LINK, LINK) \ 364 XX(32, UNLINK, UNLINK) \ 365 XX(33, SOURCE, SOURCE) \ 366 XX(46, QUERY, QUERY) \ 367 368 369 #define RTSP_METHOD_MAP(XX) \ 370 XX(1, GET, GET) \ 371 XX(3, POST, POST) \ 372 XX(6, OPTIONS, OPTIONS) \ 373 XX(35, DESCRIBE, DESCRIBE) \ 374 XX(36, ANNOUNCE, ANNOUNCE) \ 375 XX(37, SETUP, SETUP) \ 376 XX(38, PLAY, PLAY) \ 377 XX(39, PAUSE, PAUSE) \ 378 XX(40, TEARDOWN, TEARDOWN) \ 379 XX(41, GET_PARAMETER, GET_PARAMETER) \ 380 XX(42, SET_PARAMETER, SET_PARAMETER) \ 381 XX(43, REDIRECT, REDIRECT) \ 382 XX(44, RECORD, RECORD) \ 383 XX(45, FLUSH, FLUSH) \ 384 385 386 #define HTTP_ALL_METHOD_MAP(XX) \ 387 XX(0, DELETE, DELETE) \ 388 XX(1, GET, GET) \ 389 XX(2, HEAD, HEAD) \ 390 XX(3, POST, POST) \ 391 XX(4, PUT, PUT) \ 392 XX(5, CONNECT, CONNECT) \ 393 XX(6, OPTIONS, OPTIONS) \ 394 XX(7, TRACE, TRACE) \ 395 XX(8, COPY, COPY) \ 396 XX(9, LOCK, LOCK) \ 397 XX(10, MKCOL, MKCOL) \ 398 XX(11, MOVE, MOVE) \ 399 XX(12, PROPFIND, PROPFIND) \ 400 XX(13, PROPPATCH, PROPPATCH) \ 401 XX(14, SEARCH, SEARCH) \ 402 XX(15, UNLOCK, UNLOCK) \ 403 XX(16, BIND, BIND) \ 404 XX(17, REBIND, REBIND) \ 405 XX(18, UNBIND, UNBIND) \ 406 XX(19, ACL, ACL) \ 407 XX(20, REPORT, REPORT) \ 408 XX(21, MKACTIVITY, MKACTIVITY) \ 409 XX(22, CHECKOUT, CHECKOUT) \ 410 XX(23, MERGE, MERGE) \ 411 XX(24, MSEARCH, M-SEARCH) \ 412 XX(25, NOTIFY, NOTIFY) \ 413 XX(26, SUBSCRIBE, SUBSCRIBE) \ 414 XX(27, UNSUBSCRIBE, UNSUBSCRIBE) \ 415 XX(28, PATCH, PATCH) \ 416 XX(29, PURGE, PURGE) \ 417 XX(30, MKCALENDAR, MKCALENDAR) \ 418 XX(31, LINK, LINK) \ 419 XX(32, UNLINK, UNLINK) \ 420 XX(33, SOURCE, SOURCE) \ 421 XX(34, PRI, PRI) \ 422 XX(35, DESCRIBE, DESCRIBE) \ 423 XX(36, ANNOUNCE, ANNOUNCE) \ 424 XX(37, SETUP, SETUP) \ 425 XX(38, PLAY, PLAY) \ 426 XX(39, PAUSE, PAUSE) \ 427 XX(40, TEARDOWN, TEARDOWN) \ 428 XX(41, GET_PARAMETER, GET_PARAMETER) \ 429 XX(42, SET_PARAMETER, SET_PARAMETER) \ 430 XX(43, REDIRECT, REDIRECT) \ 431 XX(44, RECORD, RECORD) \ 432 XX(45, FLUSH, FLUSH) \ 433 XX(46, QUERY, QUERY) \ 434 435 436 #define HTTP_STATUS_MAP(XX) \ 437 XX(100, CONTINUE, CONTINUE) \ 438 XX(101, SWITCHING_PROTOCOLS, SWITCHING_PROTOCOLS) \ 439 XX(102, PROCESSING, PROCESSING) \ 440 XX(103, EARLY_HINTS, EARLY_HINTS) \ 441 XX(110, RESPONSE_IS_STALE, RESPONSE_IS_STALE) \ 442 XX(111, REVALIDATION_FAILED, REVALIDATION_FAILED) \ 443 XX(112, DISCONNECTED_OPERATION, DISCONNECTED_OPERATION) \ 444 XX(113, HEURISTIC_EXPIRATION, HEURISTIC_EXPIRATION) \ 445 XX(199, MISCELLANEOUS_WARNING, MISCELLANEOUS_WARNING) \ 446 XX(200, OK, OK) \ 447 XX(201, CREATED, CREATED) \ 448 XX(202, ACCEPTED, ACCEPTED) \ 449 XX(203, NON_AUTHORITATIVE_INFORMATION, NON_AUTHORITATIVE_INFORMATION) \ 450 XX(204, NO_CONTENT, NO_CONTENT) \ 451 XX(205, RESET_CONTENT, RESET_CONTENT) \ 452 XX(206, PARTIAL_CONTENT, PARTIAL_CONTENT) \ 453 XX(207, MULTI_STATUS, MULTI_STATUS) \ 454 XX(208, ALREADY_REPORTED, ALREADY_REPORTED) \ 455 XX(214, TRANSFORMATION_APPLIED, TRANSFORMATION_APPLIED) \ 456 XX(226, IM_USED, IM_USED) \ 457 XX(299, MISCELLANEOUS_PERSISTENT_WARNING, MISCELLANEOUS_PERSISTENT_WARNING) \ 458 XX(300, MULTIPLE_CHOICES, MULTIPLE_CHOICES) \ 459 XX(301, MOVED_PERMANENTLY, MOVED_PERMANENTLY) \ 460 XX(302, FOUND, FOUND) \ 461 XX(303, SEE_OTHER, SEE_OTHER) \ 462 XX(304, NOT_MODIFIED, NOT_MODIFIED) \ 463 XX(305, USE_PROXY, USE_PROXY) \ 464 XX(306, SWITCH_PROXY, SWITCH_PROXY) \ 465 XX(307, TEMPORARY_REDIRECT, TEMPORARY_REDIRECT) \ 466 XX(308, PERMANENT_REDIRECT, PERMANENT_REDIRECT) \ 467 XX(400, BAD_REQUEST, BAD_REQUEST) \ 468 XX(401, UNAUTHORIZED, UNAUTHORIZED) \ 469 XX(402, PAYMENT_REQUIRED, PAYMENT_REQUIRED) \ 470 XX(403, FORBIDDEN, FORBIDDEN) \ 471 XX(404, NOT_FOUND, NOT_FOUND) \ 472 XX(405, METHOD_NOT_ALLOWED, METHOD_NOT_ALLOWED) \ 473 XX(406, NOT_ACCEPTABLE, NOT_ACCEPTABLE) \ 474 XX(407, PROXY_AUTHENTICATION_REQUIRED, PROXY_AUTHENTICATION_REQUIRED) \ 475 XX(408, REQUEST_TIMEOUT, REQUEST_TIMEOUT) \ 476 XX(409, CONFLICT, CONFLICT) \ 477 XX(410, GONE, GONE) \ 478 XX(411, LENGTH_REQUIRED, LENGTH_REQUIRED) \ 479 XX(412, PRECONDITION_FAILED, PRECONDITION_FAILED) \ 480 XX(413, PAYLOAD_TOO_LARGE, PAYLOAD_TOO_LARGE) \ 481 XX(414, URI_TOO_LONG, URI_TOO_LONG) \ 482 XX(415, UNSUPPORTED_MEDIA_TYPE, UNSUPPORTED_MEDIA_TYPE) \ 483 XX(416, RANGE_NOT_SATISFIABLE, RANGE_NOT_SATISFIABLE) \ 484 XX(417, EXPECTATION_FAILED, EXPECTATION_FAILED) \ 485 XX(418, IM_A_TEAPOT, IM_A_TEAPOT) \ 486 XX(419, PAGE_EXPIRED, PAGE_EXPIRED) \ 487 XX(420, ENHANCE_YOUR_CALM, ENHANCE_YOUR_CALM) \ 488 XX(421, MISDIRECTED_REQUEST, MISDIRECTED_REQUEST) \ 489 XX(422, UNPROCESSABLE_ENTITY, UNPROCESSABLE_ENTITY) \ 490 XX(423, LOCKED, LOCKED) \ 491 XX(424, FAILED_DEPENDENCY, FAILED_DEPENDENCY) \ 492 XX(425, TOO_EARLY, TOO_EARLY) \ 493 XX(426, UPGRADE_REQUIRED, UPGRADE_REQUIRED) \ 494 XX(428, PRECONDITION_REQUIRED, PRECONDITION_REQUIRED) \ 495 XX(429, TOO_MANY_REQUESTS, TOO_MANY_REQUESTS) \ 496 XX(430, REQUEST_HEADER_FIELDS_TOO_LARGE_UNOFFICIAL, REQUEST_HEADER_FIELDS_TOO_LARGE_UNOFFICIAL) \ 497 XX(431, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE) \ 498 XX(440, LOGIN_TIMEOUT, LOGIN_TIMEOUT) \ 499 XX(444, NO_RESPONSE, NO_RESPONSE) \ 500 XX(449, RETRY_WITH, RETRY_WITH) \ 501 XX(450, BLOCKED_BY_PARENTAL_CONTROL, BLOCKED_BY_PARENTAL_CONTROL) \ 502 XX(451, UNAVAILABLE_FOR_LEGAL_REASONS, UNAVAILABLE_FOR_LEGAL_REASONS) \ 503 XX(460, CLIENT_CLOSED_LOAD_BALANCED_REQUEST, CLIENT_CLOSED_LOAD_BALANCED_REQUEST) \ 504 XX(463, INVALID_X_FORWARDED_FOR, INVALID_X_FORWARDED_FOR) \ 505 XX(494, REQUEST_HEADER_TOO_LARGE, REQUEST_HEADER_TOO_LARGE) \ 506 XX(495, SSL_CERTIFICATE_ERROR, SSL_CERTIFICATE_ERROR) \ 507 XX(496, SSL_CERTIFICATE_REQUIRED, SSL_CERTIFICATE_REQUIRED) \ 508 XX(497, HTTP_REQUEST_SENT_TO_HTTPS_PORT, HTTP_REQUEST_SENT_TO_HTTPS_PORT) \ 509 XX(498, INVALID_TOKEN, INVALID_TOKEN) \ 510 XX(499, CLIENT_CLOSED_REQUEST, CLIENT_CLOSED_REQUEST) \ 511 XX(500, INTERNAL_SERVER_ERROR, INTERNAL_SERVER_ERROR) \ 512 XX(501, NOT_IMPLEMENTED, NOT_IMPLEMENTED) \ 513 XX(502, BAD_GATEWAY, BAD_GATEWAY) \ 514 XX(503, SERVICE_UNAVAILABLE, SERVICE_UNAVAILABLE) \ 515 XX(504, GATEWAY_TIMEOUT, GATEWAY_TIMEOUT) \ 516 XX(505, HTTP_VERSION_NOT_SUPPORTED, HTTP_VERSION_NOT_SUPPORTED) \ 517 XX(506, VARIANT_ALSO_NEGOTIATES, VARIANT_ALSO_NEGOTIATES) \ 518 XX(507, INSUFFICIENT_STORAGE, INSUFFICIENT_STORAGE) \ 519 XX(508, LOOP_DETECTED, LOOP_DETECTED) \ 520 XX(509, BANDWIDTH_LIMIT_EXCEEDED, BANDWIDTH_LIMIT_EXCEEDED) \ 521 XX(510, NOT_EXTENDED, NOT_EXTENDED) \ 522 XX(511, NETWORK_AUTHENTICATION_REQUIRED, NETWORK_AUTHENTICATION_REQUIRED) \ 523 XX(520, WEB_SERVER_UNKNOWN_ERROR, WEB_SERVER_UNKNOWN_ERROR) \ 524 XX(521, WEB_SERVER_IS_DOWN, WEB_SERVER_IS_DOWN) \ 525 XX(522, CONNECTION_TIMEOUT, CONNECTION_TIMEOUT) \ 526 XX(523, ORIGIN_IS_UNREACHABLE, ORIGIN_IS_UNREACHABLE) \ 527 XX(524, TIMEOUT_OCCURED, TIMEOUT_OCCURED) \ 528 XX(525, SSL_HANDSHAKE_FAILED, SSL_HANDSHAKE_FAILED) \ 529 XX(526, INVALID_SSL_CERTIFICATE, INVALID_SSL_CERTIFICATE) \ 530 XX(527, RAILGUN_ERROR, RAILGUN_ERROR) \ 531 XX(529, SITE_IS_OVERLOADED, SITE_IS_OVERLOADED) \ 532 XX(530, SITE_IS_FROZEN, SITE_IS_FROZEN) \ 533 XX(561, IDENTITY_PROVIDER_AUTHENTICATION_ERROR, IDENTITY_PROVIDER_AUTHENTICATION_ERROR) \ 534 XX(598, NETWORK_READ_TIMEOUT, NETWORK_READ_TIMEOUT) \ 535 XX(599, NETWORK_CONNECT_TIMEOUT, NETWORK_CONNECT_TIMEOUT) \ 536 537 538 #ifdef __cplusplus 539 } /* extern "C" */ 540 #endif 541 #endif /* LLLLHTTP_C_HEADERS_ */ 542 543 544 #ifndef INCLUDE_LLHTTP_API_H_ 545 #define INCLUDE_LLHTTP_API_H_ 546 #ifdef __cplusplus 547 extern "C" { 548 #endif 549 #include <stddef.h> 550 551 #if defined(__wasm__) 552 #define LLHTTP_EXPORT __attribute__((visibility("default"))) 553 #elif defined(_WIN32) 554 #define LLHTTP_EXPORT __declspec(dllexport) 555 #else 556 #define LLHTTP_EXPORT 557 #endif 558 559 typedef llhttp__internal_t llhttp_t; 560 typedef struct llhttp_settings_s llhttp_settings_t; 561 562 typedef int (*llhttp_data_cb)(llhttp_t*, const char *at, size_t length); 563 typedef int (*llhttp_cb)(llhttp_t*); 564 565 struct llhttp_settings_s { 566 /* Possible return values 0, -1, `HPE_PAUSED` */ 567 llhttp_cb on_message_begin; 568 569 /* Possible return values 0, -1, HPE_USER */ 570 llhttp_data_cb on_url; 571 llhttp_data_cb on_status; 572 llhttp_data_cb on_method; 573 llhttp_data_cb on_version; 574 llhttp_data_cb on_header_field; 575 llhttp_data_cb on_header_value; 576 llhttp_data_cb on_chunk_extension_name; 577 llhttp_data_cb on_chunk_extension_value; 578 579 /* Possible return values: 580 * 0 - Proceed normally 581 * 1 - Assume that request/response has no body, and proceed to parsing the 582 * next message 583 * 2 - Assume absence of body (as above) and make `llhttp_execute()` return 584 * `HPE_PAUSED_UPGRADE` 585 * -1 - Error 586 * `HPE_PAUSED` 587 */ 588 llhttp_cb on_headers_complete; 589 590 /* Possible return values 0, -1, HPE_USER */ 591 llhttp_data_cb on_body; 592 593 /* Possible return values 0, -1, `HPE_PAUSED` */ 594 llhttp_cb on_message_complete; 595 llhttp_cb on_url_complete; 596 llhttp_cb on_status_complete; 597 llhttp_cb on_method_complete; 598 llhttp_cb on_version_complete; 599 llhttp_cb on_header_field_complete; 600 llhttp_cb on_header_value_complete; 601 llhttp_cb on_chunk_extension_name_complete; 602 llhttp_cb on_chunk_extension_value_complete; 603 604 /* When on_chunk_header is called, the current chunk length is stored 605 * in parser->content_length. 606 * Possible return values 0, -1, `HPE_PAUSED` 607 */ 608 llhttp_cb on_chunk_header; 609 llhttp_cb on_chunk_complete; 610 llhttp_cb on_reset; 611 }; 612 613 /* Initialize the parser with specific type and user settings. 614 * 615 * NOTE: lifetime of `settings` has to be at least the same as the lifetime of 616 * the `parser` here. In practice, `settings` has to be either a static 617 * variable or be allocated with `malloc`, `new`, etc. 618 */ 619 LLHTTP_EXPORT 620 void llhttp_init(llhttp_t* parser, llhttp_type_t type, 621 const llhttp_settings_t* settings); 622 623 LLHTTP_EXPORT 624 llhttp_t* llhttp_alloc(llhttp_type_t type); 625 626 LLHTTP_EXPORT 627 void llhttp_free(llhttp_t* parser); 628 629 LLHTTP_EXPORT 630 uint8_t llhttp_get_type(llhttp_t* parser); 631 632 LLHTTP_EXPORT 633 uint8_t llhttp_get_http_major(llhttp_t* parser); 634 635 LLHTTP_EXPORT 636 uint8_t llhttp_get_http_minor(llhttp_t* parser); 637 638 LLHTTP_EXPORT 639 uint8_t llhttp_get_method(llhttp_t* parser); 640 641 LLHTTP_EXPORT 642 int llhttp_get_status_code(llhttp_t* parser); 643 644 LLHTTP_EXPORT 645 uint8_t llhttp_get_upgrade(llhttp_t* parser); 646 647 /* Reset an already initialized parser back to the start state, preserving the 648 * existing parser type, callback settings, user data, and lenient flags. 649 */ 650 LLHTTP_EXPORT 651 void llhttp_reset(llhttp_t* parser); 652 653 /* Initialize the settings object */ 654 LLHTTP_EXPORT 655 void llhttp_settings_init(llhttp_settings_t* settings); 656 657 /* Parse full or partial request/response, invoking user callbacks along the 658 * way. 659 * 660 * If any of `llhttp_data_cb` returns errno not equal to `HPE_OK` - the parsing 661 * interrupts, and such errno is returned from `llhttp_execute()`. If 662 * `HPE_PAUSED` was used as a errno, the execution can be resumed with 663 * `llhttp_resume()` call. 664 * 665 * In a special case of CONNECT/Upgrade request/response `HPE_PAUSED_UPGRADE` 666 * is returned after fully parsing the request/response. If the user wishes to 667 * continue parsing, they need to invoke `llhttp_resume_after_upgrade()`. 668 * 669 * NOTE: if this function ever returns a non-pause type error, it will continue 670 * to return the same error upon each successive call up until `llhttp_init()` 671 * is called. 672 */ 673 LLHTTP_EXPORT 674 llhttp_errno_t llhttp_execute(llhttp_t* parser, const char* data, size_t len); 675 676 /* This method should be called when the other side has no further bytes to 677 * send (e.g. shutdown of readable side of the TCP connection.) 678 * 679 * Requests without `Content-Length` and other messages might require treating 680 * all incoming bytes as the part of the body, up to the last byte of the 681 * connection. This method will invoke `on_message_complete()` callback if the 682 * request was terminated safely. Otherwise a error code would be returned. 683 */ 684 LLHTTP_EXPORT 685 llhttp_errno_t llhttp_finish(llhttp_t* parser); 686 687 /* Returns `1` if the incoming message is parsed until the last byte, and has 688 * to be completed by calling `llhttp_finish()` on EOF 689 */ 690 LLHTTP_EXPORT 691 int llhttp_message_needs_eof(const llhttp_t* parser); 692 693 /* Returns `1` if there might be any other messages following the last that was 694 * successfully parsed. 695 */ 696 LLHTTP_EXPORT 697 int llhttp_should_keep_alive(const llhttp_t* parser); 698 699 /* Make further calls of `llhttp_execute()` return `HPE_PAUSED` and set 700 * appropriate error reason. 701 * 702 * Important: do not call this from user callbacks! User callbacks must return 703 * `HPE_PAUSED` if pausing is required. 704 */ 705 LLHTTP_EXPORT 706 void llhttp_pause(llhttp_t* parser); 707 708 /* Might be called to resume the execution after the pause in user's callback. 709 * See `llhttp_execute()` above for details. 710 * 711 * Call this only if `llhttp_execute()` returns `HPE_PAUSED`. 712 */ 713 LLHTTP_EXPORT 714 void llhttp_resume(llhttp_t* parser); 715 716 /* Might be called to resume the execution after the pause in user's callback. 717 * See `llhttp_execute()` above for details. 718 * 719 * Call this only if `llhttp_execute()` returns `HPE_PAUSED_UPGRADE` 720 */ 721 LLHTTP_EXPORT 722 void llhttp_resume_after_upgrade(llhttp_t* parser); 723 724 /* Returns the latest return error */ 725 LLHTTP_EXPORT 726 llhttp_errno_t llhttp_get_errno(const llhttp_t* parser); 727 728 /* Returns the verbal explanation of the latest returned error. 729 * 730 * Note: User callback should set error reason when returning the error. See 731 * `llhttp_set_error_reason()` for details. 732 */ 733 LLHTTP_EXPORT 734 const char* llhttp_get_error_reason(const llhttp_t* parser); 735 736 /* Assign verbal description to the returned error. Must be called in user 737 * callbacks right before returning the errno. 738 * 739 * Note: `HPE_USER` error code might be useful in user callbacks. 740 */ 741 LLHTTP_EXPORT 742 void llhttp_set_error_reason(llhttp_t* parser, const char* reason); 743 744 /* Returns the pointer to the last parsed byte before the returned error. The 745 * pointer is relative to the `data` argument of `llhttp_execute()`. 746 * 747 * Note: this method might be useful for counting the number of parsed bytes. 748 */ 749 LLHTTP_EXPORT 750 const char* llhttp_get_error_pos(const llhttp_t* parser); 751 752 /* Returns textual name of error code */ 753 LLHTTP_EXPORT 754 const char* llhttp_errno_name(llhttp_errno_t err); 755 756 /* Returns textual name of HTTP method */ 757 LLHTTP_EXPORT 758 const char* llhttp_method_name(llhttp_method_t method); 759 760 /* Returns textual name of HTTP status */ 761 LLHTTP_EXPORT 762 const char* llhttp_status_name(llhttp_status_t status); 763 764 /* Enables/disables lenient header value parsing (disabled by default). 765 * 766 * Lenient parsing disables header value token checks, extending llhttp's 767 * protocol support to highly non-compliant clients/server. No 768 * `HPE_INVALID_HEADER_TOKEN` will be raised for incorrect header values when 769 * lenient parsing is "on". 770 * 771 * **Enabling this flag can pose a security issue since you will be exposed to 772 * request smuggling attacks. USE WITH CAUTION!** 773 */ 774 LLHTTP_EXPORT 775 void llhttp_set_lenient_headers(llhttp_t* parser, int enabled); 776 777 778 /* Enables/disables lenient handling of conflicting `Transfer-Encoding` and 779 * `Content-Length` headers (disabled by default). 780 * 781 * Normally `llhttp` would error when `Transfer-Encoding` is present in 782 * conjunction with `Content-Length`. This error is important to prevent HTTP 783 * request smuggling, but may be less desirable for small number of cases 784 * involving legacy servers. 785 * 786 * **Enabling this flag can pose a security issue since you will be exposed to 787 * request smuggling attacks. USE WITH CAUTION!** 788 */ 789 LLHTTP_EXPORT 790 void llhttp_set_lenient_chunked_length(llhttp_t* parser, int enabled); 791 792 793 /* Enables/disables lenient handling of `Connection: close` and HTTP/1.0 794 * requests responses. 795 * 796 * Normally `llhttp` would error on (in strict mode) or discard (in loose mode) 797 * the HTTP request/response after the request/response with `Connection: close` 798 * and `Content-Length`. This is important to prevent cache poisoning attacks, 799 * but might interact badly with outdated and insecure clients. With this flag 800 * the extra request/response will be parsed normally. 801 * 802 * **Enabling this flag can pose a security issue since you will be exposed to 803 * poisoning attacks. USE WITH CAUTION!** 804 */ 805 LLHTTP_EXPORT 806 void llhttp_set_lenient_keep_alive(llhttp_t* parser, int enabled); 807 808 /* Enables/disables lenient handling of `Transfer-Encoding` header. 809 * 810 * Normally `llhttp` would error when a `Transfer-Encoding` has `chunked` value 811 * and another value after it (either in a single header or in multiple 812 * headers whose value are internally joined using `, `). 813 * This is mandated by the spec to reliably determine request body size and thus 814 * avoid request smuggling. 815 * With this flag the extra value will be parsed normally. 816 * 817 * **Enabling this flag can pose a security issue since you will be exposed to 818 * request smuggling attacks. USE WITH CAUTION!** 819 */ 820 LLHTTP_EXPORT 821 void llhttp_set_lenient_transfer_encoding(llhttp_t* parser, int enabled); 822 823 /* Enables/disables lenient handling of HTTP version. 824 * 825 * Normally `llhttp` would error when the HTTP version in the request or status line 826 * is not `0.9`, `1.0`, `1.1` or `2.0`. 827 * With this flag the invalid value will be parsed normally. 828 * 829 * **Enabling this flag can pose a security issue since you will allow unsupported 830 * HTTP versions. USE WITH CAUTION!** 831 */ 832 LLHTTP_EXPORT 833 void llhttp_set_lenient_version(llhttp_t* parser, int enabled); 834 835 /* Enables/disables lenient handling of additional data received after a message ends 836 * and keep-alive is disabled. 837 * 838 * Normally `llhttp` would error when additional unexpected data is received if the message 839 * contains the `Connection` header with `close` value. 840 * With this flag the extra data will discarded without throwing an error. 841 * 842 * **Enabling this flag can pose a security issue since you will be exposed to 843 * poisoning attacks. USE WITH CAUTION!** 844 */ 845 LLHTTP_EXPORT 846 void llhttp_set_lenient_data_after_close(llhttp_t* parser, int enabled); 847 848 /* Enables/disables lenient handling of incomplete CRLF sequences. 849 * 850 * Normally `llhttp` would error when a CR is not followed by LF when terminating the 851 * request line, the status line, the headers or a chunk header. 852 * With this flag only a CR is required to terminate such sections. 853 * 854 * **Enabling this flag can pose a security issue since you will be exposed to 855 * request smuggling attacks. USE WITH CAUTION!** 856 */ 857 LLHTTP_EXPORT 858 void llhttp_set_lenient_optional_lf_after_cr(llhttp_t* parser, int enabled); 859 860 /* 861 * Enables/disables lenient handling of line separators. 862 * 863 * Normally `llhttp` would error when a LF is not preceded by CR when terminating the 864 * request line, the status line, the headers, a chunk header or a chunk data. 865 * With this flag only a LF is required to terminate such sections. 866 * 867 * **Enabling this flag can pose a security issue since you will be exposed to 868 * request smuggling attacks. USE WITH CAUTION!** 869 */ 870 LLHTTP_EXPORT 871 void llhttp_set_lenient_optional_cr_before_lf(llhttp_t* parser, int enabled); 872 873 /* Enables/disables lenient handling of chunks not separated via CRLF. 874 * 875 * Normally `llhttp` would error when after a chunk data a CRLF is missing before 876 * starting a new chunk. 877 * With this flag the new chunk can start immediately after the previous one. 878 * 879 * **Enabling this flag can pose a security issue since you will be exposed to 880 * request smuggling attacks. USE WITH CAUTION!** 881 */ 882 LLHTTP_EXPORT 883 void llhttp_set_lenient_optional_crlf_after_chunk(llhttp_t* parser, int enabled); 884 885 /* Enables/disables lenient handling of spaces after chunk size. 886 * 887 * Normally `llhttp` would error when after a chunk size is followed by one or more 888 * spaces are present instead of a CRLF or `;`. 889 * With this flag this check is disabled. 890 * 891 * **Enabling this flag can pose a security issue since you will be exposed to 892 * request smuggling attacks. USE WITH CAUTION!** 893 */ 894 LLHTTP_EXPORT 895 void llhttp_set_lenient_spaces_after_chunk_size(llhttp_t* parser, int enabled); 896 897 #ifdef __cplusplus 898 } /* extern "C" */ 899 #endif 900 #endif /* INCLUDE_LLHTTP_API_H_ */ 901 902 903 #endif /* INCLUDE_LLHTTP_H_ */ 904