1 /* ====================================================================
2  * Copyright (c) 2008 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@openssl.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ==================================================================== */
48 
49 #include <stdio.h>
50 #include <string.h>
51 
52 #include <vector>
53 
54 #include <gtest/gtest.h>
55 
56 #include <openssl/aes.h>
57 #include <openssl/cpu.h>
58 
59 #include "../../test/abi_test.h"
60 #include "../../test/file_test.h"
61 #include "../../test/test_util.h"
62 #include "../aes/internal.h"
63 #include "internal.h"
64 
65 
TEST(GCMTest,TestVectors)66 TEST(GCMTest, TestVectors) {
67   FileTestGTest("crypto/fipsmodule/modes/gcm_tests.txt", [](FileTest *t) {
68     std::vector<uint8_t> key, plaintext, additional_data, nonce, ciphertext,
69         tag;
70     ASSERT_TRUE(t->GetBytes(&key, "Key"));
71     ASSERT_TRUE(t->GetBytes(&plaintext, "Plaintext"));
72     ASSERT_TRUE(t->GetBytes(&additional_data, "AdditionalData"));
73     ASSERT_TRUE(t->GetBytes(&nonce, "Nonce"));
74     ASSERT_TRUE(t->GetBytes(&ciphertext, "Ciphertext"));
75     ASSERT_TRUE(t->GetBytes(&tag, "Tag"));
76 
77     ASSERT_EQ(plaintext.size(), ciphertext.size());
78     ASSERT_TRUE(key.size() == 16 || key.size() == 24 || key.size() == 32);
79     ASSERT_EQ(16u, tag.size());
80 
81     std::vector<uint8_t> out(plaintext.size());
82     AES_KEY aes_key;
83     ASSERT_EQ(0, AES_set_encrypt_key(key.data(), key.size() * 8, &aes_key));
84 
85     GCM128_CONTEXT ctx;
86     OPENSSL_memset(&ctx, 0, sizeof(ctx));
87     CRYPTO_gcm128_init_key(&ctx.gcm_key, &aes_key, AES_encrypt, 0);
88     CRYPTO_gcm128_setiv(&ctx, &aes_key, nonce.data(), nonce.size());
89     if (!additional_data.empty()) {
90       CRYPTO_gcm128_aad(&ctx, additional_data.data(), additional_data.size());
91     }
92     if (!plaintext.empty()) {
93       CRYPTO_gcm128_encrypt(&ctx, &aes_key, plaintext.data(), out.data(),
94                             plaintext.size());
95     }
96 
97     std::vector<uint8_t> got_tag(tag.size());
98     CRYPTO_gcm128_tag(&ctx, got_tag.data(), got_tag.size());
99     EXPECT_EQ(Bytes(tag), Bytes(got_tag));
100     EXPECT_EQ(Bytes(ciphertext), Bytes(out));
101 
102     CRYPTO_gcm128_setiv(&ctx, &aes_key, nonce.data(), nonce.size());
103     OPENSSL_memset(out.data(), 0, out.size());
104     if (!additional_data.empty()) {
105       CRYPTO_gcm128_aad(&ctx, additional_data.data(), additional_data.size());
106     }
107     if (!ciphertext.empty()) {
108       CRYPTO_gcm128_decrypt(&ctx, &aes_key, ciphertext.data(), out.data(),
109                             ciphertext.size());
110     }
111     ASSERT_TRUE(CRYPTO_gcm128_finish(&ctx, tag.data(), tag.size()));
112     EXPECT_EQ(Bytes(plaintext), Bytes(out));
113   });
114 }
115 
TEST(GCMTest,ByteSwap)116 TEST(GCMTest, ByteSwap) {
117   EXPECT_EQ(0x04030201u, CRYPTO_bswap4(0x01020304u));
118   EXPECT_EQ(UINT64_C(0x0807060504030201),
119             CRYPTO_bswap8(UINT64_C(0x0102030405060708)));
120 }
121 
122 #if defined(SUPPORTS_ABI_TEST) && defined(GHASH_ASM)
TEST(GCMTest,ABI)123 TEST(GCMTest, ABI) {
124   static const uint64_t kH[2] = {
125       UINT64_C(0x66e94bd4ef8a2c3b),
126       UINT64_C(0x884cfa59ca342b2e),
127   };
128   static const size_t kBlockCounts[] = {1, 2, 3, 4, 7, 8, 15, 16, 31, 32};
129   uint8_t buf[16 * 32];
130   OPENSSL_memset(buf, 42, sizeof(buf));
131 
132   uint64_t X[2] = {
133       UINT64_C(0x0388dace60b6a392),
134       UINT64_C(0xf328c2b971b2fe78),
135   };
136 
137   alignas(16) u128 Htable[16];
138   CHECK_ABI(gcm_init_4bit, Htable, kH);
139 #if defined(GHASH_ASM_X86)
140   CHECK_ABI(gcm_gmult_4bit_mmx, X, Htable);
141   for (size_t blocks : kBlockCounts) {
142     CHECK_ABI(gcm_ghash_4bit_mmx, X, Htable, buf, 16 * blocks);
143   }
144 #else
145   CHECK_ABI(gcm_gmult_4bit, X, Htable);
146   for (size_t blocks : kBlockCounts) {
147     CHECK_ABI(gcm_ghash_4bit, X, Htable, buf, 16 * blocks);
148   }
149 #endif  // GHASH_ASM_X86
150 
151 #if defined(GHASH_ASM_X86) || defined(GHASH_ASM_X86_64)
152   if (gcm_ssse3_capable()) {
153     CHECK_ABI_SEH(gcm_init_ssse3, Htable, kH);
154     CHECK_ABI_SEH(gcm_gmult_ssse3, X, Htable);
155     for (size_t blocks : kBlockCounts) {
156       CHECK_ABI_SEH(gcm_ghash_ssse3, X, Htable, buf, 16 * blocks);
157     }
158   }
159 
160   if (crypto_gcm_clmul_enabled()) {
161     CHECK_ABI_SEH(gcm_init_clmul, Htable, kH);
162     CHECK_ABI_SEH(gcm_gmult_clmul, X, Htable);
163     for (size_t blocks : kBlockCounts) {
164       CHECK_ABI_SEH(gcm_ghash_clmul, X, Htable, buf, 16 * blocks);
165     }
166 
167 #if defined(GHASH_ASM_X86_64)
168     if (((OPENSSL_ia32cap_get()[1] >> 22) & 0x41) == 0x41) {  // AVX+MOVBE
169       CHECK_ABI_SEH(gcm_init_avx, Htable, kH);
170       CHECK_ABI_SEH(gcm_gmult_avx, X, Htable);
171       for (size_t blocks : kBlockCounts) {
172         CHECK_ABI_SEH(gcm_ghash_avx, X, Htable, buf, 16 * blocks);
173       }
174 
175       if (hwaes_capable()) {
176         AES_KEY aes_key;
177         static const uint8_t kKey[16] = {0};
178 
179         // aesni_gcm_* makes assumptions about |GCM128_CONTEXT|'s layout.
180         GCM128_CONTEXT gcm;
181         memset(&gcm, 0, sizeof(gcm));
182         memcpy(&gcm.gcm_key.H, kH, sizeof(kH));
183         memcpy(&gcm.gcm_key.Htable, Htable, sizeof(Htable));
184         memcpy(&gcm.Xi, X, sizeof(X));
185         uint8_t iv[16] = {0};
186 
187         aes_hw_set_encrypt_key(kKey, 128, &aes_key);
188         for (size_t blocks : kBlockCounts) {
189           CHECK_ABI(aesni_gcm_encrypt, buf, buf, blocks * 16, &aes_key, iv,
190                     gcm.Xi.u);
191           CHECK_ABI(aesni_gcm_encrypt, buf, buf, blocks * 16 + 7, &aes_key, iv,
192                     gcm.Xi.u);
193         }
194         aes_hw_set_decrypt_key(kKey, 128, &aes_key);
195         for (size_t blocks : kBlockCounts) {
196           CHECK_ABI(aesni_gcm_decrypt, buf, buf, blocks * 16, &aes_key, iv,
197                     gcm.Xi.u);
198           CHECK_ABI(aesni_gcm_decrypt, buf, buf, blocks * 16 + 7, &aes_key, iv,
199                     gcm.Xi.u);
200         }
201       }
202     }
203 #endif  // GHASH_ASM_X86_64
204   }
205 #endif  // GHASH_ASM_X86 || GHASH_ASM_X86_64
206 
207 #if defined(GHASH_ASM_ARM)
208   if (gcm_neon_capable()) {
209     CHECK_ABI(gcm_init_neon, Htable, kH);
210     CHECK_ABI(gcm_gmult_neon, X, Htable);
211     for (size_t blocks : kBlockCounts) {
212       CHECK_ABI(gcm_ghash_neon, X, Htable, buf, 16 * blocks);
213     }
214   }
215 
216   if (gcm_pmull_capable()) {
217     CHECK_ABI(gcm_init_v8, Htable, kH);
218     CHECK_ABI(gcm_gmult_v8, X, Htable);
219     for (size_t blocks : kBlockCounts) {
220       CHECK_ABI(gcm_ghash_v8, X, Htable, buf, 16 * blocks);
221     }
222   }
223 #endif  // GHASH_ASM_ARM
224 }
225 #endif  // SUPPORTS_ABI_TEST && GHASH_ASM
226