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_EXTRA_INTERNAL_H
58 #define OPENSSL_HEADER_CIPHER_EXTRA_INTERNAL_H
59
60 #include <stdlib.h>
61
62 #include <openssl/base.h>
63 #include <openssl/cpu.h>
64 #include <openssl/type_check.h>
65
66 #include "../internal.h"
67
68 #if defined(__cplusplus)
69 extern "C" {
70 #endif
71
72
73 // EVP_tls_cbc_get_padding determines the padding from the decrypted, TLS, CBC
74 // record in |in|. This decrypted record should not include any "decrypted"
75 // explicit IV. If the record is publicly invalid, it returns zero. Otherwise,
76 // it returns one and sets |*out_padding_ok| to all ones (0xfff..f) if the
77 // padding is valid and zero otherwise. It then sets |*out_len| to the length
78 // with the padding removed or |in_len| if invalid.
79 //
80 // If the function returns one, it runs in time independent of the contents of
81 // |in|. It is also guaranteed that |*out_len| >= |mac_size|, satisfying
82 // |EVP_tls_cbc_copy_mac|'s precondition.
83 int EVP_tls_cbc_remove_padding(crypto_word_t *out_padding_ok, size_t *out_len,
84 const uint8_t *in, size_t in_len,
85 size_t block_size, size_t mac_size);
86
87 // EVP_tls_cbc_copy_mac copies |md_size| bytes from the end of the first
88 // |in_len| bytes of |in| to |out| in constant time (independent of the concrete
89 // value of |in_len|, which may vary within a 256-byte window). |in| must point
90 // to a buffer of |orig_len| bytes.
91 //
92 // On entry:
93 // orig_len >= in_len >= md_size
94 // md_size <= EVP_MAX_MD_SIZE
95 void EVP_tls_cbc_copy_mac(uint8_t *out, size_t md_size, const uint8_t *in,
96 size_t in_len, size_t orig_len);
97
98 // EVP_tls_cbc_record_digest_supported returns 1 iff |md| is a hash function
99 // which EVP_tls_cbc_digest_record supports.
100 int EVP_tls_cbc_record_digest_supported(const EVP_MD *md);
101
102 // EVP_sha1_final_with_secret_suffix computes the result of hashing |len| bytes
103 // from |in| to |ctx| and writes the resulting hash to |out|. |len| is treated
104 // as secret and must be at most |max_len|, which is treated as public. |in|
105 // must point to a buffer of at least |max_len| bytes. It returns one on success
106 // and zero if inputs are too long.
107 //
108 // This function is exported for unit tests.
109 OPENSSL_EXPORT int EVP_sha1_final_with_secret_suffix(
110 SHA_CTX *ctx, uint8_t out[SHA_DIGEST_LENGTH], const uint8_t *in, size_t len,
111 size_t max_len);
112
113 // EVP_tls_cbc_digest_record computes the MAC of a decrypted, padded TLS
114 // record.
115 //
116 // md: the hash function used in the HMAC.
117 // EVP_tls_cbc_record_digest_supported must return true for this hash.
118 // md_out: the digest output. At most EVP_MAX_MD_SIZE bytes will be written.
119 // md_out_size: the number of output bytes is written here.
120 // header: the 13-byte, TLS record header.
121 // data: the record data itself
122 // data_size: the secret, reported length of the data once the padding and MAC
123 // have been removed.
124 // data_plus_mac_plus_padding_size: the public length of the whole
125 // record, including padding.
126 //
127 // On entry: by virtue of having been through one of the remove_padding
128 // functions, above, we know that data_plus_mac_size is large enough to contain
129 // a padding byte and MAC. (If the padding was invalid, it might contain the
130 // padding too. )
131 int EVP_tls_cbc_digest_record(const EVP_MD *md, uint8_t *md_out,
132 size_t *md_out_size, const uint8_t header[13],
133 const uint8_t *data, size_t data_size,
134 size_t data_plus_mac_plus_padding_size,
135 const uint8_t *mac_secret,
136 unsigned mac_secret_length);
137
138 #define POLY1305_TAG_LEN 16
139
140 // For convenience (the x86_64 calling convention allows only six parameters in
141 // registers), the final parameter for the assembly functions is both an input
142 // and output parameter.
143 union chacha20_poly1305_open_data {
144 struct {
145 alignas(16) uint8_t key[32];
146 uint32_t counter;
147 uint8_t nonce[12];
148 } in;
149 struct {
150 uint8_t tag[POLY1305_TAG_LEN];
151 } out;
152 };
153
154 union chacha20_poly1305_seal_data {
155 struct {
156 alignas(16) uint8_t key[32];
157 uint32_t counter;
158 uint8_t nonce[12];
159 const uint8_t *extra_ciphertext;
160 size_t extra_ciphertext_len;
161 } in;
162 struct {
163 uint8_t tag[POLY1305_TAG_LEN];
164 } out;
165 };
166
167 #if defined(OPENSSL_X86_64) && !defined(OPENSSL_NO_ASM)
168
169 OPENSSL_STATIC_ASSERT(sizeof(union chacha20_poly1305_open_data) == 48,
170 "wrong chacha20_poly1305_open_data size");
171 OPENSSL_STATIC_ASSERT(sizeof(union chacha20_poly1305_seal_data) == 48 + 8 + 8,
172 "wrong chacha20_poly1305_seal_data size");
173
chacha20_poly1305_asm_capable(void)174 OPENSSL_INLINE int chacha20_poly1305_asm_capable(void) {
175 const int sse41_capable = (OPENSSL_ia32cap_P[1] & (1 << 19)) != 0;
176 return sse41_capable;
177 }
178
179 // chacha20_poly1305_open is defined in chacha20_poly1305_x86_64.pl. It decrypts
180 // |plaintext_len| bytes from |ciphertext| and writes them to |out_plaintext|.
181 // Additional input parameters are passed in |aead_data->in|. On exit, it will
182 // write calculated tag value to |aead_data->out.tag|, which the caller must
183 // check.
184 extern void chacha20_poly1305_open(uint8_t *out_plaintext,
185 const uint8_t *ciphertext,
186 size_t plaintext_len, const uint8_t *ad,
187 size_t ad_len,
188 union chacha20_poly1305_open_data *data);
189
190 // chacha20_poly1305_open is defined in chacha20_poly1305_x86_64.pl. It encrypts
191 // |plaintext_len| bytes from |plaintext| and writes them to |out_ciphertext|.
192 // Additional input parameters are passed in |aead_data->in|. The calculated tag
193 // value is over the computed ciphertext concatenated with |extra_ciphertext|
194 // and written to |aead_data->out.tag|.
195 extern void chacha20_poly1305_seal(uint8_t *out_ciphertext,
196 const uint8_t *plaintext,
197 size_t plaintext_len, const uint8_t *ad,
198 size_t ad_len,
199 union chacha20_poly1305_seal_data *data);
200 #else
201
chacha20_poly1305_asm_capable(void)202 OPENSSL_INLINE int chacha20_poly1305_asm_capable(void) { return 0; }
203
chacha20_poly1305_open(uint8_t * out_plaintext,const uint8_t * ciphertext,size_t plaintext_len,const uint8_t * ad,size_t ad_len,union chacha20_poly1305_open_data * data)204 OPENSSL_INLINE void chacha20_poly1305_open(uint8_t *out_plaintext,
205 const uint8_t *ciphertext,
206 size_t plaintext_len, const uint8_t *ad,
207 size_t ad_len,
208 union chacha20_poly1305_open_data *data) {
209 abort();
210 }
211
chacha20_poly1305_seal(uint8_t * out_ciphertext,const uint8_t * plaintext,size_t plaintext_len,const uint8_t * ad,size_t ad_len,union chacha20_poly1305_seal_data * data)212 OPENSSL_INLINE void chacha20_poly1305_seal(uint8_t *out_ciphertext,
213 const uint8_t *plaintext,
214 size_t plaintext_len, const uint8_t *ad,
215 size_t ad_len,
216 union chacha20_poly1305_seal_data *data) {
217 abort();
218 }
219 #endif
220
221
222 #if defined(__cplusplus)
223 } // extern C
224 #endif
225
226 #endif // OPENSSL_HEADER_CIPHER_EXTRA_INTERNAL_H
227