gnunet_messenger_service.h

Go to the documentation of this file.

/*
   This file is part of GNUnet.
   Copyright (C) 2020 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
 */
#ifndef GNUNET_MESSENGER_SERVICE_H
#define GNUNET_MESSENGER_SERVICE_H

#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif

#include "platform.h"
#include "gnunet_configuration_lib.h"
#include "gnunet_crypto_lib.h"
#include "gnunet_identity_service.h"
#include "gnunet_mq_lib.h"
#include "gnunet_protocols.h"
#include "gnunet_scheduler_lib.h"
#include "gnunet_time_lib.h"

#define GNUNET_MESSENGER_VERSION 0x00000001

#define GNUNET_MESSENGER_SERVICE_NAME "messenger"

struct GNUNET_MESSENGER_Handle;

struct GNUNET_MESSENGER_Room;

struct GNUNET_MESSENGER_Contact;

enum GNUNET_MESSENGER_MessageKind
{
  GNUNET_MESSENGER_KIND_INFO = 1,

  GNUNET_MESSENGER_KIND_JOIN = 2,

  GNUNET_MESSENGER_KIND_LEAVE = 3,

  GNUNET_MESSENGER_KIND_NAME = 4,

  GNUNET_MESSENGER_KIND_KEY = 5,

  GNUNET_MESSENGER_KIND_PEER = 6,

  GNUNET_MESSENGER_KIND_ID = 7,

  GNUNET_MESSENGER_KIND_MISS = 8,

  GNUNET_MESSENGER_KIND_MERGE = 9,

  GNUNET_MESSENGER_KIND_REQUEST = 10,

  GNUNET_MESSENGER_KIND_INVITE = 11,

  GNUNET_MESSENGER_KIND_TEXT = 12,

  GNUNET_MESSENGER_KIND_FILE = 13,

  GNUNET_MESSENGER_KIND_PRIVATE = 14,

  GNUNET_MESSENGER_KIND_DELETE = 15,

  GNUNET_MESSENGER_KIND_UNKNOWN = 0
};

#define GNUNET_MESSENGER_KIND_MAX (GNUNET_MESSENGER_KIND_DELETE)

const char*
GNUNET_MESSENGER_name_of_kind (enum GNUNET_MESSENGER_MessageKind kind);

struct GNUNET_MESSENGER_MessageHeader
{
  struct GNUNET_IDENTITY_Signature signature;

  struct GNUNET_TIME_AbsoluteNBO timestamp;

  struct GNUNET_ShortHashCode sender_id;

  struct GNUNET_HashCode previous;

  enum GNUNET_MESSENGER_MessageKind kind;
};

struct GNUNET_MESSENGER_MessageInfo
{
  struct GNUNET_IDENTITY_PublicKey host_key;

  uint32_t messenger_version;
};

struct GNUNET_MESSENGER_MessageJoin
{
  struct GNUNET_IDENTITY_PublicKey key;
};

struct GNUNET_MESSENGER_MessageLeave
{
};

struct GNUNET_MESSENGER_MessageName
{
  char *name;
};

struct GNUNET_MESSENGER_MessageKey
{
  struct GNUNET_IDENTITY_PublicKey key;
};

struct GNUNET_MESSENGER_MessagePeer
{
  struct GNUNET_PeerIdentity peer;
};

struct GNUNET_MESSENGER_MessageId
{
  struct GNUNET_ShortHashCode id;
};

struct GNUNET_MESSENGER_MessageMiss
{
  struct GNUNET_PeerIdentity peer;
};

struct GNUNET_MESSENGER_MessageMerge
{
  struct GNUNET_HashCode previous;
};

struct GNUNET_MESSENGER_MessageRequest
{
  struct GNUNET_HashCode hash;
};

struct GNUNET_MESSENGER_MessageInvite
{
  struct GNUNET_PeerIdentity door;

  struct GNUNET_HashCode key;
};

struct GNUNET_MESSENGER_MessageText
{
  char *text;
};

struct GNUNET_MESSENGER_MessageFile
{
  struct GNUNET_CRYPTO_SymmetricSessionKey key;

  struct GNUNET_HashCode hash;

  char name[NAME_MAX];

  char *uri;
};

struct GNUNET_MESSENGER_MessagePrivate
{
  struct GNUNET_CRYPTO_EcdhePublicKey key;

  uint16_t length;

  char *data;
};

struct GNUNET_MESSENGER_MessageDelete
{
  struct GNUNET_HashCode hash;

  struct GNUNET_TIME_RelativeNBO delay;
};

struct GNUNET_MESSENGER_MessageBody
{
  union
  {
    struct GNUNET_MESSENGER_MessageInfo info;
    struct GNUNET_MESSENGER_MessageJoin join;
    struct GNUNET_MESSENGER_MessageLeave leave;
    struct GNUNET_MESSENGER_MessageName name;
    struct GNUNET_MESSENGER_MessageKey key;
    struct GNUNET_MESSENGER_MessagePeer peer;
    struct GNUNET_MESSENGER_MessageId id;
    struct GNUNET_MESSENGER_MessageMiss miss;
    struct GNUNET_MESSENGER_MessageMerge merge;
    struct GNUNET_MESSENGER_MessageRequest request;
    struct GNUNET_MESSENGER_MessageInvite invite;
    struct GNUNET_MESSENGER_MessageText text;
    struct GNUNET_MESSENGER_MessageFile file;
    struct GNUNET_MESSENGER_MessagePrivate private;
    struct GNUNET_MESSENGER_MessageDelete delete;
  };
};

struct GNUNET_MESSENGER_Message
{
  struct GNUNET_MESSENGER_MessageHeader header;

  struct GNUNET_MESSENGER_MessageBody body;
};

enum GNUNET_MESSENGER_MessageFlags
{
  GNUNET_MESSENGER_FLAG_NONE = 0,

  GNUNET_MESSENGER_FLAG_PRIVATE = 1,
};

typedef void
(*GNUNET_MESSENGER_IdentityCallback) (void *cls, struct GNUNET_MESSENGER_Handle *handle);

typedef void
(*GNUNET_MESSENGER_MessageCallback) (void *cls, struct GNUNET_MESSENGER_Room *room,
                                     const struct GNUNET_MESSENGER_Contact *sender,
                                     const struct GNUNET_MESSENGER_Message *message,
                                     const struct GNUNET_HashCode *hash,
                                     enum GNUNET_MESSENGER_MessageFlags flags);

typedef int
(*GNUNET_MESSENGER_MemberCallback) (void* cls, struct GNUNET_MESSENGER_Room *room,
                                    const struct GNUNET_MESSENGER_Contact *contact);

struct GNUNET_MESSENGER_Handle*
GNUNET_MESSENGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *name,
                          GNUNET_MESSENGER_IdentityCallback identity_callback, void *identity_cls,
                          GNUNET_MESSENGER_MessageCallback msg_callback, void *msg_cls);

int
GNUNET_MESSENGER_update (struct GNUNET_MESSENGER_Handle *handle);

void
GNUNET_MESSENGER_disconnect (struct GNUNET_MESSENGER_Handle *handle);

const char*
GNUNET_MESSENGER_get_name (const struct GNUNET_MESSENGER_Handle *handle);

int
GNUNET_MESSENGER_set_name (struct GNUNET_MESSENGER_Handle *handle, const char *name);

const struct GNUNET_IDENTITY_PublicKey*
GNUNET_MESSENGER_get_key (const struct GNUNET_MESSENGER_Handle *handle);

struct GNUNET_MESSENGER_Room*
GNUNET_MESSENGER_open_room (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key);

struct GNUNET_MESSENGER_Room*
GNUNET_MESSENGER_enter_room (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_PeerIdentity *door,
                             const struct GNUNET_HashCode *key);

void
GNUNET_MESSENGER_close_room (struct GNUNET_MESSENGER_Room *room);

struct GNUNET_MESSENGER_Contact*
GNUNET_MESSENGER_get_sender (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash);

const char*
GNUNET_MESSENGER_contact_get_name (const struct GNUNET_MESSENGER_Contact *contact);

const struct GNUNET_IDENTITY_PublicKey*
GNUNET_MESSENGER_contact_get_key (const struct GNUNET_MESSENGER_Contact *contact);

void
GNUNET_MESSENGER_send_message (struct GNUNET_MESSENGER_Room *room, const struct GNUNET_MESSENGER_Message *message,
                               const struct GNUNET_MESSENGER_Contact* contact);

const struct GNUNET_MESSENGER_Message*
GNUNET_MESSENGER_get_message (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash);

int
GNUNET_MESSENGER_iterate_members (struct GNUNET_MESSENGER_Room *room, GNUNET_MESSENGER_MemberCallback callback,
                                  void* cls);

#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif

#endif //GNUNET_MESSENGER_SERVICE_H
/* end of group */