mbed TLS v2.28.4
Loading...
Searching...
No Matches
gcm.h
Go to the documentation of this file.
1
14/*
15 * Copyright The Mbed TLS Contributors
16 * SPDX-License-Identifier: Apache-2.0
17 *
18 * Licensed under the Apache License, Version 2.0 (the "License"); you may
19 * not use this file except in compliance with the License.
20 * You may obtain a copy of the License at
21 *
22 * http://www.apache.org/licenses/LICENSE-2.0
23 *
24 * Unless required by applicable law or agreed to in writing, software
25 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
26 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
27 * See the License for the specific language governing permissions and
28 * limitations under the License.
29 */
30
31#ifndef MBEDTLS_GCM_H
32#define MBEDTLS_GCM_H
33
34#if !defined(MBEDTLS_CONFIG_FILE)
35#include "mbedtls/config.h"
36#else
37#include MBEDTLS_CONFIG_FILE
38#endif
39
40#include "mbedtls/cipher.h"
41
42#include <stdint.h>
43
44#define MBEDTLS_GCM_ENCRYPT 1
45#define MBEDTLS_GCM_DECRYPT 0
46
48#define MBEDTLS_ERR_GCM_AUTH_FAILED -0x0012
49
50/* MBEDTLS_ERR_GCM_HW_ACCEL_FAILED is deprecated and should not be used. */
52#define MBEDTLS_ERR_GCM_HW_ACCEL_FAILED -0x0013
53
55#define MBEDTLS_ERR_GCM_BAD_INPUT -0x0014
56
57#ifdef __cplusplus
58extern "C" {
59#endif
60
61#if !defined(MBEDTLS_GCM_ALT)
62
66typedef struct mbedtls_gcm_context {
68 uint64_t HL[16];
69 uint64_t HH[16];
70 uint64_t len;
71 uint64_t add_len;
72 unsigned char base_ectr[16];
73 unsigned char y[16];
74 unsigned char buf[16];
75 int mode;
78}
80
81#else /* !MBEDTLS_GCM_ALT */
82#include "gcm_alt.h"
83#endif /* !MBEDTLS_GCM_ALT */
84
97
115 mbedtls_cipher_id_t cipher,
116 const unsigned char *key,
117 unsigned int keybits);
118
171 int mode,
172 size_t length,
173 const unsigned char *iv,
174 size_t iv_len,
175 const unsigned char *add,
176 size_t add_len,
177 const unsigned char *input,
178 unsigned char *output,
179 size_t tag_len,
180 unsigned char *tag);
181
216 size_t length,
217 const unsigned char *iv,
218 size_t iv_len,
219 const unsigned char *add,
220 size_t add_len,
221 const unsigned char *tag,
222 size_t tag_len,
223 const unsigned char *input,
224 unsigned char *output);
225
244 int mode,
245 const unsigned char *iv,
246 size_t iv_len,
247 const unsigned char *add,
248 size_t add_len);
249
276 size_t length,
277 const unsigned char *input,
278 unsigned char *output);
279
297 unsigned char *tag,
298 size_t tag_len);
299
308
309#if defined(MBEDTLS_SELF_TEST)
310
317int mbedtls_gcm_self_test(int verbose);
318
319#endif /* MBEDTLS_SELF_TEST */
320
321#ifdef __cplusplus
322}
323#endif
324
325
326#endif /* gcm.h */
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:90
Configuration options (set of defines)
int mbedtls_gcm_starts(mbedtls_gcm_context *ctx, int mode, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len)
This function starts a GCM encryption or decryption operation.
int mbedtls_gcm_crypt_and_tag(mbedtls_gcm_context *ctx, int mode, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *input, unsigned char *output, size_t tag_len, unsigned char *tag)
This function performs GCM encryption or decryption of a buffer.
int mbedtls_gcm_finish(mbedtls_gcm_context *ctx, unsigned char *tag, size_t tag_len)
This function finishes the GCM operation and generates the authentication tag.
int mbedtls_gcm_update(mbedtls_gcm_context *ctx, size_t length, const unsigned char *input, unsigned char *output)
This function feeds an input buffer into an ongoing GCM encryption or decryption operation.
void mbedtls_gcm_init(mbedtls_gcm_context *ctx)
This function initializes the specified GCM context, to make references valid, and prepares the conte...
int mbedtls_gcm_setkey(mbedtls_gcm_context *ctx, mbedtls_cipher_id_t cipher, const unsigned char *key, unsigned int keybits)
This function associates a GCM context with a cipher algorithm and a key.
int mbedtls_gcm_self_test(int verbose)
The GCM checkup routine.
void mbedtls_gcm_free(mbedtls_gcm_context *ctx)
This function clears a GCM context and the underlying cipher sub-context.
int mbedtls_gcm_auth_decrypt(mbedtls_gcm_context *ctx, size_t length, const unsigned char *iv, size_t iv_len, const unsigned char *add, size_t add_len, const unsigned char *tag, size_t tag_len, const unsigned char *input, unsigned char *output)
This function performs a GCM authenticated decryption of a buffer.
The GCM context structure.
Definition: gcm.h:66
unsigned char base_ectr[16]
Definition: gcm.h:72
unsigned char y[16]
Definition: gcm.h:73
mbedtls_cipher_context_t cipher_ctx
Definition: gcm.h:67
uint64_t HH[16]
Definition: gcm.h:69
unsigned char buf[16]
Definition: gcm.h:74
uint64_t len
Definition: gcm.h:70
uint64_t add_len
Definition: gcm.h:71
uint64_t HL[16]
Definition: gcm.h:68