nearby/sharing/share_session.cc

// Copyright 2022 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 "sharing/share_session.h"

#include <cstdint>
#include <cstdlib>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <vector>

#include "absl/functional/any_invocable.h"
#include "absl/functional/bind_front.h"
#include "absl/strings/str_format.h"
#include "internal/platform/clock.h"
#include "internal/platform/task_runner.h"
#include "sharing/analytics/analytics_recorder.h"
#include "sharing/certificates/nearby_share_certificate_manager.h"
#include "sharing/constants.h"
#include "sharing/incoming_frames_reader.h"
#include "sharing/internal/public/logging.h"
#include "sharing/nearby_connection.h"
#include "sharing/nearby_connections_manager.h"
#include "sharing/nearby_connections_types.h"
#include "sharing/paired_key_verification_runner.h"
#include "sharing/payload_tracker.h"
#include "sharing/proto/wire_format.pb.h"
#include "sharing/share_target.h"
#include "sharing/transfer_metadata.h"
#include "sharing/transfer_metadata_builder.h"

namespace nearby::sharing {
namespace {

using ::location::nearby::proto::sharing::AttachmentTransmissionStatus;
using ::location::nearby::proto::sharing::OSType;
using ::nearby::sharing::service::proto::ConnectionResponseFrame;
using ::nearby::sharing::service::proto::Frame;
using ::nearby::sharing::service::proto::V1Frame;

// Used to hash a token into a 4 digit string.
constexpr int kHashModulo = 9973;
constexpr int kHashBaseMultiplier = 31;

// Converts authentication token to four bytes digit string.
std::string TokenToFourDigitString(const std::vector<uint8_t>& bytes) {
  int hash = 0;
  int multiplier = 1;
  for (uint8_t byte : bytes) {
    // Java bytes are signed two's complement so cast to use the correct sign.
    hash = (hash + static_cast<int8_t>(byte) * multiplier) % kHashModulo;
    multiplier = (multiplier * kHashBaseMultiplier) % kHashModulo;
  }

  return absl::StrFormat("%04d", std::abs(hash));
}

}  // namespace

/* static */
// Only used for final statuses.
AttachmentTransmissionStatus ShareSession::ConvertToTransmissionStatus(
    TransferMetadata::Status status) {
  switch (status) {
    case TransferMetadata::Status::kComplete:
      return AttachmentTransmissionStatus::
          COMPLETE_ATTACHMENT_TRANSMISSION_STATUS;
    case TransferMetadata::Status::kFailed:
      return AttachmentTransmissionStatus::
          FAILED_ATTACHMENT_TRANSMISSION_STATUS;
    case TransferMetadata::Status::kRejected:
      return AttachmentTransmissionStatus::
          REJECTED_ATTACHMENT_TRANSMISSION_STATUS;
    case TransferMetadata::Status::kCancelled:
      return AttachmentTransmissionStatus::
          CANCELED_ATTACHMENT_TRANSMISSION_STATUS;
    case TransferMetadata::Status::kTimedOut:
      return AttachmentTransmissionStatus::
          TIMED_OUT_ATTACHMENT_TRANSMISSION_STATUS;
    case TransferMetadata::Status::kMediaUnavailable:
      return AttachmentTransmissionStatus::MEDIA_UNAVAILABLE_ATTACHMENT;
    case TransferMetadata::Status::kNotEnoughSpace:
      return AttachmentTransmissionStatus::
          NOT_ENOUGH_SPACE_ATTACHMENT_TRANSMISSION_STATUS;
    case TransferMetadata::Status::kUnsupportedAttachmentType:
      return AttachmentTransmissionStatus::
          UNSUPPORTED_ATTACHMENT_TYPE_ATTACHMENT_TRANSMISSION_STATUS;
    case TransferMetadata::Status::kDeviceAuthenticationFailed:
      return AttachmentTransmissionStatus::FAILED_PAIRED_KEYHANDSHAKE;
    case TransferMetadata::Status::kIncompletePayloads:
      return AttachmentTransmissionStatus::FAILED_NO_PAYLOAD;
    default:
      return AttachmentTransmissionStatus::
          UNKNOWN_ATTACHMENT_TRANSMISSION_STATUS;
  }
}

ShareSession::ShareSession(Clock* clock, TaskRunner& service_thread,
                           NearbyConnectionsManager* connections_manager,
                           analytics::AnalyticsRecorder& analytics_recorder,
                           std::string endpoint_id,
                           const ShareTarget& share_target)
    : clock_(*clock),
      service_thread_(service_thread),
      connections_manager_(*connections_manager),
      analytics_recorder_(analytics_recorder),
      endpoint_id_(std::move(endpoint_id)),
      self_share_(share_target.for_self_share),
      share_target_(share_target) {}

ShareSession::ShareSession(ShareSession&&) = default;

ShareSession::~ShareSession() = default;

void ShareSession::UpdateTransferMetadata(
    const TransferMetadata& transfer_metadata) {
  if (got_final_status_) {
    // If we already got a final status, we can ignore any subsequent final
    // statuses caused by race conditions.
    VLOG(1) << __func__ << ": Transfer update decorator swallowed "
            << "status update because a final status was already received: "
            << share_target_.id << ": "
            << TransferMetadata::StatusToString(transfer_metadata.status());
    return;
  }
  got_final_status_ = transfer_metadata.is_final_status();
  InvokeTransferUpdateCallback(transfer_metadata);
}

std::weak_ptr<NearbyConnectionsManager::PayloadStatusListener>
ShareSession::payload_tracker() const {
  if (!payload_tracker_) {
    return std::weak_ptr<NearbyConnectionsManager::PayloadStatusListener>();
  }
  return payload_tracker_->GetWeakPtr();
}

void ShareSession::set_disconnect_status(
    TransferMetadata::Status disconnect_status) {
  disconnect_status_ = disconnect_status;
  if (disconnect_status_ != TransferMetadata::Status::kUnknown &&
      !TransferMetadata::IsFinalStatus(disconnect_status_)) {
    LOG(DFATAL) << "Disconnect status is not final: "
                << static_cast<int>(disconnect_status_);
  }
}

void ShareSession::SetConnection(NearbyConnection* connection) {
  connection_ = connection;
  frames_reader_ =
      std::make_shared<IncomingFramesReader>(service_thread_, connection_);
}

void ShareSession::Disconnect() {
  // Do not clear connection_ here.  It will be cleared in OnDisconnect().
  connections_manager_.Disconnect(endpoint_id_);
}

void ShareSession::Abort(TransferMetadata::Status status) {
  DCHECK(TransferMetadata::IsFinalStatus(status))
      << "Abort should only be called with a final status";

  // First invoke the appropriate transfer callback with the final
  // |status|.
  UpdateTransferMetadata(TransferMetadataBuilder()
                             .set_usage(session_usage())
                             .set_status(status)
                             .build());
  Disconnect();
}

void ShareSession::RunPairedKeyVerification(
    OSType os_type,
    const PairedKeyVerificationRunner::VisibilityHistory& visibility_history,
    NearbyShareCertificateManager* certificate_manager,
    std::function<void(PairedKeyVerificationRunner::PairedKeyVerificationResult,
                       OSType)>
        callback) {
  std::optional<std::vector<uint8_t>> token =
      connections_manager_.GetRawAuthenticationToken(endpoint_id());
  if (!token.has_value()) {
    Abort(TransferMetadata::Status::kDeviceAuthenticationFailed);
    return;
  }
  token_ = TokenToFourDigitString(*token);

  key_verification_runner_ = std::make_shared<PairedKeyVerificationRunner>(
      &clock_, os_type, IsIncoming(), visibility_history, *token,
      absl::bind_front(&ShareSession::WriteFrame, this),
      certificate_, certificate_manager, frames_reader_.get(),
      kReadFramesTimeout);
  key_verification_runner_->Run(std::move(callback));
}

bool ShareSession::ProcessKeyVerificationResult(
    PairedKeyVerificationRunner::PairedKeyVerificationResult result,
    OSType share_target_os_type) {
  os_type_ = share_target_os_type;

  switch (result) {
    case PairedKeyVerificationRunner::PairedKeyVerificationResult::kFail:
      LOG(WARNING) << __func__ << ": Paired key handshake failed for target "
                   << share_target().id << ". Disconnecting.";
      return false;

    case PairedKeyVerificationRunner::PairedKeyVerificationResult::kSuccess:
      VLOG(1) << __func__ << ": Paired key handshake succeeded for target - "
              << share_target().id;
      // If verification succeeds, this either means that the target is a
      // self-share or a mutual contact. In either case, we should clear the
      // token.
      token_.resize(0);
      break;

    case PairedKeyVerificationRunner::PairedKeyVerificationResult::kUnable:
      VLOG(1) << __func__
              << ": Unable to verify paired key encryption when "
                 "receiving connection from target - "
              << share_target().id;
      // If we are unable to verify the paired key, we should clear the self
      // share flag.
      self_share_ = false;
      break;
  }
  return true;
}

void ShareSession::OnDisconnect() {
  OnConnectionDisconnected();
  if (disconnect_status_ != TransferMetadata::Status::kUnknown) {
    UpdateTransferMetadata(
        TransferMetadataBuilder()
            .set_usage(session_usage())
            .set_status(disconnect_status_)
            .build());
  }
  connection_ = nullptr;
}

void ShareSession::SetAttachmentPayloadId(int64_t attachment_id,
                                          int64_t payload_id) {
  attachment_payload_map_[attachment_id] = payload_id;
}

bool ShareSession::CancelPayloads() {
  if (is_cancelled_) {
    LOG(INFO) << __func__ << ": Share session is already cancelled.";
    return false;
  }
  for (const auto& [attachment_id, payload_id] : attachment_payload_map_) {
    connections_manager_.Cancel(payload_id);
  }
  is_cancelled_ = true;
  return true;
}

void ShareSession::WriteFrame(const Frame& frame) {
  if (connection_ == nullptr) {
    LOG(WARNING) << __func__
                 << ": Failed to write response frame, due to "
                    "no connection established.";
    return;
  }
  std::vector<uint8_t> data(frame.ByteSizeLong());
  frame.SerializeToArray(data.data(), frame.ByteSizeLong());

  connections_manager_.Send(
      endpoint_id_, std::make_unique<Payload>(std::move(data)),
      /*listener=*/
      std::weak_ptr<NearbyConnectionsManager::PayloadStatusListener>());
}

void ShareSession::WriteResponseFrame(
    ConnectionResponseFrame::Status response_status) {
  Frame frame;
  frame.set_version(Frame::V1);
  V1Frame* v1_frame = frame.mutable_v1();
  v1_frame->set_type(V1Frame::RESPONSE);
  v1_frame->mutable_connection_response()->set_status(response_status);

  WriteFrame(frame);
}

void ShareSession::WriteCancelFrame() {
  LOG(INFO) << __func__ << ": Writing cancel frame.";

  Frame frame;
  frame.set_version(Frame::V1);
  V1Frame* v1_frame = frame.mutable_v1();
  v1_frame->set_type(V1Frame::CANCEL);

  WriteFrame(frame);
}

void ShareSession::InitializePayloadTracker(
    absl::AnyInvocable<void()> payload_transfer_updates_callback) {
  auto payload_updates_queue =
      std::make_unique<PayloadTracker::PayloadUpdateQueue>(&service_thread());
  payload_updates_queue_ = payload_updates_queue.get();
  payload_tracker_ = std::make_shared<PayloadTracker>(
      &clock_, share_target_.id, attachment_container_, attachment_payload_map_,
      std::move(payload_updates_queue));
  payload_updates_queue_->Start(std::move(payload_transfer_updates_callback));
}

}  // namespace nearby::sharing