[WebAuthN] Support CTAP HID authenticators on macOS
[WebKit-https.git] / Source / WebKit / UIProcess / WebAuthentication / Cocoa / HidService.mm
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 #import "config.h"
27 #import "HidService.h"
28
29 #if ENABLE(WEB_AUTHN) && PLATFORM(MAC)
30
31 #import "CtapHidAuthenticator.h"
32 #import "CtapHidDriver.h"
33 #import "HidConnection.h"
34 #import <WebCore/DeviceRequestConverter.h>
35 #import <WebCore/DeviceResponseConverter.h>
36 #import <WebCore/FidoConstants.h>
37 #import <WebCore/FidoHidMessage.h>
38
39 namespace WebKit {
40 using namespace fido;
41
42 // FIXME(191518)
43 static void deviceAddedCallback(void* context, IOReturn, void*, IOHIDDeviceRef device)
44 {
45     ASSERT(device);
46     auto* listener = static_cast<HidService*>(context);
47     listener->deviceAdded(device);
48 }
49
50 // FIXME(191518)
51 static void deviceRemovedCallback(void* context, IOReturn, void*, IOHIDDeviceRef device)
52 {
53     // FIXME(191525)
54 }
55
56 HidService::HidService(Observer& observer)
57     : AuthenticatorTransportService(observer)
58 {
59     m_manager = adoptCF(IOHIDManagerCreate(kCFAllocatorDefault, kIOHIDOptionsTypeNone));
60     NSDictionary *matchingDictionary = @{
61         @kIOHIDPrimaryUsagePageKey: adoptNS([NSNumber numberWithInt:kCTAPHIDUsagePage]).get(),
62         @kIOHIDPrimaryUsageKey: adoptNS([NSNumber numberWithInt:kCTAPHIDUsage]).get()
63     };
64     IOHIDManagerSetDeviceMatching(m_manager.get(), (__bridge CFDictionaryRef)matchingDictionary);
65     IOHIDManagerRegisterDeviceMatchingCallback(m_manager.get(), deviceAddedCallback, this);
66     IOHIDManagerRegisterDeviceRemovalCallback(m_manager.get(), deviceRemovedCallback, this);
67 }
68
69 HidService::~HidService()
70 {
71     IOHIDManagerUnscheduleFromRunLoop(m_manager.get(), CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
72     IOHIDManagerClose(m_manager.get(), kIOHIDOptionsTypeNone);
73 }
74
75 void HidService::startDiscoveryInternal()
76 {
77     platformStartDiscovery();
78 }
79
80 void HidService::platformStartDiscovery()
81 {
82     IOHIDManagerScheduleWithRunLoop(m_manager.get(), CFRunLoopGetCurrent(), kCFRunLoopDefaultMode);
83     IOHIDManagerOpen(m_manager.get(), kIOHIDOptionsTypeNone);
84 }
85
86 UniqueRef<HidConnection> HidService::createHidConnection(IOHIDDeviceRef device) const
87 {
88     return makeUniqueRef<HidConnection>(device);
89 }
90
91 void HidService::deviceAdded(IOHIDDeviceRef device)
92 {
93     auto driver = std::make_unique<CtapHidDriver>(createHidConnection(device));
94     // Get authenticator info from the device.
95     driver->transact(encodeEmptyAuthenticatorRequest(CtapRequestCommand::kAuthenticatorGetInfo), [weakThis = makeWeakPtr(*this), ptr = driver.get()](Vector<uint8_t>&& response) {
96         ASSERT(RunLoop::isMain());
97         if (!weakThis)
98             return;
99         weakThis->continueAddDeviceAfterGetInfo(ptr, WTFMove(response));
100     });
101     auto addResult = m_drivers.add(WTFMove(driver));
102     ASSERT_UNUSED(addResult, addResult.isNewEntry);
103 }
104
105 void HidService::continueAddDeviceAfterGetInfo(CtapHidDriver* ptr, Vector<uint8_t>&& response)
106 {
107     std::unique_ptr<CtapHidDriver> driver = m_drivers.take(ptr);
108     if (!driver || !observer())
109         return;
110
111     auto info = readCTAPGetInfoResponse(response);
112     if (info && info->versions().find(ProtocolVersion::kCtap) != info->versions().end()) {
113         observer()->authenticatorAdded(CtapHidAuthenticator::create(WTFMove(driver), WTFMove(*info)));
114         return;
115     }
116     // FIXME(191535): Support U2F authenticators.
117 }
118
119 } // namespace WebKit
120
121 #endif // ENABLE(WEB_AUTHN) && PLATFORM(MAC)