Files
MySensors/hal/transport/MyTransportRFM69.cpp
T
Marcelo Aquino 28c4f3f19e Signing improvements package (#871)
* Signing support with MAX_PAYLOAD>32

Support in the signing backends to handle configurations
where MAX_PAYLOAD is more than 32 bytes.

Fixes #748

* Support big message signatures

Support for signing messages larger than 32 bytes.
This is not fully testable with the current version of
the library but the change would add theoretical support
for signing any sized messages.

Fixes #749

* Have gw properly indicate whitelisting preferences

If the gateway hold a signing whitelist, inform all
nodes of this requirement and not just nodes that hold
whitelists themselves.

Fixes #806

* Harden security

The flag MY_SIGNING_GW_REQUEST_SIGNATURES_FROM_ALL
has been removed. Gateway will now request signatures
from everyone by default.
In addition to this, no nodes in the network will allow
clearing of signing/whitelisting preferences by OTA
commands by default.
If the old behaviour is needed (suitable for gradual
signing roll out and development purposes) a new flag,
MY_SIGNING_WEAK_SECURITY can be set.

Fixes #807

* Signing debug messages rewritten

All signing related debug has been rewritten to
better match other core debug printouts.
Also, backends are updated to have a smaller
implementation delta.

* Simplified signing option implemented

Enable by MY_SIGNING_SIMPLE_PASSWD. Signing, and signing requirements
will be enabled, as will encryption. Whitelisting is optional.
The value provided to MY_SIGNING_SIMPLE_PASSWD is used as HMAC and AES
key. Whitelists use the first 8 bytes of the password and the ninth
byte from the node ID as serial.
Password is required to be at least 8 characters wide. It is zero
padded if it is not long enough to cover the AES (16 bytes) and HMAC
(32 bytes) keys. It is not recommended to have a password shorter than
32 bytes, and there is no need for a password longer than 32 bytes.

* Add documentation section for signing debug

* Add nRF5 encryption to simple signing option

* Restructure MySigning documentation

* Minor fixes for Linux
2017-05-31 17:13:29 +02:00

276 lines
5.6 KiB
C++

/*
* The MySensors Arduino library handles the wireless radio link and protocol
* between your home built sensors/actuators and HA controller of choice.
* The sensors forms a self healing radio network with optional repeaters. Each
* repeater and gateway builds a routing tables in EEPROM which keeps track of the
* network topology allowing messages to be routed to nodes.
*
* Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
* Copyright (C) 2013-2017 Sensnology AB
* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
*
* Documentation: http://www.mysensors.org
* Support Forum: http://forum.mysensors.org
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* version 2 as published by the Free Software Foundation.
*/
#include "MyTransportHAL.h"
#if defined(MY_RFM69_NEW_DRIVER)
#include "drivers/RFM69/new/RFM69_new.h"
bool transportInit(void)
{
const bool result = RFM69_initialise(MY_RFM69_FREQUENCY);
#if !defined(MY_GATEWAY_FEATURE) && !defined(MY_RFM69_ATC_MODE_DISABLED)
// only enable ATC mode nodes
RFM69_ATCmode(true, MY_RFM69_ATC_TARGET_RSSI_DBM);
#endif
#ifdef MY_RFM69_ENABLE_ENCRYPTION
uint8_t _psk[16];
#ifdef MY_SIGNING_SIMPLE_PASSWD
memset(_psk, 0, 16);
memcpy(_psk, MY_SIGNING_SIMPLE_PASSWD, strnlen(MY_SIGNING_SIMPLE_PASSWD, 16));
#else
hwReadConfigBlock((void*)_psk, (void*)EEPROM_RF_ENCRYPTION_AES_KEY_ADDRESS, 16);
#endif
RFM69_encrypt((const char*)_psk);
(void)memset(_psk, 0, 16); // Make sure it is purged from memory when set
#endif
return result;
}
void transportSetAddress(const uint8_t address)
{
RFM69_setAddress(address);
}
uint8_t transportGetAddress(void)
{
return RFM69_getAddress();
}
bool transportSend(const uint8_t to, const void* data, uint8_t len, const bool noACK)
{
if (noACK) {
(void)RFM69_sendWithRetry(to, data, len, 0, 0);
return true;
}
return RFM69_sendWithRetry(to, data, len);
}
bool transportAvailable(void)
{
return RFM69_available();
}
bool transportSanityCheck(void)
{
return RFM69_sanityCheck();
}
uint8_t transportReceive(void* data)
{
return RFM69_recv((uint8_t*)data, MAX_MESSAGE_LENGTH);
}
void transportSleep(void)
{
(void)RFM69_sleep();
}
void transportStandBy(void)
{
(void)RFM69_standBy();
}
void transportPowerDown(void)
{
(void)RFM69_powerDown();
}
void transportPowerUp(void)
{
(void)RFM69_powerUp();
}
bool transportSetTxPowerLevel(const uint8_t powerLevel)
{
// range 0..23
return RFM69_setTxPowerLevel(powerLevel);
}
void transportSetTargetRSSI(int16_t targetSignalStrength)
{
#if !defined(MY_GATEWAY_FEATURE) && !defined(MY_RFM69_ATC_MODE_DISABLED)
RFM69_ATCmode(true, targetSignalStrength);
#else
(void)targetSignalStrength;
#endif
}
int16_t transportGetSendingRSSI(void)
{
return RFM69_getSendingRSSI();
}
int16_t transportGetReceivingRSSI(void)
{
return RFM69_getReceivingRSSI();
}
int16_t transportGetSendingSNR(void)
{
return INVALID_SNR;
}
int16_t transportGetReceivingSNR(void)
{
return INVALID_SNR;
}
int16_t transportGetTxPowerPercent(void)
{
return RFM69_getTxPowerPercent();
}
int16_t transportGetTxPowerLevel(void)
{
return RFM69_getTxPowerLevel();
}
bool transportSetTxPowerPercent(const uint8_t powerPercent)
{
return RFM69_setTxPowerPercent(powerPercent);
}
#else
#include "drivers/RFM69/old/RFM69_old.h"
RFM69 _radio(MY_RFM69_CS_PIN, MY_RFM69_IRQ_PIN, MY_RFM69HW, MY_RFM69_IRQ_NUM);
uint8_t _address;
bool transportInit(void)
{
#if defined(MY_RFM69_POWER_PIN)
//hwPinMode(MY_RFM69_POWER_PIN, OUTPUT);
#endif
#ifdef MY_RF69_DIO5
//hwPinMode(MY_RF69_DIO5, INPUT);
#endif
// Start up the radio library (_address will be set later by the MySensors library)
if (_radio.initialize(MY_RFM69_FREQUENCY, _address, MY_RFM69_NETWORKID)) {
#ifdef MY_RFM69_ENABLE_ENCRYPTION
uint8_t _psk[16];
#ifdef MY_SIGNING_SIMPLE_PASSWD
memset(_psk, 0, 16);
memcpy(_psk, MY_SIGNING_SIMPLE_PASSWD, strnlen(MY_SIGNING_SIMPLE_PASSWD, 16));
#else
hwReadConfigBlock((void*)_psk, (void*)EEPROM_RF_ENCRYPTION_AES_KEY_ADDRESS, 16);
#endif
_radio.encrypt((const char*)_psk);
(void)memset(_psk, 0, 16); // Make sure it is purged from memory when set
#endif
return true;
}
return false;
}
void transportSetAddress(const uint8_t address)
{
_address = address;
_radio.setAddress(address);
}
uint8_t transportGetAddress(void)
{
return _address;
}
bool transportSend(const uint8_t to, const void* data, const uint8_t len, const bool noACK)
{
if (noACK) {
(void)_radio.sendWithRetry(to, data, len, 0, 0);
return true;
}
return _radio.sendWithRetry(to, data, len);
}
bool transportAvailable(void)
{
return _radio.receiveDone();
}
bool transportSanityCheck(void)
{
return _radio.sanityCheck();
}
uint8_t transportReceive(void* data)
{
// save payload length
const uint8_t dataLen = _radio.DATALEN < MAX_MESSAGE_LENGTH? _radio.DATALEN : MAX_MESSAGE_LENGTH;
(void)memcpy((void*)data, (void*)_radio.DATA, dataLen);
// Send ack back if this message wasn't a broadcast
if (_radio.ACKRequested()) {
_radio.sendACK();
}
return dataLen;
}
void transportSleep(void)
{
_radio.sleep();
}
void transportStandBy(void)
{
_radio.standBy();
}
void transportPowerDown(void)
{
_radio.powerDown();
}
void transportPowerUp(void)
{
_radio.powerUp();
}
int16_t transportGetSendingRSSI(void)
{
return INVALID_RSSI;
}
int16_t transportGetReceivingRSSI(void)
{
return _radio.RSSI;
}
int16_t transportGetSendingSNR(void)
{
return INVALID_SNR;
}
int16_t transportGetReceivingSNR(void)
{
return INVALID_SNR;
}
int16_t transportGetTxPowerPercent(void)
{
return INVALID_PERCENT;
}
int16_t transportGetTxPowerLevel(void)
{
return INVALID_LEVEL;
}
#endif