tink/kem/internal/kem_encapsulate_wrapper.cc

// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
///////////////////////////////////////////////////////////////////////////////

#include "tink/kem/internal/kem_encapsulate_wrapper.h"

#include <cstdint>
#include <memory>
#include <utility>

#include "absl/container/flat_hash_set.h"
#include "absl/memory/memory.h"
#include "absl/status/status.h"
#include "absl/strings/string_view.h"
#include "tink/internal/monitoring.h"
#include "tink/internal/monitoring_util.h"
#include "tink/internal/registry_impl.h"
#include "tink/kem/kem_encapsulate.h"
#include "tink/internal/primitive_set.h"
#include "tink/util/status.h"
#include "tink/util/statusor.h"

namespace crypto {
namespace tink {
namespace internal {

namespace {

using ::google::crypto::tink::OutputPrefixType;

constexpr absl::string_view kPrimitive = "kem_encapsulate";
constexpr absl::string_view kEncapsulateApi = "encapsulate";

absl::Status Validate(PrimitiveSet<KemEncapsulate>* kem_encapsulate_set) {
  if (kem_encapsulate_set == nullptr) {
    return absl::Status(absl::StatusCode::kInternal,
                        "kem_encapsulate_set must be non-NULL");
  }
  if (kem_encapsulate_set->get_primary() == nullptr) {
    return absl::Status(absl::StatusCode::kInvalidArgument,
                        "kem_encapsulate_set has no primary");
  }

  absl::flat_hash_set<uint32_t> key_ids;
  for (const auto& entry : kem_encapsulate_set->get_all()) {
    if (entry->get_output_prefix_type() != OutputPrefixType::TINK) {
      return absl::Status(absl::StatusCode::kInvalidArgument,
                          "kem_encapsulate_set contains non-Tink prefixed key");
    }
    if (!key_ids.insert(entry->get_key_id()).second) {
      return absl::Status(
          absl::StatusCode::kInvalidArgument,
          "kem_encapsulate_set contains several keys with the same ID");
    }
  }

  return absl::OkStatus();
}

class KemEncapsulateSetWrapper : public KemEncapsulate {
 public:
  explicit KemEncapsulateSetWrapper(
      std::unique_ptr<PrimitiveSet<KemEncapsulate>> kem_encapsulate_set,
      std::unique_ptr<internal::MonitoringClient>
          monitoring_encapsulation_client = nullptr)
      : kem_encapsulate_set_(std::move(kem_encapsulate_set)),
        monitoring_encapsulation_client_(
            std::move(monitoring_encapsulation_client)) {}

  absl::StatusOr<KemEncapsulation> Encapsulate() const override;

  ~KemEncapsulateSetWrapper() override = default;

 private:
  std::unique_ptr<PrimitiveSet<KemEncapsulate>> kem_encapsulate_set_;
  std::unique_ptr<internal::MonitoringClient> monitoring_encapsulation_client_;
};

absl::StatusOr<KemEncapsulation> KemEncapsulateSetWrapper::Encapsulate() const {
  auto primary = kem_encapsulate_set_->get_primary();
  absl::StatusOr<KemEncapsulation> encapsulation =
      primary->get_primitive().Encapsulate();
  if (monitoring_encapsulation_client_ != nullptr) {
    if (encapsulation.ok()) {
      monitoring_encapsulation_client_->Log(primary->get_key_id(),
                                            /* num_bytes_as_input = */ 0);
    } else {
      monitoring_encapsulation_client_->LogFailure();
    }
  }

  return encapsulation;
}

}  // anonymous namespace

absl::StatusOr<std::unique_ptr<KemEncapsulate>> KemEncapsulateWrapper::Wrap(
    std::unique_ptr<PrimitiveSet<KemEncapsulate>> primitive_set) const {
  absl::Status status = Validate(primitive_set.get());
  if (!status.ok()) {
    return status;
  }

  internal::MonitoringClientFactory* const monitoring_factory =
      internal::RegistryImpl::GlobalInstance().GetMonitoringClientFactory();

  // Monitoring is not enabled. Create a wrapper without monitoring clients.
  if (monitoring_factory == nullptr) {
    return {
        std::make_unique<KemEncapsulateSetWrapper>(std::move(primitive_set))};
  }

  absl::StatusOr<internal::MonitoringKeySetInfo> keyset_info =
      internal::MonitoringKeySetInfoFromPrimitiveSet(*primitive_set);
  if (!keyset_info.ok()) {
    return keyset_info.status();
  }

  absl::StatusOr<std::unique_ptr<internal::MonitoringClient>>
      monitoring_encapsulation_client =
          monitoring_factory->New(internal::MonitoringContext(
              kPrimitive, kEncapsulateApi, *keyset_info));
  if (!monitoring_encapsulation_client.ok()) {
    return monitoring_encapsulation_client.status();
  }

  return std::make_unique<KemEncapsulateSetWrapper>(
      std::move(primitive_set), *std::move(monitoring_encapsulation_client));
}

}  // namespace internal
}  // namespace tink
}  // namespace crypto