codetheweb / tuyapi / 268

92%

master: 59%

push

travis-ci

Parser cipher updates (#160)

* Fixed a few parsing issues:
zero-padding is actually the return code from the device where 0 = success
Added _returnCode, _crc to MessageParser
(reordered to match order in memory)
(crc is not actually checked here, but it could be!)
More restrictive length checks, taking into account _returnCode and _crc
_commandByte is a uint32
Fill _leftOver with, well, leftovers
Reordered parse logic to match order in memory
(this also allows us to extract more data in case of a suffix mismatch)
suffix indexed relative to _payloadSize, relevant in the case of leftovers
(which happens when two messages are sent in one)

These changes were made with the best attempt to adhere to the existing coding style
I would personally make parse and encode both static functions
We could check the crc value for data integrity
If _leftOver is populated, better try decoding that too

A more drastic overhaul can be found:
https://github.com/kueblc/mocktuyacloud/blob/master/lib/lan-frame.js
But no attempt has been made to maintain the previous coding style
This adaptation was made to integrate seamlessly into the existing tuyapi project

* Reimplemented encrypt, decrypt, and md5 using built in crypto library
Removes dependency on third party node-forge library
Clarified md5 documentation

* Default encrypt options.base64 to true

* Fix lint no-negated-condition

* Cleaned up _encode implementation using one buffer to assemble payload and remove string representations of binary data

* Fixed test for encrypting with base64 option disabled
Had previously made a poor assumption about the meaning of the flag and hadn't realized utf8 is not binary safe

* Fixed cipher.encrypt base64 option, now correctly outputs a Buffer when base64 = false

* Throw appropriate errors when parsing fails
Replaced 16 with a constant HEADER_SIZE for better code readability
Cleverly account for return code or lack thereof by checking if ... (continued)

77 of 87 branches covered (88.51%)

Branch coverage included in aggregate %.

55 of 55 new or added lines in 2 files covered. (100.0%)

213 of 243 relevant lines covered (87.65%)

23.37 hits per line