5b866b96294913842c863ef1d84c1b9184e3aaa7
[WebKit-https.git] / Source / WebCore / Modules / webauthn / PublicKeyCredential.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 "BasicCredential.h"
29 #include "ExceptionOr.h"
30 #include <runtime/ArrayBuffer.h>
31 #include <wtf/Forward.h>
32
33 namespace WebCore {
34
35 class AuthenticatorResponse;
36 class DeferredPromise;
37 class SecurityOrigin;
38
39 struct PublicKeyCredentialCreationOptions;
40 struct CredentialRequestOptions;
41
42 class PublicKeyCredential final : public BasicCredential {
43 public:
44     static Ref<PublicKeyCredential> create(RefPtr<ArrayBuffer>&& id, RefPtr<AuthenticatorResponse>&& response)
45     {
46         return adoptRef(*new PublicKeyCredential(WTFMove(id), WTFMove(response)));
47     }
48
49     static Vector<Ref<BasicCredential>> collectFromCredentialStore(CredentialRequestOptions&&, bool);
50     static ExceptionOr<RefPtr<BasicCredential>> discoverFromExternalSource(const SecurityOrigin&, const CredentialRequestOptions&, bool sameOriginWithAncestors);
51     static RefPtr<BasicCredential> store(RefPtr<BasicCredential>&&, bool);
52     static ExceptionOr<RefPtr<BasicCredential>> create(const SecurityOrigin&, const PublicKeyCredentialCreationOptions&, bool sameOriginWithAncestors);
53
54     ArrayBuffer* rawId() const;
55     AuthenticatorResponse* response() const;
56     // Not support yet. Always throws.
57     ExceptionOr<bool> getClientExtensionResults() const;
58
59     static void isUserVerifyingPlatformAuthenticatorAvailable(Ref<DeferredPromise>&&);
60
61 private:
62     PublicKeyCredential(RefPtr<ArrayBuffer>&& id, RefPtr<AuthenticatorResponse>&&);
63
64     Type credentialType() const final { return Type::PublicKey; }
65
66     RefPtr<ArrayBuffer> m_rawId;
67     RefPtr<AuthenticatorResponse> m_response;
68 };
69
70 } // namespace WebCore
71
72 SPECIALIZE_TYPE_TRAITS_BASIC_CREDENTIAL(PublicKeyCredential, BasicCredential::Type::PublicKey)