Added config flag MY_SIGNING_FEATURE in MyConfig.h

By disabeling MY_SIGNING_FEATURE all signing logic in the library will be removed.
2015-03-16 23:15:54 +01:00
parent 7a2a5dad81
commit 70eac0423d
4 changed files with 41 additions and 5 deletions
@@ -16,6 +16,9 @@ typedef MyHwATMega328 MyHwDriver;
 /**********************************
 *  Message Signing Settings
 ***********************************/
+// Disable to completly disable signing functionality in library
+#define MY_SIGNING_FEATURE
+
 // Define a suitable timeout for a signature verification session
 // Consider the turnaround from a nonce being generated to a signed message being received
 // which might vary, especially in networks with many hops. 5s ought to be enough for anyone.
@@ -13,10 +13,12 @@

 #define DISTANCE_INVALID (0xFF)

+#ifdef MY_SIGNING_FEATURE
 // Macros for manipulating signing requirement table
 #define DO_SIGN(node) (node == 0 ? (~doSign[0]&1) : (~doSign[node>>4]&(node%16)))
 #define SET_SIGN(node) (node == 0 ? (doSign[0]&=~1) : (doSign[node>>4]&=~(node%16)))
 #define CLEAR_SIGN(node) (node == 0 ? (doSign[0]|=1) : (doSign[node>>4]|=(node%16)))
+#endif

 // Inline function and macros
 static inline MyMessage& build (MyMessage &msg, uint8_t sender, uint8_t destination, uint8_t sensor, uint8_t command, uint8_t type, bool enableAck) {
@@ -38,10 +40,16 @@ static inline bool isValidDistance( const uint8_t distance ) {
 }


-MySensor::MySensor(MyTransport &_radio, MySigning &_signer, MyHw &_hw)
+MySensor::MySensor(MyTransport &_radio, MyHw &_hw
+#ifdef MY_SIGNING_FEATURE
+	, MySigning &_signer
+#endif
+	)
 	:
 	radio(_radio),
+#ifdef MY_SIGNING_FEATURE
 	signer(_signer),
+#endif
 	hw(_hw)
 {
 }
@@ -63,8 +71,10 @@ void MySensor::begin(void (*_msgCallback)(const MyMessage &), uint8_t _nodeId, b
 	hw_readConfigBlock((void*)&nc, (void*)EEPROM_NODE_ID_ADDRESS, sizeof(NodeConfig));
 	// Read latest received controller configuration from EEPROM
 	hw_readConfigBlock((void*)&cc, (void*)EEPROM_CONTROLLER_CONFIG_ADDRESS, sizeof(ControllerConfig));
+#ifdef MY_SIGNING_FEATURE
 	// Read out the signing requirements from EEPROM
 	hw_readConfigBlock((void*)doSign, (void*)EEPROM_SIGNING_REQUIREMENT_TABLE_ADDRESS, sizeof(doSign));
+#endif

 	if (isGateway) {
 		nc.distance = 0;
@@ -128,6 +138,7 @@ void MySensor::setupNode() {

 	// Present node and request config
 	if (!isGateway && nc.nodeId != AUTO) {
+#ifdef MY_SIGNING_FEATURE
 		// Notify gateway (and possibly controller) about the signing preferences of this node
 		sendRoute(build(msg, nc.nodeId, GATEWAY_ADDRESS, NODE_SENSOR_ID, C_INTERNAL, I_REQUEST_SIGNING, false).set(signer.requestSignatures()));

@@ -135,6 +146,7 @@ void MySensor::setupNode() {
 		if (signer.requestSignatures()) {
 			wait(2000);
 		}
+#endif

 		// Send presentation for this radio node (attach
 		present(NODE_SENSOR_ID, repeaterMode? S_ARDUINO_REPEATER_NODE : S_ARDUINO_NODE);
@@ -186,6 +198,7 @@ boolean MySensor::sendRoute(MyMessage &message) {

 	mSetVersion(message, PROTOCOL_VERSION);

+#ifdef MY_SIGNING_FEATURE
 	// If destination is known to require signed messages and we are the sender, sign this message unless it is an ACK or a handshake message
 	if (DO_SIGN(message.destination) && message.sender == nc.nodeId && !mGetAck(message) && mGetLength(msg) &&
 		(mGetCommand(message) != C_INTERNAL ||
@@ -225,6 +238,7 @@ boolean MySensor::sendRoute(MyMessage &message) {
 		// After this point, only the 'last' member of the message structure is allowed to be altered if the message has been signed,
 		// or signature will become invalid and the message rejected by the receiver
 	} else mSetSigned(message, 0); // Message is not supposed to be signed, make sure it is marked unsigned
+#endif

 	if (dest == GATEWAY_ADDRESS || !repeaterMode) {
 		// If destination is the gateway or if we aren't a repeater, let
@@ -339,10 +353,13 @@ boolean MySensor::process() {
 	if (!radio.available(&to))
 		return false;

+#ifdef MY_SIGNING_FEATURE
 	(void)signer.checkTimer(); // Manage signing timeout
-	
+#endif
+
 	uint8_t len = radio.receive((uint8_t *)&msg);

+#ifdef MY_SIGNING_FEATURE
 	// Before processing message, reject unsigned messages if signing is required and check signature (if it is signed and addressed to us)
 	// Note that we do not care at all about any signature found if we do not require signing, nor do we care about ACKs (they are never signed)
 	if (signer.requestSignatures() && msg.destination == nc.nodeId && mGetLength(msg) && !mGetAck(msg) &&
@@ -360,6 +377,7 @@ boolean MySensor::process() {
 			return false; // This signed message has been tampered with!
 		}
 	}
+#endif

 	// Add string termination, good if we later would want to print it.
 	msg.data[mGetLength(msg)] = '\0';
@@ -418,6 +436,7 @@ boolean MySensor::process() {
 					}
 				}
 				return false;
+#ifdef MY_SIGNING_FEATURE
 			} else if (type == I_GET_NONCE) {
 				if (signer.getNonce(msg)) {
 					sendRoute(build(msg, nc.nodeId, msg.sender, NODE_SENSOR_ID, C_INTERNAL, I_GET_NONCE_RESPONSE, false));
@@ -446,6 +465,7 @@ boolean MySensor::process() {
 				return false; // Signing request is an internal MySensor protocol message, no need to inform caller about this
 			} else if (type == I_GET_NONCE_RESPONSE) {
 				return true; // Just pass along nonce silently (no need to call callback for these)
+#endif
 			} else if (sender == GATEWAY_ADDRESS) {
 				bool isMetric;

@@ -18,8 +18,10 @@
 #include "MyTransport.h"
 #include "MyTransportNRF24.h"
 #include "MyParser.h"
+#ifdef MY_SIGNING_FEATURE
 #include "MySigning.h"
 #include "MySigningNone.h"
+#endif
 #include "MyMessage.h"
 #include <stddef.h>
 #include <stdarg.h>
@@ -73,7 +75,11 @@ class MySensor
 	* Creates a new instance of Sensor class.
 	*
 	*/
-	MySensor(MyTransport &radio =*new MyTransportNRF24(), MySigning &signer=*new MySigningNone(), MyHw &hw=*new MyHwDriver());
+	MySensor(MyTransport &radio =*new MyTransportNRF24(), MyHw &hw=*new MyHwDriver()
+#ifdef MY_SIGNING_FEATURE
+		, MySigning &signer=*new MySigningNone()
+#endif
+		);

 	/**
 	* Begin operation of the MySensors library
@@ -233,14 +239,16 @@ class MySensor
 	bool repeaterMode;
 	bool autoFindParent;
 	bool isGateway;
-	uint16_t doSign[16]; // Bitfield indicating which sensors require signed communication

 	MyMessage msg;  // Buffer for incoming messages.
 	MyMessage tmpMsg ;  // Buffer for temporary messages (acks and nonces among others).
+#ifdef MY_SIGNING_FEATURE
+	uint16_t doSign[16]; // Bitfield indicating which sensors require signed communication
 	MyMessage msgSign;  // Buffer for message to sign.
+	MySigning& signer;
+#endif

 	MyTransport& radio;
-	MySigning& signer;
 	MyHw& hw;
 	
 	boolean sendWrite(uint8_t dest, MyMessage &message);
@@ -20,6 +20,7 @@

 MyTransportNRF24 radio;  // NRFRF24L01 radio driver
 MyHwATMega328 hw; // Select AtMega328 hardware profile
+#ifdef MY_SIGNING_FEATURE
 #ifdef MY_SECURE_NODE_WHITELISTING
 #ifdef USE_SOFTWARE_ATSHA
 // Change the soft_serial value to an arbitrary value for proper security
@@ -43,6 +44,10 @@ MySigningAtsha204 signer;
 #endif
 #endif
 MySensor gw(radio, hw, signer);
+#else
+#error SecureActuator cannot possibly be secure without signing enabled
+MySensor gw(radio, hw);
+#endif

 void setup()  
 {