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
|
/* Copyright (C) 2024-2025 maClara, LLC <info@maclara-llc.com>
This file is part of the JWT C Library
SPDX-License-Identifier: MPL-2.0
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include <stdlib.h>
#include <string.h>
#include <jwt.h>
#include "jwt-private.h"
/* RFC-7517 4.3 */
static jwk_key_op_t jwk_key_op_j(json_t *j_op)
{
const char *op;
if (!j_op || !json_is_string(j_op))
return JWK_KEY_OP_NONE;
op = json_string_value(j_op);
/* Should not be possible for this to happen. */
if (op == NULL)
return JWK_KEY_OP_NONE; // LCOV_EXCL_LINE
if (!strcmp(op, "sign"))
return JWK_KEY_OP_SIGN;
else if (!strcmp(op, "verify"))
return JWK_KEY_OP_VERIFY;
else if (!strcmp(op, "encrypt"))
return JWK_KEY_OP_ENCRYPT;
else if (!strcmp(op, "decrypt"))
return JWK_KEY_OP_DECRYPT;
else if (!strcmp(op, "wrapKey"))
return JWK_KEY_OP_WRAP;
else if (!strcmp(op, "unwrapKey"))
return JWK_KEY_OP_UNWRAP;
else if (!strcmp(op, "deriveKey"))
return JWK_KEY_OP_DERIVE_KEY;
else if (!strcmp(op, "deriveBits"))
return JWK_KEY_OP_DERIVE_BITS;
/* Ignore all others as the spec says other values may be used. */
return JWK_KEY_OP_NONE;
}
static void jwk_process_values(json_t *jwk, jwk_item_t *item)
{
json_t *j_use, *j_ops_a, *j_kid, *j_alg;
/* Start with the ALG (4.4). */
j_alg = json_object_get(jwk, "alg");
if (j_alg) {
if (!json_is_string(j_alg)) {
jwt_write_error(item, "Invalid alg type");
return;
}
item->alg = jwt_str_alg(json_string_value(j_alg));
}
/* Check for use (4.2). */
j_use = json_object_get(jwk, "use");
if (j_use && json_is_string(j_use)) {
const char *use = json_string_value(j_use);
if (!strcmp(use, "sig"))
item->use = JWK_PUB_KEY_USE_SIG;
else if (!strcmp(use, "enc"))
item->use = JWK_PUB_KEY_USE_ENC;
}
/* Check for key_ops (4.3). */
j_ops_a = json_object_get(jwk, "key_ops");
if (j_ops_a && json_is_array(j_ops_a)) {
json_t *j_op;
size_t i;
json_array_foreach(j_ops_a, i, j_op)
item->key_ops |= jwk_key_op_j(j_op);;
}
/* Key ID (4.5). */
j_kid = json_object_get(jwk, "kid");
if (j_kid && json_is_string(j_kid)) {
const char *kid = json_string_value(j_kid);
int len = strlen(kid);
if (len) {
item->kid = jwt_malloc(len + 1);
if (item->kid == NULL) {
// LCOV_EXCL_START
jwt_write_error(item,
"Error allocating memory for kid");
// LCOV_EXCL_STOP
} else { // LCOV_EXCL_LINE
strcpy(item->kid, kid);
}
}
}
}
static int process_octet(json_t *jwk, jwk_item_t *item)
{
unsigned char *bin_k = NULL;
const char *str_k;
json_t *k;
int len_k = 0;
k = json_object_get(jwk, "k");
if (k == NULL || !json_is_string(k)) {
jwt_write_error(item, "Invalid JWK: missing `k`");
return -1;
}
str_k = json_string_value(k);
if (str_k == NULL || !strlen(str_k)) {
jwt_write_error(item, "Invalid JWK: invalid `k`");
return -1;
}
bin_k = jwt_base64uri_decode(str_k, &len_k);
if (bin_k == NULL) {
// LCOV_EXCL_START
jwt_write_error(item, "Invalid JWK: failed to decode `k`");
return -1;
// LCOV_EXCL_STOP
}
item->is_private_key = 1;
item->provider = JWT_CRYPTO_OPS_ANY;
item->oct.key = bin_k;
item->oct.len = len_k;
item->bits = len_k * 8;
return 0;
}
static jwk_item_t *jwk_process_one(jwk_set_t *jwk_set, json_t *jwk)
{
const char *kty;
json_t *val;
jwk_item_t *item;
item = jwt_malloc(sizeof(*item));
if (item == NULL) {
// LCOV_EXCL_START
jwt_write_error(jwk_set,
"Error allocating memory for jwk_item_t");
return NULL;
// LCOV_EXCL_STOP
}
memset(item, 0, sizeof(*item));
item->json = json_deep_copy(jwk);
if (item->json == NULL) {
// LCOV_EXCL_START
jwt_freemem(jwk);
jwt_write_error(jwk_set,
"Error allocating memory for jwk_item_t");
return NULL;
// LCOV_EXCL_STOP
}
val = json_object_get(item->json, "kty");
if (val == NULL || !json_is_string(val)) {
jwt_write_error(item, "Invalid JWK: missing kty value");
return item;
}
kty = json_string_value(val);
if (!strcmp(kty, "EC")) {
item->kty = JWK_KEY_TYPE_EC;
jwt_ops->process_ec(item->json, item);
} else if (!strcmp(kty, "RSA")) {
item->kty = JWK_KEY_TYPE_RSA;
jwt_ops->process_rsa(item->json, item);
} else if (!strcmp(kty, "OKP")) {
item->kty = JWK_KEY_TYPE_OKP;
jwt_ops->process_eddsa(item->json, item);
} else if (!strcmp(kty, "oct")) {
item->kty = JWK_KEY_TYPE_OCT;
process_octet(item->json, item);
} else {
jwt_write_error(item, "Unknown or unsupported kty type '%s'", kty);
return item;
}
jwk_process_values(item->json, item);
return item;
}
const jwk_item_t *jwks_item_get(const jwk_set_t *jwk_set, size_t index)
{
jwk_item_t *item = NULL;
size_t i = 0;
list_for_each_entry(item, &jwk_set->head, node) {
if (i == index)
return item;
i++;
}
return NULL;
}
int jwks_error_any(const jwk_set_t *jwk_set)
{
jwk_item_t *item = NULL;
int count = jwk_set->error;
list_for_each_entry(item, &jwk_set->head, node) {
if (item->error)
count++;
}
return count;
}
int jwks_item_is_private(const jwk_item_t *item)
{
return item->is_private_key ? 1 : 0;
}
int jwks_item_error(const jwk_item_t *item)
{
return item->error;
}
const char *jwks_item_error_msg(const jwk_item_t *item)
{
return item->error_msg;
}
const char *jwks_item_curve(const jwk_item_t *item)
{
return item->curve[0] ? item->curve : NULL;
}
const char *jwks_item_kid(const jwk_item_t *item)
{
return item->kid;
}
jwt_alg_t jwks_item_alg(const jwk_item_t *item)
{
return item->alg;
}
jwk_key_type_t jwks_item_kty(const jwk_item_t *item)
{
return item->kty;
}
jwk_pub_key_use_t jwks_item_use(const jwk_item_t *item)
{
return item->use;
}
jwk_key_op_t jwks_item_key_ops(const jwk_item_t *item)
{
return item->key_ops;
}
const char *jwks_item_pem(const jwk_item_t *item)
{
return item->pem;
}
int jwks_item_key_bits(const jwk_item_t *item)
{
return item->bits;
}
int jwks_item_key_oct(const jwk_item_t *item, const unsigned char **buf,
size_t *len)
{
if (!item->oct.key || !item->oct.len)
return 1;
*buf = item->oct.key;
*len = item->oct.len;
return 0;
}
int jwks_error(const jwk_set_t *jwk_set)
{
return jwk_set->error ? 1 : 0;
}
const char *jwks_error_msg(const jwk_set_t *jwk_set)
{
return jwk_set->error_msg;
}
void jwks_error_clear(jwk_set_t *jwk_set)
{
jwk_set->error = 0;
memset(jwk_set->error_msg, 0, sizeof(jwk_set->error_msg));
}
static int jwks_item_add(jwk_set_t *jwk_set, jwk_item_t *item)
{
list_add_tail(&item->node, &jwk_set->head);
return 0;
}
jwk_item_t *jwks_find_bykid(jwk_set_t *jwk_set, const char *kid)
{
jwk_item_t *item = NULL;
list_for_each_entry(item, &jwk_set->head, node) {
if (item->kid == NULL || strcmp(item->kid, kid))
continue;
return item;
}
return NULL;
}
static void __item_free(jwk_item_t *todel)
{
if (todel->provider == JWT_CRYPTO_OPS_ANY)
jwt_freemem(todel->oct.key);
else
jwt_ops->process_item_free(todel);
/* A few non-crypto specific things. */
jwt_freemem(todel->kid);
json_decrefp(&todel->json);
list_del(&todel->node);
/* Free the container and the item itself. */
jwt_freemem(todel);
}
int jwks_item_free(jwk_set_t *jwk_set, const size_t index)
{
jwk_item_t *item = NULL, *todel = NULL;
size_t i = 0;
if (jwk_set == NULL)
return 0;
list_for_each_entry(item, &jwk_set->head, node) {
if (i == index) {
todel = item;
break;
}
i++;
}
if (todel == NULL)
return 0;
__item_free(todel);
return 1;
}
size_t jwks_item_count(const jwk_set_t *jwk_set)
{
size_t count = 0;
jwk_item_t *item = NULL;
list_for_each_entry(item, &jwk_set->head, node)
count++;
return count;
}
int jwks_item_free_bad(jwk_set_t *jwk_set)
{
jwk_item_t *item, *pos;
int count = 0;
list_for_each_entry_safe(item, pos, &jwk_set->head, node) {
if (!item->error)
continue;
__item_free(item);
count++;
}
return count;
}
int jwks_item_free_all(jwk_set_t *jwk_set)
{
int i;
if (jwk_set == NULL)
return 0;
for (i = 0; jwks_item_free(jwk_set, 0); i++)
/* do nothing */;
return i;
}
void jwks_free(jwk_set_t *jwk_set)
{
if (jwk_set == NULL)
return;
jwks_item_free_all(jwk_set);
jwt_freemem(jwk_set);
}
static jwk_set_t *jwks_new(void)
{
jwk_set_t *jwk_set;
jwk_set = jwt_malloc(sizeof *jwk_set);
if (jwk_set == NULL)
return NULL; // LCOV_EXCL_LINE
memset(jwk_set, 0, sizeof(*jwk_set));
INIT_LIST_HEAD(&jwk_set->head);
return jwk_set;
}
static jwk_set_t *jwks_process(jwk_set_t *jwk_set, json_t *j_all, json_error_t *error)
{
json_t *j_array = NULL, *j_item = NULL;
jwk_item_t *jwk_item;
size_t i;
if (j_all == NULL) {
jwt_write_error(jwk_set, "%s: %s", error->source, error->text);
return jwk_set;
}
/* Check for "keys" as in a JWKS */
j_array = json_object_get(j_all, "keys");
if (j_array == NULL) {
/* Assume a single JSON Object for one JWK */
jwk_item = jwk_process_one(jwk_set, j_all);
jwks_item_add(jwk_set, jwk_item);
} else {
/* We have a list, so parse them all. */
json_array_foreach(j_array, i, j_item) {
jwk_item = jwk_process_one(jwk_set, j_item);
jwks_item_add(jwk_set, jwk_item);
}
}
return jwk_set;
}
static jwk_set_t *__jwks_load_strn(jwk_set_t *jwk_set, const char *jwk_json_str,
const size_t len, int empty_allowed)
{
json_auto_t *j_all = NULL;
json_error_t error;
if (jwk_json_str == NULL && !empty_allowed)
return NULL;
if (jwk_set == NULL)
jwk_set = jwks_new();
if (jwk_set == NULL)
return NULL; // LCOV_EXCL_LINE
/* Just an empty set */
if (jwk_json_str == NULL)
return jwk_set;
/* Parse the JSON string. */
j_all = json_loadb(jwk_json_str, len, JSON_DECODE_ANY, &error);
return jwks_process(jwk_set, j_all, &error);
}
jwk_set_t *jwks_load_strn(jwk_set_t *jwk_set, const char *jwk_json_str,
const size_t len)
{
return __jwks_load_strn(jwk_set, jwk_json_str, len, 0);
}
jwk_set_t *jwks_load(jwk_set_t *jwk_set, const char *jwk_json_str)
{
int len;
if (jwk_json_str == NULL)
return NULL;
len = strlen(jwk_json_str);
return __jwks_load_strn(jwk_set, jwk_json_str, len, 0);
}
jwk_set_t *jwks_load_fromfile(jwk_set_t *jwk_set, const char *file_name)
{
json_auto_t *j_all = NULL;
json_error_t error;
if (file_name == NULL)
return NULL;
if (jwk_set == NULL)
jwk_set = jwks_new();
if (jwk_set == NULL)
return NULL; // LCOV_EXCL_LINE
/* Parse the JSON string. */
j_all = json_load_file(file_name, JSON_DECODE_ANY, &error);
return jwks_process(jwk_set, j_all, &error);
}
jwk_set_t *jwks_load_fromfp(jwk_set_t *jwk_set, FILE *input)
{
json_auto_t *j_all = NULL;
json_error_t error;
if (input == NULL)
return NULL;
if (jwk_set == NULL)
jwk_set = jwks_new();
if (jwk_set == NULL)
return NULL; // LCOV_EXCL_LINE
/* Parse the JSON string. */
j_all = json_loadf(input, JSON_DECODE_ANY, &error);
return jwks_process(jwk_set, j_all, &error);
}
jwk_set_t *jwks_create(const char *jwk_json_str)
{
int len = 0;
if (jwk_json_str != NULL)
len = strlen(jwk_json_str);
return __jwks_load_strn(NULL, jwk_json_str, len, 1);
}
jwk_set_t *jwks_create_strn(const char *jwk_json_str, const size_t len)
{
return jwks_load_strn(NULL, jwk_json_str, len);
}
jwk_set_t *jwks_create_fromfile(const char *file_name)
{
return jwks_load_fromfile(NULL, file_name);
}
jwk_set_t *jwks_create_fromfp(FILE *input)
{
return jwks_load_fromfp(NULL, input);
}
|