[WebAuthN] Import CTAP HID message and packet structure from Chromium
[WebKit-https.git] / Source / WebCore / Modules / webauthn / fido / FidoHidMessage.cpp
1 // Copyright 2017 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 #include "config.h"
31 #include "FidoHidMessage.h"
32
33 #if ENABLE(WEB_AUTHN)
34
35 #include "FidoParsingUtils.h"
36
37 namespace fido {
38
39 // static
40 std::optional<FidoHidMessage> FidoHidMessage::create(uint32_t channelId, FidoHidDeviceCommand type, const Vector<uint8_t>& data)
41 {
42     if (data.size() > kHidMaxMessageSize)
43         return std::nullopt;
44
45     switch (type) {
46     case FidoHidDeviceCommand::kPing:
47         break;
48     case FidoHidDeviceCommand::kMsg:
49     case FidoHidDeviceCommand::kCbor: {
50         if (data.isEmpty())
51             return std::nullopt;
52         break;
53     }
54
55     case FidoHidDeviceCommand::kCancel:
56     case FidoHidDeviceCommand::kWink: {
57         if (!data.isEmpty())
58             return std::nullopt;
59         break;
60     }
61     case FidoHidDeviceCommand::kLock: {
62         if (data.size() != 1 || data[0] > kHidMaxLockSeconds)
63             return std::nullopt;
64         break;
65     }
66     case FidoHidDeviceCommand::kInit: {
67         if (data.size() != 8)
68             return std::nullopt;
69         break;
70     }
71     case FidoHidDeviceCommand::kKeepAlive:
72     case FidoHidDeviceCommand::kError:
73         if (data.size() != 1)
74             return std::nullopt;
75     }
76
77     return FidoHidMessage(channelId, type, data);
78 }
79
80 // static
81 std::optional<FidoHidMessage> FidoHidMessage::createFromSerializedData(const Vector<uint8_t>& serializedData)
82 {
83     size_t remainingSize = 0;
84     if (serializedData.size() > kHidPacketSize || serializedData.size() < kHidInitPacketHeaderSize)
85         return std::nullopt;
86
87     auto initPacket = FidoHidInitPacket::createFromSerializedData(serializedData, &remainingSize);
88
89     if (!initPacket)
90         return std::nullopt;
91
92     return FidoHidMessage(WTFMove(initPacket), remainingSize);
93 }
94
95 bool FidoHidMessage::messageComplete() const
96 {
97     return !m_remainingSize;
98 }
99
100 Vector<uint8_t> FidoHidMessage::getMessagePayload() const
101 {
102     Vector<uint8_t> data;
103     size_t dataSize = 0;
104     for (const auto& packet : m_packets)
105         dataSize += packet->getPacketPayload().size();
106     data.reserveInitialCapacity(dataSize);
107
108     for (const auto& packet : m_packets) {
109         const auto& packet_data = packet->getPacketPayload();
110         data.appendVector(packet_data);
111     }
112
113     return data;
114 }
115
116 Vector<uint8_t> FidoHidMessage::popNextPacket()
117 {
118     if (m_packets.isEmpty())
119         return { };
120
121     Vector<uint8_t> data = m_packets.first()->getSerializedData();
122     m_packets.removeFirst();
123     return data;
124 }
125
126 bool FidoHidMessage::addContinuationPacket(const Vector<uint8_t>& buf)
127 {
128     size_t remainingSize = m_remainingSize;
129     auto contPacket = FidoHidContinuationPacket::createFromSerializedData(buf, &remainingSize);
130
131     // Reject packets with a different channel id.
132     if (!contPacket || m_channelId != contPacket->channelId())
133         return false;
134
135     m_remainingSize = remainingSize;
136     m_packets.append(WTFMove(contPacket));
137     return true;
138 }
139
140 size_t FidoHidMessage::numPackets() const
141 {
142     return m_packets.size();
143 }
144
145 FidoHidMessage::FidoHidMessage(uint32_t channelId, FidoHidDeviceCommand type, const Vector<uint8_t>& data)
146     : m_channelId(channelId)
147 {
148     uint8_t sequence = 0;
149
150     size_t pos = data.size() > kHidInitPacketDataSize ? kHidInitPacketDataSize : data.size();
151     m_packets.append(std::make_unique<FidoHidInitPacket>(channelId, type, getInitPacketData(data), data.size()));
152     for (; pos < data.size(); pos += kHidContinuationPacketDataSize)
153         m_packets.append(std::make_unique<FidoHidContinuationPacket>(channelId, sequence++, getContinuationPacketData(data, pos)));
154 }
155
156 FidoHidMessage::FidoHidMessage(std::unique_ptr<FidoHidInitPacket> initPacket, size_t remainingSize)
157     : m_remainingSize(remainingSize)
158 {
159     m_channelId = initPacket->channelId();
160     m_cmd = initPacket->command();
161     m_packets.append(WTFMove(initPacket));
162 }
163
164 } // namespace fido
165
166 #endif // ENABLE(WEB_AUTHN)