diff options
author | Jack Lloyd <[email protected]> | 2020-11-03 08:13:09 -0500 |
---|---|---|
committer | Jack Lloyd <[email protected]> | 2020-11-03 13:59:29 -0500 |
commit | f560e43c6b5efa951c17075a3c55775bcd76ea17 (patch) | |
tree | 340993aeadd403530f9fbe8f2b3161c92c8fe49b /src/lib/misc/hotp | |
parent | 0ee1130583efbc6c98869347d0f8dabe59004aa7 (diff) |
More header merging
Diffstat (limited to 'src/lib/misc/hotp')
-rw-r--r-- | src/lib/misc/hotp/hotp.cpp | 2 | ||||
-rw-r--r-- | src/lib/misc/hotp/hotp.h | 53 | ||||
-rw-r--r-- | src/lib/misc/hotp/otp.h | 117 | ||||
-rw-r--r-- | src/lib/misc/hotp/totp.cpp | 2 | ||||
-rw-r--r-- | src/lib/misc/hotp/totp.h | 61 |
5 files changed, 123 insertions, 112 deletions
diff --git a/src/lib/misc/hotp/hotp.cpp b/src/lib/misc/hotp/hotp.cpp index b92528492..b9791bc9b 100644 --- a/src/lib/misc/hotp/hotp.cpp +++ b/src/lib/misc/hotp/hotp.cpp @@ -5,7 +5,7 @@ * Botan is released under the Simplified BSD License (see license.txt) */ -#include <botan/hotp.h> +#include <botan/otp.h> #include <botan/loadstor.h> #include <botan/exceptn.h> diff --git a/src/lib/misc/hotp/hotp.h b/src/lib/misc/hotp/hotp.h index 9282067d5..d8c545557 100644 --- a/src/lib/misc/hotp/hotp.h +++ b/src/lib/misc/hotp/hotp.h @@ -8,56 +8,7 @@ #ifndef BOTAN_HOTP_H_ #define BOTAN_HOTP_H_ -#include <botan/mac.h> - -namespace Botan { - -/** -* HOTP one time passwords (RFC 4226) -*/ -class BOTAN_PUBLIC_API(2,2) HOTP final - { - public: - /** - * @param key the secret key shared between client and server - * @param hash_algo the hash algorithm to use, should be SHA-1 or SHA-256 - * @param digits the number of digits in the OTP (must be 6, 7, or 8) - */ - HOTP(const SymmetricKey& key, const std::string& hash_algo = "SHA-1", size_t digits = 6) : - HOTP(key.begin(), key.size(), hash_algo, digits) {} - - /** - * @param key the secret key shared between client and server - * @param key_len length of key param - * @param hash_algo the hash algorithm to use, should be SHA-1 or SHA-256 - * @param digits the number of digits in the OTP (must be 6, 7, or 8) - */ - HOTP(const uint8_t key[], size_t key_len, - const std::string& hash_algo = "SHA-1", - size_t digits = 6); - - /** - * Generate the HOTP for a particular counter value - * @warning if the counter value is repeated the OTP ceases to be one-time - */ - uint32_t generate_hotp(uint64_t counter); - - /** - * Check an OTP value using a starting counter and a resync range - * @param otp the client provided OTP - * @param starting_counter the server's guess as to the current counter state - * @param 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. - * @return (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 - */ - std::pair<bool,uint64_t> verify_hotp(uint32_t otp, uint64_t starting_counter, size_t resync_range = 0); - private: - std::unique_ptr<MessageAuthenticationCode> m_mac; - uint32_t m_digit_mod; - }; - -} +#include <botan/otp.h> +BOTAN_DEPRECATED_HEADER(hotp.h) #endif diff --git a/src/lib/misc/hotp/otp.h b/src/lib/misc/hotp/otp.h new file mode 100644 index 000000000..664f181f1 --- /dev/null +++ b/src/lib/misc/hotp/otp.h @@ -0,0 +1,117 @@ +/* +* HOTP/TOTP +* (C) 2017 Jack Lloyd +* +* Botan is released under the Simplified BSD License (see license.txt) +*/ + +#ifndef BOTAN_ONE_TIME_PASSWORDS_H_ +#define BOTAN_ONE_TIME_PASSWORDS_H_ + +#include <botan/mac.h> +#include <chrono> + +namespace Botan { + +/** +* HOTP one time passwords (RFC 4226) +*/ +class BOTAN_PUBLIC_API(2,2) HOTP final + { + public: + /** + * @param key the secret key shared between client and server + * @param hash_algo the hash algorithm to use, should be SHA-1 or SHA-256 + * @param digits the number of digits in the OTP (must be 6, 7, or 8) + */ + HOTP(const SymmetricKey& key, const std::string& hash_algo = "SHA-1", size_t digits = 6) : + HOTP(key.begin(), key.size(), hash_algo, digits) {} + + /** + * @param key the secret key shared between client and server + * @param key_len length of key param + * @param hash_algo the hash algorithm to use, should be SHA-1 or SHA-256 + * @param digits the number of digits in the OTP (must be 6, 7, or 8) + */ + HOTP(const uint8_t key[], size_t key_len, + const std::string& hash_algo = "SHA-1", + size_t digits = 6); + + /** + * Generate the HOTP for a particular counter value + * @warning if the counter value is repeated the OTP ceases to be one-time + */ + uint32_t generate_hotp(uint64_t counter); + + /** + * Check an OTP value using a starting counter and a resync range + * @param otp the client provided OTP + * @param starting_counter the server's guess as to the current counter state + * @param 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. + * @return (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 + */ + std::pair<bool,uint64_t> verify_hotp(uint32_t otp, uint64_t starting_counter, size_t resync_range = 0); + private: + std::unique_ptr<MessageAuthenticationCode> m_mac; + uint32_t m_digit_mod; + }; + +/** +* TOTP (time based) one time passwords (RFC 6238) +*/ +class BOTAN_PUBLIC_API(2,2) TOTP final + { + public: + /** + * @param key the secret key shared between client and server + * @param hash_algo the hash algorithm to use, should be SHA-1, SHA-256 or SHA-512 + * @param digits the number of digits in the OTP (must be 6, 7, or 8) + * @param time_step granularity of OTP in seconds + */ + TOTP(const SymmetricKey& key, + const std::string& hash_algo = "SHA-1", + size_t digits = 6, size_t time_step = 30) : + TOTP(key.begin(), key.size(), hash_algo, digits, time_step) {} + + /** + * @param key the secret key shared between client and server + * @param key_len length of key + * @param hash_algo the hash algorithm to use, should be SHA-1, SHA-256 or SHA-512 + * @param digits the number of digits in the OTP (must be 6, 7, or 8) + * @param time_step granularity of OTP in seconds + */ + TOTP(const uint8_t key[], size_t key_len, + const std::string& hash_algo = "SHA-1", + size_t digits = 6, + size_t time_step = 30); + + /** + * Convert the provided time_point to a Unix timestamp and call generate_totp + */ + uint32_t generate_totp(std::chrono::system_clock::time_point time_point); + + /** + * Generate the OTP corresponding the the provided "Unix timestamp" (ie + * number of seconds since midnight Jan 1, 1970) + */ + uint32_t generate_totp(uint64_t unix_time); + + bool verify_totp(uint32_t otp, + std::chrono::system_clock::time_point time, + size_t clock_drift_accepted = 0); + + bool verify_totp(uint32_t otp, uint64_t unix_time, + size_t clock_drift_accepted = 0); + + private: + HOTP m_hotp; + size_t m_time_step; + std::chrono::system_clock::time_point m_unix_epoch; + }; + +} + +#endif diff --git a/src/lib/misc/hotp/totp.cpp b/src/lib/misc/hotp/totp.cpp index 9daef6655..5e1c23f61 100644 --- a/src/lib/misc/hotp/totp.cpp +++ b/src/lib/misc/hotp/totp.cpp @@ -5,7 +5,7 @@ * Botan is released under the Simplified BSD License (see license.txt) */ -#include <botan/totp.h> +#include <botan/otp.h> #include <botan/calendar.h> namespace Botan { diff --git a/src/lib/misc/hotp/totp.h b/src/lib/misc/hotp/totp.h index 1417658c0..a5a083192 100644 --- a/src/lib/misc/hotp/totp.h +++ b/src/lib/misc/hotp/totp.h @@ -7,64 +7,7 @@ #ifndef BOTAN_TOTP_H_ #define BOTAN_TOTP_H_ -#include <botan/hotp.h> -#include <chrono> - -namespace Botan { - -/** -* TOTP (time based) one time passwords (RFC 6238) -*/ -class BOTAN_PUBLIC_API(2,2) TOTP final - { - public: - /** - * @param key the secret key shared between client and server - * @param hash_algo the hash algorithm to use, should be SHA-1, SHA-256 or SHA-512 - * @param digits the number of digits in the OTP (must be 6, 7, or 8) - * @param time_step granularity of OTP in seconds - */ - TOTP(const SymmetricKey& key, - const std::string& hash_algo = "SHA-1", - size_t digits = 6, size_t time_step = 30) : - TOTP(key.begin(), key.size(), hash_algo, digits, time_step) {} - - /** - * @param key the secret key shared between client and server - * @param key_len length of key - * @param hash_algo the hash algorithm to use, should be SHA-1, SHA-256 or SHA-512 - * @param digits the number of digits in the OTP (must be 6, 7, or 8) - * @param time_step granularity of OTP in seconds - */ - TOTP(const uint8_t key[], size_t key_len, - const std::string& hash_algo = "SHA-1", - size_t digits = 6, - size_t time_step = 30); - - /** - * Convert the provided time_point to a Unix timestamp and call generate_totp - */ - uint32_t generate_totp(std::chrono::system_clock::time_point time_point); - - /** - * Generate the OTP corresponding the the provided "Unix timestamp" (ie - * number of seconds since midnight Jan 1, 1970) - */ - uint32_t generate_totp(uint64_t unix_time); - - bool verify_totp(uint32_t otp, - std::chrono::system_clock::time_point time, - size_t clock_drift_accepted = 0); - - bool verify_totp(uint32_t otp, uint64_t unix_time, - size_t clock_drift_accepted = 0); - - private: - HOTP m_hotp; - size_t m_time_step; - std::chrono::system_clock::time_point m_unix_epoch; - }; - -} +#include <botan/otp.h> +BOTAN_DEPRECATED_HEADER(totp.h) #endif |