[WebAuthN] Import CTAP HID message and packet structure from Chromium
[WebKit-https.git] / Source / WebCore / Modules / webauthn / fido / FidoConstants.h
1 // Copyright 2018 The Chromium Authors. All rights reserved.
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 are
6 // met:
7 //
8 //    * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 //    * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 //    * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 #pragma once
31
32 #if ENABLE(WEB_AUTHN)
33
34 namespace fido {
35
36 // Commands supported by CTAPHID device as specified in
37 // https://fidoalliance.org/specs/fido-v2.0-ps-20170927/fido-client-to-authenticator-protocol-v2.0-ps-20170927.html#ctaphid-commands
38 enum class FidoHidDeviceCommand : uint8_t {
39     kMsg = 0x03,
40     kCbor = 0x10,
41     kInit = 0x06,
42     kPing = 0x01,
43     kCancel = 0x11,
44     kError = 0x3F,
45     kKeepAlive = 0x3B,
46     kWink = 0x08,
47     kLock = 0x04,
48 };
49
50 bool isFidoHidDeviceCommand(FidoHidDeviceCommand cmd);
51
52 // HID transport specific constants.
53 const size_t kHidPacketSize = 64;
54 const uint32_t kHidBroadcastChannel = 0xffffffff;
55 const size_t kHidInitPacketHeaderSize = 7;
56 const size_t kHidContinuationPacketHeader = 5;
57 const size_t kHidMaxPacketSize = 64;
58 const size_t kHidInitPacketDataSize = kHidMaxPacketSize - kHidInitPacketHeaderSize;
59 const size_t kHidContinuationPacketDataSize = kHidMaxPacketSize - kHidContinuationPacketHeader;
60
61 const uint8_t kHidMaxLockSeconds = 10;
62
63 // Messages are limited to an initiation packet and 128 continuation packets.
64 const size_t kHidMaxMessageSize = 7609;
65
66 } // namespace fido
67
68 #endif // ENABLE(WEB_AUTHN)