GNUnet 0.26.2-14-ga82e62fdc
 
Loading...
Searching...
No Matches
messenger_api_contact.h File Reference
#include "gnunet_common.h"
#include "gnunet_util_lib.h"
Include dependency graph for messenger_api_contact.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_Contact
 

Functions

struct GNUNET_MESSENGER_Contactcreate_contact (const struct GNUNET_CRYPTO_BlindablePublicKey *key, size_t unique_id)
 Creates and allocates a new contact with a given public key.
 
void destroy_contact (struct GNUNET_MESSENGER_Contact *contact)
 Destroys a contact and frees its memory fully.
 
const char * get_contact_name (const struct GNUNET_MESSENGER_Contact *contact)
 Returns the current name of a given contact or NULL if no valid name was assigned yet.
 
void set_contact_name (struct GNUNET_MESSENGER_Contact *contact, const char *name)
 Changes the current name of a given contact by copying it from the parameter name.
 
const struct GNUNET_CRYPTO_BlindablePublicKeyget_contact_key (const struct GNUNET_MESSENGER_Contact *contact)
 Returns the blindable public key of a given contact.
 
const struct GNUNET_CRYPTO_HpkePublicKeyget_contact_encryption_key (const struct GNUNET_MESSENGER_Contact *contact, const struct GNUNET_HashCode *key)
 Returns the HPKE public key of a given contact for a specific room that is identified via its own room key.
 
void set_contact_encryption_key (struct GNUNET_MESSENGER_Contact *contact, const struct GNUNET_HashCode *key, const struct GNUNET_CRYPTO_HpkePublicKey *encryption_key)
 Sets or replaces the encryption_key of a given contact for a specified room that is identified via its own room key.
 
void increase_contact_rc (struct GNUNET_MESSENGER_Contact *contact)
 Increases the reference counter of a given contact which is zero as default.
 
enum GNUNET_GenericReturnValue decrease_contact_rc (struct GNUNET_MESSENGER_Contact *contact)
 Decreases the reference counter if possible (can not underflow!) of a given contact and returns GNUNET_YES if the counter is equal to zero, otherwise GNUNET_NO.
 
size_t get_contact_id (const struct GNUNET_MESSENGER_Contact *contact)
 Returns the locally unique identifier of a given contact.
 
void get_context_from_member (const struct GNUNET_HashCode *key, const struct GNUNET_ShortHashCode *id, struct GNUNET_HashCode *context)
 Calculates the context hash of a member in a room and returns it.
 

Function Documentation

◆ create_contact()

struct GNUNET_MESSENGER_Contact * create_contact ( const struct GNUNET_CRYPTO_BlindablePublicKey key,
size_t  unique_id 
)

Creates and allocates a new contact with a given public key.

Parameters
[in]keyPublic key
[in]unique_idLocally unique identifier
Returns
New contact

Definition at line 29 of file messenger_api_contact.c.

31{
32 struct GNUNET_MESSENGER_Contact *contact;
33
35
36 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Create new contact: %lu\n",
37 unique_id);
38
39 contact = GNUNET_new (struct GNUNET_MESSENGER_Contact);
40
41 contact->name = NULL;
42 contact->rc = 0;
43 contact->id = unique_id;
44
45 GNUNET_memcpy (&(contact->public_key), key, sizeof(contact->public_key));
46
48 8, GNUNET_NO);
49
50 return contact;
51}
struct GNUNET_HashCode key
The key used in the DHT.
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
#define GNUNET_log(kind,...)
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
@ GNUNET_NO
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_CONTAINER_MultiHashMap * encryption_keys
struct GNUNET_CRYPTO_BlindablePublicKey public_key

References GNUNET_MESSENGER_Contact::encryption_keys, GNUNET_assert, GNUNET_CONTAINER_multihashmap_create(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_memcpy, GNUNET_new, GNUNET_NO, GNUNET_MESSENGER_Contact::id, key, GNUNET_MESSENGER_Contact::name, GNUNET_MESSENGER_Contact::public_key, and GNUNET_MESSENGER_Contact::rc.

Referenced by get_store_contact().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ destroy_contact()

void destroy_contact ( struct GNUNET_MESSENGER_Contact contact)

Destroys a contact and frees its memory fully.

Parameters
[in,out]contactContact

Definition at line 70 of file messenger_api_contact.c.

71{
72 GNUNET_assert (contact);
73
74 if (contact->name)
75 GNUNET_free (contact->name);
76
79
81
82 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Free contact: %lu\n",
83 contact->id);
84
85 GNUNET_free (contact);
86}
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MultiHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
#define GNUNET_free(ptr)
Wrapper around free.
static enum GNUNET_GenericReturnValue iterate_free_contact_encryption_key(void *cls, const struct GNUNET_HashCode *key, void *value)

References GNUNET_MESSENGER_Contact::encryption_keys, GNUNET_assert, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_MESSENGER_Contact::id, iterate_free_contact_encryption_key(), and GNUNET_MESSENGER_Contact::name.

Referenced by get_store_contact(), iterate_destroy_contacts(), and remove_store_contact().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_contact_name()

const char * get_contact_name ( const struct GNUNET_MESSENGER_Contact contact)

Returns the current name of a given contact or NULL if no valid name was assigned yet.

Parameters
[in]contactContact
Returns
Name of the contact or NULL

Definition at line 90 of file messenger_api_contact.c.

91{
92 GNUNET_assert (contact);
93
94 return contact->name;
95}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::name.

Referenced by GNUNET_MESSENGER_contact_get_name().

Here is the caller graph for this function:

◆ set_contact_name()

void set_contact_name ( struct GNUNET_MESSENGER_Contact contact,
const char *  name 
)

Changes the current name of a given contact by copying it from the parameter name.

Parameters
[in,out]contactContact
[in]nameName

Definition at line 99 of file messenger_api_contact.c.

101{
102 GNUNET_assert (contact);
103
104 if (contact->name)
105 GNUNET_free (contact->name);
106
107 contact->name = name ? GNUNET_strdup (name) : NULL;
108}
static char * name
Name (label) of the records to list.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.

References GNUNET_assert, GNUNET_free, GNUNET_strdup, name, and GNUNET_MESSENGER_Contact::name.

Referenced by handle_name_message().

Here is the caller graph for this function:

◆ get_contact_key()

const struct GNUNET_CRYPTO_BlindablePublicKey * get_contact_key ( const struct GNUNET_MESSENGER_Contact contact)

Returns the blindable public key of a given contact.

Parameters
[in]contactContact
Returns
Public key of the contact

Definition at line 112 of file messenger_api_contact.c.

113{
114 GNUNET_assert (contact);
115
116 return &(contact->public_key);
117}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::public_key.

Referenced by get_epoch_member_position(), get_store_contact(), GNUNET_MESSENGER_contact_get_key(), GNUNET_MESSENGER_send_message(), handle_id_message(), remove_store_contact(), and update_store_contact().

Here is the caller graph for this function:

◆ get_contact_encryption_key()

const struct GNUNET_CRYPTO_HpkePublicKey * get_contact_encryption_key ( const struct GNUNET_MESSENGER_Contact contact,
const struct GNUNET_HashCode key 
)

Returns the HPKE public key of a given contact for a specific room that is identified via its own room key.

Parameters
[in]contactContact
[in]keyRoom key
Returns
Public key of the contact for encrypted messages

Definition at line 121 of file messenger_api_contact.c.

123{
124 GNUNET_assert ((contact) && (key));
125
127}
void * GNUNET_CONTAINER_multihashmap_get(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Given a key find a value in the map matching the key.

References GNUNET_MESSENGER_Contact::encryption_keys, GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), and key.

Referenced by GNUNET_MESSENGER_send_message().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_contact_encryption_key()

void set_contact_encryption_key ( struct GNUNET_MESSENGER_Contact contact,
const struct GNUNET_HashCode key,
const struct GNUNET_CRYPTO_HpkePublicKey encryption_key 
)

Sets or replaces the encryption_key of a given contact for a specified room that is identified via its own room key.

Parameters
[in,out]contactContact
[in]keyRoom key
[in]encryption_keyPublic key of the contact for encrypted messages

Definition at line 131 of file messenger_api_contact.c.

135{
136 GNUNET_assert ((contact) && (key));
137
138 if (! encryption_key)
139 {
141 encryption_keys,
142 key))
143 return;
144
148 }
149 else
150 {
151 struct GNUNET_CRYPTO_HpkePublicKey *hpke_key;
152
154 ;
155
156 if (! hpke_key)
157 {
158 hpke_key = GNUNET_malloc (sizeof (*hpke_key));
159
161 contact->encryption_keys, key, hpke_key,
163 {
164 GNUNET_free (hpke_key);
165 return;
166 }
167 }
168
169 GNUNET_memcpy (hpke_key, encryption_key, sizeof (*hpke_key));
170 }
171}
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap_contains(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Check if the map contains any value under the given key (including values that are NULL).
int GNUNET_CONTAINER_multihashmap_remove_all(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Remove all entries for the given key from the map.
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap_put(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap_get_multiple(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, GNUNET_CONTAINER_MultiHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map that match a particular key.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
, ' bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE...
@ GNUNET_OK
@ GNUNET_YES
#define GNUNET_malloc(size)
Wrapper around malloc.
A public key used for encryption.

References GNUNET_MESSENGER_Contact::encryption_keys, GNUNET_assert, GNUNET_CONTAINER_multihashmap_contains(), GNUNET_CONTAINER_multihashmap_get(), GNUNET_CONTAINER_multihashmap_get_multiple(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_multihashmap_remove_all(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_free, GNUNET_malloc, GNUNET_memcpy, GNUNET_OK, GNUNET_YES, iterate_free_contact_encryption_key(), and key.

Referenced by handle_join_message(), and handle_key_message().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ increase_contact_rc()

void increase_contact_rc ( struct GNUNET_MESSENGER_Contact contact)

Increases the reference counter of a given contact which is zero as default.

Parameters
[in,out]contactContact

Definition at line 175 of file messenger_api_contact.c.

176{
177 GNUNET_assert (contact);
178
179 contact->rc++;
180}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::rc.

Referenced by create_member_session(), handle_join_message(), reset_member_session(), and switch_member_session().

Here is the caller graph for this function:

◆ decrease_contact_rc()

enum GNUNET_GenericReturnValue decrease_contact_rc ( struct GNUNET_MESSENGER_Contact contact)

Decreases the reference counter if possible (can not underflow!) of a given contact and returns GNUNET_YES if the counter is equal to zero, otherwise GNUNET_NO.

Parameters
[in,out]contactContact
Returns
GNUNET_YES or GNUNET_NO depending on the reference counter

Definition at line 184 of file messenger_api_contact.c.

185{
186 GNUNET_assert (contact);
187
188 if (contact->rc > 0)
189 contact->rc--;
190
191 return contact->rc ? GNUNET_NO : GNUNET_YES;
192}

References GNUNET_assert, GNUNET_NO, GNUNET_YES, and GNUNET_MESSENGER_Contact::rc.

Referenced by check_member_session_completion(), destroy_member_session(), and handle_leave_message().

Here is the caller graph for this function:

◆ get_contact_id()

size_t get_contact_id ( const struct GNUNET_MESSENGER_Contact contact)

Returns the locally unique identifier of a given contact.

Parameters
[in]contactcontact Contact
Returns
Locally unique identifier of contact

Definition at line 196 of file messenger_api_contact.c.

197{
198 GNUNET_assert (contact);
199
200 return contact->id;
201}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::id.

Referenced by GNUNET_MESSENGER_contact_get_id().

Here is the caller graph for this function:

◆ get_context_from_member()

void get_context_from_member ( const struct GNUNET_HashCode key,
const struct GNUNET_ShortHashCode id,
struct GNUNET_HashCode context 
)

Calculates the context hash of a member in a room and returns it.

Parameters
[in]keyKey of room
[in]idMember id
[out]contextMember context

Definition at line 205 of file messenger_api_contact.c.

208{
209 GNUNET_assert ((key) && (id) && (context));
210
211 GNUNET_CRYPTO_hash (id, sizeof(*id), context);
213}
static pa_context * context
Pulseaudio context.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition crypto_hash.c:41
void GNUNET_CRYPTO_hash_xor(const struct GNUNET_HashCode *a, const struct GNUNET_HashCode *b, struct GNUNET_HashCode *result)
compute result = a ^ b

References context, GNUNET_assert, GNUNET_CRYPTO_hash(), GNUNET_CRYPTO_hash_xor(), and key.

Referenced by create_member_session(), get_handle_contact(), handle_id_message(), handle_join_message(), handle_key_message(), and switch_member_session().

Here is the call graph for this function:
Here is the caller graph for this function: