src/nat/upnp-igd-parse.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /*
  22  * Code in this file is originally based on the miniupnp library.
  23  * Copyright (c) 2005-2008, Thomas BERNARD. All rights reserved.
  24  *
  25  * Original licence:
  26  *
  27  * Redistribution and use in source and binary forms, with or without
  28  * modification, are permitted provided that the following conditions are met:
  29  *
  30  *   * Redistributions of source code must retain the above copyright notice,
  31  *     this list of conditions and the following disclaimer.
  32  *   * Redistributions in binary form must reproduce the above copyright notice,
  33  *     this list of conditions and the following disclaimer in the documentation
  34  *     and/or other materials provided with the distribution.
  35  *   * The name of the author may not be used to endorse or promote products
  36  *         derived from this software without specific prior written permission.
  37  *
  38  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  39  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  41  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  42  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  43  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  44  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  45  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  46  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  47  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  48  * POSSIBILITY OF SUCH DAMAGE.
  49  */
  50
  51 /**
  52  * @file nat/upnp-igd-parse.h
  53  * @brief Parser for XML descriptions of UPnP Internet Gateway Devices
  54  *
  55  * @author Milan Bouchet-Valat
  56  */
  57 #ifndef UPNP_IGD_PARSE_H
  58 #define UPNP_IGD_PARSE_H
  59
  60 #define MINIUPNPC_URL_MAXSIZE (128)
  61
  62 /**
  63  * Structure to store the result of the parsing of UPnP
  64  * descriptions of Internet Gateway Devices.
  65  */
  66 struct UPNP_IGD_Data_
  67 {
  68   char cur_elt_name[MINIUPNPC_URL_MAXSIZE];
  69   char base_url[MINIUPNPC_URL_MAXSIZE];
  70   int level;
  71
  72   /* "urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1" */
  73   char control_url_CIF[MINIUPNPC_URL_MAXSIZE];
  74   char event_sub_url_CIF[MINIUPNPC_URL_MAXSIZE];
  75   char scpd_url_CIF[MINIUPNPC_URL_MAXSIZE];
  76   char service_type_CIF[MINIUPNPC_URL_MAXSIZE];
  77
  78   /* "urn:schemas-upnp-org:service:WANIPConnection:1"
  79    * "urn:schemas-upnp-org:service:WANPPPConnection:1" */
  80   char control_url[MINIUPNPC_URL_MAXSIZE];
  81   char event_sub_url[MINIUPNPC_URL_MAXSIZE];
  82   char scpd_url[MINIUPNPC_URL_MAXSIZE];
  83   char service_type[MINIUPNPC_URL_MAXSIZE];
  84
  85   /* Used temporarily by the parser */
  86   char control_url_tmp[MINIUPNPC_URL_MAXSIZE];
  87   char event_sub_url_tmp[MINIUPNPC_URL_MAXSIZE];
  88   char scpd_url_tmp[MINIUPNPC_URL_MAXSIZE];
  89   char service_type_tmp[MINIUPNPC_URL_MAXSIZE];
  90 };
  91
  92 /**
  93  * Parse UPnP IGD XML description to a UPNP_IGD_Data_ structure.
  94  */
  95 void
  96 UPNP_IGD_parse_desc_ (const char *buffer, int buf_size,
  97                       struct UPNP_IGD_Data_ *data);
  98
  99 #endif