Mbed TLS v3.5.2
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 OR GPL-2.0-or-later
17 */
18
19#ifndef MBEDTLS_GCM_H
20#define MBEDTLS_GCM_H
22
23#include "mbedtls/build_info.h"
24
25#include "mbedtls/cipher.h"
26
27#include <stdint.h>
28
29#define MBEDTLS_GCM_ENCRYPT 1
30#define MBEDTLS_GCM_DECRYPT 0
31
33#define MBEDTLS_ERR_GCM_AUTH_FAILED -0x0012
35#define MBEDTLS_ERR_GCM_BAD_INPUT -0x0014
37#define MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL -0x0016
38
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43#if !defined(MBEDTLS_GCM_ALT)
44
48typedef struct mbedtls_gcm_context {
50 uint64_t MBEDTLS_PRIVATE(HL)[16];
51 uint64_t MBEDTLS_PRIVATE(HH)[16];
52 uint64_t MBEDTLS_PRIVATE(len);
53 uint64_t MBEDTLS_PRIVATE(add_len);
54 unsigned char MBEDTLS_PRIVATE(base_ectr)[16];
55 unsigned char MBEDTLS_PRIVATE(y)[16];
56 unsigned char MBEDTLS_PRIVATE(buf)[16];
57 int MBEDTLS_PRIVATE(mode);
60}
62
63#else /* !MBEDTLS_GCM_ALT */
64#include "gcm_alt.h"
65#endif /* !MBEDTLS_GCM_ALT */
66
79
98 const unsigned char *key,
99 unsigned int keybits);
100
153 int mode,
154 size_t length,
155 const unsigned char *iv,
156 size_t iv_len,
157 const unsigned char *add,
158 size_t add_len,
159 const unsigned char *input,
160 unsigned char *output,
161 size_t tag_len,
162 unsigned char *tag);
163
198 size_t length,
199 const unsigned char *iv,
200 size_t iv_len,
201 const unsigned char *add,
202 size_t add_len,
203 const unsigned char *tag,
204 size_t tag_len,
205 const unsigned char *input,
206 unsigned char *output);
207
222 int mode,
223 const unsigned char *iv,
224 size_t iv_len);
225
247 const unsigned char *add,
248 size_t add_len);
249
302 const unsigned char *input, size_t input_length,
303 unsigned char *output, size_t output_size,
304 size_t *output_length);
305
340 unsigned char *output, size_t output_size,
341 size_t *output_length,
342 unsigned char *tag, size_t tag_len);
343
352
353#if defined(MBEDTLS_SELF_TEST)
354
361int mbedtls_gcm_self_test(int verbose);
362
363#endif /* MBEDTLS_SELF_TEST */
364
365#ifdef __cplusplus
366}
367#endif
368
369
370#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:66
int mbedtls_gcm_update(mbedtls_gcm_context *ctx, const unsigned char *input, size_t input_length, unsigned char *output, size_t output_size, size_t *output_length)
This function feeds an input buffer into an ongoing GCM encryption or decryption operation.
int mbedtls_gcm_finish(mbedtls_gcm_context *ctx, unsigned char *output, size_t output_size, size_t *output_length, unsigned char *tag, size_t tag_len)
This function finishes the GCM operation and generates the authentication tag.
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_update_ad(mbedtls_gcm_context *ctx, const unsigned char *add, size_t add_len)
This function feeds an input buffer as associated data (authenticated but not encrypted data) in a GC...
int mbedtls_gcm_starts(mbedtls_gcm_context *ctx, int mode, const unsigned char *iv, size_t iv_len)
This function starts a 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.
Build-time configuration info.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
The GCM context structure.
Definition gcm.h:48