[WebAuthN] Support CTAP HID authenticators on macOS
[WebKit-https.git] / Source / WebKit / UIProcess / WebAuthentication / Cocoa / HidService.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 "AuthenticatorTransportService.h"
31 #include <IOKit/hid/IOHIDManager.h>
32 #include <wtf/UniqueRef.h>
33
34 namespace WebKit {
35
36 class CtapHidDriver;
37 class HidConnection;
38
39 class HidService : public AuthenticatorTransportService {
40 public:
41     explicit HidService(Observer&);
42     ~HidService();
43
44     void deviceAdded(IOHIDDeviceRef);
45
46 private:
47     void startDiscoveryInternal() final;
48
49     // Overrided by MockHidService.
50     virtual void platformStartDiscovery();
51     virtual UniqueRef<HidConnection> createHidConnection(IOHIDDeviceRef) const;
52
53     void continueAddDeviceAfterGetInfo(CtapHidDriver* deviceRef, Vector<uint8_t>&& info);
54
55     RetainPtr<IOHIDManagerRef> m_manager;
56     // Keeping drivers alive when they are initializing authenticators.
57     HashSet<std::unique_ptr<CtapHidDriver>> m_drivers;
58 };
59
60 } // namespace WebKit
61
62 #endif // ENABLE(WEB_AUTHN) && PLATFORM(MAC)