c6398c0cb5bc937a4e132f5dfe42d3af570016e2
[WebKit-https.git] / Source / WebCore / crypto / keys / CryptoKeyEC.h
1 /*
2  * Copyright (C) 2017 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 #include "CryptoKey.h"
29 #include "CryptoKeyPair.h"
30 #include "ExceptionOr.h"
31
32 #if ENABLE(SUBTLE_CRYPTO)
33
34 #if OS(DARWIN) && !PLATFORM(GTK)
35 typedef struct _CCECCryptor *CCECCryptorRef;
36 typedef CCECCryptorRef PlatformECKey;
37 #endif
38
39 #if PLATFORM(GTK) || PLATFORM(WPE)
40 // gcry_sexp* equates gcry_sexp_t.
41 struct gcry_sexp;
42 typedef gcry_sexp* PlatformECKey;
43 #endif
44
45
46 namespace WebCore {
47
48 struct JsonWebKey;
49
50 class EcKeyAlgorithm : public KeyAlgorithm {
51 public:
52     EcKeyAlgorithm(const String& name, const String& curve)
53         : KeyAlgorithm(name)
54         , m_curve(curve)
55     {
56     }
57
58     KeyAlgorithmClass keyAlgorithmClass() const override { return KeyAlgorithmClass::EC; }
59
60     const String& namedCurve() const { return m_curve; }
61
62     CryptoEcKeyAlgorithm dictionary() const;
63
64 private:
65     String m_curve;
66 };
67
68 class CryptoKeyEC final : public CryptoKey {
69 public:
70     // FIXME: https://bugs.webkit.org/show_bug.cgi?id=169231
71     enum class NamedCurve {
72         P256,
73         P384,
74     };
75
76     static Ref<CryptoKeyEC> create(CryptoAlgorithmIdentifier identifier, NamedCurve curve, CryptoKeyType type, PlatformECKey platformKey, bool extractable, CryptoKeyUsageBitmap usages)
77     {
78         return adoptRef(*new CryptoKeyEC(identifier, curve, type, platformKey, extractable, usages));
79     }
80     virtual ~CryptoKeyEC();
81
82     static ExceptionOr<CryptoKeyPair> generatePair(CryptoAlgorithmIdentifier, const String& curve, bool extractable, CryptoKeyUsageBitmap);
83     static RefPtr<CryptoKeyEC> importRaw(CryptoAlgorithmIdentifier, const String& curve, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap);
84     static RefPtr<CryptoKeyEC> importJwk(CryptoAlgorithmIdentifier, const String& curve, JsonWebKey&&, bool extractable, CryptoKeyUsageBitmap);
85     static RefPtr<CryptoKeyEC> importSpki(CryptoAlgorithmIdentifier, const String& curve, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap);
86     static RefPtr<CryptoKeyEC> importPkcs8(CryptoAlgorithmIdentifier, const String& curve, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap);
87
88     ExceptionOr<Vector<uint8_t>> exportRaw() const;
89     JsonWebKey exportJwk() const;
90     ExceptionOr<Vector<uint8_t>> exportSpki() const;
91     ExceptionOr<Vector<uint8_t>> exportPkcs8() const;
92
93     size_t keySizeInBits() const;
94     NamedCurve namedCurve() const { return m_curve; }
95     String namedCurveString() const;
96     PlatformECKey platformKey() { return m_platformKey; }
97     static bool isValidECAlgorithm(CryptoAlgorithmIdentifier);
98
99 private:
100     CryptoKeyEC(CryptoAlgorithmIdentifier, NamedCurve, CryptoKeyType, PlatformECKey, bool extractable, CryptoKeyUsageBitmap);
101
102     CryptoKeyClass keyClass() const final { return CryptoKeyClass::EC; }
103
104     std::unique_ptr<KeyAlgorithm> buildAlgorithm() const final;
105     std::unique_ptr<CryptoKeyData> exportData() const final;
106
107     static std::optional<CryptoKeyPair> platformGeneratePair(CryptoAlgorithmIdentifier, NamedCurve, bool extractable, CryptoKeyUsageBitmap);
108     static RefPtr<CryptoKeyEC> platformImportRaw(CryptoAlgorithmIdentifier, NamedCurve, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap);
109     static RefPtr<CryptoKeyEC> platformImportJWKPublic(CryptoAlgorithmIdentifier, NamedCurve, Vector<uint8_t>&& x, Vector<uint8_t>&& y, bool extractable, CryptoKeyUsageBitmap);
110     static RefPtr<CryptoKeyEC> platformImportJWKPrivate(CryptoAlgorithmIdentifier, NamedCurve, Vector<uint8_t>&& x, Vector<uint8_t>&& y, Vector<uint8_t>&& d, bool extractable, CryptoKeyUsageBitmap);
111     static RefPtr<CryptoKeyEC> platformImportSpki(CryptoAlgorithmIdentifier, NamedCurve, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap);
112     static RefPtr<CryptoKeyEC> platformImportPkcs8(CryptoAlgorithmIdentifier, NamedCurve, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap);
113     Vector<uint8_t> platformExportRaw() const;
114     void platformAddFieldElements(JsonWebKey&) const;
115     Vector<uint8_t> platformExportSpki() const;
116     Vector<uint8_t> platformExportPkcs8() const;
117
118     PlatformECKey m_platformKey;
119     NamedCurve m_curve;
120 };
121
122 } // namespace WebCore
123
124 SPECIALIZE_TYPE_TRAITS_CRYPTO_KEY(CryptoKeyEC, CryptoKeyClass::EC)
125
126 SPECIALIZE_TYPE_TRAITS_KEY_ALGORITHM(EcKeyAlgorithm, KeyAlgorithmClass::EC)
127
128 #endif // ENABLE(SUBTLE_CRYPTO)