totp.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 KeePassXC Team <team@keepassxc.org>
// SPDX-FileCopyrightText: 2026 Anne Jan Brouwer
// SPDX-License-Identifier: GPL-3.0-or-later
#ifndef SRC_TOTP_H_
#define SRC_TOTP_H_
 
#include <QByteArray>
#include <QList>
#include <QPair>
#include <QString>
 
#include <optional>

class Totp {
public:
  enum class Algorithm {
    Sha1,   
    Sha256, 
    Sha512, 
  };

  enum class Encoder {
    Base10, 
    Steam,  
  };

  struct Settings {
    QByteArray key;    
    QString base32Key; 
    Algorithm algorithm{Algorithm::Sha1}; 
    Encoder encoder{Encoder::Base10};     
    uint digits{DEFAULT_DIGITS}; 
    uint step{DEFAULT_STEP};     
    QString label;               
    QString issuer;              
    QList<QPair<QString, QString>> extraParams;
  };
 
  static constexpr uint DEFAULT_DIGITS = 6U; 
  static constexpr uint DEFAULT_STEP = 30U;  
  static constexpr uint STEAM_DIGITS = 5U; 
  static constexpr uint MIN_DIGITS = 1U;   
  static constexpr uint MAX_DIGITS = 10U;  
  static constexpr uint MAX_STEP = 86400U; 
  static constexpr qsizetype MAX_CONFIG_LENGTH = 4096;

  [[nodiscard]] static auto parse(const QString &config)
      -> std::optional<Settings>;

  [[nodiscard]] static auto isValid(const QString &config) -> bool;

  [[nodiscard]] static auto generate(const Settings &settings, quint64 unixTime)
      -> QString;

  [[nodiscard]] static auto generateNow(const Settings &settings) -> QString;

  [[nodiscard]] static auto counter(const Settings &settings, quint64 unixTime)
      -> quint64;

  [[nodiscard]] static auto secondsRemaining(const Settings &settings,
                                             quint64 unixTime) -> uint;

  [[nodiscard]] static auto toUri(const Settings &settings) -> QString;

  [[nodiscard]] static auto normalize(const QString &config,
                                      const QString &label = {},
                                      const QString &issuer = {}) -> QString;

  [[nodiscard]] static auto currentUnixTime() -> quint64;
 
private:
  Totp() = default;
};
 
#endif // SRC_TOTP_H_