alert.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 ALTER_H
#define ALTER_H
 
#include <stdbool.h>
#include <stdint.h>
#include "hitls_build.h"
#include "tls.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    ALERT_FLAG_NO = 0,      /* no alert message */
    ALERT_FLAG_RECV,        /* received the alert message */
    ALERT_FLAG_SEND,        /* the alert message needs to be sent */
} ALERT_FLAG;

typedef struct {
    uint8_t flag;           /* send and receive flags, see ALERT_FLAG */
    uint8_t level;          /* Alert level. For details, see ALERT_Level. */
    uint8_t description;    /* Alert description. For details, see ALERT_Description. */
    uint8_t reverse;        /* reserve, 4-byte aligned */
} ALERT_Info;

int32_t ALERT_Init(TLS_Ctx *ctx);

void ALERT_Deinit(TLS_Ctx *ctx);

bool ALERT_GetFlag(const TLS_Ctx *ctx);

void ALERT_GetInfo(const TLS_Ctx *ctx, ALERT_Info *info);

void ALERT_CleanInfo(const TLS_Ctx *ctx);

void ALERT_Send(const TLS_Ctx *ctx, ALERT_Level level, ALERT_Description description);

int32_t ALERT_Flush(TLS_Ctx *ctx);

int32_t ProcessDecryptedAlert(TLS_Ctx *ctx, const uint8_t *data, uint32_t dataLen);

int32_t ProcessPlainAlert(TLS_Ctx *ctx, const uint8_t *data, uint32_t dataLen);

void ALERT_ClearWarnCount(TLS_Ctx *ctx, uint32_t recordType);

bool ALERT_HaveExceeded(TLS_Ctx *ctx, uint8_t threshold);
 
#ifdef HITLS_BSL_LOG
int32_t ReturnAlertProcess(TLS_Ctx *ctx, int32_t err, uint32_t logId, const void *logStr,
    ALERT_Description description);
 
#define RETURN_ALERT_PROCESS(ctx, err, logId, logStr, description) \
    ReturnAlertProcess(ctx, err, logId, LOG_STR(logStr), description)
 
#else
 
#define RETURN_ALERT_PROCESS(ctx, err, logId, logStr, description) \
    (ctx)->method.sendAlert(ctx, ALERT_LEVEL_FATAL, description), (err)
#endif /* HITLS_BSL_LOG */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ALTER_H */