gnunet-service-messenger_tunnel.c

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2020--2025 GNUnet e.V.
 
   GNUnet is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation, either version 3 of the License,
   or (at your option) any later version.
 
   GNUnet is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Affero General Public License for more details.
 
   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
   SPDX-License-Identifier: AGPL3.0-or-later
 */
#include "gnunet-service-messenger_tunnel.h"
 
#include "gnunet-service-messenger_handle.h"
#include "gnunet-service-messenger_message_kind.h"
#include "gnunet-service-messenger_message_recv.h"
#include "gnunet-service-messenger_message_store.h"
#include "gnunet-service-messenger_operation_store.h"
#include "gnunet-service-messenger_operation.h"
#include "gnunet-service-messenger_room.h"
 
#include "gnunet_common.h"
#include "gnunet_messenger_service.h"
#include "messenger_api_util.h"
 
struct GNUNET_MESSENGER_SrvTunnel*
create_tunnel (struct GNUNET_MESSENGER_SrvRoom *room,
               const struct GNUNET_PeerIdentity *door)
{
  struct GNUNET_MESSENGER_SrvTunnel *tunnel;
 
  GNUNET_assert ((room) && (door));
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Create new tunnel: %s\n",
              GNUNET_i2s (door));
 
  tunnel = GNUNET_new (struct GNUNET_MESSENGER_SrvTunnel);
 
  tunnel->room = room;
  tunnel->channel = NULL;
 
  tunnel->peer = GNUNET_PEER_intern (door);
 
  tunnel->messenger_version = 0;
 
  tunnel->peer_message = NULL;
 
  init_message_state (&(tunnel->state));
 
  return tunnel;
}
 
 
void
destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
{
  GNUNET_assert (tunnel);
 
  if (tunnel->channel)
    GNUNET_CADET_channel_destroy (tunnel->channel);
 
  GNUNET_PEER_change_rc (tunnel->peer, -1);
 
  if (tunnel->peer_message)
    GNUNET_free (tunnel->peer_message);
 
  clear_message_state (&(tunnel->state));
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Free tunnel!\n");
 
  GNUNET_free (tunnel);
}
 
 
void
bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
             struct GNUNET_CADET_Channel *channel)
{
  GNUNET_assert (tunnel);
 
  if (tunnel->channel)
    delayed_disconnect_channel (tunnel->channel);
 
  tunnel->channel = channel;
}
 
 
void
callback_tunnel_disconnect (void *cls,
                            const struct GNUNET_CADET_Channel *channel)
{
  struct GNUNET_MESSENGER_SrvTunnel *tunnel;
  struct GNUNET_MESSENGER_SrvRoom *room;
  struct GNUNET_PeerIdentity identity;
 
  tunnel = cls;
 
  if (! tunnel)
    return;
 
  GNUNET_assert (tunnel->room);
 
  room = tunnel->room;
 
  get_tunnel_peer_identity (tunnel, &identity);
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Connection dropped to room (%s) from peer: %s\n",
              GNUNET_h2s (get_srv_room_key (room)), GNUNET_i2s (&identity));
 
  tunnel->channel = NULL;
 
  if (! room->host)
    return;
 
  if ((GNUNET_YES != GNUNET_CONTAINER_multipeermap_remove (room->tunnels,
                                                           &identity,
                                                           tunnel)) ||
      (GNUNET_YES == GNUNET_CONTAINER_multipeermap_contains (room->tunnels,
                                                             &identity)))
    return;
 
  GNUNET_STATISTICS_update (room->service->statistics,
                            "# tunnels connected",
                            -1,
                            GNUNET_NO);
 
  if (GNUNET_YES == contains_list_tunnels (&(room->basement), &identity))
  {
    struct GNUNET_MESSENGER_Message *message;
 
    message = create_message_miss (&identity);
 
    if (! message)
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  "Sending miss message about tunnel failed: %s\n",
                  GNUNET_h2s (&(room->key)));
    else
      send_srv_room_message (room, room->host, message);
  }
 
  if ((0 < GNUNET_CONTAINER_multipeermap_size (room->tunnels)) ||
      (GNUNET_NO == room->service->auto_connecting))
    return;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Search for alternate tunnel for room: %s\n",
              GNUNET_h2s (get_srv_room_key (room)));
 
  {
    struct GNUNET_MESSENGER_ListTunnel *element;
    element = find_list_tunnels_alternate (&(room->basement), &identity);
 
    if (! element)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                  "No alternative tunnel was found!\n");
      return;
    }
 
    GNUNET_PEER_resolve (element->peer, &identity);
  }
 
  enter_srv_room_at (room, room->host, &identity);
}
 
 
static enum GNUNET_GenericReturnValue
verify_tunnel_message (struct GNUNET_MESSENGER_SrvRoom *room,
                       struct GNUNET_MESSENGER_Message *message,
                       struct GNUNET_HashCode *hash)
{
  const struct GNUNET_MESSENGER_Message *previous;
 
  GNUNET_assert ((room) && (message));
 
  if (GNUNET_MESSENGER_KIND_UNKNOWN == message->header.kind)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                "Message error: Kind is unknown! (%d)\n", message->header.kind);
    return GNUNET_SYSERR;
  }
 
  {
    struct GNUNET_MESSENGER_MessageStore *message_store;
 
    message_store = get_srv_room_message_store (room);
 
    previous = get_store_message (
      message_store, &(message->header.previous));
  }
 
  if (! previous)
    goto skip_time_comparison;
 
  {
    struct GNUNET_TIME_Absolute timestamp;
    struct GNUNET_TIME_Absolute last;
 
    timestamp = GNUNET_TIME_absolute_ntoh (message->header.timestamp);
    last = GNUNET_TIME_absolute_ntoh (previous->header.timestamp);
 
    if (GNUNET_TIME_relative_get_zero_ ().rel_value_us !=
        GNUNET_TIME_absolute_get_difference (timestamp, last).rel_value_us)
    {
      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                  "Message warning: Timestamp does not check out!\n");
    }
  }
 
skip_time_comparison:
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Receiving message of kind: %s!\n",
              GNUNET_MESSENGER_name_of_kind (message->header.kind));
 
  return GNUNET_OK;
}
 
 
enum GNUNET_GenericReturnValue
check_tunnel_message (void *cls,
                      const struct GNUNET_MessageHeader *header)
{
  struct GNUNET_MESSENGER_SrvTunnel *tunnel;
  struct GNUNET_MESSENGER_Message message;
  struct GNUNET_HashCode hash;
  uint16_t length;
  const char *buffer;
 
  GNUNET_assert (header);
 
  tunnel = cls;
 
  if (! tunnel)
    return GNUNET_SYSERR;
 
  length = ntohs (header->size) - sizeof(*header);
  buffer = (const char*) &header[1];
 
  if (length < get_message_kind_size (GNUNET_MESSENGER_KIND_UNKNOWN,
                                      GNUNET_YES))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Tunnel error: Message too short! (%d)\n", length);
    return GNUNET_SYSERR;
  }
 
  {
    uint16_t padding;
    padding = 0;
 
    if (GNUNET_YES != decode_message (&message, length, buffer, GNUNET_YES,
                                      &padding))
    {
      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                  "Tunnel error: Decoding failed!\n");
      return GNUNET_SYSERR;
    }
 
    hash_message (&message, length - padding, buffer, &hash);
  }
 
  return verify_tunnel_message (tunnel->room, &message, &hash);
}
 
 
extern enum GNUNET_GenericReturnValue
update_room_message (struct GNUNET_MESSENGER_SrvRoom *room,
                     struct GNUNET_MESSENGER_Message *message,
                     const struct GNUNET_HashCode *hash);
 
extern void
callback_room_handle_message (struct GNUNET_MESSENGER_SrvRoom *room,
                              const struct GNUNET_MESSENGER_Message *message,
                              const struct GNUNET_HashCode *hash);
 
static void
update_tunnel_last_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
                            const struct GNUNET_HashCode *hash)
{
  struct GNUNET_MESSENGER_OperationStore *operation_store;
  enum GNUNET_GenericReturnValue requested;
 
  GNUNET_assert ((tunnel) && (hash));
 
  operation_store = get_srv_room_operation_store (tunnel->room);
 
  requested = (GNUNET_MESSENGER_OP_REQUEST ==
               get_store_operation_type (operation_store, hash)?
               GNUNET_YES : GNUNET_NO);
 
  {
    struct GNUNET_MESSENGER_MessageStore *message_store;
    const struct GNUNET_MESSENGER_Message *message;
 
    message_store = get_srv_room_message_store (tunnel->room);
    message = get_store_message (message_store, hash);
 
    if (! message)
      return;
 
    update_message_state (&(tunnel->state), requested, message, hash);
  }
}
 
 
void
handle_tunnel_message (void *cls, const struct GNUNET_MessageHeader *header)
{
  struct GNUNET_MESSENGER_SrvTunnel *tunnel;
  struct GNUNET_MESSENGER_Message message;
  struct GNUNET_HashCode hash;
  uint16_t length;
  const char *buffer;
 
  GNUNET_assert (header);
 
  tunnel = cls;
 
  if (! tunnel)
    return;
 
  length = ntohs (header->size) - sizeof(*header);
  buffer = (const char*) &header[1];
 
  {
    uint16_t padding;
    padding = 0;
 
    decode_message (&message, length, buffer, GNUNET_YES, &padding);
    hash_message (&message, length - padding, buffer, &hash);
  }
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got message of kind: %s!\n",
              GNUNET_MESSENGER_name_of_kind (message.header.kind));
 
  {
    enum GNUNET_GenericReturnValue new_message;
    new_message = update_room_message (tunnel->room,
                                       copy_message (&message),
                                       &hash);
 
    if (GNUNET_YES != new_message)
      goto receive_done;
  }
 
  update_tunnel_last_message (tunnel, &hash);
 
  {
    enum GNUNET_GenericReturnValue forward_message;
    forward_message = GNUNET_YES;
 
    switch (message.header.kind)
    {
    case GNUNET_MESSENGER_KIND_INFO:
      forward_message = recv_message_info (
        tunnel->room,
        tunnel,
        &message,
        &hash);
      break;
    case GNUNET_MESSENGER_KIND_PEER:
      forward_message = recv_message_peer (
        tunnel->room,
        tunnel,
        &message,
        &hash);
      break;
    case GNUNET_MESSENGER_KIND_MISS:
      forward_message = recv_message_miss (
        tunnel->room,
        tunnel,
        &message,
        &hash);
      break;
    case GNUNET_MESSENGER_KIND_REQUEST:
      forward_message = recv_message_request (
        tunnel->room,
        tunnel,
        &message,
        &hash);
      break;
    default:
      break;
    }
 
    if (GNUNET_YES == forward_message)
    {
      forward_srv_room_message (tunnel->room, tunnel, &message, &hash);
      callback_room_handle_message (tunnel->room, &message, &hash);
    }
  }
 
receive_done:
  cleanup_message (&message);
 
  GNUNET_STATISTICS_update (tunnel->room->service->statistics,
                            "# messages received",
                            1,
                            GNUNET_NO);
 
  GNUNET_CADET_receive_done (tunnel->channel);
}
 
 
enum GNUNET_GenericReturnValue
connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
{
  const struct GNUNET_PeerIdentity *door;
  struct GNUNET_CADET_Handle *cadet;
  union GNUNET_MESSENGER_RoomKey key;
 
  GNUNET_assert (tunnel);
 
  if (tunnel->channel)
    return GNUNET_NO;
 
  door = GNUNET_PEER_resolve2 (tunnel->peer);
  cadet = get_srv_room_cadet (tunnel->room);
 
  GNUNET_memcpy (
    &(key.hash),
    get_srv_room_key (tunnel->room),
    sizeof (key.hash));
 
  if ((key.code.feed_bit) && (! key.code.group_bit))
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Tunnel to personal room containing private feeds failed!");
    return GNUNET_SYSERR;
  }
 
  {
    struct GNUNET_HashCode port;
    struct GNUNET_MQ_MessageHandler handlers[] = { GNUNET_MQ_hd_var_size (
                                                     tunnel_message,
                                                     GNUNET_MESSAGE_TYPE_CADET_CLI,
                                                     struct
                                                     GNUNET_MessageHeader, NULL)
                                                   ,
                                                   GNUNET_MQ_handler_end () };
 
    convert_messenger_key_to_port (&key, &port);
    tunnel->channel = GNUNET_CADET_channel_create (cadet, tunnel, door, &port,
                                                   NULL,
                                                   callback_tunnel_disconnect,
                                                   handlers);
  }
 
  if (! tunnel->channel)
    return GNUNET_SYSERR;
 
  GNUNET_STATISTICS_update (tunnel->room->service->statistics,
                            "# tunnels connected",
                            1,
                            GNUNET_NO);
 
  return GNUNET_YES;
}
 
 
void
disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
{
  GNUNET_assert (tunnel);
 
  if (tunnel->channel)
  {
    delayed_disconnect_channel (tunnel->channel);
 
    tunnel->channel = NULL;
  }
}
 
 
enum GNUNET_GenericReturnValue
is_tunnel_connected (const struct GNUNET_MESSENGER_SrvTunnel *tunnel)
{
  GNUNET_assert (tunnel);
 
  return (tunnel->channel ? GNUNET_YES : GNUNET_NO);
}
 
 
struct GNUNET_MESSENGER_MessageSent
{
  struct GNUNET_MESSENGER_SrvTunnel *tunnel;
  struct GNUNET_HashCode hash;
};
 
static void
callback_tunnel_sent (void *cls)
{
  struct GNUNET_MESSENGER_MessageSent *sent;
 
  GNUNET_assert (cls);
 
  sent = cls;
 
  if (sent->tunnel)
  {
    update_tunnel_last_message (sent->tunnel, &(sent->hash));
 
    GNUNET_STATISTICS_update (sent->tunnel->room->service->statistics,
                              "# messages sent",
                              1,
                              GNUNET_NO);
  }
 
  GNUNET_free (sent);
}
 
 
void
send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
                      struct GNUNET_MQ_Envelope *env,
                      const struct GNUNET_HashCode *hash)
{
  struct GNUNET_MQ_Handle *mq;
  struct GNUNET_MESSENGER_MessageSent *sent;
 
  GNUNET_assert ((tunnel) && (env) && (hash));
 
  mq = GNUNET_CADET_get_mq (tunnel->channel);
  sent = GNUNET_new (struct GNUNET_MESSENGER_MessageSent);
 
  GNUNET_memcpy (&(sent->hash), hash, sizeof(struct GNUNET_HashCode));
 
  sent->tunnel = tunnel;
 
  GNUNET_MQ_notify_sent (env, callback_tunnel_sent, sent);
  GNUNET_MQ_send (mq, env);
}
 
 
enum GNUNET_GenericReturnValue
send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
                     GNUNET_UNUSED void *handle,
                     struct GNUNET_MESSENGER_Message *message)
{
  struct GNUNET_HashCode hash;
  struct GNUNET_MQ_Envelope *env;
 
  GNUNET_assert (tunnel);
 
  if (! message)
    return GNUNET_NO;
 
  env = pack_srv_room_message (
    tunnel->room,
    message,
    &hash,
    GNUNET_MESSENGER_PACK_MODE_ENVELOPE);
 
  destroy_message (message);
 
  if (! env)
    return GNUNET_NO;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sending tunnel message: %s\n",
              GNUNET_h2s (&hash));
 
  send_tunnel_envelope (tunnel, env, &hash);
  return GNUNET_YES;
}
 
 
void
forward_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
                        const struct GNUNET_MESSENGER_Message *message,
                        const struct GNUNET_HashCode *hash)
{
  struct GNUNET_MESSENGER_Message *copy;
  struct GNUNET_MQ_Envelope *env;
 
  GNUNET_assert ((tunnel) && (message) && (hash));
 
  copy = copy_message (message);
  env = pack_message (copy, NULL, NULL, GNUNET_MESSENGER_PACK_MODE_ENVELOPE,
                      NULL);
 
  destroy_message (copy);
 
  if (! env)
    return;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Forwarding tunnel message: %s\n",
              GNUNET_h2s (hash));
 
  send_tunnel_envelope (tunnel, env, hash);
}
 
 
const struct GNUNET_HashCode*
get_tunnel_peer_message (const struct GNUNET_MESSENGER_SrvTunnel *tunnel)
{
  GNUNET_assert (tunnel);
 
  return tunnel->peer_message;
}
 
 
void
get_tunnel_peer_identity (const struct GNUNET_MESSENGER_SrvTunnel *tunnel,
                          struct GNUNET_PeerIdentity *peer)
{
  GNUNET_assert (tunnel);
 
  GNUNET_PEER_resolve (tunnel->peer, peer);
}
 
 
uint32_t
get_tunnel_messenger_version (const struct GNUNET_MESSENGER_SrvTunnel *tunnel)
{
  GNUNET_assert (tunnel);
 
  return tunnel->messenger_version;
}
 
 
enum GNUNET_GenericReturnValue
update_tunnel_messenger_version (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
                                 uint32_t version)
{
  GNUNET_assert (tunnel);
 
  if (version != GNUNET_MESSENGER_VERSION)
    return GNUNET_SYSERR;
 
  if (version > tunnel->messenger_version)
    tunnel->messenger_version = version;
 
  return GNUNET_OK;
}