base_endpoint_registry.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/quote_info.h"
#include "ccf/endpoint_metrics.h"
#include "ccf/endpoint_registry.h"
#include "ccf/node_context.h"
#include "ccf/tx_status.h"
 
namespace ccf
{
  enum class ApiResult
  {
    OK = 0,
    Uninitialised,
    InvalidArgs,
    NotFound,
    InternalError,
  };
 
  constexpr char const* api_result_to_str(ApiResult result)
  {
    switch (result)
    {
      case ApiResult::OK:
      {
        return "OK";
      }
      case ApiResult::Uninitialised:
      {
        return "Uninitialised";
      }
      case ApiResult::InvalidArgs:
      {
        return "InvalidArgs";
      }
      case ApiResult::NotFound:
      {
        return "NotFound";
      }
      case ApiResult::InternalError:
      {
        return "InternalError";
      }
      default:
      {
        return "Unhandled ApiResult";
      }
    }
  }
 
  enum class InvalidArgsReason
  {
    NoReason = 0,
    ViewSmallerThanOne,
    ActionAlreadyApplied,
    StaleActionCreatedTimestamp,
  };
 
  constexpr char const* invalid_args_reason_to_str(InvalidArgsReason reason)
  {
    switch (reason)
    {
      case InvalidArgsReason::NoReason:
      {
        return "NoReason";
      }
      case InvalidArgsReason::ViewSmallerThanOne:
      {
        return "ViewSmallerThanOne";
      }
      case InvalidArgsReason::ActionAlreadyApplied:
      {
        return "ActionAlreadyApplied";
      }
      case InvalidArgsReason::StaleActionCreatedTimestamp:
      {
        return "StaleActionCreatedTimestamp";
      }
      default:
      {
        return "Unhandled InvalidArgsReason";
      }
    }
  }
 
  class BaseEndpointRegistry : public ccf::endpoints::EndpointRegistry
  {
  protected:
    ccf::AbstractNodeContext& context;
 
  public:
    BaseEndpointRegistry(
      const std::string& method_prefix_, ccf::AbstractNodeContext& context_);
 
    ApiResult get_view_history_v1(
      std::vector<ccf::TxID>& history, ccf::View since = 1);
 
    ApiResult get_view_history_v2(
      std::vector<ccf::TxID>& history,
      ccf::View since,
      ccf::InvalidArgsReason& reason);
 
    ApiResult get_status_for_txid_v1(
      ccf::View view, ccf::SeqNo seqno, ccf::TxStatus& tx_status);
 
    ApiResult get_last_committed_txid_v1(ccf::View& view, ccf::SeqNo& seqno);
 
    ApiResult generate_openapi_document_v1(
      ccf::kv::ReadOnlyTx& tx,
      const std::string& title,
      const std::string& description,
      const std::string& document_version,
      nlohmann::json& document);
 
    ApiResult get_quote_for_this_node_v1(
      ccf::kv::ReadOnlyTx& tx, QuoteInfo& quote_info);
 
    ApiResult get_id_for_this_node_v1(NodeId& node_id);
 
    ApiResult get_quotes_for_all_trusted_nodes_v1(
      ccf::kv::ReadOnlyTx& tx, std::map<NodeId, QuoteInfo>& quotes);
 
    ApiResult get_view_for_seqno_v1(ccf::SeqNo seqno, ccf::View& view);
 
    ApiResult get_user_data_v1(
      ccf::kv::ReadOnlyTx& tx,
      const UserId& user_id,
      nlohmann::json& user_data);
 
    ApiResult get_member_data_v1(
      ccf::kv::ReadOnlyTx& tx,
      const MemberId& member_id,
      nlohmann::json& member_data);
 
    ApiResult get_user_cert_v1(
      ccf::kv::ReadOnlyTx& tx,
      const UserId& user_id,
      ccf::crypto::Pem& user_cert_pem);
 
    ApiResult get_member_cert_v1(
      ccf::kv::ReadOnlyTx& tx,
      const MemberId& member_id,
      ccf::crypto::Pem& member_cert_pem);
 
    ApiResult get_untrusted_host_time_v1(::timespec& time);
  };
}