taf_ks_common.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */
#ifndef TAF_KS_COMMON_H_INCLUDE_GUARD
#define TAF_KS_COMMON_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "le_limit_common.h"

#define IFGEN_TAF_KS_PROTOCOL_ID "a96b6ca7b1cbd694b769cfa50a9357e2"
#define IFGEN_TAF_KS_MSG_SIZE 4120



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_KS_MAX_KEY_ID_SIZE 256

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_KS_MAX_SEC_LABEL_SIZE 256

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_KS_MAX_PACKET_SIZE 4096

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_KS_MAX_AES_NONCE_SIZE 16

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_KS_MIN_HMAC_KEY_SIZE 8

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_KS_MAX_HMAC_KEY_SIZE 128

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_RSA_SIZE_1024 = 1,
    TAF_KS_RSA_SIZE_2048 = 2,
    TAF_KS_RSA_SIZE_3072 = 3,
    TAF_KS_RSA_SIZE_4096 = 4,
    TAF_KS_RSA_SIZE_MAX = 5
}
taf_ks_RsaKeySize_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_AES_SIZE_128 = 1,
    TAF_KS_AES_SIZE_192 = 2,
    TAF_KS_AES_SIZE_256 = 3,
    TAF_KS_AES_SIZE_MAX = 4
}
taf_ks_AesKeySize_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_ECC_SIZE_224 = 1,
    TAF_KS_ECC_SIZE_256 = 2,
    TAF_KS_ECC_SIZE_384 = 3,
    TAF_KS_ECC_SIZE_521 = 4,
    TAF_KS_ECC_SIZE_MAX = 5
}
taf_ks_EccKeySize_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_RSA_ENCRYPT_DECRYPT = 0,
    TAF_KS_RSA_ENCRYPT_ONLY = 1,
    TAF_KS_RSA_DECRYPT_ONLY = 2,
    TAF_KS_RSA_SIGN_VERIFY = 3,
    TAF_KS_RSA_SIGN_ONLY = 4,
    TAF_KS_RSA_VERIFY_ONLY = 5,
    TAF_KS_AES_ENCRYPT_DECRYPT = 6,
    TAF_KS_AES_ENCRYPT_ONLY = 7,
    TAF_KS_AES_DECRYPT_ONLY = 8,
    TAF_KS_ECDSA_SIGN_VERIFY = 9,
    TAF_KS_ECDSA_SIGN_ONLY = 10,
    TAF_KS_ECDSA_VERIFY_ONLY = 11,
    TAF_KS_HMAC_SIGN_VERIFY = 12,
    TAF_KS_HMAC_SIGN_ONLY = 13,
    TAF_KS_HMAC_VERIFY_ONLY = 14,
    TAF_KS_KEYUSAGE_MAX = 15
}
taf_ks_KeyUsage_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_CRYPTO_ENCRYPT = 0,
    TAF_KS_CRYPTO_DECRYPT = 1,
    TAF_KS_CRYPTO_SIGN = 2,
    TAF_KS_CRYPTO_VERIFY = 3,
    TAF_KS_CRYPTO_MAX = 4
}
taf_ks_CryptoPurpose_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_DIGEST_MD5 = 1,
    TAF_KS_DIGEST_SHA1 = 2,
    TAF_KS_DIGEST_SHA2_224 = 3,
    TAF_KS_DIGEST_SHA2_256 = 4,
    TAF_KS_DIGEST_SHA2_384 = 5,
    TAF_KS_DIGEST_SHA2_512 = 6,
    TAF_KS_DIGEST_MAX = 7
}
taf_ks_Digest_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_RSA_ENC_PAD_NONE = 0,
    TAF_KS_RSA_ENC_PAD_PKCS1_V15 = 1,
    TAF_KS_RSA_ENC_PAD_OAEP_MD5 = 2,
    TAF_KS_RSA_ENC_PAD_OAEP_SHA1 = 3,
    TAF_KS_RSA_ENC_PAD_OAEP_SHA2_224 = 4,
    TAF_KS_RSA_ENC_PAD_OAEP_SHA2_256 = 5,
    TAF_KS_RSA_ENC_PAD_OAEP_SHA2_384 = 6,
    TAF_KS_RSA_ENC_PAD_OAEP_SHA2_512 = 7,
    TAF_KS_RSA_ENC_PAD_MAX = 8
}
taf_ks_RsaEncPadding_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_RSA_SIG_PAD_NONE = 0,
    TAF_KS_RSA_SIG_PAD_PKCS1_V15_MD5 = 1,
    TAF_KS_RSA_SIG_PAD_PKCS1_V15_SHA1 = 2,
    TAF_KS_RSA_SIG_PAD_PKCS1_V15_SHA2_224 = 3,
    TAF_KS_RSA_SIG_PAD_PKCS1_V15_SHA2_256 = 4,
    TAF_KS_RSA_SIG_PAD_PKCS1_V15_SHA2_384 = 5,
    TAF_KS_RSA_SIG_PAD_PKCS1_V15_SHA2_512 = 6,
    TAF_KS_RSA_SIG_PAD_PSS_MD5 = 7,
    TAF_KS_RSA_SIG_PAD_PSS_SHA1 = 8,
    TAF_KS_RSA_SIG_PAD_PSS_SHA2_224 = 9,
    TAF_KS_RSA_SIG_PAD_PSS_SHA2_256 = 10,
    TAF_KS_RSA_SIG_PAD_PSS_SHA2_384 = 11,
    TAF_KS_RSA_SIG_PAD_PSS_SHA2_512 = 12,
    TAF_KS_RSA_SIG_PAD_MAX = 13
}
taf_ks_RsaSigPadding_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_KS_AES_MODE_ECB_PAD_NONE = 0,
    TAF_KS_AES_MODE_ECB_PAD_PKCS7 = 1,
    TAF_KS_AES_MODE_CBC_PAD_NONE = 2,
    TAF_KS_AES_MODE_CBC_PAD_PKCS7 = 3,
    TAF_KS_AES_MODE_CTR = 4,
    TAF_KS_AES_MODE_GCM = 5,
    TAF_KS_AES_MODE_MAX = 6
}
taf_ks_AesBlockMode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_ks_Key* taf_ks_KeyRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_ks_CryptoSession* taf_ks_CryptoSessionRef_t;



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_ks_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_ks_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_ks_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CreateKey
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL keyName,
        taf_ks_KeyUsage_t keyUsage,
        taf_ks_KeyRef_t* keyRefPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_GetKey
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL keyName,
        taf_ks_KeyRef_t* keyRefPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_DeleteKey
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_GetKeyUsage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        taf_ks_KeyUsage_t* keyUsagePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_SetKeyMaxUsesPerBoot
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        uint32_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_SetKeyMinSecondsBetweenOps
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        uint32_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_SetKeyAppData
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        const uint8_t* dataPtr,
        size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_SetKeyActiveDateTime
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        uint64_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_SetKeyOriginationExpireDateTime
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        uint64_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_SetKeyUsageExpireDateTime
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        uint64_t value
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_ProvisionRsaEncKeyValue
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        taf_ks_RsaKeySize_t keySize,
        taf_ks_RsaEncPadding_t padding,
        const uint8_t* impDataPtr,
        size_t impDataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_ProvisionRsaSigKeyValue
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        taf_ks_RsaKeySize_t keySize,
        taf_ks_RsaSigPadding_t padding,
        const uint8_t* impDataPtr,
        size_t impDataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_ProvisionEcdsaKeyValue
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        taf_ks_EccKeySize_t keySize,
        taf_ks_Digest_t digest,
        const uint8_t* impDataPtr,
        size_t impDataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_ProvisionAesKeyValue
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        taf_ks_AesKeySize_t keySize,
        taf_ks_AesBlockMode_t mode,
        const uint8_t* impDataPtr,
        size_t impDataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_ProvisionHmacKeyValue
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        uint32_t keySize,
        taf_ks_Digest_t digest,
        const uint8_t* impDataPtr,
        size_t impDataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_ExportKey
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        const uint8_t* appDataPtr,
        size_t appDataSize,
        uint8_t* expDataPtr,
        size_t* expDataSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CryptoSessionCreate
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_KeyRef_t keyRef,
        taf_ks_CryptoSessionRef_t* sessionRefPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CryptoSessionSetAesNonce
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_CryptoSessionRef_t sessionRef,
        const uint8_t* dataPtr,
        size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CryptoSessionSetAppData
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_CryptoSessionRef_t sessionRef,
        const uint8_t* dataPtr,
        size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CryptoSessionStart
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_CryptoSessionRef_t sessionRef,
        taf_ks_CryptoPurpose_t cryptoPurpose
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CryptoSessionProcessAead
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_CryptoSessionRef_t sessionRef,
        const uint8_t* dataPtr,
        size_t dataSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CryptoSessionProcess
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_CryptoSessionRef_t sessionRef,
        const uint8_t* inputDataPtr,
        size_t inputDataSize,
        uint8_t* outputDataPtr,
        size_t* outputDataSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CryptoSessionEnd
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_CryptoSessionRef_t sessionRef,
        const uint8_t* inputDataPtr,
        size_t inputDataSize,
        uint8_t* outputDataPtr,
        size_t* outputDataSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_ks_CryptoSessionAbort
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_ks_CryptoSessionRef_t sessionRef
);

#endif // TAF_KS_COMMON_H_INCLUDE_GUARD