gnunet-service-messenger_tunnel.h File Reference

GNUnet MESSENGER service. More...

#include "platform.h"
#include "gnunet_cadet_service.h"
#include "gnunet_peer_lib.h"
#include "gnunet_crypto_lib.h"
#include "gnunet-service-messenger_room.h"

Include dependency graph for gnunet-service-messenger_tunnel.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_MESSENGER_SrvTunnel

Functions
struct GNUNET_MESSENGER_SrvTunnel *	create_tunnel (struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_PeerIdentity *door)
	Creates and allocates a tunnel of a room to a specific peer identity (called door). More...
void	destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Destroys a tunnel and frees its memory fully. More...
void	bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_CADET_Channel *channel)
	Binds a CADET channel to a tunnel and replaces its channel the tunnel is currently bound to if necessary. More...
int	connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Tries to connect a tunnel by creating a new CADET channel and binding it. More...
void	disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Disconnects and unbinds a channel from a tunnel. More...
int	is_tunnel_connected (const struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Returns the status of a currently bound channel of a tunnel. More...
void	send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_MQ_Envelope *env, const struct GNUNET_HashCode *hash)
	Sends an envelope containing a message with a given hash through a tunnel. More...
int	send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, void *handle, struct GNUNET_MESSENGER_Message *message)
	Sends a message by packing it automatically into an envelope and passing it through the tunnel. More...
void	forward_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
	Forwards a given message with a known hash through a tunnel. More...
const struct GNUNET_HashCode *	get_tunnel_peer_message (const struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Returns the hash of the latest peer message published through a given tunnel and matching the tunnels peer identity. More...
void	get_tunnel_peer_identity (const struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_PeerIdentity *peer)
	Writes the peer identity of the peer connected via tunnel to this peer into the peer parameter. More...
uint32_t	get_tunnel_messenger_version (const struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Returns the current messenger version the peer connected via a given tunnel has reported to be using if it was compatible during updating. More...
int	update_tunnel_messenger_version (struct GNUNET_MESSENGER_SrvTunnel *tunnel, uint32_t version)
	Updates the messenger version of the tunnel to a given version if it is compatible to the running peer of the service. More...

Detailed Description

GNUnet MESSENGER service.

Author

Tobias Frisch

Definition in file gnunet-service-messenger_tunnel.h.

Function Documentation

create_tunnel()

struct GNUNET_MESSENGER_SrvTunnel* create_tunnel	(	struct GNUNET_MESSENGER_SrvRoom *	room,
		const struct GNUNET_PeerIdentity *	door
	)

Creates and allocates a tunnel of a room to a specific peer identity (called door).

Parameters

Definition at line 33 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_assert, GNUNET_new, GNUNET_PEER_intern(), GNUNET_MESSENGER_SrvTunnel::last_message, GNUNET_MESSENGER_SrvTunnel::messenger_version, GNUNET_MESSENGER_SrvTunnel::peer, GNUNET_MESSENGER_SrvTunnel::peer_message, and GNUNET_MESSENGER_SrvTunnel::room.

Referenced by callback_room_connect(), and enter_room_at().

{
  GNUNET_assert((room) && (door));

  struct GNUNET_MESSENGER_SrvTunnel *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;
  tunnel->last_message = NULL;

  return tunnel;
}

Here is the call graph for this function:

Here is the caller graph for this function:

destroy_tunnel()

void destroy_tunnel

(

struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Destroys a tunnel and frees its memory fully.

Parameters

Definition at line 53 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_assert, GNUNET_CADET_channel_destroy(), GNUNET_free, GNUNET_PEER_change_rc(), GNUNET_MESSENGER_SrvTunnel::last_message, GNUNET_MESSENGER_SrvTunnel::peer, and GNUNET_MESSENGER_SrvTunnel::peer_message.

{
  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);

  if (tunnel->last_message)
    GNUNET_free(tunnel->last_message);

  GNUNET_free(tunnel);
}

Here is the call graph for this function:

bind_tunnel()

void bind_tunnel	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		struct GNUNET_CADET_Channel *	channel
	)

Binds a CADET channel to a tunnel and replaces its channel the tunnel is currently bound to if necessary.

Parameters

Definition at line 72 of file gnunet-service-messenger_tunnel.c.

References callback_room_disconnect(), GNUNET_MESSENGER_SrvTunnel::channel, delayed_disconnect_channel(), GNUNET_assert, and GNUNET_MESSENGER_SrvTunnel::room.

Referenced by callback_room_connect().

{
  GNUNET_assert(tunnel);

  if (tunnel->channel)
    delayed_disconnect_channel (tunnel->channel);

  tunnel->channel = channel;
}

Here is the call graph for this function:

Here is the caller graph for this function:

connect_tunnel()

int connect_tunnel

(

struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Tries to connect a tunnel by creating a new CADET channel and binding it.

The function returns GNUNET_YES on success, otherwise GNUNET_NO.

Parameters

Definition at line 209 of file gnunet-service-messenger_tunnel.c.

References cadet, callback_tunnel_disconnect(), GNUNET_MESSENGER_SrvTunnel::channel, get_room_cadet(), get_room_key(), GNUNET_assert, GNUNET_CADET_channel_create(), GNUNET_MESSAGE_TYPE_CADET_CLI, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_NO, GNUNET_PEER_resolve2(), GNUNET_YES, key, GNUNET_MESSENGER_SrvTunnel::peer, and GNUNET_MESSENGER_SrvTunnel::room.

Referenced by enter_room_at(), and rebuild_room_basement_structure().

{
  GNUNET_assert(tunnel);

  if (tunnel->channel)
    return GNUNET_NO;

  const struct GNUNET_PeerIdentity *door = GNUNET_PEER_resolve2 (tunnel->peer);

  struct GNUNET_CADET_Handle *cadet = get_room_cadet (tunnel->room);
  const struct GNUNET_HashCode *key = get_room_key (tunnel->room);

  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() };

  tunnel->channel = GNUNET_CADET_channel_create (cadet, tunnel, door, key, NULL, callback_tunnel_disconnect, handlers);

  return GNUNET_YES;
}

Here is the call graph for this function:

Here is the caller graph for this function:

disconnect_tunnel()

void disconnect_tunnel

(

struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Disconnects and unbinds a channel from a tunnel.

The actual disconnection will be asynchronous.

Parameters

Definition at line 231 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::channel, delayed_disconnect_channel(), and GNUNET_assert.

Referenced by callback_room_connect(), rebuild_room_basement_structure(), and recv_message_info().

{
  GNUNET_assert(tunnel);

  if (tunnel->channel)
  {
    delayed_disconnect_channel (tunnel->channel);

    tunnel->channel = NULL;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

is_tunnel_connected()

int is_tunnel_connected

(

const struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Returns the status of a currently bound channel of a tunnel.

Parameters

[in]

tunnel

Tunnel

Returns

GNUNET_YES or GNUNET_NO

Definition at line 244 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_assert, GNUNET_NO, and GNUNET_YES.

Referenced by iterate_send_room_message(), and send_room_info().

{
  GNUNET_assert(tunnel);

  return (tunnel->channel ? GNUNET_YES : GNUNET_NO);
}

Here is the caller graph for this function:

send_tunnel_envelope()

void send_tunnel_envelope	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		struct GNUNET_MQ_Envelope *	env,
		const struct GNUNET_HashCode *	hash
	)

Sends an envelope containing a message with a given hash through a tunnel.

Parameters

Definition at line 269 of file gnunet-service-messenger_tunnel.c.

References callback_tunnel_sent(), GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_assert, GNUNET_CADET_get_mq(), GNUNET_memcpy, GNUNET_MQ_notify_sent(), GNUNET_MQ_send(), GNUNET_new, GNUNET_MESSENGER_MessageSent::hash, mq, and GNUNET_MESSENGER_MessageSent::tunnel.

Referenced by forward_tunnel_message(), iterate_send_room_message(), and send_tunnel_message().

{
  GNUNET_assert((tunnel) && (env) && (hash));

  struct GNUNET_MQ_Handle *mq = GNUNET_CADET_get_mq (tunnel->channel);

  struct GNUNET_MESSENGER_MessageSent *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);
}

Here is the call graph for this function:

Here is the caller graph for this function:

send_tunnel_message()

int send_tunnel_message	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		void *	handle,
		struct GNUNET_MESSENGER_Message *	message
	)

Sends a message by packing it automatically into an envelope and passing it through the tunnel.

The used handle will sign the message and the hash will be calculated and stored.

Parameters

Definition at line 287 of file gnunet-service-messenger_tunnel.c.

References destroy_message(), env, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_log, GNUNET_MESSENGER_PACK_MODE_ENVELOPE, GNUNET_NO, GNUNET_YES, pack_room_message(), GNUNET_MESSENGER_SrvTunnel::room, and send_tunnel_envelope().

Referenced by recv_message_info(), and send_room_info().

{
  GNUNET_assert((tunnel) && (handle));

  if (!message)
    return GNUNET_NO;

  struct GNUNET_HashCode hash;
  struct GNUNET_MQ_Envelope *env = pack_room_message (
      tunnel->room, (struct GNUNET_MESSENGER_SrvHandle*) handle,
      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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

forward_tunnel_message()

void forward_tunnel_message	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		const struct GNUNET_MESSENGER_Message *	message,
		const struct GNUNET_HashCode *	hash
	)

Forwards a given message with a known hash through a tunnel.

Parameters

Definition at line 313 of file gnunet-service-messenger_tunnel.c.

References copy_message(), destroy_message(), env, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_log, GNUNET_MESSENGER_PACK_MODE_ENVELOPE, pack_message(), and send_tunnel_envelope().

Referenced by check_room_peer_status(), iterate_forward_members(), and recv_message_request().

{
  if (!message)
    return;

  GNUNET_assert((tunnel) && (message) && (hash));

  struct GNUNET_MESSENGER_Message *copy = copy_message(message);
  struct GNUNET_MQ_Envelope *env = pack_message (copy, NULL, NULL, GNUNET_MESSENGER_PACK_MODE_ENVELOPE);

  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);
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_tunnel_peer_message()

const struct GNUNET_HashCode* get_tunnel_peer_message

(

const struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Returns the hash of the latest peer message published through a given tunnel and matching the tunnels peer identity.

If no peer message has been linked to the tunnel yet, NULL gets returned.

Parameters

[in]

tunnel

Tunnel

Returns

Hash of peer message or NULL

Definition at line 336 of file gnunet-service-messenger_tunnel.c.

References GNUNET_assert, and GNUNET_MESSENGER_SrvTunnel::peer_message.

{
  GNUNET_assert(tunnel);

  return tunnel->peer_message;
}

get_tunnel_peer_identity()

void get_tunnel_peer_identity	(	const struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		struct GNUNET_PeerIdentity *	peer
	)

Writes the peer identity of the peer connected via tunnel to this peer into the peer parameter.

Parameters

[in]	tunnel	Tunnel
[out]	peer	Peer identity

Definition at line 344 of file gnunet-service-messenger_tunnel.c.

References GNUNET_assert, GNUNET_PEER_resolve(), and GNUNET_MESSENGER_SrvTunnel::peer.

Referenced by callback_room_disconnect(), and recv_message_info().

{
  GNUNET_assert(tunnel);

  GNUNET_PEER_resolve(tunnel->peer, peer);
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_tunnel_messenger_version()

uint32_t get_tunnel_messenger_version

(

const struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Returns the current messenger version the peer connected via a given tunnel has reported to be using if it was compatible during updating.

See also

update_tunnel_messenger_version

Parameters

[in]

tunnel

Tunnel

Returns

Version of messenger

Definition at line 352 of file gnunet-service-messenger_tunnel.c.

References GNUNET_assert, and GNUNET_MESSENGER_SrvTunnel::messenger_version.

Referenced by iterate_send_room_message(), and recv_message_info().

{
  GNUNET_assert(tunnel);

  return tunnel->messenger_version;
}

Here is the caller graph for this function:

update_tunnel_messenger_version()

int update_tunnel_messenger_version	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		uint32_t	version
	)

Updates the messenger version of the tunnel to a given version if it is compatible to the running peer of the service.

Depending on success it returns GNUNET_OK or GNUNET_SYSERR on failure.

Parameters

Definition at line 360 of file gnunet-service-messenger_tunnel.c.

References GNUNET_assert, GNUNET_MESSENGER_VERSION, GNUNET_OK, GNUNET_SYSERR, and GNUNET_MESSENGER_SrvTunnel::messenger_version.

Referenced by recv_message_info().

{
  GNUNET_assert(tunnel);

  if (version != GNUNET_MESSENGER_VERSION)
    return GNUNET_SYSERR;

  if (version > tunnel->messenger_version)
    tunnel->messenger_version = version;

  return GNUNET_OK;
}

Here is the caller graph for this function: