JWT-CPP v0.7.0
A header only library for creating and validating JSON Web Tokens (JWT) in C++
Loading...
Searching...
No Matches
jwt.h
1#ifndef JWT_CPP_JWT_H
2#define JWT_CPP_JWT_H
3
4#ifndef JWT_DISABLE_PICOJSON
5#ifndef PICOJSON_USE_INT64
6#define PICOJSON_USE_INT64
7#endif
8#include "picojson/picojson.h"
9#endif
10
11#ifndef JWT_DISABLE_BASE64
12#include "base.h"
13#endif
14
15#include <openssl/ec.h>
16#include <openssl/ecdsa.h>
17#include <openssl/err.h>
18#include <openssl/evp.h>
19#include <openssl/hmac.h>
20#include <openssl/pem.h>
21#include <openssl/rsa.h>
22#include <openssl/ssl.h>
23
24#include <algorithm>
25#include <chrono>
26#include <climits>
27#include <cmath>
28#include <cstring>
29#include <functional>
30#include <iterator>
31#include <locale>
32#include <memory>
33#include <set>
34#include <system_error>
35#include <type_traits>
36#include <unordered_map>
37#include <utility>
38#include <vector>
39
40#if __cplusplus >= 201402L
41#ifdef __has_include
42#if __has_include(<experimental/type_traits>)
43#include <experimental/type_traits>
44#endif
45#endif
46#endif
47
48#if OPENSSL_VERSION_NUMBER >= 0x30000000L // 3.0.0
49#define JWT_OPENSSL_3_0
50#include <openssl/param_build.h>
51#elif OPENSSL_VERSION_NUMBER >= 0x10101000L // 1.1.1
52#define JWT_OPENSSL_1_1_1
53#elif OPENSSL_VERSION_NUMBER >= 0x10100000L // 1.1.0
54#define JWT_OPENSSL_1_1_0
55#elif OPENSSL_VERSION_NUMBER >= 0x10000000L // 1.0.0
56#define JWT_OPENSSL_1_0_0
57#endif
58
59#if defined(LIBRESSL_VERSION_NUMBER)
60#if LIBRESSL_VERSION_NUMBER >= 0x3050300fL
61#define JWT_OPENSSL_1_1_0
62#else
63#define JWT_OPENSSL_1_0_0
64#endif
65#endif
66
67#if defined(LIBWOLFSSL_VERSION_HEX)
68#define JWT_OPENSSL_1_1_1
69#endif
70
71#ifndef JWT_CLAIM_EXPLICIT
72#define JWT_CLAIM_EXPLICIT explicit
73#endif
74
82namespace jwt {
86 using date = std::chrono::system_clock::time_point;
87
91 namespace error {
92 struct signature_verification_exception : public std::system_error {
93 using system_error::system_error;
94 };
95 struct signature_generation_exception : public std::system_error {
96 using system_error::system_error;
97 };
98 struct rsa_exception : public std::system_error {
99 using system_error::system_error;
100 };
101 struct ecdsa_exception : public std::system_error {
102 using system_error::system_error;
103 };
104 struct token_verification_exception : public std::system_error {
105 using system_error::system_error;
106 };
110 enum class rsa_error {
111 ok = 0,
112 cert_load_failed = 10,
113 get_key_failed,
114 write_key_failed,
115 write_cert_failed,
116 convert_to_pem_failed,
117 load_key_bio_write,
118 load_key_bio_read,
119 create_mem_bio_failed,
120 no_key_provided,
121 set_rsa_failed,
122 create_context_failed
123 };
127 inline std::error_category& rsa_error_category() {
128 class rsa_error_cat : public std::error_category {
129 public:
130 const char* name() const noexcept override { return "rsa_error"; };
131 std::string message(int ev) const override {
132 switch (static_cast<rsa_error>(ev)) {
133 case rsa_error::ok: return "no error";
134 case rsa_error::cert_load_failed: return "error loading cert into memory";
135 case rsa_error::get_key_failed: return "error getting key from certificate";
136 case rsa_error::write_key_failed: return "error writing key data in PEM format";
137 case rsa_error::write_cert_failed: return "error writing cert data in PEM format";
138 case rsa_error::convert_to_pem_failed: return "failed to convert key to pem";
139 case rsa_error::load_key_bio_write: return "failed to load key: bio write failed";
140 case rsa_error::load_key_bio_read: return "failed to load key: bio read failed";
141 case rsa_error::create_mem_bio_failed: return "failed to create memory bio";
142 case rsa_error::no_key_provided: return "at least one of public or private key need to be present";
143 case rsa_error::set_rsa_failed: return "set modulus and exponent to RSA failed";
144 case rsa_error::create_context_failed: return "failed to create context";
145 default: return "unknown RSA error";
146 }
147 }
148 };
149 static rsa_error_cat cat;
150 return cat;
151 }
155 inline std::error_code make_error_code(rsa_error e) { return {static_cast<int>(e), rsa_error_category()}; }
159 enum class ecdsa_error {
160 ok = 0,
161 load_key_bio_write = 10,
162 load_key_bio_read,
163 create_mem_bio_failed,
164 no_key_provided,
165 invalid_key_size,
166 invalid_key,
167 create_context_failed,
168 cert_load_failed,
169 get_key_failed,
170 write_key_failed,
171 write_cert_failed,
172 convert_to_pem_failed,
173 unknown_curve,
174 set_ecdsa_failed
175 };
179 inline std::error_category& ecdsa_error_category() {
180 class ecdsa_error_cat : public std::error_category {
181 public:
182 const char* name() const noexcept override { return "ecdsa_error"; };
183 std::string message(int ev) const override {
184 switch (static_cast<ecdsa_error>(ev)) {
185 case ecdsa_error::ok: return "no error";
186 case ecdsa_error::load_key_bio_write: return "failed to load key: bio write failed";
187 case ecdsa_error::load_key_bio_read: return "failed to load key: bio read failed";
188 case ecdsa_error::create_mem_bio_failed: return "failed to create memory bio";
189 case ecdsa_error::no_key_provided:
190 return "at least one of public or private key need to be present";
191 case ecdsa_error::invalid_key_size: return "invalid key size";
192 case ecdsa_error::invalid_key: return "invalid key";
193 case ecdsa_error::create_context_failed: return "failed to create context";
194 case ecdsa_error::cert_load_failed: return "error loading cert into memory";
195 case ecdsa_error::get_key_failed: return "error getting key from certificate";
196 case ecdsa_error::write_key_failed: return "error writing key data in PEM format";
197 case ecdsa_error::write_cert_failed: return "error writing cert data in PEM format";
198 case ecdsa_error::convert_to_pem_failed: return "failed to convert key to pem";
199 case ecdsa_error::unknown_curve: return "unknown curve";
200 case ecdsa_error::set_ecdsa_failed: return "set parameters to ECDSA failed";
201 default: return "unknown ECDSA error";
202 }
203 }
204 };
205 static ecdsa_error_cat cat;
206 return cat;
207 }
211 inline std::error_code make_error_code(ecdsa_error e) { return {static_cast<int>(e), ecdsa_error_category()}; }
212
216 enum class signature_verification_error {
217 ok = 0,
218 invalid_signature = 10,
219 create_context_failed,
220 verifyinit_failed,
221 verifyupdate_failed,
222 verifyfinal_failed,
223 get_key_failed,
224 set_rsa_pss_saltlen_failed,
225 signature_encoding_failed
226 };
230 inline std::error_category& signature_verification_error_category() {
231 class verification_error_cat : public std::error_category {
232 public:
233 const char* name() const noexcept override { return "signature_verification_error"; };
234 std::string message(int ev) const override {
235 switch (static_cast<signature_verification_error>(ev)) {
236 case signature_verification_error::ok: return "no error";
237 case signature_verification_error::invalid_signature: return "invalid signature";
238 case signature_verification_error::create_context_failed:
239 return "failed to verify signature: could not create context";
240 case signature_verification_error::verifyinit_failed:
241 return "failed to verify signature: VerifyInit failed";
242 case signature_verification_error::verifyupdate_failed:
243 return "failed to verify signature: VerifyUpdate failed";
244 case signature_verification_error::verifyfinal_failed:
245 return "failed to verify signature: VerifyFinal failed";
246 case signature_verification_error::get_key_failed:
247 return "failed to verify signature: Could not get key";
248 case signature_verification_error::set_rsa_pss_saltlen_failed:
249 return "failed to verify signature: EVP_PKEY_CTX_set_rsa_pss_saltlen failed";
250 case signature_verification_error::signature_encoding_failed:
251 return "failed to verify signature: i2d_ECDSA_SIG failed";
252 default: return "unknown signature verification error";
253 }
254 }
255 };
256 static verification_error_cat cat;
257 return cat;
258 }
262 inline std::error_code make_error_code(signature_verification_error e) {
263 return {static_cast<int>(e), signature_verification_error_category()};
264 }
265
269 enum class signature_generation_error {
270 ok = 0,
271 hmac_failed = 10,
272 create_context_failed,
273 signinit_failed,
274 signupdate_failed,
275 signfinal_failed,
276 ecdsa_do_sign_failed,
277 digestinit_failed,
278 digestupdate_failed,
279 digestfinal_failed,
280 rsa_padding_failed,
281 rsa_private_encrypt_failed,
282 get_key_failed,
283 set_rsa_pss_saltlen_failed,
284 signature_decoding_failed
285 };
289 inline std::error_category& signature_generation_error_category() {
290 class signature_generation_error_cat : public std::error_category {
291 public:
292 const char* name() const noexcept override { return "signature_generation_error"; };
293 std::string message(int ev) const override {
294 switch (static_cast<signature_generation_error>(ev)) {
295 case signature_generation_error::ok: return "no error";
296 case signature_generation_error::hmac_failed: return "hmac failed";
297 case signature_generation_error::create_context_failed:
298 return "failed to create signature: could not create context";
299 case signature_generation_error::signinit_failed:
300 return "failed to create signature: SignInit failed";
301 case signature_generation_error::signupdate_failed:
302 return "failed to create signature: SignUpdate failed";
303 case signature_generation_error::signfinal_failed:
304 return "failed to create signature: SignFinal failed";
305 case signature_generation_error::ecdsa_do_sign_failed: return "failed to generate ecdsa signature";
306 case signature_generation_error::digestinit_failed:
307 return "failed to create signature: DigestInit failed";
308 case signature_generation_error::digestupdate_failed:
309 return "failed to create signature: DigestUpdate failed";
310 case signature_generation_error::digestfinal_failed:
311 return "failed to create signature: DigestFinal failed";
312 case signature_generation_error::rsa_padding_failed:
313 return "failed to create signature: EVP_PKEY_CTX_set_rsa_padding failed";
314 case signature_generation_error::rsa_private_encrypt_failed:
315 return "failed to create signature: RSA_private_encrypt failed";
316 case signature_generation_error::get_key_failed:
317 return "failed to generate signature: Could not get key";
318 case signature_generation_error::set_rsa_pss_saltlen_failed:
319 return "failed to create signature: EVP_PKEY_CTX_set_rsa_pss_saltlen failed";
320 case signature_generation_error::signature_decoding_failed:
321 return "failed to create signature: d2i_ECDSA_SIG failed";
322 default: return "unknown signature generation error";
323 }
324 }
325 };
326 static signature_generation_error_cat cat = {};
327 return cat;
328 }
332 inline std::error_code make_error_code(signature_generation_error e) {
333 return {static_cast<int>(e), signature_generation_error_category()};
334 }
335
339 enum class token_verification_error {
340 ok = 0,
341 wrong_algorithm = 10,
342 missing_claim,
343 claim_type_missmatch,
344 claim_value_missmatch,
345 token_expired,
346 audience_missmatch
347 };
351 inline std::error_category& token_verification_error_category() {
352 class token_verification_error_cat : public std::error_category {
353 public:
354 const char* name() const noexcept override { return "token_verification_error"; };
355 std::string message(int ev) const override {
356 switch (static_cast<token_verification_error>(ev)) {
357 case token_verification_error::ok: return "no error";
358 case token_verification_error::wrong_algorithm: return "wrong algorithm";
359 case token_verification_error::missing_claim: return "decoded JWT is missing required claim(s)";
360 case token_verification_error::claim_type_missmatch:
361 return "claim type does not match expected type";
362 case token_verification_error::claim_value_missmatch:
363 return "claim value does not match expected value";
364 case token_verification_error::token_expired: return "token expired";
365 case token_verification_error::audience_missmatch:
366 return "token doesn't contain the required audience";
367 default: return "unknown token verification error";
368 }
369 }
370 };
371 static token_verification_error_cat cat = {};
372 return cat;
373 }
377 inline std::error_code make_error_code(token_verification_error e) {
378 return {static_cast<int>(e), token_verification_error_category()};
379 }
383 inline void throw_if_error(std::error_code ec) {
384 if (ec) {
385 if (ec.category() == rsa_error_category()) throw rsa_exception(ec);
386 if (ec.category() == ecdsa_error_category()) throw ecdsa_exception(ec);
387 if (ec.category() == signature_verification_error_category())
388 throw signature_verification_exception(ec);
389 if (ec.category() == signature_generation_error_category()) throw signature_generation_exception(ec);
390 if (ec.category() == token_verification_error_category()) throw token_verification_exception(ec);
391 }
392 }
393 } // namespace error
394} // namespace jwt
395
396namespace std {
397 template<>
398 struct is_error_code_enum<jwt::error::rsa_error> : true_type {};
399 template<>
400 struct is_error_code_enum<jwt::error::ecdsa_error> : true_type {};
401 template<>
402 struct is_error_code_enum<jwt::error::signature_verification_error> : true_type {};
403 template<>
404 struct is_error_code_enum<jwt::error::signature_generation_error> : true_type {};
405 template<>
406 struct is_error_code_enum<jwt::error::token_verification_error> : true_type {};
407} // namespace std
408
409namespace jwt {
417 namespace helper {
425 class evp_pkey_handle {
426 public:
430 constexpr evp_pkey_handle() noexcept = default;
431#ifdef JWT_OPENSSL_1_0_0
436 explicit evp_pkey_handle(EVP_PKEY* key) { m_key = std::shared_ptr<EVP_PKEY>(key, EVP_PKEY_free); }
437
438 EVP_PKEY* get() const noexcept { return m_key.get(); }
439 bool operator!() const noexcept { return m_key == nullptr; }
440 explicit operator bool() const noexcept { return m_key != nullptr; }
441
442 private:
443 std::shared_ptr<EVP_PKEY> m_key{nullptr};
444#else
449 explicit constexpr evp_pkey_handle(EVP_PKEY* key) noexcept : m_key{key} {}
450 evp_pkey_handle(const evp_pkey_handle& other) : m_key{other.m_key} {
451 if (m_key != nullptr && EVP_PKEY_up_ref(m_key) != 1) throw std::runtime_error("EVP_PKEY_up_ref failed");
452 }
453// C++11 requires the body of a constexpr constructor to be empty
454#if __cplusplus >= 201402L
455 constexpr
456#endif
457 evp_pkey_handle(evp_pkey_handle&& other) noexcept
458 : m_key{other.m_key} {
459 other.m_key = nullptr;
460 }
461 evp_pkey_handle& operator=(const evp_pkey_handle& other) {
462 if (&other == this) return *this;
463 decrement_ref_count(m_key);
464 m_key = other.m_key;
465 increment_ref_count(m_key);
466 return *this;
467 }
468 evp_pkey_handle& operator=(evp_pkey_handle&& other) noexcept {
469 if (&other == this) return *this;
470 decrement_ref_count(m_key);
471 m_key = other.m_key;
472 other.m_key = nullptr;
473 return *this;
474 }
475 evp_pkey_handle& operator=(EVP_PKEY* key) {
476 decrement_ref_count(m_key);
477 m_key = key;
478 increment_ref_count(m_key);
479 return *this;
480 }
481 ~evp_pkey_handle() noexcept { decrement_ref_count(m_key); }
482
483 EVP_PKEY* get() const noexcept { return m_key; }
484 bool operator!() const noexcept { return m_key == nullptr; }
485 explicit operator bool() const noexcept { return m_key != nullptr; }
486
487 private:
488 EVP_PKEY* m_key{nullptr};
489
490 static void increment_ref_count(EVP_PKEY* key) {
491 if (key != nullptr && EVP_PKEY_up_ref(key) != 1) throw std::runtime_error("EVP_PKEY_up_ref failed");
492 }
493 static void decrement_ref_count(EVP_PKEY* key) noexcept {
494 if (key != nullptr) EVP_PKEY_free(key);
495 }
496#endif
497 };
498
499 inline std::unique_ptr<BIO, decltype(&BIO_free_all)> make_mem_buf_bio() {
500 return std::unique_ptr<BIO, decltype(&BIO_free_all)>(BIO_new(BIO_s_mem()), BIO_free_all);
501 }
502
503 inline std::unique_ptr<BIO, decltype(&BIO_free_all)> make_mem_buf_bio(const std::string& data) {
504 return std::unique_ptr<BIO, decltype(&BIO_free_all)>(
505#if OPENSSL_VERSION_NUMBER <= 0x10100003L
506 BIO_new_mem_buf(const_cast<char*>(data.data()), static_cast<int>(data.size())), BIO_free_all
507#else
508 BIO_new_mem_buf(data.data(), static_cast<int>(data.size())), BIO_free_all
509#endif
510 );
511 }
512
513 template<typename error_category = error::rsa_error>
514 std::string write_bio_to_string(std::unique_ptr<BIO, decltype(&BIO_free_all)>& bio_out, std::error_code& ec) {
515 char* ptr = nullptr;
516 auto len = BIO_get_mem_data(bio_out.get(), &ptr);
517 if (len <= 0 || ptr == nullptr) {
518 ec = error_category::convert_to_pem_failed;
519 return {};
520 }
521 return {ptr, static_cast<size_t>(len)};
522 }
523
524 inline std::unique_ptr<EVP_MD_CTX, void (*)(EVP_MD_CTX*)> make_evp_md_ctx() {
525 return
526#ifdef JWT_OPENSSL_1_0_0
527 std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_destroy)>(EVP_MD_CTX_create(), &EVP_MD_CTX_destroy);
528#else
529 std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(EVP_MD_CTX_new(), &EVP_MD_CTX_free);
530#endif
531 }
532
541 template<typename error_category = error::rsa_error>
542 std::string extract_pubkey_from_cert(const std::string& certstr, const std::string& pw, std::error_code& ec) {
543 ec.clear();
544 auto certbio = make_mem_buf_bio(certstr);
545 auto keybio = make_mem_buf_bio();
546 if (!certbio || !keybio) {
547 ec = error_category::create_mem_bio_failed;
548 return {};
549 }
550
551 std::unique_ptr<X509, decltype(&X509_free)> cert(
552 PEM_read_bio_X509(certbio.get(), nullptr, nullptr, const_cast<char*>(pw.c_str())), X509_free);
553 if (!cert) {
554 ec = error_category::cert_load_failed;
555 return {};
556 }
557 std::unique_ptr<EVP_PKEY, decltype(&EVP_PKEY_free)> key(X509_get_pubkey(cert.get()), EVP_PKEY_free);
558 if (!key) {
559 ec = error_category::get_key_failed;
560 return {};
561 }
562 if (PEM_write_bio_PUBKEY(keybio.get(), key.get()) == 0) {
563 ec = error_category::write_key_failed;
564 return {};
565 }
566
567 return write_bio_to_string<error_category>(keybio, ec);
568 }
569
578 template<typename error_category = error::rsa_error>
579 std::string extract_pubkey_from_cert(const std::string& certstr, const std::string& pw = "") {
580 std::error_code ec;
581 auto res = extract_pubkey_from_cert<error_category>(certstr, pw, ec);
582 error::throw_if_error(ec);
583 return res;
584 }
585
592 inline std::string convert_der_to_pem(const std::string& cert_der_str, std::error_code& ec) {
593 ec.clear();
594
595 auto c_str = reinterpret_cast<const unsigned char*>(cert_der_str.c_str());
596
597 std::unique_ptr<X509, decltype(&X509_free)> cert(
598 d2i_X509(NULL, &c_str, static_cast<int>(cert_der_str.size())), X509_free);
599 auto certbio = make_mem_buf_bio();
600 if (!cert || !certbio) {
601 ec = error::rsa_error::create_mem_bio_failed;
602 return {};
603 }
604
605 if (!PEM_write_bio_X509(certbio.get(), cert.get())) {
606 ec = error::rsa_error::write_cert_failed;
607 return {};
608 }
609
610 return write_bio_to_string(certbio, ec);
611 }
612
627 template<typename Decode>
628 std::string convert_base64_der_to_pem(const std::string& cert_base64_der_str, Decode decode,
629 std::error_code& ec) {
630 ec.clear();
631 const auto decoded_str = decode(cert_base64_der_str);
632 return convert_der_to_pem(decoded_str, ec);
633 }
634
649 template<typename Decode>
650 std::string convert_base64_der_to_pem(const std::string& cert_base64_der_str, Decode decode) {
651 std::error_code ec;
652 auto res = convert_base64_der_to_pem(cert_base64_der_str, std::move(decode), ec);
653 error::throw_if_error(ec);
654 return res;
655 }
656
663 inline std::string convert_der_to_pem(const std::string& cert_der_str) {
664 std::error_code ec;
665 auto res = convert_der_to_pem(cert_der_str, ec);
666 error::throw_if_error(ec);
667 return res;
668 }
669
670#ifndef JWT_DISABLE_BASE64
680 inline std::string convert_base64_der_to_pem(const std::string& cert_base64_der_str, std::error_code& ec) {
681 auto decode = [](const std::string& token) {
682 return base::decode<alphabet::base64>(base::pad<alphabet::base64>(token));
683 };
684 return convert_base64_der_to_pem(cert_base64_der_str, std::move(decode), ec);
685 }
686
696 inline std::string convert_base64_der_to_pem(const std::string& cert_base64_der_str) {
697 std::error_code ec;
698 auto res = convert_base64_der_to_pem(cert_base64_der_str, ec);
699 error::throw_if_error(ec);
700 return res;
701 }
702#endif
713 template<typename error_category = error::rsa_error>
714 evp_pkey_handle load_public_key_from_string(const std::string& key, const std::string& password,
715 std::error_code& ec) {
716 ec.clear();
717 auto pubkey_bio = make_mem_buf_bio();
718 if (!pubkey_bio) {
719 ec = error_category::create_mem_bio_failed;
720 return {};
721 }
722 if (key.substr(0, 27) == "-----BEGIN CERTIFICATE-----") {
723 auto epkey = helper::extract_pubkey_from_cert<error_category>(key, password, ec);
724 if (ec) return {};
725 const int len = static_cast<int>(epkey.size());
726 if (BIO_write(pubkey_bio.get(), epkey.data(), len) != len) {
727 ec = error_category::load_key_bio_write;
728 return {};
729 }
730 } else {
731 const int len = static_cast<int>(key.size());
732 if (BIO_write(pubkey_bio.get(), key.data(), len) != len) {
733 ec = error_category::load_key_bio_write;
734 return {};
735 }
736 }
737
738 evp_pkey_handle pkey(PEM_read_bio_PUBKEY(
739 pubkey_bio.get(), nullptr, nullptr,
740 (void*)password.data())); // NOLINT(google-readability-casting) requires `const_cast`
741 if (!pkey) ec = error_category::load_key_bio_read;
742 return pkey;
743 }
744
755 template<typename error_category = error::rsa_error>
756 inline evp_pkey_handle load_public_key_from_string(const std::string& key, const std::string& password = "") {
757 std::error_code ec;
758 auto res = load_public_key_from_string<error_category>(key, password, ec);
759 error::throw_if_error(ec);
760 return res;
761 }
762
771 template<typename error_category = error::rsa_error>
772 inline evp_pkey_handle load_private_key_from_string(const std::string& key, const std::string& password,
773 std::error_code& ec) {
774 ec.clear();
775 auto private_key_bio = make_mem_buf_bio();
776 if (!private_key_bio) {
777 ec = error_category::create_mem_bio_failed;
778 return {};
779 }
780 const int len = static_cast<int>(key.size());
781 if (BIO_write(private_key_bio.get(), key.data(), len) != len) {
782 ec = error_category::load_key_bio_write;
783 return {};
784 }
785 evp_pkey_handle pkey(
786 PEM_read_bio_PrivateKey(private_key_bio.get(), nullptr, nullptr, const_cast<char*>(password.c_str())));
787 if (!pkey) ec = error_category::load_key_bio_read;
788 return pkey;
789 }
790
799 template<typename error_category = error::rsa_error>
800 inline evp_pkey_handle load_private_key_from_string(const std::string& key, const std::string& password = "") {
801 std::error_code ec;
802 auto res = load_private_key_from_string<error_category>(key, password, ec);
803 error::throw_if_error(ec);
804 return res;
805 }
806
818 inline evp_pkey_handle load_public_ec_key_from_string(const std::string& key, const std::string& password,
819 std::error_code& ec) {
820 return load_public_key_from_string<error::ecdsa_error>(key, password, ec);
821 }
822
828 inline
829#ifdef JWT_OPENSSL_1_0_0
830 std::string
831 bn2raw(BIGNUM* bn)
832#else
833 std::string
834 bn2raw(const BIGNUM* bn)
835#endif
836 {
837 std::string res(BN_num_bytes(bn), '\0');
838 BN_bn2bin(bn, (unsigned char*)res.data()); // NOLINT(google-readability-casting) requires `const_cast`
839 return res;
840 }
847 inline std::unique_ptr<BIGNUM, decltype(&BN_free)> raw2bn(const std::string& raw, std::error_code& ec) {
848 auto bn =
849 BN_bin2bn(reinterpret_cast<const unsigned char*>(raw.data()), static_cast<int>(raw.size()), nullptr);
850 // https://www.openssl.org/docs/man1.1.1/man3/BN_bin2bn.html#RETURN-VALUES
851 if (!bn) {
852 ec = error::rsa_error::set_rsa_failed;
853 return {nullptr, BN_free};
854 }
855 return {bn, BN_free};
856 }
862 inline std::unique_ptr<BIGNUM, decltype(&BN_free)> raw2bn(const std::string& raw) {
863 std::error_code ec;
864 auto res = raw2bn(raw, ec);
865 error::throw_if_error(ec);
866 return res;
867 }
868
880 inline evp_pkey_handle load_public_ec_key_from_string(const std::string& key,
881 const std::string& password = "") {
882 std::error_code ec;
883 auto res = load_public_key_from_string<error::ecdsa_error>(key, password, ec);
884 error::throw_if_error(ec);
885 return res;
886 }
887
897 inline evp_pkey_handle load_private_ec_key_from_string(const std::string& key, const std::string& password,
898 std::error_code& ec) {
899 return load_private_key_from_string<error::ecdsa_error>(key, password, ec);
900 }
901
916 template<typename Decode>
917 std::string create_public_key_from_rsa_components(const std::string& modulus, const std::string& exponent,
918 Decode decode, std::error_code& ec) {
919 ec.clear();
920 auto decoded_modulus = decode(modulus);
921 auto decoded_exponent = decode(exponent);
922
923 auto n = helper::raw2bn(decoded_modulus, ec);
924 if (ec) return {};
925 auto e = helper::raw2bn(decoded_exponent, ec);
926 if (ec) return {};
927
928#if defined(JWT_OPENSSL_3_0)
929 // OpenSSL deprecated mutable keys and there is a new way for making them
930 // https://mta.openssl.org/pipermail/openssl-users/2021-July/013994.html
931 // https://www.openssl.org/docs/man3.1/man3/OSSL_PARAM_BLD_new.html#Example-2
932 std::unique_ptr<OSSL_PARAM_BLD, decltype(&OSSL_PARAM_BLD_free)> param_bld(OSSL_PARAM_BLD_new(),
933 OSSL_PARAM_BLD_free);
934 if (!param_bld) {
935 ec = error::rsa_error::create_context_failed;
936 return {};
937 }
938
939 if (OSSL_PARAM_BLD_push_BN(param_bld.get(), "n", n.get()) != 1 ||
940 OSSL_PARAM_BLD_push_BN(param_bld.get(), "e", e.get()) != 1) {
941 ec = error::rsa_error::set_rsa_failed;
942 return {};
943 }
944
945 std::unique_ptr<OSSL_PARAM, decltype(&OSSL_PARAM_free)> params(OSSL_PARAM_BLD_to_param(param_bld.get()),
946 OSSL_PARAM_free);
947 if (!params) {
948 ec = error::rsa_error::set_rsa_failed;
949 return {};
950 }
951
952 std::unique_ptr<EVP_PKEY_CTX, decltype(&EVP_PKEY_CTX_free)> ctx(
953 EVP_PKEY_CTX_new_from_name(nullptr, "RSA", nullptr), EVP_PKEY_CTX_free);
954 if (!ctx) {
955 ec = error::rsa_error::create_context_failed;
956 return {};
957 }
958
959 // https://www.openssl.org/docs/man3.0/man3/EVP_PKEY_fromdata.html#EXAMPLES
960 // Error codes based on https://www.openssl.org/docs/manmaster/man3/EVP_PKEY_fromdata_init.html#RETURN-VALUES
961 EVP_PKEY* pkey = NULL;
962 if (EVP_PKEY_fromdata_init(ctx.get()) <= 0 ||
963 EVP_PKEY_fromdata(ctx.get(), &pkey, EVP_PKEY_KEYPAIR, params.get()) <= 0) {
964 // It's unclear if this can fail after allocating but free it anyways
965 // https://www.openssl.org/docs/man3.0/man3/EVP_PKEY_fromdata.html
966 EVP_PKEY_free(pkey);
967
968 ec = error::rsa_error::cert_load_failed;
969 return {};
970 }
971
972 // Transfer ownership so we get ref counter and cleanup
973 evp_pkey_handle rsa(pkey);
974
975#else
976 std::unique_ptr<RSA, decltype(&RSA_free)> rsa(RSA_new(), RSA_free);
977
978#if defined(JWT_OPENSSL_1_1_1) || defined(JWT_OPENSSL_1_1_0)
979 // After this RSA_free will also free the n and e big numbers
980 // See https://github.com/Thalhammer/jwt-cpp/pull/298#discussion_r1282619186
981 if (RSA_set0_key(rsa.get(), n.get(), e.get(), nullptr) == 1) {
982 // This can only fail we passed in NULL for `n` or `e`
983 // https://github.com/openssl/openssl/blob/d6e4056805f54bb1a0ef41fa3a6a35b70c94edba/crypto/rsa/rsa_lib.c#L396
984 // So to make sure there is no memory leak, we hold the references
985 n.release();
986 e.release();
987 } else {
988 ec = error::rsa_error::set_rsa_failed;
989 return {};
990 }
991#elif defined(JWT_OPENSSL_1_0_0)
992 rsa->e = e.release();
993 rsa->n = n.release();
994 rsa->d = nullptr;
995#endif
996#endif
997
998 auto pub_key_bio = make_mem_buf_bio();
999 if (!pub_key_bio) {
1000 ec = error::rsa_error::create_mem_bio_failed;
1001 return {};
1002 }
1003
1004 auto write_pem_to_bio =
1005#if defined(JWT_OPENSSL_3_0)
1006 // https://www.openssl.org/docs/man3.1/man3/PEM_write_bio_RSA_PUBKEY.html
1007 &PEM_write_bio_PUBKEY;
1008#else
1009 &PEM_write_bio_RSA_PUBKEY;
1010#endif
1011 if (write_pem_to_bio(pub_key_bio.get(), rsa.get()) != 1) {
1012 ec = error::rsa_error::load_key_bio_write;
1013 return {};
1014 }
1015
1016 return write_bio_to_string<error::rsa_error>(pub_key_bio, ec);
1017 }
1018
1032 template<typename Decode>
1033 std::string create_public_key_from_rsa_components(const std::string& modulus, const std::string& exponent,
1034 Decode decode) {
1035 std::error_code ec;
1036 auto res = create_public_key_from_rsa_components(modulus, exponent, decode, ec);
1037 error::throw_if_error(ec);
1038 return res;
1039 }
1040
1041#ifndef JWT_DISABLE_BASE64
1052 inline std::string create_public_key_from_rsa_components(const std::string& modulus,
1053 const std::string& exponent, std::error_code& ec) {
1054 auto decode = [](const std::string& token) {
1055 return base::decode<alphabet::base64url>(base::pad<alphabet::base64url>(token));
1056 };
1057 return create_public_key_from_rsa_components(modulus, exponent, std::move(decode), ec);
1058 }
1068 inline std::string create_public_key_from_rsa_components(const std::string& modulus,
1069 const std::string& exponent) {
1070 std::error_code ec;
1071 auto res = create_public_key_from_rsa_components(modulus, exponent, ec);
1072 error::throw_if_error(ec);
1073 return res;
1074 }
1075#endif
1085 inline evp_pkey_handle load_private_ec_key_from_string(const std::string& key,
1086 const std::string& password = "") {
1087 std::error_code ec;
1088 auto res = load_private_key_from_string<error::ecdsa_error>(key, password, ec);
1089 error::throw_if_error(ec);
1090 return res;
1091 }
1092
1093#if defined(JWT_OPENSSL_3_0)
1094
1102 inline std::string curve2group(const std::string curve, std::error_code& ec) {
1103 if (curve == "P-256") {
1104 return "prime256v1";
1105 } else if (curve == "P-384") {
1106 return "secp384r1";
1107 } else if (curve == "P-521") {
1108 return "secp521r1";
1109 } else {
1110 ec = jwt::error::ecdsa_error::unknown_curve;
1111 return {};
1112 }
1113 }
1114
1115#else
1116
1124 inline int curve2nid(const std::string curve, std::error_code& ec) {
1125 if (curve == "P-256") {
1126 return NID_X9_62_prime256v1;
1127 } else if (curve == "P-384") {
1128 return NID_secp384r1;
1129 } else if (curve == "P-521") {
1130 return NID_secp521r1;
1131 } else {
1132 ec = jwt::error::ecdsa_error::unknown_curve;
1133 return {};
1134 }
1135 }
1136
1137#endif
1138
1154 template<typename Decode>
1155 std::string create_public_key_from_ec_components(const std::string& curve, const std::string& x,
1156 const std::string& y, Decode decode, std::error_code& ec) {
1157 ec.clear();
1158 auto decoded_x = decode(x);
1159 auto decoded_y = decode(y);
1160
1161#if defined(JWT_OPENSSL_3_0)
1162 // OpenSSL deprecated mutable keys and there is a new way for making them
1163 // https://mta.openssl.org/pipermail/openssl-users/2021-July/013994.html
1164 // https://www.openssl.org/docs/man3.1/man3/OSSL_PARAM_BLD_new.html#Example-2
1165 std::unique_ptr<OSSL_PARAM_BLD, decltype(&OSSL_PARAM_BLD_free)> param_bld(OSSL_PARAM_BLD_new(),
1166 OSSL_PARAM_BLD_free);
1167 if (!param_bld) {
1168 ec = error::ecdsa_error::create_context_failed;
1169 return {};
1170 }
1171
1172 std::string group = helper::curve2group(curve, ec);
1173 if (ec) return {};
1174
1175 // https://github.com/openssl/openssl/issues/16270#issuecomment-895734092
1176 std::string pub = std::string("\x04").append(decoded_x).append(decoded_y);
1177
1178 if (OSSL_PARAM_BLD_push_utf8_string(param_bld.get(), "group", group.data(), group.size()) != 1 ||
1179 OSSL_PARAM_BLD_push_octet_string(param_bld.get(), "pub", pub.data(), pub.size()) != 1) {
1180 ec = error::ecdsa_error::set_ecdsa_failed;
1181 return {};
1182 }
1183
1184 std::unique_ptr<OSSL_PARAM, decltype(&OSSL_PARAM_free)> params(OSSL_PARAM_BLD_to_param(param_bld.get()),
1185 OSSL_PARAM_free);
1186 if (!params) {
1187 ec = error::ecdsa_error::set_ecdsa_failed;
1188 return {};
1189 }
1190
1191 std::unique_ptr<EVP_PKEY_CTX, decltype(&EVP_PKEY_CTX_free)> ctx(
1192 EVP_PKEY_CTX_new_from_name(nullptr, "EC", nullptr), EVP_PKEY_CTX_free);
1193 if (!ctx) {
1194 ec = error::ecdsa_error::create_context_failed;
1195 return {};
1196 }
1197
1198 // https://www.openssl.org/docs/man3.0/man3/EVP_PKEY_fromdata.html#EXAMPLES
1199 // Error codes based on https://www.openssl.org/docs/manmaster/man3/EVP_PKEY_fromdata_init.html#RETURN-VALUES
1200 EVP_PKEY* pkey = NULL;
1201 if (EVP_PKEY_fromdata_init(ctx.get()) <= 0 ||
1202 EVP_PKEY_fromdata(ctx.get(), &pkey, EVP_PKEY_KEYPAIR, params.get()) <= 0) {
1203 // It's unclear if this can fail after allocating but free it anyways
1204 // https://www.openssl.org/docs/man3.0/man3/EVP_PKEY_fromdata.html
1205 EVP_PKEY_free(pkey);
1206
1207 ec = error::ecdsa_error::cert_load_failed;
1208 return {};
1209 }
1210
1211 // Transfer ownership so we get ref counter and cleanup
1212 evp_pkey_handle ecdsa(pkey);
1213
1214#else
1215 int nid = helper::curve2nid(curve, ec);
1216 if (ec) return {};
1217
1218 auto qx = helper::raw2bn(decoded_x, ec);
1219 if (ec) return {};
1220 auto qy = helper::raw2bn(decoded_y, ec);
1221 if (ec) return {};
1222
1223 std::unique_ptr<EC_GROUP, decltype(&EC_GROUP_free)> ecgroup(EC_GROUP_new_by_curve_name(nid), EC_GROUP_free);
1224 if (!ecgroup) {
1225 ec = error::ecdsa_error::set_ecdsa_failed;
1226 return {};
1227 }
1228
1229 EC_GROUP_set_asn1_flag(ecgroup.get(), OPENSSL_EC_NAMED_CURVE);
1230
1231 std::unique_ptr<EC_POINT, decltype(&EC_POINT_free)> ecpoint(EC_POINT_new(ecgroup.get()), EC_POINT_free);
1232 if (!ecpoint ||
1233 EC_POINT_set_affine_coordinates_GFp(ecgroup.get(), ecpoint.get(), qx.get(), qy.get(), nullptr) != 1) {
1234 ec = error::ecdsa_error::set_ecdsa_failed;
1235 return {};
1236 }
1237
1238 std::unique_ptr<EC_KEY, decltype(&EC_KEY_free)> ecdsa(EC_KEY_new(), EC_KEY_free);
1239 if (!ecdsa || EC_KEY_set_group(ecdsa.get(), ecgroup.get()) != 1 ||
1240 EC_KEY_set_public_key(ecdsa.get(), ecpoint.get()) != 1) {
1241 ec = error::ecdsa_error::set_ecdsa_failed;
1242 return {};
1243 }
1244
1245#endif
1246
1247 auto pub_key_bio = make_mem_buf_bio();
1248 if (!pub_key_bio) {
1249 ec = error::ecdsa_error::create_mem_bio_failed;
1250 return {};
1251 }
1252
1253 auto write_pem_to_bio =
1254#if defined(JWT_OPENSSL_3_0)
1255 // https://www.openssl.org/docs/man3.1/man3/PEM_write_bio_EC_PUBKEY.html
1256 &PEM_write_bio_PUBKEY;
1257#else
1258 &PEM_write_bio_EC_PUBKEY;
1259#endif
1260 if (write_pem_to_bio(pub_key_bio.get(), ecdsa.get()) != 1) {
1261 ec = error::ecdsa_error::load_key_bio_write;
1262 return {};
1263 }
1264
1265 return write_bio_to_string<error::ecdsa_error>(pub_key_bio, ec);
1266 }
1267
1282 template<typename Decode>
1283 std::string create_public_key_from_ec_components(const std::string& curve, const std::string& x,
1284 const std::string& y, Decode decode) {
1285 std::error_code ec;
1286 auto res = create_public_key_from_ec_components(curve, x, y, decode, ec);
1287 error::throw_if_error(ec);
1288 return res;
1289 }
1290
1291#ifndef JWT_DISABLE_BASE64
1303 inline std::string create_public_key_from_ec_components(const std::string& curve, const std::string& x,
1304 const std::string& y, std::error_code& ec) {
1305 auto decode = [](const std::string& token) {
1306 return base::decode<alphabet::base64url>(base::pad<alphabet::base64url>(token));
1307 };
1308 return create_public_key_from_ec_components(curve, x, y, std::move(decode), ec);
1309 }
1320 inline std::string create_public_key_from_ec_components(const std::string& curve, const std::string& x,
1321 const std::string& y) {
1322 std::error_code ec;
1323 auto res = create_public_key_from_ec_components(curve, x, y, ec);
1324 error::throw_if_error(ec);
1325 return res;
1326 }
1327#endif
1328 } // namespace helper
1329
1339 namespace algorithm {
1347 struct none {
1351 std::string sign(const std::string& /*unused*/, std::error_code& ec) const {
1352 ec.clear();
1353 return {};
1354 }
1362 void verify(const std::string& /*unused*/, const std::string& signature, std::error_code& ec) const {
1363 ec.clear();
1364 if (!signature.empty()) { ec = error::signature_verification_error::invalid_signature; }
1365 }
1367 std::string name() const { return "none"; }
1368 };
1372 struct hmacsha {
1380 hmacsha(std::string key, const EVP_MD* (*md)(), std::string name)
1381 : secret(std::move(key)), md(md), alg_name(std::move(name)) {}
1389 std::string sign(const std::string& data, std::error_code& ec) const {
1390 ec.clear();
1391 std::string res(static_cast<size_t>(EVP_MAX_MD_SIZE), '\0');
1392 auto len = static_cast<unsigned int>(res.size());
1393 if (HMAC(md(), secret.data(), static_cast<int>(secret.size()),
1394 reinterpret_cast<const unsigned char*>(data.data()), static_cast<int>(data.size()),
1395 (unsigned char*)res.data(), // NOLINT(google-readability-casting) requires `const_cast`
1396 &len) == nullptr) {
1397 ec = error::signature_generation_error::hmac_failed;
1398 return {};
1399 }
1400 res.resize(len);
1401 return res;
1402 }
1410 void verify(const std::string& data, const std::string& signature, std::error_code& ec) const {
1411 ec.clear();
1412 auto res = sign(data, ec);
1413 if (ec) return;
1414
1415 bool matched = true;
1416 for (size_t i = 0; i < std::min<size_t>(res.size(), signature.size()); i++)
1417 if (res[i] != signature[i]) matched = false;
1418 if (res.size() != signature.size()) matched = false;
1419 if (!matched) {
1420 ec = error::signature_verification_error::invalid_signature;
1421 return;
1422 }
1423 }
1429 std::string name() const { return alg_name; }
1430
1431 private:
1433 const std::string secret;
1435 const EVP_MD* (*md)();
1437 const std::string alg_name;
1438 };
1442 struct rsa {
1453 rsa(const std::string& public_key, const std::string& private_key, const std::string& public_key_password,
1454 const std::string& private_key_password, const EVP_MD* (*md)(), std::string name)
1455 : md(md), alg_name(std::move(name)) {
1456 if (!private_key.empty()) {
1457 pkey = helper::load_private_key_from_string(private_key, private_key_password);
1458 } else if (!public_key.empty()) {
1459 pkey = helper::load_public_key_from_string(public_key, public_key_password);
1460 } else
1461 throw error::rsa_exception(error::rsa_error::no_key_provided);
1462 }
1469 std::string sign(const std::string& data, std::error_code& ec) const {
1470 ec.clear();
1471 auto ctx = helper::make_evp_md_ctx();
1472 if (!ctx) {
1473 ec = error::signature_generation_error::create_context_failed;
1474 return {};
1475 }
1476 if (!EVP_SignInit(ctx.get(), md())) {
1477 ec = error::signature_generation_error::signinit_failed;
1478 return {};
1479 }
1480
1481 std::string res(EVP_PKEY_size(pkey.get()), '\0');
1482 unsigned int len = 0;
1483
1484 if (!EVP_SignUpdate(ctx.get(), data.data(), data.size())) {
1485 ec = error::signature_generation_error::signupdate_failed;
1486 return {};
1487 }
1488 if (EVP_SignFinal(ctx.get(), (unsigned char*)res.data(), &len, pkey.get()) == 0) {
1489 ec = error::signature_generation_error::signfinal_failed;
1490 return {};
1491 }
1492
1493 res.resize(len);
1494 return res;
1495 }
1503 void verify(const std::string& data, const std::string& signature, std::error_code& ec) const {
1504 ec.clear();
1505 auto ctx = helper::make_evp_md_ctx();
1506 if (!ctx) {
1507 ec = error::signature_verification_error::create_context_failed;
1508 return;
1509 }
1510 if (!EVP_VerifyInit(ctx.get(), md())) {
1511 ec = error::signature_verification_error::verifyinit_failed;
1512 return;
1513 }
1514 if (!EVP_VerifyUpdate(ctx.get(), data.data(), data.size())) {
1515 ec = error::signature_verification_error::verifyupdate_failed;
1516 return;
1517 }
1518 auto res = EVP_VerifyFinal(ctx.get(), reinterpret_cast<const unsigned char*>(signature.data()),
1519 static_cast<unsigned int>(signature.size()), pkey.get());
1520 if (res != 1) {
1521 ec = error::signature_verification_error::verifyfinal_failed;
1522 return;
1523 }
1524 }
1529 std::string name() const { return alg_name; }
1530
1531 private:
1533 helper::evp_pkey_handle pkey;
1535 const EVP_MD* (*md)();
1537 const std::string alg_name;
1538 };
1542 struct ecdsa {
1554 ecdsa(const std::string& public_key, const std::string& private_key, const std::string& public_key_password,
1555 const std::string& private_key_password, const EVP_MD* (*md)(), std::string name, size_t siglen)
1556 : md(md), alg_name(std::move(name)), signature_length(siglen) {
1557 if (!private_key.empty()) {
1558 pkey = helper::load_private_ec_key_from_string(private_key, private_key_password);
1559 check_private_key(pkey.get());
1560 } else if (!public_key.empty()) {
1561 pkey = helper::load_public_ec_key_from_string(public_key, public_key_password);
1562 check_public_key(pkey.get());
1563 } else {
1564 throw error::ecdsa_exception(error::ecdsa_error::no_key_provided);
1565 }
1566 if (!pkey) throw error::ecdsa_exception(error::ecdsa_error::invalid_key);
1567
1568 size_t keysize = EVP_PKEY_bits(pkey.get());
1569 if (keysize != signature_length * 4 && (signature_length != 132 || keysize != 521))
1570 throw error::ecdsa_exception(error::ecdsa_error::invalid_key_size);
1571 }
1572
1579 std::string sign(const std::string& data, std::error_code& ec) const {
1580 ec.clear();
1581 auto ctx = helper::make_evp_md_ctx();
1582 if (!ctx) {
1583 ec = error::signature_generation_error::create_context_failed;
1584 return {};
1585 }
1586 if (!EVP_DigestSignInit(ctx.get(), nullptr, md(), nullptr, pkey.get())) {
1587 ec = error::signature_generation_error::signinit_failed;
1588 return {};
1589 }
1590 if (!EVP_DigestUpdate(ctx.get(), data.data(), data.size())) {
1591 ec = error::signature_generation_error::digestupdate_failed;
1592 return {};
1593 }
1594
1595 size_t len = 0;
1596 if (!EVP_DigestSignFinal(ctx.get(), nullptr, &len)) {
1597 ec = error::signature_generation_error::signfinal_failed;
1598 return {};
1599 }
1600 std::string res(len, '\0');
1601 if (!EVP_DigestSignFinal(ctx.get(), (unsigned char*)res.data(), &len)) {
1602 ec = error::signature_generation_error::signfinal_failed;
1603 return {};
1604 }
1605
1606 res.resize(len);
1607 return der_to_p1363_signature(res, ec);
1608 }
1609
1616 void verify(const std::string& data, const std::string& signature, std::error_code& ec) const {
1617 ec.clear();
1618 std::string der_signature = p1363_to_der_signature(signature, ec);
1619 if (ec) { return; }
1620
1621 auto ctx = helper::make_evp_md_ctx();
1622 if (!ctx) {
1623 ec = error::signature_verification_error::create_context_failed;
1624 return;
1625 }
1626 if (!EVP_DigestVerifyInit(ctx.get(), nullptr, md(), nullptr, pkey.get())) {
1627 ec = error::signature_verification_error::verifyinit_failed;
1628 return;
1629 }
1630 if (!EVP_DigestUpdate(ctx.get(), data.data(), data.size())) {
1631 ec = error::signature_verification_error::verifyupdate_failed;
1632 return;
1633 }
1634
1635#if OPENSSL_VERSION_NUMBER < 0x10002000L
1636 unsigned char* der_sig_data = reinterpret_cast<unsigned char*>(const_cast<char*>(der_signature.data()));
1637#else
1638 const unsigned char* der_sig_data = reinterpret_cast<const unsigned char*>(der_signature.data());
1639#endif
1640 auto res =
1641 EVP_DigestVerifyFinal(ctx.get(), der_sig_data, static_cast<unsigned int>(der_signature.length()));
1642 if (res == 0) {
1643 ec = error::signature_verification_error::invalid_signature;
1644 return;
1645 }
1646 if (res == -1) {
1647 ec = error::signature_verification_error::verifyfinal_failed;
1648 return;
1649 }
1650 }
1655 std::string name() const { return alg_name; }
1656
1657 private:
1658 static void check_public_key(EVP_PKEY* pkey) {
1659#ifdef JWT_OPENSSL_3_0
1660 std::unique_ptr<EVP_PKEY_CTX, decltype(&EVP_PKEY_CTX_free)> ctx(
1661 EVP_PKEY_CTX_new_from_pkey(nullptr, pkey, nullptr), EVP_PKEY_CTX_free);
1662 if (!ctx) { throw error::ecdsa_exception(error::ecdsa_error::create_context_failed); }
1663 if (EVP_PKEY_public_check(ctx.get()) != 1) {
1664 throw error::ecdsa_exception(error::ecdsa_error::invalid_key);
1665 }
1666#else
1667 std::unique_ptr<EC_KEY, decltype(&EC_KEY_free)> eckey(EVP_PKEY_get1_EC_KEY(pkey), EC_KEY_free);
1668 if (!eckey) { throw error::ecdsa_exception(error::ecdsa_error::invalid_key); }
1669 if (EC_KEY_check_key(eckey.get()) == 0) throw error::ecdsa_exception(error::ecdsa_error::invalid_key);
1670#endif
1671 }
1672
1673 static void check_private_key(EVP_PKEY* pkey) {
1674#ifdef JWT_OPENSSL_3_0
1675 std::unique_ptr<EVP_PKEY_CTX, decltype(&EVP_PKEY_CTX_free)> ctx(
1676 EVP_PKEY_CTX_new_from_pkey(nullptr, pkey, nullptr), EVP_PKEY_CTX_free);
1677 if (!ctx) { throw error::ecdsa_exception(error::ecdsa_error::create_context_failed); }
1678 if (EVP_PKEY_private_check(ctx.get()) != 1) {
1679 throw error::ecdsa_exception(error::ecdsa_error::invalid_key);
1680 }
1681#else
1682 std::unique_ptr<EC_KEY, decltype(&EC_KEY_free)> eckey(EVP_PKEY_get1_EC_KEY(pkey), EC_KEY_free);
1683 if (!eckey) { throw error::ecdsa_exception(error::ecdsa_error::invalid_key); }
1684 if (EC_KEY_check_key(eckey.get()) == 0) throw error::ecdsa_exception(error::ecdsa_error::invalid_key);
1685#endif
1686 }
1687
1688 std::string der_to_p1363_signature(const std::string& der_signature, std::error_code& ec) const {
1689 const unsigned char* possl_signature = reinterpret_cast<const unsigned char*>(der_signature.data());
1690 std::unique_ptr<ECDSA_SIG, decltype(&ECDSA_SIG_free)> sig(
1691 d2i_ECDSA_SIG(nullptr, &possl_signature, static_cast<long>(der_signature.length())),
1692 ECDSA_SIG_free);
1693 if (!sig) {
1694 ec = error::signature_generation_error::signature_decoding_failed;
1695 return {};
1696 }
1697
1698#ifdef JWT_OPENSSL_1_0_0
1699 auto rr = helper::bn2raw(sig->r);
1700 auto rs = helper::bn2raw(sig->s);
1701#else
1702 const BIGNUM* r;
1703 const BIGNUM* s;
1704 ECDSA_SIG_get0(sig.get(), &r, &s);
1705 auto rr = helper::bn2raw(r);
1706 auto rs = helper::bn2raw(s);
1707#endif
1708 if (rr.size() > signature_length / 2 || rs.size() > signature_length / 2)
1709 throw std::logic_error("bignum size exceeded expected length");
1710 rr.insert(0, signature_length / 2 - rr.size(), '\0');
1711 rs.insert(0, signature_length / 2 - rs.size(), '\0');
1712 return rr + rs;
1713 }
1714
1715 std::string p1363_to_der_signature(const std::string& signature, std::error_code& ec) const {
1716 ec.clear();
1717 auto r = helper::raw2bn(signature.substr(0, signature.size() / 2), ec);
1718 if (ec) return {};
1719 auto s = helper::raw2bn(signature.substr(signature.size() / 2), ec);
1720 if (ec) return {};
1721
1722 ECDSA_SIG* psig;
1723#ifdef JWT_OPENSSL_1_0_0
1724 ECDSA_SIG sig;
1725 sig.r = r.get();
1726 sig.s = s.get();
1727 psig = &sig;
1728#else
1729 std::unique_ptr<ECDSA_SIG, decltype(&ECDSA_SIG_free)> sig(ECDSA_SIG_new(), ECDSA_SIG_free);
1730 if (!sig) {
1731 ec = error::signature_verification_error::create_context_failed;
1732 return {};
1733 }
1734 ECDSA_SIG_set0(sig.get(), r.release(), s.release());
1735 psig = sig.get();
1736#endif
1737
1738 int length = i2d_ECDSA_SIG(psig, nullptr);
1739 if (length < 0) {
1740 ec = error::signature_verification_error::signature_encoding_failed;
1741 return {};
1742 }
1743 std::string der_signature(length, '\0');
1744 unsigned char* psbuffer = (unsigned char*)der_signature.data();
1745 length = i2d_ECDSA_SIG(psig, &psbuffer);
1746 if (length < 0) {
1747 ec = error::signature_verification_error::signature_encoding_failed;
1748 return {};
1749 }
1750 der_signature.resize(length);
1751 return der_signature;
1752 }
1753
1755 helper::evp_pkey_handle pkey;
1757 const EVP_MD* (*md)();
1759 const std::string alg_name;
1761 const size_t signature_length;
1762 };
1763
1764#if !defined(JWT_OPENSSL_1_0_0) && !defined(JWT_OPENSSL_1_1_0)
1773 struct eddsa {
1784 eddsa(const std::string& public_key, const std::string& private_key, const std::string& public_key_password,
1785 const std::string& private_key_password, std::string name)
1786 : alg_name(std::move(name)) {
1787 if (!private_key.empty()) {
1788 pkey = helper::load_private_key_from_string(private_key, private_key_password);
1789 } else if (!public_key.empty()) {
1790 pkey = helper::load_public_key_from_string(public_key, public_key_password);
1791 } else
1792 throw error::ecdsa_exception(error::ecdsa_error::load_key_bio_read);
1793 }
1800 std::string sign(const std::string& data, std::error_code& ec) const {
1801 ec.clear();
1802 auto ctx = helper::make_evp_md_ctx();
1803 if (!ctx) {
1804 ec = error::signature_generation_error::create_context_failed;
1805 return {};
1806 }
1807 if (!EVP_DigestSignInit(ctx.get(), nullptr, nullptr, nullptr, pkey.get())) {
1808 ec = error::signature_generation_error::signinit_failed;
1809 return {};
1810 }
1811
1812 size_t len = EVP_PKEY_size(pkey.get());
1813 std::string res(len, '\0');
1814
1815// LibreSSL is the special kid in the block, as it does not support EVP_DigestSign.
1816// OpenSSL on the otherhand does not support using EVP_DigestSignUpdate for eddsa, which is why we end up with this
1817// mess.
1818#if defined(LIBRESSL_VERSION_NUMBER) || defined(LIBWOLFSSL_VERSION_HEX)
1819 ERR_clear_error();
1820 if (EVP_DigestSignUpdate(ctx.get(), reinterpret_cast<const unsigned char*>(data.data()), data.size()) !=
1821 1) {
1822 std::cout << ERR_error_string(ERR_get_error(), NULL) << std::endl;
1823 ec = error::signature_generation_error::signupdate_failed;
1824 return {};
1825 }
1826 if (EVP_DigestSignFinal(ctx.get(), reinterpret_cast<unsigned char*>(&res[0]), &len) != 1) {
1827 ec = error::signature_generation_error::signfinal_failed;
1828 return {};
1829 }
1830#else
1831 if (EVP_DigestSign(ctx.get(), reinterpret_cast<unsigned char*>(&res[0]), &len,
1832 reinterpret_cast<const unsigned char*>(data.data()), data.size()) != 1) {
1833 ec = error::signature_generation_error::signfinal_failed;
1834 return {};
1835 }
1836#endif
1837
1838 res.resize(len);
1839 return res;
1840 }
1841
1848 void verify(const std::string& data, const std::string& signature, std::error_code& ec) const {
1849 ec.clear();
1850 auto ctx = helper::make_evp_md_ctx();
1851 if (!ctx) {
1852 ec = error::signature_verification_error::create_context_failed;
1853 return;
1854 }
1855 if (!EVP_DigestVerifyInit(ctx.get(), nullptr, nullptr, nullptr, pkey.get())) {
1856 ec = error::signature_verification_error::verifyinit_failed;
1857 return;
1858 }
1859// LibreSSL is the special kid in the block, as it does not support EVP_DigestVerify.
1860// OpenSSL on the otherhand does not support using EVP_DigestVerifyUpdate for eddsa, which is why we end up with this
1861// mess.
1862#if defined(LIBRESSL_VERSION_NUMBER) || defined(LIBWOLFSSL_VERSION_HEX)
1863 if (EVP_DigestVerifyUpdate(ctx.get(), reinterpret_cast<const unsigned char*>(data.data()),
1864 data.size()) != 1) {
1865 ec = error::signature_verification_error::verifyupdate_failed;
1866 return;
1867 }
1868 if (EVP_DigestVerifyFinal(ctx.get(), reinterpret_cast<const unsigned char*>(signature.data()),
1869 signature.size()) != 1) {
1870 ec = error::signature_verification_error::verifyfinal_failed;
1871 return;
1872 }
1873#else
1874 auto res = EVP_DigestVerify(ctx.get(), reinterpret_cast<const unsigned char*>(signature.data()),
1875 signature.size(), reinterpret_cast<const unsigned char*>(data.data()),
1876 data.size());
1877 if (res != 1) {
1878 ec = error::signature_verification_error::verifyfinal_failed;
1879 return;
1880 }
1881#endif
1882 }
1887 std::string name() const { return alg_name; }
1888
1889 private:
1891 helper::evp_pkey_handle pkey;
1893 const std::string alg_name;
1894 };
1895#endif
1899 struct pss {
1909 pss(const std::string& public_key, const std::string& private_key, const std::string& public_key_password,
1910 const std::string& private_key_password, const EVP_MD* (*md)(), std::string name)
1911 : md(md), alg_name(std::move(name)) {
1912 if (!private_key.empty()) {
1913 pkey = helper::load_private_key_from_string(private_key, private_key_password);
1914 } else if (!public_key.empty()) {
1915 pkey = helper::load_public_key_from_string(public_key, public_key_password);
1916 } else
1917 throw error::rsa_exception(error::rsa_error::no_key_provided);
1918 }
1919
1926 std::string sign(const std::string& data, std::error_code& ec) const {
1927 ec.clear();
1928 auto md_ctx = helper::make_evp_md_ctx();
1929 if (!md_ctx) {
1930 ec = error::signature_generation_error::create_context_failed;
1931 return {};
1932 }
1933 EVP_PKEY_CTX* ctx = nullptr;
1934 if (EVP_DigestSignInit(md_ctx.get(), &ctx, md(), nullptr, pkey.get()) != 1) {
1935 ec = error::signature_generation_error::signinit_failed;
1936 return {};
1937 }
1938 if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PSS_PADDING) <= 0) {
1939 ec = error::signature_generation_error::rsa_padding_failed;
1940 return {};
1941 }
1942// wolfSSL does not require EVP_PKEY_CTX_set_rsa_pss_saltlen. The default behavior
1943// sets the salt length to the hash length. Unlike OpenSSL which exposes this functionality.
1944#ifndef LIBWOLFSSL_VERSION_HEX
1945 if (EVP_PKEY_CTX_set_rsa_pss_saltlen(ctx, -1) <= 0) {
1946 ec = error::signature_generation_error::set_rsa_pss_saltlen_failed;
1947 return {};
1948 }
1949#endif
1950 if (EVP_DigestUpdate(md_ctx.get(), data.data(), data.size()) != 1) {
1951 ec = error::signature_generation_error::digestupdate_failed;
1952 return {};
1953 }
1954
1955 size_t size = EVP_PKEY_size(pkey.get());
1956 std::string res(size, 0x00);
1957 if (EVP_DigestSignFinal(
1958 md_ctx.get(),
1959 (unsigned char*)res.data(), // NOLINT(google-readability-casting) requires `const_cast`
1960 &size) <= 0) {
1961 ec = error::signature_generation_error::signfinal_failed;
1962 return {};
1963 }
1964
1965 return res;
1966 }
1967
1974 void verify(const std::string& data, const std::string& signature, std::error_code& ec) const {
1975 ec.clear();
1976
1977 auto md_ctx = helper::make_evp_md_ctx();
1978 if (!md_ctx) {
1979 ec = error::signature_verification_error::create_context_failed;
1980 return;
1981 }
1982 EVP_PKEY_CTX* ctx = nullptr;
1983 if (EVP_DigestVerifyInit(md_ctx.get(), &ctx, md(), nullptr, pkey.get()) != 1) {
1984 ec = error::signature_verification_error::verifyinit_failed;
1985 return;
1986 }
1987 if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PSS_PADDING) <= 0) {
1988 ec = error::signature_generation_error::rsa_padding_failed;
1989 return;
1990 }
1991// wolfSSL does not require EVP_PKEY_CTX_set_rsa_pss_saltlen. The default behavior
1992// sets the salt length to the hash length. Unlike OpenSSL which exposes this functionality.
1993#ifndef LIBWOLFSSL_VERSION_HEX
1994 if (EVP_PKEY_CTX_set_rsa_pss_saltlen(ctx, -1) <= 0) {
1995 ec = error::signature_verification_error::set_rsa_pss_saltlen_failed;
1996 return;
1997 }
1998#endif
1999 if (EVP_DigestUpdate(md_ctx.get(), data.data(), data.size()) != 1) {
2000 ec = error::signature_verification_error::verifyupdate_failed;
2001 return;
2002 }
2003
2004 if (EVP_DigestVerifyFinal(md_ctx.get(), (unsigned char*)signature.data(), signature.size()) <= 0) {
2005 ec = error::signature_verification_error::verifyfinal_failed;
2006 return;
2007 }
2008 }
2013 std::string name() const { return alg_name; }
2014
2015 private:
2017 helper::evp_pkey_handle pkey;
2019 const EVP_MD* (*md)();
2021 const std::string alg_name;
2022 };
2023
2027 struct hs256 : public hmacsha {
2032 explicit hs256(std::string key) : hmacsha(std::move(key), EVP_sha256, "HS256") {}
2033 };
2037 struct hs384 : public hmacsha {
2042 explicit hs384(std::string key) : hmacsha(std::move(key), EVP_sha384, "HS384") {}
2043 };
2047 struct hs512 : public hmacsha {
2052 explicit hs512(std::string key) : hmacsha(std::move(key), EVP_sha512, "HS512") {}
2053 };
2059 struct rs256 : public rsa {
2068 explicit rs256(const std::string& public_key, const std::string& private_key = "",
2069 const std::string& public_key_password = "", const std::string& private_key_password = "")
2070 : rsa(public_key, private_key, public_key_password, private_key_password, EVP_sha256, "RS256") {}
2071 };
2075 struct rs384 : public rsa {
2083 explicit rs384(const std::string& public_key, const std::string& private_key = "",
2084 const std::string& public_key_password = "", const std::string& private_key_password = "")
2085 : rsa(public_key, private_key, public_key_password, private_key_password, EVP_sha384, "RS384") {}
2086 };
2090 struct rs512 : public rsa {
2098 explicit rs512(const std::string& public_key, const std::string& private_key = "",
2099 const std::string& public_key_password = "", const std::string& private_key_password = "")
2100 : rsa(public_key, private_key, public_key_password, private_key_password, EVP_sha512, "RS512") {}
2101 };
2105 struct es256 : public ecdsa {
2115 explicit es256(const std::string& public_key, const std::string& private_key = "",
2116 const std::string& public_key_password = "", const std::string& private_key_password = "")
2117 : ecdsa(public_key, private_key, public_key_password, private_key_password, EVP_sha256, "ES256", 64) {}
2118 };
2122 struct es384 : public ecdsa {
2132 explicit es384(const std::string& public_key, const std::string& private_key = "",
2133 const std::string& public_key_password = "", const std::string& private_key_password = "")
2134 : ecdsa(public_key, private_key, public_key_password, private_key_password, EVP_sha384, "ES384", 96) {}
2135 };
2139 struct es512 : public ecdsa {
2149 explicit es512(const std::string& public_key, const std::string& private_key = "",
2150 const std::string& public_key_password = "", const std::string& private_key_password = "")
2151 : ecdsa(public_key, private_key, public_key_password, private_key_password, EVP_sha512, "ES512", 132) {}
2152 };
2156 struct es256k : public ecdsa {
2165 explicit es256k(const std::string& public_key, const std::string& private_key = "",
2166 const std::string& public_key_password = "", const std::string& private_key_password = "")
2167 : ecdsa(public_key, private_key, public_key_password, private_key_password, EVP_sha256, "ES256K", 64) {}
2168 };
2169
2170#if !defined(JWT_OPENSSL_1_0_0) && !defined(JWT_OPENSSL_1_1_0)
2178 struct ed25519 : public eddsa {
2188 explicit ed25519(const std::string& public_key, const std::string& private_key = "",
2189 const std::string& public_key_password = "", const std::string& private_key_password = "")
2190 : eddsa(public_key, private_key, public_key_password, private_key_password, "EdDSA") {}
2191 };
2192
2200 struct ed448 : public eddsa {
2210 explicit ed448(const std::string& public_key, const std::string& private_key = "",
2211 const std::string& public_key_password = "", const std::string& private_key_password = "")
2212 : eddsa(public_key, private_key, public_key_password, private_key_password, "EdDSA") {}
2213 };
2214#endif
2215
2219 struct ps256 : public pss {
2227 explicit ps256(const std::string& public_key, const std::string& private_key = "",
2228 const std::string& public_key_password = "", const std::string& private_key_password = "")
2229 : pss(public_key, private_key, public_key_password, private_key_password, EVP_sha256, "PS256") {}
2230 };
2234 struct ps384 : public pss {
2242 explicit ps384(const std::string& public_key, const std::string& private_key = "",
2243 const std::string& public_key_password = "", const std::string& private_key_password = "")
2244 : pss(public_key, private_key, public_key_password, private_key_password, EVP_sha384, "PS384") {}
2245 };
2249 struct ps512 : public pss {
2257 explicit ps512(const std::string& public_key, const std::string& private_key = "",
2258 const std::string& public_key_password = "", const std::string& private_key_password = "")
2259 : pss(public_key, private_key, public_key_password, private_key_password, EVP_sha512, "PS512") {}
2260 };
2261 } // namespace algorithm
2262
2266 namespace json {
2274 enum class type { boolean, integer, number, string, array, object };
2275 } // namespace json
2276
2277 namespace details {
2278#ifdef __cpp_lib_void_t
2279 template<typename... Ts>
2280 using void_t = std::void_t<Ts...>;
2281#else
2282 // https://en.cppreference.com/w/cpp/types/void_t
2283 template<typename... Ts>
2284 struct make_void {
2285 using type = void;
2286 };
2287
2288 template<typename... Ts>
2289 using void_t = typename make_void<Ts...>::type;
2290#endif
2291
2292#ifdef __cpp_lib_experimental_detect
2293 template<template<typename...> class _Op, typename... _Args>
2294 using is_detected = std::experimental::is_detected<_Op, _Args...>;
2295#else
2296 struct nonesuch {
2297 nonesuch() = delete;
2298 ~nonesuch() = delete;
2299 nonesuch(nonesuch const&) = delete;
2300 nonesuch(nonesuch const&&) = delete;
2301 void operator=(nonesuch const&) = delete;
2302 void operator=(nonesuch&&) = delete;
2303 };
2304
2305 // https://en.cppreference.com/w/cpp/experimental/is_detected
2306 template<class Default, class AlwaysVoid, template<class...> class Op, class... Args>
2307 struct detector {
2308 using value = std::false_type;
2309 using type = Default;
2310 };
2311
2312 template<class Default, template<class...> class Op, class... Args>
2313 struct detector<Default, void_t<Op<Args...>>, Op, Args...> {
2314 using value = std::true_type;
2315 using type = Op<Args...>;
2316 };
2317
2318 template<template<class...> class Op, class... Args>
2319 using is_detected = typename detector<nonesuch, void, Op, Args...>::value;
2320#endif
2321
2322 template<typename T, typename Signature>
2323 using is_signature = typename std::is_same<T, Signature>;
2324
2325 template<typename traits_type, template<typename...> class Op, typename Signature>
2326 struct is_function_signature_detected {
2327 using type = Op<traits_type>;
2328 static constexpr auto value = is_detected<Op, traits_type>::value && std::is_function<type>::value &&
2329 is_signature<type, Signature>::value;
2330 };
2331
2332 template<typename traits_type, typename value_type>
2333 struct supports_get_type {
2334 template<typename T>
2335 using get_type_t = decltype(T::get_type);
2336
2337 static constexpr auto value =
2338 is_function_signature_detected<traits_type, get_type_t, json::type(const value_type&)>::value;
2339
2340 // Internal assertions for better feedback
2341 static_assert(value, "traits implementation must provide `jwt::json::type get_type(const value_type&)`");
2342 };
2343
2344#define JWT_CPP_JSON_TYPE_TYPE(TYPE) json_##TYPE_type
2345#define JWT_CPP_AS_TYPE_T(TYPE) as_##TYPE_t
2346#define JWT_CPP_SUPPORTS_AS(TYPE) \
2347 template<typename traits_type, typename value_type, typename JWT_CPP_JSON_TYPE_TYPE(TYPE)> \
2348 struct supports_as_##TYPE { \
2349 template<typename T> \
2350 using JWT_CPP_AS_TYPE_T(TYPE) = decltype(T::as_##TYPE); \
2351 \
2352 static constexpr auto value = \
2353 is_function_signature_detected<traits_type, JWT_CPP_AS_TYPE_T(TYPE), \
2354 JWT_CPP_JSON_TYPE_TYPE(TYPE)(const value_type&)>::value; \
2355 \
2356 static_assert(value, "traits implementation must provide `" #TYPE "_type as_" #TYPE "(const value_type&)`"); \
2357 }
2358
2359 JWT_CPP_SUPPORTS_AS(object);
2360 JWT_CPP_SUPPORTS_AS(array);
2361 JWT_CPP_SUPPORTS_AS(string);
2362 JWT_CPP_SUPPORTS_AS(number);
2363 JWT_CPP_SUPPORTS_AS(integer);
2364 JWT_CPP_SUPPORTS_AS(boolean);
2365
2366#undef JWT_CPP_JSON_TYPE_TYPE
2367#undef JWT_CPP_AS_TYPE_T
2368#undef JWT_CPP_SUPPORTS_AS
2369
2370 template<typename traits>
2371 struct is_valid_traits {
2372 static constexpr auto value =
2373 supports_get_type<traits, typename traits::value_type>::value &&
2374 supports_as_object<traits, typename traits::value_type, typename traits::object_type>::value &&
2375 supports_as_array<traits, typename traits::value_type, typename traits::array_type>::value &&
2376 supports_as_string<traits, typename traits::value_type, typename traits::string_type>::value &&
2377 supports_as_number<traits, typename traits::value_type, typename traits::number_type>::value &&
2378 supports_as_integer<traits, typename traits::value_type, typename traits::integer_type>::value &&
2379 supports_as_boolean<traits, typename traits::value_type, typename traits::boolean_type>::value;
2380 };
2381
2382 template<typename value_type>
2383 struct is_valid_json_value {
2384 static constexpr auto value =
2385 std::is_default_constructible<value_type>::value &&
2386 std::is_constructible<value_type, const value_type&>::value && // a more generic is_copy_constructible
2387 std::is_move_constructible<value_type>::value && std::is_assignable<value_type, value_type>::value &&
2388 std::is_copy_assignable<value_type>::value && std::is_move_assignable<value_type>::value;
2389 // TODO(prince-chrismc): Stream operators
2390 };
2391
2392 // https://stackoverflow.com/a/53967057/8480874
2393 template<typename T, typename = void>
2394 struct is_iterable : std::false_type {};
2395
2396 template<typename T>
2397 struct is_iterable<T, void_t<decltype(std::begin(std::declval<T>())), decltype(std::end(std::declval<T>())),
2398#if __cplusplus > 201402L
2399 decltype(std::cbegin(std::declval<T>())), decltype(std::cend(std::declval<T>()))
2400#else
2401 decltype(std::begin(std::declval<const T>())),
2402 decltype(std::end(std::declval<const T>()))
2403#endif
2404 >> : std::true_type {
2405 };
2406
2407#if __cplusplus > 201703L
2408 template<typename T>
2409 inline constexpr bool is_iterable_v = is_iterable<T>::value;
2410#endif
2411
2412 template<typename object_type, typename string_type>
2413 using is_count_signature = typename std::is_integral<decltype(std::declval<const object_type>().count(
2414 std::declval<const string_type>()))>;
2415
2416 template<typename object_type, typename string_type, typename = void>
2417 struct is_subcription_operator_signature : std::false_type {};
2418
2419 template<typename object_type, typename string_type>
2420 struct is_subcription_operator_signature<
2421 object_type, string_type,
2422 void_t<decltype(std::declval<object_type>().operator[](std::declval<string_type>()))>> : std::true_type {
2423 // TODO(prince-chrismc): I am not convienced this is meaningful anymore
2424 static_assert(
2425 value,
2426 "object_type must implementate the subscription operator '[]' taking string_type as an argument");
2427 };
2428
2429 template<typename object_type, typename value_type, typename string_type>
2430 using is_at_const_signature =
2431 typename std::is_same<decltype(std::declval<const object_type>().at(std::declval<const string_type>())),
2432 const value_type&>;
2433
2434 template<typename value_type, typename string_type, typename object_type>
2435 struct is_valid_json_object {
2436 template<typename T>
2437 using mapped_type_t = typename T::mapped_type;
2438 template<typename T>
2439 using key_type_t = typename T::key_type;
2440 template<typename T>
2441 using iterator_t = typename T::iterator;
2442 template<typename T>
2443 using const_iterator_t = typename T::const_iterator;
2444
2445 static constexpr auto value =
2446 std::is_constructible<value_type, object_type>::value &&
2447 is_detected<mapped_type_t, object_type>::value &&
2448 std::is_same<typename object_type::mapped_type, value_type>::value &&
2449 is_detected<key_type_t, object_type>::value &&
2450 (std::is_same<typename object_type::key_type, string_type>::value ||
2451 std::is_constructible<typename object_type::key_type, string_type>::value) &&
2452 is_detected<iterator_t, object_type>::value && is_detected<const_iterator_t, object_type>::value &&
2453 is_iterable<object_type>::value && is_count_signature<object_type, string_type>::value &&
2454 is_subcription_operator_signature<object_type, string_type>::value &&
2455 is_at_const_signature<object_type, value_type, string_type>::value;
2456 };
2457
2458 template<typename value_type, typename array_type>
2459 struct is_valid_json_array {
2460 template<typename T>
2461 using value_type_t = typename T::value_type;
2462 using front_base_type = typename std::decay<decltype(std::declval<array_type>().front())>::type;
2463
2464 static constexpr auto value = std::is_constructible<value_type, array_type>::value &&
2465 is_iterable<array_type>::value &&
2466 is_detected<value_type_t, array_type>::value &&
2467 std::is_same<typename array_type::value_type, value_type>::value &&
2468 std::is_same<front_base_type, value_type>::value;
2469 };
2470
2471 template<typename string_type, typename integer_type>
2472 using is_substr_start_end_index_signature =
2473 typename std::is_same<decltype(std::declval<string_type>().substr(std::declval<integer_type>(),
2474 std::declval<integer_type>())),
2475 string_type>;
2476
2477 template<typename string_type, typename integer_type>
2478 using is_substr_start_index_signature =
2479 typename std::is_same<decltype(std::declval<string_type>().substr(std::declval<integer_type>())),
2480 string_type>;
2481
2482 template<typename string_type>
2483 using is_std_operate_plus_signature =
2484 typename std::is_same<decltype(std::operator+(std::declval<string_type>(), std::declval<string_type>())),
2485 string_type>;
2486
2487 template<typename value_type, typename string_type, typename integer_type>
2488 struct is_valid_json_string {
2489 static constexpr auto substr = is_substr_start_end_index_signature<string_type, integer_type>::value &&
2490 is_substr_start_index_signature<string_type, integer_type>::value;
2491 static_assert(substr, "string_type must have a substr method taking only a start index and an overload "
2492 "taking a start and end index, both must return a string_type");
2493
2494 static constexpr auto operator_plus = is_std_operate_plus_signature<string_type>::value;
2495 static_assert(operator_plus,
2496 "string_type must have a '+' operator implemented which returns the concatenated string");
2497
2498 static constexpr auto value =
2499 std::is_constructible<value_type, string_type>::value && substr && operator_plus;
2500 };
2501
2502 template<typename value_type, typename number_type>
2503 struct is_valid_json_number {
2504 static constexpr auto value =
2505 std::is_floating_point<number_type>::value && std::is_constructible<value_type, number_type>::value;
2506 };
2507
2508 template<typename value_type, typename integer_type>
2509 struct is_valid_json_integer {
2510 static constexpr auto value = std::is_signed<integer_type>::value &&
2511 !std::is_floating_point<integer_type>::value &&
2512 std::is_constructible<value_type, integer_type>::value;
2513 };
2514 template<typename value_type, typename boolean_type>
2515 struct is_valid_json_boolean {
2516 static constexpr auto value = std::is_convertible<boolean_type, bool>::value &&
2517 std::is_constructible<value_type, boolean_type>::value;
2518 };
2519
2520 template<typename value_type, typename object_type, typename array_type, typename string_type,
2521 typename number_type, typename integer_type, typename boolean_type>
2522 struct is_valid_json_types {
2523 // Internal assertions for better feedback
2524 static_assert(is_valid_json_value<value_type>::value,
2525 "value_type must meet basic requirements, default constructor, copyable, moveable");
2526 static_assert(is_valid_json_object<value_type, string_type, object_type>::value,
2527 "object_type must be a string_type to value_type container");
2528 static_assert(is_valid_json_array<value_type, array_type>::value,
2529 "array_type must be a container of value_type");
2530
2531 static constexpr auto value = is_valid_json_value<value_type>::value &&
2532 is_valid_json_object<value_type, string_type, object_type>::value &&
2533 is_valid_json_array<value_type, array_type>::value &&
2534 is_valid_json_string<value_type, string_type, integer_type>::value &&
2535 is_valid_json_number<value_type, number_type>::value &&
2536 is_valid_json_integer<value_type, integer_type>::value &&
2537 is_valid_json_boolean<value_type, boolean_type>::value;
2538 };
2539 } // namespace details
2540
2548 template<typename json_traits>
2549 class basic_claim {
2556 static_assert(std::is_same<typename json_traits::string_type, std::string>::value ||
2557 std::is_convertible<typename json_traits::string_type, std::string>::value ||
2558 std::is_constructible<typename json_traits::string_type, std::string>::value,
2559 "string_type must be a std::string, convertible to a std::string, or construct a std::string.");
2560
2561 static_assert(
2562 details::is_valid_json_types<typename json_traits::value_type, typename json_traits::object_type,
2563 typename json_traits::array_type, typename json_traits::string_type,
2564 typename json_traits::number_type, typename json_traits::integer_type,
2565 typename json_traits::boolean_type>::value,
2566 "must satisfy json container requirements");
2567 static_assert(details::is_valid_traits<json_traits>::value, "traits must satisfy requirements");
2568
2569 typename json_traits::value_type val;
2570
2571 public:
2575 using set_t = std::set<typename json_traits::string_type>;
2576
2577 basic_claim() = default;
2578 basic_claim(const basic_claim&) = default;
2579 basic_claim(basic_claim&&) = default;
2580 basic_claim& operator=(const basic_claim&) = default;
2581 basic_claim& operator=(basic_claim&&) = default;
2582 ~basic_claim() = default;
2583
2584 JWT_CLAIM_EXPLICIT basic_claim(typename json_traits::string_type s) : val(std::move(s)) {}
2585 JWT_CLAIM_EXPLICIT basic_claim(const date& d)
2586 : val(typename json_traits::integer_type(std::chrono::system_clock::to_time_t(d))) {}
2587 JWT_CLAIM_EXPLICIT basic_claim(typename json_traits::array_type a) : val(std::move(a)) {}
2588 JWT_CLAIM_EXPLICIT basic_claim(typename json_traits::value_type v) : val(std::move(v)) {}
2589 JWT_CLAIM_EXPLICIT basic_claim(const set_t& s) : val(typename json_traits::array_type(s.begin(), s.end())) {}
2590 template<typename Iterator>
2591 basic_claim(Iterator begin, Iterator end) : val(typename json_traits::array_type(begin, end)) {}
2592
2597 typename json_traits::value_type to_json() const { return val; }
2598
2603 std::istream& operator>>(std::istream& is) { return is >> val; }
2604
2609 std::ostream& operator<<(std::ostream& os) { return os << val; }
2610
2616 json::type get_type() const { return json_traits::get_type(val); }
2617
2623 typename json_traits::string_type as_string() const { return json_traits::as_string(val); }
2624
2633 date as_date() const {
2634 using std::chrono::system_clock;
2635 if (get_type() == json::type::number) return system_clock::from_time_t(std::round(as_number()));
2636 return system_clock::from_time_t(as_integer());
2637 }
2638
2644 typename json_traits::array_type as_array() const { return json_traits::as_array(val); }
2645
2651 set_t as_set() const {
2652 set_t res;
2653 for (const auto& e : json_traits::as_array(val)) {
2654 res.insert(json_traits::as_string(e));
2655 }
2656 return res;
2657 }
2658
2664 typename json_traits::integer_type as_integer() const { return json_traits::as_integer(val); }
2665
2671 typename json_traits::boolean_type as_boolean() const { return json_traits::as_boolean(val); }
2672
2678 typename json_traits::number_type as_number() const { return json_traits::as_number(val); }
2679 };
2680
2681 namespace error {
2685 struct invalid_json_exception : public std::runtime_error {
2686 invalid_json_exception() : runtime_error("invalid json") {}
2687 };
2691 struct claim_not_present_exception : public std::out_of_range {
2692 claim_not_present_exception() : out_of_range("claim not found") {}
2693 };
2694 } // namespace error
2695
2696 namespace details {
2697 template<typename json_traits>
2698 struct map_of_claims {
2699 typename json_traits::object_type claims;
2700 using basic_claim_t = basic_claim<json_traits>;
2701 using iterator = typename json_traits::object_type::iterator;
2702 using const_iterator = typename json_traits::object_type::const_iterator;
2703
2704 map_of_claims() = default;
2705 map_of_claims(const map_of_claims&) = default;
2706 map_of_claims(map_of_claims&&) = default;
2707 map_of_claims& operator=(const map_of_claims&) = default;
2708 map_of_claims& operator=(map_of_claims&&) = default;
2709
2710 map_of_claims(typename json_traits::object_type json) : claims(std::move(json)) {}
2711
2712 iterator begin() { return claims.begin(); }
2713 iterator end() { return claims.end(); }
2714 const_iterator cbegin() const { return claims.begin(); }
2715 const_iterator cend() const { return claims.end(); }
2716 const_iterator begin() const { return claims.begin(); }
2717 const_iterator end() const { return claims.end(); }
2718
2727 static typename json_traits::object_type parse_claims(const typename json_traits::string_type& str) {
2728 typename json_traits::value_type val;
2729 if (!json_traits::parse(val, str)) throw error::invalid_json_exception();
2730
2731 return json_traits::as_object(val);
2732 };
2733
2738 bool has_claim(const typename json_traits::string_type& name) const noexcept {
2739 return claims.count(name) != 0;
2740 }
2741
2749 basic_claim_t get_claim(const typename json_traits::string_type& name) const {
2750 if (!has_claim(name)) throw error::claim_not_present_exception();
2751 return basic_claim_t{claims.at(name)};
2752 }
2753 };
2754 } // namespace details
2755
2760 template<typename json_traits>
2761 class payload {
2762 protected:
2763 details::map_of_claims<json_traits> payload_claims;
2764
2765 public:
2766 using basic_claim_t = basic_claim<json_traits>;
2767
2772 bool has_issuer() const noexcept { return has_payload_claim("iss"); }
2777 bool has_subject() const noexcept { return has_payload_claim("sub"); }
2782 bool has_audience() const noexcept { return has_payload_claim("aud"); }
2787 bool has_expires_at() const noexcept { return has_payload_claim("exp"); }
2792 bool has_not_before() const noexcept { return has_payload_claim("nbf"); }
2797 bool has_issued_at() const noexcept { return has_payload_claim("iat"); }
2802 bool has_id() const noexcept { return has_payload_claim("jti"); }
2809 typename json_traits::string_type get_issuer() const { return get_payload_claim("iss").as_string(); }
2816 typename json_traits::string_type get_subject() const { return get_payload_claim("sub").as_string(); }
2823 typename basic_claim_t::set_t get_audience() const {
2824 auto aud = get_payload_claim("aud");
2825 if (aud.get_type() == json::type::string) return {aud.as_string()};
2826
2827 return aud.as_set();
2828 }
2835 date get_expires_at() const { return get_payload_claim("exp").as_date(); }
2842 date get_not_before() const { return get_payload_claim("nbf").as_date(); }
2849 date get_issued_at() const { return get_payload_claim("iat").as_date(); }
2856 typename json_traits::string_type get_id() const { return get_payload_claim("jti").as_string(); }
2861 bool has_payload_claim(const typename json_traits::string_type& name) const noexcept {
2862 return payload_claims.has_claim(name);
2863 }
2869 basic_claim_t get_payload_claim(const typename json_traits::string_type& name) const {
2870 return payload_claims.get_claim(name);
2871 }
2872 };
2873
2878 template<typename json_traits>
2879 class header {
2880 protected:
2881 details::map_of_claims<json_traits> header_claims;
2882
2883 public:
2884 using basic_claim_t = basic_claim<json_traits>;
2889 bool has_algorithm() const noexcept { return has_header_claim("alg"); }
2894 bool has_type() const noexcept { return has_header_claim("typ"); }
2899 bool has_content_type() const noexcept { return has_header_claim("cty"); }
2904 bool has_key_id() const noexcept { return has_header_claim("kid"); }
2911 typename json_traits::string_type get_algorithm() const { return get_header_claim("alg").as_string(); }
2918 typename json_traits::string_type get_type() const { return get_header_claim("typ").as_string(); }
2925 typename json_traits::string_type get_content_type() const { return get_header_claim("cty").as_string(); }
2932 typename json_traits::string_type get_key_id() const { return get_header_claim("kid").as_string(); }
2937 bool has_header_claim(const typename json_traits::string_type& name) const noexcept {
2938 return header_claims.has_claim(name);
2939 }
2945 basic_claim_t get_header_claim(const typename json_traits::string_type& name) const {
2946 return header_claims.get_claim(name);
2947 }
2948 };
2949
2953 template<typename json_traits>
2954 class decoded_jwt : public header<json_traits>, public payload<json_traits> {
2955 protected:
2957 typename json_traits::string_type token;
2959 typename json_traits::string_type header;
2961 typename json_traits::string_type header_base64;
2963 typename json_traits::string_type payload;
2965 typename json_traits::string_type payload_base64;
2967 typename json_traits::string_type signature;
2969 typename json_traits::string_type signature_base64;
2970
2971 public:
2972 using basic_claim_t = basic_claim<json_traits>;
2973#ifndef JWT_DISABLE_BASE64
2983 JWT_CLAIM_EXPLICIT decoded_jwt(const typename json_traits::string_type& token)
2984 : decoded_jwt(token, [](const typename json_traits::string_type& str) {
2985 return base::decode<alphabet::base64url>(base::pad<alphabet::base64url>(str));
2986 }) {}
2987#endif
2999 template<typename Decode>
3000 decoded_jwt(const typename json_traits::string_type& token, Decode decode) : token(token) {
3001 auto hdr_end = token.find('.');
3002 if (hdr_end == json_traits::string_type::npos) throw std::invalid_argument("invalid token supplied");
3003 auto payload_end = token.find('.', hdr_end + 1);
3004 if (payload_end == json_traits::string_type::npos) throw std::invalid_argument("invalid token supplied");
3005 header_base64 = token.substr(0, hdr_end);
3006 payload_base64 = token.substr(hdr_end + 1, payload_end - hdr_end - 1);
3007 signature_base64 = token.substr(payload_end + 1);
3008
3009 header = decode(header_base64);
3010 payload = decode(payload_base64);
3011 signature = decode(signature_base64);
3012
3013 this->header_claims = details::map_of_claims<json_traits>::parse_claims(header);
3014 this->payload_claims = details::map_of_claims<json_traits>::parse_claims(payload);
3015 }
3016
3021 const typename json_traits::string_type& get_token() const noexcept { return token; }
3026 const typename json_traits::string_type& get_header() const noexcept { return header; }
3031 const typename json_traits::string_type& get_payload() const noexcept { return payload; }
3036 const typename json_traits::string_type& get_signature() const noexcept { return signature; }
3041 const typename json_traits::string_type& get_header_base64() const noexcept { return header_base64; }
3046 const typename json_traits::string_type& get_payload_base64() const noexcept { return payload_base64; }
3051 const typename json_traits::string_type& get_signature_base64() const noexcept { return signature_base64; }
3056 typename json_traits::object_type get_payload_json() const { return this->payload_claims.claims; }
3061 typename json_traits::object_type get_header_json() const { return this->header_claims.claims; }
3069 basic_claim_t get_payload_claim(const typename json_traits::string_type& name) const {
3070 return this->payload_claims.get_claim(name);
3071 }
3079 basic_claim_t get_header_claim(const typename json_traits::string_type& name) const {
3080 return this->header_claims.get_claim(name);
3081 }
3082 };
3083
3088 template<typename Clock, typename json_traits>
3089 class builder {
3090 typename json_traits::object_type header_claims;
3091 typename json_traits::object_type payload_claims;
3092
3094 Clock clock;
3095
3096 public:
3101 JWT_CLAIM_EXPLICIT builder(Clock c) : clock(c) {}
3108 builder& set_header_claim(const typename json_traits::string_type& id, typename json_traits::value_type c) {
3109 header_claims[id] = std::move(c);
3110 return *this;
3111 }
3112
3119 builder& set_header_claim(const typename json_traits::string_type& id, basic_claim<json_traits> c) {
3120 header_claims[id] = c.to_json();
3121 return *this;
3122 }
3129 builder& set_payload_claim(const typename json_traits::string_type& id, typename json_traits::value_type c) {
3130 payload_claims[id] = std::move(c);
3131 return *this;
3132 }
3139 builder& set_payload_claim(const typename json_traits::string_type& id, basic_claim<json_traits> c) {
3140 payload_claims[id] = c.to_json();
3141 return *this;
3142 }
3150 builder& set_algorithm(typename json_traits::string_type str) {
3151 return set_header_claim("alg", typename json_traits::value_type(str));
3152 }
3158 builder& set_type(typename json_traits::string_type str) {
3159 return set_header_claim("typ", typename json_traits::value_type(str));
3160 }
3166 builder& set_content_type(typename json_traits::string_type str) {
3167 return set_header_claim("cty", typename json_traits::value_type(str));
3168 }
3175 builder& set_key_id(typename json_traits::string_type str) {
3176 return set_header_claim("kid", typename json_traits::value_type(str));
3177 }
3183 builder& set_issuer(typename json_traits::string_type str) {
3184 return set_payload_claim("iss", typename json_traits::value_type(str));
3185 }
3191 builder& set_subject(typename json_traits::string_type str) {
3192 return set_payload_claim("sub", typename json_traits::value_type(str));
3193 }
3199 builder& set_audience(typename json_traits::array_type a) {
3200 return set_payload_claim("aud", typename json_traits::value_type(a));
3201 }
3207 builder& set_audience(typename json_traits::string_type aud) {
3208 return set_payload_claim("aud", typename json_traits::value_type(aud));
3209 }
3215 builder& set_expires_at(const date& d) { return set_payload_claim("exp", basic_claim<json_traits>(d)); }
3221 template<class Rep>
3222 builder& set_expires_in(const std::chrono::duration<Rep>& d) {
3223 return set_payload_claim("exp", basic_claim<json_traits>(clock.now() + d));
3224 }
3230 builder& set_not_before(const date& d) { return set_payload_claim("nbf", basic_claim<json_traits>(d)); }
3236 builder& set_issued_at(const date& d) { return set_payload_claim("iat", basic_claim<json_traits>(d)); }
3241 builder& set_issued_now() { return set_issued_at(clock.now()); }
3247 builder& set_id(const typename json_traits::string_type& str) {
3248 return set_payload_claim("jti", typename json_traits::value_type(str));
3249 }
3250
3262 template<typename Algo, typename Encode>
3263 typename json_traits::string_type sign(const Algo& algo, Encode encode) const {
3264 std::error_code ec;
3265 auto res = sign(algo, encode, ec);
3266 error::throw_if_error(ec);
3267 return res;
3268 }
3269#ifndef JWT_DISABLE_BASE64
3278 template<typename Algo>
3279 typename json_traits::string_type sign(const Algo& algo) const {
3280 std::error_code ec;
3281 auto res = sign(algo, ec);
3282 error::throw_if_error(ec);
3283 return res;
3284 }
3285#endif
3286
3299 template<typename Algo, typename Encode>
3300 typename json_traits::string_type sign(const Algo& algo, Encode encode, std::error_code& ec) const {
3301 // make a copy such that a builder can be re-used
3302 typename json_traits::object_type obj_header = header_claims;
3303 if (header_claims.count("alg") == 0) obj_header["alg"] = typename json_traits::value_type(algo.name());
3304
3305 const auto header = encode(json_traits::serialize(typename json_traits::value_type(obj_header)));
3306 const auto payload = encode(json_traits::serialize(typename json_traits::value_type(payload_claims)));
3307 const auto token = header + "." + payload;
3308
3309 auto signature = algo.sign(token, ec);
3310 if (ec) return {};
3311
3312 return token + "." + encode(signature);
3313 }
3314#ifndef JWT_DISABLE_BASE64
3324 template<typename Algo>
3325 typename json_traits::string_type sign(const Algo& algo, std::error_code& ec) const {
3326 return sign(
3327 algo,
3328 [](const typename json_traits::string_type& data) {
3329 return base::trim<alphabet::base64url>(base::encode<alphabet::base64url>(data));
3330 },
3331 ec);
3332 }
3333#endif
3334 };
3335
3336 namespace verify_ops {
3340 template<typename json_traits>
3341 struct verify_context {
3342 verify_context(date ctime, const decoded_jwt<json_traits>& j, size_t l)
3343 : current_time(ctime), jwt(j), default_leeway(l) {}
3345 date current_time;
3347 const decoded_jwt<json_traits>& jwt;
3349 size_t default_leeway{0};
3350
3352 typename json_traits::string_type claim_key{};
3353
3360 basic_claim<json_traits> get_claim(bool in_header, std::error_code& ec) const {
3361 if (in_header) {
3362 if (!jwt.has_header_claim(claim_key)) {
3363 ec = error::token_verification_error::missing_claim;
3364 return {};
3365 }
3366 return jwt.get_header_claim(claim_key);
3367 } else {
3368 if (!jwt.has_payload_claim(claim_key)) {
3369 ec = error::token_verification_error::missing_claim;
3370 return {};
3371 }
3372 return jwt.get_payload_claim(claim_key);
3373 }
3374 }
3382 basic_claim<json_traits> get_claim(bool in_header, json::type t, std::error_code& ec) const {
3383 auto c = get_claim(in_header, ec);
3384 if (ec) return {};
3385 if (c.get_type() != t) {
3386 ec = error::token_verification_error::claim_type_missmatch;
3387 return {};
3388 }
3389 return c;
3390 }
3396 basic_claim<json_traits> get_claim(std::error_code& ec) const { return get_claim(false, ec); }
3403 basic_claim<json_traits> get_claim(json::type t, std::error_code& ec) const {
3404 return get_claim(false, t, ec);
3405 }
3406 };
3407
3411 template<typename json_traits, bool in_header = false>
3412 struct equals_claim {
3413 const basic_claim<json_traits> expected;
3414 void operator()(const verify_context<json_traits>& ctx, std::error_code& ec) const {
3415 auto jc = ctx.get_claim(in_header, expected.get_type(), ec);
3416 if (ec) return;
3417 const bool matches = [&]() {
3418 switch (expected.get_type()) {
3419 case json::type::boolean: return expected.as_boolean() == jc.as_boolean();
3420 case json::type::integer: return expected.as_integer() == jc.as_integer();
3421 case json::type::number: return expected.as_number() == jc.as_number();
3422 case json::type::string: return expected.as_string() == jc.as_string();
3423 case json::type::array:
3424 case json::type::object:
3425 return json_traits::serialize(expected.to_json()) == json_traits::serialize(jc.to_json());
3426 default: throw std::logic_error("internal error, should be unreachable");
3427 }
3428 }();
3429 if (!matches) {
3430 ec = error::token_verification_error::claim_value_missmatch;
3431 return;
3432 }
3433 }
3434 };
3435
3440 template<typename json_traits, bool in_header = false>
3441 struct date_before_claim {
3442 const size_t leeway;
3443 void operator()(const verify_context<json_traits>& ctx, std::error_code& ec) const {
3444 auto jc = ctx.get_claim(in_header, json::type::integer, ec);
3445 if (ec) return;
3446 auto c = jc.as_date();
3447 if (ctx.current_time > c + std::chrono::seconds(leeway)) {
3448 ec = error::token_verification_error::token_expired;
3449 }
3450 }
3451 };
3452
3457 template<typename json_traits, bool in_header = false>
3458 struct date_after_claim {
3459 const size_t leeway;
3460 void operator()(const verify_context<json_traits>& ctx, std::error_code& ec) const {
3461 auto jc = ctx.get_claim(in_header, json::type::integer, ec);
3462 if (ec) return;
3463 auto c = jc.as_date();
3464 if (ctx.current_time < c - std::chrono::seconds(leeway)) {
3465 ec = error::token_verification_error::token_expired;
3466 }
3467 }
3468 };
3469
3475 template<typename json_traits, bool in_header = false>
3476 struct is_subset_claim {
3477 const typename basic_claim<json_traits>::set_t expected;
3478 void operator()(const verify_context<json_traits>& ctx, std::error_code& ec) const {
3479 auto c = ctx.get_claim(in_header, ec);
3480 if (ec) return;
3481 if (c.get_type() == json::type::string) {
3482 if (expected.size() != 1 || *expected.begin() != c.as_string()) {
3483 ec = error::token_verification_error::audience_missmatch;
3484 return;
3485 }
3486 } else if (c.get_type() == json::type::array) {
3487 auto jc = c.as_set();
3488 for (auto& e : expected) {
3489 if (jc.find(e) == jc.end()) {
3490 ec = error::token_verification_error::audience_missmatch;
3491 return;
3492 }
3493 }
3494 } else {
3495 ec = error::token_verification_error::claim_type_missmatch;
3496 return;
3497 }
3498 }
3499 };
3500
3504 template<typename json_traits, bool in_header = false>
3505 struct insensitive_string_claim {
3506 const typename json_traits::string_type expected;
3507 std::locale locale;
3508 insensitive_string_claim(const typename json_traits::string_type& e, std::locale loc)
3509 : expected(to_lower_unicode(e, loc)), locale(loc) {}
3510
3511 void operator()(const verify_context<json_traits>& ctx, std::error_code& ec) const {
3512 const auto c = ctx.get_claim(in_header, json::type::string, ec);
3513 if (ec) return;
3514 if (to_lower_unicode(c.as_string(), locale) != expected) {
3515 ec = error::token_verification_error::claim_value_missmatch;
3516 }
3517 }
3518
3519 static std::string to_lower_unicode(const std::string& str, const std::locale& loc) {
3520 std::mbstate_t state = std::mbstate_t();
3521 const char* in_next = str.data();
3522 const char* in_end = str.data() + str.size();
3523 std::wstring wide;
3524 wide.reserve(str.size());
3525
3526 while (in_next != in_end) {
3527 wchar_t wc;
3528 std::size_t result = std::mbrtowc(&wc, in_next, in_end - in_next, &state);
3529 if (result == static_cast<std::size_t>(-1)) {
3530 throw std::runtime_error("encoding error: " + std::string(std::strerror(errno)));
3531 } else if (result == static_cast<std::size_t>(-2)) {
3532 throw std::runtime_error("conversion error: next bytes constitute an incomplete, but so far "
3533 "valid, multibyte character.");
3534 }
3535 in_next += result;
3536 wide.push_back(wc);
3537 }
3538
3539 auto& f = std::use_facet<std::ctype<wchar_t>>(loc);
3540 f.tolower(&wide[0], &wide[0] + wide.size());
3541
3542 std::string out;
3543 out.reserve(wide.size());
3544 for (wchar_t wc : wide) {
3545 char mb[MB_LEN_MAX];
3546 std::size_t n = std::wcrtomb(mb, wc, &state);
3547 if (n != static_cast<std::size_t>(-1)) out.append(mb, n);
3548 }
3549
3550 return out;
3551 }
3552 };
3553 } // namespace verify_ops
3554
3559 template<typename Clock, typename json_traits>
3560 class verifier {
3561 public:
3562 using basic_claim_t = basic_claim<json_traits>;
3572 using verify_check_fn_t =
3573 std::function<void(const verify_ops::verify_context<json_traits>&, std::error_code& ec)>;
3574
3575 private:
3576 struct algo_base {
3577 virtual ~algo_base() = default;
3578 virtual void verify(const std::string& data, const std::string& sig, std::error_code& ec) = 0;
3579 };
3580 template<typename T>
3581 struct algo : public algo_base {
3582 T alg;
3583 explicit algo(T a) : alg(a) {}
3584 void verify(const std::string& data, const std::string& sig, std::error_code& ec) override {
3585 alg.verify(data, sig, ec);
3586 }
3587 };
3589 std::unordered_map<typename json_traits::string_type, verify_check_fn_t> claims;
3591 size_t default_leeway = 0;
3593 Clock clock;
3595 std::unordered_map<std::string, std::shared_ptr<algo_base>> algs;
3596
3597 public:
3602 explicit verifier(Clock c) : clock(c) {
3603 claims["exp"] = [](const verify_ops::verify_context<json_traits>& ctx, std::error_code& ec) {
3604 if (!ctx.jwt.has_expires_at()) return;
3605 auto exp = ctx.jwt.get_expires_at();
3606 if (ctx.current_time > exp + std::chrono::seconds(ctx.default_leeway)) {
3607 ec = error::token_verification_error::token_expired;
3608 }
3609 };
3610 claims["iat"] = [](const verify_ops::verify_context<json_traits>& ctx, std::error_code& ec) {
3611 if (!ctx.jwt.has_issued_at()) return;
3612 auto iat = ctx.jwt.get_issued_at();
3613 if (ctx.current_time < iat - std::chrono::seconds(ctx.default_leeway)) {
3614 ec = error::token_verification_error::token_expired;
3615 }
3616 };
3617 claims["nbf"] = [](const verify_ops::verify_context<json_traits>& ctx, std::error_code& ec) {
3618 if (!ctx.jwt.has_not_before()) return;
3619 auto nbf = ctx.jwt.get_not_before();
3620 if (ctx.current_time < nbf - std::chrono::seconds(ctx.default_leeway)) {
3621 ec = error::token_verification_error::token_expired;
3622 }
3623 };
3624 }
3625
3631 verifier& leeway(size_t leeway) {
3632 default_leeway = leeway;
3633 return *this;
3634 }
3641 verifier& expires_at_leeway(size_t leeway) {
3642 claims["exp"] = verify_ops::date_before_claim<json_traits>{leeway};
3643 return *this;
3644 }
3651 verifier& not_before_leeway(size_t leeway) {
3652 claims["nbf"] = verify_ops::date_after_claim<json_traits>{leeway};
3653 return *this;
3654 }
3661 verifier& issued_at_leeway(size_t leeway) {
3662 claims["iat"] = verify_ops::date_after_claim<json_traits>{leeway};
3663 return *this;
3664 }
3665
3677 verifier& with_type(const typename json_traits::string_type& type, std::locale locale = std::locale{}) {
3678 return with_claim("typ", verify_ops::insensitive_string_claim<json_traits, true>{type, std::move(locale)});
3679 }
3680
3687 verifier& with_issuer(const typename json_traits::string_type& iss) {
3688 return with_claim("iss", basic_claim_t(iss));
3689 }
3690
3697 verifier& with_subject(const typename json_traits::string_type& sub) {
3698 return with_claim("sub", basic_claim_t(sub));
3699 }
3706 verifier& with_audience(const typename basic_claim_t::set_t& aud) {
3707 claims["aud"] = verify_ops::is_subset_claim<json_traits>{aud};
3708 return *this;
3709 }
3716 verifier& with_audience(const typename json_traits::string_type& aud) {
3717 typename basic_claim_t::set_t s;
3718 s.insert(aud);
3719 return with_audience(s);
3720 }
3727 verifier& with_id(const typename json_traits::string_type& id) { return with_claim("jti", basic_claim_t(id)); }
3728
3740 verifier& with_claim(const typename json_traits::string_type& name, verify_check_fn_t fn) {
3741 claims[name] = fn;
3742 return *this;
3743 }
3744
3755 verifier& with_claim(const typename json_traits::string_type& name, basic_claim_t c) {
3756 return with_claim(name, verify_ops::equals_claim<json_traits>{c});
3757 }
3758
3772 template<typename Algorithm>
3773 verifier& allow_algorithm(Algorithm alg) {
3774 algs[alg.name()] = std::make_shared<algo<Algorithm>>(alg);
3775 return *this;
3776 }
3777
3783 void verify(const decoded_jwt<json_traits>& jwt) const {
3784 std::error_code ec;
3785 verify(jwt, ec);
3786 error::throw_if_error(ec);
3787 }
3793 void verify(const decoded_jwt<json_traits>& jwt, std::error_code& ec) const {
3794 ec.clear();
3795 const typename json_traits::string_type data = jwt.get_header_base64() + "." + jwt.get_payload_base64();
3796 const typename json_traits::string_type sig = jwt.get_signature();
3797 const std::string algo = jwt.get_algorithm();
3798 if (algs.count(algo) == 0) {
3799 ec = error::token_verification_error::wrong_algorithm;
3800 return;
3801 }
3802 algs.at(algo)->verify(data, sig, ec);
3803 if (ec) return;
3804
3805 verify_ops::verify_context<json_traits> ctx{clock.now(), jwt, default_leeway};
3806 for (auto& c : claims) {
3807 ctx.claim_key = c.first;
3808 c.second(ctx, ec);
3809 if (ec) return;
3810 }
3811 }
3812 };
3813
3822 template<typename json_traits>
3823 class jwk {
3824 using basic_claim_t = basic_claim<json_traits>;
3825 const details::map_of_claims<json_traits> jwk_claims;
3826
3827 public:
3828 JWT_CLAIM_EXPLICIT jwk(const typename json_traits::string_type& str)
3829 : jwk_claims(details::map_of_claims<json_traits>::parse_claims(str)) {}
3830
3831 JWT_CLAIM_EXPLICIT jwk(const typename json_traits::value_type& json)
3832 : jwk_claims(json_traits::as_object(json)) {}
3833
3842 typename json_traits::string_type get_key_type() const { return get_jwk_claim("kty").as_string(); }
3843
3850 typename json_traits::string_type get_use() const { return get_jwk_claim("use").as_string(); }
3851
3858 typename basic_claim_t::set_t get_key_operations() const { return get_jwk_claim("key_ops").as_set(); }
3859
3866 typename json_traits::string_type get_algorithm() const { return get_jwk_claim("alg").as_string(); }
3867
3874 typename json_traits::string_type get_key_id() const { return get_jwk_claim("kid").as_string(); }
3875
3886 typename json_traits::string_type get_curve() const { return get_jwk_claim("crv").as_string(); }
3887
3894 typename json_traits::array_type get_x5c() const { return get_jwk_claim("x5c").as_array(); };
3895
3902 typename json_traits::string_type get_x5u() const { return get_jwk_claim("x5u").as_string(); };
3903
3910 typename json_traits::string_type get_x5t() const { return get_jwk_claim("x5t").as_string(); };
3911
3918 typename json_traits::string_type get_x5t_sha256() const { return get_jwk_claim("x5t#S256").as_string(); };
3919
3926 typename json_traits::string_type get_x5c_key_value() const {
3927 auto x5c_array = get_jwk_claim("x5c").as_array();
3928 if (x5c_array.size() == 0) throw error::claim_not_present_exception();
3929
3930 return json_traits::as_string(x5c_array.front());
3931 };
3932
3937 bool has_key_type() const noexcept { return has_jwk_claim("kty"); }
3938
3943 bool has_use() const noexcept { return has_jwk_claim("use"); }
3944
3949 bool has_key_operations() const noexcept { return has_jwk_claim("key_ops"); }
3950
3955 bool has_algorithm() const noexcept { return has_jwk_claim("alg"); }
3956
3961 bool has_curve() const noexcept { return has_jwk_claim("crv"); }
3962
3967 bool has_key_id() const noexcept { return has_jwk_claim("kid"); }
3968
3973 bool has_x5u() const noexcept { return has_jwk_claim("x5u"); }
3974
3979 bool has_x5c() const noexcept { return has_jwk_claim("x5c"); }
3980
3985 bool has_x5t() const noexcept { return has_jwk_claim("x5t"); }
3986
3991 bool has_x5t_sha256() const noexcept { return has_jwk_claim("x5t#S256"); }
3992
3997 bool has_jwk_claim(const typename json_traits::string_type& name) const noexcept {
3998 return jwk_claims.has_claim(name);
3999 }
4000
4006 basic_claim_t get_jwk_claim(const typename json_traits::string_type& name) const {
4007 return jwk_claims.get_claim(name);
4008 }
4009
4014 bool empty() const noexcept { return jwk_claims.empty(); }
4015
4020 typename json_traits::object_type get_claims() const { return this->jwk_claims.claims; }
4021 };
4022
4033 template<typename json_traits>
4034 class jwks {
4035 public:
4037 using jwks_t = jwk<json_traits>;
4039 using jwks_vector_t = std::vector<jwks_t>;
4040 using iterator = typename jwks_vector_t::iterator;
4041 using const_iterator = typename jwks_vector_t::const_iterator;
4042
4046 jwks() = default;
4047
4054 JWT_CLAIM_EXPLICIT jwks(const typename json_traits::string_type& str) {
4055 typename json_traits::value_type parsed_val;
4056 if (!json_traits::parse(parsed_val, str)) throw error::invalid_json_exception();
4057
4058 const details::map_of_claims<json_traits> jwks_json = json_traits::as_object(parsed_val);
4059 if (!jwks_json.has_claim("keys")) throw error::invalid_json_exception();
4060
4061 auto jwk_list = jwks_json.get_claim("keys").as_array();
4062 std::transform(jwk_list.begin(), jwk_list.end(), std::back_inserter(jwk_claims),
4063 [](const typename json_traits::value_type& val) { return jwks_t{val}; });
4064 }
4065
4066 iterator begin() { return jwk_claims.begin(); }
4067 iterator end() { return jwk_claims.end(); }
4068 const_iterator cbegin() const { return jwk_claims.begin(); }
4069 const_iterator cend() const { return jwk_claims.end(); }
4070 const_iterator begin() const { return jwk_claims.begin(); }
4071 const_iterator end() const { return jwk_claims.end(); }
4072
4077 bool has_jwk(const typename json_traits::string_type& key_id) const noexcept {
4078 return find_by_kid(key_id) != end();
4079 }
4080
4086 jwks_t get_jwk(const typename json_traits::string_type& key_id) const {
4087 const auto maybe = find_by_kid(key_id);
4088 if (maybe == end()) throw error::claim_not_present_exception();
4089 return *maybe;
4090 }
4091
4092 private:
4093 jwks_vector_t jwk_claims;
4094
4095 const_iterator find_by_kid(const typename json_traits::string_type& key_id) const noexcept {
4096 return std::find_if(cbegin(), cend(), [key_id](const jwks_t& jwk) {
4097 if (!jwk.has_key_id()) { return false; }
4098 return jwk.get_key_id() == key_id;
4099 });
4100 }
4101 };
4102
4108 template<typename Clock, typename json_traits>
4112
4118 template<typename Clock, typename json_traits>
4122
4126 struct default_clock {
4131 date now() const { return date::clock::now(); }
4132 };
4133
4142 template<typename json_traits>
4143 verifier<default_clock, json_traits> verify(default_clock c = {}) {
4144 return verifier<default_clock, json_traits>(c);
4145 }
4146
4150 template<typename json_traits>
4151 builder<default_clock, json_traits> create(default_clock c = {}) {
4152 return builder<default_clock, json_traits>(c);
4153 }
4154
4169 template<typename json_traits, typename Decode>
4170 decoded_jwt<json_traits> decode(const typename json_traits::string_type& token, Decode decode) {
4171 return decoded_jwt<json_traits>(token, decode);
4172 }
4173
4184 template<typename json_traits>
4185 decoded_jwt<json_traits> decode(const typename json_traits::string_type& token) {
4186 return decoded_jwt<json_traits>(token);
4187 }
4194 template<typename json_traits>
4195 jwk<json_traits> parse_jwk(const typename json_traits::string_type& jwk_) {
4196 return jwk<json_traits>(jwk_);
4197 }
4208 template<typename json_traits>
4209 jwks<json_traits> parse_jwks(const typename json_traits::string_type& jwks_) {
4210 return jwks<json_traits>(jwks_);
4211 }
4212} // namespace jwt
4213
4214template<typename json_traits>
4215std::istream& operator>>(std::istream& is, jwt::basic_claim<json_traits>& c) {
4216 return c.operator>>(is);
4217}
4218
4219template<typename json_traits>
4220std::ostream& operator<<(std::ostream& os, const jwt::basic_claim<json_traits>& c) {
4221 return os << c.to_json();
4222}
4223
4224#ifndef JWT_DISABLE_PICOJSON
4225#include "traits/kazuho-picojson/defaults.h"
4226#endif
4227
4228#endif
jwt::basic_claim
a class to store a generic JSON value as claim
Definition jwt.h:2549
jwt::basic_claim::as_number
json_traits::number_type as_number() const
Definition jwt.h:2678
jwt::basic_claim::as_set
set_t as_set() const
Definition jwt.h:2651
jwt::basic_claim::get_type
json::type get_type() const
Definition jwt.h:2616
jwt::basic_claim::set_t
std::set< typename json_traits::string_type > set_t
Definition jwt.h:2575
jwt::basic_claim::operator>>
std::istream & operator>>(std::istream &is)
Definition jwt.h:2603
jwt::basic_claim::as_boolean
json_traits::boolean_type as_boolean() const
Definition jwt.h:2671
jwt::basic_claim::as_date
date as_date() const
Get the contained JSON value as a date.
Definition jwt.h:2633
jwt::basic_claim::operator<<
std::ostream & operator<<(std::ostream &os)
Definition jwt.h:2609
jwt::basic_claim::as_integer
json_traits::integer_type as_integer() const
Definition jwt.h:2664
jwt::basic_claim::to_json
json_traits::value_type to_json() const
Definition jwt.h:2597
jwt::basic_claim::as_array
json_traits::array_type as_array() const
Definition jwt.h:2644
jwt::basic_claim::as_string
json_traits::string_type as_string() const
Definition jwt.h:2623
jwt::builder
Definition jwt.h:3089
jwt::builder::set_audience
builder & set_audience(typename json_traits::string_type aud)
Definition jwt.h:3207
jwt::builder::set_payload_claim
builder & set_payload_claim(const typename json_traits::string_type &id, basic_claim< json_traits > c)
Definition jwt.h:3139
jwt::builder::set_expires_in
builder & set_expires_in(const std::chrono::duration< Rep > &d)
Definition jwt.h:3222
jwt::builder::set_algorithm
builder & set_algorithm(typename json_traits::string_type str)
Set algorithm claim You normally don't need to do this, as the algorithm is automatically set if you ...
Definition jwt.h:3150
jwt::builder::set_expires_at
builder & set_expires_at(const date &d)
Definition jwt.h:3215
jwt::builder::set_type
builder & set_type(typename json_traits::string_type str)
Definition jwt.h:3158
jwt::builder::builder
JWT_CLAIM_EXPLICIT builder(Clock c)
Definition jwt.h:3101
jwt::builder::sign
json_traits::string_type sign(const Algo &algo, std::error_code &ec) const
Definition jwt.h:3325
jwt::builder::set_issued_at
builder & set_issued_at(const date &d)
Definition jwt.h:3236
jwt::builder::sign
json_traits::string_type sign(const Algo &algo) const
Definition jwt.h:3279
jwt::builder::set_payload_claim
builder & set_payload_claim(const typename json_traits::string_type &id, typename json_traits::value_type c)
Definition jwt.h:3129
jwt::builder::set_id
builder & set_id(const typename json_traits::string_type &str)
Definition jwt.h:3247
jwt::builder::set_header_claim
builder & set_header_claim(const typename json_traits::string_type &id, typename json_traits::value_type c)
Definition jwt.h:3108
jwt::builder::set_header_claim
builder & set_header_claim(const typename json_traits::string_type &id, basic_claim< json_traits > c)
Definition jwt.h:3119
jwt::builder::sign
json_traits::string_type sign(const Algo &algo, Encode encode) const
Definition jwt.h:3263
jwt::builder::set_audience
builder & set_audience(typename json_traits::array_type a)
Definition jwt.h:3199
jwt::builder::sign
json_traits::string_type sign(const Algo &algo, Encode encode, std::error_code &ec) const
Definition jwt.h:3300
jwt::builder::set_content_type
builder & set_content_type(typename json_traits::string_type str)
Definition jwt.h:3166
jwt::builder::set_not_before
builder & set_not_before(const date &d)
Definition jwt.h:3230
jwt::builder::set_subject
builder & set_subject(typename json_traits::string_type str)
Definition jwt.h:3191
jwt::builder::set_issued_now
builder & set_issued_now()
Definition jwt.h:3241
jwt::builder::set_key_id
builder & set_key_id(typename json_traits::string_type str)
Set key id claim.
Definition jwt.h:3175
jwt::builder::set_issuer
builder & set_issuer(typename json_traits::string_type str)
Definition jwt.h:3183
jwt::decoded_jwt
Definition jwt.h:2954
jwt::decoded_jwt::get_header
const json_traits::string_type & get_header() const noexcept
Definition jwt.h:3026
jwt::decoded_jwt::get_signature_base64
const json_traits::string_type & get_signature_base64() const noexcept
Definition jwt.h:3051
jwt::decoded_jwt::signature
json_traits::string_type signature
Signature part decoded from base64.
Definition jwt.h:2967
jwt::decoded_jwt::header
json_traits::string_type header
Header part decoded from base64.
Definition jwt.h:2959
jwt::decoded_jwt::header_base64
json_traits::string_type header_base64
Unmodified header part in base64.
Definition jwt.h:2961
jwt::decoded_jwt::token
json_traits::string_type token
Unmodified token, as passed to constructor.
Definition jwt.h:2957
jwt::decoded_jwt::get_payload_claim
basic_claim_t get_payload_claim(const typename json_traits::string_type &name) const
Definition jwt.h:3069
jwt::decoded_jwt::get_signature
const json_traits::string_type & get_signature() const noexcept
Definition jwt.h:3036
jwt::decoded_jwt::decoded_jwt
JWT_CLAIM_EXPLICIT decoded_jwt(const typename json_traits::string_type &token)
Parses a given token.
Definition jwt.h:2983
jwt::decoded_jwt::get_header_claim
basic_claim_t get_header_claim(const typename json_traits::string_type &name) const
Definition jwt.h:3079
jwt::decoded_jwt::decoded_jwt
decoded_jwt(const typename json_traits::string_type &token, Decode decode)
Parses a given token.
Definition jwt.h:3000
jwt::decoded_jwt::get_payload_json
json_traits::object_type get_payload_json() const
Definition jwt.h:3056
jwt::decoded_jwt::signature_base64
json_traits::string_type signature_base64
Unmodified signature part in base64.
Definition jwt.h:2969
jwt::decoded_jwt::get_payload_base64
const json_traits::string_type & get_payload_base64() const noexcept
Definition jwt.h:3046
jwt::decoded_jwt::get_token
const json_traits::string_type & get_token() const noexcept
Definition jwt.h:3021
jwt::decoded_jwt::get_header_json
json_traits::object_type get_header_json() const
Definition jwt.h:3061
jwt::decoded_jwt::get_payload
const json_traits::string_type & get_payload() const noexcept
Definition jwt.h:3031
jwt::decoded_jwt::get_header_base64
const json_traits::string_type & get_header_base64() const noexcept
Definition jwt.h:3041
jwt::decoded_jwt::payload_base64
json_traits::string_type payload_base64
Unmodified payload part in base64.
Definition jwt.h:2965
jwt::decoded_jwt::payload
json_traits::string_type payload
Payload part decoded from base64.
Definition jwt.h:2963
jwt::header
Definition jwt.h:2879
jwt::header::get_type
json_traits::string_type get_type() const
Definition jwt.h:2918
jwt::header::has_header_claim
bool has_header_claim(const typename json_traits::string_type &name) const noexcept
Definition jwt.h:2937
jwt::header::has_algorithm
bool has_algorithm() const noexcept
Definition jwt.h:2889
jwt::header::has_type
bool has_type() const noexcept
Definition jwt.h:2894
jwt::header::get_algorithm
json_traits::string_type get_algorithm() const
Definition jwt.h:2911
jwt::header::has_content_type
bool has_content_type() const noexcept
Definition jwt.h:2899
jwt::header::get_header_claim
basic_claim_t get_header_claim(const typename json_traits::string_type &name) const
Definition jwt.h:2945
jwt::header::get_key_id
json_traits::string_type get_key_id() const
Definition jwt.h:2932
jwt::header::get_content_type
json_traits::string_type get_content_type() const
Definition jwt.h:2925
jwt::header::has_key_id
bool has_key_id() const noexcept
Definition jwt.h:2904
jwt::helper::evp_pkey_handle
Handle class for EVP_PKEY structures.
Definition jwt.h:425
jwt::helper::evp_pkey_handle::evp_pkey_handle
constexpr evp_pkey_handle() noexcept=default
Creates a null key pointer.
jwt::helper::evp_pkey_handle::evp_pkey_handle
constexpr evp_pkey_handle(EVP_PKEY *key) noexcept
Construct a new handle. The handle takes ownership of the key.
Definition jwt.h:449
jwt::jwk
JSON Web Key.
Definition jwt.h:3823
jwt::jwk::has_x5c
bool has_x5c() const noexcept
Definition jwt.h:3979
jwt::jwk::get_curve
json_traits::string_type get_curve() const
Get curve claim.
Definition jwt.h:3886
jwt::jwk::has_x5t_sha256
bool has_x5t_sha256() const noexcept
Definition jwt.h:3991
jwt::jwk::get_algorithm
json_traits::string_type get_algorithm() const
Definition jwt.h:3866
jwt::jwk::get_x5c
json_traits::array_type get_x5c() const
Definition jwt.h:3894
jwt::jwk::get_claims
json_traits::object_type get_claims() const
Definition jwt.h:4020
jwt::jwk::get_x5t
json_traits::string_type get_x5t() const
Definition jwt.h:3910
jwt::jwk::get_x5c_key_value
json_traits::string_type get_x5c_key_value() const
Definition jwt.h:3926
jwt::jwk::get_x5t_sha256
json_traits::string_type get_x5t_sha256() const
Definition jwt.h:3918
jwt::jwk::get_key_id
json_traits::string_type get_key_id() const
Definition jwt.h:3874
jwt::jwk::has_algorithm
bool has_algorithm() const noexcept
Definition jwt.h:3955
jwt::jwk::get_use
json_traits::string_type get_use() const
Definition jwt.h:3850
jwt::jwk::has_key_id
bool has_key_id() const noexcept
Definition jwt.h:3967
jwt::jwk::has_x5u
bool has_x5u() const noexcept
Definition jwt.h:3973
jwt::jwk::has_key_operations
bool has_key_operations() const noexcept
Definition jwt.h:3949
jwt::jwk::empty
bool empty() const noexcept
Definition jwt.h:4014
jwt::jwk::has_use
bool has_use() const noexcept
Definition jwt.h:3943
jwt::jwk::has_x5t
bool has_x5t() const noexcept
Definition jwt.h:3985
jwt::jwk::has_jwk_claim
bool has_jwk_claim(const typename json_traits::string_type &name) const noexcept
Definition jwt.h:3997
jwt::jwk::get_key_operations
basic_claim_t::set_t get_key_operations() const
Definition jwt.h:3858
jwt::jwk::has_curve
bool has_curve() const noexcept
Definition jwt.h:3961
jwt::jwk::has_key_type
bool has_key_type() const noexcept
Definition jwt.h:3937
jwt::jwk::get_jwk_claim
basic_claim_t get_jwk_claim(const typename json_traits::string_type &name) const
Definition jwt.h:4006
jwt::jwk::get_x5u
json_traits::string_type get_x5u() const
Definition jwt.h:3902
jwt::jwk::get_key_type
json_traits::string_type get_key_type() const
Definition jwt.h:3842
jwt::jwks
JWK Set.
Definition jwt.h:4034
jwt::jwks::get_jwk
jwks_t get_jwk(const typename json_traits::string_type &key_id) const
Definition jwt.h:4086
jwt::jwks::jwks
jwks()=default
jwt::jwks::jwks_vector_t
std::vector< jwks_t > jwks_vector_t
Type specialization for the vector of JWK.
Definition jwt.h:4039
jwt::jwks::jwks
JWT_CLAIM_EXPLICIT jwks(const typename json_traits::string_type &str)
Definition jwt.h:4054
jwt::jwks::has_jwk
bool has_jwk(const typename json_traits::string_type &key_id) const noexcept
Definition jwt.h:4077
jwt::payload
Definition jwt.h:2761
jwt::payload::get_audience
basic_claim_t::set_t get_audience() const
Definition jwt.h:2823
jwt::payload::get_id
json_traits::string_type get_id() const
Definition jwt.h:2856
jwt::payload::has_issued_at
bool has_issued_at() const noexcept
Definition jwt.h:2797
jwt::payload::has_not_before
bool has_not_before() const noexcept
Definition jwt.h:2792
jwt::payload::has_payload_claim
bool has_payload_claim(const typename json_traits::string_type &name) const noexcept
Definition jwt.h:2861
jwt::payload::has_subject
bool has_subject() const noexcept
Definition jwt.h:2777
jwt::payload::get_not_before
date get_not_before() const
Definition jwt.h:2842
jwt::payload::has_issuer
bool has_issuer() const noexcept
Definition jwt.h:2772
jwt::payload::has_id
bool has_id() const noexcept
Definition jwt.h:2802
jwt::payload::has_expires_at
bool has_expires_at() const noexcept
Definition jwt.h:2787
jwt::payload::get_issued_at
date get_issued_at() const
Definition jwt.h:2849
jwt::payload::get_payload_claim
basic_claim_t get_payload_claim(const typename json_traits::string_type &name) const
Definition jwt.h:2869
jwt::payload::has_audience
bool has_audience() const noexcept
Definition jwt.h:2782
jwt::payload::get_expires_at
date get_expires_at() const
Definition jwt.h:2835
jwt::payload::get_subject
json_traits::string_type get_subject() const
Definition jwt.h:2816
jwt::payload::get_issuer
json_traits::string_type get_issuer() const
Definition jwt.h:2809
jwt::verifier
Definition jwt.h:3560
jwt::verifier::expires_at_leeway
verifier & expires_at_leeway(size_t leeway)
Definition jwt.h:3641
jwt::verifier::with_claim
verifier & with_claim(const typename json_traits::string_type &name, verify_check_fn_t fn)
Definition jwt.h:3740
jwt::verifier::verify
void verify(const decoded_jwt< json_traits > &jwt, std::error_code &ec) const
Definition jwt.h:3793
jwt::verifier::verify_check_fn_t
std::function< void(const verify_ops::verify_context< json_traits > &, std::error_code &ec)> verify_check_fn_t
Verification function data structure.
Definition jwt.h:3572
jwt::verifier::not_before_leeway
verifier & not_before_leeway(size_t leeway)
Definition jwt.h:3651
jwt::verifier::issued_at_leeway
verifier & issued_at_leeway(size_t leeway)
Definition jwt.h:3661
jwt::verifier::with_subject
verifier & with_subject(const typename json_traits::string_type &sub)
Definition jwt.h:3697
jwt::verifier::with_audience
verifier & with_audience(const typename basic_claim_t::set_t &aud)
Definition jwt.h:3706
jwt::verifier::with_claim
verifier & with_claim(const typename json_traits::string_type &name, basic_claim_t c)
Definition jwt.h:3755
jwt::verifier::with_audience
verifier & with_audience(const typename json_traits::string_type &aud)
Definition jwt.h:3716
jwt::verifier::verify
void verify(const decoded_jwt< json_traits > &jwt) const
Definition jwt.h:3783
jwt::verifier::verifier
verifier(Clock c)
Definition jwt.h:3602
jwt::verifier::leeway
verifier & leeway(size_t leeway)
Definition jwt.h:3631
jwt::verifier::with_issuer
verifier & with_issuer(const typename json_traits::string_type &iss)
Definition jwt.h:3687
jwt::verifier::allow_algorithm
verifier & allow_algorithm(Algorithm alg)
Add an algorithm available for checking.
Definition jwt.h:3773
jwt::verifier::with_type
verifier & with_type(const typename json_traits::string_type &type, std::locale locale=std::locale{})
Definition jwt.h:3677
jwt::verifier::with_id
verifier & with_id(const typename json_traits::string_type &id)
Definition jwt.h:3727
jwt::error::signature_verification_error
signature_verification_error
Errors related to verification of signatures.
Definition jwt.h:216
jwt::error::token_verification_error_category
std::error_category & token_verification_error_category()
Error category for token verification errors.
Definition jwt.h:351
jwt::error::throw_if_error
void throw_if_error(std::error_code ec)
Raises an exception if any JWT-CPP error codes are active.
Definition jwt.h:383
jwt::error::ecdsa_error_category
std::error_category & ecdsa_error_category()
Error category for ECDSA errors.
Definition jwt.h:179
jwt::error::signature_verification_error_category
std::error_category & signature_verification_error_category()
Error category for verification errors.
Definition jwt.h:230
jwt::error::rsa_error_category
std::error_category & rsa_error_category()
Error category for RSA errors.
Definition jwt.h:127
jwt::error::signature_generation_error_category
std::error_category & signature_generation_error_category()
Error category for signature generation errors.
Definition jwt.h:289
jwt::error::ecdsa_error
ecdsa_error
Errors related to processing of RSA signatures.
Definition jwt.h:159
jwt::error::rsa_error
rsa_error
Errors related to processing of RSA signatures.
Definition jwt.h:110
jwt::error::signature_generation_error
signature_generation_error
Errors related to signature generation errors.
Definition jwt.h:269
jwt::error::token_verification_error
token_verification_error
Errors related to token verification errors.
Definition jwt.h:339
jwt::error::make_error_code
std::error_code make_error_code(rsa_error e)
Converts JWT-CPP errors into generic STL error_codes.
Definition jwt.h:155
jwt::helper::extract_pubkey_from_cert
std::string extract_pubkey_from_cert(const std::string &certstr, const std::string &pw, std::error_code &ec)
Extract the public key of a pem certificate.
Definition jwt.h:542
jwt::helper::load_public_ec_key_from_string
evp_pkey_handle load_public_ec_key_from_string(const std::string &key, const std::string &password, std::error_code &ec)
Load a public key from a string.
Definition jwt.h:818
jwt::helper::load_public_key_from_string
evp_pkey_handle load_public_key_from_string(const std::string &key, const std::string &password, std::error_code &ec)
Load a public key from a string.
Definition jwt.h:714
jwt::helper::create_public_key_from_rsa_components
std::string create_public_key_from_rsa_components(const std::string &modulus, const std::string &exponent, Decode decode, std::error_code &ec)
create public key from modulus and exponent. This is defined in RFC 7518 Section 6....
Definition jwt.h:917
jwt::helper::raw2bn
std::unique_ptr< BIGNUM, decltype(&BN_free)> raw2bn(const std::string &raw, std::error_code &ec)
Definition jwt.h:847
jwt::helper::load_private_ec_key_from_string
evp_pkey_handle load_private_ec_key_from_string(const std::string &key, const std::string &password, std::error_code &ec)
Load a private key from a string.
Definition jwt.h:897
jwt::helper::curve2nid
int curve2nid(const std::string curve, std::error_code &ec)
Convert a curve name to an ID.
Definition jwt.h:1124
jwt::helper::convert_base64_der_to_pem
std::string convert_base64_der_to_pem(const std::string &cert_base64_der_str, Decode decode, std::error_code &ec)
Convert the certificate provided as base64 DER to PEM.
Definition jwt.h:628
jwt::helper::bn2raw
std::string bn2raw(const BIGNUM *bn)
Definition jwt.h:834
jwt::helper::create_public_key_from_ec_components
std::string create_public_key_from_ec_components(const std::string &curve, const std::string &x, const std::string &y, Decode decode, std::error_code &ec)
Definition jwt.h:1155
jwt::helper::load_private_key_from_string
evp_pkey_handle load_private_key_from_string(const std::string &key, const std::string &password, std::error_code &ec)
Load a private key from a string.
Definition jwt.h:772
jwt::helper::convert_der_to_pem
std::string convert_der_to_pem(const std::string &cert_der_str, std::error_code &ec)
Convert the certificate provided as DER to PEM.
Definition jwt.h:592
jwt::json::type
type
Categories for the various JSON types used in JWTs.
Definition jwt.h:2274
jwt
JSON Web Token.
Definition base.h:21
jwt::verify
verifier< Clock, json_traits > verify(Clock c)
Definition jwt.h:4109
jwt::date
std::chrono::system_clock::time_point date
Definition jwt.h:86
jwt::create
builder< Clock, json_traits > create(Clock c)
Definition jwt.h:4119
jwt::verify
verifier< default_clock, traits::boost_json > verify()
Definition defaults.h:23
jwt::parse_jwk
jwk< json_traits > parse_jwk(const typename json_traits::string_type &jwk_)
Definition jwt.h:4195
jwt::parse_jwks
jwks< json_traits > parse_jwks(const typename json_traits::string_type &jwks_)
Definition jwt.h:4209
jwt::decode
decoded_jwt< json_traits > decode(const typename json_traits::string_type &token, Decode decode)
Decode a token. This can be used to to help access important feild like 'x5c' for verifying tokens....
Definition jwt.h:4170
jwt::verify_context
verify_ops::verify_context< traits::boost_json > verify_context
Definition defaults.h:88
jwt::algorithm::ecdsa
Base class for ECDSA family of algorithms.
Definition jwt.h:1542
jwt::algorithm::ecdsa::verify
void verify(const std::string &data, const std::string &signature, std::error_code &ec) const
Definition jwt.h:1616
jwt::algorithm::ecdsa::sign
std::string sign(const std::string &data, std::error_code &ec) const
Definition jwt.h:1579
jwt::algorithm::ecdsa::ecdsa
ecdsa(const std::string &public_key, const std::string &private_key, const std::string &public_key_password, const std::string &private_key_password, const EVP_MD *(*md)(), std::string name, size_t siglen)
Definition jwt.h:1554
jwt::algorithm::ecdsa::name
std::string name() const
Definition jwt.h:1655
jwt::algorithm::ed25519
Definition jwt.h:2178
jwt::algorithm::ed25519::ed25519
ed25519(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2188
jwt::algorithm::ed448
Definition jwt.h:2200
jwt::algorithm::ed448::ed448
ed448(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2210
jwt::algorithm::eddsa
Base class for EdDSA family of algorithms.
Definition jwt.h:1773
jwt::algorithm::eddsa::name
std::string name() const
Definition jwt.h:1887
jwt::algorithm::eddsa::eddsa
eddsa(const std::string &public_key, const std::string &private_key, const std::string &public_key_password, const std::string &private_key_password, std::string name)
Definition jwt.h:1784
jwt::algorithm::eddsa::sign
std::string sign(const std::string &data, std::error_code &ec) const
Definition jwt.h:1800
jwt::algorithm::eddsa::verify
void verify(const std::string &data, const std::string &signature, std::error_code &ec) const
Definition jwt.h:1848
jwt::algorithm::es256
Definition jwt.h:2105
jwt::algorithm::es256::es256
es256(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2115
jwt::algorithm::es256k
Definition jwt.h:2156
jwt::algorithm::es256k::es256k
es256k(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2165
jwt::algorithm::es384
Definition jwt.h:2122
jwt::algorithm::es384::es384
es384(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2132
jwt::algorithm::es512
Definition jwt.h:2139
jwt::algorithm::es512::es512
es512(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2149
jwt::algorithm::hmacsha
Base class for HMAC family of algorithms.
Definition jwt.h:1372
jwt::algorithm::hmacsha::sign
std::string sign(const std::string &data, std::error_code &ec) const
Definition jwt.h:1389
jwt::algorithm::hmacsha::name
std::string name() const
Definition jwt.h:1429
jwt::algorithm::hmacsha::verify
void verify(const std::string &data, const std::string &signature, std::error_code &ec) const
Definition jwt.h:1410
jwt::algorithm::hmacsha::hmacsha
hmacsha(std::string key, const EVP_MD *(*md)(), std::string name)
Definition jwt.h:1380
jwt::algorithm::hs256
Definition jwt.h:2027
jwt::algorithm::hs256::hs256
hs256(std::string key)
Definition jwt.h:2032
jwt::algorithm::hs384
Definition jwt.h:2037
jwt::algorithm::hs384::hs384
hs384(std::string key)
Definition jwt.h:2042
jwt::algorithm::hs512
Definition jwt.h:2047
jwt::algorithm::hs512::hs512
hs512(std::string key)
Definition jwt.h:2052
jwt::algorithm::none
"none" algorithm.
Definition jwt.h:1347
jwt::algorithm::none::verify
void verify(const std::string &, const std::string &signature, std::error_code &ec) const
Check if the given signature is empty.
Definition jwt.h:1362
jwt::algorithm::none::name
std::string name() const
Get algorithm name.
Definition jwt.h:1367
jwt::algorithm::none::sign
std::string sign(const std::string &, std::error_code &ec) const
Return an empty string.
Definition jwt.h:1351
jwt::algorithm::ps256
Definition jwt.h:2219
jwt::algorithm::ps256::ps256
ps256(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2227
jwt::algorithm::ps384
Definition jwt.h:2234
jwt::algorithm::ps384::ps384
ps384(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2242
jwt::algorithm::ps512
Definition jwt.h:2249
jwt::algorithm::ps512::ps512
ps512(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2257
jwt::algorithm::pss
Base class for PSS-RSA family of algorithms.
Definition jwt.h:1899
jwt::algorithm::pss::name
std::string name() const
Definition jwt.h:2013
jwt::algorithm::pss::pss
pss(const std::string &public_key, const std::string &private_key, const std::string &public_key_password, const std::string &private_key_password, const EVP_MD *(*md)(), std::string name)
Definition jwt.h:1909
jwt::algorithm::pss::verify
void verify(const std::string &data, const std::string &signature, std::error_code &ec) const
Definition jwt.h:1974
jwt::algorithm::pss::sign
std::string sign(const std::string &data, std::error_code &ec) const
Definition jwt.h:1926
jwt::algorithm::rs256
Definition jwt.h:2059
jwt::algorithm::rs256::rs256
rs256(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Construct new instance of algorithm.
Definition jwt.h:2068
jwt::algorithm::rs384
Definition jwt.h:2075
jwt::algorithm::rs384::rs384
rs384(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2083
jwt::algorithm::rs512
Definition jwt.h:2090
jwt::algorithm::rs512::rs512
rs512(const std::string &public_key, const std::string &private_key="", const std::string &public_key_password="", const std::string &private_key_password="")
Definition jwt.h:2098
jwt::algorithm::rsa
Base class for RSA family of algorithms.
Definition jwt.h:1442
jwt::algorithm::rsa::verify
void verify(const std::string &data, const std::string &signature, std::error_code &ec) const
Definition jwt.h:1503
jwt::algorithm::rsa::sign
std::string sign(const std::string &data, std::error_code &ec) const
Definition jwt.h:1469
jwt::algorithm::rsa::rsa
rsa(const std::string &public_key, const std::string &private_key, const std::string &public_key_password, const std::string &private_key_password, const EVP_MD *(*md)(), std::string name)
Definition jwt.h:1453
jwt::algorithm::rsa::name
std::string name() const
Definition jwt.h:1529
jwt::default_clock
Definition jwt.h:4126
jwt::default_clock::now
date now() const
Definition jwt.h:4131
jwt::error::claim_not_present_exception
Definition jwt.h:2691
jwt::error::ecdsa_exception
Definition jwt.h:101
jwt::error::invalid_json_exception
Definition jwt.h:2685
jwt::error::rsa_exception
Definition jwt.h:98
jwt::error::signature_generation_exception
Definition jwt.h:95
jwt::error::signature_verification_exception
Definition jwt.h:92
jwt::error::token_verification_exception
Definition jwt.h:104
jwt::verify_ops::date_after_claim
Definition jwt.h:3458
jwt::verify_ops::date_before_claim
Definition jwt.h:3441
jwt::verify_ops::equals_claim
Definition jwt.h:3412
jwt::verify_ops::insensitive_string_claim
Definition jwt.h:3505
jwt::verify_ops::is_subset_claim
Definition jwt.h:3476
jwt::verify_ops::verify_context
Definition jwt.h:3341
jwt::verify_ops::verify_context::current_time
date current_time
Current time, retrieved from the verifiers clock and cached for performance and consistency.
Definition jwt.h:3345
jwt::verify_ops::verify_context::get_claim
basic_claim< json_traits > get_claim(bool in_header, json::type t, std::error_code &ec) const
Definition jwt.h:3382
jwt::verify_ops::verify_context::default_leeway
size_t default_leeway
The configured default leeway for this verification.
Definition jwt.h:3349
jwt::verify_ops::verify_context::get_claim
basic_claim< json_traits > get_claim(bool in_header, std::error_code &ec) const
Helper method to get a claim from the jwt in this context.
Definition jwt.h:3360
jwt::verify_ops::verify_context::get_claim
basic_claim< json_traits > get_claim(json::type t, std::error_code &ec) const
Helper method to get a payload claim of a specific type from the jwt.
Definition jwt.h:3403
jwt::verify_ops::verify_context::get_claim
basic_claim< json_traits > get_claim(std::error_code &ec) const
Helper method to get a payload claim from the jwt.
Definition jwt.h:3396
jwt::verify_ops::verify_context::claim_key
json_traits::string_type claim_key
The claim key to apply this comparison on.
Definition jwt.h:3352
jwt::verify_ops::verify_context::jwt
const decoded_jwt< json_traits > & jwt
The jwt passed to the verifier.
Definition jwt.h:3347