c7f9d04ca2e4109c4d7803b6c6471caa417e8f3e
[WebKit-https.git] / Source / WebCore / crypto / keys / CryptoKeyRSA.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 #include "CryptoKey.h"
29 #include "ExceptionOr.h"
30 #include <wtf/Function.h>
31
32 #if ENABLE(SUBTLE_CRYPTO)
33
34 #if OS(DARWIN) && !PLATFORM(GTK)
35 typedef struct _CCRSACryptor *CCRSACryptorRef;
36 typedef CCRSACryptorRef PlatformRSAKey;
37 #endif
38
39 #if PLATFORM(GTK) || PLATFORM(WPE)
40 // gcry_sexp* equates gcry_sexp_t.
41 struct gcry_sexp;
42 typedef gcry_sexp* PlatformRSAKey;
43 #endif
44
45 namespace WebCore {
46
47 class CryptoKeyDataRSAComponents;
48 class PromiseWrapper;
49 class ScriptExecutionContext;
50
51 struct CryptoKeyPair;
52 struct JsonWebKey;
53
54 class RsaKeyAlgorithm : public KeyAlgorithm {
55 public:
56     RsaKeyAlgorithm(const String& name, size_t modulusLength, Vector<uint8_t>&& publicExponent)
57         : KeyAlgorithm(name)
58         , m_modulusLength(modulusLength)
59         , m_publicExponent(WTFMove(publicExponent))
60     {
61     }
62
63     KeyAlgorithmClass keyAlgorithmClass() const override { return KeyAlgorithmClass::RSA; }
64
65     size_t modulusLength() const { return m_modulusLength; }
66     const Vector<uint8_t>& publicExponent() const { return m_publicExponent; }
67
68     CryptoRsaKeyAlgorithm dictionary() const;
69
70 private:
71     size_t m_modulusLength;
72     Vector<uint8_t> m_publicExponent;
73 };
74
75 class RsaHashedKeyAlgorithm final : public RsaKeyAlgorithm {
76 public:
77     RsaHashedKeyAlgorithm(const String& name, size_t modulusLength, Vector<uint8_t>&& publicExponent, const String& hash)
78         : RsaKeyAlgorithm(name, modulusLength, WTFMove(publicExponent))
79         , m_hash(hash)
80     {
81     }
82
83     KeyAlgorithmClass keyAlgorithmClass() const final { return KeyAlgorithmClass::HRSA; }
84
85     const String& hash() const { return m_hash; }
86
87     CryptoRsaHashedKeyAlgorithm dictionary() const;
88
89 private:
90     String m_hash;
91 };
92
93 class CryptoKeyRSA final : public CryptoKey {
94 public:
95     static Ref<CryptoKeyRSA> create(CryptoAlgorithmIdentifier identifier, CryptoAlgorithmIdentifier hash, bool hasHash, CryptoKeyType type, PlatformRSAKey platformKey, bool extractable, CryptoKeyUsageBitmap usage)
96     {
97         return adoptRef(*new CryptoKeyRSA(identifier, hash, hasHash, type, platformKey, extractable, usage));
98     }
99     static RefPtr<CryptoKeyRSA> create(CryptoAlgorithmIdentifier, CryptoAlgorithmIdentifier hash, bool hasHash, const CryptoKeyDataRSAComponents&, bool extractable, CryptoKeyUsageBitmap);
100     virtual ~CryptoKeyRSA();
101
102     bool isRestrictedToHash(CryptoAlgorithmIdentifier&) const;
103
104     size_t keySizeInBits() const;
105
106     using KeyPairCallback = WTF::Function<void(CryptoKeyPair&&)>;
107     using VoidCallback = WTF::Function<void()>;
108     static void generatePair(CryptoAlgorithmIdentifier, CryptoAlgorithmIdentifier hash, bool hasHash, unsigned modulusLength, const Vector<uint8_t>& publicExponent, bool extractable, CryptoKeyUsageBitmap, KeyPairCallback&&, VoidCallback&& failureCallback, ScriptExecutionContext*);
109     static RefPtr<CryptoKeyRSA> importJwk(CryptoAlgorithmIdentifier, std::optional<CryptoAlgorithmIdentifier> hash, JsonWebKey&&, bool extractable, CryptoKeyUsageBitmap);
110     static RefPtr<CryptoKeyRSA> importSpki(CryptoAlgorithmIdentifier, std::optional<CryptoAlgorithmIdentifier> hash, Vector<uint8_t>&&, bool extractable, CryptoKeyUsageBitmap);
111     static RefPtr<CryptoKeyRSA> importPkcs8(CryptoAlgorithmIdentifier, std::optional<CryptoAlgorithmIdentifier> hash, Vector<uint8_t>&&, bool extractable, CryptoKeyUsageBitmap);
112
113     PlatformRSAKey platformKey() const { return m_platformKey; }
114     JsonWebKey exportJwk() const;
115     ExceptionOr<Vector<uint8_t>> exportSpki() const;
116     ExceptionOr<Vector<uint8_t>> exportPkcs8() const;
117
118     CryptoAlgorithmIdentifier hashAlgorithmIdentifier() const { return m_hash; }
119
120 private:
121     CryptoKeyRSA(CryptoAlgorithmIdentifier, CryptoAlgorithmIdentifier hash, bool hasHash, CryptoKeyType, PlatformRSAKey, bool extractable, CryptoKeyUsageBitmap);
122
123     CryptoKeyClass keyClass() const final { return CryptoKeyClass::RSA; }
124
125     std::unique_ptr<KeyAlgorithm> buildAlgorithm() const final;
126     std::unique_ptr<CryptoKeyData> exportData() const final;
127
128     PlatformRSAKey m_platformKey;
129
130     bool m_restrictedToSpecificHash;
131     CryptoAlgorithmIdentifier m_hash;
132 };
133
134 } // namespace WebCore
135
136 SPECIALIZE_TYPE_TRAITS_CRYPTO_KEY(CryptoKeyRSA, CryptoKeyClass::RSA)
137
138 SPECIALIZE_TYPE_TRAITS_KEY_ALGORITHM(RsaKeyAlgorithm, KeyAlgorithmClass::RSA)
139
140 SPECIALIZE_TYPE_TRAITS_KEY_ALGORITHM(RsaHashedKeyAlgorithm, KeyAlgorithmClass::HRSA)
141
142 #endif // ENABLE(SUBTLE_CRYPTO)