Botan::HOTP Class Reference

#include <otp.h>

Public Member Functions
uint32_t	generate_hotp (uint64_t counter)
BOTAN_FUTURE_EXPLICIT	HOTP (const SymmetricKey &key, std::string_view hash_algo="SHA-1", size_t digits=6)
	HOTP (const uint8_t key[], size_t key_len, std::string_view hash_algo="SHA-1", size_t digits=6)
std::pair< bool, uint64_t >	verify_hotp (uint32_t otp, uint64_t starting_counter, size_t resync_range=0)

Detailed Description

HOTP one time passwords (RFC 4226)

Definition at line 20 of file otp.h.

Constructor & Destructor Documentation

HOTP() [1/2]

BOTAN_FUTURE_EXPLICIT Botan::HOTP::HOTP ( const SymmetricKey & key, std::string_view hash_algo = "SHA-1", size_t digits = 6 )

inline

Parameters

key	the secret key shared between client and server
hash_algo	the hash algorithm to use, should be SHA-1 or SHA-256
digits	the number of digits in the OTP (must be 6, 7, or 8) TODO(Botan4) remove the default hash param here

Definition at line 28 of file otp.h.

                                                                                                             :
            HOTP(key.begin(), key.size(), hash_algo, digits) {}

References BOTAN_FUTURE_EXPLICIT, and HOTP().

Referenced by HOTP().

HOTP() [2/2]

Botan::HOTP::HOTP	(	const uint8_t	key[],
		size_t	key_len,
		std::string_view	hash_algo = "SHA-1",
		size_t	digits = 6 )

Parameters

key	the secret key shared between client and server
key_len	length of key param
hash_algo	the hash algorithm to use, should be SHA-1 or SHA-256
digits	the number of digits in the OTP (must be 6, 7, or 8) TODO(Botan4) remove the default hash param here

Definition at line 34 of file hotp.cpp.

                                                                                       : m_digits(digits) {
   BOTAN_ARG_CHECK(m_digits == 6 || m_digits == 7 || m_digits == 8, "Invalid HOTP digits");
 
   /*
   RFC 4228 only supports SHA-1 but TOTP allows SHA-256 and SHA-512
   and some HOTP libs support one or both as extensions
   */
   if(hash_algo == "SHA-1") {
      m_mac = MessageAuthenticationCode::create_or_throw("HMAC(SHA-1)");
   } else if(hash_algo == "SHA-256") {
      m_mac = MessageAuthenticationCode::create_or_throw("HMAC(SHA-256)");
   } else if(hash_algo == "SHA-512") {
      m_mac = MessageAuthenticationCode::create_or_throw("HMAC(SHA-512)");
   } else {
      throw Invalid_Argument("Unsupported HOTP hash function");
   }
 
   m_mac->set_key(key, key_len);
}

References BOTAN_ARG_CHECK, and Botan::MessageAuthenticationCode::create_or_throw().

Member Function Documentation

generate_hotp()

uint32_t Botan::HOTP::generate_hotp

(

uint64_t

counter

)

Generate the HOTP for a particular counter value

Warning

if the counter value is repeated the OTP ceases to be one-time

Definition at line 54 of file hotp.cpp.

                                             {
   m_mac->update_be(counter);
   const secure_vector<uint8_t> mac = m_mac->final();
 
   const size_t offset = mac[mac.size() - 1] & 0x0F;
   const uint32_t code = load_be<uint32_t>(mac.data() + offset, 0) & 0x7FFFFFFF;
   return hotp_truncate(code, m_digits);
}

References Botan::load_be().

Referenced by verify_hotp().

verify_hotp()

std::pair< bool, uint64_t > Botan::HOTP::verify_hotp	(	uint32_t	otp,
		uint64_t	starting_counter,
		size_t	resync_range = 0 )

Check an OTP value using a starting counter and a resync range

Parameters

otp	the client provided OTP
starting_counter	the server's guess as to the current counter state
resync_range	if 0 then only HOTP(starting_counter) is accepted If larger than 0, up to resync_range values after HOTP are also checked.

Returns

(valid,next_counter). If the OTP does not validate, always returns (false,starting_counter). Otherwise returns (true,next_counter) where next_counter is at most starting_counter + resync_range + 1

Definition at line 63 of file hotp.cpp.

                                                                                                      {
   for(size_t i = 0; i <= resync_range; ++i) {
      if(generate_hotp(starting_counter + i) == otp) {
         return std::make_pair(true, starting_counter + i + 1);
      }
   }
   return std::make_pair(false, starting_counter);
}

References generate_hotp().

---

The documentation for this class was generated from the following files:

• src/lib/misc/hotp/otp.h
• src/lib/misc/hotp/hotp.cpp