jwt_key_auto_refresh.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache 2.0 License.
#pragma once
 
#include "ccf/service/tables/jwt.h"
#include "http/http_builder.h"
#include "http/http_rpc_context.h"
#include "node/rpc/node_frontend.h"
 
#define FMT_HEADER_ONLY
#include <fmt/format.h>
 
namespace ccf
{
  class JwtKeyAutoRefresh
  {
  private:
    size_t refresh_interval_s;
    NetworkState& network;
    std::shared_ptr<ccf::kv::Consensus> consensus;
    std::shared_ptr<ccf::RPCSessions> rpcsessions;
    std::shared_ptr<ccf::RPCMap> rpc_map;
    ccf::crypto::ECKeyPairPtr node_sign_kp;
    ccf::crypto::Pem node_cert;
    std::atomic_size_t attempts;
 
    ccf::tasks::Task periodic_refresh_task;
 
  public:
    JwtKeyAutoRefresh(
      size_t refresh_interval_s,
      NetworkState& network,
      const std::shared_ptr<ccf::kv::Consensus>& consensus,
      const std::shared_ptr<ccf::RPCSessions>& rpcsessions,
      const std::shared_ptr<ccf::RPCMap>& rpc_map,
      ccf::crypto::ECKeyPairPtr node_sign_kp,
      ccf::crypto::Pem node_cert) :
      refresh_interval_s(refresh_interval_s),
      network(network),
      consensus(consensus),
      rpcsessions(rpcsessions),
      rpc_map(rpc_map),
      node_sign_kp(std::move(node_sign_kp)),
      node_cert(std::move(node_cert)),
      attempts(0)
    {}
 
    ~JwtKeyAutoRefresh()
    {
      stop();
    }
 
    void start()
    {
      LOG_DEBUG_FMT("JWT key initial auto-refresh");
      periodic_refresh_task = ccf::tasks::make_basic_task([this]() {
        if (!this->consensus->can_replicate())
        {
          LOG_DEBUG_FMT("JWT key auto-refresh: Node is not primary, skipping");
        }
        else
        {
          this->refresh_jwt_keys();
        }
 
        LOG_DEBUG_FMT(
          "JWT key auto-refresh: Scheduling in {}s", this->refresh_interval_s);
      });
 
      const std::chrono::seconds period(refresh_interval_s);
      ccf::tasks::add_periodic_task(periodic_refresh_task, period, period);
    }
 
    void stop()
    {
      if (periodic_refresh_task != nullptr)
      {
        periodic_refresh_task->cancel_task();
      }
    }
 
    void schedule_once()
    {
      LOG_DEBUG_FMT("JWT key one-off refresh: Scheduling without delay");
      ccf::tasks::add_task(ccf::tasks::make_basic_task([this]() {
        if (!this->consensus->can_replicate())
        {
          LOG_DEBUG_FMT(
            "JWT key one-off refresh: Node is not primary, skipping");
        }
        else
        {
          this->refresh_jwt_keys();
        }
      }));
    }
 
    template <typename T>
    void send_refresh_jwt_keys(T msg)
    {
      ::http::Request request(fmt::format(
        "/{}/{}",
        ccf::get_actor_prefix(ccf::ActorsType::nodes),
        "jwt_keys/refresh"));
      request.set_header(
        http::headers::CONTENT_TYPE, http::headervalues::contenttype::JSON);
 
      auto body = nlohmann::json(msg).dump();
      request.set_body(body);
 
      auto packed = request.build_request();
 
      auto node_session = std::make_shared<ccf::SessionContext>(
        ccf::InvalidSessionId, node_cert.raw());
      auto ctx = ccf::make_rpc_context(node_session, packed);
 
      std::shared_ptr<ccf::RpcHandler> search =
        ::http::fetch_rpc_handler(ctx, this->rpc_map);
 
      search->process(ctx);
    }
 
    void send_refresh_jwt_keys_error()
    {
      // A message that the endpoint fails to parse, leading to 500.
      // This is done purely for exposing errors as endpoint metrics.
      auto msg = false;
      send_refresh_jwt_keys(msg);
    }
 
    void handle_jwt_jwks_response(
      const std::string& issuer,
      const std::optional<std::string>& issuer_constraint,
      ccf::http_status status,
      std::vector<uint8_t>&& data)
    {
      if (status != HTTP_STATUS_OK)
      {
        LOG_FAIL_FMT(
          "JWT key auto-refresh: Error while requesting JWKS: {} {}{}",
          status,
          ccf::http_status_str(status),
          data.empty() ?
            "" :
            fmt::format("  '{}'", std::string(data.begin(), data.end())));
        send_refresh_jwt_keys_error();
        return;
      }
 
      LOG_DEBUG_FMT(
        "JWT key auto-refresh: Received JWKS for issuer '{}'", issuer);
 
      JsonWebKeySet jwks;
      try
      {
        jwks = nlohmann::json::parse(data).get<JsonWebKeySet>();
      }
      catch (const std::exception& e)
      {
        LOG_FAIL_FMT(
          "JWT key auto-refresh: Cannot parse JWKS for issuer '{}': {}",
          issuer,
          e.what());
        send_refresh_jwt_keys_error();
        return;
      }
 
      // call internal endpoint to update keys
      auto msg = SetJwtPublicSigningKeys{issuer, jwks};
 
      // For each key we leave the specified issuer constraint or set a common
      // one otherwise (if present).
      if (issuer_constraint.has_value())
      {
        for (auto& key : jwks.keys)
        {
          if (!key.issuer.has_value())
          {
            key.issuer = issuer_constraint;
          }
        }
      }
 
      send_refresh_jwt_keys(msg);
    }
 
    void handle_jwt_metadata_response(
      const std::string& issuer,
      std::shared_ptr<::tls::CA> ca,
      ccf::http_status status,
      std::vector<uint8_t>&& data)
    {
      if (status != HTTP_STATUS_OK)
      {
        LOG_FAIL_FMT(
          "JWT key auto-refresh: Error while requesting OpenID metadata: {} "
          "{}{}",
          status,
          ccf::http_status_str(status),
          data.empty() ?
            "" :
            fmt::format("  '{}'", std::string(data.begin(), data.end())));
        send_refresh_jwt_keys_error();
        return;
      }
 
      LOG_DEBUG_FMT(
        "JWT key auto-refresh: Received OpenID metadata for issuer '{}'",
        issuer);
 
      std::string jwks_url_str;
      nlohmann::json metadata;
      try
      {
        metadata = nlohmann::json::parse(data);
        jwks_url_str = metadata.at("jwks_uri").get<std::string>();
      }
      catch (const std::exception& e)
      {
        LOG_FAIL_FMT(
          "JWT key auto-refresh: Cannot parse OpenID metadata for issuer '{}': "
          "{}",
          issuer,
          e.what());
        send_refresh_jwt_keys_error();
        return;
      }
      ::http::URL jwks_url;
      try
      {
        jwks_url = ::http::parse_url_full(jwks_url_str);
      }
      catch (const std::invalid_argument& e)
      {
        LOG_FAIL_FMT(
          "JWT key auto-refresh: Cannot parse jwks_uri for issuer '{}': {}",
          issuer,
          jwks_url_str);
        send_refresh_jwt_keys_error();
        return;
      }
      auto jwks_url_port = !jwks_url.port.empty() ? jwks_url.port : "443";
 
      auto ca_cert = std::make_shared<::tls::Cert>(
        ca, std::nullopt, std::nullopt, jwks_url.host);
 
      std::optional<std::string> issuer_constraint{std::nullopt};
      const auto constraint = metadata.find("issuer");
      if (constraint != metadata.end())
      {
        issuer_constraint = *constraint;
      }
 
      LOG_DEBUG_FMT(
        "JWT key auto-refresh: Requesting JWKS at https://{}:{}{}",
        jwks_url.host,
        jwks_url_port,
        jwks_url.path);
      auto http_client = rpcsessions->create_client(ca_cert);
      // Note: Connection errors are not signalled and hence not tracked in
      // endpoint metrics currently.
      http_client->connect(
        std::string(jwks_url.host),
        std::string(jwks_url_port),
        [this, issuer, issuer_constraint](
          ccf::http_status status,
          http::HeaderMap&&,
          std::vector<uint8_t>&& data) {
          handle_jwt_jwks_response(
            issuer, issuer_constraint, status, std::move(data));
          return true;
        });
      ::http::Request r(jwks_url.path, HTTP_GET);
      r.set_header(ccf::http::headers::HOST, std::string(jwks_url.host));
      http_client->send_request(std::move(r));
    }
 
    void refresh_jwt_keys()
    {
      auto tx = network.tables->create_read_only_tx();
      auto* jwt_issuers = tx.ro(network.jwt_issuers);
      auto* ca_cert_bundles = tx.ro(network.ca_cert_bundles);
      jwt_issuers->foreach([this, &ca_cert_bundles](
                             const JwtIssuer& issuer,
                             const JwtIssuerMetadata& metadata) {
        if (!metadata.auto_refresh)
        {
          LOG_DEBUG_FMT(
            "JWT key auto-refresh: Skipping issuer '{}', auto-refresh is "
            "disabled",
            issuer);
          return true;
        }
 
        // Increment attempts, only when auto-refresh is enabled.
        attempts++;
 
        LOG_DEBUG_FMT(
          "JWT key auto-refresh: Refreshing keys for issuer '{}'", issuer);
        const auto& ca_cert_bundle_name = metadata.ca_cert_bundle_name.value();
        auto ca_cert_bundle_pem = ca_cert_bundles->get(ca_cert_bundle_name);
        if (!ca_cert_bundle_pem.has_value())
        {
          LOG_FAIL_FMT(
            "JWT key auto-refresh: CA cert bundle with name '{}' for issuer "
            "'{}' not "
            "found",
            ca_cert_bundle_name,
            issuer);
          send_refresh_jwt_keys_error();
          return true;
        }
 
        auto metadata_url_str = issuer + "/.well-known/openid-configuration";
        auto metadata_url = ::http::parse_url_full(metadata_url_str);
        auto metadata_url_port =
          !metadata_url.port.empty() ? metadata_url.port : "443";
 
        auto ca_pems =
          crypto::split_x509_cert_bundle(ca_cert_bundle_pem.value());
        auto ca = std::make_shared<::tls::CA>(ca_pems);
        auto ca_cert = std::make_shared<::tls::Cert>(
          ca, std::nullopt, std::nullopt, metadata_url.host);
 
        LOG_DEBUG_FMT(
          "JWT key auto-refresh: Requesting OpenID metadata at https://{}:{}{}",
          metadata_url.host,
          metadata_url_port,
          metadata_url.path);
        auto http_client = rpcsessions->create_client(ca_cert);
        // Note: Connection errors are not signalled and hence not tracked in
        // endpoint metrics currently.
        http_client->connect(
          std::string(metadata_url.host),
          std::string(metadata_url_port),
          [this, issuer, ca](
            ccf::http_status status,
            ccf::http::HeaderMap&&,
            std::vector<uint8_t>&& data) {
            handle_jwt_metadata_response(issuer, ca, status, std::move(data));
            return true;
          });
        ::http::Request r(metadata_url.path, HTTP_GET);
        r.set_header(ccf::http::headers::HOST, std::string(metadata_url.host));
        http_client->send_request(std::move(r));
        return true;
      });
    }
 
    // Returns a copy of the current attempts
    [[nodiscard]] size_t get_attempts() const
    {
      return attempts.load();
    }
  };
}