auth_otp.h

/*
 * This file is part of the openHiTLS project.
 *
 * openHiTLS is licensed under the Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *
 *     http://license.coscl.org.cn/MulanPSL2
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */
 
#ifndef AUTH_OTP_H
#define AUTH_OTP_H
 
#include <stdint.h>
#include "bsl_params.h"
#include "bsl_obj.h"
#include "crypt_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct Otp_Ctx HITLS_AUTH_OtpCtx;
 
typedef enum {
    HITLS_AUTH_OTP_HOTP = 1,
    HITLS_AUTH_OTP_TOTP = 2,
} HITLS_AUTH_OtpType;
 
/* Commands for parameter operations and retrieval */
typedef enum {
    HITLS_AUTH_OTP_SET_CTX_DIGITS = 1, 
    HITLS_AUTH_OTP_SET_CTX_HASHALGID = 2, 
    HITLS_AUTH_OTP_SET_CTX_TOTP_TIMESTEPSIZE = 3, 
    HITLS_AUTH_OTP_SET_CTX_TOTP_STARTOFFSET = 4, 
    HITLS_AUTH_OTP_SET_CTX_TOTP_VALIDWINDOW = 5, 
    HITLS_AUTH_OTP_GET_CTX_PROTOCOLTYPE = 6, 
    HITLS_AUTH_OTP_GET_CTX_KEY = 7, 
    HITLS_AUTH_OTP_GET_CTX_DIGITS = 8, 
    HITLS_AUTH_OTP_GET_CTX_HASHALGID = 9, 
    HITLS_AUTH_OTP_GET_CTX_TOTP_TIMESTEPSIZE = 10, 
    HITLS_AUTH_OTP_GET_CTX_TOTP_STARTOFFSET = 11, 
    HITLS_AUTH_OTP_GET_CTX_TOTP_VALIDWINDOW = 12, 
} HITLS_AUTH_OtpCmd;
 
/* HMAC hashing algorithm used in TOTP. */
typedef enum {
    HITLS_AUTH_OTP_CRYPTO_SHA1 = BSL_CID_HMAC_SHA1,
    HITLS_AUTH_OTP_CRYPTO_SHA256 = BSL_CID_HMAC_SHA256,
    HITLS_AUTH_OTP_CRYPTO_SHA512 = BSL_CID_HMAC_SHA512
} HITLS_AUTH_OtpCryptAlgId;
 
typedef enum {
    HITLS_AUTH_OTP_RANDOM_CB = 1,
    HITLS_AUTH_OTP_HMAC_CB = 2,
} HITLS_AUTH_OtpCryptCbType;

typedef int32_t (*HITLS_AUTH_OtpHmac)(void *libCtx, const char *attrName, int32_t algId, const uint8_t *key,
                                      uint32_t keyLen, const uint8_t *input, uint32_t inputLen, uint8_t *hmac,
                                      uint32_t *hmacLen);

typedef int32_t (*HITLS_AUTH_OtpRandom)(uint8_t *buffer, uint32_t bufferLen);

HITLS_AUTH_OtpCtx *HITLS_AUTH_OtpNewCtx(int32_t protocolType);

HITLS_AUTH_OtpCtx *HITLS_AUTH_ProviderOtpNewCtx(CRYPT_EAL_LibCtx *libCtx, int32_t protocolType, const char *attrName);

void HITLS_AUTH_OtpFreeCtx(HITLS_AUTH_OtpCtx *ctx);

int32_t HITLS_AUTH_OtpSetCryptCb(HITLS_AUTH_OtpCtx *ctx, int32_t cbType, void *cryptCb);

int32_t HITLS_AUTH_OtpInit(HITLS_AUTH_OtpCtx *ctx, uint8_t *key, uint32_t keyLen);

int32_t HITLS_AUTH_OtpGen(HITLS_AUTH_OtpCtx *ctx, const BSL_Param *param, char *otp, uint32_t *otpLen);

int32_t HITLS_AUTH_OtpValidate(HITLS_AUTH_OtpCtx *ctx, const BSL_Param *param, const char *otp, const uint32_t otpLen,
                               uint64_t *matched);

int32_t HITLS_AUTH_OtpCtxCtrl(HITLS_AUTH_OtpCtx *ctx, int32_t cmd, void *param, uint32_t paramLen);
 
#ifdef __cplusplus
}
#endif
 
#endif // AUTH_OTP_H