diff options
Diffstat (limited to 'src/service/messenger/messenger_api_util.h')
-rw-r--r-- | src/service/messenger/messenger_api_util.h | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/src/service/messenger/messenger_api_util.h b/src/service/messenger/messenger_api_util.h new file mode 100644 index 000000000..877491c93 --- /dev/null +++ b/src/service/messenger/messenger_api_util.h | |||
@@ -0,0 +1,95 @@ | |||
1 | /* | ||
2 | This file is part of GNUnet. | ||
3 | Copyright (C) 2020--2024 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 | */ | ||
20 | /** | ||
21 | * @author Tobias Frisch | ||
22 | * @file src/messenger/messenger_api_util.h | ||
23 | * @brief messenger api: client implementation of GNUnet MESSENGER service | ||
24 | */ | ||
25 | |||
26 | #ifndef GNUNET_SERVICE_MESSENGER_UTIL_H | ||
27 | #define GNUNET_SERVICE_MESSENGER_UTIL_H | ||
28 | |||
29 | #include "gnunet_cadet_service.h" | ||
30 | #include "gnunet_util_lib.h" | ||
31 | |||
32 | /** | ||
33 | * Starts an urgent task to close a CADET channel asynchronously. | ||
34 | * | ||
35 | * @param[in,out] channel Channel | ||
36 | */ | ||
37 | void | ||
38 | delayed_disconnect_channel (struct GNUNET_CADET_Channel *channel); | ||
39 | |||
40 | /** | ||
41 | * Tries to generate an unused member id and store it into the <i>id</i> parameter. | ||
42 | * A map containing all currently used member ids is used to check against. | ||
43 | * | ||
44 | * @param[out] id New member id | ||
45 | * @param[in] members Map of member ids | ||
46 | * @return #GNUNET_YES on success, #GNUNET_NO on failure | ||
47 | */ | ||
48 | enum GNUNET_GenericReturnValue | ||
49 | generate_free_member_id (struct GNUNET_ShortHashCode *id, | ||
50 | const struct GNUNET_CONTAINER_MultiShortmap *members); | ||
51 | |||
52 | /** | ||
53 | * Returns the private identity key of #GNUNET_IDENTITY_ego_get_anonymous() without | ||
54 | * recalculating it every time. | ||
55 | * | ||
56 | * @return anonymous private key | ||
57 | */ | ||
58 | const struct GNUNET_CRYPTO_PrivateKey* | ||
59 | get_anonymous_private_key (); | ||
60 | |||
61 | /** | ||
62 | * Returns the public identity key of #GNUNET_IDENTITY_ego_get_anonymous() without | ||
63 | * recalculating it every time. | ||
64 | * | ||
65 | * @return anonymous public key | ||
66 | */ | ||
67 | const struct GNUNET_CRYPTO_PublicKey* | ||
68 | get_anonymous_public_key (); | ||
69 | |||
70 | /** | ||
71 | * Converts a Messenger service key of a room to the specific port which | ||
72 | * gets used for the CADET channels. | ||
73 | * | ||
74 | * The port includes upper bits of the #GNUNET_MESSENGER_VERSION to | ||
75 | * reduce the chance of incompatible connections. | ||
76 | * | ||
77 | * @param[in] key Messenger service room key | ||
78 | * @param[out] port CADET service port | ||
79 | */ | ||
80 | void | ||
81 | convert_messenger_key_to_port (const struct GNUNET_HashCode *key, | ||
82 | struct GNUNET_HashCode *port); | ||
83 | |||
84 | /** | ||
85 | * Converts a peers identity to a short hash code which can be used | ||
86 | * as id to refer to a peer via sender id as attached in messages. | ||
87 | * | ||
88 | * @param[in] identity Peer identity | ||
89 | * @param[out] id Short peer id | ||
90 | */ | ||
91 | void | ||
92 | convert_peer_identity_to_id (const struct GNUNET_PeerIdentity *identity, | ||
93 | struct GNUNET_ShortHashCode *id); | ||
94 | |||
95 | #endif //GNUNET_SERVICE_MESSENGER_UTIL_H | ||