tfac.h

Go to the documentation of this file.

/*
   Copyright 2020 Raphael Beck
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
 
       http://www.apache.org/licenses/LICENSE-2.0
 
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
 
#ifndef TFAC_H
#define TFAC_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(_WIN32) && defined(TFAC_DLL)
#ifdef TFAC_BUILD_DLL
#define TFAC_API __declspec(dllexport)
#else
#define TFAC_API __declspec(dllimport)
#endif
#else
#define TFAC_API
#endif
 
#include <time.h>
#include <stdint.h>
#include <stddef.h>
 
#define TFAC_MAX_DIGITS 18
 
#define TFAC_MAX_SECRET_KEY_SIZE 256
 
#define TFAC_DEFAULT_HASH_ALGO 0
 
#define TFAC_DEFAULT_DIGITS 6
 
#define TFAC_DEFAULT_STEPS 30
 
enum tfac_hash_algo
{
    TFAC_SHA1 = 0,
    TFAC_SHA224 = 1,
    TFAC_SHA256 = 2,
};
 
struct tfac_token
{
    char string[32];
 
    uint64_t number;
};
 
struct tfac_secret
{
    char secret_key_base32[48 + 1];
 
    uint8_t secret_key[30];
};
 
struct tfac_version_number
{
    uint32_t major;
 
    uint32_t minor;
 
    uint32_t patch;
 
    char string[32];
};
 
TFAC_API struct tfac_secret tfac_generate_secret();
 
TFAC_API struct tfac_token tfac_totp(const char* secret_key_base32, uint8_t digits, uint8_t steps, enum tfac_hash_algo hash_algo);
 
TFAC_API uint64_t tfac_totp_raw(const uint8_t* secret_key, size_t secret_key_length, uint8_t digits, uint8_t steps, enum tfac_hash_algo hash_algo, time_t utc);
 
TFAC_API uint8_t tfac_verify_totp(const char* secret_key_base32, const char* totp, uint8_t digits, uint8_t steps, enum tfac_hash_algo hash_algo);
 
TFAC_API struct tfac_token tfac_hotp(const char* secret_key_base32, uint8_t digits, uint64_t counter, enum tfac_hash_algo hash_algo);
 
TFAC_API uint64_t tfac_hotp_raw(const uint8_t* secret_key, size_t secret_key_length, uint8_t digits, uint64_t counter, enum tfac_hash_algo hash_algo);
 
TFAC_API struct tfac_version_number tfac_get_version_number();
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // TFAC_H