X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_sensor_util_lib.h;h=f4eaad9e803c63649bf1c717c5f5551e509b869e;hb=0d4f151374efb1972361c40b6624bf4fd0e3fcaa;hp=3ff6097c7070c2115ddd2560d10db032e1619d46;hpb=d5d82faf0c8ef87b9bd4171f3e880ff006ec693c;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_sensor_util_lib.h b/src/include/gnunet_sensor_util_lib.h index 3ff6097c7..f4eaad9e8 100644 --- a/src/include/gnunet_sensor_util_lib.h +++ b/src/include/gnunet_sensor_util_lib.h @@ -1,27 +1,32 @@ /* 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 - 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 . - 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. + SPDX-License-Identifier: AGPL3.0-or-later */ /** - * @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 @@ -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 @@ -189,52 +194,31 @@ struct GNUNET_SENSOR_SensorInfo }; -GNUNET_NETWORK_STRUCT_BEGIN /** - * Used to communicate sensor readings to - * collection points (SENSORDASHBAORD service) + * 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_ReadingMessage +struct GNUNET_SENSOR_DashboardAnomalyEntry { /** - * GNUNET general message header - */ - struct GNUNET_MessageHeader header; - - /** - * Size of the sensor name value, allocated - * at position 0 after this struct - */ - uint16_t sensorname_size; - - /** - * First part of sensor version number - */ - uint16_t sensorversion_major; - - /** - * Second part of sensor version number - */ - uint16_t sensorversion_minor; - - /** - * Timestamp of recorded reading + * New anomaly status */ - uint64_t timestamp; + uint16_t anomalous; /** - * Size of reading value, allocation - * at poistion 1 after this struct + * Percentage of neighbors reported the same anomaly */ - uint16_t value_size; + float anomalous_neighbors; }; +GNUNET_NETWORK_STRUCT_BEGIN /** * Used to communicate brief information about a sensor. */ -struct GNUNET_SENSOR_SensorBriefMessage + struct GNUNET_SENSOR_SensorBriefMessage { /** @@ -298,13 +282,14 @@ struct GNUNET_SENSOR_SensorFullMessage }; /** - * Message carrying an anomaly status change report + * Used to communicate sensor values to + * collection points (SENSORDASHBAORD service) */ -struct AnomalyReportMessage +struct GNUNET_SENSOR_ValueMessage { /** - * Message header + * GNUNET general message header */ struct GNUNET_MessageHeader header; @@ -318,6 +303,39 @@ struct AnomalyReportMessage */ uint16_t sensorversion_major; + /** + * Second part of sensor version number + */ + uint16_t sensorversion_minor; + + /** + * Timestamp of recorded reading + */ + struct GNUNET_TIME_Absolute timestamp; + + /** + * Size of sensor value, allocated at poistion 0 after this struct + */ + uint16_t value_size; + +}; + +/** + * Message carrying an anomaly status change report + */ +struct GNUNET_SENSOR_AnomalyReportMessage +{ + + /** + * Hash of sensor name + */ + struct GNUNET_HashCode sensorname_hash; + + /** + * First part of sensor version number + */ + uint16_t sensorversion_major; + /** * Second part of sensor version name */ @@ -326,7 +344,7 @@ struct AnomalyReportMessage /** * New anomaly status */ - uint8_t anomalous; + uint16_t anomalous; /** * Percentage of neighbors reported the same anomaly @@ -336,7 +354,6 @@ struct AnomalyReportMessage }; GNUNET_NETWORK_STRUCT_END - /** * Given two version numbers as major and minor, compare them. * @@ -351,21 +368,23 @@ GNUNET_SENSOR_version_compare (uint16_t v1_major, uint16_t v1_minor, /** - * Reads sensor definitions from local data files + * Reads sensor definitions from given sensor directory. * + * @param sensordir Path to sensor directory. * @return a multihashmap of loaded sensors */ struct GNUNET_CONTAINER_MultiHashMap * -GNUNET_SENSOR_load_all_sensors (); +GNUNET_SENSOR_load_all_sensors (char *sensor_dir); -/* - * Get path to the directory containing the sensor definition files +/** + * Get path to the default directory containing the sensor definition files with + * a trailing directory separator. * - * @return sensor files directory string + * @return Default sensor files directory full path */ char * -GNUNET_SENSOR_get_sensor_dir (); +GNUNET_SENSOR_get_default_sensor_dir (); /** @@ -376,6 +395,116 @@ GNUNET_SENSOR_get_sensor_dir (); 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 @@ -385,4 +514,7 @@ GNUNET_SENSOR_destroy_sensors (struct GNUNET_CONTAINER_MultiHashMap *sensors); /* ifndef GNUNET_SENSOR_UTIL_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_sensor_util_lib.h */