1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* Copyright (C) 2013 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "CryptoKeyHMAC.h"
#include "CryptoAlgorithmHmacKeyParams.h"
#include "CryptoAlgorithmRegistry.h"
#include "ExceptionOr.h"
#include "JsonWebKey.h"
#include <wtf/text/Base64.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
static std::optional<size_t> getKeyLengthFromHash(CryptoAlgorithmIdentifier hash)
{
switch (hash) {
case CryptoAlgorithmIdentifier::SHA_1:
case CryptoAlgorithmIdentifier::DEPRECATED_SHA_224:
case CryptoAlgorithmIdentifier::SHA_256:
return 512;
case CryptoAlgorithmIdentifier::SHA_384:
case CryptoAlgorithmIdentifier::SHA_512:
return 1024;
default:
RELEASE_ASSERT_NOT_REACHED_WITH_MESSAGE("Invalid Hash Algorithm");
return { };
}
}
CryptoKeyHMAC::CryptoKeyHMAC(const Vector<uint8_t>& key, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsageBitmap usage)
: CryptoKey(CryptoAlgorithmIdentifier::HMAC, CryptoKeyType::Secret, extractable, usage)
, m_hash(hash)
, m_key(key)
{
}
CryptoKeyHMAC::CryptoKeyHMAC(Vector<uint8_t>&& key, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsageBitmap usage)
: CryptoKey(CryptoAlgorithmIdentifier::HMAC, CryptoKeyType::Secret, extractable, usage)
, m_hash(hash)
, m_key(WTFMove(key))
{
}
CryptoKeyHMAC::~CryptoKeyHMAC() = default;
RefPtr<CryptoKeyHMAC> CryptoKeyHMAC::generate(size_t lengthBits, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsageBitmap usages)
{
if (!lengthBits) {
auto length = getKeyLengthFromHash(hash);
if (!length.value_or(0))
return nullptr;
lengthBits = *length;
}
// CommonHMAC only supports key length that is a multiple of 8. Therefore, here we are a little bit different
// from the spec as of 11 December 2014: https://www.w3.org/TR/WebCryptoAPI/#hmac-operations
if (lengthBits % 8)
return nullptr;
return adoptRef(new CryptoKeyHMAC(randomData(lengthBits / 8), hash, extractable, usages));
}
RefPtr<CryptoKeyHMAC> CryptoKeyHMAC::importRaw(size_t lengthBits, CryptoAlgorithmIdentifier hash, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap usages)
{
size_t length = keyData.size() * 8;
if (!length)
return nullptr;
// CommonHMAC only supports key length that is a multiple of 8. Therefore, here we are a little bit different
// from the spec as of 11 December 2014: https://www.w3.org/TR/WebCryptoAPI/#hmac-operations
if (lengthBits && lengthBits != length)
return nullptr;
return adoptRef(new CryptoKeyHMAC(WTFMove(keyData), hash, extractable, usages));
}
RefPtr<CryptoKeyHMAC> CryptoKeyHMAC::importJwk(size_t lengthBits, CryptoAlgorithmIdentifier hash, JsonWebKey&& keyData, bool extractable, CryptoKeyUsageBitmap usages, CheckAlgCallback&& callback)
{
if (keyData.kty != "oct"_s)
return nullptr;
if (keyData.k.isNull())
return nullptr;
auto octetSequence = base64URLDecode(keyData.k);
if (!octetSequence)
return nullptr;
if (!callback(hash, keyData.alg))
return nullptr;
if (usages && !keyData.use.isNull() && keyData.use != "sig"_s)
return nullptr;
if (keyData.key_ops && ((keyData.usages & usages) != usages))
return nullptr;
if (keyData.ext && !keyData.ext.value() && extractable)
return nullptr;
return CryptoKeyHMAC::importRaw(lengthBits, hash, WTFMove(*octetSequence), extractable, usages);
}
JsonWebKey CryptoKeyHMAC::exportJwk() const
{
JsonWebKey result;
result.kty = "oct"_s;
result.k = base64URLEncodeToString(m_key);
result.key_ops = usages();
result.usages = usagesBitmap();
result.ext = extractable();
return result;
}
ExceptionOr<std::optional<size_t>> CryptoKeyHMAC::getKeyLength(const CryptoAlgorithmParameters& parameters)
{
auto& aesParameters = downcast<CryptoAlgorithmHmacKeyParams>(parameters);
auto length = aesParameters.length ? *(aesParameters.length) : getKeyLengthFromHash(aesParameters.hashIdentifier);
if (!length.value_or(0))
return Exception { ExceptionCode::TypeError };
return length;
}
auto CryptoKeyHMAC::algorithm() const -> KeyAlgorithm
{
CryptoHmacKeyAlgorithm result;
result.name = CryptoAlgorithmRegistry::singleton().name(algorithmIdentifier());
result.hash.name = CryptoAlgorithmRegistry::singleton().name(m_hash);
result.length = m_key.size() * 8;
return result;
}
CryptoKey::Data CryptoKeyHMAC::data() const
{
auto keyData = key();
return CryptoKey::Data {
CryptoKeyClass::HMAC,
algorithmIdentifier(),
extractable(),
usagesBitmap(),
std::nullopt,
exportJwk(),
hashAlgorithmIdentifier(),
std::nullopt,
key().size() * CHAR_BIT, // Size in bits.
};
}
} // namespace WebCore
|
