summaryrefslogtreecommitdiff
path: root/src/nat/nat.h
blob: 86de3c2f637e23dfa48cf9c374e48d05fecda3c7 (plain) (blame)
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
/*
     This file is part of GNUnet.
     Copyright (C) 2011, 2016 GNUnet e.V.

     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.

     GNUnet 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
     Affero General Public License for more details.
    
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.

     SPDX-License-Identifier: AGPL3.0-or-later
*/

/**
 * @file src/nat/nat.h
 * @brief Messages for interaction with gnunet-nat-server and gnunet-nat-service
 * @author Christian Grothoff
 *
 */
#ifndef NAT_H
#define NAT_H
#include "gnunet_util_lib.h"



GNUNET_NETWORK_STRUCT_BEGIN

/**
 * Request to test NAT traversal, sent to the gnunet-nat-server
 * (not the service!).
 */
struct GNUNET_NAT_TestMessage
{
  /**
   * Header with type #GNUNET_MESSAGE_TYPE_NAT_TEST
   */
  struct GNUNET_MessageHeader header;

  /**
   * IPv4 target IP address
   */
  uint32_t dst_ipv4;

  /**
   * Port to use, 0 to send dummy ICMP response.
   */
  uint16_t dport;

  /**
   * Data to send OR advertised-port (in NBO) to use for dummy ICMP.
   */
  uint16_t data;

  /**
   * #GNUNET_YES for TCP, #GNUNET_NO for UDP.
   */
  int32_t is_tcp;

};


/**
 * Flags specifying the events this client would be
 * interested in being told about.
 */
enum GNUNET_NAT_RegisterFlags
{
  /**
   * This client does not want any notifications.
   */
  GNUNET_NAT_RF_NONE = 0,

  /**
   * This client wants to be informed about changes to our
   * applicable addresses.
   */
  GNUNET_NAT_RF_ADDRESSES = 1,

  /**
   * This client supports address reversal.
   */
  GNUNET_NAT_RF_REVERSAL = 2
};


/**
 * Message sent by a client to register with its addresses.
 */
struct GNUNET_NAT_RegisterMessage
{
  /**
   * Header with type #GNUNET_MESSAGE_TYPE_NAT_REGISTER
   */
  struct GNUNET_MessageHeader header;

  /**
   * An `enum GNUNET_NAT_RegisterFlags`.
   */
  uint8_t flags;

  /**
   * Client's IPPROTO, e.g. IPPROTO_UDP or IPPROTO_TCP.
   */
  uint8_t proto;

  /**
   * Number of bytes in the string that follow which
   * specifies a section name in the configuration.
   */
  uint16_t str_len GNUNET_PACKED;

  /**
   * Number of addresses that this service is bound to that follow.
   * Given as an array of "struct sockaddr" entries, the size of
   * each entry being determined by the "sa_family" at the beginning.
   */
  uint16_t num_addrs GNUNET_PACKED;

  /* Followed by @e num_addrs addresses of type 'struct
     sockaddr' */

  /* Followed by @e str_len section name to use for options */
  
};


/**
 * Client telling the service to (possibly) handle a STUN message.
 */
struct GNUNET_NAT_HandleStunMessage
{
  /**
   * Header with type #GNUNET_MESSAGE_TYPE_NAT_HANDLE_STUN
   */
  struct GNUNET_MessageHeader header;

  /**
   * Size of the sender address included, in NBO.
   */
  uint16_t sender_addr_size;

  /**
   * Number of bytes of payload included, in NBO.
   */
  uint16_t payload_size;

  /* followed by a `struct sockaddr` of @e sender_addr_size bytes */

  /* followed by payload with @e payload_size bytes */
};


/**
 * Client asking the service to initiate connection reversal.
 */
struct GNUNET_NAT_RequestConnectionReversalMessage
{
  /**
   * Header with type #GNUNET_MESSAGE_TYPE_NAT_REQUEST_CONNECTION_REVERSAL
   */
  struct GNUNET_MessageHeader header;

  /**
   * Size of the local address included, in NBO.
   */
  uint16_t local_addr_size;

  /**
   * Size of the remote address included, in NBO.
   */
  uint16_t remote_addr_size;

  /* followed by a `struct sockaddr` of @e local_addr_size bytes */

  /* followed by a `struct sockaddr` of @e remote_addr_size bytes */

};


/**
 * Service telling a client that connection reversal was requested.
 */
struct GNUNET_NAT_ConnectionReversalRequestedMessage
{
  /**
   * Header with type #GNUNET_MESSAGE_TYPE_NAT_CONNECTION_REVERSAL_REQUESTED
   */
  struct GNUNET_MessageHeader header;

  /* followed by a `struct sockaddr_in` */
  
};


/**
 * Service notifying the client about changes in the set of 
 * addresses it has.
 */
struct GNUNET_NAT_AddressChangeNotificationMessage
{
  /**
   * Header with type #GNUNET_MESSAGE_TYPE_NAT_ADDRESS_CHANGE
   */
  struct GNUNET_MessageHeader header;

  /**
   * #GNUNET_YES to add, #GNUNET_NO to remove the address from the list.
   */ 
  int32_t add_remove GNUNET_PACKED;

  /**
   * Type of the address, an `enum GNUNET_NAT_AddressClass` in NBO.
   */
  uint32_t addr_class GNUNET_PACKED;
  /* followed by a `struct sockaddr` */
  
};


GNUNET_NETWORK_STRUCT_END

#endif