1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
|
#ifndef SRC_NODE_HTTP_COMMON_H_
#define SRC_NODE_HTTP_COMMON_H_
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
#include "v8.h"
#include "node_mem.h"
#include <string>
namespace node {
class Environment;
#define MAX_MAX_HEADER_LIST_SIZE 16777215u
#define DEFAULT_MAX_HEADER_LIST_PAIRS 128u
#define DEFAULT_MAX_HEADER_LENGTH 8192
#define HTTP_SPECIAL_HEADERS(V) \
V(STATUS, ":status") \
V(METHOD, ":method") \
V(AUTHORITY, ":authority") \
V(SCHEME, ":scheme") \
V(PATH, ":path") \
V(PROTOCOL, ":protocol")
#define HTTP_REGULAR_HEADERS(V) \
V(ACCEPT_ENCODING, "accept-encoding") \
V(ACCEPT_LANGUAGE, "accept-language") \
V(ACCEPT_RANGES, "accept-ranges") \
V(ACCEPT, "accept") \
V(ACCESS_CONTROL_ALLOW_CREDENTIALS, "access-control-allow-credentials") \
V(ACCESS_CONTROL_ALLOW_HEADERS, "access-control-allow-headers") \
V(ACCESS_CONTROL_ALLOW_METHODS, "access-control-allow-methods") \
V(ACCESS_CONTROL_ALLOW_ORIGIN, "access-control-allow-origin") \
V(ACCESS_CONTROL_EXPOSE_HEADERS, "access-control-expose-headers") \
V(ACCESS_CONTROL_REQUEST_HEADERS, "access-control-request-headers") \
V(ACCESS_CONTROL_REQUEST_METHOD, "access-control-request-method") \
V(AGE, "age") \
V(AUTHORIZATION, "authorization") \
V(CACHE_CONTROL, "cache-control") \
V(CONNECTION, "connection") \
V(CONTENT_DISPOSITION, "content-disposition") \
V(CONTENT_ENCODING, "content-encoding") \
V(CONTENT_LENGTH, "content-length") \
V(CONTENT_TYPE, "content-type") \
V(COOKIE, "cookie") \
V(DATE, "date") \
V(ETAG, "etag") \
V(FORWARDED, "forwarded") \
V(HOST, "host") \
V(IF_MODIFIED_SINCE, "if-modified-since") \
V(IF_NONE_MATCH, "if-none-match") \
V(IF_RANGE, "if-range") \
V(LAST_MODIFIED, "last-modified") \
V(LINK, "link") \
V(LOCATION, "location") \
V(RANGE, "range") \
V(REFERER, "referer") \
V(SERVER, "server") \
V(SET_COOKIE, "set-cookie") \
V(STRICT_TRANSPORT_SECURITY, "strict-transport-security") \
V(TRANSFER_ENCODING, "transfer-encoding") \
V(TE, "te") \
V(UPGRADE_INSECURE_REQUESTS, "upgrade-insecure-requests") \
V(UPGRADE, "upgrade") \
V(USER_AGENT, "user-agent") \
V(VARY, "vary") \
V(X_CONTENT_TYPE_OPTIONS, "x-content-type-options") \
V(X_FRAME_OPTIONS, "x-frame-options") \
V(KEEP_ALIVE, "keep-alive") \
V(PROXY_CONNECTION, "proxy-connection") \
V(X_XSS_PROTECTION, "x-xss-protection") \
V(ALT_SVC, "alt-svc") \
V(CONTENT_SECURITY_POLICY, "content-security-policy") \
V(EARLY_DATA, "early-data") \
V(EXPECT_CT, "expect-ct") \
V(ORIGIN, "origin") \
V(PURPOSE, "purpose") \
V(TIMING_ALLOW_ORIGIN, "timing-allow-origin") \
V(X_FORWARDED_FOR, "x-forwarded-for")
#define HTTP_ADDITIONAL_HEADERS(V) \
V(ACCEPT_CHARSET, "accept-charset") \
V(ACCESS_CONTROL_MAX_AGE, "access-control-max-age") \
V(ALLOW, "allow") \
V(CONTENT_LANGUAGE, "content-language") \
V(CONTENT_LOCATION, "content-location") \
V(CONTENT_MD5, "content-md5") \
V(CONTENT_RANGE, "content-range") \
V(DNT, "dnt") \
V(EXPECT, "expect") \
V(EXPIRES, "expires") \
V(FROM, "from") \
V(IF_MATCH, "if-match") \
V(IF_UNMODIFIED_SINCE, "if-unmodified-since") \
V(MAX_FORWARDS, "max-forwards") \
V(PREFER, "prefer") \
V(PROXY_AUTHENTICATE, "proxy-authenticate") \
V(PROXY_AUTHORIZATION, "proxy-authorization") \
V(REFRESH, "refresh") \
V(RETRY_AFTER, "retry-after") \
V(TRAILER, "trailer") \
V(TK, "tk") \
V(VIA, "via") \
V(WARNING, "warning") \
V(WWW_AUTHENTICATE, "www-authenticate") \
V(HTTP2_SETTINGS, "http2-settings")
// Special and regular headers are handled specifically by the HTTP/2 (and
// later HTTP/3) implementation.
#define HTTP_KNOWN_HEADERS(V) \
HTTP_SPECIAL_HEADERS(V) \
HTTP_REGULAR_HEADERS(V) \
HTTP_ADDITIONAL_HEADERS(V)
enum http_known_headers {
HTTP_KNOWN_HEADER_MIN,
#define V(name, value) HTTP_HEADER_##name,
HTTP_KNOWN_HEADERS(V)
#undef V
HTTP_KNOWN_HEADER_MAX
};
#define HTTP_STATUS_CODES(V) \
V(CONTINUE, 100) \
V(SWITCHING_PROTOCOLS, 101) \
V(PROCESSING, 102) \
V(EARLY_HINTS, 103) \
V(OK, 200) \
V(CREATED, 201) \
V(ACCEPTED, 202) \
V(NON_AUTHORITATIVE_INFORMATION, 203) \
V(NO_CONTENT, 204) \
V(RESET_CONTENT, 205) \
V(PARTIAL_CONTENT, 206) \
V(MULTI_STATUS, 207) \
V(ALREADY_REPORTED, 208) \
V(IM_USED, 226) \
V(MULTIPLE_CHOICES, 300) \
V(MOVED_PERMANENTLY, 301) \
V(FOUND, 302) \
V(SEE_OTHER, 303) \
V(NOT_MODIFIED, 304) \
V(USE_PROXY, 305) \
V(TEMPORARY_REDIRECT, 307) \
V(PERMANENT_REDIRECT, 308) \
V(BAD_REQUEST, 400) \
V(UNAUTHORIZED, 401) \
V(PAYMENT_REQUIRED, 402) \
V(FORBIDDEN, 403) \
V(NOT_FOUND, 404) \
V(METHOD_NOT_ALLOWED, 405) \
V(NOT_ACCEPTABLE, 406) \
V(PROXY_AUTHENTICATION_REQUIRED, 407) \
V(REQUEST_TIMEOUT, 408) \
V(CONFLICT, 409) \
V(GONE, 410) \
V(LENGTH_REQUIRED, 411) \
V(PRECONDITION_FAILED, 412) \
V(PAYLOAD_TOO_LARGE, 413) \
V(URI_TOO_LONG, 414) \
V(UNSUPPORTED_MEDIA_TYPE, 415) \
V(RANGE_NOT_SATISFIABLE, 416) \
V(EXPECTATION_FAILED, 417) \
V(TEAPOT, 418) \
V(MISDIRECTED_REQUEST, 421) \
V(UNPROCESSABLE_ENTITY, 422) \
V(LOCKED, 423) \
V(FAILED_DEPENDENCY, 424) \
V(TOO_EARLY, 425) \
V(UPGRADE_REQUIRED, 426) \
V(PRECONDITION_REQUIRED, 428) \
V(TOO_MANY_REQUESTS, 429) \
V(REQUEST_HEADER_FIELDS_TOO_LARGE, 431) \
V(UNAVAILABLE_FOR_LEGAL_REASONS, 451) \
V(INTERNAL_SERVER_ERROR, 500) \
V(NOT_IMPLEMENTED, 501) \
V(BAD_GATEWAY, 502) \
V(SERVICE_UNAVAILABLE, 503) \
V(GATEWAY_TIMEOUT, 504) \
V(HTTP_VERSION_NOT_SUPPORTED, 505) \
V(VARIANT_ALSO_NEGOTIATES, 506) \
V(INSUFFICIENT_STORAGE, 507) \
V(LOOP_DETECTED, 508) \
V(BANDWIDTH_LIMIT_EXCEEDED, 509) \
V(NOT_EXTENDED, 510) \
V(NETWORK_AUTHENTICATION_REQUIRED, 511)
enum http_status_codes {
#define V(name, code) HTTP_STATUS_##name = code,
HTTP_STATUS_CODES(V)
#undef V
};
// Unlike the HTTP/1 implementation, the HTTP/2 implementation is not limited
// to a fixed number of known supported HTTP methods. These constants, therefore
// are provided strictly as a convenience to users and are exposed via the
// require('http2').constants object.
#define HTTP_KNOWN_METHODS(V) \
V(ACL, "ACL") \
V(BASELINE_CONTROL, "BASELINE-CONTROL") \
V(BIND, "BIND") \
V(CHECKIN, "CHECKIN") \
V(CHECKOUT, "CHECKOUT") \
V(CONNECT, "CONNECT") \
V(COPY, "COPY") \
V(DELETE, "DELETE") \
V(GET, "GET") \
V(HEAD, "HEAD") \
V(LABEL, "LABEL") \
V(LINK, "LINK") \
V(LOCK, "LOCK") \
V(MERGE, "MERGE") \
V(MKACTIVITY, "MKACTIVITY") \
V(MKCALENDAR, "MKCALENDAR") \
V(MKCOL, "MKCOL") \
V(MKREDIRECTREF, "MKREDIRECTREF") \
V(MKWORKSPACE, "MKWORKSPACE") \
V(MOVE, "MOVE") \
V(OPTIONS, "OPTIONS") \
V(ORDERPATCH, "ORDERPATCH") \
V(PATCH, "PATCH") \
V(POST, "POST") \
V(PRI, "PRI") \
V(PROPFIND, "PROPFIND") \
V(PROPPATCH, "PROPPATCH") \
V(PUT, "PUT") \
V(REBIND, "REBIND") \
V(REPORT, "REPORT") \
V(SEARCH, "SEARCH") \
V(TRACE, "TRACE") \
V(UNBIND, "UNBIND") \
V(UNCHECKOUT, "UNCHECKOUT") \
V(UNLINK, "UNLINK") \
V(UNLOCK, "UNLOCK") \
V(UPDATE, "UPDATE") \
V(UPDATEREDIRECTREF, "UPDATEREDIRECTREF") \
V(VERSION_CONTROL, "VERSION-CONTROL")
// NgHeaders takes as input a block of headers provided by the
// JavaScript side (see http2's mapToHeaders function) and
// converts it into a array of ng header structs. This is done
// generically to handle both http/2 and (in the future) http/3,
// which use nearly identical structs. The template parameter
// takes a Traits type that defines the ng header struct and
// the kNoneFlag value. See Http2HeaderTraits in node_http2.h
// for an example.
template <typename T>
class NgHeaders {
public:
typedef typename T::nv_t nv_t;
inline NgHeaders(Environment* env, v8::Local<v8::Array> headers);
~NgHeaders() = default;
const nv_t* operator*() const {
return reinterpret_cast<const nv_t*>(*buf_);
}
const nv_t* data() const {
return reinterpret_cast<const nv_t*>(*buf_);
}
size_t length() const {
return count_;
}
private:
size_t count_;
MaybeStackBuffer<char, 3000> buf_;
};
// The ng libraries use nearly identical
// reference counted structures for retaining header name and value
// information in memory until the application is done with it.
// The NgRcBufPointer is an intelligent pointer capable of working
// with either type, handling the ref counting increment and
// decrement as appropriate. The Template takes a single Traits
// type that provides the rc buffer and vec type, as well as
// implementations for multiple static functions.
// See Http2RcBufferPointerTraits in node_http2.h for an example.
template <typename T>
class NgRcBufPointer : public MemoryRetainer {
public:
typedef typename T::rcbuf_t rcbuf_t;
typedef typename T::vector_t vector_t;
NgRcBufPointer() = default;
explicit NgRcBufPointer(rcbuf_t* buf) {
reset(buf);
}
template <typename B>
NgRcBufPointer(const NgRcBufPointer<B>& other) {
reset(other.get());
}
NgRcBufPointer(const NgRcBufPointer& other) {
reset(other.get());
}
template <typename B>
NgRcBufPointer& operator=(const NgRcBufPointer<B>& other) {
if (other.get() == get()) return *this;
this->~NgRcBufPointer();
return *new (this) NgRcBufPointer(other);
}
NgRcBufPointer& operator=(const NgRcBufPointer& other) {
if (other.get() == get()) return *this;
this->~NgRcBufPointer();
return *new (this) NgRcBufPointer(other);
}
NgRcBufPointer(NgRcBufPointer&& other) {
this->~NgRcBufPointer();
buf_ = other.buf_;
other.buf_ = nullptr;
}
NgRcBufPointer& operator=(NgRcBufPointer&& other) {
this->~NgRcBufPointer();
return *new (this) NgRcBufPointer(std::move(other));
}
~NgRcBufPointer() {
reset();
}
// Returns the underlying ngvec for this rcbuf
uint8_t* data() const {
vector_t v = T::get_vec(buf_);
return v.base;
}
size_t len() const {
vector_t v = T::get_vec(buf_);
return v.len;
}
std::string str() const {
return std::string(reinterpret_cast<const char*>(data()), len());
}
void reset(rcbuf_t* ptr = nullptr, bool internalizable = false) {
if (buf_ == ptr)
return;
if (buf_ != nullptr)
T::dec(buf_);
buf_ = ptr;
if (ptr != nullptr) {
T::inc(ptr);
internalizable_ = internalizable;
}
}
rcbuf_t* get() const { return buf_; }
rcbuf_t& operator*() const { return *get(); }
rcbuf_t* operator->() const { return buf_; }
operator bool() const { return buf_ != nullptr; }
bool IsStatic() const { return T::is_static(buf_) != 0; }
void SetInternalizable() { internalizable_ = true; }
bool IsInternalizable() const { return internalizable_; }
static inline bool IsZeroLength(rcbuf_t* buf) {
if (buf == nullptr)
return true;
vector_t b = T::get_vec(buf);
return b.len == 0;
}
void MemoryInfo(MemoryTracker* tracker) const override {
tracker->TrackFieldWithSize("buf", len(), "buf");
}
SET_MEMORY_INFO_NAME(NgRcBufPointer)
SET_SELF_SIZE(NgRcBufPointer)
class External : public v8::String::ExternalOneByteStringResource {
public:
explicit External(const NgRcBufPointer<T>& ptr) : ptr_(ptr) {}
const char* data() const override {
return const_cast<const char*>(reinterpret_cast<char*>(ptr_.data()));
}
size_t length() const override {
return ptr_.len();
}
static inline
v8::MaybeLocal<v8::String> GetInternalizedString(
Environment* env,
const NgRcBufPointer<T>& ptr) {
return v8::String::NewFromOneByte(
env->isolate(),
ptr.data(),
v8::NewStringType::kInternalized,
ptr.len());
}
template <typename Allocator>
static v8::MaybeLocal<v8::String> New(
Allocator* allocator,
NgRcBufPointer<T> ptr) {
Environment* env = allocator->env();
if (ptr.IsStatic()) {
auto& static_str_map = env->isolate_data()->static_str_map;
const char* header_name = reinterpret_cast<const char*>(ptr.data());
v8::Eternal<v8::String>& eternal = static_str_map[header_name];
if (eternal.IsEmpty()) {
v8::Local<v8::String> str =
GetInternalizedString(env, ptr).ToLocalChecked();
eternal.Set(env->isolate(), str);
return str;
}
return eternal.Get(env->isolate());
}
size_t len = ptr.len();
if (len == 0) {
ptr.reset();
return v8::String::Empty(env->isolate());
}
if (ptr.IsInternalizable() && len < 64) {
v8::MaybeLocal<v8::String> ret = GetInternalizedString(env, ptr);
ptr.reset();
return ret;
}
allocator->StopTrackingMemory(ptr.get());
External* h_str = new External(std::move(ptr));
v8::MaybeLocal<v8::String> str =
v8::String::NewExternalOneByte(env->isolate(), h_str);
if (str.IsEmpty())
delete h_str;
return str;
}
private:
NgRcBufPointer<T> ptr_;
};
private:
rcbuf_t* buf_ = nullptr;
bool internalizable_ = false;
};
template <typename allocator_t>
struct NgHeaderBase : public MemoryRetainer {
virtual v8::MaybeLocal<v8::String> GetName(allocator_t* allocator) const = 0;
virtual v8::MaybeLocal<v8::String> GetValue(allocator_t* allocator) const = 0;
virtual std::string name() const = 0;
virtual std::string value() const = 0;
virtual size_t length() const = 0;
virtual uint8_t flags() const = 0;
virtual std::string ToString() const;
};
// The ng libraries use nearly identical structs to represent
// received http headers. The NgHeader class wraps those in a
// consistent way and allows converting the name and value to
// v8 strings. The template is given a Traits type that provides
// the NgRcBufPointer type, the NgLibMemoryManager to use for
// memory tracking, and implementation of static utility functions.
// See Http2HeaderTraits in node_http2.h for an example.
template <typename T>
class NgHeader final : public NgHeaderBase<typename T::allocator_t> {
public:
typedef typename T::rcbufferpointer_t rcbufferpointer_t;
typedef typename T::rcbufferpointer_t::rcbuf_t rcbuf_t;
typedef typename T::allocator_t allocator_t;
inline static bool IsZeroLength(rcbuf_t* name, rcbuf_t* value);
inline static bool IsZeroLength(int32_t token, rcbuf_t* name, rcbuf_t* value);
inline NgHeader(
Environment* env,
rcbuf_t* name,
rcbuf_t* value,
uint8_t flags);
inline NgHeader(
Environment* env,
int32_t token,
rcbuf_t* name,
rcbuf_t* value,
uint8_t flags);
inline NgHeader(NgHeader<T>&& other) noexcept;
// Calling GetName and GetValue will have the effect of releasing
// control over the reference counted buffer from this NgHeader
// object to the v8 string. Once the v8 string is garbage collected,
// the reference counter will be decremented.
inline v8::MaybeLocal<v8::String> GetName(
allocator_t* allocator) const override;
inline v8::MaybeLocal<v8::String> GetValue(
allocator_t* allocator) const override;
inline std::string name() const override;
inline std::string value() const override;
inline size_t length() const override;
inline uint8_t flags() const override;
void MemoryInfo(MemoryTracker* tracker) const override;
SET_MEMORY_INFO_NAME(NgHeader)
SET_SELF_SIZE(NgHeader)
private:
Environment* env_;
rcbufferpointer_t name_;
rcbufferpointer_t value_;
int32_t token_ = -1;
uint8_t flags_ = 0;
};
inline size_t GetServerMaxHeaderPairs(size_t max_header_pairs);
inline size_t GetClientMaxHeaderPairs(size_t max_header_pairs);
} // namespace node
#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
#endif // SRC_NODE_HTTP_COMMON_H_
|