1 2 /* 3 * Copyright (C) Igor Sysoev 4 * Copyright (C) NGINX, Inc. 5 */ 6 7 #ifndef _NXT_HTTP_H_INCLUDED_ 8 #define _NXT_HTTP_H_INCLUDED_ 9 10 11 typedef enum { 12 NXT_HTTP_UNSET = -1, 13 NXT_HTTP_INVALID = 0, 14 15 NXT_HTTP_CONTINUE = 100, 16 NXT_HTTP_SWITCHING_PROTOCOLS = 101, 17 18 NXT_HTTP_OK = 200, 19 NXT_HTTP_NO_CONTENT = 204, 20 21 NXT_HTTP_MULTIPLE_CHOICES = 300, 22 NXT_HTTP_MOVED_PERMANENTLY = 301, 23 NXT_HTTP_FOUND = 302, 24 NXT_HTTP_SEE_OTHER = 303, 25 NXT_HTTP_NOT_MODIFIED = 304, 26 NXT_HTTP_TEMPORARY_REDIRECT = 307, 27 NXT_HTTP_PERMANENT_REDIRECT = 308, 28 29 NXT_HTTP_BAD_REQUEST = 400, 30 NXT_HTTP_FORBIDDEN = 403, 31 NXT_HTTP_NOT_FOUND = 404, 32 NXT_HTTP_METHOD_NOT_ALLOWED = 405, 33 NXT_HTTP_REQUEST_TIMEOUT = 408, 34 NXT_HTTP_LENGTH_REQUIRED = 411, 35 NXT_HTTP_PAYLOAD_TOO_LARGE = 413, 36 NXT_HTTP_URI_TOO_LONG = 414, 37 NXT_HTTP_UPGRADE_REQUIRED = 426, 38 NXT_HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431, 39 40 NXT_HTTP_TO_HTTPS = 497, 41 42 NXT_HTTP_INTERNAL_SERVER_ERROR = 500, 43 NXT_HTTP_NOT_IMPLEMENTED = 501, 44 NXT_HTTP_BAD_GATEWAY = 502, 45 NXT_HTTP_SERVICE_UNAVAILABLE = 503, 46 NXT_HTTP_GATEWAY_TIMEOUT = 504, 47 NXT_HTTP_VERSION_NOT_SUPPORTED = 505, 48 NXT_HTTP_SERVER_ERROR_MAX = 599, 49 50 NXT_HTTP_STATUS_MAX = 999, 51 } nxt_http_status_t; 52 53 54 typedef enum { 55 NXT_HTTP_TE_NONE = 0, 56 NXT_HTTP_TE_CHUNKED = 1, 57 NXT_HTTP_TE_UNSUPPORTED = 2, 58 } nxt_http_te_t; 59 60 61 typedef enum { 62 NXT_HTTP_PROTO_H1 = 0, 63 NXT_HTTP_PROTO_H2, 64 NXT_HTTP_PROTO_DEVNULL, 65 } nxt_http_protocol_t; 66 67 68 typedef struct { 69 nxt_work_handler_t ready_handler; 70 nxt_work_handler_t error_handler; 71 } nxt_http_request_state_t; 72 73 74 typedef struct nxt_h1proto_s nxt_h1proto_t; 75 76 struct nxt_h1p_websocket_timer_s { 77 nxt_timer_t timer; 78 nxt_h1proto_t *h1p; 79 nxt_msec_t keepalive_interval; 80 }; 81 82 83 typedef union { 84 void *any; 85 nxt_h1proto_t *h1; 86 } nxt_http_proto_t; 87 88 89 #define nxt_http_field_name_set(_field, _name) \ 90 do { \ 91 (_field)->name_length = nxt_length(_name); \ 92 (_field)->name = (u_char *) _name; \ 93 } while (0) 94 95 96 #define nxt_http_field_set(_field, _name, _value) \ 97 do { \ 98 (_field)->name_length = nxt_length(_name); \ 99 (_field)->value_length = nxt_length(_value); \ 100 (_field)->name = (u_char *) _name; \ 101 (_field)->value = (u_char *) _value; \ 102 } while (0) 103 104 105 typedef struct { 106 nxt_list_t *fields; 107 nxt_http_field_t *date; 108 nxt_http_field_t *content_type; 109 nxt_http_field_t *content_length; 110 nxt_off_t content_length_n; 111 } nxt_http_response_t; 112 113 114 typedef struct nxt_upstream_server_s nxt_upstream_server_t; 115 116 typedef struct { 117 nxt_http_proto_t proto; 118 nxt_http_request_t *request; 119 nxt_upstream_server_t *server; 120 nxt_list_t *fields; 121 nxt_buf_t *body; 122 nxt_off_t remainder; 123 124 nxt_http_status_t status:16; 125 nxt_http_protocol_t protocol:8; /* 2 bits */ 126 uint8_t header_received; /* 1 bit */ 127 uint8_t closed; /* 1 bit */ 128 } nxt_http_peer_t; 129 130 131 struct nxt_http_request_s { 132 nxt_http_proto_t proto; 133 nxt_socket_conf_joint_t *conf; 134 135 nxt_mp_t *mem_pool; 136 137 nxt_buf_t *body; 138 nxt_buf_t *ws_frame; 139 nxt_buf_t *out; 140 const nxt_http_request_state_t *state; 141 142 nxt_str_t host; 143 nxt_str_t server_name; 144 nxt_str_t target; 145 nxt_str_t version; 146 nxt_str_t *method; 147 nxt_str_t *path; 148 nxt_str_t *args; 149 150 nxt_array_t *arguments; /* of nxt_http_name_value_t */ 151 nxt_array_t *cookies; /* of nxt_http_name_value_t */ 152 nxt_list_t *fields; 153 nxt_http_field_t *content_type; 154 nxt_http_field_t *content_length; 155 nxt_http_field_t *cookie; 156 nxt_http_field_t *referer; 157 nxt_http_field_t *user_agent; 158 nxt_off_t content_length_n; 159 160 nxt_sockaddr_t *remote; 161 nxt_sockaddr_t *local; 162 void *tls; 163 nxt_task_t task; 164 165 nxt_timer_t timer; 166 void *timer_data; 167 168 void *req_rpc_data; 169 170 nxt_http_peer_t *peer; 171 nxt_buf_t *last; 172 173 nxt_http_response_t resp; 174 175 nxt_http_status_t status:16; 176 177 uint8_t pass_count; /* 8 bits */ 178 nxt_http_protocol_t protocol:8; /* 2 bits */ 179 uint8_t logged; /* 1 bit */ 180 uint8_t header_sent; /* 1 bit */ 181 uint8_t inconsistent; /* 1 bit */ 182 uint8_t error; /* 1 bit */ 183 uint8_t websocket_handshake; /* 1 bit */ 184 }; 185 186 187 typedef struct nxt_http_route_s nxt_http_route_t; 188 189 190 struct nxt_http_action_s { 191 nxt_http_action_t *(*handler)(nxt_task_t *task, 192 nxt_http_request_t *r, 193 nxt_http_action_t *action); 194 union { 195 nxt_http_route_t *route; 196 nxt_app_t *application; 197 nxt_http_action_t *fallback; 198 nxt_upstream_t *upstream; 199 uint32_t upstream_number; 200 nxt_http_status_t return_code; 201 } u; 202 203 nxt_str_t name; 204 }; 205 206 207 typedef struct { 208 void (*body_read)(nxt_task_t *task, nxt_http_request_t *r); 209 void (*local_addr)(nxt_task_t *task, nxt_http_request_t *r); 210 void (*header_send)(nxt_task_t *task, nxt_http_request_t *r, 211 nxt_work_handler_t body_handler, void *data); 212 void (*send)(nxt_task_t *task, nxt_http_request_t *r, nxt_buf_t *out); 213 nxt_off_t (*body_bytes_sent)(nxt_task_t *task, nxt_http_proto_t proto); 214 void (*discard)(nxt_task_t *task, nxt_http_request_t *r, nxt_buf_t *last); 215 void (*close)(nxt_task_t *task, nxt_http_proto_t proto, 216 nxt_socket_conf_joint_t *joint); 217 218 void (*peer_connect)(nxt_task_t *task, nxt_http_peer_t *peer); 219 void (*peer_header_send)(nxt_task_t *task, nxt_http_peer_t *peer); 220 void (*peer_header_read)(nxt_task_t *task, nxt_http_peer_t *peer); 221 void (*peer_read)(nxt_task_t *task, nxt_http_peer_t *peer); 222 void (*peer_close)(nxt_task_t *task, nxt_http_peer_t *peer); 223 224 void (*ws_frame_start)(nxt_task_t *task, nxt_http_request_t *r, 225 nxt_buf_t *ws_frame); 226 } nxt_http_proto_table_t; 227 228 229 #define NXT_HTTP_DATE_LEN nxt_length("Wed, 31 Dec 1986 16:40:00 GMT") 230 231 nxt_inline u_char * 232 nxt_http_date(u_char *buf, struct tm *tm) 233 { 234 static const char *week[] = { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", 235 "Sat" }; 236 237 static const char *month[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", 238 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" }; 239 240 return nxt_sprintf(buf, buf + NXT_HTTP_DATE_LEN, 241 "%s, %02d %s %4d %02d:%02d:%02d GMT", 242 week[tm->tm_wday], tm->tm_mday, 243 month[tm->tm_mon], tm->tm_year + 1900, 244 tm->tm_hour, tm->tm_min, tm->tm_sec); 245 } 246 247 248 nxt_int_t nxt_http_init(nxt_task_t *task); 249 nxt_int_t nxt_h1p_init(nxt_task_t *task); 250 nxt_int_t nxt_http_response_hash_init(nxt_task_t *task); 251 252 void nxt_http_conn_init(nxt_task_t *task, void *obj, void *data); 253 nxt_http_request_t *nxt_http_request_create(nxt_task_t *task); 254 void nxt_http_request_error(nxt_task_t *task, nxt_http_request_t *r, 255 nxt_http_status_t status); 256 void nxt_http_request_read_body(nxt_task_t *task, nxt_http_request_t *r); 257 void nxt_http_request_header_send(nxt_task_t *task, nxt_http_request_t *r, 258 nxt_work_handler_t body_handler, void *data); 259 void nxt_http_request_ws_frame_start(nxt_task_t *task, nxt_http_request_t *r, 260 nxt_buf_t *ws_frame); 261 void nxt_http_request_send(nxt_task_t *task, nxt_http_request_t *r, 262 nxt_buf_t *out); 263 nxt_buf_t *nxt_http_buf_mem(nxt_task_t *task, nxt_http_request_t *r, 264 size_t size); 265 nxt_buf_t *nxt_http_buf_last(nxt_http_request_t *r); 266 void nxt_http_request_error_handler(nxt_task_t *task, void *obj, void *data); 267 void nxt_http_request_close_handler(nxt_task_t *task, void *obj, void *data); 268 269 nxt_int_t nxt_http_request_host(void *ctx, nxt_http_field_t *field, 270 uintptr_t data); 271 nxt_int_t nxt_http_request_field(void *ctx, nxt_http_field_t *field, 272 uintptr_t offset); 273 nxt_int_t nxt_http_request_content_length(void *ctx, nxt_http_field_t *field, 274 uintptr_t data); 275 276 nxt_http_routes_t *nxt_http_routes_create(nxt_task_t *task, 277 nxt_router_temp_conf_t *tmcf, nxt_conf_value_t *routes_conf); 278 nxt_http_action_t *nxt_http_action_create(nxt_task_t *task, 279 nxt_router_temp_conf_t *tmcf, nxt_str_t *name); 280 nxt_int_t nxt_http_routes_resolve(nxt_task_t *task, 281 nxt_router_temp_conf_t *tmcf); 282 nxt_int_t nxt_http_pass_segments(nxt_mp_t *mp, nxt_str_t *pass, 283 nxt_str_t *segments, nxt_uint_t n); 284 nxt_http_action_t *nxt_http_pass_application(nxt_task_t *task, 285 nxt_router_temp_conf_t *tmcf, nxt_str_t *name); 286 void nxt_http_routes_cleanup(nxt_task_t *task, nxt_http_routes_t *routes); 287 void nxt_http_action_cleanup(nxt_task_t *task, nxt_http_action_t *action); 288 289 nxt_int_t nxt_upstreams_create(nxt_task_t *task, nxt_router_temp_conf_t *tmcf, 290 nxt_conf_value_t *conf); 291 nxt_int_t nxt_upstreams_joint_create(nxt_router_temp_conf_t *tmcf, 292 nxt_upstream_t ***upstream_joint); 293 294 nxt_http_action_t *nxt_http_return_handler(nxt_task_t *task, 295 nxt_http_request_t *r, nxt_http_action_t *action); 296 297 nxt_http_action_t *nxt_http_static_handler(nxt_task_t *task, 298 nxt_http_request_t *r, nxt_http_action_t *action); 299 nxt_int_t nxt_http_static_mtypes_init(nxt_mp_t *mp, nxt_lvlhsh_t *hash); 300 nxt_int_t nxt_http_static_mtypes_hash_add(nxt_mp_t *mp, nxt_lvlhsh_t *hash, 301 nxt_str_t *extension, nxt_str_t *type); 302 nxt_str_t *nxt_http_static_mtypes_hash_find(nxt_lvlhsh_t *hash, 303 nxt_str_t *extension); 304 305 nxt_http_action_t *nxt_http_application_handler(nxt_task_t *task, 306 nxt_http_request_t *r, nxt_http_action_t *action); 307 void nxt_upstream_find(nxt_upstreams_t *upstreams, nxt_str_t *name, 308 nxt_http_action_t *action); 309 nxt_http_action_t *nxt_upstream_proxy_handler(nxt_task_t *task, 310 nxt_http_request_t *r, nxt_upstream_t *upstream); 311 312 313 nxt_int_t nxt_http_proxy_create(nxt_mp_t *mp, nxt_http_action_t *action); 314 nxt_int_t nxt_http_proxy_date(void *ctx, nxt_http_field_t *field, 315 uintptr_t data); 316 nxt_int_t nxt_http_proxy_content_length(void *ctx, nxt_http_field_t *field, 317 uintptr_t data); 318 nxt_int_t nxt_http_proxy_skip(void *ctx, nxt_http_field_t *field, 319 uintptr_t data); 320 nxt_buf_t *nxt_http_proxy_buf_mem_alloc(nxt_task_t *task, nxt_http_request_t *r, 321 size_t size); 322 void nxt_http_proxy_buf_mem_free(nxt_task_t *task, nxt_http_request_t *r, 323 nxt_buf_t *b); 324 325 extern nxt_time_string_t nxt_http_date_cache; 326 327 extern nxt_lvlhsh_t nxt_response_fields_hash; 328 329 extern const nxt_http_proto_table_t nxt_http_proto[]; 330 331 void nxt_h1p_websocket_first_frame_start(nxt_task_t *task, 332 nxt_http_request_t *r, nxt_buf_t *ws_frame); 333 void nxt_h1p_websocket_frame_start(nxt_task_t *task, nxt_http_request_t *r, 334 nxt_buf_t *ws_frame); 335 void nxt_h1p_complete_buffers(nxt_task_t *task, nxt_h1proto_t *h1p, 336 nxt_bool_t all); 337 nxt_msec_t nxt_h1p_conn_request_timer_value(nxt_conn_t *c, uintptr_t data); 338 339 extern const nxt_conn_state_t nxt_h1p_idle_close_state; 340 341 #endif /* _NXT_HTTP_H_INCLUDED_ */ 342