smithtek-nodered-lora-aes
v1.8.0
Published
AES security for the PassPort LoRa Module
Downloads
26
Maintainers
Readme
SmithTek LoRa AES Node for Node-RED
Installation
Install the "smithtek-nodered-lora-aes" node using the Node-RED Palette Manager. Prerequisites
The AES nodes need to be used with the Smithtek-node-red-lora node. The AES nodes complement the Smithtek-node-red-lora nodes by enabling and disabling AES encryption. You can get the Smithtek-node-red-lora node from the Node-RED Palette Manager. Description
The "smithtek-nodered-lora-aes" node uploads your chosen magic key for the embedded LoRa module (PassPort). The encryption method used is 128-bit AES.
The magic key is an additional level of encryption on top of the transport layer encryption (AES 128) that is built into the hardware. It is recommended for an additional level of security when using OTA communication. The magic key ensures that the payload is encrypted and secure. The magic key used must be the same on all your SmithTek devices and has to be 8 digits long. You can use any combination of characters, for example, "1@%dR67L".
Disabling the encryption will revert the communication back to the transport layer encryption only, which is still a high-level encryption but not safe from eavesdropping.
Once the magic key has been uploaded to the LoRa module through the Node-RED flow editor, you can safely delete the "smithtek-nodered-lora-aes" nodes from the flow. Node Configuration
The node has the following configuration options:
Name: Provide a name for the node (optional).
Node Behavior
Inject a string in the msg.payload property to control AES encryption:
Use "enable" to activate AES encryption.
Use "disable" to deactivate AES encryption.
Inject the magic key using the msg.key property:
Provide a string with a maximum of 8 digits.
If the key is too long, an error message will be output on Output 2: "Error: Key is too long".
If the key is too short, an error message will be output on Output 2: "Error: Key is too short".
Outputs
Output 1: The generated hex command for enable/disable.
Output 2: The generated magic key hex or key length error message.
Example Flow
Here's an example flow using the "smithtek-nodered-lora-aes" node:
[{"id":"1368e2ff7afe2e57","type":"debug","z":"f14cc45fdd084c22","name":"Status","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":470,"y":320,"wires":[]},{"id":"0f8cd66da4053e61","type":"smithtek-nodered-lora-aes","z":"f14cc45fdd084c22","name":"test","x":330,"y":340,"wires":[["1368e2ff7afe2e57"],["777e64ba5df283dc"]]},{"id":"89ed2a44e1cfead4","type":"inject","z":"f14cc45fdd084c22","name":"","props":[{"p":"payload"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"enable","payloadType":"str","x":190,"y":300,"wires":[["0f8cd66da4053e61"]]},{"id":"232e2ee8ba7a025f","type":"inject","z":"f14cc45fdd084c22","name":"","props":[{"p":"payload"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"disable","payloadType":"str","x":190,"y":380,"wires":[["0f8cd66da4053e61"]]},{"id":"777e64ba5df283dc","type":"debug","z":"f14cc45fdd084c22","name":"magic key","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":480,"y":360,"wires":[]},{"id":"287d08a63be0b9e3","type":"inject","z":"f14cc45fdd084c22","name":"Magic Key","props":[{"p":"key","v":"ket12345","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","x":180,"y":340,"wires":[["0f8cd66da4053e61"]]}]
License
Copyright (c) 2023 www.smithtek.com.au Licenced under the terms of the GPLv3 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAMIEN CLARK BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
www.smithtek.com.au