X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_sensor_util_lib.h;h=f4eaad9e803c63649bf1c717c5f5551e509b869e;hb=0d4f151374efb1972361c40b6624bf4fd0e3fcaa;hp=56e0bc868ec1c4bb6f1d0d8ef3f83b8299f10a87;hpb=85e95fea731341b5bfdbb1175520220cd1d394d5;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_sensor_util_lib.h b/src/include/gnunet_sensor_util_lib.h index 56e0bc868..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 @@ -38,7 +43,7 @@ extern "C" /** * Structure containing sensor definition */ -struct SensorInfo +struct GNUNET_SENSOR_SensorInfo { /** @@ -47,140 +52,142 @@ struct SensorInfo */ struct GNUNET_CONFIGURATION_Handle *cfg; - /* + /** * Sensor name */ char *name; - /* + /** * Path to definition file */ char *def_file; - /* + /** * First part of version number */ uint16_t version_major; - /* + /** * Second part of version number */ uint16_t version_minor; - /* + /** * Sensor description */ char *description; - /* + /** * Sensor currently enabled */ int enabled; - /* + /** * Category under which the sensor falls (e.g. tcp, datastore) */ char *category; - /* + /** * When does the sensor become active */ struct GNUNET_TIME_Absolute *start_time; - /* + /** * When does the sensor expire */ struct GNUNET_TIME_Absolute *end_time; - /* + /** * Time interval to collect sensor information (e.g. every 1 min) */ struct GNUNET_TIME_Relative interval; - /* + /** * Lifetime of an information sample after which it is deleted from storage * If not supplied, will default to the interval value */ struct GNUNET_TIME_Relative lifetime; - /* + /** * A set of required peer capabilities for the sensor to collect meaningful information (e.g. ipv6) */ char *capabilities; - /* + /** * Either "gnunet-statistics" or external "process" */ char *source; - /* + /** * Name of the GNUnet service that is the source for the gnunet-statistics entry */ char *gnunet_stat_service; - /* + /** * Name of the gnunet-statistics entry */ 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; - /* + /** * Name of the external process to be executed */ char *ext_process; - /* + /** * Arguments to be passed to the external process */ char *ext_args; - /* + /** * Handle to the external process */ struct GNUNET_OS_CommandHandle *ext_cmd; - /* + /** * Did we already receive a value * from the currently running external * proccess ? #GNUNET_YES / #GNUNET_NO */ int ext_cmd_value_received; - /* + /** * The output datatype to be expected */ char *expected_datatype; - /* + /** * Peer-identity of peer running collection point */ struct GNUNET_PeerIdentity *collection_point; - /* - * Time interval to send sensor information to collection point (e.g. every 30 mins) + /** + * Do we report received sensor values to collection point? + * #GNUNET_YES / #GNUNET_NO */ - struct GNUNET_TIME_Relative collection_interval; + int report_values; - /* - * Flag specifying if value is to be communicated to the p2p network + /** + * Time interval to send sensor values to collection point (e.g. every 30 mins) */ - int p2p_report; + struct GNUNET_TIME_Relative value_reporting_interval; - /* - * Time interval to communicate value to the p2p network + /** + * Do we report anomalies to collection point? + * #GNUNET_YES / #GNUNET_NO */ - struct GNUNET_TIME_Relative p2p_interval; + 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 */ int running; @@ -188,40 +195,97 @@ struct SensorInfo }; /** - * Carries a single reading from a sensor + * 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_Reading +struct GNUNET_SENSOR_DashboardAnomalyEntry { /** - * Sensor this reading is related to + * New anomaly status */ - struct SensorInfo *sensor; + uint16_t anomalous; /** - * Timestamp of taking the reading + * Percentage of neighbors reported the same anomaly */ - uint64_t timestamp; + float anomalous_neighbors; + +}; + +GNUNET_NETWORK_STRUCT_BEGIN +/** + * Used to communicate brief information about a sensor. + */ + struct GNUNET_SENSOR_SensorBriefMessage +{ /** - * Reading value + * GNUNET general message header. */ - void *value; + struct GNUNET_MessageHeader header; /** - * Size of @value + * Size of sensor name string, allocated at position 0 after this struct. */ - uint16_t value_size; + uint16_t name_size; + + /** + * First part of sensor version number + */ + uint16_t version_major; + + /** + * Second part of sensor version number + */ + uint16_t version_minor; }; -GNUNET_NETWORK_STRUCT_BEGIN +/** + * Used to communicate full information about a sensor. + */ +struct GNUNET_SENSOR_SensorFullMessage +{ + + /** + * GNUNET general message header. + */ + struct GNUNET_MessageHeader header; + + /** + * Size of sensor name. + * Name allocated at position 0 after this struct. + */ + uint16_t sensorname_size; + + /** + * Size of the sensor definition file carrying full sensor information. + * The file content allocated at position 1 after this struct. + */ + uint16_t sensorfile_size; + + /** + * Name of the file (usually script) associated with this sensor. + * At the moment we only support having one file per sensor. + * The file name is allocated at position 2 after this struct. + */ + uint16_t scriptname_size; + + /** + * Size of the file (usually script) associated with this sensor. + * The file content is allocated at position 3 after this struct. + */ + uint16_t scriptfile_size; + +}; /** - * Used to communicate sensor readings to + * Used to communicate sensor values to * collection points (SENSORDASHBAORD service) */ -struct GNUNET_SENSOR_ReadingMessage +struct GNUNET_SENSOR_ValueMessage { /** @@ -230,10 +294,9 @@ struct GNUNET_SENSOR_ReadingMessage struct GNUNET_MessageHeader header; /** - * Size of the sensor name value, allocated - * at position 0 after this struct + * Hash of sensor name */ - uint16_t sensorname_size; + struct GNUNET_HashCode sensorname_hash; /** * First part of sensor version number @@ -248,43 +311,81 @@ struct GNUNET_SENSOR_ReadingMessage /** * Timestamp of recorded reading */ - uint64_t timestamp; + struct GNUNET_TIME_Absolute timestamp; /** - * Size of reading value, allocation - * at poistion 1 after this struct + * 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 + */ + uint16_t sensorversion_minor; + + /** + * New anomaly status + */ + uint16_t anomalous; + + /** + * Percentage of neighbors reported the same anomaly + */ + float anomalous_neighbors; + +}; + GNUNET_NETWORK_STRUCT_END +/** + * Given two version numbers as major and minor, compare them. + * + * @param v1_major First part of first version number + * @param v1_minor Second part of first version number + * @param v2_major First part of second version number + * @param v2_minor Second part of second version number + */ + int +GNUNET_SENSOR_version_compare (uint16_t v1_major, uint16_t v1_minor, + uint16_t v2_major, uint16_t v2_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 - * - * @return sensor files directory - */ -char * -GNUNET_SENSOR_get_sensor_dir (); /** - * Parses a sensor reading message struct + * Get path to the default directory containing the sensor definition files with + * a trailing directory separator. * - * @param msg message header received - * @param sensors multihashmap of loaded sensors - * @return sensor reading struct or NULL if error + * @return Default sensor files directory full path */ -struct GNUNET_SENSOR_Reading * -GNUNET_SENSOR_parse_reading_message (const struct GNUNET_MessageHeader *msg, - struct GNUNET_CONTAINER_MultiHashMap *sensors); +char * +GNUNET_SENSOR_get_default_sensor_dir (); + /** * Destroys a group of sensors in a hashmap and the hashmap itself @@ -294,6 +395,116 @@ GNUNET_SENSOR_parse_reading_message (const struct GNUNET_MessageHeader *msg, 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 @@ -303,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 */