Merge branch 'master' of git+ssh://gnunet.org/gnunet

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

diff --git a/src/include/gnunet_sensor_util_lib.h b/src/include/gnunet_sensor_util_lib.h
index d1b1a925e897abd6c64220a74b08130c0d51f184..63a6fc10f5b9cce89cdea291e893f391b4bbb93a 100644 (file)
--- a/src/include/gnunet_sensor_util_lib.h
+++ b/src/include/gnunet_sensor_util_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C)
+     Copyright (C)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,14 +14,19 @@
 
      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., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
- * @file sensor/sensor_util_lib.c
- * @brief sensor utilities
  * @author Omar Tarabai
+ *
+ * @file
+ * Sensor utilities
+ *
+ * @defgroup sensor  Sensor Utilities library
+ *
+ * @{
  */
 
 #ifndef GNUNET_SENSOR_UTIL_LIB_H
@@ -124,7 +129,7 @@ struct GNUNET_SENSOR_SensorInfo
   char *gnunet_stat_name;
 
   /**
-   * Handle to statistics get request (OR GNUNET_SCHEDULER_NO_TASK)
+   * Handle to statistics get request (OR NULL)
    */
   struct GNUNET_STATISTICS_GetHandle *gnunet_stat_get_handle;
 
@@ -178,9 +183,9 @@ struct GNUNET_SENSOR_SensorInfo
   int report_anomalies;
 
   /**
-   * Execution task (OR GNUNET_SCHEDULER_NO_TASK)
+   * Execution task (OR NULL)
    */
-  GNUNET_SCHEDULER_TaskIdentifier execution_task;
+  struct GNUNET_SCHEDULER_Task * execution_task;
 
   /**
    * Is the sensor being executed
@@ -321,11 +326,6 @@ struct GNUNET_SENSOR_ValueMessage
 struct GNUNET_SENSOR_AnomalyReportMessage
 {
 
-  /**
-   * Message header
-   */
-  struct GNUNET_MessageHeader header;
-
   /**
    * Hash of sensor name
    */
@@ -415,10 +415,26 @@ struct GNUNET_SENSOR_crypto_pow_block
   struct GNUNET_CRYPTO_EddsaSignature signature;
 
   /**
-   * Purpose of signing, data is allocated after this.
+   * Size of the msg component (allocated after this struct)
+   */
+  size_t msg_size;
+
+  /**
+   * Purpose of signing.
+   * Data is allocated after this (timestamp, public_key, msg).
    */
   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
 
+  /**
+   * First part of data - timestamp
+   */
+  struct GNUNET_TIME_Absolute timestamp;
+
+  /**
+   * Second part of data - Public key
+   */
+  struct GNUNET_CRYPTO_EddsaPublicKey public_key;
+
 };
 
 
@@ -468,6 +484,27 @@ GNUNET_SENSOR_crypto_pow_sign (void *msg, size_t msg_size,
                                GNUNET_SENSOR_UTIL_pow_callback callback,
                                void *callback_cls);
 
+
+/**
+ * Verify that proof-of-work and signature in the given block are valid.
+ * If all valid, a pointer to the payload within the block is set and the size
+ * of the payload is returned.
+ *
+ * **VERY IMPORTANT** : You will still need to verify the timestamp yourself.
+ *
+ * @param block The block received and needs to be verified
+ * @param matching_bits Number of leading zeros in the hash used to verify pow
+ * @param public_key Public key of the peer that sent this block
+ * @param payload Where to store the pointer to the payload
+ * @return Size of the payload
+ */
+size_t
+GNUNET_SENSOR_crypto_verify_pow_sign (struct GNUNET_SENSOR_crypto_pow_block *
+                                      block, int matching_bits,
+                                      struct GNUNET_CRYPTO_EddsaPublicKey *
+                                      public_key, void **payload);
+
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif
@@ -477,4 +514,7 @@ GNUNET_SENSOR_crypto_pow_sign (void *msg, size_t msg_size,
 
 /* ifndef GNUNET_SENSOR_UTIL_LIB_H */
 #endif
+
+/** @} */  /* end of group */
+
 /* end of gnunet_sensor_util_lib.h */