Next batch of conversions to use C++ enum class instead of strings for enumerations
[WebKit-https.git] / Source / WebCore / crypto / CryptoKey.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 #ifndef CryptoKey_h
27 #define CryptoKey_h
28
29 #if ENABLE(SUBTLE_CRYPTO)
30
31 #include "CryptoAlgorithmIdentifier.h"
32 #include "CryptoKeyType.h"
33 #include "CryptoKeyUsage.h"
34 #include <wtf/Forward.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/TypeCasts.h>
37 #include <wtf/Vector.h>
38
39 namespace WebCore {
40
41 class CryptoAlgorithmDescriptionBuilder;
42 class CryptoKeyData;
43
44 enum class CryptoKeyClass {
45     HMAC,
46     AES,
47     RSA
48 };
49
50 enum class KeyUsage { Encrypt, Decrypt, Sign, Verify, DeriveKey, DeriveBits, WrapKey, UnwrapKey };
51
52 using KeyType = CryptoKeyType;
53
54 class CryptoKey : public RefCounted<CryptoKey> {
55 public:
56     CryptoKey(CryptoAlgorithmIdentifier, CryptoKeyType, bool extractable, CryptoKeyUsage);
57     virtual ~CryptoKey();
58
59     virtual CryptoKeyClass keyClass() const = 0;
60
61     CryptoKeyType type() const;
62     bool extractable() const { return m_extractable; }
63     virtual void buildAlgorithmDescription(CryptoAlgorithmDescriptionBuilder&) const;
64     Vector<KeyUsage> usages() const;
65
66     CryptoAlgorithmIdentifier algorithmIdentifier() const { return m_algorithm; }
67     CryptoKeyUsage usagesBitmap() const { return m_usages; }
68     bool allows(CryptoKeyUsage usage) const { return usage == (m_usages & usage); }
69
70     virtual std::unique_ptr<CryptoKeyData> exportData() const = 0;
71
72     static Vector<uint8_t> randomData(size_t);
73
74 private:
75     CryptoAlgorithmIdentifier m_algorithm;
76     CryptoKeyType m_type;
77     bool m_extractable;
78     CryptoKeyUsage m_usages;
79 };
80
81 inline CryptoKeyType CryptoKey::type() const
82 {
83     return m_type;
84 }
85
86 } // namespace WebCore
87
88 #define SPECIALIZE_TYPE_TRAITS_CRYPTO_KEY(ToClassName, KeyClass) \
89 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToClassName) \
90     static bool isType(const WebCore::CryptoKey& key) { return key.keyClass() == WebCore::KeyClass; } \
91 SPECIALIZE_TYPE_TRAITS_END()
92
93 #endif // ENABLE(SUBTLE_CRYPTO)
94 #endif // CryptoKey_h