symmetric-key.hpp

#pragma once
 
#include <string>
#include "sodium-buffer.hpp"
#include "packaged-sealed-message.hpp"
 
class SymmetricKey {
 
  public:
  const SodiumBuffer keyBytes;
  const std::string recipe;
 
  SymmetricKey(
    const SodiumBuffer& keyBytes,
    std::string recipe
  );
 
  SymmetricKey(
    const SymmetricKey &other
  );
 
  // /**
  //  * @brief Construct (reconstitute) a SymmetricKey from its JSON
  //  * representation
  //  * 
  //  * @param symmetricKeyAsJson A SymmetricKey serialized in JSON format
  //  * via a previous call to toJson
  //  */
  // SymmetricKey(
  //   const std::string& symmetricKeyAsJson
  // );
 
  SymmetricKey(
    const std::string& seedString,
    const std::string& recipe
  );
 
  static SymmetricKey deriveFromSeed(
    const std::string& seedString,
    const std::string& recipe
  );
 
  const std::vector<unsigned char> sealToCiphertextOnly(
    const unsigned char* message,
    const size_t messageLength,
    const std::string& unsealingInstructions = {}
  ) const;
 
  const std::vector<unsigned char> sealToCiphertextOnly(
    const SodiumBuffer& message,
    const std::string& unsealingInstructions = {}
  ) const;
 
  const PackagedSealedMessage seal(
    const SodiumBuffer& message,
    const std::string& unsealingInstructions = {}
  ) const;
 
  const PackagedSealedMessage seal(
    const std::string& message,
    const std::string& unsealingInstructions = {}
  ) const;
 
  const PackagedSealedMessage seal(
    const std::vector<unsigned char>& message,
    const std::string& unsealingInstructions = {}
  ) const;
 
 
  const PackagedSealedMessage seal(
    const unsigned char* message,
    const size_t messageLength,
    const std::string& unsealingInstructions = {}
  ) const;
 
  const SodiumBuffer unseal(
    const unsigned char* ciphertext,
    const size_t ciphertextLength,
    const std::string& unsealingInstructions = {}
  ) const;
 
  const SodiumBuffer unseal(
    const std::vector<unsigned char> &ciphertext,
    const std::string& unsealingInstructions = {}
  ) const;
 
  const SodiumBuffer unseal(
    const PackagedSealedMessage& packagedSealedMessage
  ) const;
 
  static const SodiumBuffer unseal(
    const PackagedSealedMessage &packagedSealedMessage,
    const std::string& seedString
  );
 
 
  const std::string toJson(
    int indent = -1,
    const char indent_char = ' '
  ) const;
 
 
  const SodiumBuffer toSerializedBinaryForm() const;
 
  static SymmetricKey fromSerializedBinaryForm(const SodiumBuffer &serializedBinaryForm);
 
  static SymmetricKey fromJson(
    const std::string& symmetricKeyAsJson
  );
 
protected:
 
  const SodiumBuffer unsealMessageContents(
    const unsigned char* ciphertext,
    const size_t ciphertextLength,
    const std::string& unsealingInstructions = {}
  ) const;
 
};