[WebAuthN] Use a real nonce for CTAPHID_INIT
[WebKit-https.git] / Source / WebKit / UIProcess / WebAuthentication / Mock / MockHidConnection.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) && PLATFORM(MAC)
29
30 #include "HidConnection.h"
31 #include "MockWebAuthenticationConfiguration.h"
32 #include <WebCore/FidoHidMessage.h>
33 #include <wtf/WeakPtr.h>
34
35 namespace WebKit {
36
37 // The following basically simulates an external HID token that:
38 //    1. Only supports CTAP2 protocol,
39 //    2. Doesn't support resident keys,
40 //    3. Doesn't support user verification.
41 // There are four stages for each WebAuthN request:
42 // FSM: Info::Init => Info::Msg => Request::Init => Request::Msg
43 // According to different combinations of error and stages, error will manifest differently.
44 class MockHidConnection final : public CanMakeWeakPtr<MockHidConnection>, public HidConnection {
45 public:
46     MockHidConnection(IOHIDDeviceRef, const MockWebAuthenticationConfiguration&);
47
48 private:
49     void send(Vector<uint8_t>&& data, DataSentCallback&&) final;
50     void initialize() final;
51     void terminate() final;
52     void registerDataReceivedCallbackInternal() final;
53
54     void assembleRequest(Vector<uint8_t>&&);
55     void parseRequest();
56     void feedReports();
57     bool stagesMatch() const;
58     void shouldContinueFeedReports();
59     void continueFeedReports();
60
61     MockWebAuthenticationConfiguration m_configuration;
62     std::optional<fido::FidoHidMessage> m_requestMessage;
63     MockWebAuthenticationConfiguration::Hid::Stage m_stage { MockWebAuthenticationConfiguration::Hid::Stage::Info };
64     MockWebAuthenticationConfiguration::Hid::SubStage m_subStage { MockWebAuthenticationConfiguration::Hid::SubStage::Init };
65     uint32_t m_currentChannel { fido::kHidBroadcastChannel };
66     bool m_requireResidentKey { false };
67     bool m_requireUserVerification  { false };
68     Vector<uint8_t> m_nonce;
69 };
70
71 } // namespace WebKit
72
73 #endif // ENABLE(WEB_AUTHN) && PLATFORM(MAC)