| // Copyright 2017 The Fuchsia Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| // This file contains two classes for working with EncryptedMessages. |
| // |
| // EncryptedMessageMaker is used by the Encoder to create EncryptedMessages |
| // by encrypting Observations, and Envelopes. |
| // |
| // MessageDecrypter is used by the Analyzer to decrypt EncryptedMessages |
| // containing Observations. |
| |
| #ifndef COBALT_SRC_LIB_UTIL_ENCRYPTED_MESSAGE_UTIL_H_ |
| #define COBALT_SRC_LIB_UTIL_ENCRYPTED_MESSAGE_UTIL_H_ |
| |
| #include <memory> |
| #include <string> |
| #include <vector> |
| |
| #include "google/protobuf/message_lite.h" |
| #include "src/lib/statusor/statusor.h" |
| #include "src/pb/encrypted_message.pb.h" |
| |
| namespace cobalt { |
| namespace util { |
| |
| // EncryptedMessageMaker is used by the Encoder to encrypt protocol buffer |
| // messages before sending them to the Shuffler (and then to the Analyzer). |
| // |
| // The Encoder should make two instances of this class: |
| // one constructed with the public key of the Analyzer used for encrypting |
| // Observations and one with the public key of the Shuffler used for |
| // encrypting Envelopes. |
| class EncryptedMessageMaker { |
| public: |
| // Encrypts a protocol buffer |message| and populates |encrypted_message| |
| // with the result. Returns true for success or false on failure. |
| virtual bool Encrypt(const google::protobuf::MessageLite& message, |
| EncryptedMessage* encrypted_message) const = 0; |
| |
| // Returns the EncryptionScheme used by the EncryptedMessageMaker. |
| [[nodiscard]] virtual EncryptedMessage::EncryptionScheme scheme() const = 0; |
| |
| // Make an UnencryptedMessageMaker. |
| // Message will be serialized, but not encrypted: they will be sent in plain |
| // text. This scheme must never be used in production Cobalt. |
| static std::unique_ptr<EncryptedMessageMaker> MakeUnencrypted(); |
| |
| // Make an EncryptedMessageMaker to encrypt Envelopes. |
| // Messages will be encrypted using the scheme corresponding to the key |
| // that is passed in. |cobalt_encryption_key_bytes| is a serialized |
| // cobalt::CobaltEncryptionKey protobuf message. |
| static lib::statusor::StatusOr<std::unique_ptr<EncryptedMessageMaker>> MakeForEnvelopes( |
| const std::string& cobalt_encryption_key_bytes); |
| |
| // Make an EncryptedMessageMaker to encrypt Observations. |
| // Messages will be encrypted using the scheme corresponding to the key |
| // that is passed in. |cobalt_encryption_key_bytes| is a serialized |
| // cobalt::CobaltEncryptionKey protobuf message. |
| static lib::statusor::StatusOr<std::unique_ptr<EncryptedMessageMaker>> MakeForObservations( |
| const std::string& cobalt_encryption_key_bytes); |
| |
| virtual ~EncryptedMessageMaker() = default; |
| }; |
| |
| // UnencryptedMessageMaker is an implementation of EncryptedMessageMaker that |
| // does not perform any encryption. |
| class UnencryptedMessageMaker : public EncryptedMessageMaker { |
| public: |
| bool Encrypt(const google::protobuf::MessageLite& message, |
| EncryptedMessage* encrypted_message) const override; |
| |
| [[nodiscard]] EncryptedMessage::EncryptionScheme scheme() const override { |
| return EncryptedMessage::NONE; |
| } |
| }; |
| |
| } // namespace util |
| } // namespace cobalt |
| |
| #endif // COBALT_SRC_LIB_UTIL_ENCRYPTED_MESSAGE_UTIL_H_ |