/*
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
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 senor utilities
* @author Omar Tarabai
+ *
+ * @file
+ * Sensor utilities
+ *
+ * @defgroup sensor Sensor Utilities library
+ *
+ * @{
*/
#ifndef GNUNET_SENSOR_UTIL_LIB_H
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;
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
};
-GNUNET_NETWORK_STRUCT_BEGIN
+/**
+ * Anomaly report received and stored by sensor dashboard.
+ * Sensor name and peer id are not included because they are part of the
+ * peerstore key.
+ */
+struct GNUNET_SENSOR_DashboardAnomalyEntry
+{
+ /**
+ * New anomaly status
+ */
+ uint16_t anomalous;
+
+ /**
+ * Percentage of neighbors reported the same anomaly
+ */
+ float anomalous_neighbors;
+
+};
+
+GNUNET_NETWORK_STRUCT_BEGIN
/**
* Used to communicate brief information about a sensor.
*/
-struct GNUNET_SENSOR_SensorBriefMessage
+ struct GNUNET_SENSOR_SensorBriefMessage
{
/**
* Used to communicate sensor values to
* collection points (SENSORDASHBAORD service)
*/
- struct GNUNET_SENSOR_ValueMessage
+struct GNUNET_SENSOR_ValueMessage
{
/**
struct GNUNET_SENSOR_AnomalyReportMessage
{
- /**
- * Message header
- */
- struct GNUNET_MessageHeader header;
-
/**
* Hash of sensor name
*/
/**
* New anomaly status
*/
- uint8_t anomalous;
+ uint16_t anomalous;
/**
* Percentage of neighbors reported the same anomaly
};
GNUNET_NETWORK_STRUCT_END
-
/**
* Given two version numbers as major and minor, compare them.
*
void
GNUNET_SENSOR_destroy_sensors (struct GNUNET_CONTAINER_MultiHashMap *sensors);
+
+struct GNUNET_SENSOR_crypto_pow_context;
+
+/**
+ * Block carrying arbitrary data + its proof-of-work + signature
+ */
+struct GNUNET_SENSOR_crypto_pow_block
+{
+
+ /**
+ * Proof-of-work value
+ */
+ uint64_t pow;
+
+ /**
+ * Data signature
+ */
+ struct GNUNET_CRYPTO_EddsaSignature signature;
+
+ /**
+ * 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;
+
+};
+
+
+/**
+ * Continuation called with a status result.
+ *
+ * @param cls closure
+ * @param pow Proof-of-work value
+ * @param purpose Signed block (size, purpose, data)
+ * @param signature Signature, NULL on error
+ */
+typedef void (*GNUNET_SENSOR_UTIL_pow_callback) (void *cls,
+ struct
+ GNUNET_SENSOR_crypto_pow_block
+ * block);
+
+
+/**
+ * Cancel an operation started by #GNUNET_SENSOR_crypto_pow_sign().
+ * Call only before callback function passed to #GNUNET_SENSOR_crypto_pow_sign()
+ * is called with the result.
+ */
+void
+GNUNET_SENSOR_crypto_pow_sign_cancel (struct GNUNET_SENSOR_crypto_pow_context
+ *cx);
+
+
+/**
+ * Calculate proof-of-work and sign a message.
+ *
+ * @param msg Message to calculate pow and sign
+ * @param msg_size size of msg
+ * @param timestamp Timestamp to add to the message to protect against replay attacks
+ * @param public_key Public key of the origin peer, to protect against redirect attacks
+ * @param private_key Private key of the origin peer to sign the result
+ * @param matching_bits Number of leading zeros required in the result hash
+ * @param callback Callback function to call with the result
+ * @param callback_cls Closure for callback
+ * @return Operation context
+ */
+struct GNUNET_SENSOR_crypto_pow_context *
+GNUNET_SENSOR_crypto_pow_sign (void *msg, size_t msg_size,
+ struct GNUNET_TIME_Absolute *timestamp,
+ struct GNUNET_CRYPTO_EddsaPublicKey *public_key,
+ struct GNUNET_CRYPTO_EddsaPrivateKey
+ *private_key, int matching_bits,
+ 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
/* ifndef GNUNET_SENSOR_UTIL_LIB_H */
#endif
+
+/** @} */ /* end of group */
+
/* end of gnunet_sensor_util_lib.h */
projects / oweals / gnunet.git / blobdiff