services/network/socket_factory.h

// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SERVICES_NETWORK_SOCKET_FACTORY_H_
#define SERVICES_NETWORK_SOCKET_FACTORY_H_

#include <memory>
#include <vector>

#include "base/component_export.h"
#include "base/memory/raw_ptr.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/receiver_set.h"
#include "mojo/public/cpp/bindings/unique_receiver_set.h"
#include "net/socket/ssl_client_socket.h"
#include "net/socket/tcp_socket.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/network/public/mojom/network_context.mojom.h"
#include "services/network/public/mojom/restricted_udp_socket.mojom.h"
#include "services/network/public/mojom/tcp_socket.mojom.h"
#include "services/network/public/mojom/udp_socket.mojom.h"
#include "services/network/tcp_bound_socket.h"
#include "services/network/tcp_connected_socket.h"
#include "services/network/tcp_server_socket.h"
#include "services/network/tls_socket_factory.h"

#if BUILDFLAG(IS_WIN)
#include "services/network/public/mojom/socket_broker.mojom.h"
#endif

namespace net {
class ClientSocketFactory;
class NetLog;
}  // namespace net

namespace network {

class SimpleHostResolver;

// Helper class that handles socket requests. It takes care of destroying
// socket implementation instances when mojo  pipes are broken.
class COMPONENT_EXPORT(NETWORK_SERVICE) SocketFactory
    : public TCPServerSocket::Delegate {
 public:
  // Constructs a SocketFactory. If |net_log| is non-null, it is used to
  // log NetLog events when logging is enabled. |net_log| must outlive |this|.
  SocketFactory(net::NetLog* net_log,
                net::URLRequestContext* url_request_context);

  SocketFactory(const SocketFactory&) = delete;
  SocketFactory& operator=(const SocketFactory&) = delete;

  virtual ~SocketFactory();

  // These all correspond to the NetworkContext methods of the same name.
  void CreateUDPSocket(mojo::PendingReceiver<mojom::UDPSocket> receiver,
                       mojo::PendingRemote<mojom::UDPSocketListener> listener);
  void CreateRestrictedUDPSocket(
      const net::IPEndPoint& addr,
      mojom::RestrictedUDPSocketMode mode,
      const net::MutableNetworkTrafficAnnotationTag& traffic_annotation,
      mojom::RestrictedUDPSocketParamsPtr params,
      mojo::PendingReceiver<mojom::RestrictedUDPSocket> receiver,
      mojo::PendingRemote<mojom::UDPSocketListener> listener,
      std::unique_ptr<SimpleHostResolver> resolver,
      mojom::NetworkContext::CreateRestrictedUDPSocketCallback callback);
  void CreateTCPServerSocket(
      const net::IPEndPoint& local_addr,
      mojom::TCPServerSocketOptionsPtr options,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      mojo::PendingReceiver<mojom::TCPServerSocket> receiver,
      mojom::NetworkContext::CreateTCPServerSocketCallback callback);
  void CreateTCPConnectedSocket(
      const std::optional<net::IPEndPoint>& local_addr,
      const net::AddressList& remote_addr_list,
      mojom::TCPConnectedSocketOptionsPtr tcp_connected_socket_options,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      mojo::PendingReceiver<mojom::TCPConnectedSocket> receiver,
      mojo::PendingRemote<mojom::SocketObserver> observer,
      mojom::NetworkContext::CreateTCPConnectedSocketCallback callback);
  void CreateTCPBoundSocket(
      const net::IPEndPoint& local_addr,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      mojo::PendingReceiver<mojom::TCPBoundSocket> receiver,
      mojom::NetworkContext::CreateTCPBoundSocketCallback callback);

  // Destroys the specified BoundSocket object.
  void DestroyBoundSocket(mojo::ReceiverId bound_socket_id);

  // Invoked when a BoundSocket successfully starts listening. Destroys the
  // BoundSocket object, adding a binding for the provided TCPServerSocket in
  // its place.
  void OnBoundSocketListening(
      mojo::ReceiverId bound_socket_id,
      std::unique_ptr<TCPServerSocket> server_socket,
      mojo::PendingReceiver<mojom::TCPServerSocket> server_socket_receiver);

  // Invoked when a BoundSocket successfully establishes a connection. Destroys
  // the BoundSocket object, adding a binding for the provided
  // TCPConnectedSocket in its place.
  void OnBoundSocketConnected(
      mojo::ReceiverId bound_socket_id,
      std::unique_ptr<TCPConnectedSocket> connected_socket,
      mojo::PendingReceiver<mojom::TCPConnectedSocket>
          connected_socket_receiver);

  TLSSocketFactory* tls_socket_factory() { return &tls_socket_factory_; }

#if BUILDFLAG(IS_WIN)
  void BindSocketBroker(
      mojo::PendingRemote<mojom::SocketBroker> pending_remote);
#endif

 private:
  // TCPServerSocket::Delegate implementation:
  void OnAccept(
      std::unique_ptr<TCPConnectedSocket> socket,
      mojo::PendingReceiver<mojom::TCPConnectedSocket> receiver) override;

  void CreateTCPServerSocketHelper(
      std::unique_ptr<TCPServerSocket> socket,
      const net::IPEndPoint& local_addr,
      mojom::TCPServerSocketOptionsPtr options,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      mojo::PendingReceiver<mojom::TCPServerSocket> receiver,
      mojom::NetworkContext::CreateTCPServerSocketCallback callback);

#if BUILDFLAG(IS_WIN)
  void DidCompleteCreate(
      const net::IPEndPoint& local_addr,
      mojom::TCPServerSocketOptionsPtr options,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      mojo::PendingReceiver<mojom::TCPServerSocket> receiver,
      mojom::NetworkContext::CreateTCPServerSocketCallback callback,
      network::TransferableSocket socket,
      int result);
#endif

  const raw_ptr<net::NetLog> net_log_;

  raw_ptr<net::ClientSocketFactory> client_socket_factory_;
  TLSSocketFactory tls_socket_factory_;
  mojo::UniqueReceiverSet<mojom::UDPSocket> udp_socket_receivers_;
  mojo::UniqueReceiverSet<mojom::RestrictedUDPSocket>
      restricted_udp_socket_receivers_;
  mojo::UniqueReceiverSet<mojom::TCPServerSocket> tcp_server_socket_receivers_;
  mojo::UniqueReceiverSet<mojom::TCPConnectedSocket>
      tcp_connected_socket_receiver_;
  mojo::UniqueReceiverSet<mojom::TCPBoundSocket> tcp_bound_socket_receivers_;

#if BUILDFLAG(IS_WIN)
  mojo::Remote<mojom::SocketBroker> socket_broker_;
#endif

  base::WeakPtrFactory<SocketFactory> weak_ptr_factory_{this};
};

}  // namespace network

#endif  // SERVICES_NETWORK_SOCKET_FACTORY_H_