externalizing secushare logic

[oweals/gnunet.git] / src / include / gnunet_transport_hello_service.h

diff --git a/src/include/gnunet_transport_hello_service.h b/src/include/gnunet_transport_hello_service.h
index 8573613acbcc8c0e509a8f62ab26f78ffe978055..d568c621ee3a1f759852c5d163348f99b99891a4 100644 (file)
--- a/src/include/gnunet_transport_hello_service.h
+++ b/src/include/gnunet_transport_hello_service.h
@@ -2,20 +2,20 @@
      This file is part of GNUnet.
      Copyright (C) 2009-2016 GNUnet e.V.
 
-     GNUnet is free software; you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-     Boston, MA 02110-1301, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
@@ -51,6 +51,66 @@ extern "C"
 #define GNUNET_TRANSPORT_HELLO_VERSION 0x00000000
 
 
+/**
+ * Some addresses contain sensitive information or are
+ * not suitable for global distribution.  We use address
+ * classes to filter addresses by which domain they make
+ * sense to be used in.  These are used in a bitmask.
+ */
+enum GNUNET_TRANSPORT_AddressClass
+{
+
+  /**
+   * No address.
+   */
+  GNUNET_TRANSPORT_AC_NONE = 0,
+
+  /**
+   * Addresses that fall into no other category
+   * (i.e. incoming which we cannot use elsewhere).
+   */
+  GNUNET_TRANSPORT_AC_OTHER = 1,
+
+  /**
+   * Addresses that are global and are insensitive
+   * (i.e. IPv4).
+   */
+  GNUNET_TRANSPORT_AC_GLOBAL = 2,
+
+  /**
+   * Addresses that are global and are sensitive
+   * (i.e. IPv6 with our MAC).
+   */
+  GNUNET_TRANSPORT_AC_GLOBAL_PRIVATE = 4,
+
+  /**
+   * Addresses useful in the local wired network,
+   * i.e. a MAC.  Sensitive, but obvious to people nearby.
+   * Useful for broadcasts.
+   */
+  GNUNET_TRANSPORT_AC_LAN = 8,
+
+  /**
+   * Addresses useful in the local wireless network,
+   * i.e. a MAC.  Sensitive, but obvious to people nearby.
+   * Useful for broadcasts.
+   */
+  GNUNET_TRANSPORT_AC_WLAN = 16,
+
+  /**
+   * Addresses useful in the local bluetooth network.  Sensitive, but
+   * obvious to people nearby.  Useful for broadcasts.
+   */
+  GNUNET_TRANSPORT_AC_BT = 32,
+
+  /**
+   * Bitmask for "any" address.
+   */
+  GNUNET_TRANSPORT_AC_ANY = 65535
+  
+};
+
+
 /**
  * Function called whenever there is an update to the
  * HELLO of this peer.
@@ -74,14 +134,14 @@ struct GNUNET_TRANSPORT_HelloGetHandle;
  * given in this function is never called synchronously.
  *
  * @param cfg configuration to use
- * @param nt which network type should the addresses from the HELLO belong to?
+ * @param ac which network type should the addresses from the HELLO belong to?
  * @param rec function to call with the HELLO
  * @param rec_cls closure for @a rec
  * @return handle to cancel the operation
  */
 struct GNUNET_TRANSPORT_HelloGetHandle *
 GNUNET_TRANSPORT_hello_get (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                            enum GNUNET_ATS_Network_Type nt,
+                            enum GNUNET_TRANSPORT_AddressClass ac,
                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
                             void *rec_cls);
 
@@ -108,7 +168,7 @@ typedef void
 (*GNUNET_TRANSPORT_AddressCallback) (void *cls,
                                      const struct GNUNET_PeerIdentity *peer,
                                      const char *address,
-                                     enum GNUNET_ATS_Network_Type nt,
+                                     enum GNUNET_NetworkType nt,
                                      struct GNUNET_TIME_Absolute expiration);