[WebAuthn] Formalize the Keychain schema
[WebKit-https.git] / Source / WebCore / Modules / webauthn / AuthenticatorAssertionResponse.h
1 /*
2  * Copyright (C) 2018 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 #if ENABLE(WEB_AUTHN)
29
30 #include "AuthenticatorResponse.h"
31 #include <wtf/RetainPtr.h>
32 #include <wtf/spi/cocoa/SecuritySPI.h>
33
34 namespace WebCore {
35
36 class AuthenticatorAssertionResponse : public AuthenticatorResponse {
37 public:
38     static Ref<AuthenticatorAssertionResponse> create(Ref<ArrayBuffer>&& rawId, Ref<ArrayBuffer>&& authenticatorData, Ref<ArrayBuffer>&& signature, RefPtr<ArrayBuffer>&& userHandle, Optional<AuthenticationExtensionsClientOutputs>&&);
39     WEBCORE_EXPORT static Ref<AuthenticatorAssertionResponse> create(const Vector<uint8_t>& rawId, const Vector<uint8_t>& authenticatorData, const Vector<uint8_t>& signature,  const Vector<uint8_t>& userHandle);
40     WEBCORE_EXPORT static Ref<AuthenticatorAssertionResponse> create(Ref<ArrayBuffer>&& rawId, Ref<ArrayBuffer>&& userHandle, String&& name, SecAccessControlRef);
41     virtual ~AuthenticatorAssertionResponse() = default;
42
43     ArrayBuffer* authenticatorData() const { return m_authenticatorData.get(); }
44     ArrayBuffer* signature() const { return m_signature.get(); }
45     ArrayBuffer* userHandle() const { return m_userHandle.get(); }
46     const String& name() const { return m_name; }
47     const String& displayName() const { return m_displayName; }
48     size_t numberOfCredentials() const { return m_numberOfCredentials; }
49     SecAccessControlRef accessControl() const { return m_accessControl.get(); }
50
51     WEBCORE_EXPORT void setAuthenticatorData(Vector<uint8_t>&&);
52     void setSignature(Ref<ArrayBuffer>&& signature) { m_signature = WTFMove(signature); }
53     void setName(const String& name) { m_name = name; }
54     void setDisplayName(const String& displayName) { m_displayName = displayName; }
55     void setNumberOfCredentials(size_t numberOfCredentials) { m_numberOfCredentials = numberOfCredentials; }
56
57 private:
58     AuthenticatorAssertionResponse(Ref<ArrayBuffer>&&, Ref<ArrayBuffer>&&, Ref<ArrayBuffer>&&, RefPtr<ArrayBuffer>&&);
59     AuthenticatorAssertionResponse(Ref<ArrayBuffer>&&, Ref<ArrayBuffer>&&, String&&, SecAccessControlRef);
60
61     Type type() const final { return Type::Assertion; }
62     AuthenticatorResponseData data() const final;
63
64     RefPtr<ArrayBuffer> m_authenticatorData;
65     RefPtr<ArrayBuffer> m_signature;
66     RefPtr<ArrayBuffer> m_userHandle;
67
68     String m_name;
69     String m_displayName;
70     size_t m_numberOfCredentials { 0 };
71     RetainPtr<SecAccessControlRef> m_accessControl;
72 };
73
74 } // namespace WebCore
75
76 SPECIALIZE_TYPE_TRAITS_AUTHENTICATOR_RESPONSE(AuthenticatorAssertionResponse, AuthenticatorResponse::Type::Assertion)
77
78 #endif // ENABLE(WEB_AUTHN)