1/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.] */
56
57#ifndef OPENSSL_HEADER_CIPHER_INTERNAL_H
58#define OPENSSL_HEADER_CIPHER_INTERNAL_H
59
60#include <openssl/base.h>
61
62#include <openssl/aead.h>
63#include <openssl/aes.h>
64
65#include "../../internal.h"
66#include "../modes/internal.h"
67
68#if defined(__cplusplus)
69extern "C" {
70#endif
71
72
73// EVP_CIPH_MODE_MASK contains the bits of |flags| that represent the mode.
74#define EVP_CIPH_MODE_MASK 0x3f
75
76// EVP_AEAD represents a specific AEAD algorithm.
77struct evp_aead_st {
78 uint8_t key_len;
79 uint8_t nonce_len;
80 uint8_t overhead;
81 uint8_t max_tag_len;
82 int seal_scatter_supports_extra_in;
83
84 // init initialises an |EVP_AEAD_CTX|. If this call returns zero then
85 // |cleanup| will not be called for that context.
86 int (*init)(EVP_AEAD_CTX *, const uint8_t *key, size_t key_len,
87 size_t tag_len);
88 int (*init_with_direction)(EVP_AEAD_CTX *, const uint8_t *key, size_t key_len,
89 size_t tag_len, enum evp_aead_direction_t dir);
90 void (*cleanup)(EVP_AEAD_CTX *);
91
92 int (*open)(const EVP_AEAD_CTX *ctx, uint8_t *out, size_t *out_len,
93 size_t max_out_len, const uint8_t *nonce, size_t nonce_len,
94 const uint8_t *in, size_t in_len, const uint8_t *ad,
95 size_t ad_len);
96
97 int (*seal_scatter)(const EVP_AEAD_CTX *ctx, uint8_t *out, uint8_t *out_tag,
98 size_t *out_tag_len, size_t max_out_tag_len,
99 const uint8_t *nonce, size_t nonce_len, const uint8_t *in,
100 size_t in_len, const uint8_t *extra_in,
101 size_t extra_in_len, const uint8_t *ad, size_t ad_len);
102
103 int (*open_gather)(const EVP_AEAD_CTX *ctx, uint8_t *out,
104 const uint8_t *nonce, size_t nonce_len, const uint8_t *in,
105 size_t in_len, const uint8_t *in_tag, size_t in_tag_len,
106 const uint8_t *ad, size_t ad_len);
107
108 int (*get_iv)(const EVP_AEAD_CTX *ctx, const uint8_t **out_iv,
109 size_t *out_len);
110
111 size_t (*tag_len)(const EVP_AEAD_CTX *ctx, size_t in_Len,
112 size_t extra_in_len);
113};
114
115// aes_ctr_set_key initialises |*aes_key| using |key_bytes| bytes from |key|,
116// where |key_bytes| must either be 16, 24 or 32. If not NULL, |*out_block| is
117// set to a function that encrypts single blocks. If not NULL, |*gcm_key| is
118// initialised to do GHASH with the given key. It returns a function for
119// optimised CTR-mode, or NULL if CTR-mode should be built using |*out_block|.
120ctr128_f aes_ctr_set_key(AES_KEY *aes_key, GCM128_KEY *gcm_key,
121 block128_f *out_block, const uint8_t *key,
122 size_t key_bytes);
123
124#if defined(__cplusplus)
125} // extern C
126#endif
127
128#endif // OPENSSL_HEADER_CIPHER_INTERNAL_H
129