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