Support exporting symmetric keys as JWK
[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 #include "CryptoAlgorithmIdentifier.h"
30 #include "CryptoKeyType.h"
31 #include "CryptoKeyUsage.h"
32 #include <wtf/Forward.h>
33 #include <wtf/RefCounted.h>
34 #include <wtf/Vector.h>
35
36 #if ENABLE(SUBTLE_CRYPTO)
37
38 namespace WebCore {
39
40 class CryptoAlgorithmDescriptionBuilder;
41 class CryptoKeyData;
42
43 ENUM_CLASS(CryptoKeyClass) {
44     HMAC,
45     AES,
46     RSA
47 };
48
49 class CryptoKey : public RefCounted<CryptoKey> {
50 public:
51     CryptoKey(CryptoAlgorithmIdentifier, CryptoKeyType, bool extractable, CryptoKeyUsage);
52     virtual ~CryptoKey();
53
54     virtual CryptoKeyClass keyClass() const = 0;
55
56     String type() const;
57     bool extractable() const { return m_extractable; }
58     virtual void buildAlgorithmDescription(CryptoAlgorithmDescriptionBuilder&) const;
59     Vector<String> usages() const;
60
61     CryptoAlgorithmIdentifier algorithmIdentifier() const { return m_algorithm; }
62     CryptoKeyUsage usagesBitmap() const { return m_usages; }
63     bool allows(CryptoKeyUsage usage) const { return usage == (m_usages & usage); }
64
65     virtual std::unique_ptr<CryptoKeyData> exportData() const = 0;
66
67     static Vector<char> randomData(size_t);
68
69 private:
70     CryptoAlgorithmIdentifier m_algorithm;
71     CryptoKeyType m_type;
72     bool m_extractable;
73     CryptoKeyUsage m_usages;
74 };
75
76 #define CRYPTO_KEY_TYPE_CASTS(ToClassName) \
77     TYPE_CASTS_BASE(ToClassName, CryptoKey, key, WebCore::is##ToClassName(*key), WebCore::is##ToClassName(key))
78
79 } // namespace WebCore
80
81 #endif // ENABLE(SUBTLE_CRYPTO)
82 #endif // CryptoKey_h