nearby/connections/implementation/encryption_runner_test.cc

// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "connections/implementation/encryption_runner.h"

#include <cstddef>
#include <cstdint>
#include <memory>
#include <string>

#include "gtest/gtest.h"
#include "absl/strings/string_view.h"
#include "absl/time/time.h"
#include "connections/implementation/analytics/analytics_recorder.h"
#include "connections/implementation/client_proxy.h"
#include "connections/implementation/endpoint_channel.h"
#include "internal/platform/byte_array.h"
#include "internal/platform/count_down_latch.h"
#include "internal/platform/exception.h"
#include "internal/platform/implementation/system_clock.h"
#include "internal/platform/input_stream.h"
#include "internal/platform/output_stream.h"
#include "internal/platform/pipe.h"
#include "proto/connections_enums.pb.h"
#include "third_party/ukey2/src/main/cpp/include/securegcm/ukey2_handshake.h"

namespace nearby::connections {
namespace {

using ::location::nearby::proto::connections::Medium;
constexpr size_t kChunkSize = 64 * 1024;
constexpr securegcm::UKey2Handshake::HandshakeCipher kCipher =
    securegcm::UKey2Handshake::HandshakeCipher::P256_SHA512;

class FakeEndpointChannel : public EndpointChannel {
 public:
  FakeEndpointChannel(InputStream* in, OutputStream* out)
      : in_(in), out_(out) {}
  ExceptionOr<ByteArray> Read() override {
    read_timestamp_ = SystemClock::ElapsedRealtime();
    return in_ ? in_->Read(kChunkSize) : ExceptionOr<ByteArray>{Exception::kIo};
  }

  Exception Write(absl::string_view data) override {
    write_timestamp_ = SystemClock::ElapsedRealtime();
    return out_ ? out_->Write(data) : Exception{Exception::kIo};
  }
  void Close() override {
    if (in_) in_->Close();
    if (out_) out_->Close();
  }
  void Close(location::nearby::proto::connections::DisconnectionReason reason)
      override {
    Close();
  }
  void Close(location::nearby::proto::connections::DisconnectionReason reason,
             nearby::analytics::SafeDisconnectionResult result) override {
    Close();
  }
  bool IsClosed() const override { return false; }
  location::nearby::proto::connections::ConnectionTechnology GetTechnology()
      const override {
    return location::nearby::proto::connections::ConnectionTechnology::
        CONNECTION_TECHNOLOGY_BLE_GATT;
  }
  location::nearby::proto::connections::ConnectionBand GetBand()
      const override {
    return location::nearby::proto::connections::ConnectionBand::
        CONNECTION_BAND_CELLULAR_BAND_2G;
  }
  int GetFrequency() const override { return 0; }
  int GetTryCount() const override { return 0; }
  std::string GetType() const override { return "fake-channel-type"; }
  std::string GetServiceId() const override { return "fake-service-id"; }
  std::string GetName() const override { return "fake-channel"; }
  Medium GetMedium() const override { return Medium::BLE; }
  int GetMaxTransmitPacketSize() const override { return 512; }
  void EnableEncryption(std::shared_ptr<EncryptionContext> context) override {}
  void DisableEncryption() override {}
  bool IsEncrypted() override { return false; }
  ExceptionOr<ByteArray> TryDecrypt(const ByteArray& data) override {
    return Exception::kFailed;
  }

  bool IsPaused() const override { return false; }
  void Pause() override {}
  void Resume() override {}
  absl::Time GetLastReadTimestamp() const override { return read_timestamp_; }
  absl::Time GetLastWriteTimestamp() const override { return write_timestamp_; }
  uint32_t GetNextKeepAliveSeqNo() const override {
    return next_keep_alive_seq_no_++;
  }
  void SetAnalyticsRecorder(analytics::AnalyticsRecorder* analytics_recorder,
                            const std::string& endpoint_id) override {}
  void SetLocalEndpointId(const std::string& local_endpoint_id) override {
    local_endpoint_id_ = local_endpoint_id;
  }
  std::string GetLocalEndpointId() const override { return local_endpoint_id_; }

 private:
  InputStream* in_ = nullptr;
  OutputStream* out_ = nullptr;
  absl::Time read_timestamp_ = absl::InfinitePast();
  absl::Time write_timestamp_ = absl::InfinitePast();
  mutable uint32_t next_keep_alive_seq_no_ = 0;
  std::string local_endpoint_id_;
};

struct User {
  User(InputStream* reader, OutputStream* writer)
      : channel(std::make_shared<FakeEndpointChannel>(reader, writer)) {}

  std::shared_ptr<FakeEndpointChannel> channel;
  EncryptionRunner crypto;
  ClientProxy client;
};

struct Response {
  Response() : latch(2) {}
  explicit Response(int count) : latch(count) {}
  enum class Status {
    kUnknown = 0,
    kDone = 1,
    kFailed = 2,
  };

  CountDownLatch latch;
  Status server_status = Status::kUnknown;
  Status client_status = Status::kUnknown;
};

TEST(EncryptionRunnerTest, ConstructorDestructorWorks) { EncryptionRunner enc; }

TEST(EncryptionRunnerTest, ReadWrite) {
  auto from_a_to_b = CreatePipe();
  auto from_b_to_a = CreatePipe();
  User user_a(/*reader=*/from_b_to_a.first.get(),
              /*writer=*/from_a_to_b.second.get());
  User user_b(/*reader=*/from_a_to_b.first.get(),
              /*writer=*/from_b_to_a.second.get());
  Response response;

  user_a.crypto.StartServer(
      &user_a.client, "endpoint_id", user_a.channel,
      {
          .on_success_cb =
              [&response](const std::string& endpoint_id,
                          std::unique_ptr<securegcm::UKey2Handshake> ukey2,
                          const std::string& auth_token,
                          const ByteArray& raw_auth_token) {
                response.server_status = Response::Status::kDone;
                response.latch.CountDown();
              },
          .on_failure_cb =
              [&response, &user_a](const std::string& endpoint_id) {
                user_a.channel->Close();
                response.server_status = Response::Status::kFailed;
                response.latch.CountDown();
              },
      });
  user_b.crypto.StartClient(
      &user_b.client, "endpoint_id", user_b.channel,
      {
          .on_success_cb =
              [&response](const std::string& endpoint_id,
                          std::unique_ptr<securegcm::UKey2Handshake> ukey2,
                          const std::string& auth_token,
                          const ByteArray& raw_auth_token) {
                response.client_status = Response::Status::kDone;
                response.latch.CountDown();
              },
          .on_failure_cb =
              [&response, &user_b](const std::string& endpoint_id) {
                user_b.channel->Close();
                response.client_status = Response::Status::kFailed;
                response.latch.CountDown();
              },
      });
  EXPECT_TRUE(response.latch.Await(absl::Milliseconds(5000)).result());
  EXPECT_EQ(response.server_status, Response::Status::kDone);
  EXPECT_EQ(response.client_status, Response::Status::kDone);
}

TEST(EncryptionRunnerTest, ClientWriteFails) {
  auto from_a_to_b = CreatePipe();
  auto from_b_to_a = CreatePipe();
  User user_a(/*reader=*/from_b_to_a.first.get(),
              /*writer=*/from_a_to_b.second.get());
  User user_b(/*reader=*/from_a_to_b.first.get(),
              /*writer=*/from_b_to_a.second.get());
  Response response(1);

  // Close server's input stream, so client can't write to it.
  from_b_to_a.first->Close();

  user_b.crypto.StartClient(
      &user_b.client, "endpoint_id", user_b.channel,
      {
          .on_success_cb =
              [&response](const std::string& endpoint_id,
                          std::unique_ptr<securegcm::UKey2Handshake> ukey2,
                          const std::string& auth_token,
                          const ByteArray& raw_auth_token) {
                response.client_status = Response::Status::kDone;
                response.latch.CountDown();
              },
          .on_failure_cb =
              [&response, &user_a](const std::string& endpoint_id) {
                user_a.channel->Close();
                response.client_status = Response::Status::kFailed;
                response.latch.CountDown();
              },
      });
  EXPECT_TRUE(response.latch.Await(absl::Milliseconds(5000)).result());
  EXPECT_EQ(response.client_status, Response::Status::kFailed);
}

TEST(EncryptionRunnerTest, ServerWriteFails) {
  auto from_a_to_b = CreatePipe();
  auto from_b_to_a = CreatePipe();
  User user_a(/*reader=*/from_b_to_a.first.get(),
              /*writer=*/from_a_to_b.second.get());
  User user_b(/*reader=*/from_a_to_b.first.get(),
              /*writer=*/from_b_to_a.second.get());
  Response response(1);

  // Close client's input stream, so server can't write to it.
  from_a_to_b.first->Close();

  user_a.crypto.StartServer(
      &user_a.client, "endpoint_id", user_a.channel,
      {
          .on_success_cb =
              [&response](const std::string& endpoint_id,
                          std::unique_ptr<securegcm::UKey2Handshake> ukey2,
                          const std::string& auth_token,
                          const ByteArray& raw_auth_token) {
                response.server_status = Response::Status::kDone;
                response.latch.CountDown();
              },
          .on_failure_cb =
              [&response, &user_a](const std::string& endpoint_id) {
                user_a.channel->Close();
                response.server_status = Response::Status::kFailed;
                response.latch.CountDown();
              },
      });
  user_b.crypto.StartClient(
      &user_b.client, "endpoint_id", user_b.channel,
      {
          .on_success_cb = [](const std::string& endpoint_id,
                              std::unique_ptr<securegcm::UKey2Handshake> ukey2,
                              const std::string& auth_token,
                              const ByteArray& raw_auth_token) {},
          .on_failure_cb =
              [&user_b](const std::string& endpoint_id) {
                user_b.channel->Close();
              },
      });
  EXPECT_TRUE(response.latch.Await(absl::Milliseconds(5000)).result());
  EXPECT_EQ(response.server_status, Response::Status::kFailed);
}

TEST(EncryptionRunnerTest, ClientSendsGarbageMessage1) {
  auto from_server_to_client = CreatePipe();
  auto from_client_to_server = CreatePipe();
  User user_a(/*reader=*/from_client_to_server.first.get(),
              /*writer=*/from_server_to_client.second.get());
  Response response(1);

  user_a.crypto.StartServer(
      &user_a.client, "endpoint_id", user_a.channel,
      {
          .on_success_cb =
              [&response](const std::string& endpoint_id,
                          std::unique_ptr<securegcm::UKey2Handshake> ukey2,
                          const std::string& auth_token,
                          const ByteArray& raw_auth_token) {
                response.server_status = Response::Status::kDone;
                response.latch.CountDown();
              },
          .on_failure_cb =
              [&response, &user_a](const std::string& endpoint_id) {
                user_a.channel->Close();
                response.server_status = Response::Status::kFailed;
                response.latch.CountDown();
              },
      });

  // Client writes garbage instead of message 1
  from_client_to_server.second->Write("Garbage");

  EXPECT_TRUE(response.latch.Await(absl::Milliseconds(5000)).result());
  EXPECT_EQ(response.server_status, Response::Status::kFailed);

  // Check if server sent alert message.
  // The alert message should be readable from from_server_to_client.first.
  auto alert = from_server_to_client.first->Read(kChunkSize);
  EXPECT_TRUE(alert.ok());
  EXPECT_FALSE(alert.result().Empty());
}

TEST(EncryptionRunnerTest, ServerSendsGarbageMessage2) {
  auto from_server_to_client = CreatePipe();
  auto from_client_to_server = CreatePipe();
  User user_b(/*reader=*/from_server_to_client.first.get(),
              /*writer=*/from_client_to_server.second.get());
  Response response(1);

  user_b.crypto.StartClient(
      &user_b.client, "endpoint_id", user_b.channel,
      {
          .on_success_cb =
              [&response](const std::string& endpoint_id,
                          std::unique_ptr<securegcm::UKey2Handshake> ukey2,
                          const std::string& auth_token,
                          const ByteArray& raw_auth_token) {
                response.client_status = Response::Status::kDone;
                response.latch.CountDown();
              },
          .on_failure_cb =
              [&response, &user_b](const std::string& endpoint_id) {
                user_b.channel->Close();
                response.client_status = Response::Status::kFailed;
                response.latch.CountDown();
              },
      });

  // Client sends message 1.
  auto client_init = from_client_to_server.first->Read(kChunkSize);
  EXPECT_TRUE(client_init.ok());

  // Server writes garbage instead of message 2.
  from_server_to_client.second->Write("Garbage");

  EXPECT_TRUE(response.latch.Await(absl::Milliseconds(5000)).result());
  EXPECT_EQ(response.client_status, Response::Status::kFailed);

  // Check if client sent alert message.
  auto alert = from_client_to_server.first->Read(kChunkSize);
  EXPECT_TRUE(alert.ok());
  EXPECT_FALSE(alert.result().Empty());
}

TEST(EncryptionRunnerTest, ClientSendsGarbageMessage3) {
  auto from_server_to_client = CreatePipe();
  auto from_client_to_server = CreatePipe();
  User user_a(/*reader=*/from_client_to_server.first.get(),
              /*writer=*/from_server_to_client.second.get());
  User user_b(/*reader=*/from_server_to_client.first.get(),
              /*writer=*/from_client_to_server.second.get());
  Response response(1);

  user_a.crypto.StartServer(
      &user_a.client, "endpoint_id", user_a.channel,
      {
          .on_success_cb =
              [&response](const std::string& endpoint_id,
                          std::unique_ptr<securegcm::UKey2Handshake> ukey2,
                          const std::string& auth_token,
                          const ByteArray& raw_auth_token) {
                response.server_status = Response::Status::kDone;
                response.latch.CountDown();
              },
          .on_failure_cb =
              [&response, &user_a](const std::string& endpoint_id) {
                user_a.channel->Close();
                response.server_status = Response::Status::kFailed;
                response.latch.CountDown();
              },
      });

  // Client starts, sends message 1
  std::unique_ptr<securegcm::UKey2Handshake> client_crypto =
      securegcm::UKey2Handshake::ForInitiator(kCipher);
  std::unique_ptr<std::string> client_init_str =
      client_crypto->GetNextHandshakeMessage();
  from_client_to_server.second->Write(
      ByteArray(*client_init_str).AsStringView());

  // Server reads message 1, sends message 2.
  // Read message 2 from server
  auto server_init = from_server_to_client.first->Read(kChunkSize);
  EXPECT_TRUE(server_init.ok());

  // Client crypto parses message 2.
  client_crypto->ParseHandshakeMessage(
      std::string(server_init.result().data(), server_init.result().size()));

  // Client sends garbage instead of message 3
  from_client_to_server.second->Write("Garbage");

  EXPECT_TRUE(response.latch.Await(absl::Milliseconds(5000)).result());
  EXPECT_EQ(response.server_status, Response::Status::kFailed);

  // Check if server sent alert message.
  // Message 3 doesn't send alert in current UKEY2 implementation.
  auto alert = from_server_to_client.first->Read(kChunkSize);
  EXPECT_TRUE(alert.ok());
  EXPECT_TRUE(alert.result().Empty());
}

}  // namespace
}  // namespace nearby::connections