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
252
|
/* Copyright (c) 2014, Vsevolod Stakhov
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL AUTHOR BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ADDR_H_
#define ADDR_H_
#include "config.h"
#ifdef HAVE_SYS_SOCKET_H
#include <sys/socket.h>
#endif
#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif
#ifdef HAVE_ARPA_INET_H
#include <arpa/inet.h>
#endif
/* unix sockets */
#ifdef HAVE_SYS_UN_H
#include <sys/un.h>
#endif
#include "mem_pool.h"
/**
* Opaque structure
*/
typedef struct rspamd_inet_addr_s rspamd_inet_addr_t;
/**
* Create new inet address structure based on the address familiy and opaque init pointer
* @param af
* @param init
* @return new inet addr
*/
rspamd_inet_addr_t * rspamd_inet_address_new (int af, const void *init);
/**
* Create new inet address structure from struct sockaddr
* @param sa
* @param slen
* @return
*/
rspamd_inet_addr_t * rspamd_inet_address_from_sa (const struct sockaddr *sa,
socklen_t slen);
/**
* Parse string with ipv6 address of length `len` to `target` which should be
* at least sizeof (in6_addr_t)
* @param text input string
* @param len lenth of `text` (if 0, then `text` must be zero terminated)
* @param target target structure
* @return TRUE if the address has been parsed, otherwise `target` content is undefined
*/
gboolean rspamd_parse_inet_address_ip6 (const guchar *text, gsize len,
gpointer target);
/**
* Parse string with ipv4 address of length `len` to `target` which should be
* at least sizeof (in4_addr_t)
* @param text input string
* @param len lenth of `text` (if 0, then `text` must be zero terminated)
* @param target target structure
* @return TRUE if the address has been parsed, otherwise `target` content is undefined
*/
gboolean rspamd_parse_inet_address_ip4 (const guchar *text, gsize len,
gpointer target);
/**
* Try to parse address from string
* @param target target to fill
* @param src IP string representation
* @return TRUE if addr has been parsed
*/
gboolean rspamd_parse_inet_address (rspamd_inet_addr_t **target,
const char *src,
gsize srclen);
/**
* Returns string representation of inet address
* @param addr
* @return statically allocated string pointer (not thread safe)
*/
const char * rspamd_inet_address_to_string (const rspamd_inet_addr_t *addr);
/**
* Returns port number for the specified inet address in host byte order
* @param addr
* @return
*/
uint16_t rspamd_inet_address_get_port (const rspamd_inet_addr_t *addr);
/**
* Returns address family of inet address
* @param addr
* @return
*/
gint rspamd_inet_address_get_af (const rspamd_inet_addr_t *addr);
/**
* Makes a radix key from inet address
* @param addr
* @param klen
* @return
*/
guchar * rspamd_inet_address_get_radix_key (const rspamd_inet_addr_t *addr, guint *klen);
/**
* Receive data from an unconnected socket and fill the inet_addr structure if needed
* @param fd
* @param buf
* @param len
* @param target
* @return same as recvfrom(2)
*/
gssize rspamd_inet_address_recvfrom (gint fd, void *buf, gsize len, gint fl,
rspamd_inet_addr_t **target);
/**
* Send data via unconnected socket using the specified inet_addr structure
* @param fd
* @param buf
* @param len
* @param target
* @return
*/
gssize rspamd_inet_address_sendto (gint fd, const void *buf, gsize len, gint fl,
const rspamd_inet_addr_t *addr);
/**
* Set port for inet address
*/
void rspamd_inet_address_set_port (rspamd_inet_addr_t *addr, uint16_t port);
/**
* Connect to inet_addr address
* @param addr
* @param async perform operations asynchronously
* @return newly created and connected socket
*/
int rspamd_inet_address_connect (const rspamd_inet_addr_t *addr, gint type,
gboolean async);
/**
* Listen on a specified inet address
* @param addr
* @param type
* @param async
* @return
*/
int rspamd_inet_address_listen (const rspamd_inet_addr_t *addr, gint type,
gboolean async);
/**
* Check whether specified ip is valid (not INADDR_ANY or INADDR_NONE) for ipv4 or ipv6
* @param ptr pointer to struct in_addr or struct in6_addr
* @param af address family (AF_INET or AF_INET6)
* @return TRUE if the address is valid
*/
gboolean rspamd_ip_is_valid (const rspamd_inet_addr_t *addr);
/**
* Accept from listening socket filling addr structure
* @param sock listening socket
* @param addr allocated inet addr structur
* @return
*/
gint rspamd_accept_from_socket (gint sock, rspamd_inet_addr_t **addr);
gboolean rspamd_parse_host_port_priority_strv (gchar **tokens,
GPtrArray **addrs, guint *priority,
gchar **name, guint default_port, rspamd_mempool_t *pool);
/**
* Parse host[:port[:priority]] line
* @param ina host address
* @param port port
* @param priority priority
* @return TRUE if string was parsed
*/
gboolean rspamd_parse_host_port_priority (const gchar *str,
GPtrArray **addrs,
guint *priority, gchar **name, guint default_port,
rspamd_mempool_t *pool);
/**
* Parse host:port line
* @param ina host address
* @param port port
* @return TRUE if string was parsed
*/
gboolean rspamd_parse_host_port (const gchar *str,
GPtrArray **addrs,
gchar **name, guint default_port, rspamd_mempool_t *pool);
/**
* Destroy the specified IP address
* @param addr
*/
void rspamd_inet_address_destroy (rspamd_inet_addr_t *addr);
/**
* Apply the specified mask to an address (ignored for AF_UNIX)
* @param addr
* @param mask
*/
void rspamd_inet_address_apply_mask (rspamd_inet_addr_t *addr, guint mask);
/**
* Compare a1 and a2 and return value >0, ==0 and <0 if a1 is more, equal or less than a2 correspondingly
* @param a1
* @param a2
* @return
*/
gint rspamd_inet_address_compare (const rspamd_inet_addr_t *a1,
const rspamd_inet_addr_t *a2);
/**
* Utility function to compare addresses by in g_ptr_array
* @param a1
* @param a2
* @return
*/
gint rspamd_inet_address_compare_ptr (gconstpointer a1,
gconstpointer a2);
/**
* Performs deep copy of rspamd inet addr
* @param addr
* @return
*/
rspamd_inet_addr_t *rspamd_inet_address_copy (const rspamd_inet_addr_t *addr);
#endif /* ADDR_H_ */
|
