// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/nearby_sharing/paired_key_verification_runner.h"
#include <stdint.h>
#include <optional>
#include <vector>
#include "base/functional/callback.h"
#include "base/functional/callback_helpers.h"
#include "base/run_loop.h"
#include "base/test/bind.h"
#include "base/time/time.h"
#include "chrome/browser/nearby_sharing/certificates/fake_nearby_share_certificate_manager.h"
#include "chrome/browser/nearby_sharing/certificates/nearby_share_decrypted_public_certificate.h"
#include "chrome/browser/nearby_sharing/certificates/test_util.h"
#include "chrome/browser/nearby_sharing/incoming_frames_reader.h"
#include "chrome/browser/nearby_sharing/share_target.h"
#include "chrome/services/sharing/public/proto/wire_format.pb.h"
#include "chromeos/ash/components/nearby/common/connections_manager/fake_nearby_connection.h"
#include "chromeos/ash/services/nearby/public/cpp/mock_nearby_process_manager.h"
#include "content/public/test/browser_task_environment.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace {
const char kEndpointId[] = "test_endpoint_id";
const std::vector<uint8_t> kAuthToken = {0, 1, 2};
const std::vector<uint8_t> kPrivateCertificateHashAuthToken = {
0x8b, 0xcb, 0xa2, 0xf8, 0xe4, 0x06};
const std::vector<uint8_t> kIncomingConnectionSignedData = {
0x30, 0x45, 0x02, 0x20, 0x4f, 0x83, 0x72, 0xbd, 0x02, 0x70, 0xd9, 0xda,
0x62, 0x83, 0x5d, 0xb2, 0xdc, 0x6e, 0x3f, 0xa6, 0xa8, 0xa1, 0x4f, 0x5f,
0xd3, 0xe3, 0xd9, 0x1a, 0x5d, 0x2d, 0x61, 0xd2, 0x6c, 0xdd, 0x8d, 0xa5,
0x02, 0x21, 0x00, 0xd4, 0xe1, 0x1d, 0x14, 0xcb, 0x58, 0xf7, 0x02, 0xd5,
0xab, 0x48, 0xe2, 0x2f, 0xcb, 0xc0, 0x53, 0x41, 0x06, 0x50, 0x65, 0x95,
0x19, 0xa9, 0x22, 0x92, 0x00, 0x42, 0x01, 0x26, 0x25, 0xcb, 0x8c};
const std::vector<uint8_t> kIncomingConnectionInvalidSignedData = {
0x72, 0xe5, 0x40, 0xa6, 0xdd, 0x1d, 0xfd, 0x44, 0xf2, 0x55, 0xd5, 0x15,
0x61, 0xe1, 0xe6, 0x15, 0x93, 0xa5, 0xf9, 0x94, 0x16, 0xcd, 0x8b, 0x0a,
0xb3, 0xca, 0xe6, 0x10, 0x6d, 0x22, 0x3e, 0x1e, 0x3f, 0x34, 0x23, 0x4f,
0xc2, 0x07, 0xae, 0xcc, 0xb0, 0xb2, 0x5e, 0x26, 0xca, 0x01, 0xd8, 0xe2,
0x3e, 0xc4, 0x54, 0x0b, 0xfd, 0xc4, 0xf1, 0xa7, 0xf5, 0xa8, 0x63, 0x10,
0x46, 0x48, 0xdc, 0x98, 0x0b, 0x8f, 0xc3, 0xee, 0xb4, 0x99, 0xb6};
const base::TimeDelta kTimeout = base::Seconds(1);
class MockIncomingFramesReader : public IncomingFramesReader {
public:
MockIncomingFramesReader(ash::nearby::NearbyProcessManager* process_manager,
NearbyConnection* connection)
: IncomingFramesReader(process_manager, connection) {}
MOCK_METHOD(void,
ReadFrame,
(base::OnceCallback<
void(std::optional<sharing::mojom::V1FramePtr>)> callback),
(override));
MOCK_METHOD(
void,
ReadFrame,
(sharing::mojom::V1Frame::Tag frame_type,
base::OnceCallback<void(std::optional<sharing::mojom::V1FramePtr>)>
callback,
base::TimeDelta timeout),
(override));
};
PairedKeyVerificationRunner::PairedKeyVerificationResult Merge(
PairedKeyVerificationRunner::PairedKeyVerificationResult local_result,
sharing::mojom::PairedKeyResultFrame::Status remote_result) {
if (remote_result == sharing::mojom::PairedKeyResultFrame_Status::kFail ||
local_result ==
PairedKeyVerificationRunner::PairedKeyVerificationResult::kFail) {
return PairedKeyVerificationRunner::PairedKeyVerificationResult::kFail;
}
if (remote_result == sharing::mojom::PairedKeyResultFrame_Status::kSuccess &&
local_result ==
PairedKeyVerificationRunner::PairedKeyVerificationResult::kSuccess) {
return PairedKeyVerificationRunner::PairedKeyVerificationResult::kSuccess;
}
return PairedKeyVerificationRunner::PairedKeyVerificationResult::kUnable;
}
} // namespace
class PairedKeyVerificationRunnerTest : public testing::Test {
public:
enum class ReturnFrameType {
// Return std::nullopt for the frame.
kNull,
// Return an empty frame.
kEmpty,
// Return a valid frame.
kValid,
// Return a valid frame where |signed_data| is invalid, but
// |optional_signed_data| is valid.
kOptionalSignedDataValid,
// Return an invalid frame where both |signed_data| and
// |optional_signed_data| are invalid.
kOptionalSignedDataInvalid,
};
PairedKeyVerificationRunnerTest()
: frames_reader_(&process_manager_, &connection_) {}
void SetUp() override { share_target_.is_incoming = true; }
void RunVerification(bool use_valid_public_certificate,
bool restricted_to_contacts,
PairedKeyVerificationRunner::PairedKeyVerificationResult
expected_result) {
std::optional<NearbyShareDecryptedPublicCertificate> public_certificate =
use_valid_public_certificate
? std::make_optional<NearbyShareDecryptedPublicCertificate>(
GetNearbyShareTestDecryptedPublicCertificate())
: std::nullopt;
PairedKeyVerificationRunner runner(
share_target_, kEndpointId, kAuthToken, &connection_,
std::move(public_certificate), &certificate_manager_,
nearby_share::mojom::Visibility::kAllContacts, restricted_to_contacts,
&frames_reader_, kTimeout);
base::RunLoop run_loop;
runner.Run(base::BindLambdaForTesting(
[&](PairedKeyVerificationRunner::PairedKeyVerificationResult result) {
EXPECT_EQ(expected_result, result);
run_loop.Quit();
}));
run_loop.Run();
}
void SetUpPairedKeyEncryptionFrame(ReturnFrameType frame_type) {
EXPECT_CALL(
frames_reader_,
ReadFrame(
testing::Eq(sharing::mojom::V1Frame::Tag::kPairedKeyEncryption),
testing::_, testing::Eq(kTimeout)))
.WillOnce(testing::WithArg<1>(testing::Invoke(
[frame_type](
base::OnceCallback<void(
std::optional<sharing::mojom::V1FramePtr>)> callback) {
if (frame_type == ReturnFrameType::kNull) {
std::move(callback).Run(std::nullopt);
return;
}
sharing::mojom::V1FramePtr mojo_v1frame;
if (frame_type == ReturnFrameType::kValid) {
mojo_v1frame = sharing::mojom::V1Frame::NewPairedKeyEncryption(
sharing::mojom::PairedKeyEncryptionFrame::New(
kIncomingConnectionSignedData,
kPrivateCertificateHashAuthToken, std::nullopt));
} else if (frame_type ==
ReturnFrameType::kOptionalSignedDataValid) {
mojo_v1frame = sharing::mojom::V1Frame::NewPairedKeyEncryption(
sharing::mojom::PairedKeyEncryptionFrame::New(
kIncomingConnectionInvalidSignedData,
kPrivateCertificateHashAuthToken,
kIncomingConnectionSignedData));
} else if (frame_type ==
ReturnFrameType::kOptionalSignedDataInvalid) {
mojo_v1frame = sharing::mojom::V1Frame::NewPairedKeyEncryption(
sharing::mojom::PairedKeyEncryptionFrame::New(
kIncomingConnectionInvalidSignedData,
kPrivateCertificateHashAuthToken,
kIncomingConnectionInvalidSignedData));
} else {
mojo_v1frame = sharing::mojom::V1Frame::NewPairedKeyEncryption(
sharing::mojom::PairedKeyEncryptionFrame::New());
}
std::move(callback).Run(std::move(mojo_v1frame));
})));
}
void SetUpPairedKeyResultFrame(
ReturnFrameType frame_type,
sharing::mojom::PairedKeyResultFrame::Status status =
sharing::mojom::PairedKeyResultFrame_Status::kUnknown) {
EXPECT_CALL(
frames_reader_,
ReadFrame(testing::Eq(sharing::mojom::V1Frame::Tag::kPairedKeyResult),
testing::_, testing::Eq(kTimeout)))
.WillOnce(testing::WithArg<1>(testing::Invoke(
[=](base::OnceCallback<void(
std::optional<sharing::mojom::V1FramePtr>)> callback) {
if (frame_type == ReturnFrameType::kNull) {
std::move(callback).Run(std::nullopt);
return;
}
sharing::mojom::V1FramePtr mojo_v1frame =
sharing::mojom::V1Frame::NewPairedKeyResult(
sharing::mojom::PairedKeyResultFrame::New(status));
std::move(callback).Run(std::move(mojo_v1frame));
})));
}
sharing::nearby::Frame GetWrittenFrame() {
std::vector<uint8_t> data = connection_.GetWrittenData();
sharing::nearby::Frame frame;
frame.ParseFromArray(data.data(), data.size());
return frame;
}
void ExpectPairedKeyEncryptionFrameSent() {
sharing::nearby::Frame frame = GetWrittenFrame();
ASSERT_TRUE(frame.has_v1());
ASSERT_TRUE(frame.v1().has_paired_key_encryption());
}
void ExpectCertificateInfoSent() {
// TODO - Uncomment when crbug.com/1114765 is resolved.
// sharing::nearby::Frame frame = GetWrittenFrame();
// ASSERT_TRUE(frame.has_v1());
// ASSERT_TRUE(frame.v1().has_certificate_info());
}
void ExpectPairedKeyResultFrameSent(
sharing::nearby::PairedKeyResultFrame::Status status) {
sharing::nearby::Frame frame = GetWrittenFrame();
ASSERT_TRUE(frame.has_v1());
ASSERT_TRUE(frame.v1().has_paired_key_result());
EXPECT_EQ(status, frame.v1().paired_key_result().status());
}
protected:
content::BrowserTaskEnvironment task_environment_;
FakeNearbyConnection connection_;
FakeNearbyShareCertificateManager certificate_manager_;
testing::NiceMock<ash::nearby::MockNearbyProcessManager> process_manager_;
testing::NiceMock<MockIncomingFramesReader> frames_reader_;
ShareTarget share_target_;
};
TEST_F(PairedKeyVerificationRunnerTest,
NullCertificate_InvalidPairedKeyEncryptionFrame_RestrictToContacts) {
// Empty key encryption frame fails the certificate verification.
SetUpPairedKeyEncryptionFrame(ReturnFrameType::kEmpty);
RunVerification(
/*use_valid_public_certificate=*/false,
/*restricted_to_contacts=*/true,
/*expected_result=*/
PairedKeyVerificationRunner::PairedKeyVerificationResult::kFail);
ExpectPairedKeyEncryptionFrameSent();
}
TEST_F(PairedKeyVerificationRunnerTest,
ValidPairedKeyEncryptionFrame_ResultFrameTimedOut) {
SetUpPairedKeyEncryptionFrame(ReturnFrameType::kValid);
// Null result frame fails the certificate verification process.
SetUpPairedKeyResultFrame(ReturnFrameType::kNull);
RunVerification(
/*use_valid_public_certificate=*/true,
/*restricted_to_contacts=*/false,
/*expected_result=*/
PairedKeyVerificationRunner::PairedKeyVerificationResult::kFail);
ExpectPairedKeyEncryptionFrameSent();
ExpectPairedKeyResultFrameSent(sharing::nearby::PairedKeyResultFrame::UNABLE);
}
struct TestParameters {
bool is_target_known;
bool is_valid_certificate;
PairedKeyVerificationRunnerTest::ReturnFrameType encryption_frame_type;
PairedKeyVerificationRunner::PairedKeyVerificationResult result;
} kParameters[] = {
{true, true, PairedKeyVerificationRunnerTest::ReturnFrameType::kValid,
PairedKeyVerificationRunner::PairedKeyVerificationResult::kSuccess},
{true, true,
PairedKeyVerificationRunnerTest::ReturnFrameType::kOptionalSignedDataValid,
PairedKeyVerificationRunner::PairedKeyVerificationResult::kSuccess},
{true, true,
PairedKeyVerificationRunnerTest::ReturnFrameType::
kOptionalSignedDataInvalid,
PairedKeyVerificationRunner::PairedKeyVerificationResult::kFail},
{true, true, PairedKeyVerificationRunnerTest::ReturnFrameType::kEmpty,
PairedKeyVerificationRunner::PairedKeyVerificationResult::kFail},
{true, false, PairedKeyVerificationRunnerTest::ReturnFrameType::kValid,
PairedKeyVerificationRunner::PairedKeyVerificationResult::kUnable},
{true, false, PairedKeyVerificationRunnerTest::ReturnFrameType::kEmpty,
PairedKeyVerificationRunner::PairedKeyVerificationResult::kUnable},
{false, true, PairedKeyVerificationRunnerTest::ReturnFrameType::kValid,
PairedKeyVerificationRunner::PairedKeyVerificationResult::kUnable},
};
using KeyVerificationTestParam =
std::tuple<TestParameters, sharing::mojom::PairedKeyResultFrame_Status>;
class ParameterisedPairedKeyVerificationRunnerTest
: public PairedKeyVerificationRunnerTest,
public testing::WithParamInterface<KeyVerificationTestParam> {};
TEST_P(ParameterisedPairedKeyVerificationRunnerTest,
ValidEncryptionFrame_ValidResultFrame) {
const TestParameters& params = std::get<0>(GetParam());
sharing::mojom::PairedKeyResultFrame::Status status = std::get<1>(GetParam());
PairedKeyVerificationRunner::PairedKeyVerificationResult expected_result =
Merge(params.result, status);
share_target_.is_known = params.is_target_known;
SetUpPairedKeyEncryptionFrame(params.encryption_frame_type);
SetUpPairedKeyResultFrame(
PairedKeyVerificationRunnerTest::ReturnFrameType::kValid, status);
RunVerification(
/*use_valid_public_certificate=*/params.is_valid_certificate,
/*restricted_to_contacts=*/false, expected_result);
ExpectPairedKeyEncryptionFrameSent();
if (params.encryption_frame_type ==
PairedKeyVerificationRunnerTest::ReturnFrameType::kValid) {
ExpectCertificateInfoSent();
}
// Check for result frame sent.
if (!params.is_valid_certificate) {
ExpectPairedKeyResultFrameSent(
sharing::nearby::PairedKeyResultFrame::UNABLE);
return;
}
if (params.encryption_frame_type ==
PairedKeyVerificationRunnerTest::ReturnFrameType::kEmpty ||
params.encryption_frame_type ==
PairedKeyVerificationRunnerTest::ReturnFrameType::
kOptionalSignedDataInvalid) {
ExpectPairedKeyResultFrameSent(sharing::nearby::PairedKeyResultFrame::FAIL);
return;
}
if (params.is_target_known) {
ExpectPairedKeyResultFrameSent(
sharing::nearby::PairedKeyResultFrame::SUCCESS);
} else {
ExpectPairedKeyResultFrameSent(
sharing::nearby::PairedKeyResultFrame::UNABLE);
}
}
INSTANTIATE_TEST_SUITE_P(
/*no prefix*/,
ParameterisedPairedKeyVerificationRunnerTest,
testing::Combine(
testing::ValuesIn(kParameters),
testing::Values(sharing::mojom::PairedKeyResultFrame_Status::kUnknown,
sharing::mojom::PairedKeyResultFrame_Status::kSuccess,
sharing::mojom::PairedKeyResultFrame_Status::kFail,
sharing::mojom::PairedKeyResultFrame_Status::kUnable)));