xref: /aosp_15_r20/external/boringssl/src/crypto/hmac_extra/hmac_test.cc (revision 8fb009dc861624b67b6cdb62ea21f0f22d0c584b)
1 /* Copyright (C) 1995-1998 Eric Young ([email protected])
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young ([email protected]).
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 ([email protected]).
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 ([email protected])"
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 ([email protected])"
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 #include <memory>
58 #include <string>
59 #include <vector>
60 
61 #include <gtest/gtest.h>
62 
63 #include <openssl/digest.h>
64 #include <openssl/hmac.h>
65 
66 #include "../test/file_test.h"
67 #include "../test/test_util.h"
68 #include "../test/wycheproof_util.h"
69 
70 
GetDigest(const std::string & name)71 static const EVP_MD *GetDigest(const std::string &name) {
72   if (name == "MD5") {
73     return EVP_md5();
74   } else if (name == "SHA1") {
75     return EVP_sha1();
76   } else if (name == "SHA224") {
77     return EVP_sha224();
78   } else if (name == "SHA256") {
79     return EVP_sha256();
80   } else if (name == "SHA384") {
81     return EVP_sha384();
82   } else if (name == "SHA512") {
83     return EVP_sha512();
84   }
85   return nullptr;
86 }
87 
TEST(HMACTest,TestVectors)88 TEST(HMACTest, TestVectors) {
89   FileTestGTest("crypto/hmac_extra/hmac_tests.txt", [](FileTest *t) {
90     std::string digest_str;
91     ASSERT_TRUE(t->GetAttribute(&digest_str, "HMAC"));
92     const EVP_MD *digest = GetDigest(digest_str);
93     ASSERT_TRUE(digest) << "Unknown digest: " << digest_str;
94 
95     std::vector<uint8_t> key, input, output;
96     ASSERT_TRUE(t->GetBytes(&key, "Key"));
97     ASSERT_TRUE(t->GetBytes(&input, "Input"));
98     ASSERT_TRUE(t->GetBytes(&output, "Output"));
99     ASSERT_EQ(EVP_MD_size(digest), output.size());
100 
101     // Test using the one-shot API.
102     auto mac = std::make_unique<uint8_t[]>(EVP_MD_size(digest));
103     unsigned mac_len;
104     ASSERT_TRUE(HMAC(digest, key.data(), key.size(), input.data(), input.size(),
105                      mac.get(), &mac_len));
106     EXPECT_EQ(Bytes(output), Bytes(mac.get(), mac_len));
107 
108     // Test using HMAC_CTX.
109     bssl::ScopedHMAC_CTX ctx;
110     ASSERT_TRUE(
111         HMAC_Init_ex(ctx.get(), key.data(), key.size(), digest, nullptr));
112     ASSERT_TRUE(HMAC_Update(ctx.get(), input.data(), input.size()));
113     ASSERT_TRUE(HMAC_Final(ctx.get(), mac.get(), &mac_len));
114     EXPECT_EQ(Bytes(output), Bytes(mac.get(), mac_len));
115 
116     // Test that an HMAC_CTX may be reset with the same key.
117     ASSERT_TRUE(HMAC_Init_ex(ctx.get(), nullptr, 0, digest, nullptr));
118     ASSERT_TRUE(HMAC_Update(ctx.get(), input.data(), input.size()));
119     ASSERT_TRUE(HMAC_Final(ctx.get(), mac.get(), &mac_len));
120     EXPECT_EQ(Bytes(output), Bytes(mac.get(), mac_len));
121 
122     // Test feeding the input in byte by byte.
123     ASSERT_TRUE(HMAC_Init_ex(ctx.get(), nullptr, 0, nullptr, nullptr));
124     for (size_t i = 0; i < input.size(); i++) {
125       ASSERT_TRUE(HMAC_Update(ctx.get(), &input[i], 1));
126     }
127     ASSERT_TRUE(HMAC_Final(ctx.get(), mac.get(), &mac_len));
128     EXPECT_EQ(Bytes(output), Bytes(mac.get(), mac_len));
129   });
130 }
131 
RunWycheproofTest(const char * path,const EVP_MD * md)132 static void RunWycheproofTest(const char *path, const EVP_MD *md) {
133   SCOPED_TRACE(path);
134   FileTestGTest(path, [&](FileTest *t) {
135     t->IgnoreInstruction("keySize");
136     t->IgnoreInstruction("tagSize");
137     std::vector<uint8_t> key, msg, tag;
138     ASSERT_TRUE(t->GetBytes(&key, "key"));
139     ASSERT_TRUE(t->GetBytes(&msg, "msg"));
140     ASSERT_TRUE(t->GetBytes(&tag, "tag"));
141     WycheproofResult result;
142     ASSERT_TRUE(GetWycheproofResult(t, &result));
143 
144     if (!result.IsValid()) {
145       // Wycheproof tests assume the HMAC implementation checks the MAC. Ours
146       // simply computes the HMAC, so skip the tests with invalid outputs.
147       return;
148     }
149 
150     uint8_t out[EVP_MAX_MD_SIZE];
151     unsigned out_len;
152     ASSERT_TRUE(HMAC(md, key.data(), key.size(), msg.data(), msg.size(), out,
153                      &out_len));
154     // Wycheproof tests truncate the tags down to |tagSize|.
155     ASSERT_LE(tag.size(), out_len);
156     EXPECT_EQ(Bytes(out, tag.size()), Bytes(tag));
157   });
158 }
159 
TEST(HMACTest,WycheproofSHA1)160 TEST(HMACTest, WycheproofSHA1) {
161   RunWycheproofTest("third_party/wycheproof_testvectors/hmac_sha1_test.txt",
162                     EVP_sha1());
163 }
164 
TEST(HMACTest,WycheproofSHA224)165 TEST(HMACTest, WycheproofSHA224) {
166   RunWycheproofTest("third_party/wycheproof_testvectors/hmac_sha224_test.txt",
167                     EVP_sha224());
168 }
169 
TEST(HMACTest,WycheproofSHA256)170 TEST(HMACTest, WycheproofSHA256) {
171   RunWycheproofTest("third_party/wycheproof_testvectors/hmac_sha256_test.txt",
172                     EVP_sha256());
173 }
174 
TEST(HMACTest,WycheproofSHA384)175 TEST(HMACTest, WycheproofSHA384) {
176   RunWycheproofTest("third_party/wycheproof_testvectors/hmac_sha384_test.txt",
177                     EVP_sha384());
178 }
179 
TEST(HMACTest,WycheproofSHA512)180 TEST(HMACTest, WycheproofSHA512) {
181   RunWycheproofTest("third_party/wycheproof_testvectors/hmac_sha512_test.txt",
182                     EVP_sha512());
183 }
184