src/nat/gnunet-service-nat_stun.h

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