password.hpp

#pragma once
 
#include "sodium-buffer.hpp"
#include <string>
 
class Password {
public:
  // /**
  //  * @brief The binary representation of the password before it was translated into words.
  //  */
  // const SodiumBuffer secretBytes;
  const std::string password;
 
  const std::string recipe;
 
  Password(
    const Password &other
  );
 
  Password(
    // const SodiumBuffer& secretBytes,
    const std::string& password,
    const std::string& recipe = {}
  );
 
  // /**
  //  * @brief Derive a password from a seed secret and a set of
  //  * recipe in @ref recipe_format.
  //  * 
  //  * @param seedString The secret seed string from which this password should be
  //  * derived. Once the password is derived, you won't need the secretSeedBytes
  //  * again unless you need to re-derive this password.
  //  * @param recipe The recipe in @ref recipe_format.
  //  * @param wordListAsSingleString The word list to use to generate the password, with words
  //  * separated by any number of non-alphabetic characters.  This allows word lists to be
  //  * tab-delimited, comma-delimited, line-delimited, or any combination thereof. 
  //  */
  // Password(
  //   const std::string& seedString,
  //   const std::string& recipe,
  //   const std::string& wordListAsSingleString = ""
  // );
 
  static Password deriveFromSeedAndWordList(
    const std::string& seedString,
    const std::string& recipe,
    const std::string& wordListAsSingleString
  );
  static Password deriveFromSeed(
    const std::string& seedString,
    const std::string& recipe
  ) {
    return Password::deriveFromSeedAndWordList(seedString, recipe, "");
  };
 
  const std::string toJson(
    int indent = -1,
    const char indent_char = ' '
  ) const;
 
  // /**
  //  * @brief Derive the word array that can be used to build the final password
  //  * 
  //  * @return const std::vector<std::string> 
  //  */
  // const std::vector<std::string> asWordVector(const std::string wordList = "") const;
 
  // /**
  //  * @brief Derive the password.
  //  *
  //  * @return const std::vector<std::string>
  //  */
  // const std::string password(const std::string wordList = "") const;
 
  const SodiumBuffer toSerializedBinaryForm() const;
 
  static Password fromSerializedBinaryForm(const SodiumBuffer &serializedBinaryForm);
 
  static Password fromJson(
    const std::string& seedAsJson
  );
 
};