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_des.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_DES_H__ 36 #define __N32WB452_DES_H__ 37 #include <stdint.h> 38 /** @addtogroup N32WB452_Algorithm_Library 39 * @{ 40 */ 41 42 /** @addtogroup DES 43 * @brief DES symmetrical cipher algorithm 44 * @{ 45 */ 46 #define DES_ECB (0x11111111) 47 #define DES_CBC (0x22222222) 48 49 50 #define DES_ENC (0x33333333) 51 #define DES_DEC (0x44444444) 52 53 #define DES_KEY (0x55555555) 54 #define TDES_2KEY (0x66666666) 55 #define TDES_3KEY (0x77777777) 56 57 enum DES 58 { 59 DES_Crypto_OK = 0x0, //DES/TDES opreation success 60 DES_Init_OK = 0x0, //DES/TDES Init opreation success 61 DES_Crypto_ModeError = 0x5a5a5a5a, //Working mode error(Neither ECB nor CBC) 62 DES_Crypto_EnOrDeError, //En&De error(Neither encryption nor decryption) 63 DES_Crypto_ParaNull, // the part of input(output/iv) Null 64 DES_Crypto_LengthError, //the length of input message must be 2 times and cannot be zero 65 DES_Crypto_KeyError, //keyMode error(Neither DES_KEY nor TDES_2KEY nor TDES_3KEY) 66 DES_Crypto_UnInitError, //DES/TDES 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 inWordLen; // the length(by word) of plaintext or cipher 76 uint32_t En_De; // 0x33333333- encrypt, 0x44444444 - decrypt 77 uint32_t Mode; // 0x11111111 - ECB, 0x22222222 - CBC 78 uint32_t keyMode; //TDES key mode: 0x55555555-key,0x66666666-2key, 0x77777777-3key 79 }DES_PARM; 80 81 /** 82 * @brief DES_Init 83 * @return DES_Init_OK, DES/TDES Init success; othets: DES/TDES Init fail 84 * @note 85 */ 86 uint32_t DES_Init(DES_PARM *parm); 87 88 /** 89 * @brief DES crypto 90 * @param[in] parm pointer to DES/TDES context and the detail please refer to struct DES_PARM in DES.h 91 * @return DES_Crypto_OK, DES/TDES crypto success; othets: DES/TDES crypto fail(reference to the definition by enum variation) 92 * @note 1.Please refer to the demo in user guidance before using this function 93 * 2.Input and output can be the same buffer 94 * 3. IV can be NULL when ECB mode 95 * 4. The word lengrh of message must be as times as 2. 96 * 5. If the input is in byte, make sure align by word. 97 */ 98 uint32_t DES_Crypto(DES_PARM *parm); 99 100 /** 101 * @brief DES close 102 * @return none 103 * @note if you want to close DES algorithm, this function can be recalled. 104 */ 105 void DES_Close(void); 106 107 /** 108 * @brief Get DES/TDES lib version 109 * @param[out] type pointer one byte type information represents the type of the lib, like Commercial version.\ 110 * @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. 111 * @param[out] customer pointer one byte customer information represents customer ID. for example, 0x00 stands for standard version, 0x01 is for Tianyu customized version... 112 * @param[out] date pointer array which include three bytes date information. If the returned bytes are 18,9,13,this denotes September 13,2018 113 * @param[out] version pointer one byte version information represents develop version of the lib. e.g. 0x12 denotes version 1.2. 114 * @return none 115 * @1.You can recall this function to get DES/TDES lib information 116 */ 117 void DES_Version(uint8_t *type, uint8_t *customer, uint8_t date[3], uint8_t *version); 118 119 #endif 120