aes.h
Go to the documentation of this file.
1 /**
2  * @file aes.h
3  * @brief AES (Advanced Encryption Standard)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.5.0
29  **/
30 
31 #ifndef _AES_H
32 #define _AES_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //Application specific context
38 #ifndef AES_PRIVATE_CONTEXT
39  #define AES_PRIVATE_CONTEXT
40 #endif
41 
42 //AES block size
43 #define AES_BLOCK_SIZE 16
44 //Common interface for encryption algorithms
45 #define AES_CIPHER_ALGO (&aesCipherAlgo)
46 
47 //C++ guard
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 
53 /**
54  * @brief AES algorithm context
55  **/
56 
57 typedef struct
58 {
59  uint_t nr;
60  uint32_t ek[60];
61  uint32_t dk[60];
62  AES_PRIVATE_CONTEXT
63 } AesContext;
64 
65 
66 //AES related constants
67 extern const uint8_t AES128_ECB_OID[9];
68 extern const uint8_t AES128_CBC_OID[9];
69 extern const uint8_t AES128_OFB_OID[9];
70 extern const uint8_t AES128_CFB_OID[9];
71 extern const uint8_t AES128_GCM_OID[9];
72 extern const uint8_t AES128_CCM_OID[9];
73 extern const uint8_t AES192_ECB_OID[9];
74 extern const uint8_t AES192_CBC_OID[9];
75 extern const uint8_t AES192_OFB_OID[9];
76 extern const uint8_t AES192_CFB_OID[9];
77 extern const uint8_t AES192_GCM_OID[9];
78 extern const uint8_t AES192_CCM_OID[9];
79 extern const uint8_t AES256_ECB_OID[9];
80 extern const uint8_t AES256_CBC_OID[9];
81 extern const uint8_t AES256_OFB_OID[9];
82 extern const uint8_t AES256_CFB_OID[9];
83 extern const uint8_t AES256_GCM_OID[9];
84 extern const uint8_t AES256_CCM_OID[9];
85 extern const CipherAlgo aesCipherAlgo;
86 
87 //AES related functions
88 error_t aesInit(AesContext *context, const uint8_t *key, size_t keyLen);
89 
90 void aesEncryptBlock(AesContext *context, const uint8_t *input,
91  uint8_t *output);
92 
93 void aesDecryptBlock(AesContext *context, const uint8_t *input,
94  uint8_t *output);
95 
96 void aesDeinit(AesContext *context);
97 
98 //C++ guard
99 #ifdef __cplusplus
100 }
101 #endif
102 
103 #endif
aesDeinit
void aesDeinit(AesContext *context)
Release AES context.
Definition: aes.c:571
AES256_ECB_OID
const uint8_t AES256_ECB_OID[9]
Definition: aes.c:206
AES_PRIVATE_CONTEXT
#define AES_PRIVATE_CONTEXT
Definition: aes.h:39
AES192_OFB_OID
const uint8_t AES192_OFB_OID[9]
Definition: aes.c:197
aesInit
error_t aesInit(AesContext *context, const uint8_t *key, size_t keyLen)
Key expansion.
Definition: aes.c:242
aesEncryptBlock
void aesEncryptBlock(AesContext *context, const uint8_t *input, uint8_t *output)
Encrypt a 16-byte block using AES algorithm.
Definition: aes.c:351
AES192_CCM_OID
const uint8_t AES192_CCM_OID[9]
Definition: aes.c:203
AesContext
AES algorithm context.
Definition: aes.h:58
AES128_GCM_OID
const uint8_t AES128_GCM_OID[9]
Definition: aes.c:188
AES128_OFB_OID
const uint8_t AES128_OFB_OID[9]
Definition: aes.c:184
AES128_CCM_OID
const uint8_t AES128_CCM_OID[9]
Definition: aes.c:190
error_t
error_t
Error codes.
Definition: error.h:43
crypto.h
General definitions for cryptographic algorithms.
AES192_GCM_OID
const uint8_t AES192_GCM_OID[9]
Definition: aes.c:201
aesDecryptBlock
void aesDecryptBlock(AesContext *context, const uint8_t *input, uint8_t *output)
Decrypt a 16-byte block using AES algorithm.
Definition: aes.c:462
AES128_ECB_OID
const uint8_t AES128_ECB_OID[9]
Definition: aes.c:180
AES192_ECB_OID
const uint8_t AES192_ECB_OID[9]
Definition: aes.c:193
AES128_CBC_OID
const uint8_t AES128_CBC_OID[9]
Definition: aes.c:182
AesContext::nr
uint_t nr
Definition: aes.h:59
AES192_CBC_OID
const uint8_t AES192_CBC_OID[9]
Definition: aes.c:195
AES256_CFB_OID
const uint8_t AES256_CFB_OID[9]
Definition: aes.c:212
AES128_CFB_OID
const uint8_t AES128_CFB_OID[9]
Definition: aes.c:186
CipherAlgo
Common interface for encryption algorithms.
Definition: crypto.h:1104
uint_t
unsigned int uint_t
Definition: compiler_port.h:57
AES256_GCM_OID
const uint8_t AES256_GCM_OID[9]
Definition: aes.c:214
AES256_CCM_OID
const uint8_t AES256_CCM_OID[9]
Definition: aes.c:216
aesCipherAlgo
const CipherAlgo aesCipherAlgo
Definition: aes.c:219
AES256_OFB_OID
const uint8_t AES256_OFB_OID[9]
Definition: aes.c:210
AES192_CFB_OID
const uint8_t AES192_CFB_OID[9]
Definition: aes.c:199
AES256_CBC_OID
const uint8_t AES256_CBC_OID[9]
Definition: aes.c:208