GNUnet  0.11.x
gnunet_messenger_service.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2020 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
32 #ifndef GNUNET_MESSENGER_SERVICE_H
33 #define GNUNET_MESSENGER_SERVICE_H
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #if 0 /* keep Emacsens' auto-indent happy */
38 }
39 #endif
40 #endif
41 
42 #include "platform.h"
44 #include "gnunet_crypto_lib.h"
46 #include "gnunet_mq_lib.h"
47 #include "gnunet_protocols.h"
48 #include "gnunet_scheduler_lib.h"
49 #include "gnunet_time_lib.h"
50 
54 #define GNUNET_MESSENGER_VERSION 0x00000001
55 
59 #define GNUNET_MESSENGER_SERVICE_NAME "messenger"
60 
65 
70 
75 
80 {
85 
90 
95 
100 
105 
110 
115 
120 
125 
130 
135 
140 
145 
150 
155 
160 };
161 
162 #define GNUNET_MESSENGER_KIND_MAX (GNUNET_MESSENGER_KIND_DELETE)
163 
170 const char*
172 
180 {
185 
190 
195 
200 
205 };
206 
214 {
218  struct GNUNET_IDENTITY_PublicKey host_key;
219 
224 };
225 
233 {
238 };
239 
247 {
248 };
249 
257 {
261  char *name;
262 };
263 
271 {
276 };
277 
285 {
290 };
291 
299 {
304 };
305 
313 {
317  struct GNUNET_PeerIdentity peer;
318 };
319 
327 {
332 };
333 
341 {
345  struct GNUNET_HashCode hash;
346 };
347 
355 {
359  struct GNUNET_PeerIdentity door;
360 
364  struct GNUNET_HashCode key;
365 };
366 
374 {
378  char *text;
379 };
380 
388 {
393 
397  struct GNUNET_HashCode hash;
398 
402  char name[NAME_MAX];
403 
407  char *uri;
408 };
409 
417 {
422 
426  uint16_t length;
427 
431  char *data;
432 };
433 
441 {
445  struct GNUNET_HashCode hash;
446 
451 };
452 
457 {
458  union
459  {
475  };
476 };
477 
482 {
487 
492 };
493 
498 {
503 
508 };
509 
517 typedef void
519 
533 typedef void
535  const struct GNUNET_MESSENGER_Contact *sender,
536  const struct GNUNET_MESSENGER_Message *message,
537  const struct GNUNET_HashCode *hash,
538  enum GNUNET_MESSENGER_MessageFlags flags);
539 
548 typedef int
550  const struct GNUNET_MESSENGER_Contact *contact);
551 
568 
580 int
582 
588 void
590 
597 const char*
599 
609 int
611 
618 const struct GNUNET_IDENTITY_PublicKey*
620 
637 struct GNUNET_MESSENGER_Room*
639 
658 struct GNUNET_MESSENGER_Room*
660  const struct GNUNET_HashCode *key);
661 
671 void
673 
684 GNUNET_MESSENGER_get_sender (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash);
685 
692 const char*
694 
701 const struct GNUNET_IDENTITY_PublicKey*
703 
722 void
724  const struct GNUNET_MESSENGER_Contact* contact);
725 
733 const struct GNUNET_MESSENGER_Message*
734 GNUNET_MESSENGER_get_message (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash);
735 
746 int
748  void* cls);
749 
750 #if 0 /* keep Emacsens' auto-indent happy */
751 {
752 #endif
753 #ifdef __cplusplus
754 }
755 #endif
756 
757 #endif //GNUNET_MESSENGER_SERVICE_H
758 /* end of group */
const struct GNUNET_MESSENGER_Message * GNUNET_MESSENGER_get_message(const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash)
Get the message in a room identified by its hash.
const struct GNUNET_IDENTITY_PublicKey * GNUNET_MESSENGER_get_key(const struct GNUNET_MESSENGER_Handle *handle)
Get the public key used by the messenger or NULL if the anonymous key was used.
struct GNUNET_ShortHashCode sender_id
The senders id inside of the room the message was sent in.
static struct GNUNET_VPN_RedirectionRequest * request
Opaque redirection request handle.
Definition: gnunet-vpn.c:41
struct GNUNET_MESSENGER_Room * GNUNET_MESSENGER_open_room(struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key)
Open a room to send and receive messages.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
struct GNUNET_TIME_AbsoluteNBO timestamp
The timestamp of the message.
The header of a GNUNET_MESSENGER_Message.
void GNUNET_MESSENGER_close_room(struct GNUNET_MESSENGER_Room *room)
Close a room which was entered, opened or both in various order and variety.
void GNUNET_MESSENGER_send_message(struct GNUNET_MESSENGER_Room *room, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_MESSENGER_Contact *contact)
Send a message into a room.
char * uri
The uri of the encrypted file.
struct GNUNET_MESSENGER_Room * GNUNET_MESSENGER_enter_room(struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_PeerIdentity *door, const struct GNUNET_HashCode *key)
Enter a room to send and receive messages through a door opened using GNUNET_MESSENGER_open_room.
const char * GNUNET_MESSENGER_contact_get_name(const struct GNUNET_MESSENGER_Contact *contact)
Get the name used by the contact.
int GNUNET_MESSENGER_set_name(struct GNUNET_MESSENGER_Handle *handle, const char *name)
Set the name for the messenger.
uint32_t messenger_version
The version of GNUnet Messenger API.
static struct GNUNET_IDENTITY_Handle * id
Handle to identity service.
Time for relative time used by GNUnet, in microseconds and in network byte order. ...
char * text
The containing text.
Time for absolute time used by GNUnet, in microseconds and in network byte order. ...
A 256-bit hashcode.
GNUNET_MESSENGER_MessageFlags
Enum for the different supported flags used by message handling.
cryptographic primitives for GNUnet
The unified body of a GNUNET_MESSENGER_Message.
GNUNET_MESSENGER_MessageCallback msg_callback
An identity signature as per LSD0001.
const char * GNUNET_MESSENGER_name_of_kind(enum GNUNET_MESSENGER_MessageKind kind)
Get the name of a message kind.
Definition: messenger_api.c:35
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
int GNUNET_MESSENGER_update(struct GNUNET_MESSENGER_Handle *handle)
Update a handle of the messenger to use a different ego key and replace the old one with a newly gene...
uint16_t length
The length of the encrypted message.
struct GNUNET_IDENTITY_Signature signature
The signature of the senders private key.
A 512-bit hashcode.
int(* GNUNET_MESSENGER_MemberCallback)(void *cls, struct GNUNET_MESSENGER_Room *room, const struct GNUNET_MESSENGER_Contact *contact)
Method called for each member in a room during iteration.
struct GNUNET_HashCode previous
The hash of the previous message from the senders perspective.
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
struct GNUNET_HashCode key
The key used in the DHT.
void(* GNUNET_MESSENGER_IdentityCallback)(void *cls, struct GNUNET_MESSENGER_Handle *handle)
Method called whenever the EGO of a handle changes or if the first connection fails to load a valid E...
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
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)
Method called whenever a message is sent or received from a room.
The identity of the host (wraps the signing key of the peer).
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)
Set up a handle for the messenger related functions and connects to all necessary services...
An identity key as per LSD0001.
int GNUNET_MESSENGER_iterate_members(struct GNUNET_MESSENGER_Room *room, GNUNET_MESSENGER_MemberCallback callback, void *cls)
Iterates through all members of a given room and calls a selected callback for each of them with a pr...
char * data
The data of the encrypted message.
configuration data
Definition: configuration.c:84
const char * name
void GNUNET_MESSENGER_disconnect(struct GNUNET_MESSENGER_Handle *handle)
Disconnect all of the messengers used services and clears up its used memory.
Public ECC key (always for Curve25519) encoded in a format suitable for network transmission and encr...
const char * GNUNET_MESSENGER_get_name(const struct GNUNET_MESSENGER_Handle *handle)
Get the name (if specified, otherwise NULL) used by the messenger.
const struct GNUNET_IDENTITY_PublicKey * GNUNET_MESSENGER_contact_get_key(const struct GNUNET_MESSENGER_Contact *contact)
Get the public key used by the contact or NULL if the anonymous key was used.
GNUNET_MESSENGER_MessageKind
Enum for the different supported kinds of messages.
char * name
The new name which replaces the current senders name.
static int delete
Set if we should delete configuration and temp directory on exit.
Definition: gnunet-arm.c:49
GNUNET_MESSENGER_IdentityCallback identity_callback
A delete message body This allows deletion of an own previous message with any custom automatic delay...
struct GNUNET_MESSENGER_Contact * GNUNET_MESSENGER_get_sender(const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash)
Get the contact of a member in a room which sent a specific message identified with a given hash...
enum GNUNET_MESSENGER_MessageKind kind
The kind of the message.