[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / crypto / keys / CryptoKeyHMAC.h
1 /*
2  * Copyright (C) 2013 Apple Inc. 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(SUBTLE_CRYPTO)
29
30 #include "CryptoKey.h"
31 #include <wtf/Function.h>
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35
36 struct JsonWebKey;
37
38 class HmacKeyAlgorithm final : public KeyAlgorithm {
39 public:
40     HmacKeyAlgorithm(const String& name, const String& hash, size_t length)
41         : KeyAlgorithm(name)
42         , m_hash(hash)
43         , m_length(length)
44     {
45     }
46
47     KeyAlgorithmClass keyAlgorithmClass() const final { return KeyAlgorithmClass::HMAC; }
48
49     const String& hash() const { return m_hash; }
50     size_t length() const { return m_length; }
51
52 private:
53     String m_hash;
54     size_t m_length;
55 };
56
57 class CryptoKeyHMAC final : public CryptoKey {
58 public:
59     static Ref<CryptoKeyHMAC> create(const Vector<uint8_t>& key, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsageBitmap usage)
60     {
61         return adoptRef(*new CryptoKeyHMAC(key, hash, extractable, usage));
62     }
63     virtual ~CryptoKeyHMAC();
64
65     static RefPtr<CryptoKeyHMAC> generate(size_t lengthBits, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsageBitmap);
66     static RefPtr<CryptoKeyHMAC> importRaw(size_t lengthBits, CryptoAlgorithmIdentifier hash, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap);
67     using CheckAlgCallback = WTF::Function<bool(CryptoAlgorithmIdentifier, const std::optional<String>&)>;
68     static RefPtr<CryptoKeyHMAC> importJwk(size_t lengthBits, CryptoAlgorithmIdentifier hash, JsonWebKey&&, bool extractable, CryptoKeyUsageBitmap, CheckAlgCallback&&);
69
70     CryptoKeyClass keyClass() const final { return CryptoKeyClass::HMAC; }
71
72     const Vector<uint8_t>& key() const { return m_key; }
73     JsonWebKey exportJwk() const;
74
75     CryptoAlgorithmIdentifier hashAlgorithmIdentifier() const { return m_hash; }
76
77 private:
78     CryptoKeyHMAC(const Vector<uint8_t>& key, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsageBitmap);
79     CryptoKeyHMAC(Vector<uint8_t>&& key, CryptoAlgorithmIdentifier hash, bool extractable, CryptoKeyUsageBitmap);
80
81     std::unique_ptr<KeyAlgorithm> buildAlgorithm() const final;
82     std::unique_ptr<CryptoKeyData> exportData() const final;
83
84     CryptoAlgorithmIdentifier m_hash;
85     Vector<uint8_t> m_key;
86 };
87
88 } // namespace WebCore
89
90 SPECIALIZE_TYPE_TRAITS_CRYPTO_KEY(CryptoKeyHMAC, CryptoKeyClass::HMAC)
91
92 SPECIALIZE_TYPE_TRAITS_KEY_ALGORITHM(HmacKeyAlgorithm, KeyAlgorithmClass::HMAC)
93
94 #endif // ENABLE(SUBTLE_CRYPTO)