e683dcac65342f3decca93ee77fe7a05d6774ae6
[WebKit-https.git] / Source / WebCore / Modules / webauthn / PublicKeyCredential.cpp
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 #include "config.h"
27 #include "PublicKeyCredential.h"
28
29 #include "Authenticator.h"
30 #include "AuthenticatorResponse.h"
31 #include "CredentialCreationOptions.h"
32 #include "JSDOMPromiseDeferred.h"
33 #include "SecurityOrigin.h"
34 #include <pal/crypto/CryptoDigest.h>
35 #include <wtf/CurrentTime.h>
36 #include <wtf/JSONValues.h>
37 #include <wtf/text/Base64.h>
38
39 namespace WebCore {
40
41 namespace PublicKeyCredentialInternal {
42
43 // The layout of attestation object: https://www.w3.org/TR/webauthn/#attestation-object as of 5 December 2017.
44 // Here is a summary before CredentialID in the layout. All lengths are fixed.
45 // RP ID hash (32) || FLAGS (1) || COUNTER (4) || AAGUID (16) || L (2) || CREDENTIAL ID (?) || ...
46 static constexpr size_t CredentialIdLengthOffset = 43;
47
48 enum class ClientDataType {
49     Create,
50     Get
51 };
52
53 // FIXME: Add token binding ID and extensions.
54 // https://bugs.webkit.org/show_bug.cgi?id=181948
55 // https://bugs.webkit.org/show_bug.cgi?id=181949
56 static Ref<ArrayBuffer> produceClientDataJson(ClientDataType type, const BufferSource& challenge, const SecurityOrigin& origin)
57 {
58     auto object = JSON::Object::create();
59     switch (type) {
60     case ClientDataType::Create:
61         object->setString(ASCIILiteral("type"), ASCIILiteral("webauthn.create"));
62         break;
63     case ClientDataType::Get:
64         object->setString(ASCIILiteral("type"), ASCIILiteral("webauthn.get"));
65         break;
66     }
67     object->setString(ASCIILiteral("challenge"), WTF::base64URLEncode(challenge.data(), challenge.length()));
68     object->setString(ASCIILiteral("origin"), origin.toRawString());
69     // FIXME: This might be platform dependent.
70     object->setString(ASCIILiteral("hashAlgorithm"), ASCIILiteral("SHA-256"));
71
72     auto utf8JSONString = object->toJSONString().utf8();
73     return ArrayBuffer::create(utf8JSONString.data(), utf8JSONString.length());
74 }
75
76 static Vector<uint8_t> produceClientDataJsonHash(const Ref<ArrayBuffer>& clientDataJson)
77 {
78     auto crypto = PAL::CryptoDigest::create(PAL::CryptoDigest::Algorithm::SHA_256);
79     crypto->addBytes(clientDataJson->data(), clientDataJson->byteLength());
80     return crypto->computeHash();
81 }
82
83 static RefPtr<ArrayBuffer> getIdFromAttestationObject(const Vector<uint8_t>& attestationObject)
84 {
85     // The byte length of L is 2.
86     if (attestationObject.size() < CredentialIdLengthOffset + 2)
87         return nullptr;
88     size_t length = (attestationObject[CredentialIdLengthOffset] << 8) + attestationObject[CredentialIdLengthOffset + 1];
89     if (attestationObject.size() < CredentialIdLengthOffset + 2 + length)
90         return nullptr;
91     return ArrayBuffer::create(attestationObject.data() + CredentialIdLengthOffset + 2, length);
92 }
93
94 } // namespace PublicKeyCredentialInternal
95
96 PublicKeyCredential::PublicKeyCredential(RefPtr<ArrayBuffer>&& id, RefPtr<AuthenticatorResponse>&& response)
97     : BasicCredential(WTF::base64URLEncode(id->data(), id->byteLength()), Type::PublicKey, Discovery::Remote)
98     , m_rawId(WTFMove(id))
99     , m_response(WTFMove(response))
100 {
101 }
102
103 Vector<Ref<BasicCredential>> PublicKeyCredential::collectFromCredentialStore(CredentialRequestOptions&&, bool)
104 {
105     return { };
106 }
107
108 ExceptionOr<RefPtr<BasicCredential>> PublicKeyCredential::discoverFromExternalSource(const SecurityOrigin&, const CredentialRequestOptions&, bool)
109 {
110     return Exception { NotSupportedError };
111 }
112
113 RefPtr<BasicCredential> PublicKeyCredential::store(RefPtr<BasicCredential>&&, bool)
114 {
115     return nullptr;
116 }
117
118 ExceptionOr<RefPtr<BasicCredential>> PublicKeyCredential::create(const SecurityOrigin& callerOrigin, const PublicKeyCredentialCreationOptions& options, bool sameOriginWithAncestors)
119 {
120     using namespace PublicKeyCredentialInternal;
121
122     // The following implements https://www.w3.org/TR/webauthn/#createCredential as of 5 December 2017.
123     // FIXME: Extensions are not supported yet. Skip Step 11-12.
124     // Step 1, 3, 4, 17 are handled by the caller, including options sanitizing, timer and abort signal.
125     // Step 2.
126     if (!sameOriginWithAncestors)
127         return Exception { NotAllowedError };
128
129     // Step 5-7.
130     // FIXME: We lack fundamental support from SecurityOrigin to determine if a host is a valid domain or not.
131     // Step 6 is therefore skipped. Also, we lack the support to determine whether a domain is a registrable
132     // domain suffix of another domain. Hence restrict the comparison to equal in Step 7.
133     // https://bugs.webkit.org/show_bug.cgi?id=181950
134     if (!options.rp.id.isEmpty() && !(callerOrigin.host() == options.rp.id))
135         return Exception { SecurityError };
136     if (options.rp.id.isEmpty())
137         options.rp.id = callerOrigin.host();
138
139     // Step 8-10.
140     // Most of the jobs are done by bindings. However, we can't know if the JSValue of options.pubKeyCredParams
141     // is empty or not. Return NotSupportedError as long as it is empty.
142     if (options.pubKeyCredParams.isEmpty())
143         return Exception { NotSupportedError };
144
145     // Step 13-15.
146     auto clientDataJson = produceClientDataJson(ClientDataType::Create, options.challenge, callerOrigin);
147     auto clientDataJsonHash = produceClientDataJsonHash(clientDataJson);
148
149     // Step 18-21.
150     // Only platform attachments will be supported at this stage. Assuming one authenticator per device.
151     // Also, resident keys, user verifications and direct attestation are enforced at this tage.
152     // For better performance, no filtering is done here regarding to options.excludeCredentials.
153     // What's more, user cancellations effectively means NotAllowedError. Therefore, the below call
154     // will only returns either an exception or a PublicKeyCredential ref.
155     // FIXME: The following operation might need to perform async.
156     // https://bugs.webkit.org/show_bug.cgi?id=181946
157     auto result = Authenticator::singleton().makeCredential(clientDataJsonHash, options.rp, options.user, options.pubKeyCredParams, options.excludeCredentials);
158     if (result.hasException())
159         return result.releaseException();
160
161     auto attestationObject = result.releaseReturnValue();
162     // FIXME: Got some crazy compile error when I was trying to return RHS directly.
163     RefPtr<BasicCredential> credential = PublicKeyCredential::create(getIdFromAttestationObject(attestationObject), AuthenticatorAttestationResponse::create(WTFMove(clientDataJson), ArrayBuffer::create(attestationObject.data(), attestationObject.size())));
164     return WTFMove(credential);
165 }
166
167 ArrayBuffer* PublicKeyCredential::rawId() const
168 {
169     return m_rawId.get();
170 }
171
172 AuthenticatorResponse* PublicKeyCredential::response() const
173 {
174     return m_response.get();
175 }
176
177 ExceptionOr<bool> PublicKeyCredential::getClientExtensionResults() const
178 {
179     return Exception { NotSupportedError };
180 }
181
182 void PublicKeyCredential::isUserVerifyingPlatformAuthenticatorAvailable(Ref<DeferredPromise>&& promise)
183 {
184     promise->reject(Exception { NotSupportedError });
185 }
186
187 } // namespace WebCore