1 /***************************************************************************** 2 * Copyright (c) 2019, Nations Technologies Inc. 3 * 4 * All rights reserved. 5 * **************************************************************************** 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions are met: 9 * 10 * - Redistributions of source code must retain the above copyright notice, 11 * this list of conditions and the disclaimer below. 12 * 13 * Nations' name may not be used to endorse or promote products derived from 14 * this software without specific prior written permission. 15 * 16 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY NATIONS "AS IS" AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE 19 * DISCLAIMED. IN NO EVENT SHALL NATIONS BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 22 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 23 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 24 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 25 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * ****************************************************************************/ 27 28 /** 29 * @file n32wb452_aes.h 30 * @author Nations 31 * @version v1.0.0 32 * 33 * @copyright Copyright (c) 2019, Nations Technologies Inc. All rights reserved. 34 */ 35 #ifndef __N32WB452_AES_H__ 36 #define __N32WB452_AES_H__ 37 38 #include <stdint.h> 39 /** @addtogroup N32WB452_Algorithm_Library 40 * @{ 41 */ 42 43 /** @addtogroup AES 44 * @brief AES symmetrical cipher algorithm 45 * @{ 46 */ 47 48 #define AES_ECB (0x11111111) 49 #define AES_CBC (0x22222222) 50 #define AES_CTR (0x33333333) 51 52 #define AES_ENC (0x44444444) 53 #define AES_DEC (0x55555555) 54 55 enum 56 { 57 AES_Crypto_OK = 0x0, //AES opreation success 58 AES_Init_OK = 0x0, //AES Init opreation success 59 AES_Crypto_ModeError = 0x5a5a5a5a, //Working mode error(Neither ECB nor CBC nor CTR) 60 AES_Crypto_EnOrDeError, //En&De error(Neither encryption nor decryption) 61 AES_Crypto_ParaNull, // the part of input(output/iv) Null 62 AES_Crypto_LengthError, // if Working mode is ECB or CBC,the length of input message must be 4 times and cannot be zero; 63 //if Working mode is CTR,the length of input message cannot be zero; othets: return AES_Crypto_LengthError 64 65 AES_Crypto_KeyLengthError, //the keyWordLen must be 4 or 6 or 8; othets:return AES_Crypto_KeyLengthError 66 AES_Crypto_UnInitError, //AES uninitialized 67 }; 68 69 typedef struct 70 { 71 uint32_t *in; // the part of input to be encrypted or decrypted 72 uint32_t *iv; // the part of initial vector 73 uint32_t *out; // the part of out 74 uint32_t *key; // the part of key 75 uint32_t keyWordLen; // the length(by word) of key 76 uint32_t inWordLen; // the length(by word) of plaintext or cipher 77 uint32_t En_De; // 0x44444444- encrypt, 0x55555555 - decrypt 78 uint32_t Mode; // 0x11111111 - ECB, 0x22222222 - CBC, 0x33333333 - CTR 79 }AES_PARM; 80 81 /** 82 * @brief AES_Init 83 * @return AES_Init_OK, AES Init success; othets: AES Init fail 84 * @note 85 */ 86 87 uint32_t AES_Init(AES_PARM *parm); 88 89 /** 90 * @brief AES crypto 91 * @param[in] parm pointer to AES context and the detail please refer to struct AES_PARM in AES.h 92 * @return AES_Crypto_OK, AES crypto success; othets: AES crypto fail(reference to the definition by enum variation) 93 * @note 1.Please refer to the demo in user guidance before using this function 94 * 2.Input and output can be the same buffer 95 * 3. IV can be NULL when ECB mode 96 * 4. If Working mode is ECB or CBC,the length of input message must be 4 times and cannot be zero; 97 * if Working mode is CTR,the length of input message cannot be zero; 98 * 5. If the input is in byte, make sure align by word. 99 */ 100 uint32_t AES_Crypto(AES_PARM *parm); 101 102 /** 103 * @brief AES close 104 * @return none 105 * @note if you want to close AES algorithm, this function can be recalled. 106 */ 107 void AES_Close(void); 108 109 /** 110 * @brief Get AES lib version 111 * @param[out] type pointer one byte type information represents the type of the lib, like Commercial version.\ 112 * @Bits 0~4 stands for Commercial (C), Security (S), Normal (N), Evaluation (E), Test (T), Bits 5~7 are reserved. e.g. 0x09 stands for CE version. 113 * @param[out] customer pointer one byte customer information represents customer ID. for example, 0x00 stands for standard version, 0x01 is for Tianyu customized version... 114 * @param[out] date pointer array which include three bytes date information. If the returned bytes are 18,9,13,this denotes September 13,2018 115 * @param[out] version pointer one byte version information represents develop version of the lib. e.g. 0x12 denotes version 1.2. 116 * @return none 117 * @1.You can recall this function to get AES lib information 118 */ 119 void AES_Version(uint8_t *type, uint8_t *customer, uint8_t date[3], uint8_t *version); 120 121 122 123 124 #endif 125 126 127