ffi_totp.cpp File Reference

#include <botan/ffi.h>
#include <botan/assert.h>
#include <botan/internal/ffi_util.h>

Go to the source code of this file.

Functions
int	botan_totp_check (botan_totp_t totp, uint32_t totp_code, uint64_t timestamp, size_t acceptable_clock_drift)
int	botan_totp_destroy (botan_totp_t totp)
int	botan_totp_generate (botan_totp_t totp, uint32_t *totp_code, uint64_t timestamp)
int	botan_totp_init (botan_totp_t *totp, const uint8_t key[], size_t key_len, const char *hash_algo, size_t digits, size_t time_step)

Function Documentation

botan_totp_check()

int botan_totp_check	(	botan_totp_t	totp,
		uint32_t	totp_code,
		uint64_t	timestamp,
		size_t	acceptable_clock_drift )

Verify a TOTP code

Parameters

totp	the TOTP object
totp_code	the presented OTP
timestamp	the current local timestamp
acceptable_clock_drift	specifies the acceptable amount of clock drift (in terms of time steps) between the two hosts.

Definition at line 68 of file ffi_totp.cpp.

                                                                                                               {
#if defined(BOTAN_HAS_TOTP)
   return BOTAN_FFI_VISIT(totp, [=](auto& t) {
      const bool ok = t.verify_totp(totp_code, timestamp, acceptable_clock_drift);
      return (ok ? BOTAN_FFI_SUCCESS : BOTAN_FFI_INVALID_VERIFIER);
   });
 
#else
   BOTAN_UNUSED(totp, totp_code, timestamp, acceptable_clock_drift);
   return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_INVALID_VERIFIER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

botan_totp_destroy()

int botan_totp_destroy

(

botan_totp_t

totp

)

Destroy a TOTP instance

Returns

0 if success, error if invalid object handle

Definition at line 45 of file ffi_totp.cpp.

                                          {
#if defined(BOTAN_HAS_TOTP)
   return BOTAN_FFI_CHECKED_DELETE(totp);
#else
   BOTAN_UNUSED(totp);
   return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

botan_totp_generate()

int botan_totp_generate	(	botan_totp_t	totp,
		uint32_t *	totp_code,
		uint64_t	timestamp )

Generate a TOTP code for the provided timestamp

Parameters

totp	the TOTP object
totp_code	the OTP code will be written here
timestamp	the current local timestamp

Definition at line 54 of file ffi_totp.cpp.

                                                                                    {
#if defined(BOTAN_HAS_TOTP)
   if(totp == nullptr || totp_code == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   return BOTAN_FFI_VISIT(totp, [=](auto& t) { *totp_code = t.generate_totp(timestamp); });
 
#else
   BOTAN_UNUSED(totp, totp_code, timestamp);
   return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and BOTAN_UNUSED.

botan_totp_init()

int botan_totp_init	(	botan_totp_t *	totp,
		const uint8_t	key[],
		size_t	key_len,
		const char *	hash_algo,
		size_t	digits,
		size_t	time_step )

Initialize a TOTP instance

Definition at line 26 of file ffi_totp.cpp.

                                                                                                                    {
   if(totp == nullptr || key == nullptr || hash_algo == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   *totp = nullptr;
 
#if defined(BOTAN_HAS_TOTP)
   return ffi_guard_thunk(__func__, [=]() -> int {
      auto otp = std::make_unique<Botan::TOTP>(key, key_len, hash_algo, digits, time_step);
      return ffi_new_object(totp, std::move(otp));
   });
#else
   BOTAN_UNUSED(totp, key, key_len, hash_algo, digits, time_step);
   return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
#endif
}

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_UNUSED, Botan_FFI::ffi_guard_thunk(), and Botan_FFI::ffi_new_object().