KeySchedulerTest.cpp

Go to the documentation of this file.

/*
 *  Copyright (c) 2018-present, Facebook, Inc.
 *  All rights reserved.
 *
 *  This source code is licensed under the BSD-style license found in the
 *  LICENSE file in the root directory of this source tree.
 */

#include <gtest/gtest.h>

#include <fizz/protocol/KeyScheduler.h>

#include <fizz/crypto/test/Mocks.h>

using namespace folly;
using namespace testing;

namespace fizz {
namespace test {

class KeySchedulerTest : public testing::Test {
 public:
  void SetUp() override {
    auto kd = std::make_unique<MockKeyDerivation>();
    kd_ = kd.get();
    ON_CALL(*kd_, hashLength()).WillByDefault(Return(4));
    ON_CALL(*kd_, _expandLabel(_, _, _, _))
        .WillByDefault(InvokeWithoutArgs([]() { return IOBuf::create(0); }));
    ks_ = std::make_unique<KeyScheduler>(std::move(kd));
  }

 protected:
  StringPiece transcript_{"hash"};
  MockKeyDerivation* kd_;
  std::unique_ptr<KeyScheduler> ks_;
};

TEST_F(KeySchedulerTest, TestEarly) {
  StringPiece psk{"psk"};
  EXPECT_CALL(*kd_, hkdfExtract(_, _));
  ks_->deriveEarlySecret(psk);
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(4);
  ks_->getSecret(EarlySecrets::ExternalPskBinder, transcript_);
  ks_->getSecret(EarlySecrets::ResumptionPskBinder, transcript_);
  ks_->getSecret(EarlySecrets::ResumptionPskBinder, transcript_);
  ks_->getSecret(EarlySecrets::EarlyExporter, transcript_);

  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(1);
  EXPECT_CALL(*kd_, hkdfExtract(_, _));
  ks_->deriveHandshakeSecret();
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->getSecret(HandshakeSecrets::ClientHandshakeTraffic, transcript_);
  ks_->getSecret(HandshakeSecrets::ServerHandshakeTraffic, transcript_);

  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(1);
  EXPECT_CALL(*kd_, hkdfExtract(_, _));
  ks_->deriveMasterSecret();
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->getSecret(MasterSecrets::ExporterMaster, transcript_);
  ks_->getSecret(MasterSecrets::ResumptionMaster, transcript_);

  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->deriveAppTrafficSecrets(transcript_);
  ks_->getSecret(AppTrafficSecrets::ClientAppTraffic);
  ks_->getSecret(AppTrafficSecrets::ServerAppTraffic);
}

TEST_F(KeySchedulerTest, TestEarlyEcdhe) {
  StringPiece psk{"psk"};
  EXPECT_CALL(*kd_, hkdfExtract(_, _));
  ks_->deriveEarlySecret(psk);
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(4);
  ks_->getSecret(EarlySecrets::ExternalPskBinder, transcript_);
  ks_->getSecret(EarlySecrets::ResumptionPskBinder, transcript_);
  ks_->getSecret(EarlySecrets::ResumptionPskBinder, transcript_);
  ks_->getSecret(EarlySecrets::EarlyExporter, transcript_);

  StringPiece ecdhe{"ecdhe"};
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(1);
  EXPECT_CALL(*kd_, hkdfExtract(_, _));
  ks_->deriveHandshakeSecret(ecdhe);
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->getSecret(HandshakeSecrets::ClientHandshakeTraffic, transcript_);
  ks_->getSecret(HandshakeSecrets::ServerHandshakeTraffic, transcript_);

  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(1);
  EXPECT_CALL(*kd_, hkdfExtract(_, _));
  ks_->deriveMasterSecret();
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->getSecret(MasterSecrets::ExporterMaster, transcript_);
  ks_->getSecret(MasterSecrets::ResumptionMaster, transcript_);

  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->deriveAppTrafficSecrets(transcript_);
  ks_->getSecret(AppTrafficSecrets::ClientAppTraffic);
  ks_->getSecret(AppTrafficSecrets::ServerAppTraffic);
}

TEST_F(KeySchedulerTest, TestNoEarly) {
  StringPiece ecdhe{"ecdhe"};
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(1);
  EXPECT_CALL(*kd_, hkdfExtract(_, _)).Times(2);
  ks_->deriveHandshakeSecret(ecdhe);
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->getSecret(HandshakeSecrets::ClientHandshakeTraffic, transcript_);
  ks_->getSecret(HandshakeSecrets::ServerHandshakeTraffic, transcript_);

  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(1);
  EXPECT_CALL(*kd_, hkdfExtract(_, _));
  ks_->deriveMasterSecret();
  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->getSecret(MasterSecrets::ExporterMaster, transcript_);
  ks_->getSecret(MasterSecrets::ResumptionMaster, transcript_);

  EXPECT_CALL(*kd_, deriveSecret(_, _, _)).Times(2);
  ks_->deriveAppTrafficSecrets(transcript_);
  ks_->getSecret(AppTrafficSecrets::ClientAppTraffic);
  ks_->getSecret(AppTrafficSecrets::ServerAppTraffic);
}

TEST_F(KeySchedulerTest, TestKeyUpdate) {
  StringPiece ecdhe{"ecdhe"};
  ks_->deriveHandshakeSecret(ecdhe);
  ks_->deriveMasterSecret();
  ks_->deriveAppTrafficSecrets(transcript_);

  EXPECT_CALL(*kd_, _expandLabel(_, _, _, _));
  EXPECT_EQ(ks_->clientKeyUpdate(), 1);
  EXPECT_CALL(*kd_, _expandLabel(_, _, _, _));
  EXPECT_EQ(ks_->clientKeyUpdate(), 2);

  EXPECT_CALL(*kd_, _expandLabel(_, _, _, _));
  EXPECT_EQ(ks_->serverKeyUpdate(), 1);
  EXPECT_CALL(*kd_, _expandLabel(_, _, _, _));
  EXPECT_EQ(ks_->serverKeyUpdate(), 2);
}

TEST_F(KeySchedulerTest, TestTrafficKey) {
  EXPECT_CALL(*kd_, _expandLabel(_, _, _, _)).Times(2);
  StringPiece trafficSecret{"secret"};
  ks_->getTrafficKey(trafficSecret, 10, 10);
}
} // namespace test
} // namespace fizz