rec.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 REC_H
#define REC_H
 
#include <stdbool.h>
#include <stdint.h>
#include "hitls_build.h"
#include "hitls_crypt_type.h"
#include "tls.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DTLS_MIN_MTU 256    /* Minimum MTU setting size */
#define REC_MAX_PLAIN_LENGTH 16384          /* Maximum plain length */
/* TLS13 Maximum MAC address padding */
#define REC_MAX_TLS13_ENCRYPTED_OVERHEAD  256u
/* TLS13 Maximum ciphertext length */
#define REC_MAX_TLS13_ENCRYPTED_LEN (REC_MAX_PLAIN_LENGTH + REC_MAX_TLS13_ENCRYPTED_OVERHEAD)
 
#define REC_MASTER_SECRET_LEN 48
#define REC_RANDOM_LEN  32
 
#define RECORD_HEADER 0x100
#define RECORD_INNER_CONTENT_TYPE 0x101
/*
 * record type
 */
typedef enum {
    REC_TYPE_CHANGE_CIPHER_SPEC = 20,
    REC_TYPE_ALERT = 21,
    REC_TYPE_HANDSHAKE = 22,
    REC_TYPE_APP = 23,
    REC_TYPE_UNKNOWN = 255
} REC_Type;
 
/*
 * SecurityParameters, used to generate keys and initialize the connect state
 */
typedef struct {
    bool isClient;                  /* Connection Endpoint */
    bool isClientTrafficSecret;     /* TrafficSecret type */
    HITLS_HashAlgo prfAlg;          /* prf_algorithm */
    HITLS_MacAlgo macAlg;           /* mac algorithm */
    HITLS_CipherAlgo cipherAlg;     /* symmetric encryption algorithm */
    HITLS_CipherType cipherType;    /* encryption algorithm type */
 
    /* key length */
    uint8_t fixedIvLength;          /* iv length. In TLS1.2 AEAD algorithm is the implicit IV length */
    uint8_t encKeyLen;              /* Length of the symmetric key */
    uint8_t macKeyLen;              /* MAC key length: If the AEAD algorithm is used, the MAC key length is 0 */
 
    uint8_t blockLength;            /* If the block length is not zero, the alignment should be handled. */
    uint8_t recordIvLength;         /* The explicit IV needs to be sent to the peer */
    uint8_t macLen;                 /*  MAC length. For AEAD, it is the mark length */
 
    uint8_t masterSecret[MAX_DIGEST_SIZE];             /* tls1.2 master key. TLS1.3 carries the TrafficSecret */
    uint8_t clientRandom[REC_RANDOM_LEN];              /* Client random number */
    uint8_t serverRandom[REC_RANDOM_LEN];              /* service random number */
} REC_SecParameters;

int32_t REC_Init(TLS_Ctx *ctx);

void REC_DeInit(TLS_Ctx *ctx);

bool REC_ReadHasPending(const TLS_Ctx *ctx);

int32_t REC_Read(TLS_Ctx *ctx, REC_Type recordType, uint8_t *data, uint32_t *readLen, uint32_t num);

int32_t REC_Write(TLS_Ctx *ctx, REC_Type recordType, const uint8_t *data, uint32_t num);

void REC_ActiveOutdatedWriteState(TLS_Ctx *ctx);

void REC_DeActiveOutdatedWriteState(TLS_Ctx *ctx);

int32_t REC_InitPendingState(const TLS_Ctx *ctx, const REC_SecParameters *param);

int32_t REC_ActivePendingState(TLS_Ctx *ctx, bool isOut);

int32_t REC_QueryMtu(TLS_Ctx *ctx);

int32_t REC_GetMaxWriteSize(const TLS_Ctx *ctx, uint32_t *len);

int32_t REC_GetMaxDataMtu(const TLS_Ctx *ctx, uint32_t *len);

int32_t REC_TLS13InitPendingState(const TLS_Ctx *ctx, const REC_SecParameters *param, bool isOut);

int32_t REC_RetransmitListAppend(REC_Ctx *recCtx, REC_Type type, const uint8_t *msg, uint32_t len);

void REC_RetransmitListClean(REC_Ctx *recCtx);

int32_t REC_RetransmitListFlush(TLS_Ctx *ctx);
 
REC_Type REC_GetUnexpectedMsgType(TLS_Ctx *ctx);
 
bool REC_HaveReadSuiteInfo(const TLS_Ctx *ctx);

uint32_t APP_GetReadPendingBytes(const TLS_Ctx *ctx);
 
int32_t REC_RecOutBufReSet(TLS_Ctx *ctx);

int32_t REC_FlightTransmit(TLS_Ctx *ctx);

uint32_t REC_GetOutBufPendingSize(const TLS_Ctx *ctx);

int32_t REC_OutBufFlush(TLS_Ctx *ctx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* REC_H */