1 /* Copyright (c) 2018, Google Inc.
2 *
3 * Permission to use, copy, modify, and/or distribute this software for any
4 * purpose with or without fee is hereby granted, provided that the above
5 * copyright notice and this permission notice appear in all copies.
6 *
7 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
10 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
12 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
13 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */
14
15 #include <openssl/base.h>
16
17 #if defined(BORINGSSL_DISPATCH_TEST) && !defined(BORINGSSL_SHARED_LIBRARY)
18
19 #include <functional>
20 #include <utility>
21 #include <vector>
22
23 #include <openssl/aead.h>
24 #include <openssl/aes.h>
25 #include <openssl/mem.h>
26
27 #include <gtest/gtest.h>
28
29 #include "internal.h"
30
31
32 class ImplDispatchTest : public ::testing::Test {
33 public:
SetUp()34 void SetUp() override {
35 #if defined(OPENSSL_X86) || defined(OPENSSL_X86_64)
36 aesni_ = CRYPTO_is_AESNI_capable();
37 avx_movbe_ = CRYPTO_is_AVX_capable() && CRYPTO_is_MOVBE_capable();
38 ssse3_ = CRYPTO_is_SSSE3_capable();
39 is_x86_64_ =
40 #if defined(OPENSSL_X86_64)
41 true;
42 #else
43 false;
44 #endif
45 #endif // X86 || X86_64
46 }
47
48 protected:
49 // AssertFunctionsHit takes a list of pairs (flag index, boolean), and a
50 // function to test. It runs the given function and asserts, for each flag
51 // index, that the boolean reflects whether that flag index was written or
52 // not, and that no other flagged functions were triggered.
AssertFunctionsHit(std::vector<std::pair<size_t,bool>> flags,std::function<void ()> f)53 void AssertFunctionsHit(std::vector<std::pair<size_t, bool>> flags,
54 std::function<void()> f) {
55 OPENSSL_memset(BORINGSSL_function_hit, 0, sizeof(BORINGSSL_function_hit));
56
57 f();
58
59 for (const auto& flag : flags) {
60 SCOPED_TRACE(flag.first);
61
62 ASSERT_LT(flag.first, sizeof(BORINGSSL_function_hit));
63 EXPECT_EQ(flag.second, BORINGSSL_function_hit[flag.first] == 1);
64 BORINGSSL_function_hit[flag.first] = 0;
65 }
66
67 for (size_t i = 0; i < sizeof(BORINGSSL_function_hit); i++) {
68 EXPECT_EQ(0u, BORINGSSL_function_hit[i])
69 << "Flag " << i << " unexpectedly hit";
70 }
71 }
72
73 #if defined(OPENSSL_X86) || defined(OPENSSL_X86_64)
74 bool aesni_ = false;
75 bool avx_movbe_ = false;
76 bool ssse3_ = false;
77 bool is_x86_64_ = false;
78 #endif
79 };
80
81 #if !defined(OPENSSL_NO_ASM) && \
82 (defined(OPENSSL_X86) || defined(OPENSSL_X86_64))
83
84 constexpr size_t kFlag_aes_hw_ctr32_encrypt_blocks = 0;
85 constexpr size_t kFlag_aes_hw_encrypt = 1;
86 constexpr size_t kFlag_aesni_gcm_encrypt = 2;
87 constexpr size_t kFlag_aes_hw_set_encrypt_key = 3;
88 constexpr size_t kFlag_vpaes_encrypt = 4;
89 constexpr size_t kFlag_vpaes_set_encrypt_key = 5;
90
TEST_F(ImplDispatchTest,AEAD_AES_GCM)91 TEST_F(ImplDispatchTest, AEAD_AES_GCM) {
92 AssertFunctionsHit(
93 {
94 {kFlag_aes_hw_ctr32_encrypt_blocks, aesni_},
95 {kFlag_aes_hw_encrypt, aesni_},
96 {kFlag_aes_hw_set_encrypt_key, aesni_},
97 {kFlag_aesni_gcm_encrypt, is_x86_64_ && aesni_ && avx_movbe_},
98 {kFlag_vpaes_encrypt, ssse3_ && !aesni_},
99 {kFlag_vpaes_set_encrypt_key, ssse3_ && !aesni_},
100 },
101 [] {
102 const uint8_t kZeros[16] = {0};
103 const uint8_t kPlaintext[40] = {1, 2, 3, 4, 0};
104 uint8_t ciphertext[sizeof(kPlaintext) + 16];
105 size_t ciphertext_len;
106 bssl::ScopedEVP_AEAD_CTX ctx;
107 ASSERT_TRUE(EVP_AEAD_CTX_init(ctx.get(), EVP_aead_aes_128_gcm(), kZeros,
108 sizeof(kZeros),
109 EVP_AEAD_DEFAULT_TAG_LENGTH, nullptr));
110 ASSERT_TRUE(EVP_AEAD_CTX_seal(
111 ctx.get(), ciphertext, &ciphertext_len, sizeof(ciphertext), kZeros,
112 EVP_AEAD_nonce_length(EVP_aead_aes_128_gcm()), kPlaintext,
113 sizeof(kPlaintext), nullptr, 0));
114 });
115 }
116
TEST_F(ImplDispatchTest,AES_set_encrypt_key)117 TEST_F(ImplDispatchTest, AES_set_encrypt_key) {
118 AssertFunctionsHit(
119 {
120 {kFlag_aes_hw_set_encrypt_key, aesni_},
121 {kFlag_vpaes_set_encrypt_key, ssse3_ && !aesni_},
122 },
123 [] {
124 AES_KEY key;
125 static const uint8_t kZeros[16] = {0};
126 AES_set_encrypt_key(kZeros, sizeof(kZeros) * 8, &key);
127 });
128 }
129
TEST_F(ImplDispatchTest,AES_single_block)130 TEST_F(ImplDispatchTest, AES_single_block) {
131 AES_KEY key;
132 static const uint8_t kZeros[16] = {0};
133 AES_set_encrypt_key(kZeros, sizeof(kZeros) * 8, &key);
134
135 AssertFunctionsHit(
136 {
137 {kFlag_aes_hw_encrypt, aesni_},
138 {kFlag_vpaes_encrypt, ssse3_ && !aesni_},
139 },
140 [&key] {
141 uint8_t in[AES_BLOCK_SIZE] = {0};
142 uint8_t out[AES_BLOCK_SIZE];
143 AES_encrypt(in, out, &key);
144 });
145 }
146
147 #endif // X86 || X86_64
148
149 #endif // DISPATCH_TEST && !SHARED_LIBRARY
150