share_manager.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/entropy.h"
#include "ccf/crypto/rsa_key_pair.h"
#include "ccf/crypto/sha256.h"
#include "ccf/crypto/symmetric_key.h"
#include "ccf/ds/logger.h"
#include "crypto/sharing.h"
#include "kv/encryptor.h"
#include "ledger_secrets.h"
#include "network_state.h"
#include "node/ledger_secret.h"
#include "service/internal_tables_access.h"
 
#include <openssl/crypto.h>
#include <vector>
 
namespace ccf
{
  class SharedLedgerSecretWrappingKey
  {
  private:
    static constexpr auto KZ_KEY_SIZE = ccf::crypto::GCM_DEFAULT_KEY_SIZE;
    bool has_wrapped = false;
    size_t num_shares;
    size_t recovery_threshold;
    ccf::crypto::sharing::Share secret;
    std::vector<ccf::crypto::sharing::Share> shares;
 
  public:
    SharedLedgerSecretWrappingKey(
      size_t num_shares_, size_t recovery_threshold_) :
      num_shares(num_shares_),
      recovery_threshold(recovery_threshold_)
    {
      shares.resize(num_shares);
      ccf::crypto::sharing::sample_secret_and_shares(
        secret, shares, recovery_threshold);
    }
 
    size_t get_num_shares() const
    {
      return num_shares;
    }
 
    size_t get_recovery_threshold() const
    {
      return recovery_threshold;
    }
 
    std::vector<std::vector<uint8_t>> get_shares() const
    {
      std::vector<std::vector<uint8_t>> shares_;
      for (const ccf::crypto::sharing::Share& share : shares)
      {
        std::vector<uint8_t> share_serialised(share.serialised_size);
        share.serialise(share_serialised);
        shares_.emplace_back(share_serialised);
      }
      return shares_;
    }
 
    void get_full_share_serialised(std::vector<uint8_t>& serialised) const
    {
      secret.serialise(serialised);
    }
 
    std::vector<uint8_t> wrap(const LedgerSecretPtr& ledger_secret)
    {
      if (has_wrapped)
      {
        throw std::logic_error(
          "Ledger secret wrapping key has already wrapped once");
      }
 
      ccf::crypto::GcmCipher encrypted_ls(ledger_secret->raw_key.size());
 
      std::vector<uint8_t> data = secret.key(KZ_KEY_SIZE);
      try
      {
        ccf::crypto::make_key_aes_gcm(data)->encrypt(
          encrypted_ls.hdr
            .get_iv(), // iv is always 0 here as the share wrapping
                       // key is never re-used for encryption
          ledger_secret->raw_key,
          {},
          encrypted_ls.cipher,
          encrypted_ls.hdr.tag);
      }
      catch (...)
      {
        OPENSSL_cleanse(data.data(), data.size());
        throw;
      }
 
      has_wrapped = true;
 
      return encrypted_ls.serialise();
    }
  };
 
  class ReconstructedLedgerSecretWrappingKey
  {
  private:
    static constexpr auto KZ_KEY_SIZE = ccf::crypto::GCM_DEFAULT_KEY_SIZE;
    ccf::crypto::sharing::Share secret;
 
  public:
    ReconstructedLedgerSecretWrappingKey(
      std::vector<ccf::crypto::sharing::Share>&& shares_,
      size_t recovery_threshold_)
    {
      ccf::crypto::sharing::recover_unauthenticated_secret(
        secret, shares_, recovery_threshold_);
    }
 
    ReconstructedLedgerSecretWrappingKey(
      const ccf::crypto::sharing::Share& secret_)
    {
      secret = secret_;
    }
 
    LedgerSecretPtr unwrap(
      const std::vector<uint8_t>& wrapped_latest_ledger_secret)
    {
      ccf::crypto::GcmCipher encrypted_ls;
      encrypted_ls.deserialise(wrapped_latest_ledger_secret);
      std::vector<uint8_t> decrypted_ls;
 
      std::vector<uint8_t> data = secret.key(KZ_KEY_SIZE);
      try
      {
        if (!ccf::crypto::make_key_aes_gcm(data)->decrypt(
              encrypted_ls.hdr.get_iv(),
              encrypted_ls.hdr.tag,
              encrypted_ls.cipher,
              {},
              decrypted_ls))
        {
          throw std::logic_error("Unwrapping latest ledger secret failed");
        }
      }
      catch (...)
      {
        OPENSSL_cleanse(data.data(), data.size());
        throw;
      }
 
      return std::make_shared<LedgerSecret>(std::move(decrypted_ls));
    }
  };
 
  // During recovery, a list of EncryptedLedgerSecretInfo is constructed
  // from the local hook on the encrypted ledger secrets table.
  using RecoveredEncryptedLedgerSecrets = std::list<EncryptedLedgerSecretInfo>;
 
  // The ShareManager class provides the interface between the ledger secrets
  // object and the shares, ledger secrets and submitted shares KV tables. In
  // particular, it is used to:
  //  - Issue new recovery shares whenever required (e.g. on startup, rekey and
  //  membership updates)
  //  - Re-assemble the ledger secrets on recovery, once a threshold of members
  //  have successfully submitted their shares
  class ShareManager
  {
  private:
    std::shared_ptr<LedgerSecrets> ledger_secrets;
 
    EncryptedSharesMap compute_encrypted_shares(
      ccf::kv::Tx& tx, const SharedLedgerSecretWrappingKey& ls_wrapping_key)
    {
      EncryptedSharesMap encrypted_shares;
      auto shares = ls_wrapping_key.get_shares();
 
      auto active_recovery_participants_info =
        InternalTablesAccess::get_active_recovery_participants(tx);
 
      size_t share_index = 0;
      for (auto const& [member_id, enc_pub_key] :
           active_recovery_participants_info)
      {
        auto member_enc_pubk = ccf::crypto::make_rsa_public_key(enc_pub_key);
        auto raw_share = std::vector<uint8_t>(
          shares[share_index].begin(), shares[share_index].end());
        encrypted_shares[member_id] = member_enc_pubk->rsa_oaep_wrap(raw_share);
        OPENSSL_cleanse(raw_share.data(), raw_share.size());
        OPENSSL_cleanse(shares[share_index].data(), shares[share_index].size());
        share_index++;
      }
 
      auto active_recovery_owners_info =
        InternalTablesAccess::get_active_recovery_owners(tx);
      if (active_recovery_owners_info.size() > 0)
      {
        std::vector<uint8_t> full_share_serialised(
          ccf::crypto::sharing::Share::serialised_size);
        ls_wrapping_key.get_full_share_serialised(full_share_serialised);
 
        for (auto const& [member_id, enc_pub_key] : active_recovery_owners_info)
        {
          auto member_enc_pubk = ccf::crypto::make_rsa_public_key(enc_pub_key);
          encrypted_shares[member_id] =
            member_enc_pubk->rsa_oaep_wrap(full_share_serialised);
        }
 
        OPENSSL_cleanse(
          full_share_serialised.data(), full_share_serialised.size());
      }
 
      return encrypted_shares;
    }
 
    void shuffle_recovery_shares(
      ccf::kv::Tx& tx, const LedgerSecretPtr& latest_ledger_secret)
    {
      auto active_recovery_participants_info =
        InternalTablesAccess::get_active_recovery_participants(tx);
      auto active_recovery_owners_info =
        InternalTablesAccess::get_active_recovery_owners(tx);
      size_t recovery_threshold =
        InternalTablesAccess::get_recovery_threshold(tx);
 
      if (
        active_recovery_participants_info.empty() &&
        active_recovery_owners_info.empty())
      {
        throw std::logic_error(
          "There should be at least one active recovery member to issue "
          "recovery shares");
      }
 
      if (recovery_threshold == 0)
      {
        throw std::logic_error(
          "Recovery threshold should be set before recovery "
          "shares are computed");
      }
 
      size_t num_shares;
      if (!active_recovery_participants_info.empty())
      {
        if (recovery_threshold > active_recovery_participants_info.size())
        {
          throw std::logic_error(fmt::format(
            "Recovery threshold {} should be equal to or less than the number "
            "of active recovery members {}",
            recovery_threshold,
            active_recovery_participants_info.size()));
        }
 
        num_shares = active_recovery_participants_info.size();
      }
      else
      {
        if (recovery_threshold > 1)
        {
          throw std::logic_error(fmt::format(
            "Recovery threshold {} cannot be greater than 1 when the "
            "consortium consists of only active recovery owner members ({})",
            recovery_threshold,
            active_recovery_owners_info.size()));
        }
 
        num_shares = 1;
      }
 
      auto ls_wrapping_key =
        SharedLedgerSecretWrappingKey(num_shares, recovery_threshold);
 
      auto wrapped_latest_ls = ls_wrapping_key.wrap(latest_ledger_secret);
      auto recovery_shares = tx.rw<ccf::RecoveryShares>(Tables::SHARES);
      recovery_shares->put(
        {wrapped_latest_ls,
         compute_encrypted_shares(tx, ls_wrapping_key),
         latest_ledger_secret->previous_secret_stored_version});
    }
 
    void set_recovery_shares_info(
      ccf::kv::Tx& tx,
      const LedgerSecretPtr& latest_ledger_secret,
      const std::optional<VersionedLedgerSecret>& previous_ledger_secret =
        std::nullopt,
      std::optional<ccf::kv::Version> latest_ls_version = std::nullopt)
    {
      // First, generate a fresh ledger secrets wrapping key and wrap the
      // latest ledger secret with it. Then, encrypt the penultimate ledger
      // secret with the latest ledger secret and split the ledger secret
      // wrapping key, allocating a new share for each active recovery member.
      // Finally, encrypt each share with the public key of each member and
      // record it in the shares table.
 
      shuffle_recovery_shares(tx, latest_ledger_secret);
 
      auto encrypted_ls = tx.rw<ccf::EncryptedLedgerSecretsInfo>(
        Tables::ENCRYPTED_PAST_LEDGER_SECRET);
 
      std::vector<uint8_t> encrypted_previous_secret = {};
      ccf::kv::Version version_previous_secret = ccf::kv::NoVersion;
      if (previous_ledger_secret.has_value())
      {
        version_previous_secret = previous_ledger_secret->first;
 
        ccf::crypto::GcmCipher encrypted_previous_ls(
          previous_ledger_secret->second->raw_key.size());
        encrypted_previous_ls.hdr.set_random_iv();
 
        latest_ledger_secret->key->encrypt(
          encrypted_previous_ls.hdr.get_iv(),
          previous_ledger_secret->second->raw_key,
          {},
          encrypted_previous_ls.cipher,
          encrypted_previous_ls.hdr.tag);
 
        encrypted_previous_secret = encrypted_previous_ls.serialise();
        encrypted_ls->put(
          {PreviousLedgerSecretInfo(
             std::move(encrypted_previous_secret),
             version_previous_secret,
             encrypted_ls->get_version_of_previous_write()),
           latest_ls_version});
      }
      else
      {
        encrypted_ls->put({std::nullopt, latest_ls_version});
      }
    }
 
    std::vector<uint8_t> encrypt_submitted_share(
      const std::vector<uint8_t>& submitted_share,
      const LedgerSecretPtr& current_ledger_secret)
    {
      // Submitted recovery shares are encrypted with the latest ledger secret.
      ccf::crypto::GcmCipher encrypted_submitted_share(submitted_share.size());
 
      encrypted_submitted_share.hdr.set_random_iv();
 
      current_ledger_secret->key->encrypt(
        encrypted_submitted_share.hdr.get_iv(),
        submitted_share,
        {},
        encrypted_submitted_share.cipher,
        encrypted_submitted_share.hdr.tag);
 
      return encrypted_submitted_share.serialise();
    }
 
    std::vector<uint8_t> decrypt_submitted_share(
      const std::vector<uint8_t>& encrypted_submitted_share,
      LedgerSecretPtr&& current_ledger_secret)
    {
      ccf::crypto::GcmCipher encrypted_share;
      encrypted_share.deserialise(encrypted_submitted_share);
      std::vector<uint8_t> decrypted_share;
 
      if (!current_ledger_secret->key->decrypt(
            encrypted_share.hdr.get_iv(),
            encrypted_share.hdr.tag,
            encrypted_share.cipher,
            {},
            decrypted_share))
      {
        throw std::logic_error("Decrypting submitted shares failed");
      }
 
      return decrypted_share;
    }
 
    ReconstructedLedgerSecretWrappingKey
    combine_from_encrypted_submitted_shares(ccf::kv::Tx& tx)
    {
      auto encrypted_submitted_shares = tx.rw<ccf::EncryptedSubmittedShares>(
        Tables::ENCRYPTED_SUBMITTED_SHARES);
      auto config = tx.rw<ccf::Configuration>(Tables::CONFIGURATION);
 
      std::optional<ccf::crypto::sharing::Share> full_share;
      std::vector<ccf::crypto::sharing::Share> new_shares = {};
      encrypted_submitted_shares->foreach(
        [&new_shares, &full_share, &tx, this](
          const MemberId, const EncryptedSubmittedShare& encrypted_share) {
          auto decrypted_share = decrypt_submitted_share(
            encrypted_share, ledger_secrets->get_latest(tx).second);
          switch (decrypted_share.size())
          {
            case ccf::crypto::sharing::Share::serialised_size:
            {
              // For a new share, we can check the index and decide if it's
              // a full share or just a partial share (compare to zero).
              // If it is a full share, we can short-circuit and return a
              // ReconstructedLedgerSecretWrappingKey directly, otherwise we
              // follow the existing flow.
              auto share = ccf::crypto::sharing::Share(decrypted_share);
              if (share.x == 0)
              {
                full_share = share;
              }
              else
              {
                new_shares.emplace_back(decrypted_share);
              }
              break;
            }
            default:
            {
              OPENSSL_cleanse(decrypted_share.data(), decrypted_share.size());
              throw std::logic_error(fmt::format(
                "Error combining recovery shares: decrypted share of {} bytes "
                "is not an {}-byte long new-style share.",
                decrypted_share.size(),
                ccf::crypto::sharing::Share::serialised_size));
            }
          }
          OPENSSL_cleanse(decrypted_share.data(), decrypted_share.size());
          if (full_share.has_value())
          {
            return false;
          }
 
          return true;
        });
 
      if (full_share.has_value())
      {
        return ReconstructedLedgerSecretWrappingKey(full_share.value());
      }
 
      auto num_shares = new_shares.size();
 
      auto recovery_threshold = config->get()->recovery_threshold;
      if (recovery_threshold > num_shares)
      {
        throw std::logic_error(fmt::format(
          "Error combining recovery shares: only {} recovery shares were "
          "submitted but recovery threshold is {}",
          num_shares,
          recovery_threshold));
      }
 
      return ReconstructedLedgerSecretWrappingKey(
        std::move(new_shares), recovery_threshold);
    }
 
  public:
    ShareManager(const std::shared_ptr<LedgerSecrets>& ledger_secrets_) :
      ledger_secrets(ledger_secrets_)
    {}
 
    void issue_recovery_shares(ccf::kv::Tx& tx)
    {
      auto [latest, penultimate] =
        ledger_secrets->get_latest_and_penultimate(tx);
 
      set_recovery_shares_info(tx, latest.second, penultimate, latest.first);
    }
 
    void issue_recovery_shares(
      ccf::kv::Tx& tx, LedgerSecretPtr new_ledger_secret)
    {
      set_recovery_shares_info(
        tx, new_ledger_secret, ledger_secrets->get_latest(tx));
    }
 
    void shuffle_recovery_shares(ccf::kv::Tx& tx)
    {
      shuffle_recovery_shares(tx, ledger_secrets->get_latest(tx).second);
    }
 
    static std::optional<EncryptedShare> get_encrypted_share(
      ccf::kv::ReadOnlyTx& tx, const MemberId& member_id)
    {
      auto recovery_shares_info =
        tx.ro<ccf::RecoveryShares>(Tables::SHARES)->get();
      if (!recovery_shares_info.has_value())
      {
        throw std::logic_error(
          "Failed to retrieve current recovery shares info");
      }
 
      auto search = recovery_shares_info->encrypted_shares.find(member_id);
      if (search == recovery_shares_info->encrypted_shares.end())
      {
        return std::nullopt;
      }
 
      return search->second;
    }
 
    LedgerSecretsMap restore_recovery_shares_info(
      ccf::kv::Tx& tx,
      const RecoveredEncryptedLedgerSecrets& recovery_ledger_secrets,
      const std::optional<LedgerSecretPtr>& restored_ls_opt = std::nullopt)
    {
      if (recovery_ledger_secrets.empty())
      {
        throw std::logic_error("No recovery ledger secrets");
      }
 
      LedgerSecretPtr restored_ls;
      if (restored_ls_opt.has_value())
      {
        restored_ls = restored_ls_opt.value();
      }
      else
      {
        // First, re-assemble the ledger secret wrapping key from the submitted
        // encrypted shares. Then, unwrap the latest ledger secret and use it to
        // decrypt the sequence of recovered ledger secrets, from the last one.
 
        auto recovery_shares_info =
          tx.ro<ccf::RecoveryShares>(Tables::SHARES)->get();
        if (!recovery_shares_info.has_value())
        {
          throw std::logic_error(
            "Failed to retrieve current recovery shares info");
        }
 
        restored_ls = combine_from_encrypted_submitted_shares(tx).unwrap(
          recovery_shares_info->wrapped_latest_ledger_secret);
      }
 
      LOG_DEBUG_FMT(
        "Recovering {} encrypted ledger secrets",
        recovery_ledger_secrets.size());
 
      auto& current_ledger_secret_version =
        recovery_ledger_secrets.back().next_version;
      if (!current_ledger_secret_version.has_value())
      {
        // This should always be set by the recovery hook, which sets this to
        // the version at which it is called if unset in the store
        throw std::logic_error("Current ledger secret version should be set");
      }
 
      auto encrypted_previous_ledger_secret =
        tx.ro<ccf::EncryptedLedgerSecretsInfo>(
          Tables::ENCRYPTED_PAST_LEDGER_SECRET);
 
      LedgerSecretsMap restored_ledger_secrets = {};
      auto s = restored_ledger_secrets.emplace(
        current_ledger_secret_version.value(),
        std::make_shared<LedgerSecret>(
          std::move(restored_ls->raw_key),
          encrypted_previous_ledger_secret->get_version_of_previous_write()));
      auto latest_ls = s.first->second;
 
      for (auto it = recovery_ledger_secrets.rbegin();
           it != recovery_ledger_secrets.rend();
           it++)
      {
        LOG_DEBUG_FMT(
          "Recovering encrypted ledger secret valid at seqno {}",
          it->previous_ledger_secret->version);
 
        if (!it->previous_ledger_secret.has_value())
        {
          // Very first entry does not encrypt any other ledger secret
          break;
        }
 
        if (
          restored_ledger_secrets.find(it->previous_ledger_secret->version) !=
          restored_ledger_secrets.end())
        {
          // Already decrypted this ledger secret
          LOG_INFO_FMT(
            "Skipping, already decrypted ledger secret with version {}",
            it->previous_ledger_secret->version);
          continue;
        }
 
        auto decrypted_ls_raw = decrypt_previous_ledger_secret_raw(
          latest_ls, it->previous_ledger_secret->encrypted_data);
 
        auto secret = restored_ledger_secrets.emplace(
          it->previous_ledger_secret->version,
          std::make_shared<LedgerSecret>(
            std::move(decrypted_ls_raw),
            it->previous_ledger_secret->previous_secret_stored_version));
        latest_ls = secret.first->second;
      }
 
      return restored_ledger_secrets;
    }
 
    static bool is_full_key(
      const std::vector<uint8_t>& submitted_recovery_share)
    {
      if (
        submitted_recovery_share.size() ==
        ccf::crypto::sharing::Share::serialised_size)
      {
        auto share = ccf::crypto::sharing::Share(submitted_recovery_share);
        if (share.x == 0)
        {
          // Index value of 0 indicates a full key.
          return true;
        }
      }
 
      return false;
    }
 
    size_t submit_recovery_share(
      ccf::kv::Tx& tx,
      MemberId member_id,
      const std::vector<uint8_t>& submitted_recovery_share)
    {
      auto service = tx.rw<ccf::Service>(Tables::SERVICE);
      auto encrypted_submitted_shares = tx.rw<ccf::EncryptedSubmittedShares>(
        Tables::ENCRYPTED_SUBMITTED_SHARES);
      auto active_service = service->get();
      if (!active_service.has_value())
      {
        throw std::logic_error("Failed to get active service");
      }
 
      encrypted_submitted_shares->put(
        member_id,
        encrypt_submitted_share(
          submitted_recovery_share, ledger_secrets->get_latest(tx).second));
 
      return encrypted_submitted_shares->size();
    }
 
    static void clear_submitted_recovery_shares(ccf::kv::Tx& tx)
    {
      auto encrypted_submitted_shares = tx.rw<ccf::EncryptedSubmittedShares>(
        Tables::ENCRYPTED_SUBMITTED_SHARES);
      encrypted_submitted_shares->clear();
    }
  };
}