/*
 * Copyright (c) 2014-2016 ARM Limited. All rights reserved.
 *
 * SPDX-License-Identifier: LicenseRef-PBL
 *
 * Licensed under the Permissive Binary License, Version 1.0 (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.mbed.com/licenses/PBL-1.0
 *
 * See the License for the specific language governing permissions and limitations under the License.
 *
 */
#ifndef CCMLIB_H_
#define CCMLIB_H_

#include "ns_types.h"

/**
 *
 * \file ccmLIB.h
 * \brief CCM Library API.
 *
 *  \section ccm-api CCM Library API:
 *  - ccm_sec_init(), A function to init CCM library.
 *  - ccm_process_run(), A function to run configured CCM process.
 *
 *  \section ccm-instruction CCM process sequence:
 *  1. Init CCM library by, ccm key, ccm_sec_init()
 *      - security level
 *      - 128-bit CCM key
 *      - mode: AES_CCM_ENCRYPT or AES_CCM_DECRYPT
 *      - CCM L parameter: 2 or 3 depending on the nonce length (802.15.4 use 2 and TLS security use 3)
 *  2. Define ADATA pointer and length, if returned global structure mic_len field is > 0
 *  3. Set data pointer and length
 *  4. Do configured CCM process ccm_process_run()
 *  5. Check return value:
 *      -If 0 Process ok
 *      -< 0 MIC fail or parameter fail
 *
 *  \section ccm-mutex CCM Mutex for Multi Thread System
 *  If you are running a multi thread system and the CCM library will be used for multiple thread, do the following:
 *  1. Add compiler flag to library build process CCM_USE_MUTEX.
 *  2. Define OS-specific mutex at the application.
 *  3. Implement arm_ccm_mutex_lock() arm_ccm_mutex_unlock() function for using the generated and initialized mutex.
 */
#ifdef __cplusplus
extern "C" {
#endif
#define AES_NO_SECURITY                 0x00    /**< No security */
#define AES_SECURITY_LEVEL_MIC32        0x01    /**< MIC32 */
#define AES_SECURITY_LEVEL_MIC64        0x02    /**< MIC64 */
#define AES_SECURITY_LEVEL_MIC128       0x03    /**< MIC128 */
#define AES_SECURITY_LEVEL_ENC          0x04    /**< ENC */
#define AES_SECURITY_LEVEL_ENC_MIC32    0x05    /**< ENC_MIC32 */
#define AES_SECURITY_LEVEL_ENC_MIC64    0x06    /**< ENC_MIC64 */
#define AES_SECURITY_LEVEL_ENC_MIC128   0x07    /**< ENC_MIC128 */

#define AES_CCM_ENCRYPT                 0x00    /**< Encryption mode */
#define AES_CCM_DECRYPT                 0x01    /**< Decryption mode */


/**
 * \brief A function for locking CCM mutex if the OS is multi thread. If you are using single thread create an empty function.
 */
extern void arm_ccm_mutex_lock(void);
/**
 * \brief A function for unlocking CCM mutex if the OS is multi thread. If you are using single thread create an empty function
 */
extern void arm_ccm_mutex_unlock(void);

/*!
 * \struct ccm_globals_t
 * \brief CCM global structure.
 * The structure is used for configuring NONCE, adata and data before calling ccm_process_run().
 */
typedef struct {
    uint8_t exp_nonce[15];  /**< CCM NONCE buffer Nonce. */
    uint8_t *data_ptr;      /**< Pointer to data IN. */
    uint16_t data_len;      /**< Length of data IN. */
    const uint8_t *adata_ptr;   /**< Pointer to authentication data. */
    uint16_t adata_len;     /**< Length of authentication data. */
    uint8_t mic_len;        /**< ccm_sec_init() sets here the length of MIC. */
    uint8_t *mic;           /**< Encrypt process writes MIC. Decrypt reads it and compares it with the MIC obtained from data. */
} ccm_globals_t;

/**
 * \brief A function to initialize the CCM library.
 * \param sec_level Used CCM security level (0-7).
 * \param ccm_key Pointer to 128-key.
 * \param mode AES_CCM_ENCRYPT or AES_CCM_DECRYPT.
 * \param ccm_l Can be 2 or 3. 2 when NONCE length is 13 and 3 when 12. (NONCE length = (15-ccm_l))
 *
 * \return Pointer to Global CCM parameter buffer.
 * \return 0 When parameter fails or CCM is busy.
 */
extern ccm_globals_t *ccm_sec_init(uint8_t sec_level, const uint8_t *ccm_key, uint8_t mode, uint8_t ccm_l);

/**
 * \brief A function to run the configured CCM process.
 * When AES_CCM_ENCRYPT mode is selected and MIC is needed, the library saves MIC right after the encrypted data.
 * \param ccm_params CCM parameters
 *
 * \return 0 CCM process OK and when AES_CCM_DECRYPT mode was selected also MIC was correct.
 * \return -1 Init not called or data or adata pointers or lengths are zero.
 * \return -2 Null pointer given to function.
 */
extern int8_t ccm_process_run(ccm_globals_t *ccm_params);
#ifdef __cplusplus
}
#endif

#endif /* CCMLIB_H_ */
