[WebAuthN] Support CTAP HID authenticators on macOS
[WebKit-https.git] / Source / WebKit / UIProcess / WebAuthentication / Cocoa / HidConnection.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 <IOKit/hid/IOHIDDevice.h>
31 #include <wtf/CompletionHandler.h>
32 #include <wtf/Deque.h>
33 #include <wtf/Forward.h>
34 #include <wtf/Function.h>
35 #include <wtf/Noncopyable.h>
36 #include <wtf/RetainPtr.h>
37
38 namespace WebKit {
39
40 class HidConnection {
41     WTF_MAKE_FAST_ALLOCATED;
42     WTF_MAKE_NONCOPYABLE(HidConnection);
43 public:
44     enum class DataSent {
45         No,
46         Yes
47     };
48
49     using DataSentCallback = CompletionHandler<void(DataSent)>;
50     using DataReceivedCallback = Function<void(Vector<uint8_t>&&)>;
51
52     explicit HidConnection(IOHIDDeviceRef);
53     virtual ~HidConnection();
54
55     // Overrided by MockHidConnection.
56     virtual void initialize();
57     virtual void terminate();
58     // Caller should send data again after callback is invoked to control flow.
59     virtual void send(Vector<uint8_t>&& data, DataSentCallback&&);
60     void registerDataReceivedCallback(DataReceivedCallback&&);
61     void unregisterDataReceivedCallback();
62
63     void receiveReport(Vector<uint8_t>&&);
64
65 protected:
66     bool m_initialized { false };
67     bool m_terminated { false };
68
69 private:
70     void consumeReports();
71
72     // Overrided by MockHidConnection.
73     virtual void registerDataReceivedCallbackInternal();
74
75     RetainPtr<IOHIDDeviceRef> m_device;
76     Vector<uint8_t> m_inputBuffer;
77     // Could queue data requested by other applications.
78     Deque<Vector<uint8_t>> m_inputReports;
79     DataReceivedCallback m_inputCallback;
80 };
81
82 } // namespace WebKit
83
84 #endif // ENABLE(WEB_AUTHN) && PLATFORM(MAC)