gcm.h
Go to the documentation of this file.
1 /**
2  * @file gcm.h
3  * @brief Galois/Counter Mode (GCM)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 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 1.9.6
29  **/
30 
31 #ifndef _GCM_H
32 #define _GCM_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 
43 /**
44  * @brief GCM context
45  **/
46 
47 typedef struct
48 {
49  const CipherAlgo *cipherAlgo; ///<Cipher algorithm
50  void *cipherContext; ///<Cipher algorithm context
51  uint32_t m[16][4]; ///<Precalculated table
52 } GcmContext;
53 
54 
55 //GCM related functions
56 error_t gcmInit(GcmContext *context, const CipherAlgo *cipherAlgo,
57  void *cipherContext);
58 
59 error_t gcmEncrypt(GcmContext *context, const uint8_t *iv,
60  size_t ivLen, const uint8_t *a, size_t aLen, const uint8_t *p,
61  uint8_t *c, size_t length, uint8_t *t, size_t tLen);
62 
63 error_t gcmDecrypt(GcmContext *context, const uint8_t *iv,
64  size_t ivLen, const uint8_t *a, size_t aLen, const uint8_t *c,
65  uint8_t *p, size_t length, const uint8_t *t, size_t tLen);
66 
67 void gcmMul(GcmContext *context, uint8_t *x);
68 void gcmXorBlock(uint8_t *x, const uint8_t *a, const uint8_t *b, size_t n);
69 void gcmIncCounter(uint8_t *x);
70 
71 //C++ guard
72 #ifdef __cplusplus
73 }
74 #endif
75 
76 #endif
uint8_t length
Definition: dtls_misc.h:149
void gcmXorBlock(uint8_t *x, const uint8_t *a, const uint8_t *b, size_t n)
XOR operation.
Definition: gcm.c:553
error_t gcmEncrypt(GcmContext *context, const uint8_t *iv, size_t ivLen, const uint8_t *a, size_t aLen, const uint8_t *p, uint8_t *c, size_t length, uint8_t *t, size_t tLen)
Authenticated encryption using GCM.
Definition: gcm.c:190
uint8_t a
Definition: ndp.h:410
uint8_t b[6]
Definition: dtls_misc.h:139
uint8_t p
Definition: ndp.h:298
void gcmMul(GcmContext *context, uint8_t *x)
Multiplication operation in GF(2^128)
Definition: gcm.c:484
uint8_t t
Definition: llmnr_common.h:81
error_t
Error codes.
Definition: error.h:42
General definitions for cryptographic algorithms.
const CipherAlgo * cipherAlgo
Cipher algorithm.
Definition: gcm.h:49
error_t gcmInit(GcmContext *context, const CipherAlgo *cipherAlgo, void *cipherContext)
Initialize GCM context.
Definition: gcm.c:78
GCM context.
Definition: gcm.h:47
void gcmIncCounter(uint8_t *x)
Increment counter block.
Definition: gcm.c:570
uint8_t m
Definition: ndp.h:302
uint8_t n
error_t gcmDecrypt(GcmContext *context, const uint8_t *iv, size_t ivLen, const uint8_t *a, size_t aLen, const uint8_t *c, uint8_t *p, size_t length, const uint8_t *t, size_t tLen)
Authenticated decryption using GCM.
Definition: gcm.c:337
Common interface for encryption algorithms.
Definition: crypto.h:1150
void * cipherContext
Cipher algorithm context.
Definition: gcm.h:50