Botan 2.13.0 Crypto and TLS for C++11

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

Functions
ffi_hotp.cpp File Reference
`#include <botan/ffi.h>`
`#include <botan/internal/ffi_util.h>`

Go to the source code of this file.

## Functions
int | botan_hotp_check (botan_hotp_t hotp, uint64_t *next_hotp_counter, uint32_t hotp_code, uint64_t hotp_counter, size_t resync_range)
int | botan_hotp_destroy (botan_hotp_t hotp)
int | botan_hotp_generate (botan_hotp_t hotp, uint32_t *hotp_code, uint64_t hotp_counter)
int | botan_hotp_init (botan_hotp_t *hotp, const uint8_t key[], size_t key_len, const char *hash_algo, size_t digits)

## Function Documentation

int botan_hotp_check | ( | botan_hotp_t | hotp,
|  | uint64_t * | next_hotp_counter,
|  | uint32_t | hotp_code,
|  | uint64_t | hotp_counter,
|  | size_t | resync_range
| ) |  |

Verify a HOTP code

Definition at line 76 of file ffi_hotp.cpp.

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_INVALID_VERIFIER, BOTAN_FFI_RETURNING, BOTAN_FFI_SUCCESS, BOTAN_UNUSED, and Botan::HOTP::verify_hotp().

81 {
82 #if defined(BOTAN_HAS_HOTP)
83 return BOTAN_FFI_RETURNING(Botan::HOTP, hotp, h, {
84
85 auto resp = h.verify_hotp(hotp_code, hotp_counter, resync_range);
86
87 if(next_hotp_counter)
88 *next_hotp_counter = resp.second;
89
90 return (resp.first == true) ? BOTAN_FFI_SUCCESS : BOTAN_FFI_INVALID_VERIFIER;
91 });
92
93 #else
94 BOTAN_UNUSED(hotp, next_hotp_counter, hotp_code, hotp_counter, resync_range);
95 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
96 #endif
97 }
BOTAN_FFI_ERROR_NOT_IMPLEMENTED
Definition: ffi.h:82
BOTAN_FFI_RETURNING
#define BOTAN_FFI_RETURNING(T, obj, param, block)
Definition: ffi_util.h:101
Botan::HOTP
Definition: hotp.h:18
BOTAN_UNUSED
#define BOTAN_UNUSED(...)
Definition: assert.h:142
Botan::HOTP::verify_hotp
std::pair< bool, uint64_t > verify_hotp(uint32_t otp, uint64_t starting_counter, size_t resync_range=0)
Definition: hotp.cpp:52
BOTAN_FFI_SUCCESS
Definition: ffi.h:62
BOTAN_FFI_INVALID_VERIFIER
Definition: ffi.h:63

int botan_hotp_destroy | ( | botan_hotp_t | hotp | ) |

Destroy a HOTP instance

Returns
  0 if success, error if invalid object handle

Definition at line 48 of file ffi_hotp.cpp.

References BOTAN_FFI_CHECKED_DELETE, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, and BOTAN_UNUSED.

49 {
50 #if defined(BOTAN_HAS_HOTP)
51 return BOTAN_FFI_CHECKED_DELETE(hotp);
52 #else
53 BOTAN_UNUSED(hotp);
54 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
55 #endif
56 }
BOTAN_FFI_ERROR_NOT_IMPLEMENTED
Definition: ffi.h:82
BOTAN_FFI_CHECKED_DELETE
#define BOTAN_FFI_CHECKED_DELETE(o)
Definition: ffi_util.h:129
BOTAN_UNUSED
#define BOTAN_UNUSED(...)
Definition: assert.h:142

int botan_hotp_generate | ( | botan_hotp_t | hotp,
|  | uint32_t * | hotp_code,
|  | uint64_t | hotp_counter
| ) |  |

Generate a HOTP code for the provided counter

Definition at line 58 of file ffi_hotp.cpp.

References BOTAN_FFI_DO, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_UNUSED, and Botan::HOTP::generate_hotp().

61 {
62 #if defined(BOTAN_HAS_HOTP)
63 if(hotp == nullptr || hotp_code == nullptr)
64 return BOTAN_FFI_ERROR_NULL_POINTER;
65
66 return BOTAN_FFI_DO(Botan::HOTP, hotp, h, {
67 *hotp_code = h.generate_hotp(hotp_counter);
68 });
69
70 #else
71 BOTAN_UNUSED(hotp, hotp_code, hotp_counter);
72 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
73 #endif
74 }
BOTAN_FFI_ERROR_NOT_IMPLEMENTED
Definition: ffi.h:82
BOTAN_FFI_ERROR_NULL_POINTER
Definition: ffi.h:76
Botan::HOTP
Definition: hotp.h:18
BOTAN_UNUSED
#define BOTAN_UNUSED(...)
Definition: assert.h:142
BOTAN_FFI_DO
#define BOTAN_FFI_DO(T, obj, param, block)
Definition: ffi_util.h:92
Botan::HOTP::generate_hotp
uint32_t generate_hotp(uint64_t counter)
Definition: hotp.cpp:42

int botan_hotp_init | ( | botan_hotp_t * | hotp,
|  | const uint8_t | key[],
|  | size_t | key_len,
|  | const char * | hash_algo,
|  | size_t | digits
| ) |  |

Initialize a HOTP instance

Definition at line 24 of file ffi_hotp.cpp.

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

28 {
29 if(hotp == nullptr || key == nullptr || hash_algo == nullptr)
30 return BOTAN_FFI_ERROR_NULL_POINTER;
31
32 *hotp = nullptr;
33
34 #if defined(BOTAN_HAS_HOTP)
35 return ffi_guard_thunk(__func__, [=]() -> int {
36
37 *hotp = new botan_hotp_struct(
38 new Botan::HOTP(key, key_len, hash_algo, digits));
39
40 return BOTAN_FFI_SUCCESS;
41 });
42 #else
43 BOTAN_UNUSED(hotp, key, key_len, hash_algo, digits);
44 return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
45 #endif
46 }
Botan_FFI::ffi_guard_thunk
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:89
BOTAN_FFI_ERROR_NOT_IMPLEMENTED
Definition: ffi.h:82
BOTAN_FFI_ERROR_NULL_POINTER
Definition: ffi.h:76
Botan::HOTP
Definition: hotp.h:18
BOTAN_UNUSED
#define BOTAN_UNUSED(...)
Definition: assert.h:142
hash_algo
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:22
BOTAN_FFI_SUCCESS
Definition: ffi.h:62