aboutsummaryrefslogtreecommitdiff
path: root/src/service/nat/gnunet-service-nat_stun.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/service/nat/gnunet-service-nat_stun.h')
-rw-r--r--src/service/nat/gnunet-service-nat_stun.h61
1 files changed, 61 insertions, 0 deletions
diff --git a/src/service/nat/gnunet-service-nat_stun.h b/src/service/nat/gnunet-service-nat_stun.h
new file mode 100644
index 000000000..912fc3b46
--- /dev/null
+++ b/src/service/nat/gnunet-service-nat_stun.h
@@ -0,0 +1,61 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2009, 2015, 2016 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 * This code provides some support for doing STUN transactions. We
22 * receive the simplest possible packet as the STUN server and try
23 * to respond properly.
24 *
25 * All STUN packets start with a simple header made of a type,
26 * length (excluding the header) and a 16-byte random transaction id.
27 * Following the header we may have zero or more attributes, each
28 * structured as a type, length and a value (whose format depends
29 * on the type, but often contains addresses).
30 * Of course all fields are in network format.
31 *
32 * This code was based on ministun.c.
33 *
34 * @file nat/gnunet-service-nat_stun.h
35 * @brief Functions for STUN functionality
36 * @author Bruno Souza Cabral
37 */
38#ifndef GNUNET_SERVICE_NAT_STUN_H
39#define GNUNET_SERVICE_NAT_STUN_H
40
41#include "platform.h"
42
43/**
44 * Handle an incoming STUN response. Do some basic sanity checks on
45 * packet size and content, try to extract information.
46 * At the moment this only processes BIND requests,
47 * and returns the externally visible address of the original
48 * request.
49 *
50 * @param data the packet
51 * @param len the length of the packet in @a data
52 * @param[out] arg sockaddr_in where we will set our discovered address
53 * @return #GNUNET_OK on success,
54 * #GNUNET_NO if the packet is invalid (not a stun packet)
55 */
56int
57GNUNET_NAT_stun_handle_packet_ (const void *data,
58 size_t len,
59 struct sockaddr_in *arg);
60
61#endif