node_info.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/crypto/pem.h"
#include "ccf/ds/json.h"
#include "ccf/ds/quote_info.h"
#include "ccf/kv/version.h"
#include "ccf/service/node_info_network.h"
 
#define FMT_HEADER_ONLY
#include <fmt/format.h>
#include <optional>
 
namespace ccf
{
  enum class NodeStatus
  {
    PENDING = 0,
    TRUSTED = 1,
    RETIRED = 2
  };
  DECLARE_JSON_ENUM(
    NodeStatus,
    {{NodeStatus::PENDING, "Pending"},
     {NodeStatus::TRUSTED, "Trusted"},
     {NodeStatus::RETIRED, "Retired"}});
 
  struct NodeInfo : NodeInfoNetwork
  {
    QuoteInfo quote_info;
    ccf::crypto::Pem encryption_pub_key;
    NodeStatus status = NodeStatus::PENDING;
 
    std::optional<ccf::kv::Version> ledger_secret_seqno = std::nullopt;
 
    std::optional<std::string> code_digest = std::nullopt;
 
    std::optional<ccf::crypto::Pem> certificate_signing_request = std::nullopt;
 
    std::optional<ccf::crypto::Pem> public_key = std::nullopt;
 
    nlohmann::json node_data = nullptr;
 
    std::optional<ccf::crypto::Pem> cert = std::nullopt;
 
    bool retired_committed = false;
  };
  DECLARE_JSON_TYPE_WITH_BASE_AND_OPTIONAL_FIELDS(NodeInfo, NodeInfoNetwork);
  DECLARE_JSON_REQUIRED_FIELDS(
    NodeInfo, quote_info, encryption_pub_key, status);
  DECLARE_JSON_OPTIONAL_FIELDS(
    NodeInfo,
    cert,
    ledger_secret_seqno,
    code_digest,
    certificate_signing_request,
    public_key,
    node_data,
    retired_committed);
}
 
FMT_BEGIN_NAMESPACE
template <>
struct formatter<ccf::NodeStatus>
{
  template <typename ParseContext>
  constexpr auto parse(ParseContext& ctx)
  {
    return ctx.begin();
  }
 
  template <typename FormatContext>
  auto format(const ccf::NodeStatus& state, FormatContext& ctx) const
    -> decltype(ctx.out())
  {
    switch (state)
    {
      case (ccf::NodeStatus::PENDING):
      {
        return format_to(ctx.out(), "PENDING");
      }
      case (ccf::NodeStatus::TRUSTED):
      {
        return format_to(ctx.out(), "TRUSTED");
      }
      case (ccf::NodeStatus::RETIRED):
      {
        return format_to(ctx.out(), "RETIRED");
      }
    }
  }
};
FMT_END_NAMESPACE