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 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
|
/*
* libwebsockets - small server side websockets and web server implementation
*
* Copyright (C) 2019 - 2021 Andy Green <andy@warmcat.com>
*
* 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.
*
* This file contains the stuff related to secure streams policy, it's always
* built if LWS_WITH_SECURE_STREAMS enabled.
*/
#include <private-lib-core.h>
#if defined(LWS_WITH_SYS_SMD)
const lws_ss_policy_t pol_smd = {
.flags = 0, /* have to set something for windows */
};
#endif
const lws_ss_policy_t *
lws_ss_policy_lookup(const struct lws_context *context, const char *streamtype)
{
const lws_ss_policy_t *p = context->pss_policies;
if (!streamtype)
return NULL;
#if defined(LWS_WITH_SYS_SMD)
if (!strcmp(streamtype, LWS_SMD_STREAMTYPENAME))
return &pol_smd;
#endif
while (p) {
if (!strcmp(p->streamtype, streamtype))
return p;
p = p->next;
}
return NULL;
}
int
_lws_ss_set_metadata(lws_ss_metadata_t *omd, const char *name,
const void *value, size_t len)
{
/*
* If there was already a heap-based value, it's about to go out of
* scope due to us trashing the pointer. So free it first and clear
* its flag indicating it's heap-based.
*/
if (omd->value_on_lws_heap) {
lws_free_set_NULL(omd->value__may_own_heap);
omd->value_on_lws_heap = 0;
}
// lwsl_notice("%s: %s %s\n", __func__, name, (const char *)value);
omd->name = name;
omd->value__may_own_heap = (void *)value;
omd->length = len;
return 0;
}
int
lws_ss_set_metadata(struct lws_ss_handle *h, const char *name,
const void *value, size_t len)
{
lws_ss_metadata_t *omd = lws_ss_get_handle_metadata(h, name);
lws_service_assert_loop_thread(h->context, h->tsi);
if (omd)
return _lws_ss_set_metadata(omd, name, value, len);
#if defined(LWS_WITH_SS_DIRECT_PROTOCOL_STR)
if (h->policy->flags & LWSSSPOLF_DIRECT_PROTO_STR) {
omd = lws_ss_get_handle_instant_metadata(h, name);
if (!omd) {
omd = lws_zalloc(sizeof(*omd), "imetadata");
if (!omd) {
lwsl_err("%s OOM\n", __func__);
return 1;
}
omd->name = name;
omd->next = h->instant_metadata;
h->instant_metadata = omd;
}
omd->value__may_own_heap = (void *)value;
omd->length = len;
return 0;
}
#endif
lwsl_info("%s: unknown metadata %s\n", __func__, name);
return 1;
}
int
_lws_ss_alloc_set_metadata(lws_ss_metadata_t *omd, const char *name,
const void *value, size_t len)
{
uint8_t *p;
int n;
if (omd->value_on_lws_heap) {
lws_free_set_NULL(omd->value__may_own_heap);
omd->value_on_lws_heap = 0;
}
p = lws_malloc(len, __func__);
if (!p)
return 1;
n = _lws_ss_set_metadata(omd, name, p, len);
if (n) {
lws_free(p);
return n;
}
memcpy(p, value, len);
omd->value_on_lws_heap = 1;
return 0;
}
int
lws_ss_alloc_set_metadata(struct lws_ss_handle *h, const char *name,
const void *value, size_t len)
{
lws_ss_metadata_t *omd = lws_ss_get_handle_metadata(h, name);
lws_service_assert_loop_thread(h->context, h->tsi);
if (!omd) {
lwsl_info("%s: unknown metadata %s\n", __func__, name);
return 1;
}
return _lws_ss_alloc_set_metadata(omd, name, value, len);
}
int
lws_ss_get_metadata(struct lws_ss_handle *h, const char *name,
const void **value, size_t *len)
{
lws_ss_metadata_t *omd = lws_ss_get_handle_metadata(h, name);
#if defined(LWS_WITH_SS_DIRECT_PROTOCOL_STR)
int n;
#endif
lws_service_assert_loop_thread(h->context, h->tsi);
if (omd) {
*value = omd->value__may_own_heap;
*len = omd->length;
return 0;
}
#if defined(LWS_WITH_SS_DIRECT_PROTOCOL_STR)
if (!(h->policy->flags & LWSSSPOLF_DIRECT_PROTO_STR) || !h->wsi)
goto bail;
n = lws_http_string_to_known_header(name, strlen(name));
if (n != LWS_HTTP_NO_KNOWN_HEADER) {
*len = (size_t)lws_hdr_total_length(h->wsi, n);
if (!*len)
goto bail;
*value = lws_hdr_simple_ptr(h->wsi, n);
if (!*value)
goto bail;
return 0;
}
#if defined(LWS_WITH_CUSTOM_HEADERS)
n = lws_hdr_custom_length(h->wsi, (const char *)name,
(int)strlen(name));
if (n <= 0)
goto bail;
*value = lwsac_use(&h->imd_ac, (size_t)(n+1), (size_t)(n+1));
if (!*value) {
lwsl_err("%s ac OOM\n", __func__);
return 1;
}
if (lws_hdr_custom_copy(h->wsi, (char *)(*value), n+1, name,
(int)strlen(name))) {
/* waste n+1 bytes until ss is destryed */
goto bail;
}
*len = (size_t)n;
return 0;
#endif
bail:
#endif
lwsl_info("%s: unknown metadata %s\n", __func__, name);
return 1;
}
lws_ss_metadata_t *
lws_ss_get_handle_metadata(struct lws_ss_handle *h, const char *name)
{
int n;
lws_service_assert_loop_thread(h->context, h->tsi);
for (n = 0; n < h->policy->metadata_count; n++)
if (!strcmp(name, h->metadata[n].name))
return &h->metadata[n];
return NULL;
}
#if defined(LWS_WITH_SS_DIRECT_PROTOCOL_STR)
lws_ss_metadata_t *
lws_ss_get_handle_instant_metadata(struct lws_ss_handle *h, const char *name)
{
lws_ss_metadata_t *imd = h->instant_metadata;
while (imd) {
if (!strcmp(name, imd->name))
return imd;
imd = imd->next;
}
return NULL;
}
#endif
lws_ss_metadata_t *
lws_ss_policy_metadata(const lws_ss_policy_t *p, const char *name)
{
lws_ss_metadata_t *pmd = p->metadata;
while (pmd) {
if (pmd->name && !strcmp(name, pmd->name))
return pmd;
pmd = pmd->next;
}
return NULL;
}
lws_ss_metadata_t *
lws_ss_policy_metadata_index(const lws_ss_policy_t *p, size_t index)
{
lws_ss_metadata_t *pmd = p->metadata;
while (pmd) {
if (pmd->length == index)
return pmd;
pmd = pmd->next;
}
return NULL;
}
#if !defined(LWS_WITH_SECURE_STREAMS_STATIC_POLICY_ONLY)
static int
fe_lws_ss_destroy(struct lws_dll2 *d, void *user)
{
lws_ss_handle_t *h = lws_container_of(d, lws_ss_handle_t, list);
lws_ss_destroy(&h);
return 0;
}
#endif
/*
* Dynamic policy: we want to one-time create the vhost for the policy and the
* trust store behind it.
*
* Static policy: We want to make use of a trust store / vhost from the policy and add to its
* ss-refcount.
*/
struct lws_vhost *
lws_ss_policy_ref_trust_store(struct lws_context *context,
const lws_ss_policy_t *pol, char doref)
{
struct lws_context_creation_info i;
struct lws_vhost *v;
int n;
memset(&i, 0, sizeof(i));
if (!pol->trust.store) {
v = lws_get_vhost_by_name(context, "_ss_default");
if (!v) {
/* corner case... there's no trust store used */
i.options = context->options;
i.vhost_name = "_ss_default";
i.port = CONTEXT_PORT_NO_LISTEN;
v = lws_create_vhost(context, &i);
if (!v) {
lwsl_err("%s: failed to create vhost %s\n",
__func__, i.vhost_name);
return NULL;
}
}
goto accepted;
}
v = lws_get_vhost_by_name(context, pol->trust.store->name);
if (v) {
lwsl_debug("%s: vh already exists\n", __func__);
goto accepted;
}
i.options = context->options;
i.vhost_name = pol->trust.store->name;
lwsl_debug("%s: %s\n", __func__, i.vhost_name);
#if defined(LWS_WITH_TLS) && defined(LWS_WITH_CLIENT)
i.client_ssl_ca_mem = pol->trust.store->ssx509[0]->ca_der;
i.client_ssl_ca_mem_len = (unsigned int)
pol->trust.store->ssx509[0]->ca_der_len;
#endif
i.port = CONTEXT_PORT_NO_LISTEN;
lwsl_info("%s: %s trust store initial '%s'\n", __func__,
i.vhost_name, pol->trust.store->ssx509[0]->vhost_name);
v = lws_create_vhost(context, &i);
if (!v) {
lwsl_err("%s: failed to create vhost %s\n",
__func__, i.vhost_name);
return NULL;
} else
v->from_ss_policy = 1;
for (n = 1; v && n < pol->trust.store->count; n++) {
lwsl_info("%s: add '%s' to trust store\n", __func__,
pol->trust.store->ssx509[n]->vhost_name);
#if defined(LWS_WITH_TLS)
if (lws_tls_client_vhost_extra_cert_mem(v,
pol->trust.store->ssx509[n]->ca_der,
pol->trust.store->ssx509[n]->ca_der_len)) {
lwsl_err("%s: add extra cert failed\n",
__func__);
return NULL;
}
#endif
}
accepted:
#if defined(LWS_WITH_SECURE_STREAMS_STATIC_POLICY_ONLY) || defined(LWS_WITH_SECURE_STREAMS_CPP)
if (doref)
v->ss_refcount++;
#endif
return v;
}
#if defined(LWS_WITH_SECURE_STREAMS_STATIC_POLICY_ONLY) || defined(LWS_WITH_SECURE_STREAMS_CPP)
int
lws_ss_policy_unref_trust_store(struct lws_context *context,
const lws_ss_policy_t *pol)
{
struct lws_vhost *v;
const char *name = "_ss_default";
if (pol->trust.store)
name = pol->trust.store->name;
v = lws_get_vhost_by_name(context, name);
if (!v || !v->from_ss_policy)
return 0;
assert(v->ss_refcount);
v->ss_refcount--;
if (!v->ss_refcount) {
lwsl_notice("%s: destroying vh %s\n", __func__, name);
lws_vhost_destroy(v);
}
return 1;
}
#endif
int
lws_ss_policy_set(struct lws_context *context, const char *name)
{
int ret = 0;
#if !defined(LWS_WITH_SECURE_STREAMS_STATIC_POLICY_ONLY)
struct policy_cb_args *args = (struct policy_cb_args *)context->pol_args;
const lws_ss_policy_t *pol;
struct lws_vhost *v;
lws_ss_x509_t *x;
char buf[16];
int m;
/*
* Parsing seems to have succeeded, and we're going to use the new
* policy that's laid out in args->ac
*/
if (!args)
return 1;
lejp_destruct(&args->jctx);
if (context->ac_policy) {
int n;
#if defined(LWS_WITH_SYS_METRICS)
lws_start_foreach_dll_safe(struct lws_dll2 *, d, d1,
context->owner_mtr_dynpol.head) {
lws_metric_policy_dyn_t *dm =
lws_container_of(d, lws_metric_policy_dyn_t, list);
lws_metric_policy_dyn_destroy(dm, 1); /* keep */
} lws_end_foreach_dll_safe(d, d1);
#endif
/*
* any existing ss created with the old policy have to go away
* now, since they point to the shortly-to-be-destroyed old
* policy
*/
for (n = 0; n < context->count_threads; n++) {
struct lws_context_per_thread *pt = &context->pt[n];
lws_dll2_foreach_safe(&pt->ss_owner, NULL, fe_lws_ss_destroy);
}
/*
* So this is a bit fun-filled, we already had a policy in
* force, perhaps it was the default policy that's just good for
* fetching the real policy, and we're doing that now.
*
* We can destroy all the policy-related direct allocations
* easily because they're cleanly in a single lwsac...
*/
lwsac_free(&context->ac_policy);
/*
* ...but when we did the trust stores, we created vhosts for
* each. We need to destroy those now too, and recreate new
* ones from the new policy, perhaps with different X.509s.
*
* Vhost destruction is inherently async, it can't be destroyed
* until all of the wsi bound to it have closed, and, eg, libuv
* means their closure is deferred until a later go around the
* event loop. SMP means we also have to wait for all the pts
* to close their wsis that are bound on the vhost too.
*
* This marks the vhost as being destroyed so new things won't
* use it, and starts the close of all wsi on this pt that are
* bound to the wsi, and deals with the listen socket if any.
* "being-destroyed" vhosts can't be found using get_vhost_by_
* name(), so if a new vhost of the same name exists that isn't
* being destroyed that will be the one found.
*
* When the number of wsi bound to the vhost gets to zero a
* short time later, the vhost is actually destroyed.
*/
v = context->vhost_list;
while (v) {
if (v->from_ss_policy) {
struct lws_vhost *vh = v->vhost_next;
lwsl_debug("%s: destroying %s\n", __func__, lws_vh_tag(v));
lws_vhost_destroy(v);
v = vh;
continue;
}
v = v->vhost_next;
}
}
context->pss_policies = args->heads[LTY_POLICY].p;
context->ac_policy = args->ac;
lws_humanize(buf, sizeof(buf), lwsac_total_alloc(args->ac),
humanize_schema_si_bytes);
if (lwsac_total_alloc(args->ac))
m = (int)((lwsac_total_overhead(args->ac) * 100) /
lwsac_total_alloc(args->ac));
else
m = 0;
(void)m;
lwsl_info("%s: %s, pad %d%c: %s\n", __func__, buf, m, '%', name);
/* Create vhosts for each type of trust store */
/*
* We get called from context creation... instantiates
* vhosts with client tls contexts set up for each unique CA.
*
* We create the vhosts by walking streamtype list and create vhosts
* using trust store name if it's a client connection that doesn't
* already exist.
*/
pol = context->pss_policies;
while (pol) {
if (!(pol->flags & LWSSSPOLF_SERVER)) {
v = lws_ss_policy_ref_trust_store(context, pol,
0 /* no refcount inc */);
if (!v)
ret = 1;
}
pol = pol->next;
}
#if defined(LWS_WITH_SOCKS5)
/*
* ... we need to go through every vhost updating its understanding of
* which socks5 proxy to use...
*/
v = context->vhost_list;
while (v) {
lws_set_socks(v, args->socks5_proxy);
v = v->vhost_next;
}
if (context->vhost_system)
lws_set_socks(context->vhost_system, args->socks5_proxy);
if (args->socks5_proxy)
lwsl_notice("%s: global socks5 proxy: %s\n", __func__,
args->socks5_proxy);
#endif
/*
* For dynamic policy case, now we processed the x.509 CAs, we can free
* all of our originals. For static policy, they're in .rodata, nothing
* to free.
*/
x = args->heads[LTY_X509].x;
while (x) {
/*
* Free all the client DER buffers now they have been parsed
* into tls library X.509 objects
*/
if (!x->keep) { /* used for server */
lws_free((void *)x->ca_der);
x->ca_der = NULL;
}
x = x->next;
}
context->last_policy = time(NULL);
#if defined(LWS_WITH_SYS_METRICS)
if (context->pss_policies)
((lws_ss_policy_t *)context->pss_policies)->metrics =
args->heads[LTY_METRICS].m;
#endif
/* and we can discard the parsing args object now, invalidating args */
lws_free_set_NULL(context->pol_args);
#endif
#if defined(LWS_WITH_SYS_METRICS)
lws_metric_rebind_policies(context);
#endif
#if defined(LWS_WITH_SYS_SMD)
(void)lws_smd_msg_printf(context, LWSSMDCL_SYSTEM_STATE,
"{\"policy\":\"updated\",\"ts\":%lu}",
(long)context->last_policy);
#endif
return ret;
}
|