mvfst/quic/codec/test/QuicPacketBuilderTest.cpp

/*
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */

#include <folly/portability/GTest.h>

#include <folly/Random.h>
#include <quic/codec/QuicPacketBuilder.h>
#include <quic/codec/QuicReadCodec.h>
#include <quic/codec/Types.h>
#include <quic/codec/test/Mocks.h>
#include <quic/common/test/TestUtils.h>
#include <quic/handshake/HandshakeLayer.h>

using namespace quic;
using namespace quic::test;
using namespace testing;

Buf packetToBuf(
    RegularQuicPacketBuilder::Packet& packet,
    Aead* aead = nullptr) {
  auto buf = folly::IOBuf::create(0);
  // This doesnt matter.
  PacketNum num = 10;
  if (packet.header) {
    buf->prependChain(packet.header->clone());
  }
  std::unique_ptr<folly::IOBuf> body = folly::IOBuf::create(0);
  if (packet.body) {
    body = packet.body->clone();
  }
  if (aead && packet.header) {
    auto bodySize = body->computeChainDataLength();
    body = aead->encrypt(std::move(body), packet.header.get(), num);
    EXPECT_GT(body->computeChainDataLength(), bodySize);
  }
  if (body) {
    buf->prependChain(std::move(body));
  }
  return buf;
}

size_t longHeaderLength = sizeof(uint32_t) + sizeof(uint32_t) +
    kDefaultConnectionIdSize + sizeof(uint8_t);

constexpr size_t kVersionNegotiationHeaderSize =
    sizeof(FrameType) + kDefaultConnectionIdSize * 2 + sizeof(QuicVersion);

std::unique_ptr<QuicReadCodec> makeCodec(
    ConnectionId clientConnId,
    QuicNodeType nodeType,
    std::unique_ptr<Aead> zeroRttCipher = nullptr,
    std::unique_ptr<Aead> oneRttCipher = nullptr) {
  QuicFizzFactory fizzFactory;
  auto codec = std::make_unique<QuicReadCodec>(nodeType);
  if (nodeType != QuicNodeType::Client) {
    codec->setZeroRttReadCipher(std::move(zeroRttCipher));
    codec->setZeroRttHeaderCipher(test::createNoOpHeaderCipher());
  }
  codec->setOneRttReadCipher(std::move(oneRttCipher));
  codec->setOneRttHeaderCipher(test::createNoOpHeaderCipher());
  codec->setHandshakeReadCipher(test::createNoOpAead());
  codec->setHandshakeHeaderCipher(test::createNoOpHeaderCipher());
  codec->setClientConnectionId(clientConnId);
  if (nodeType == QuicNodeType::Client) {
    codec->setInitialReadCipher(
        getServerInitialCipher(&fizzFactory, clientConnId, QuicVersion::MVFST));
    codec->setInitialHeaderCipher(makeServerInitialHeaderCipher(
        &fizzFactory, clientConnId, QuicVersion::MVFST));
  } else {
    codec->setInitialReadCipher(
        getClientInitialCipher(&fizzFactory, clientConnId, QuicVersion::MVFST));
    codec->setInitialHeaderCipher(makeClientInitialHeaderCipher(
        &fizzFactory, clientConnId, QuicVersion::MVFST));
  }
  return codec;
}

class QuicPacketBuilderTest : public Test {};

TEST_F(QuicPacketBuilderTest, SimpleVersionNegotiationPacket) {
  auto versions = versionList({1, 2, 3, 4, 5, 6, 7});

  auto srcConnId = getTestConnectionId(0), destConnId = getTestConnectionId(1);
  VersionNegotiationPacketBuilder builder(srcConnId, destConnId, versions);
  EXPECT_TRUE(builder.canBuildPacket());
  auto builtOut = std::move(builder).buildPacket();
  auto resultVersionNegotiationPacket = builtOut.first;

  // Verify the returned packet from packet builder:
  EXPECT_EQ(resultVersionNegotiationPacket.versions, versions);
  EXPECT_EQ(resultVersionNegotiationPacket.sourceConnectionId, srcConnId);
  EXPECT_EQ(resultVersionNegotiationPacket.destinationConnectionId, destConnId);

  // Verify the returned buf from packet builder can be decoded by read codec:
  AckStates ackStates;
  auto packetQueue = bufToQueue(std::move(builtOut.second));
  auto optionalDecodedPacket = makeCodec(destConnId, QuicNodeType::Client)
                                   ->parsePacket(packetQueue, ackStates);
  auto decodedPacket = boost::get<QuicPacket>(optionalDecodedPacket);
  EXPECT_NO_THROW(boost::get<VersionNegotiationPacket>(decodedPacket));
  auto decodedVersionNegotiationPacket =
      boost::get<VersionNegotiationPacket>(decodedPacket);
  EXPECT_EQ(decodedVersionNegotiationPacket.sourceConnectionId, srcConnId);
  EXPECT_EQ(
      decodedVersionNegotiationPacket.destinationConnectionId, destConnId);
  EXPECT_EQ(decodedVersionNegotiationPacket.versions, versions);
}

TEST_F(QuicPacketBuilderTest, SimpleRetryPacket) {
  LongHeader headerIn(
      LongHeader::Types::Retry,
      getTestConnectionId(0),
      getTestConnectionId(1),
      321,
      QuicVersion::MVFST,
      folly::IOBuf::copyBuffer("454358"),
      getTestConnectionId(2));

  RegularQuicPacketBuilder builder(
      kDefaultUDPSendPacketLen, std::move(headerIn), 0 /* largestAcked */);

  auto packet = packetToBuf(std::move(builder).buildPacket());
  auto packetQueue = bufToQueue(std::move(packet));

  // Verify the returned buf from packet builder can be decoded by read codec:
  AckStates ackStates;
  auto optionalDecodedPacket =
      makeCodec(getTestConnectionId(1), QuicNodeType::Client)
          ->parsePacket(packetQueue, ackStates);
  EXPECT_NO_THROW(boost::get<QuicPacket>(optionalDecodedPacket));
  auto decodedPacket = boost::get<QuicPacket>(optionalDecodedPacket);
  EXPECT_NO_THROW(boost::get<RegularQuicPacket>(decodedPacket));
  auto retryPacket = boost::get<RegularQuicPacket>(decodedPacket);

  auto headerOut = boost::get<LongHeader>(retryPacket.header);

  EXPECT_EQ(*headerOut.getOriginalDstConnId(), getTestConnectionId(2));
  EXPECT_EQ(headerOut.getVersion(), QuicVersion::MVFST);
  EXPECT_EQ(headerOut.getSourceConnId(), getTestConnectionId(0));
  EXPECT_EQ(headerOut.getDestinationConnId(), getTestConnectionId(1));

  folly::IOBufEqualTo eq;
  auto expectedBuf = folly::IOBuf::copyBuffer("454358");
  EXPECT_TRUE(eq(*headerOut.getToken(), *expectedBuf));
}

TEST_F(QuicPacketBuilderTest, TooManyVersions) {
  std::vector<QuicVersion> versions;
  for (size_t i = 0; i < 1000; i++) {
    versions.push_back(static_cast<QuicVersion>(i));
  }
  auto srcConnId = getTestConnectionId(0), destConnId = getTestConnectionId(1);
  size_t expectedVersionsToWrite =
      (kDefaultUDPSendPacketLen - kVersionNegotiationHeaderSize) /
      sizeof(QuicVersion);
  std::vector<QuicVersion> expectedWrittenVersions;
  for (size_t i = 0; i < expectedVersionsToWrite; i++) {
    expectedWrittenVersions.push_back(static_cast<QuicVersion>(i));
  }
  VersionNegotiationPacketBuilder builder(srcConnId, destConnId, versions);
  EXPECT_LE(builder.remainingSpaceInPkt(), sizeof(QuicVersion));
  EXPECT_TRUE(builder.canBuildPacket());
  auto builtOut = std::move(builder).buildPacket();
  auto resultVersionNegotiationPacket = builtOut.first;
  auto resultBuf = std::move(builtOut.second);
  EXPECT_EQ(
      expectedVersionsToWrite, resultVersionNegotiationPacket.versions.size());
  EXPECT_EQ(resultVersionNegotiationPacket.versions, expectedWrittenVersions);
  EXPECT_EQ(resultVersionNegotiationPacket.sourceConnectionId, srcConnId);
  EXPECT_EQ(resultVersionNegotiationPacket.destinationConnectionId, destConnId);

  AckStates ackStates;
  auto packetQueue = bufToQueue(std::move(resultBuf));
  auto decodedPacket = boost::get<VersionNegotiationPacket>(
      boost::get<QuicPacket>(makeCodec(destConnId, QuicNodeType::Client)
                                 ->parsePacket(packetQueue, ackStates)));
  EXPECT_EQ(decodedPacket.destinationConnectionId, destConnId);
  EXPECT_EQ(decodedPacket.sourceConnectionId, srcConnId);
  EXPECT_EQ(decodedPacket.versions, expectedWrittenVersions);
}

TEST_F(QuicPacketBuilderTest, LongHeaderRegularPacket) {
  ConnectionId clientConnId = getTestConnectionId(),
               serverConnId = ConnectionId({1, 3, 5, 7});
  PacketNum pktNum = 444;
  QuicVersion ver = QuicVersion::QUIC_DRAFT;
  // create a server cleartext write codec.
  QuicFizzFactory fizzFactory;
  auto cleartextAead = getClientInitialCipher(&fizzFactory, serverConnId, ver);
  auto headerCipher =
      makeClientInitialHeaderCipher(&fizzFactory, serverConnId, ver);

  auto resultRegularPacket = createInitialCryptoPacket(
      serverConnId,
      clientConnId,
      pktNum,
      ver,
      *folly::IOBuf::copyBuffer("CHLO"),
      *cleartextAead,
      0);
  auto resultBuf = packetToBufCleartext(
      resultRegularPacket, *cleartextAead, *headerCipher, pktNum);
  auto& resultHeader = resultRegularPacket.packet.header;
  EXPECT_NO_THROW(boost::get<LongHeader>(resultHeader));
  auto& resultLongHeader = boost::get<LongHeader>(resultHeader);
  EXPECT_EQ(LongHeader::Types::Initial, resultLongHeader.getHeaderType());
  EXPECT_EQ(serverConnId, resultLongHeader.getSourceConnId());
  EXPECT_EQ(pktNum, resultLongHeader.getPacketSequenceNum());
  EXPECT_EQ(ver, resultLongHeader.getVersion());

  AckStates ackStates;
  auto packetQueue = bufToQueue(std::move(resultBuf));
  auto optionalDecodedPacket = makeCodec(serverConnId, QuicNodeType::Server)
                                   ->parsePacket(packetQueue, ackStates);
  auto decodedPacket = boost::get<QuicPacket>(optionalDecodedPacket);
  EXPECT_NO_THROW(boost::get<RegularQuicPacket>(decodedPacket));
  auto decodedRegularPacket = boost::get<RegularQuicPacket>(decodedPacket);
  auto& decodedHeader = boost::get<LongHeader>(decodedRegularPacket.header);
  EXPECT_EQ(LongHeader::Types::Initial, decodedHeader.getHeaderType());
  EXPECT_EQ(clientConnId, decodedHeader.getDestinationConnId());
  EXPECT_EQ(pktNum, decodedHeader.getPacketSequenceNum());
  EXPECT_EQ(ver, decodedHeader.getVersion());
}

TEST_F(QuicPacketBuilderTest, ShortHeaderRegularPacket) {
  auto connId = getTestConnectionId();
  PacketNum pktNum = 222;

  PacketNum largestAckedPacketNum = 0;
  auto encodedPacketNum = encodePacketNumber(pktNum, largestAckedPacketNum);
  RegularQuicPacketBuilder builder(
      kDefaultUDPSendPacketLen,
      PacketHeader(ShortHeader(ProtectionType::KeyPhaseZero, connId, pktNum)),
      largestAckedPacketNum);

  // write out at least one frame
  writeFrame(PaddingFrame(), builder);
  EXPECT_TRUE(builder.canBuildPacket());
  auto builtOut = std::move(builder).buildPacket();
  auto resultRegularPacket = builtOut.packet;

  size_t expectedOutputSize =
      sizeof(Sample) + kMaxPacketNumEncodingSize - encodedPacketNum.length;
  // We wrote less than sample bytes into the packet, so we'll pad it to sample
  EXPECT_EQ(builtOut.body->computeChainDataLength(), expectedOutputSize);
  auto resultBuf = packetToBuf(builtOut);

  auto resultShortHeader = boost::get<ShortHeader>(resultRegularPacket.header);
  EXPECT_EQ(
      ProtectionType::KeyPhaseZero, resultShortHeader.getProtectionType());
  EXPECT_EQ(connId, resultShortHeader.getConnectionId());
  EXPECT_EQ(pktNum, resultShortHeader.getPacketSequenceNum());

  // TODO: change this when we start encoding packet numbers.
  AckStates ackStates;
  auto packetQueue = bufToQueue(std::move(resultBuf));
  auto parsedPacket =
      makeCodec(
          connId, QuicNodeType::Client, nullptr, quic::test::createNoOpAead())
          ->parsePacket(packetQueue, ackStates);
  auto decodedPacket = boost::get<QuicPacket>(parsedPacket);
  auto decodedRegularPacket = boost::get<RegularQuicPacket>(decodedPacket);
  auto decodedHeader = boost::get<ShortHeader>(decodedRegularPacket.header);
  EXPECT_EQ(ProtectionType::KeyPhaseZero, decodedHeader.getProtectionType());
  EXPECT_EQ(connId, decodedHeader.getConnectionId());
  EXPECT_EQ(pktNum, decodedHeader.getPacketSequenceNum());
}

TEST_F(QuicPacketBuilderTest, ShortHeaderWithNoFrames) {
  auto connId = getTestConnectionId();
  PacketNum pktNum = 222;

  // We expect that the builder will not add new frames to a packet which has no
  // frames already and will be too small to parse.
  RegularQuicPacketBuilder builder(
      kDefaultUDPSendPacketLen,
      PacketHeader(ShortHeader(ProtectionType::KeyPhaseZero, connId, pktNum)),
      0 /* largestAcked */);
  EXPECT_TRUE(builder.canBuildPacket());
  auto builtOut = std::move(builder).buildPacket();
  auto resultRegularPacket = builtOut.packet;
  auto resultBuf = packetToBuf(builtOut);

  EXPECT_EQ(resultRegularPacket.frames.size(), 0);
  AckStates ackStates;
  auto packetQueue = bufToQueue(std::move(resultBuf));
  auto parsedPacket =
      makeCodec(
          connId, QuicNodeType::Client, nullptr, quic::test::createNoOpAead())
          ->parsePacket(packetQueue, ackStates);
  auto decodedPacket = boost::get<QuicPacket>(&parsedPacket);
  EXPECT_EQ(decodedPacket, nullptr);
}

TEST_F(QuicPacketBuilderTest, TestPaddingAccountsForCipherOverhead) {
  auto connId = getTestConnectionId();
  PacketNum pktNum = 222;
  PacketNum largestAckedPacketNum = 0;

  auto encodedPacketNum = encodePacketNumber(pktNum, largestAckedPacketNum);

  size_t cipherOverhead = 2;
  RegularQuicPacketBuilder builder(
      kDefaultUDPSendPacketLen,
      PacketHeader(ShortHeader(ProtectionType::KeyPhaseZero, connId, pktNum)),
      largestAckedPacketNum);
  builder.setCipherOverhead(cipherOverhead);
  EXPECT_TRUE(builder.canBuildPacket());
  writeFrame(PaddingFrame(), builder);
  auto builtOut = std::move(builder).buildPacket();
  auto resultRegularPacket = builtOut.packet;
  // We should have padded the remaining bytes with Padding frames.
  size_t expectedOutputSize =
      sizeof(Sample) + kMaxPacketNumEncodingSize - encodedPacketNum.length;
  EXPECT_EQ(
      resultRegularPacket.frames.size(), expectedOutputSize - cipherOverhead);
  EXPECT_EQ(
      builtOut.body->computeChainDataLength(),
      expectedOutputSize - cipherOverhead);
}

TEST_F(QuicPacketBuilderTest, TestPaddingRespectsRemainingBytes) {
  auto connId = getTestConnectionId();
  PacketNum pktNum = 222;
  PacketNum largestAckedPacketNum = 0;

  size_t totalPacketSize = 20;
  RegularQuicPacketBuilder builder(
      totalPacketSize,
      PacketHeader(ShortHeader(ProtectionType::KeyPhaseZero, connId, pktNum)),
      largestAckedPacketNum);
  EXPECT_TRUE(builder.canBuildPacket());
  writeFrame(PaddingFrame(), builder);
  auto builtOut = std::move(builder).buildPacket();
  auto resultRegularPacket = builtOut.packet;

  size_t headerSize = 13;
  // We should have padded the remaining bytes with Padding frames.
  EXPECT_EQ(resultRegularPacket.frames.size(), totalPacketSize - headerSize);
  EXPECT_EQ(
      builtOut.body->computeChainDataLength(), totalPacketSize - headerSize);
}

TEST_F(QuicPacketBuilderTest, PacketBuilderWrapper) {
  MockQuicPacketBuilder builder;
  EXPECT_CALL(builder, remainingSpaceInPkt()).WillRepeatedly(Return(500));
  PacketBuilderWrapper wrapper(builder, 400);

  EXPECT_EQ(400, wrapper.remainingSpaceInPkt());

  EXPECT_CALL(builder, remainingSpaceInPkt()).WillRepeatedly(Return(50));
  EXPECT_EQ(0, wrapper.remainingSpaceInPkt());
}