totp.hh

Go to the documentation of this file.

/*
 * libkeepass - KeePass key database importer/exporter
 * Copyright (C) 2014 Christian Kindahl
 * Copyright (C) 2024 Dominik Krümpelmann
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <cstdint>
#include <ctime>
#include <optional>
#include <string>
 
#include "libkeepass/export.hh"
#include "libkeepass/secure.hh"
 
namespace keepass {
 
class Entry;
 
class LIBKEEPASS_API TotpConfig final {
public:
  enum class Algorithm { kSha1, kSha256, kSha512 };
 
private:
  secure_string secret_;
  uint32_t period_ = 30;
  uint32_t digits_ = 6;
  Algorithm algorithm_ = Algorithm::kSha1;
 
public:
  TotpConfig() = default;
 
  explicit TotpConfig(secure_string secret, uint32_t period = 30, uint32_t digits = 6,
                      Algorithm algorithm = Algorithm::kSha1);
 
  const secure_string& secret() const { return secret_; }
 
  void set_secret(const secure_string& secret) { secret_ = secret; }
 
  uint32_t period() const { return period_; }
 
  void set_period(uint32_t period) { period_ = period == 0 ? 1 : period; }
 
  uint32_t digits() const { return digits_; }
 
  void set_digits(uint32_t digits) { digits_ = digits < 1 ? 1 : (digits > 10 ? 10 : digits); }
 
  Algorithm algorithm() const { return algorithm_; }
 
  void set_algorithm(Algorithm algorithm) { algorithm_ = algorithm; }
 
  bool empty() const { return secret_.empty(); }
 
  static std::optional<TotpConfig> Parse(const std::string& seed_field,
                                         const std::string& settings_field = {});
 
  static std::optional<TotpConfig> FromEntry(const Entry& entry);
};
 
class LIBKEEPASS_API Totp final {
public:
  static std::string Generate(const TotpConfig& config, std::time_t time = 0);
 
 
  static std::string Generate(const Entry& entry, std::time_t time = 0);
 
 
  static uint32_t SecondsRemaining(const TotpConfig& config, std::time_t time = 0);
};
 
} // namespace keepass