src/nse/nse.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-2011 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 2, 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  * @author Nathan Evans
  23  * @file nse/nse.h
  24  *
  25  * @brief Common type definitions for the network size estimation
  26  *        service and API.
  27  */
  28 #ifndef NSE_H
  29 #define NSE_H
  30
  31 #include "gnunet_common.h"
  32
  33 #define DEBUG_NSE GNUNET_YES
  34
  35
  36 /**
  37  * Network size estimate sent from the service
  38  * to clients.  Contains the current size estimate
  39  * (or 0 if none has been calculated) and the
  40  * standard deviation of known estimates.
  41  *
  42  */
  43 struct GNUNET_NSE_ClientMessage
  44 {
  45   /**
  46    * Type:  GNUNET_MESSAGE_TYPE_NSE_UPDATE
  47    */
  48   struct GNUNET_MessageHeader header;
  49
  50   /*
  51    * The current estimated network size.
  52    */
  53   double size_estimate;
  54
  55   /**
  56    * The standard deviation (rounded down
  57    * to the nearest integer) of size
  58    * estimations.
  59    */
  60   double std_deviation;
  61 };
  62
  63 /**
  64  * Network size estimate reply; sent when "this"
  65  * peer's timer has run out before receiving a
  66  * valid reply from another peer.
  67  *
  68  * FIXME: Is this the right way to do this?
  69  * I think we need to include both the public
  70  * key and the timestamp signed by the private
  71  * key.  This way a recipient
  72  * can verify that the peer at least generated
  73  * the public/private key pair, and that the
  74  * timestamp matches what the current peer
  75  * believes it should be.  The receiving peer
  76  * would then check whether the XOR of the peer
  77  * identity and the timestamp is within a
  78  * reasonable range of the current time
  79  * (+/- N seconds).  If a closer message which
  80  * also verifies hasn't been received (or this
  81  * message is a duplicate), the peer
  82  * calculates the size estimate and forwards
  83  * the request to all other peers.
  84  *
  85  * Hmm... Is it enought to *just* send the peer
  86  * identity?  Obviously this is smaller, but it
  87  * doesn't allow us to verify that the
  88  * public/private key pair were generated, right?
  89  */
  90 struct GNUNET_NSE_FloodMessage
  91 {
  92   /**
  93    * Type: GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD
  94    */
  95   struct GNUNET_MessageHeader header;
  96
  97   /**
  98    * Magic header code(?)
  99    */
 100   uint16_t enc_type;
 101
 102   /**
 103    * Number of matching bits between the hash
 104    * of timestamp and the initiator's public
 105    * key.
 106    */
 107   uint16_t distance;
 108
 109   /**
 110    * The current timestamp value (which all
 111    * peers should agree on).
 112    */
 113   struct GNUNET_TIME_AbsoluteNBO timestamp;
 114
 115   /**
 116    * Public key of the originator.
 117    */
 118   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pkey;
 119
 120   /**
 121    * FIXME: use, document.
 122    */
 123   uint32_t proof_of_work;
 124
 125   /**
 126    * FIXME: use, document.
 127    */
 128   struct GNUNET_CRYPTO_RsaSignature signature;
 129 };
 130
 131 #endif