-Merge branch 'master' of ssh://gnunet.org/gnunet into gsoc2018/rest_api
[oweals/gnunet.git] / src / nat-auto / nat-auto.h
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2011, 2016, 2017 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
19 /**
20  * @file src/nat-auto/nat-auto.h
21  * @brief Messages for interaction with gnunet-nat-auto-service
22  * @author Christian Grothoff
23  *
24  */
25 #ifndef NAT_AUTO_H
26 #define NAT_AUTO_H
27 #include "gnunet_util_lib.h"
28
29
30
31 GNUNET_NETWORK_STRUCT_BEGIN
32
33 /**
34  * Request to test NAT traversal, sent to the gnunet-nat-server
35  * (not the service!).
36  */
37 struct GNUNET_NAT_AUTO_TestMessage
38 {
39   /**
40    * Header with type #GNUNET_MESSAGE_TYPE_NAT_TEST
41    */
42   struct GNUNET_MessageHeader header;
43
44   /**
45    * IPv4 target IP address
46    */
47   uint32_t dst_ipv4;
48
49   /**
50    * Port to use, 0 to send dummy ICMP response.
51    */
52   uint16_t dport;
53
54   /**
55    * Data to send OR advertised-port (in NBO) to use for dummy ICMP.
56    */
57   uint16_t data;
58
59   /**
60    * #GNUNET_YES for TCP, #GNUNET_NO for UDP.
61    */
62   int32_t is_tcp;
63
64 };
65
66
67 /**
68  * Client requesting automatic configuration.
69  */
70 struct GNUNET_NAT_AUTO_AutoconfigRequestMessage
71 {
72   /**
73    * Header with type #GNUNET_MESSAGE_TYPE_NAT_REQUEST_AUTO_CFG
74    */
75   struct GNUNET_MessageHeader header;
76
77   /* Followed by configuration (diff, serialized, compressed) */
78   
79 };
80
81
82 /**
83  * Service responding with proposed configuration.
84  */
85 struct GNUNET_NAT_AUTO_AutoconfigResultMessage
86 {
87   /**
88    * Header with type #GNUNET_MESSAGE_TYPE_NAT_AUTO_CFG_RESULT
89    */
90   struct GNUNET_MessageHeader header;
91   
92   /**
93    * An `enum GNUNET_NAT_StatusCode` in NBO.
94    */
95   int32_t status_code GNUNET_PACKED;
96
97   /**
98    * An `enum GNUNET_NAT_Type` in NBO.
99    */
100   int32_t type GNUNET_PACKED;
101
102   /* Followed by configuration (diff, serialized, compressed) */
103 };
104
105
106 GNUNET_NETWORK_STRUCT_END
107
108 #endif