Merge branch 'master' into is-12

lo-simon · lo-simon · commit 0b1191d72b1d · 2024-02-15T13:13:33.000Z
diff --git a/Development/cmake/NmosCppTest.cmake b/Development/cmake/NmosCppTest.cmake
@@ -126,7 +126,7 @@ target_link_libraries(
     nmos-cpp::mdns
     nmos-cpp::cpprestsdk
     nmos-cpp::Boost
-	nmos-cpp::jwt-cpp
+    nmos-cpp::jwt-cpp
     )
 if(NMOS_CPP_BUILD_LLDP)
     target_link_libraries(
diff --git a/Development/conanfile.txt b/Development/conanfile.txt
@@ -2,7 +2,7 @@
 boost/1.83.0
 cpprestsdk/2.10.19
 websocketpp/0.8.2
-openssl/1.1.1s
+openssl/3.2.1
 json-schema-validator/2.3.0
 nlohmann_json/3.11.3
 zlib/1.2.13
diff --git a/Development/jwk/algorithm.h b/Development/jwk/algorithm.h
@@ -8,7 +8,7 @@ namespace jwk
     DEFINE_STRING_ENUM(algorithm)
     namespace algorithms
     {
-		// RS256/RS384/RS512
+        // RS256/RS384/RS512
         const algorithm RS256{ U("RS256") };
         const algorithm RS384{ U("RS384") };
         const algorithm RS512{ U("RS512") };
diff --git a/Development/nmos/api_utils.h b/Development/nmos/api_utils.h
@@ -53,8 +53,8 @@ namespace nmos
         const route_pattern connection_api = make_route_pattern(U("api"), U("connection"));
         // IS-07 Events API
         const route_pattern events_api = make_route_pattern(U("api"), U("events"));
-		// IS-08 Channel Mapping API
-		const route_pattern channelmapping_api = make_route_pattern(U("api"), U("channelmapping"));
+        // IS-08 Channel Mapping API
+        const route_pattern channelmapping_api = make_route_pattern(U("api"), U("channelmapping"));
         // IS-09 System API (originally specified in JT-NM TR-1001-1:2018 Annex A)
         const route_pattern system_api = make_route_pattern(U("api"), U("system"));
 
diff --git a/Development/nmos/ws_api_utils.cpp b/Development/nmos/ws_api_utils.cpp
@@ -56,5 +56,5 @@ namespace nmos
                 return true;
             };
         }
-	}
+    }
 }
diff --git a/Development/third_party/README.md b/Development/third_party/README.md
@@ -7,7 +7,7 @@ Third-party source files used by the nmos-cpp libraries
 - [cmake](cmake)  
   CMake modules derived from third-party sources
 - [jwt-cpp](jwt-cpp)  
-  The [C++ JSON Web Tokens creator and validator] (https://github.com/Thalhammer/jwt-cpp) header only library
+  The [Thalhammer/jwt-cpp](https://github.com/Thalhammer/jwt-cpp) header only library for creating and validating JSON Web Tokens in C++11
 - [mDNSResponder](mDNSResponder)  
   Patches and patched source files for the Bonjour DNS-SD implementation
 - [nlohmann](nlohmann)  
diff --git a/Development/third_party/jwt-cpp/README.md b/Development/third_party/jwt-cpp/README.md
@@ -1,155 +1,8 @@
-<img src="https://raw.githubusercontent.com/Thalhammer/jwt-cpp/master/.github/logo.svg" alt="logo" width="100%">
+# jwt-cpp
 
-[![License Badge](https://img.shields.io/github/license/Thalhammer/jwt-cpp)](https://github.com/Thalhammer/jwt-cpp/blob/master/LICENSE)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5f7055e294744901991fd0a1620b231d)](https://app.codacy.com/gh/Thalhammer/jwt-cpp/dashboard)
-[![Linux Badge][Linux]][Cross-Platform]
-[![MacOS Badge][MacOS]][Cross-Platform]
-[![Windows Badge][Windows]][Cross-Platform]
-[![Coverage Status](https://coveralls.io/repos/github/Thalhammer/jwt-cpp/badge.svg?branch=master)](https://coveralls.io/github/Thalhammer/jwt-cpp?branch=master)
+This directory contains files from the [Thalhammer/jwt-cpp](https://github.com/Thalhammer/jwt-cpp) header only library for creating and validating JSON Web Tokens in C++11.
 
-[![Documentation Badge](https://img.shields.io/badge/Documentation-master-blue)](https://thalhammer.github.io/jwt-cpp/)
+Original source code:
 
-[![Stars Badge](https://img.shields.io/github/stars/Thalhammer/jwt-cpp)](https://github.com/Thalhammer/jwt-cpp/stargazers)
-[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/Thalhammer/jwt-cpp?include_prereleases)](https://github.com/Thalhammer/jwt-cpp/releases)
-[![ConanCenter package](https://repology.org/badge/version-for-repo/conancenter/jwt-cpp.svg)](https://repology.org/project/jwt-cpp/versions)
-[![Vcpkg package](https://repology.org/badge/version-for-repo/vcpkg/jwt-cpp.svg)](https://repology.org/project/jwt-cpp/versions)
-
-[Linux]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/cross-platform/ubuntu-latest/shields.json
-[MacOS]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/cross-platform/macos-latest/shields.json
-[Windows]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/cross-platform/windows-latest/shields.json
-[Cross-Platform]: https://github.com/Thalhammer/jwt-cpp/actions?query=workflow%3A%22Cross-Platform+CI%22
-
-A header only library for creating and validating [JSON Web Tokens](https://tools.ietf.org/html/rfc7519) in C++11. For a great introduction, [read this](https://jwt.io/introduction/).
-
-## Signature algorithms
-
-jwt-cpp supports all the algorithms defined by the specifications. The modular design allows to easily add additional algorithms without any problems. If you need any feel free to create a pull request or [open an issue](https://github.com/Thalhammer/jwt-cpp/issues/new).
-
-For completeness, here is a list of all supported algorithms:
-
-| HMSC  | RSA   | ECDSA  | PSS   | EdDSA   |
-|-------|-------|--------|-------|---------|
-| HS256 | RS256 | ES256  | PS256 | Ed25519 |
-| HS384 | RS384 | ES384  | PS384 | Ed448   |
-| HS512 | RS512 | ES512  | PS512 |         |
-|       |       | ES256K |       |         |
-
-## SSL Compatibility
-
-In the name of flexibility and extensibility, jwt-cpp supports [OpenSSL](https://github.com/openssl/openssl), [LibreSSL](https://github.com/libressl-portable/portable), and [wolfSSL](https://github.com/wolfSSL/wolfssl). Read [this page](docs/ssl.md) for more details. These are the version which are currently being tested:
-
-| OpenSSL           | LibreSSL       | wolfSSL        |
-|-------------------|----------------|----------------|
-| ![1.0.2u][o1.0.2] | ![3.3.6][l3.3] | ![5.1.1][w5.1] |
-| ![1.1.0i][o1.1.0] | ![3.4.3][l3.4] | ![5.2.0][w5.2] |
-| ![1.1.1q][o1.1.1] | ![3.5.3][l3.5] | ![5.3.0][w5.3] |
-| ![3.0.5][o3.0]    |                |                |
-
-> ℹ️ Note: A complete list of versions tested in the past can be found [here](https://github.com/Thalhammer/jwt-cpp/tree/badges).
-
-[o1.0.2]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/openssl/1.0.2u/shields.json
-[o1.1.0]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/openssl/1.1.0i/shields.json
-[o1.1.1]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/openssl/1.1.1q/shields.json
-[o3.0]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/openssl/3.0.5/shields.json
-[l3.3]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/libressl/3.3.6/shields.json
-[l3.4]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/libressl/3.4.3/shields.json
-[l3.5]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/libressl/3.5.3/shields.json
-[w5.1]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/wolfssl/5.1.1/shields.json
-[w5.2]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/wolfssl/5.2.0/shields.json
-[w5.3]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/wolfssl/5.3.0/shields.json
-
-## Overview
-
-There is no hard dependency on a JSON library. Instead, there's a generic `jwt::basic_claim` which is templated around type traits, which described the semantic [JSON types](https://json-schema.org/understanding-json-schema/reference/type.html) for a value, object, array, string, number, integer and boolean, as well as methods to translate between them.
-
-```cpp
-jwt::basic_claim<my_favorite_json_library_traits> claim(json::object({{"json", true},{"example", 0}}));
-```
-
-This allows for complete freedom when picking which libraries you want to use. For more information, [read this page](docs/traits.md)).
-
-For your convenience there are serval traits implementation which provide some popular JSON libraries. They are:
-
-[![picojson][picojson]](https://github.com/kazuho/picojson)
-[![nlohmann][nlohmann]](https://github.com/nlohmann/json)
-[![jsoncons][jsoncons]](https://github.com/danielaparker/jsoncons)
-[![boostjson][boostjson]](https://github.com/boostorg/json)
-
-[picojson]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/traits/kazuho-picojson/shields.json
-[nlohmann]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/traits/nlohmann-json/shields.json
-[jsoncons]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/traits/danielaparker-jsoncons/shields.json
-[boostjson]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/traits/boost-json/shields.json
-
-In order to maintain compatibility, [picojson](https://github.com/kazuho/picojson) is still used to provide a specialized `jwt::claim` along with all helpers. Defining `JWT_DISABLE_PICOJSON` will remove this optional dependency. It's possible to directly include the traits defaults for the other JSON libraries. See the [traits examples](https://github.com/Thalhammer/jwt-cpp/tree/master/example/traits) for details.
-
-As for the base64 requirements of JWTs, this library provides `base.h` with all the required implementation; However base64 implementations are very common, with varying degrees of performance. When providing your own base64 implementation, you can define `JWT_DISABLE_BASE64` to remove the jwt-cpp implementation.
-
-### Getting Started
-
-Simple example of decoding a token and printing all [claims](https://tools.ietf.org/html/rfc7519#section-4) ([try it out](https://github.com/Thalhammer/jwt-cpp/tree/master/example/print-claims.cpp)):
-
-```cpp
-#include <jwt-cpp/jwt.h>
-#include <iostream>
-
-int main() {
-    std::string token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJpc3MiOiJhdXRoMCJ9.AbIJTDMFc7yUa5MhvcP03nJPyCPzZtQcGEp-zWfOkEE";
-    auto decoded = jwt::decode(token);
-
-    for(auto& e : decoded.get_payload_json())
-        std::cout << e.first << " = " << e.second << std::endl;
-}
-```
-
-In order to verify a token you first build a verifier and use it to verify a decoded token.
-
-```cpp
-auto verifier = jwt::verify()
-    .allow_algorithm(jwt::algorithm::hs256{ "secret" })
-    .with_issuer("auth0");
-
-verifier.verify(decoded_token);
-```
-
-The created verifier is stateless so you can reuse it for different tokens.
-
-Creating a token (and signing) is equally as easy.
-
-```cpp
-auto token = jwt::create()
-    .set_issuer("auth0")
-    .set_type("JWS")
-    .set_payload_claim("sample", jwt::claim(std::string("test")))
-    .sign(jwt::algorithm::hs256{"secret"});
-```
-
-> To see more examples working with RSA public and private keys, visit our [examples](https://github.com/Thalhammer/jwt-cpp/tree/master/example)!
-
-### Providing your own JSON Traits
-
-To learn how to writes a trait's implementation, checkout the [these instructions](docs/traits.md)
-
-## Contributing
-
-If you have an improvement or found a bug feel free to [open an issue](https://github.com/Thalhammer/jwt-cpp/issues/new) or add the change and create a pull request. If you file a bug please make sure to include as much information about your environment (compiler version, etc.) as possible to help reproduce the issue. If you add a new feature please make sure to also include test cases for it.
-
-## Dependencies
-
-In order to use jwt-cpp you need the following tools.
-
-* libcrypto (openssl or compatible)
-* libssl-dev (for the header files)
-* a compiler supporting at least c++11
-* basic stl support
-
-In order to build the test cases you also need
-
-* gtest
-* pthread
-
-## Troubleshooting
-
-See the [FAQs](docs/faqs.md) for tips.
-
-## Conference Coverage
-[![CppCon](https://img.youtube.com/vi/Oq4NW5idmiI/0.jpg)](https://www.youtube.com/watch?v=Oq4NW5idmiI)
+- Licensed under the MIT License <http://opensource.org/licenses/MIT>.
+- Copyright (c) 2018 Dominik Thalhammer
diff --git a/Documents/Dependencies.md b/Documents/Dependencies.md
@@ -12,6 +12,7 @@ More details are given below.
   - This library incorporates some third-party material including WebSocket++, and also relies on e.g. some of the Boost C++ Libraries and [OpenSSL](https://www.openssl.org/).
 - The [WebSocket++](https://github.com/zaphoyd/websocketpp) header-only C++ websocket client/server library, to implement Query API websocket subscriptions
 - For JSON Schema validation, the [Modern C++ JSON schema validator](https://github.com/pboettch/json-schema-validator) library, which is implemented on top of [JSON for Modern C++](https://github.com/nlohmann/json)
+- For creating and validating JSON Web Tokens, the [Thalhammer/jwt-cpp](https://github.com/Thalhammer/jwt-cpp) header only library
 - For DNS Service Discovery (DNS-SD), the [Bonjour SDK](https://developer.apple.com/bonjour/) on Windows, and on Linux either [Avahi](https://www.avahi.org/) or Apple's [mDNSResponder](https://opensource.apple.com/tarballs/mDNSResponder/) (another name for Bonjour)
 - The [Catch](https://github.com/philsquared/Catch) automated test framework, for unit testing
 
@@ -54,7 +55,7 @@ By default nmos-cpp uses [Conan](https://conan.io) to download most of its depen
 
 1. Install Python 3 if necessary  
    Note: The Python scripts directory needs to be added to the `PATH`, so the Conan executable can be found
-2. Install or upgrade Conan using `pip install --upgrade conan~=1.47`
+2. Install or upgrade Conan using `pip install --upgrade conan~=1.47`  
    Notes:
    - On some platforms with Python 2 and Python 3 both installed this may need to be `pip3 install --upgrade conan~=1.47`
    - Currently, Conan 1.47 or higher (and lower than version 2.0) is required by the nmos-cpp recipe; dependencies may require a higher version; version 1.59.0 has been tested
@@ -152,8 +153,8 @@ If using Conan, this section can be skipped.
      - Set ``Boost_USE_STATIC_LIBS`` (BOOL) to ``1`` (true)
    - If CMake cannot find it automatically, set hints for [finding Boost](https://cmake.org/cmake/help/latest/module/FindBoost.html), for example:
      - *Either* set ``Boost_DIR`` (PATH) to the location of the installed BoostConfig.cmake (since Boost 1.70.0)
-     - *Or* set ``BOOST_INCLUDEDIR`` (PATH) and ``BOOST_LIBRARYDIR`` (PATH) to the appropriate full paths, e.g. *``<home-dir>``*``/boost_1_80_0``
-       and *``<home-dir>``*``/boost_1_80_0/x64/lib`` respectively to match the suggested ``b2`` command
+     - *Or* set ``BOOST_INCLUDEDIR`` (PATH) and ``BOOST_LIBRARYDIR`` (PATH) to the appropriate full paths, e.g. *``<home-dir>``*``/boost_1_83_0``
+       and *``<home-dir>``*``/boost_1_83_0/x64/lib`` respectively to match the suggested ``b2`` command
    - Due to interactions with other dependencies, it may also be necessary to explicitly set ``WERROR`` (BOOL) to ``0`` so that compiler warnings are not treated as errors
    - To speed up the build by omitting the C++ REST SDK sample apps and test suite, set ``BUILD_SAMPLES`` and ``BUILD_TESTS`` (BOOL) to ``0`` (false)
 3. Use CMake to generate build/project files, and then build *and* install  
@@ -172,8 +173,8 @@ cmake .. ^
   -DCPPREST_EXCLUDE_COMPRESSION:BOOL="1" ^
   -DCMAKE_CONFIGURATION_TYPES:STRING="Debug;Release" ^
   -DBoost_USE_STATIC_LIBS:BOOL="1" ^
-  -DBOOST_INCLUDEDIR:PATH="<home-dir>/boost_1_80_0" ^
-  -DBOOST_LIBRARYDIR:PATH="<home-dir>/boost_1_80_0/x64/lib" ^
+  -DBOOST_INCLUDEDIR:PATH="<home-dir>/boost_1_83_0" ^
+  -DBOOST_LIBRARYDIR:PATH="<home-dir>/boost_1_83_0/x64/lib" ^
   -DWERROR:BOOL="0" ^
   -DBUILD_SAMPLES:BOOL="0" ^
   -DBUILD_TESTS:BOOL="0"
@@ -234,15 +235,17 @@ If using Conan, this section can be skipped.
 <summary>If not using Conan...</summary>
 
 The C++ REST SDK depends on [OpenSSL](https://www.openssl.org/) (to implement secure HTTP and/or secure WebSockets).
-It is compatible with the OpenSSL 1.1 API, so the 1.1.1 Long Term Support (LTS) release is recommended.
-It is also possible to use OpenSSL 1.0, but the OpenSSL team announced that [users of that release are strongly advised to upgrade to OpenSSL 1.1.1](https://www.openssl.org/blog/blog/2018/09/11/release111/).
+The nmos-cpp codebase also uses OpenSSL directly to implement the specific requirements of [AMWA BCP-003-01 Secure Communication in NMOS Systems](https://specs.amwa.tv/bcp-003-01/) and [AMWA BCP-003-02 Authorization in NMOS Systems](https://specs.amwa.tv/bcp-003-02/).
 
-1. Download and install a recent release
+OpenSSL version 3 is recommended, and version 3.2.1 (latest release at the time) has been tested.
+It is currently also possible to use OpenSSL v1.1.1, although [this OpenSSL release is now end of life](https://www.openssl.org/blog/blog/2023/09/11/eol-111/index.html).
+
+1. Download and install a recent release  
    Notes:
    - On Windows, an installer can be downloaded from [Shining Light Productions - Win32 OpenSSL](https://slproweb.com/products/Win32OpenSSL.html)  
-     The Win64 OpenSSL v1.1.1s installer (latest release at the time) has been tested
+     The Win64 OpenSSL v3.2.1 installer (latest release at the time) has been tested
    - On Linux distributions, an OpenSSL package may already be available  
-     The Ubuntu team announced an [OpenSSL 1.1.1 stable release update (SRU) for Ubuntu 18.04 LTS](https://lists.ubuntu.com/archives/ubuntu-devel/2018-December/040567.html)
+     For example, Ubuntu 22.04 LTS includes OpenSSL v3.0.2
 
 </details>
 
@@ -257,6 +260,17 @@ No installation is necessary.
 
 </details>
 
+### jwt-cpp
+
+If using Conan, this section can be skipped.
+<details>
+<summary>If not using Conan...</summary>
+
+A copy of the source code necessary to use this library is included in the [third_party/jwt-cpp](../Development/third_party/jwt-cpp) directory.
+No installation is necessary.
+
+</details>
+
 ### DNS Service Discovery
 
 **Windows**
diff --git a/Documents/Getting-Started.md b/Documents/Getting-Started.md
@@ -32,8 +32,8 @@ Notes:
 
      - If CMake cannot find it automatically, set hints for [finding Boost](https://cmake.org/cmake/help/latest/module/FindBoost.html), for example:
        - *Either* set ``Boost_DIR`` (PATH) to the location of the installed *BoostConfig.cmake* (since Boost 1.70.0)
-       - *Or* set ``BOOST_INCLUDEDIR`` (PATH) and ``BOOST_LIBRARYDIR`` (PATH) to the appropriate full paths, e.g. *``<home-dir>``*``/boost_1_80_0``
-         and *``<home-dir>``*``/boost_1_80_0/x64/lib`` respectively to match the suggested ``b2`` command
+       - *Or* set ``BOOST_INCLUDEDIR`` (PATH) and ``BOOST_LIBRARYDIR`` (PATH) to the appropriate full paths, e.g. *``<home-dir>``*``/boost_1_83_0``
+         and *``<home-dir>``*``/boost_1_83_0/x64/lib`` respectively to match the suggested ``b2`` command
      - If CMake cannot find them automatically, set hints for finding the C++ REST SDK and WebSocket++, for example:
        - Set ``cpprestsdk_DIR`` (PATH) to the location of the installed *cpprestsdk-config.cmake*
        - *Either* set ``websocketpp_DIR`` (PATH) to the location of the installed *websocketpp-config.cmake*
@@ -75,8 +75,8 @@ cmake .. ^
   -G "Visual Studio 16 2019" ^
   -DCMAKE_CONFIGURATION_TYPES:STRING="Debug;Release" ^
   -DBoost_USE_STATIC_LIBS:BOOL="1" ^
-  -DBOOST_INCLUDEDIR:PATH="<home-dir>/boost_1_80_0" ^
-  -DBOOST_LIBRARYDIR:PATH="<home-dir>/boost_1_80_0/x64/lib" ^
+  -DBOOST_INCLUDEDIR:PATH="<home-dir>/boost_1_83_0" ^
+  -DBOOST_LIBRARYDIR:PATH="<home-dir>/boost_1_83_0/x64/lib" ^
   -DWEBSOCKETPP_INCLUDE_DIR:PATH="<home-dir>/cpprestsdk/Release/libs/websocketpp"
 ```
 

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ target_link_libraries(`
`126`	`126`	`nmos-cpp::mdns`
`127`	`127`	`nmos-cpp::cpprestsdk`
`128`	`128`	`nmos-cpp::Boost`
`129`		`- nmos-cpp::jwt-cpp`
	`129`	`+ nmos-cpp::jwt-cpp`
`130`	`130`	`)`
`131`	`131`	`if(NMOS_CPP_BUILD_LLDP)`
`132`	`132`	`target_link_libraries(`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace jwk`
`8`	`8`	`DEFINE_STRING_ENUM(algorithm)`
`9`	`9`	`namespace algorithms`
`10`	`10`	`{`
`11`		`- // RS256/RS384/RS512`
	`11`	`+ // RS256/RS384/RS512`
`12`	`12`	`const algorithm RS256{ U("RS256") };`
`13`	`13`	`const algorithm RS384{ U("RS384") };`
`14`	`14`	`const algorithm RS512{ U("RS512") };`
Original file line number	Diff line number	Diff line change
`@@ -56,5 +56,5 @@ namespace nmos`
`56`	`56`	`return true;`
`57`	`57`	`};`
`58`	`58`	`}`
`59`		`- }`
	`59`	`+ }`
`60`	`60`	`}`