1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/*
This file is part of GNU Taler
Copyright (C) 2021 Taler Systems SA
GNU Taler is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
GNU Taler 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 General Public License for more details.
You should have received a copy of the GNU General Public License along with
TALER; see the file COPYING. If not, see
<http://www.gnu.org/licenses/>
*/
/**
* @file util/secmod_common.h
* @brief Common functions for the exchange security modules
* @author Florian Dold <dold@taler.net>
*/
#ifndef SECMOD_COMMON_H
#define SECMOD_COMMON_H
#include <gnunet/gnunet_util_lib.h>
#include <gnunet/gnunet_network_lib.h>
#include <pthread.h>
/**
* Create the listen socket for a secmod daemon.
*
* This function is not thread-safe, as it changes and
* restores the process umask.
*
* @param unixpath socket path
*/
struct GNUNET_NETWORK_Handle *
TES_open_socket (const char *unixpath);
/**
* Send a message starting with @a hdr to @a sock.
*
* @param sock where to send the message
* @param hdr beginning of the message, length indicated in size field
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TES_transmit (int sock,
const struct GNUNET_MessageHeader *hdr);
/**
* Transmit @a end bytes from @a pos on @a sock.
*
* @param sock where to send the data
* @param end how many bytes to send
* @param pos first address with data
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TES_transmit_raw (int sock,
size_t end,
const void *pos);
/**
* Information we keep for a client connected to us.
*/
struct TES_Client;
/**
* Function that handles message @a hdr from @a client.
*
* @param client sender of the message
* @param hdr message we received
* @return #GNUNET_OK on success
*/
typedef enum GNUNET_GenericReturnValue
(*TES_MessageDispatch)(struct TES_Client *client,
const struct GNUNET_MessageHeader *hdr);
/**
* Function that updates the keys for @a client.
*
* @param client sender of the message
* @return #GNUNET_OK on success
*/
typedef enum GNUNET_GenericReturnValue
(*TES_KeyUpdater)(struct TES_Client *client);
/**
* Module-specific functions to be used.
*/
struct TES_Callbacks
{
/**
* Function to handle inbound messages.
*/
TES_MessageDispatch dispatch;
/**
* Function to update key material initially.
*/
TES_KeyUpdater init;
/**
* Function to update key material.
*/
TES_KeyUpdater updater;
};
/**
* Information we keep for a client connected to us.
*/
struct TES_Client
{
/**
* Kept in a DLL.
*/
struct TES_Client *next;
/**
* Kept in a DLL.
*/
struct TES_Client *prev;
/**
* Callbacks to use for work.
*/
struct TES_Callbacks cb;
/**
* Worker thread for this client.
*/
pthread_t worker;
/**
* Key generation this client is on.
*/
uint64_t key_gen;
/**
* IO-buffer used by @a purpose.
*/
char iobuf[65536];
/**
* Client socket.
*/
int csock;
/**
* Event socket.
*/
int esock;
};
/**
* Head of DLL of clients connected to us.
*/
extern struct TES_Client *TES_clients_head;
/**
* Tail of DLL of clients connected to us.
*/
extern struct TES_Client *TES_clients_tail;
/**
* Lock for the client queue.
*/
extern pthread_mutex_t TES_clients_lock;
/**
* Private key of this security module. Used to sign denomination key
* announcements.
*/
extern struct TALER_SecurityModulePrivateKeyP TES_smpriv;
/**
* Public key of this security module.
*/
extern struct TALER_SecurityModulePublicKeyP TES_smpub;
/**
* Send a signal to all clients to notify them about a key generation change.
*/
void
TES_wake_clients (void);
/**
* Read work request from the client.
*
* @param cls a `struct TES_Client *`
* @param dispatch function to call with work requests received
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TES_read_work (void *cls,
TES_MessageDispatch dispatch);
/**
* Wait until the socket is ready to read.
*
* @param client the client to wait for
* @return true if we received an event
*/
bool
TES_await_ready (struct TES_Client *client);
/**
* Free resources occupied by @a client.
*
* @param[in] client resources to release
*/
void
TES_free_client (struct TES_Client *client);
/**
* Start listen task.
*
* @param cfg configuration to use
* @param section configuration section to use
* @param cb callback functions to use
* @return 0 on success, otherwise return value to return from main()
*/
int
TES_listen_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const struct TES_Callbacks *cb);
/**
* Stop listen task.
*/
void
TES_listen_stop (void);
#endif
|
