libnghttp2 1.68.0

FFI bindings to the HTTP/2 framing layer of nghttp2 C library
Documentation 
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

/*
 * nghttp2 - HTTP/2 C Library
 *
 * Copyright (c) 2012 Tatsuhiro Tsujikawa
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#include "shrpx_http.h"

#include "shrpx_config.h"
#include "shrpx_log.h"
#include "http2.h"
#include "util.h"

using namespace nghttp2;

namespace shrpx {

namespace http {

std::string_view create_error_html(BlockAllocator &balloc,
                                   unsigned int http_status) {
  auto &httpconf = get_config()->http;

  const auto &error_pages = httpconf.error_pages;
  for (const auto &page : error_pages) {
    if (page.http_status == 0 || page.http_status == http_status) {
      return as_string_view(page.content);
    }
  }

  auto status_string = http2::stringify_status(balloc, http_status);
  auto reason_phrase = http2::get_reason_phrase(http_status);

  return concat_string_ref(
    balloc, R"(<!DOCTYPE html><html lang="en"><title>)"sv, status_string, " "sv,
    reason_phrase, "</title><body><h1>"sv, status_string, " "sv, reason_phrase,
    "</h1><footer>"sv, httpconf.server_name, "</footer></body></html>"sv);
}

std::string_view create_forwarded(BlockAllocator &balloc, uint32_t params,
                                  const std::string_view &node_by,
                                  const std::string_view &node_for,
                                  const std::string_view &host,
                                  const std::string_view &proto) {
  size_t len = 0;
  if ((params & FORWARDED_BY) && !node_by.empty()) {
    len += str_size("by=\"") + node_by.size() + str_size("\";");
  }
  if ((params & FORWARDED_FOR) && !node_for.empty()) {
    len += str_size("for=\"") + node_for.size() + str_size("\";");
  }
  if ((params & FORWARDED_HOST) && !host.empty()) {
    len += str_size("host=\"") + host.size() + str_size("\";");
  }
  if ((params & FORWARDED_PROTO) && !proto.empty()) {
    len += str_size("proto=") + proto.size() + str_size(";");
  }

  auto iov = make_byte_ref(balloc, len + 1);
  auto p = std::ranges::begin(iov);

  if ((params & FORWARDED_BY) && !node_by.empty()) {
    // This must be quoted-string unless it is obfuscated version
    // (which starts with "_") or some special value (e.g.,
    // "localhost" for UNIX domain socket), since ':' is not allowed
    // in token.  ':' is used to separate host and port.
    if (node_by[0] == '_' || node_by[0] == 'l') {
      p = std::ranges::copy("by="sv, p).out;
      p = std::ranges::copy(node_by, p).out;
      *p++ = ';';
    } else {
      p = std::ranges::copy("by=\""sv, p).out;
      p = std::ranges::copy(node_by, p).out;
      p = std::ranges::copy("\";"sv, p).out;
    }
  }
  if ((params & FORWARDED_FOR) && !node_for.empty()) {
    // We only quote IPv6 literal address only, which starts with '['.
    if (node_for[0] == '[') {
      p = std::ranges::copy("for=\""sv, p).out;
      p = std::ranges::copy(node_for, p).out;
      p = std::ranges::copy("\";"sv, p).out;
    } else {
      p = std::ranges::copy("for="sv, p).out;
      p = std::ranges::copy(node_for, p).out;
      *p++ = ';';
    }
  }
  if ((params & FORWARDED_HOST) && !host.empty()) {
    // Just be quoted to skip checking characters.
    p = std::ranges::copy("host=\""sv, p).out;
    p = std::ranges::copy(host, p).out;
    p = std::ranges::copy("\";"sv, p).out;
  }
  if ((params & FORWARDED_PROTO) && !proto.empty()) {
    // Scheme production rule only allow characters which are all in
    // token.
    p = std::ranges::copy("proto="sv, p).out;
    p = std::ranges::copy(proto, p).out;
    *p++ = ';';
  }

  if (std::ranges::begin(iov) == p) {
    return ""sv;
  }

  --p;
  *p = '\0';

  return as_string_view(std::ranges::begin(iov), p);
}

std::string colorize_headers(const std::string_view &hdrs) {
  std::string nhdrs;
  auto p = std::ranges::find(hdrs, '\n');
  if (p == std::ranges::end(hdrs)) {
    // Not valid HTTP header
    return std::string{hdrs};
  }

  nhdrs.append(std::ranges::begin(hdrs), ++p);

  while (1) {
    auto np = std::ranges::find(p, std::ranges::end(hdrs), ':');
    if (np == std::ranges::end(hdrs)) {
      nhdrs.append(p, std::ranges::end(hdrs));
      break;
    }

    nhdrs += TTY_HTTP_HD;
    nhdrs.append(p, np);
    nhdrs += TTY_RST;

    auto redact = util::strieq("authorization"sv, std::string_view{p, np});

    p = np;

    np = std::ranges::find(p, std::ranges::end(hdrs), '\n');

    if (redact) {
      nhdrs.append(": <redacted>"sv);
    } else {
      nhdrs.append(p, np);
    }

    if (np == std::ranges::end(hdrs)) {
      return nhdrs;
    }

    nhdrs += '\n';
    p = np + 1;
  }

  return nhdrs;
}

nghttp2_ssize select_padding_callback(nghttp2_session *session,
                                      const nghttp2_frame *frame,
                                      size_t max_payload, void *user_data) {
  return as_signed(
    std::min(max_payload, frame->hd.length + get_config()->padding));
}

std::string_view create_affinity_cookie(BlockAllocator &balloc,
                                        const std::string_view &name,
                                        uint32_t affinity_cookie,
                                        const std::string_view &path,
                                        bool secure) {
  static constexpr auto PATH_PREFIX = "; Path="sv;
  static constexpr auto SECURE = "; Secure"sv;
  // <name>=<value>[; Path=<path>][; Secure]
  size_t len = name.size() + 1 + 8;

  if (!path.empty()) {
    len += PATH_PREFIX.size() + path.size();
  }
  if (secure) {
    len += SECURE.size();
  }

  auto iov = make_byte_ref(balloc, len + 1);
  auto p = std::ranges::copy(name, std::ranges::begin(iov)).out;
  *p++ = '=';
  affinity_cookie = htonl(affinity_cookie);
  p = util::format_hex(as_uint8_span(std::span{&affinity_cookie, 1}), p);
  if (!path.empty()) {
    p = std::ranges::copy(PATH_PREFIX, p).out;
    p = std::ranges::copy(path, p).out;
  }
  if (secure) {
    p = std::ranges::copy(SECURE, p).out;
  }
  *p = '\0';
  return as_string_view(std::ranges::begin(iov), p);
}

bool require_cookie_secure_attribute(SessionAffinityCookieSecure secure,
                                     const std::string_view &scheme) {
  switch (secure) {
  case SessionAffinityCookieSecure::AUTO:
    return scheme == "https"sv;
  case SessionAffinityCookieSecure::YES:
    return true;
  default:
    return false;
  }
}

std::string_view
create_altsvc_header_value(BlockAllocator &balloc,
                           const std::vector<AltSvc> &altsvcs) {
  // <PROTOID>="<HOST>:<SERVICE>"; <PARAMS>
  size_t len = 0;

  if (altsvcs.empty()) {
    return ""sv;
  }

  for (auto &altsvc : altsvcs) {
    len += util::percent_encode_tokenlen(altsvc.protocol_id);
    len += str_size("=\"");
    len += util::quote_stringlen(altsvc.host);
    len += str_size(":");
    len += altsvc.service.size();
    len += str_size("\"");
    if (!altsvc.params.empty()) {
      len += str_size("; ");
      len += altsvc.params.size();
    }
  }

  // ", " between items.
  len += (altsvcs.size() - 1) * 2;

  // We will write additional ", " at the end, and cut it later.
  auto iov = make_byte_ref(balloc, len + 2);
  auto p = std::ranges::begin(iov);

  for (auto &altsvc : altsvcs) {
    p = util::percent_encode_token(altsvc.protocol_id, p);
    p = std::ranges::copy("=\""sv, p).out;
    p = util::quote_string(altsvc.host, p);
    *p++ = ':';
    p = std::ranges::copy(altsvc.service, p).out;
    *p++ = '"';
    if (!altsvc.params.empty()) {
      p = std::ranges::copy("; "sv, p).out;
      p = std::ranges::copy(altsvc.params, p).out;
    }
    p = std::ranges::copy(", "sv, p).out;
  }

  p -= 2;
  *p = '\0';

  assert(static_cast<size_t>(p - std::ranges::begin(iov)) == len);

  return as_string_view(std::ranges::begin(iov), p);
}

bool check_http_scheme(const std::string_view &scheme, bool encrypted) {
  return encrypted ? scheme == "https"sv : scheme == "http"sv;
}

} // namespace http

} // namespace shrpx