Source/WebCore/Modules/webauthn/fido/FidoHidMessage.h

   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 #pragma once
  31
  32 #if ENABLE(WEB_AUTHN)
  33
  34 #include "FidoConstants.h"
  35 #include "FidoHidPacket.h"
  36 #include <wtf/Deque.h>
  37 #include <wtf/Optional.h>
  38 #include <wtf/Vector.h>
  39
  40 namespace fido {
  41
  42 // Represents HID message format defined by the specification at
  43 // https://fidoalliance.org/specs/fido-v2.0-ps-20170927/fido-client-to-authenticator-protocol-v2.0-ps-20170927.html#message-and-packet-structure
  44 class WEBCORE_EXPORT FidoHidMessage {
  45     WTF_MAKE_NONCOPYABLE(FidoHidMessage);
  46 public:
  47     // Static functions to create CTAP/U2F HID commands.
  48     static std::optional<FidoHidMessage> create(uint32_t channelId, FidoHidDeviceCommand, const Vector<uint8_t>& data);
  49
  50     // Reconstruct a message from serialized message data.
  51     static std::optional<FidoHidMessage> createFromSerializedData(const Vector<uint8_t>&);
  52
  53     FidoHidMessage(FidoHidMessage&& that) = default;
  54     FidoHidMessage& operator=(FidoHidMessage&& other) = default;
  55
  56     bool messageComplete() const;
  57     Vector<uint8_t> getMessagePayload() const;
  58     // Pop front of queue with next packet.
  59     Vector<uint8_t> popNextPacket();
  60     // Adds a continuation packet to the packet list, from the serialized
  61     // response value.
  62     bool addContinuationPacket(const Vector<uint8_t>&);
  63
  64     size_t numPackets() const;
  65     uint32_t channelId() const { return m_channelId; }
  66     FidoHidDeviceCommand cmd() const { return m_cmd; }
  67     const Deque<std::unique_ptr<FidoHidPacket>>& getPacketsForTesting() const { return m_packets; }
  68
  69 private:
  70     FidoHidMessage(uint32_t channelId, FidoHidDeviceCommand, const Vector<uint8_t>& data);
  71     FidoHidMessage(std::unique_ptr<FidoHidInitPacket>, size_t remainingSize);
  72
  73     uint32_t m_channelId = kHidBroadcastChannel;
  74     FidoHidDeviceCommand m_cmd = FidoHidDeviceCommand::kMsg;
  75     Deque<std::unique_ptr<FidoHidPacket>> m_packets;
  76     size_t m_remainingSize = 0;
  77 };
  78
  79 } // namespace fido
  80
  81 #endif // ENABLE(WEB_AUTHN)