mbed TLS v2.13.0
gcm.h
Go to the documentation of this file.
1 
14 /*
15  * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
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  * This file is part of Mbed TLS (https://tls.mbed.org)
31  */
32 
33 #ifndef MBEDTLS_GCM_H
34 #define MBEDTLS_GCM_H
35 
36 #include "cipher.h"
37 
38 #include <stdint.h>
39 
40 #define MBEDTLS_GCM_ENCRYPT 1
41 #define MBEDTLS_GCM_DECRYPT 0
42 
43 #define MBEDTLS_ERR_GCM_AUTH_FAILED -0x0012
44 #define MBEDTLS_ERR_GCM_HW_ACCEL_FAILED -0x0013
45 #define MBEDTLS_ERR_GCM_BAD_INPUT -0x0014
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 #if !defined(MBEDTLS_GCM_ALT)
52 
56 typedef struct mbedtls_gcm_context
57 {
59  uint64_t HL[16];
60  uint64_t HH[16];
61  uint64_t len;
62  uint64_t add_len;
63  unsigned char base_ectr[16];
64  unsigned char y[16];
65  unsigned char buf[16];
66  int mode;
69 }
71 
72 #else /* !MBEDTLS_GCM_ALT */
73 #include "gcm_alt.h"
74 #endif /* !MBEDTLS_GCM_ALT */
75 
88 
105  mbedtls_cipher_id_t cipher,
106  const unsigned char *key,
107  unsigned int keybits );
108 
154  int mode,
155  size_t length,
156  const unsigned char *iv,
157  size_t iv_len,
158  const unsigned char *add,
159  size_t add_len,
160  const unsigned char *input,
161  unsigned char *output,
162  size_t tag_len,
163  unsigned char *tag );
164 
193  size_t length,
194  const unsigned char *iv,
195  size_t iv_len,
196  const unsigned char *add,
197  size_t add_len,
198  const unsigned char *tag,
199  size_t tag_len,
200  const unsigned char *input,
201  unsigned char *output );
202 
220  int mode,
221  const unsigned char *iv,
222  size_t iv_len,
223  const unsigned char *add,
224  size_t add_len );
225 
248  size_t length,
249  const unsigned char *input,
250  unsigned char *output );
251 
267  unsigned char *tag,
268  size_t tag_len );
269 
277 
284 int mbedtls_gcm_self_test( int verbose );
285 
286 #ifdef __cplusplus
287 }
288 #endif
289 
290 
291 #endif /* gcm.h */
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_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_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.
The GCM context structure.
Definition: gcm.h:56
mbedtls_cipher_context_t cipher_ctx
Definition: gcm.h:58
unsigned char buf[16]
Definition: gcm.h:65
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.
struct mbedtls_gcm_context mbedtls_gcm_context
The GCM context structure.
unsigned char y[16]
Definition: gcm.h:64
uint64_t HH[16]
Definition: gcm.h:60
uint64_t add_len
Definition: gcm.h:62
mbedtls_cipher_id_t
Supported cipher types.
Definition: cipher.h:81
uint64_t HL[16]
Definition: gcm.h:59
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
uint64_t len
Definition: gcm.h:61
unsigned char base_ectr[16]
Definition: gcm.h:63
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_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_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.
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.