hzl_Client.h

Go to the documentation of this file.

/*
 * Copyright © 2020-2022, Matjaž Guštin <dev@matjaz.it>
 * <https://matjaz.it>. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS “AS IS”
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef HZL_CLIENT_H_
#define HZL_CLIENT_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "hzl.h"
 
typedef struct hzl_ClientConfig
{
    HZL_SET_BY_USER uint16_t timeoutReqToResMillis;
    HZL_SET_BY_USER uint8_t ltk[HZL_LTK_LEN];
    HZL_SET_BY_USER hzl_Sid_t sid;
    HZL_SET_BY_USER uint8_t headerType;
    HZL_SET_BY_USER uint8_t amountOfGroups;
    uint8_t unusedPadding[1];
} hzl_ClientConfig_t;
 
_Static_assert(sizeof(hzl_ClientConfig_t) == 22,
               "The size of the Client Config struct must be exactly 22 B");
 
typedef struct hzl_ClientGroupConfig
{
    HZL_SET_BY_USER uint32_t maxCtrnonceDelayMsgs;
    HZL_SET_BY_USER uint16_t maxSilenceIntervalMillis;
    HZL_SET_BY_USER uint16_t sessionRenewalDurationMillis;
    HZL_SET_BY_USER hzl_Gid_t gid;
    uint8_t unusedPadding[3];
} hzl_ClientGroupConfig_t;
 
_Static_assert(sizeof(hzl_ClientGroupConfig_t) == 12,
               "The size of the Client Group Config struct must be exactly 12 B");
 
typedef struct hzl_ClientGroupState
{
    hzl_ReqNonce_t requestNonce;
    hzl_Timestamp_t lastHandshakeEventInstant;
    hzl_Timestamp_t currentRxLastMessageInstant;
    hzl_Timestamp_t previousRxLastMessageInstant;
    hzl_CtrNonce_t currentCtrNonce;
    hzl_CtrNonce_t previousCtrNonce;
    uint8_t currentStk[HZL_LTK_LEN];
    uint8_t previousStk[HZL_LTK_LEN];
    uint8_t unusedPadding[4];
} hzl_ClientGroupState_t;
 
_Static_assert(sizeof(hzl_ClientGroupState_t) == 64,
               "The size of the Client Group state struct must be exactly 64 B");
 
typedef struct hzl_ClientCtx
{
    HZL_SET_BY_USER const hzl_ClientConfig_t* clientConfig;
    HZL_SET_BY_USER const hzl_ClientGroupConfig_t* groupConfigs;
    HZL_SET_BY_USER hzl_ClientGroupState_t* groupStates;
    HZL_SET_BY_USER hzl_Io_t io;
} hzl_ClientCtx_t;
 
HZL_API hzl_Err_t
hzl_ClientInit(hzl_ClientCtx_t* ctx);
 
HZL_API hzl_Err_t
hzl_ClientDeInit(hzl_ClientCtx_t* ctx);
 
HZL_API hzl_Err_t
hzl_ClientBuildRequest(hzl_CbsPduMsg_t* requestPdu,
                       hzl_ClientCtx_t* ctx,
                       hzl_Gid_t groupId);
 
HZL_API hzl_Err_t
hzl_ClientBuildUnsecured(hzl_CbsPduMsg_t* unsecuredPdu,
                         const hzl_ClientCtx_t* ctx,
                         const uint8_t* userData,
                         size_t userDataLen,
                         hzl_Gid_t groupId);
 
HZL_API hzl_Err_t
hzl_ClientBuildSecuredFd(hzl_CbsPduMsg_t* securedPdu,
                         hzl_ClientCtx_t* ctx,
                         const uint8_t* userData,
                         size_t userDataLen,
                         hzl_Gid_t groupId);
 
HZL_API hzl_Err_t
hzl_ClientProcessReceived(hzl_CbsPduMsg_t* reactionPdu,
                          hzl_RxSduMsg_t* receivedUserData,
                          hzl_ClientCtx_t* ctx,
                          const uint8_t* receivedPdu,
                          size_t receivedPduLen,
                          hzl_CanId_t receivedCanId);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* HZL_CLIENT_H_ */