security.h

00001 /*****************************************************************************
00002 *
00003 *  security.h  - CC3000 Host Driver Implementation.
00004 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
00005 *
00006 *  Redistribution and use in source and binary forms, with or without
00007 *  modification, are permitted provided that the following conditions
00008 *  are met:
00009 *
00010 *    Redistributions of source code must retain the above copyright
00011 *    notice, this list of conditions and the following disclaimer.
00012 *
00013 *    Redistributions in binary form must reproduce the above copyright
00014 *    notice, this list of conditions and the following disclaimer in the
00015 *    documentation and/or other materials provided with the   
00016 *    distribution.
00017 *
00018 *    Neither the name of Texas Instruments Incorporated nor the names of
00019 *    its contributors may be used to endorse or promote products derived
00020 *    from this software without specific prior written permission.
00021 *
00022 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
00023 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
00024 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00025 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
00026 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
00027 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
00028 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00029 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00030 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
00031 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
00032 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 *
00034 *****************************************************************************/
00035 #ifndef __SECURITY__
00036 #define __SECURITY__
00037 
00038 #include "socket.h"
00039 
00040 //*****************************************************************************
00041 //
00042 //! \addtogroup security
00043 //! @{
00044 //
00045 //*****************************************************************************
00046 
00047 /** CC3000 Host driver - Security
00048 *
00049 */
00050 
00051 #ifdef  __cplusplus
00052 extern "C" {
00053 #endif
00054 
00055 
00056 #define AES128_KEY_SIZE        16
00057 
00058 
00059 #ifndef CC3000_UNENCRYPTED_SMART_CONFIG
00060 
00061 // forward sbox
00062 const unsigned char sbox[256] =   { 
00063 //0     1    2      3     4    5     6     7      8    9     A      B    C     D     E     F
00064 0x63, 0x7c, 0x77, 0x7b, 0xf2, 0x6b, 0x6f, 0xc5, 0x30, 0x01, 0x67, 0x2b, 0xfe, 0xd7, 0xab, 0x76, //0
00065 0xca, 0x82, 0xc9, 0x7d, 0xfa, 0x59, 0x47, 0xf0, 0xad, 0xd4, 0xa2, 0xaf, 0x9c, 0xa4, 0x72, 0xc0, //1
00066 0xb7, 0xfd, 0x93, 0x26, 0x36, 0x3f, 0xf7, 0xcc, 0x34, 0xa5, 0xe5, 0xf1, 0x71, 0xd8, 0x31, 0x15, //2
00067 0x04, 0xc7, 0x23, 0xc3, 0x18, 0x96, 0x05, 0x9a, 0x07, 0x12, 0x80, 0xe2, 0xeb, 0x27, 0xb2, 0x75, //3
00068 0x09, 0x83, 0x2c, 0x1a, 0x1b, 0x6e, 0x5a, 0xa0, 0x52, 0x3b, 0xd6, 0xb3, 0x29, 0xe3, 0x2f, 0x84, //4
00069 0x53, 0xd1, 0x00, 0xed, 0x20, 0xfc, 0xb1, 0x5b, 0x6a, 0xcb, 0xbe, 0x39, 0x4a, 0x4c, 0x58, 0xcf, //5
00070 0xd0, 0xef, 0xaa, 0xfb, 0x43, 0x4d, 0x33, 0x85, 0x45, 0xf9, 0x02, 0x7f, 0x50, 0x3c, 0x9f, 0xa8, //6
00071 0x51, 0xa3, 0x40, 0x8f, 0x92, 0x9d, 0x38, 0xf5, 0xbc, 0xb6, 0xda, 0x21, 0x10, 0xff, 0xf3, 0xd2, //7
00072 0xcd, 0x0c, 0x13, 0xec, 0x5f, 0x97, 0x44, 0x17, 0xc4, 0xa7, 0x7e, 0x3d, 0x64, 0x5d, 0x19, 0x73, //8
00073 0x60, 0x81, 0x4f, 0xdc, 0x22, 0x2a, 0x90, 0x88, 0x46, 0xee, 0xb8, 0x14, 0xde, 0x5e, 0x0b, 0xdb, //9
00074 0xe0, 0x32, 0x3a, 0x0a, 0x49, 0x06, 0x24, 0x5c, 0xc2, 0xd3, 0xac, 0x62, 0x91, 0x95, 0xe4, 0x79, //A
00075 0xe7, 0xc8, 0x37, 0x6d, 0x8d, 0xd5, 0x4e, 0xa9, 0x6c, 0x56, 0xf4, 0xea, 0x65, 0x7a, 0xae, 0x08, //B
00076 0xba, 0x78, 0x25, 0x2e, 0x1c, 0xa6, 0xb4, 0xc6, 0xe8, 0xdd, 0x74, 0x1f, 0x4b, 0xbd, 0x8b, 0x8a, //C
00077 0x70, 0x3e, 0xb5, 0x66, 0x48, 0x03, 0xf6, 0x0e, 0x61, 0x35, 0x57, 0xb9, 0x86, 0xc1, 0x1d, 0x9e, //D
00078 0xe1, 0xf8, 0x98, 0x11, 0x69, 0xd9, 0x8e, 0x94, 0x9b, 0x1e, 0x87, 0xe9, 0xce, 0x55, 0x28, 0xdf, //E
00079 0x8c, 0xa1, 0x89, 0x0d, 0xbf, 0xe6, 0x42, 0x68, 0x41, 0x99, 0x2d, 0x0f, 0xb0, 0x54, 0xbb, 0x16 }; //F   
00080 // inverse sbox
00081 const unsigned char rsbox[256] =
00082 { 0x52, 0x09, 0x6a, 0xd5, 0x30, 0x36, 0xa5, 0x38, 0xbf, 0x40, 0xa3, 0x9e, 0x81, 0xf3, 0xd7, 0xfb
00083 , 0x7c, 0xe3, 0x39, 0x82, 0x9b, 0x2f, 0xff, 0x87, 0x34, 0x8e, 0x43, 0x44, 0xc4, 0xde, 0xe9, 0xcb
00084 , 0x54, 0x7b, 0x94, 0x32, 0xa6, 0xc2, 0x23, 0x3d, 0xee, 0x4c, 0x95, 0x0b, 0x42, 0xfa, 0xc3, 0x4e
00085 , 0x08, 0x2e, 0xa1, 0x66, 0x28, 0xd9, 0x24, 0xb2, 0x76, 0x5b, 0xa2, 0x49, 0x6d, 0x8b, 0xd1, 0x25
00086 , 0x72, 0xf8, 0xf6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xd4, 0xa4, 0x5c, 0xcc, 0x5d, 0x65, 0xb6, 0x92
00087 , 0x6c, 0x70, 0x48, 0x50, 0xfd, 0xed, 0xb9, 0xda, 0x5e, 0x15, 0x46, 0x57, 0xa7, 0x8d, 0x9d, 0x84
00088 , 0x90, 0xd8, 0xab, 0x00, 0x8c, 0xbc, 0xd3, 0x0a, 0xf7, 0xe4, 0x58, 0x05, 0xb8, 0xb3, 0x45, 0x06
00089 , 0xd0, 0x2c, 0x1e, 0x8f, 0xca, 0x3f, 0x0f, 0x02, 0xc1, 0xaf, 0xbd, 0x03, 0x01, 0x13, 0x8a, 0x6b
00090 , 0x3a, 0x91, 0x11, 0x41, 0x4f, 0x67, 0xdc, 0xea, 0x97, 0xf2, 0xcf, 0xce, 0xf0, 0xb4, 0xe6, 0x73
00091 , 0x96, 0xac, 0x74, 0x22, 0xe7, 0xad, 0x35, 0x85, 0xe2, 0xf9, 0x37, 0xe8, 0x1c, 0x75, 0xdf, 0x6e
00092 , 0x47, 0xf1, 0x1a, 0x71, 0x1d, 0x29, 0xc5, 0x89, 0x6f, 0xb7, 0x62, 0x0e, 0xaa, 0x18, 0xbe, 0x1b
00093 , 0xfc, 0x56, 0x3e, 0x4b, 0xc6, 0xd2, 0x79, 0x20, 0x9a, 0xdb, 0xc0, 0xfe, 0x78, 0xcd, 0x5a, 0xf4
00094 , 0x1f, 0xdd, 0xa8, 0x33, 0x88, 0x07, 0xc7, 0x31, 0xb1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xec, 0x5f
00095 , 0x60, 0x51, 0x7f, 0xa9, 0x19, 0xb5, 0x4a, 0x0d, 0x2d, 0xe5, 0x7a, 0x9f, 0x93, 0xc9, 0x9c, 0xef
00096 , 0xa0, 0xe0, 0x3b, 0x4d, 0xae, 0x2a, 0xf5, 0xb0, 0xc8, 0xeb, 0xbb, 0x3c, 0x83, 0x53, 0x99, 0x61
00097 , 0x17, 0x2b, 0x04, 0x7e, 0xba, 0x77, 0xd6, 0x26, 0xe1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0c, 0x7d };
00098 // round constant
00099 const unsigned char Rcon[11] = {0x8d, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36};
00100 
00101 /**
00102 * expand a 16 bytes key for AES128 implementation.
00103 * @param   key          AES128 key - 16 bytes
00104 * @param   expandedKey  expanded AES128 key
00105 * @return  none
00106 */
00107 void expandKey(unsigned char *expandedKey, unsigned char *key);
00108 
00109 /**
00110 * multiply by 2 in the galois field.
00111 * @param   value    argument to multiply
00112 * @return  multiplied argument
00113 */
00114 unsigned char galois_mul2(unsigned char value);
00115 
00116 /**
00117 * internal implementation of AES128 encryption.
00118 * straight forward aes encryption implementation\n
00119 * first the group of operations
00120 * - addRoundKey
00121 * - subbytes
00122 * - shiftrows
00123 * - mixcolums\n
00124 *
00125 * is executed 9 times, after this addroundkey to finish the 9th\n 
00126 * round, after that the 10th round without mixcolums\n
00127 * no further subfunctions to save cycles for function calls\n
00128 * no structuring with "for (....)" to save cycles.\n
00129 * @param[in]  expandedKey expanded AES128 key
00130 * @param[in/out] state 16 bytes of plain text and cipher text
00131 * @return  none
00132 */
00133 void aes_encr(unsigned char *state, unsigned char *expandedKey);
00134 
00135 /**
00136 * internal implementation of AES128 decryption.
00137 * straightforward aes decryption implementation\n
00138 * the order of substeps is the exact reverse of decryption\n
00139 * inverse functions:
00140 * - addRoundKey is its own inverse
00141 * - rsbox is inverse of sbox
00142 * - rightshift instead of leftshift
00143 * - invMixColumns = barreto + mixColumns\n
00144 *
00145 * no further subfunctions to save cycles for function calls\n
00146 * no structuring with "for (....)" to save cycles\n
00147 * @param[in]     expandedKey expanded AES128 key
00148 * @param[in\out] state 16 bytes of cipher text and plain text
00149 * @return  none
00150 */
00151 void aes_decr(unsigned char *state, unsigned char *expandedKey);
00152 
00153 /**
00154 * AES128 encryption.
00155 * Given AES128 key and 16 bytes plain text, cipher text of 16 bytes is computed.\n
00156 * The AES implementation is in mode ECB (Electronic Code Book).\n 
00157 * @param[in]  key   AES128 key of size 16 bytes
00158 * @param[in\out] state   16 bytes of plain text and cipher text
00159 * @return  none
00160 */
00161 extern void aes_encrypt(unsigned char *state, unsigned char *key);
00162 
00163 /**
00164 * AES128 decryption.
00165 * Given AES128 key and  16 bytes cipher text, plain text of 16 bytes is computed.\n
00166 * The AES implementation is in mode ECB (Electronic Code Book).\n
00167 * @param[in]  key   AES128 key of size 16 bytes
00168 * @param[in\out] state   16 bytes of cipher text and plain text
00169 * @return  none
00170 */
00171 extern void aes_decrypt(unsigned char *state, unsigned char *key);
00172 
00173 
00174 /**
00175 * Read the AES128 key from fileID #12 in EEPROM.
00176 * @param[out]  key   AES128 key of size 16 bytes
00177 * @return  0 on success, error otherwise.
00178 */
00179 extern signed long aes_read_key(unsigned char *key);
00180 
00181 /**
00182 * Write the AES128 key to fileID #12 in EEPROM.
00183 * @param[out]  key   AES128 key of size 16 bytes
00184 * @return  on success 0, error otherwise.
00185 */
00186 extern signed long aes_write_key(unsigned char *key);
00187 
00188 #endif //CC3000_UNENCRYPTED_SMART_CONFIG
00189 
00190 #ifdef  __cplusplus
00191 }
00192 #endif // __cplusplus
00193 
00194 //*****************************************************************************
00195 //
00196 // Close the Doxygen group.
00197 //! @}
00198 //
00199 //*****************************************************************************
00200 
00201 #endif //__SECURITY__
00202 
00203 
00204 
00205 
00206 
00207