[security] Introducing signing support to MySensors


  • Contest Winner

    @noelgeorgi if you have cloned the arduino git you have everything you need. I can build that sketch myself and have used it many times. I suspect you have a problem with your environment if you get compilation errors in it. We continously test the repository and build all examples nightly to make sure it all works as it is supposed to. You can see this at ci.mysensors.org



  • @Anticimex sorry for the interruption, i was using rsync to get eveything synced and i might have messed something uop, sha204 library was missing from my libraries folder, now everything works, thanks for the prompt and fast support.


  • Contest Winner

    πŸ‘


  • Hardware Contributor

    @Anticimex - thanks for this. I finally got around to enabling signing on everything while I was testing out my new board design. I followed your schematic from your board design when I built mine and I just went through the instructions to configure the crypto chip and everything went smoothly. Thanks for the work and the good instructions!


  • Contest Winner

    @TD22057 that's really nice to hear! Are you using a stable release or the development/beta channel?


  • Hardware Contributor

    @Anticimex
    I used the signing sketch on the dev branch - I'm in the process of shifting my stuff over to the dev branch from 1.5 now.


  • Contest Winner

    Ok, cool. As you might have noticed, personalization has changed a bit on development. Also, whitelisting works slightly differently/better.



  • Isn't blacklisting cool too to use ?
    Like, if we know the "name" of the sensor lost, we push it to the black list and voila ? This way, we don't have to put a long list a agreed sensors if we have only two nodes outside the house.
    ... I think.


  • Contest Winner

    @Pierre-P because if a node is lost, you no longer control that node. So anyone could reprogram it to have it identify itself in any way possible. We have to assume an attacker has full source code access, so they can rewrite the signing algorithm to use a fake serial as salt for the signature to trick the GW to believe it is a new node. A whitelist mean the attacker has to know the ID/serial of one of the nodes you trust. Which they won't know unless they can get access to that node.



  • Thanks for the complet answer !


  • Contest Winner

    @Pierre-P you are welcome. Security is best when it is totally open and the implementation is aware of this. That makes it quite difficult to circumvent, and it also allows to be challenged. That way, with many eyes examining it, it gets stronger and stronger πŸ™‚ I welcome all attempts to crack it. White or black hat style.


  • Hardware Contributor

    Hello all! What would require less flash memory? Signing by ATSHA204A Chip or by software?


  • Contest Winner

    Signing by ATSHA204A require less flash memory, but takes longer to execute (at least on 8MHz AtMega328).


  • Hardware Contributor

    @Anticimex assumed that, but this post on the forum got me confused: http://forum.mysensors.org/topic/2005/software-aes-encryption-for-nrf24/19

    According to that post, he uses software on the SenseBender with Encryption because, according to him "...encryption and ATSHA204A is to big for the SenseBender... ".

    I would like to add Signing and encryption to my nodes, but I don't know if it will fit on my Atmega328 flash!


  • Contest Winner

    Well, how much space you have depend on your sketch and on the features you enable in the library, so it is impossible to predict how your code will fit. I suggest you just try to enable what you want and compile, and you'll know πŸ™‚


  • Mod

    The easiest way to find out is to look at the output in Arduino IDE when you click "Verify".

    There are some factors that affect size:

    • Size of bootloader
    • MySensors version (different versions of the library have different size requirements)
    • MySensors features used (software signing, encryption, debug on or off, etc)
    • Size of other libraries you use in your sketch
    • Size of your sketch

  • Mod

    ouch, @Anticimex was a bit faster πŸ™‚
    oh, and the problem in the thread you quoted @Soloam is encryption. At least at that time, encryption used too much space so there wasn't space to include either hardware or software signing.


  • Hardware Contributor


  • Contest Winner

    And on development branch, @tekka has an open PR where he has cut down significantly on the size of the NRF24 driver as well.


  • Contest Winner

    And you might also have read mine and @mfalkvidd's stand on encryption, so don't be discouraged if you find that you can't fit both. Just skip the encryption in that case. It adds far less in security than signing does.


  • Hardware Contributor

    Yes, if I have to discard one it would be encryption! Thank you for the help @Anticimex and @mfalkvidd



  • Hello,

    I currently testing various bootloader to measure impact on CPU speed on the power consumption.
    I got a lot of nonce error when using 1 MHz configuration.

    Is signing feature possible at 1 MHz ?

    Thanks.

    David.


  • Contest Winner

    @carlierd could you specify a bit clearer what you mean by "nonce error"? Signing should work, but the atsha driver is not tested @ 1MHz and might get bad timing. Also, for soft (and hard) signing, if 1MHz is used, performance could degrade to the point that the nonce timeout needs to be increased.



  • @Anticimex

    Hello.

    I am using soft signing.

    find parent
    send: 255-255-255-255 s=255,c=3,t=7,pt=0,l=0,sg=0,st=bc:
    read: 255-255-255 s=255,c=3,t=7,pt=0,l=0,sg=0:
    sensor started, id=255, parent=255, distance=255
    find parent
    send: 255-255-255-255 s=255,c=3,t=7,pt=0,l=0,sg=0,st=bc:
    read: 0-0-255 s=255,c=3,t=8,pt=1,l=1,sg=0:0
    parent=0, d=1
    read: 0-0-255 s=255,c=3,t=8,pt=1,l=1,sg=0:0
    req id
    send: 255-255-0-0 s=255,c=3,t=3,pt=0,l=0,sg=0,st=ok:
    read: 0-0-255 s=255,c=3,t=4,pt=0,l=1,sg=0:9
    send: 9-9-0-0 s=255,c=3,t=15,pt=2,l=2,sg=0,st=fail:1
    read and drop: 9-9-0 s=255,c=3,t=15,pt=2,l=2,sg=0:1
    read: 0-0-9 s=255,c=3,t=15,pt=2,l=2,sg=0:1
    send: 9-9-0-0 s=255,c=3,t=16,pt=0,l=0,sg=0,st=fail:
    nonce tr err
    send: 9-9-0-0 s=255,c=3,t=16,pt=0,l=0,sg=0,st=fail:
    nonce tr err
    read and drop: 9-0-0 s=255,c=3,t=6,pt=1,l=1,sg=0:0
    read: 0-0-9 s=255,c=3,t=17,pt=6,l=25,sg=0:0129D04B64916F5E805EFDF704C34F56B47E547FDDE93805BE
    id=9
    send: 9-9-0-0 s=0,c=0,t=0,pt=0,l=0,sg=0,st=ok:
    send: 9-9-0-0 s=1,c=0,t=30,pt=0,l=0,sg=0,st=fail:
    [Setup duration: 9928 ms]
    send: 9-9-0-0 s=0,c=3,t=16,pt=0,l=0,sg=0,st=fail:
    nonce tr err
    send: 9-9-0-0 s=1,c=3,t=16,pt=0,l=0,sg=0,st=fail:
    nonce tr err
    send: 9-9-0-0 s=255,c=3,t=16,pt=0,l=0,sg=0,st=fail:
    nonce tr err
    Value is 1   Cycle is 1   3.39 v   [753 ms]
    

    Thanks,

    David.


  • Contest Winner

    @carlierd you have a lot of st=fail, so your problem is radio related, not signing related. I also see non nonce related messages fail so you need to stabilize your rf connection before signing can work. And since signing uses the maximum payload size, it has the least probability to succeed to be sent, so you could find that unsigned messages work while nonces and signed messages fail, but this is normal of the rf link is not fully working. If you get st=fail, it is a radio problem. See this discussion for details: http://forum.mysensors.org/topic/3386/mqttclientgateway-broken-after-upgrade-signature-failure



  • @Anticimex Hello. Everything is working at 16 or 8MHz so I am pretty sure it's not an issue with the material.
    I will burn the bootloader again and create a new post if it's still not correct. I will also disable signing feature to be sure there is no impact.

    David.


  • Contest Winner

    @carlierd well, st=fail indicate transmission failure so it is pretty clear that you have a issue with rf, at least on that frequency. st=fail is not signing related. But, like previously discussed, enabling signing can trigger more st=fail because the payload gets bigger and is more sensitive to noise.



  • @calierd You can have a look here at the discussion I had with a similar problem which I was able to resolve finally. See the last reply in the aforementioned thread where I summarized how I resolved it, eventually.



  • @Anticimex @tomkxy
    Perhaps the arduino and RFM69 can't run at 1MHz. I have capacitors and I tried with two different power sources. Without signing it's better but still a lot of st=fail. No matter, it was just for testing purpose πŸ™‚



  • @calierd I cannot comment on RFM69 since I have non in operation. Sorry, try to place the nodes further apart and look whether it changes.



  • @Anticimex Thank you for the effort you have put into signing, this is great!

    Would it make sense to explore the I2C version of ATSHA204A ? The reason I'm asking is speed.


  • Contest Winner

    Thanks @duovis,
    Yes, I welcome anyone who has the HW to provide a IO routine for I2C-variants of ATSHA204A. I don't have the hw myself though.



  • @Anticimex Ok, I'll try to play with it and see if I can come up with something that works on I2C.


  • Contest Winner

    @duovis Great. I'll happily review any code. You should only need to worry about the low level stuff.


  • Hardware Contributor

    Hello all!

    Two fast question! Can I have nodes working with ATSHA204A chip and others with software?

    And, can I have nodes with signing on and others off? Or if I add signing to my network, all nodes must have it?

    Thank you all!


  • Contest Winner

    @Soloam
    You can mix nodes with soft signing and ATSHA signing as you like.
    You can mix nodes with signing on and off as well. The GW will only sign messages to nodes that require it, and it will also only check signatures from nodes that require signatures. So you can have one node which support/require signing and another which don't. The GW will be able to exchange messages with both nodes.


  • Hardware Contributor

    Great work indeed!

    Thank you @Anticimex


  • Contest Winner

    @Soloam thanks πŸ™‚



  • Slightly silly question, but did anyone manage to get signing working (MySigningAtsha204Soft signer;) on Arduino Uno on MS 1.5.4 on the Ethernet gateway please? I am going out of memory and really hate to upgrade it to Mega


  • Contest Winner

    @alexsh1 if you feel adventurous try 2.0.0-beta2, or if you are patient, go to 2.0.0 in a few months and redesigns will have made space available for you.



  • @Anticimex Thanks - I am currently trying an Ethernet GW and a node (Sensebender Micro) with dev branch. I am stuck at personalisation. I cannot lock data. Any idea what I am doing wrong?

    This is Sensebender (with ATSHA204):

    Personalization sketch for MySensors usage.
    -------------------------------------------
    Device revision: 00020009
    Device serial:   {0x01,0x23,0x53,0x3F,0x52,0x6A,0x1A,0x06,0xEE}
    0123533F526A1A06EE
    Skipping configuration write and lock (configuration already locked).
    Chip configuration:
    EEPROM DATA:
    SOFT_HMAC_KEY | FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
    SOFT_SERIAL   | FFFFFFFFFFFFFFFFFF
    AES_KEY       | FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
    ATSHA204A DATA:
               SN[0:1]           |         SN[2:3]           | 01   23 | 53   3F   
                              Revnum                         | 00   09   04   00   
                              SN[4:7]                        | 52   6A   1A   06   
        SN[8]    |  Reserved13   | I2CEnable | Reserved15    | EE | 13 | 00 | 00   
      I2CAddress |  TempOffset   |  OTPmode  | SelectorMode  | C8 | 00 | 55 | 00   
             SlotConfig00        |       SlotConfig01        | 8F   80 | 80   A1   
             SlotConfig02        |       SlotConfig03        | 82   E0 | A3   60   
             SlotConfig04        |       SlotConfig05        | 94   40 | A0   85   
             SlotConfig06        |       SlotConfig07        | 86   40 | 87   07   
             SlotConfig08        |       SlotConfig09        | 0F   00 | 89   F2   
             SlotConfig0A        |       SlotConfig0B        | 8A   7A | 0B   8B   
             SlotConfig0C        |       SlotConfig0D        | 0C   4C | DD   4D   
             SlotConfig0E        |       SlotConfig0F        | C2   42 | AF   8F   
      UseFlag00  | UpdateCount00 | UseFlag01 | UpdateCount01 | FF | 00 | FF | 00   
      UseFlag02  | UpdateCount02 | UseFlag03 | UpdateCount03 | FF | 00 | FF | 00   
      UseFlag04  | UpdateCount04 | UseFlag05 | UpdateCount05 | FF | 00 | FF | 00   
      UseFlag06  | UpdateCount06 | UseFlag07 | UpdateCount07 | FF | 00 | FF | 00   
                          LastKeyUse[0:3]                    | FF   FF   FF   FF   
                          LastKeyUse[4:7]                    | FF   FF   FF   FF   
                          LastKeyUse[8:B]                    | FF   FF   FF   FF   
                          LastKeyUse[C:F]                    | FF   FF   FF   FF   
      UserExtra  |    Selector   | LockValue |  LockConfig   | 00 | 00 | 55 | 00   
    Take note of this key, it will never be the shown again:
    #define MY_HMAC_KEY [deleted]
    Writing key to slot 0...
    Send SPACE character to lock data...
    Data lock failed. Response: D3
    Halting!
    

  • Contest Winner

    @alexsh1 actually, I have never actually locked data. Could be a bug there. But I also highly recommend that you don't. If you do, you will never be able to change hmac key in that device.



  • @Anticimex So this is no problem if the key is not locked? I was just following the manual

    On a separate note, I cannot get soft_serial written into the EEPROM:

    #define LOCK_CONFIGURATION
    //#define LOCK_DATA
    //#define SKIP_KEY_STORAGE
    //#define USER_KEY
    //#define SKIP_UART_CONFIRMATION
    #define USE_SOFT_SIGNING
    #define STORE_SOFT_KEY
    #define USER_SOFT_KEY
    #define STORE_SOFT_SERIAL
    #define USER_SOFT_SERIAL
    #define STORE_AES_KEY
    #define USER_AES_KEY```
    

    I have defined the key under #define MY_SOFT_SERIAL [key]

    Personalization sketch for MySensors usage.
    -------------------------------------------
    This value will be stored in EEPROM as soft HMAC key:
    #define MY_SOFT_HMAC_KEY [deleted]
    Using this user supplied AES key:
    #define MY_AES_KEY [deleted]
    EEPROM configuration:
    SOFT_HMAC_KEY | [deleted]
    SOFT_SERIAL   | FFFFFFFFFFFFFFFFFF
    AES_KEY       | [deleted]
    --------------------------------
    Personalization is now complete.
    

  • Contest Winner

    @alexsh1 Hopefully the manual informs about the risks with locking data (that you cannot change the key afterwards). Atmel is somewhat vague on the security implications; they say that you can not read the key anyway but it is "more secure" to lock data. But personally, I have not found a way to read it, and I prefer to be able to change my HMAC key in my devices if it should be compromised.

    Strange that you don't get the soft serial. I see nothing obviously wrong with your config. But I do see that you probably sensored your uart log a bit too hard because there are other lines missing there.
    You should have seen this

    Using this user supplied soft HMAC key:
    #define MY_SOFT_HMAC_KEY [deleted]
    

    if you have enabled this:

    #define STORE_SOFT_KEY
    #define USER_SOFT_KEY
    

    You are sure you have no #undef or some accidental comment or similar. As you see in the personalizer code, it is not that complicated. If the flags are enabled, you should at least get some printouts. But since (if your UART dump is correct) you get nothing, I suspect the flags are not really "on".



  • @Anticimex said:

    Strange that you don't get the soft serial. I see nothing obviously wrong with your config. But I do see that you probably sensored your uart log a bit too hard because there are other lines missing there.
    You should have seen this

    Using this user supplied soft HMAC key:
    #define MY_SOFT_HMAC_KEY [deleted]
    

    if you have enabled this:

    #define STORE_SOFT_KEY
    #define USER_SOFT_KEY
    

    You are sure you have no #undef or some accidental comment or similar. As you see in the personalizer code, it is not that complicated. If the flags are enabled, you should at least get some printouts. But since (if your UART dump is correct) you get nothing, I suspect the flags are not really "on".

    OK, it was Arduino glitch - any changes in the sketch were not reflected on the compilation. Rebooted my PC and restarted Arduino and all works as expected.

    A few questions: Mixing ATSHA204 and soft signing - Does HMAC key (one stored in ATSHA204 of say a node and another one in GW's EEPROM) have to be the same? Also I understand one can store HMAC key on both ATSHA204 and EEPROM of one device (say, Sensebender)? I understand that SOFT_KEY has to be unique for every device?


  • Contest Winner

    @alexsh1 Ok, well Arduino IDE sucks totally.

    You can mix ATSHA204A and soft signing as much as you like. But for any two nodes to exchange signed data the HMAC keys have to be identical.
    Yes, you can store a HMAC key in both ATSHA204A and EEPROM. These can be different if you like (and I recommend they are as the EEPROM can be dumped if the node falls into the wrong hands).
    However, if you want that node to communicate signed data to another node, that node must use a matching HMAC key.
    SOFT_KEY is the HMAC key stored in EEPROM, it must not be unique for every device. If it is, no device will be able to sign data to any other node and expect that node to accept that data.
    SOFT_SERIAL on the other hand, must be unique to serve any useful purpose for whitelisting. If you use the ATSHA204A, the serial fused in the device will be used and that cannot be changed, and is according to Atmel, unique.



  • @Anticimex Ok, but is there a reason why one would have HMAC key in both ATSHA204a and EEPROM?


  • Contest Winner

    @alexsh1 no, not really. If you have a atsha204a the only reason to not use it would be performance. Software signing executes slightly faster due to the single write protocol of the atsha.



  • @Anticimex Thanks very much for your help - I must admit it was a bit of a challenge to jump straight away from a stable 1.5.4 to 2.0 beta


  • Contest Winner

    @alexsh1 yes there have been a lot of changes but hopefully they are perceived as improvements. Feedback on signing usability is always welcome πŸ™‚



  • @Anticimex BTW, is signing compatible between 1.5.4 and 2.0b?


  • Contest Winner

    @alexsh1 no, it is not



  • @Anticimex Right, this is why I am not able to sign 1.5.4 nodes with 2.0b GW.
    In fact when I inserted #define MY_SIGNING_REQUEST_SIGNATURES into the GW code, some nodes stopped working and I think it has to be with signing as GW is throwing a lot of messages that signing failed.

    Bottom line is that I need to upgrade pretty much all sensors 😞


  • Contest Winner

    @alexsh1 yes, Unfortunately. But it is a huge release upcoming. And a major version step, hence the incompatibilities. Hopefully, the changes made will make it easier to do future maintenance.



  • Hi. Is there any difference in using RFM69? Signing is supported using that radio? Thanks


  • Contest Winner

    @cingolanifede signing has nothing to to with which radio you choose so yes. It supports any transport, but to my knowledge it has only been actually tested with nrf24 and rfm69.



  • @Anticimex I must admit that signing is working really-really nicely on my custom made nodes (Soft sign and ATSHA204A)

    Apart from a small issue with the sensebender, which I believe is not a signing issue, it is working like a charm. All credit to you! Thank you

    Starting sensor (RNNNAS, 2.0.0-beta)
    Radio init successful.
    HTU21D Sensor1.1 - Online!
    isMetric: 1
    TempDiff :1098.00
    HumDiff  :136.75
    T: 998.00
    H: 36.75
    send: 5-5-0-0 s=0,c=1,t=0,pt=7,l=5,sg=0,st=ok:998.0
    send: 5-5-0-0 s=1,c=1,t=1,pt=7,l=5,sg=0,st=ok:36.7
    send: 5-5-0-0 s=2,c=1,t=38,pt=7,l=5,sg=0,st=ok:3.29
    send: 5-5-0-0 s=255,c=3,t=0,pt=1,l=1,sg=0,st=ok:106
    Signing required
    send: 5-5-0-0 s=255,c=3,t=15,pt=0,l=2,sg=0,st=ok:
    Waiting for GW to send signing preferences...
    Skipping security for command 3 type 15
    read: 0-0-5 s=255,c=3,t=15,pt=0,l=2,sg=0:
    Mark node 0 as one that do not require signed messages
    Mark node 0 as one that do not require whitelisting
    send: 5-5-0-0 s=255,c=0,t=17,pt=0,l=10,sg=0,st=ok:2.0.0-beta
    send: 5-5-0-0 s=255,c=3,t=6,pt=1,l=1,sg=0,st=ok:0
    Skipping security for command 3 type 16
    read: 0-0-5 s=255,c=3,t=16,pt=0,l=0,sg=0:
    Signing backend: ATSHA204Soft
    SHA256: 2C4A871ACCAE26760F41E547DD39B7B816FE22EEBCD8DFA2FE00000000000000
    Transmittng nonce
    send: 5-5-0-0 s=255,c=3,t=17,pt=6,l=25,sg=0,st=ok:2C4A871ACCAE26760F41E547DD39B7B816FE22EEBCD8DFA2FE
    Signature in message: 01C31110DAE29D5DCD3771F68B6F29B5CCCF43A3D5397CC8
    Message to process: 00050E0306FF4D
    Current nonce: 2C4A871ACCAE26760F41E547DD39B7B816FE22EEBCD8DFA2FEAAAAAAAAAAAAAA
    HMAC: 0CC31110DAE29D5DCD3771F68B6F29B5CCCF43A3D5397CC89A82A89D87E931B8
    Signature OK
    read: 0-0-5 s=255,c=3,t=6,pt=0,l=1,sg=0:M
    send: 5-5-0-0 s=255,c=3,t=11,pt=0,l=24,sg=0,st=ok:Temp/Hum Sensor - HTU21D
    send: 5-5-0-0 s=255,c=3,t=12,pt=0,l=3,sg=0,st=ok:1.1
    send: 5-5-0-0 s=0,c=0,t=6,pt=0,l=0,sg=0,st=ok:
    send: 5-5-0-0 s=1,c=0,t=7,pt=0,l=0,sg=0,st=ok:
    send: 5-5-0-0 s=2,c=0,t=13,pt=0,l=0,sg=0,st=ok:
    Init complete, id=5, parent=0, distance=1
    TempDiff :971.94
    HumDiff  :0.02
    T: 26.06
    H: 36.72
    send: 5-5-0-0 s=0,c=1,t=0,pt=7,l=5,sg=0,st=ok:26.1
    send: 5-5-0-0 s=1,c=1,t=1,pt=7,l=5,sg=0,st=ok:36.7
    

  • Contest Winner

    @alexsh1 I'm really glad to hear that. Thank you! Glad that signing is being used and is perceived as something not to complicated to bother with. It sets us apart from many other projects dealing with the same thing πŸ™‚



  • @Anticimex I did not say it was not complicated πŸ™‚
    Just kidding - speaking just for myself, it did require some time investment to understand the concept and then upgrading my gateway and my nodes (I am still in the process of rolling signing across the rest of my nodes) to MySensors 2.0b. I probably spent more time upgrading MySensors lib and breaking some hardware in the meantime (the SMA connector on the nrf24l01+ PA+LNA) than the actual signing.


  • Contest Winner

    @alexsh1 yeah, well if there is room for improvement in the documentation then feel free to help put with suggestions if there is anything unclear about that πŸ™‚ I use doxygen to document signing features, and a link is available on the GitHub "front-page" (the readme.md)



  • @Anticimex I think a noob's section would be good. Having said that, the point is that signing is not something beginners should touch. What do you think?

    How about a section on the web-site? Somewhere here - https://www.mysensors.org/build/


  • Contest Winner

    @alexsh1 hm, yeah, perhaps something for @hek to consider. At least a link to the signing section of the doxygen docs could be placed there. I have tried to make the documentation as step-by-step friendly as I can. That said, as I also did the actual implementation, I may well be blind for certain aspects I take for granted that a "novice" does not.


  • Admin

    The next release of the main site will be much more flexible and integrated with openhardware-added projects. The idea is to allow community members to maintain their projects and/or "articles" themselves. The how-to for signing is a good example of an article.



  • This tutorial is up to date for 2.0 release ?


  • Contest Winner

    @Fabien Yes, top post is now updated for 2.0.0. Documentation is in doxygen.



  • Thank you @Anticimex I will update my network soon and had RFM69 Encryption too.



  • Trying this:
    https://www.mysensors.org/build/raspberry

    How do I enable signing and give the gateway the serial, hmac and aes-key when running on Linux? (rPi).

    Edit: Pin 7 as random number generator maybe need some change?


  • Contest Winner

    @NiklasO @marceloaqno is working on this.



  • Hi,
    I have about 100 ATSHA204 I2C variant to be used in a MySensors project.
    Do you think that by modifying the personalizer sketch to disable the I2C bit in the configuration (0x03 word address) the chips can be set to be used as single-wire, or are they hardcoded to use only one protocol, but then why having the config bit?


  • Contest Winner

    @executivul The bit is readonly. You cannot change it. It is used to determine the variant of chip, not to select mode of operation.
    From the documentation:
    0_1478094689558_upload-93242040-4814-4ad6-8951-4ad4d1e99a23
    But you are welcome to submit a pull request for adding support for I2C variants of ATSHA204a. I have none myself so I have not bothered looking into that and currently I am out of time to spend on it I am afraid.



  • @Anticimex said:
    But you are welcome to submit a pull request for adding support for I2C variants of ATSHA204a. I have none myself so I have not bothered looking into that and currently I am out of time to spend on it I am afraid.

    Please excuse my noobish ignorance: How and where do I submit one?


  • Contest Winner

    @executivul By forking the MySensors core repository and create a local git branch, do your code, push it back to your fork on GitHub and then create a pull request from that. There are good guides on GitHub for how do do it.



  • ok, thank you, but do you know why the sketch didnt generate the keys, and instead of random i get only keys ffffffffffff ?
    thank you


  • Contest Winner

    @meddie Without actually seeing your sketch it is pretty hard for me to help with anything πŸ˜‰
    My guess is, you did not enable the proper defines to instruct it to generate and store any keys.



  • @Anticimex
    Hi i have posted my sketch few posts ago, but no problem here is it:

    
    
    #include "sha204_library.h"
    #include "sha204_lib_return_codes.h"
    #define MY_CORE_ONLY
    #include <MySensors.h>
    
    #if DOXYGEN
    #define LOCK_CONFIGURATION
    #define LOCK_DATA
    #define SKIP_KEY_STORAGE
    #define USER_KEY
    #define SKIP_UART_CONFIRMATION
    #define USE_SOFT_SIGNING
    #define STORE_SOFT_KEY
    #define USER_SOFT_KEY
    #define STORE_SOFT_SERIAL
    #define USER_SOFT_SERIAL
    #define STORE_AES_KEY
    #define USER_AES_KEY
    #endif
    
    //#define LOCK_CONFIGURATION
    
    //#define LOCK_DATA
    
    #define SKIP_KEY_STORAGE
    
    //#define USER_KEY
    
    //#define SKIP_UART_CONFIRMATION
    
    //#define USE_SOFT_SIGNING
    
    //#define STORE_SOFT_KEY
    
    //#define USER_SOFT_KEY
    
    //#define STORE_SOFT_SERIAL
    
    //#define USER_SOFT_SERIAL
    
    //#define STORE_AES_KEY
    
    //#define USER_AES_KEY
    
    #if defined(SKIP_UART_CONFIRMATION) && !defined(USER_KEY)
    #error You have to define USER_KEY for boards that does not have UART
    #endif
    
    #ifdef USER_KEY
    /** @brief The user-defined HMAC key to use for personalization */
    #define MY_HMAC_KEY 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00
    /** @brief The data to store in key slot 0 */
    const uint8_t user_key_data[32] = {MY_HMAC_KEY};
    #endif
    
    #ifdef USER_SOFT_KEY
    /** @brief The user-defined soft HMAC key to use for EEPROM personalization */
    #define MY_SOFT_HMAC_KEY 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00
    /** @brief The data to store as soft HMAC key in EEPROM */
    const uint8_t user_soft_key_data[32] = {MY_SOFT_HMAC_KEY};
    #endif
    
    #ifdef USER_SOFT_SERIAL
    /** @brief The user-defined soft serial to use for EEPROM personalization */
    #define MY_SOFT_SERIAL 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00
    /** @brief The data to store as soft serial in EEPROM */
    const uint8_t user_soft_serial[9] = {MY_SOFT_SERIAL};
    #endif
    
    #ifdef USER_AES_KEY
    /** @brief The user-defined AES key to use for EEPROM personalization */
    #define MY_AES_KEY 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00
    /** @brief The data to store as AES key in EEPROM */
    const uint8_t user_aes_key[16] = {MY_AES_KEY};
    #endif
    
    #ifndef USE_SOFT_SIGNING
    const int sha204Pin = MY_SIGNING_ATSHA204_PIN; //!< The IO pin to use for ATSHA204A
    atsha204Class sha204(sha204Pin);
    #endif
    
    /** @brief Print a error notice and halt the execution */
    void halt()
    {
    	Serial.println(F("Halting!"));
    	while(1);
    }
    
    #ifndef USE_SOFT_SIGNING
    
    uint16_t write_config_and_get_crc()
    {
    	uint16_t crc = 0;
    	uint8_t config_word[4];
    	uint8_t tx_buffer[SHA204_CMD_SIZE_MAX];
    	uint8_t rx_buffer[SHA204_RSP_SIZE_MAX];
    	uint8_t ret_code;
    	bool do_write;
    
    	for (int i=0; i < 88; i += 4) {
    		do_write = true;
    		if (i == 20) {
    			config_word[0] = 0x8F;
    			config_word[1] = 0x80;
    			config_word[2] = 0x80;
    			config_word[3] = 0xA1;
    		} else if (i == 24) {
    			config_word[0] = 0x82;
    			config_word[1] = 0xE0;
    			config_word[2] = 0xA3;
    			config_word[3] = 0x60;
    		} else if (i == 28) {
    			config_word[0] = 0x94;
    			config_word[1] = 0x40;
    			config_word[2] = 0xA0;
    			config_word[3] = 0x85;
    		} else if (i == 32) {
    			config_word[0] = 0x86;
    			config_word[1] = 0x40;
    			config_word[2] = 0x87;
    			config_word[3] = 0x07;
    		} else if (i == 36) {
    			config_word[0] = 0x0F;
    			config_word[1] = 0x00;
    			config_word[2] = 0x89;
    			config_word[3] = 0xF2;
    		} else if (i == 40) {
    			config_word[0] = 0x8A;
    			config_word[1] = 0x7A;
    			config_word[2] = 0x0B;
    			config_word[3] = 0x8B;
    		} else if (i == 44) {
    			config_word[0] = 0x0C;
    			config_word[1] = 0x4C;
    			config_word[2] = 0xDD;
    			config_word[3] = 0x4D;
    		} else if (i == 48) {
    			config_word[0] = 0xC2;
    			config_word[1] = 0x42;
    			config_word[2] = 0xAF;
    			config_word[3] = 0x8F;
    		} else if (i == 52 || i == 56 || i == 60 || i == 64) {
    			config_word[0] = 0xFF;
    			config_word[1] = 0x00;
    			config_word[2] = 0xFF;
    			config_word[3] = 0x00;
    		} else if (i == 68 || i == 72 || i == 76 || i == 80) {
    			config_word[0] = 0xFF;
    			config_word[1] = 0xFF;
    			config_word[2] = 0xFF;
    			config_word[3] = 0xFF;
    		} else {
    			// All other configs are untouched
    			ret_code = sha204.sha204m_read(tx_buffer, rx_buffer, SHA204_ZONE_CONFIG, i);
    			if (ret_code != SHA204_SUCCESS) {
    				Serial.print(F("Failed to read config. Response: "));
    				Serial.println(ret_code, HEX);
    				halt();
    			}
    			// Set config_word to the read data
    			config_word[0] = rx_buffer[SHA204_BUFFER_POS_DATA+0];
    			config_word[1] = rx_buffer[SHA204_BUFFER_POS_DATA+1];
    			config_word[2] = rx_buffer[SHA204_BUFFER_POS_DATA+2];
    			config_word[3] = rx_buffer[SHA204_BUFFER_POS_DATA+3];
    			do_write = false;
    		}
    
    		// Update crc with CRC for the current word
    		crc = sha204.calculateAndUpdateCrc(4, config_word, crc);
    
    		// Write config word
    		if (do_write) {
    			ret_code = sha204.sha204m_execute(SHA204_WRITE, SHA204_ZONE_CONFIG,
    			                                  i >> 2, 4, config_word, 0, NULL, 0, NULL,
    			                                  WRITE_COUNT_SHORT, tx_buffer, WRITE_RSP_SIZE, rx_buffer);
    			if (ret_code != SHA204_SUCCESS) {
    				Serial.print(F("Failed to write config word at address "));
    				Serial.print(i);
    				Serial.print(F(". Response: "));
    				Serial.println(ret_code, HEX);
    				halt();
    			}
    		}
    	}
    	return crc;
    }
    
    /**
     * @brief Write provided key to slot 0
     * @param key The key data to write
     */
    void write_key(uint8_t* key)
    {
    	uint8_t tx_buffer[SHA204_CMD_SIZE_MAX];
    	uint8_t rx_buffer[SHA204_RSP_SIZE_MAX];
    	uint8_t ret_code;
    
    	// Write key to slot 0
    	ret_code = sha204.sha204m_execute(SHA204_WRITE, SHA204_ZONE_DATA | SHA204_ZONE_COUNT_FLAG,
    	                                  0, SHA204_ZONE_ACCESS_32, key, 0, NULL, 0, NULL,
    	                                  WRITE_COUNT_LONG, tx_buffer, WRITE_RSP_SIZE, rx_buffer);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Failed to write key to slot 0. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	}
    }
    #endif // not USE_SOFT_SIGNING
    
    /** @brief Dump current configuration to UART */
    void dump_configuration()
    {
    	uint8_t buffer[32];
    #ifndef USE_SOFT_SIGNING
    	Serial.println(F("EEPROM DATA:"));
    #endif
    	hwReadConfigBlock((void*)buffer, (void*)EEPROM_SIGNING_SOFT_HMAC_KEY_ADDRESS, 32);
    	Serial.print(F("SOFT_HMAC_KEY | "));
    	for (int j=0; j<32; j++) {
    		if (buffer[j] < 0x10) {
    			Serial.print('0'); // Because Serial.print does not 0-pad HEX
    		}
    		Serial.print(buffer[j], HEX);
    	}
    	Serial.println();
    	hwReadConfigBlock((void*)buffer, (void*)EEPROM_SIGNING_SOFT_SERIAL_ADDRESS, 9);
    	Serial.print(F("SOFT_SERIAL   | "));
    	for (int j=0; j<9; j++) {
    		if (buffer[j] < 0x10) {
    			Serial.print('0'); // Because Serial.print does not 0-pad HEX
    		}
    		Serial.print(buffer[j], HEX);
    	}
    	Serial.println();
    	hwReadConfigBlock((void*)buffer, (void*)EEPROM_RF_ENCRYPTION_AES_KEY_ADDRESS, 16);
    	Serial.print(F("AES_KEY       | "));
    	for (int j=0; j<16; j++) {
    		if (buffer[j] < 0x10) {
    			Serial.print('0'); // Because Serial.print does not 0-pad HEX
    		}
    		Serial.print(buffer[j], HEX);
    	}
    	Serial.println();
    #ifndef USE_SOFT_SIGNING
    	uint8_t tx_buffer[SHA204_CMD_SIZE_MAX];
    	uint8_t rx_buffer[SHA204_RSP_SIZE_MAX];
    	uint8_t ret_code;
    	Serial.println(F("ATSHA204A DATA:"));
    	for (int i=0; i < 88; i += 4) {
    		ret_code = sha204.sha204m_read(tx_buffer, rx_buffer, SHA204_ZONE_CONFIG, i);
    		if (ret_code != SHA204_SUCCESS) {
    			Serial.print(F("Failed to read config. Response: "));
    			Serial.println(ret_code, HEX);
    			halt();
    		}
    		if (i == 0x00) {
    			Serial.print(F("           SN[0:1]           |         SN[2:3]           | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x04) {
    			Serial.print(F("                          Revnum                         | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				Serial.print(F("   "));
    			}
    			Serial.println();
    		} else if (i == 0x08) {
    			Serial.print(F("                          SN[4:7]                        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				Serial.print(F("   "));
    			}
    			Serial.println();
    		} else if (i == 0x0C) {
    			Serial.print(F("    SN[8]    |  Reserved13   | I2CEnable | Reserved15    | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j < 3) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x10) {
    			Serial.print(F("  I2CAddress |  TempOffset   |  OTPmode  | SelectorMode  | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j < 3) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x14) {
    			Serial.print(F("         SlotConfig00        |       SlotConfig01        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x18) {
    			Serial.print(F("         SlotConfig02        |       SlotConfig03        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x1C) {
    			Serial.print(F("         SlotConfig04        |       SlotConfig05        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x20) {
    			Serial.print(F("         SlotConfig06        |       SlotConfig07        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x24) {
    			Serial.print(F("         SlotConfig08        |       SlotConfig09        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x28) {
    			Serial.print(F("         SlotConfig0A        |       SlotConfig0B        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x2C) {
    			Serial.print(F("         SlotConfig0C        |       SlotConfig0D        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x30) {
    			Serial.print(F("         SlotConfig0E        |       SlotConfig0F        | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j == 1) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x34) {
    			Serial.print(F("  UseFlag00  | UpdateCount00 | UseFlag01 | UpdateCount01 | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j < 3) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x38) {
    			Serial.print(F("  UseFlag02  | UpdateCount02 | UseFlag03 | UpdateCount03 | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j < 3) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x3C) {
    			Serial.print(F("  UseFlag04  | UpdateCount04 | UseFlag05 | UpdateCount05 | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j < 3) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x40) {
    			Serial.print(F("  UseFlag06  | UpdateCount06 | UseFlag07 | UpdateCount07 | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j < 3) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		} else if (i == 0x44) {
    			Serial.print(F("                      LastKeyUse[0:3]                    | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				Serial.print(F("   "));
    			}
    			Serial.println();
    		} else if (i == 0x48) {
    			Serial.print(F("                      LastKeyUse[4:7]                    | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				Serial.print(F("   "));
    			}
    			Serial.println();
    		} else if (i == 0x4C) {
    			Serial.print(F("                      LastKeyUse[8:B]                    | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				Serial.print(F("   "));
    			}
    			Serial.println();
    		} else if (i == 0x50) {
    			Serial.print(F("                      LastKeyUse[C:F]                    | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				Serial.print(F("   "));
    			}
    			Serial.println();
    		} else if (i == 0x54) {
    			Serial.print(F("  UserExtra  |    Selector   | LockValue |  LockConfig   | "));
    			for (int j=0; j<4; j++) {
    				if (rx_buffer[SHA204_BUFFER_POS_DATA+j] < 0x10) {
    					Serial.print('0'); // Because Serial.print does not 0-pad HEX
    				}
    				Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+j], HEX);
    				if (j < 3) {
    					Serial.print(F(" | "));
    				} else {
    					Serial.print(F("   "));
    				}
    			}
    			Serial.println();
    		}
    	}
    #endif // not USE_SOFT_SIGNING
    }
    
    /** @brief Sketch setup code */
    void setup()
    {
    	// Delay startup a bit for serial consoles to catch up
    	unsigned long enter = hwMillis();
    	while (hwMillis() - enter < (unsigned long)500);
    #ifndef USE_SOFT_SIGNING
    	uint8_t tx_buffer[SHA204_CMD_SIZE_MAX];
    	uint8_t rx_buffer[SHA204_RSP_SIZE_MAX];
    	uint8_t ret_code;
    	uint8_t lockConfig = 0;
    	uint8_t lockValue = 0;
    	uint16_t crc;
    	(void)crc;
    #else
    	// initialize pseudo-RNG
    	randomSeed(analogRead(MY_SIGNING_SOFT_RANDOMSEED_PIN));
    #endif
    	uint8_t key[32];
    	(void)key;
    
    	Serial.begin(115200);
    	hwInit();
    	Serial.println(F("Personalization sketch for MySensors usage."));
    	Serial.println(F("-------------------------------------------"));
    
    #ifndef USE_SOFT_SIGNING
    	// Wake device before starting operations
    	ret_code = sha204.sha204c_wakeup(rx_buffer);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Failed to wake device. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	}
    	// Read out lock config bits to determine if locking is possible
    	ret_code = sha204.sha204m_read(tx_buffer, rx_buffer, SHA204_ZONE_CONFIG, 0x15<<2);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Failed to determine device lock status. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	} else {
    		lockConfig = rx_buffer[SHA204_BUFFER_POS_DATA+3];
    		lockValue = rx_buffer[SHA204_BUFFER_POS_DATA+2];
    	}
    #endif
    
    #ifdef STORE_SOFT_KEY
    #ifdef USER_SOFT_KEY
    	memcpy(key, user_soft_key_data, 32);
    	Serial.println(F("Using this user supplied soft HMAC key:"));
    #else
    	// Retrieve random value to use as soft HMAC key
    #ifdef USE_SOFT_SIGNING
    	for (int i = 0; i < 32; i++) {
    		key[i] = random(256) ^ micros();
    		unsigned long enter = hwMillis();
    		while (hwMillis() - enter < (unsigned long)2);
    	}
    	Serial.println(F("This value will be stored in EEPROM as soft HMAC key:"));
    #else
    	ret_code = sha204.sha204m_random(tx_buffer, rx_buffer, RANDOM_SEED_UPDATE);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Random key generation failed. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	} else {
    		memcpy(key, rx_buffer+SHA204_BUFFER_POS_DATA, 32);
    	}
    	if (lockConfig == 0x00) {
    		Serial.println(F("This value will be stored in EEPROM as soft HMAC key:"));
    	} else {
    		Serial.println(F("Key is not randomized (configuration not locked):"));
    	}
    #endif // not USE_SOFT_SIGNING
    #endif // not USER_SOFT_KEY
    	Serial.print("#define MY_SOFT_HMAC_KEY ");
    	for (int i=0; i<32; i++) {
    		Serial.print("0x");
    		if (key[i] < 0x10) {
    			Serial.print('0'); // Because Serial.print does not 0-pad HEX
    		}
    		Serial.print(key[i], HEX);
    		if (i < 31) {
    			Serial.print(',');
    		}
    	}
    	Serial.println();
    	hwWriteConfigBlock((void*)key, (void*)EEPROM_SIGNING_SOFT_HMAC_KEY_ADDRESS, 32);
    #endif // STORE_SOFT_KEY
    
    #ifdef STORE_SOFT_SERIAL
    #ifdef USER_SOFT_SERIAL
    	memcpy(key, user_soft_serial, 9);
    	Serial.println(F("Using this user supplied soft serial:"));
    #else
    	// Retrieve random value to use as serial
    #ifdef USE_SOFT_SIGNING
    	for (int i = 0; i < 9; i++) {
    		key[i] = random(256) ^ micros();
    		unsigned long enter = hwMillis();
    		while (hwMillis() - enter < (unsigned long)2);
    	}
    	Serial.println(F("This value will be stored in EEPROM as soft serial:"));
    #else
    	ret_code = sha204.sha204m_random(tx_buffer, rx_buffer, RANDOM_SEED_UPDATE);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Random serial generation failed. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	} else {
    		memcpy(key, rx_buffer+SHA204_BUFFER_POS_DATA, 9);
    	}
    	if (lockConfig == 0x00) {
    		Serial.println(F("This value will be stored in EEPROM as soft serial:"));
    	} else {
    		Serial.println(F("Serial is not randomized (configuration not locked):"));
    	}
    #endif // not USE_SOFT_SIGNING
    #endif // not USER_SOFT_SERIAL
    	Serial.print("#define MY_SOFT_SERIAL ");
    	for (int i=0; i<9; i++) {
    		Serial.print("0x");
    		if (key[i] < 0x10) {
    			Serial.print('0'); // Because Serial.print does not 0-pad HEX
    		}
    		Serial.print(key[i], HEX);
    		if (i < 8) {
    			Serial.print(',');
    		}
    	}
    	Serial.println();
    	hwWriteConfigBlock((void*)key, (void*)EEPROM_SIGNING_SOFT_SERIAL_ADDRESS, 9);
    #endif // STORE_SOFT_SERIAL
    
    #ifdef STORE_AES_KEY
    #ifdef USER_AES_KEY
    	memcpy(key, user_aes_key, 16);
    	Serial.println(F("Using this user supplied AES key:"));
    #else
    	// Retrieve random value to use as key
    #ifdef USE_SOFT_SIGNING
    	for (int i = 0; i < 16; i++) {
    		key[i] = random(256) ^ micros();
    		unsigned long enter = hwMillis();
    		while (hwMillis() - enter < (unsigned long)2);
    	}
    	Serial.println(F("This key will be stored in EEPROM as AES key:"));
    #else
    	ret_code = sha204.sha204m_random(tx_buffer, rx_buffer, RANDOM_SEED_UPDATE);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Random key generation failed. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	} else {
    		memcpy(key, rx_buffer+SHA204_BUFFER_POS_DATA, 32);
    	}
    	if (lockConfig == 0x00) {
    		Serial.println(F("This key will be stored in EEPROM as AES key:"));
    	} else {
    		Serial.println(F("Key is not randomized (configuration not locked):"));
    	}
    #endif // not USE_SOFT_SIGNING
    #endif // not USER_AES_KEY
    	Serial.print("#define MY_AES_KEY ");
    	for (int i=0; i<16; i++) {
    		Serial.print("0x");
    		if (key[i] < 0x10) {
    			Serial.print('0'); // Because Serial.print does not 0-pad HEX
    		}
    		Serial.print(key[i], HEX);
    		if (i < 15) {
    			Serial.print(',');
    		}
    	}
    	Serial.println();
    	hwWriteConfigBlock((void*)key, (void*)EEPROM_RF_ENCRYPTION_AES_KEY_ADDRESS, 16);
    #endif // STORE_AES_KEY
    
    #ifdef USE_SOFT_SIGNING
    	Serial.println(F("EEPROM configuration:"));
    	dump_configuration();
    #else
    	// Output device revision on console
    	ret_code = sha204.sha204m_dev_rev(tx_buffer, rx_buffer);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Failed to determine device revision. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	} else {
    		Serial.print(F("Device revision: "));
    		for (int i=0; i<4; i++) {
    			if (rx_buffer[SHA204_BUFFER_POS_DATA+i] < 0x10) {
    				Serial.print('0'); // Because Serial.print does not 0-pad HEX
    			}
    			Serial.print(rx_buffer[SHA204_BUFFER_POS_DATA+i], HEX);
    		}
    		Serial.println();
    	}
    
    	// Output serial number on console
    	ret_code = sha204.getSerialNumber(rx_buffer);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Failed to obtain device serial number. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	} else {
    		Serial.print(F("Device serial:   "));
    		Serial.print('{');
    		for (int i=0; i<9; i++) {
    			Serial.print(F("0x"));
    			if (rx_buffer[i] < 0x10) {
    				Serial.print('0'); // Because Serial.print does not 0-pad HEX
    			}
    			Serial.print(rx_buffer[i], HEX);
    			if (i < 8) {
    				Serial.print(',');
    			}
    		}
    		Serial.print('}');
    		Serial.println();
    		for (int i=0; i<9; i++) {
    			if (rx_buffer[i] < 0x10) {
    				Serial.print('0'); // Because Serial.print does not 0-pad HEX
    			}
    			Serial.print(rx_buffer[i], HEX);
    		}
    		Serial.println();
    	}
    
    	if (lockConfig != 0x00) {
    		// Write config and get CRC for the updated config
    		crc = write_config_and_get_crc();
    
    		// List current configuration before attempting to lock
    		Serial.println(F("Chip configuration:"));
    		dump_configuration();
    
    #ifdef LOCK_CONFIGURATION
    		// Purge serial input buffer
    #ifndef SKIP_UART_CONFIRMATION
    		while (Serial.available()) {
    			Serial.read();
    		}
    		Serial.println(F("Send SPACE character now to lock the configuration..."));
    
    		while (Serial.available() == 0);
    		if (Serial.read() == ' ')
    #endif //not SKIP_UART_CONFIRMATION
    		{
    			Serial.println(F("Locking configuration..."));
    
    			// Correct sequence, resync chip
    			ret_code = sha204.sha204c_resync(SHA204_RSP_SIZE_MAX, rx_buffer);
    			if (ret_code != SHA204_SUCCESS && ret_code != SHA204_RESYNC_WITH_WAKEUP) {
    				Serial.print(F("Resync failed. Response: "));
    				Serial.println(ret_code, HEX);
    				halt();
    			}
    
    			// Lock configuration zone
    			ret_code = sha204.sha204m_execute(SHA204_LOCK, SHA204_ZONE_CONFIG,
    			                                  crc, 0, NULL, 0, NULL, 0, NULL,
    			                                  LOCK_COUNT, tx_buffer, LOCK_RSP_SIZE, rx_buffer);
    			if (ret_code != SHA204_SUCCESS) {
    				Serial.print(F("Configuration lock failed. Response: "));
    				Serial.println(ret_code, HEX);
    				halt();
    			} else {
    				Serial.println(F("Configuration locked."));
    
    				// Update lock flags after locking
    				ret_code = sha204.sha204m_read(tx_buffer, rx_buffer, SHA204_ZONE_CONFIG, 0x15<<2);
    				if (ret_code != SHA204_SUCCESS) {
    					Serial.print(F("Failed to determine device lock status. Response: "));
    					Serial.println(ret_code, HEX);
    					halt();
    				} else {
    					lockConfig = rx_buffer[SHA204_BUFFER_POS_DATA+3];
    					lockValue = rx_buffer[SHA204_BUFFER_POS_DATA+2];
    				}
    			}
    		}
    #ifndef SKIP_UART_CONFIRMATION
    		else {
    			Serial.println(F("Unexpected answer. Skipping lock."));
    		}
    #endif //not SKIP_UART_CONFIRMATION
    #else //LOCK_CONFIGURATION
    		Serial.println(F("Configuration not locked. Define LOCK_CONFIGURATION to lock for real."));
    #endif
    	} else {
    		Serial.println(F("Skipping configuration write and lock (configuration already locked)."));
    		Serial.println(F("Chip configuration:"));
    		dump_configuration();
    	}
    
    #ifdef SKIP_KEY_STORAGE
    	Serial.println(F("Disable SKIP_KEY_STORAGE to store key."));
    #else
    #ifdef USER_KEY
    	memcpy(key, user_key_data, 32);
    	Serial.println(F("Using this user supplied HMAC key:"));
    #else
    	// Retrieve random value to use as key
    	ret_code = sha204.sha204m_random(tx_buffer, rx_buffer, RANDOM_SEED_UPDATE);
    	if (ret_code != SHA204_SUCCESS) {
    		Serial.print(F("Random key generation failed. Response: "));
    		Serial.println(ret_code, HEX);
    		halt();
    	} else {
    		memcpy(key, rx_buffer+SHA204_BUFFER_POS_DATA, 32);
    	}
    	if (lockConfig == 0x00) {
    		Serial.println(F("Take note of this key, it will never be the shown again:"));
    	} else {
    		Serial.println(F("Key is not randomized (configuration not locked):"));
    	}
    #endif
    	Serial.print("#define MY_HMAC_KEY ");
    	for (int i=0; i<32; i++) {
    		Serial.print("0x");
    		if (key[i] < 0x10) {
    			Serial.print('0'); // Because Serial.print does not 0-pad HEX
    		}
    		Serial.print(key[i], HEX);
    		if (i < 31) {
    			Serial.print(',');
    		}
    		if (i+1 == 16) {
    			Serial.print("\\\n                    ");
    		}
    	}
    	Serial.println();
    
    	// It will not be possible to write the key if the configuration zone is unlocked
    	if (lockConfig == 0x00) {
    		// Write the key to the appropriate slot in the data zone
    		Serial.println(F("Writing key to slot 0..."));
    		write_key(key);
    	} else {
    		Serial.println(F("Skipping key storage (configuration not locked)."));
    		Serial.println(F("The configuration must be locked to be able to write a key."));
    	}
    #endif
    
    	if (lockValue != 0x00) {
    #ifdef LOCK_DATA
    #ifndef SKIP_UART_CONFIRMATION
    		while (Serial.available()) {
    			Serial.read();
    		}
    		Serial.println(F("Send SPACE character to lock data..."));
    		while (Serial.available() == 0);
    		if (Serial.read() == ' ')
    #endif //not SKIP_UART_CONFIRMATION
    		{
    			// Correct sequence, resync chip
    			ret_code = sha204.sha204c_resync(SHA204_RSP_SIZE_MAX, rx_buffer);
    			if (ret_code != SHA204_SUCCESS && ret_code != SHA204_RESYNC_WITH_WAKEUP) {
    				Serial.print(F("Resync failed. Response: "));
    				Serial.println(ret_code, HEX);
    				halt();
    			}
    
    			// If configuration is unlocked, key is not updated. Locking data in this case will cause
    			// slot 0 to contain an unknown (or factory default) key, and this is in practically any
    			// usecase not the desired behaviour, so ask for additional confirmation in this case.
    			if (lockConfig != 0x00) {
    				while (Serial.available()) {
    					Serial.read();
    				}
    				Serial.println(F("*** ATTENTION ***"));
    				Serial.println(F("Configuration is not locked. Are you ABSULOUTELY SURE you want to lock data?"));
    				Serial.println(F("Locking data at this stage will cause slot 0 to contain a factory default key"));
    				Serial.println(
    				    F("which cannot be change after locking is done. This is in practically any usecase"));
    				Serial.println(F("NOT the desired behavour. Send SPACE character now to lock data anyway..."));
    				while (Serial.available() == 0);
    				if (Serial.read() != ' ') {
    					Serial.println(F("Unexpected answer. Skipping lock."));
    					halt();
    				}
    			}
    
    			// Lock data zone
    			ret_code = sha204.sha204m_execute(SHA204_LOCK, SHA204_ZONE_DATA | LOCK_ZONE_NO_CRC,
    			                                  0x0000, 0, NULL, 0, NULL, 0, NULL,
    			                                  LOCK_COUNT, tx_buffer, LOCK_RSP_SIZE, rx_buffer);
    			if (ret_code != SHA204_SUCCESS) {
    				Serial.print(F("Data lock failed. Response: "));
    				Serial.println(ret_code, HEX);
    				halt();
    			} else {
    				Serial.println(F("Data locked."));
    
    				// Update lock flags after locking
    				ret_code = sha204.sha204m_read(tx_buffer, rx_buffer, SHA204_ZONE_CONFIG, 0x15<<2);
    				if (ret_code != SHA204_SUCCESS) {
    					Serial.print(F("Failed to determine device lock status. Response: "));
    					Serial.println(ret_code, HEX);
    					halt();
    				} else {
    					lockConfig = rx_buffer[SHA204_BUFFER_POS_DATA+3];
    					lockValue = rx_buffer[SHA204_BUFFER_POS_DATA+2];
    				}
    			}
    		}
    #ifndef SKIP_UART_CONFIRMATION
    		else {
    			Serial.println(F("Unexpected answer. Skipping lock."));
    		}
    #endif //not SKIP_UART_CONFIRMATION
    #else //LOCK_DATA
    		Serial.println(F("Data not locked. Define LOCK_DATA to lock for real."));
    #endif
    	} else {
    		Serial.println(F("Skipping OTP/data zone lock (zone already locked)."));
    	}
    #endif // not USE_SOFT_SIGNING
    
    	Serial.println(F("--------------------------------"));
    	Serial.println(F("Personalization is now complete."));
    #ifndef USE_SOFT_SIGNING
    	Serial.print(F("Configuration is "));
    	if (lockConfig == 0x00) {
    		Serial.println("LOCKED");
    	} else {
    		Serial.println("UNLOCKED");
    	}
    	Serial.print(F("Data is "));
    	if (lockValue == 0x00) {
    		Serial.println("LOCKED");
    	} else {
    		Serial.println("UNLOCKED");
    	}
    #endif
    }
    
    /** @brief Sketch execution code */
    void loop()
    {
    }```

  • Contest Winner

    @meddie Sorry, missed that post.
    You have SKIP_KEY_STORAGE defined so no keys will be stored. This is the default and intentional, to avoid people just executing the sketch and accidentally overwrite existing keys.
    Furthermore, you have selected to personalize a ATSHA device, and have it generate the keys. That means that you have to define LOCK_CONFIGURATION or the ATSHA random number generator will not work.


  • Contest Winner

    You can read about personalization here.



  • Ah, thank you very much, yes now i get generated a key. But one more question the AES key will not be generated? I got only the HMAC Key, do i have to put the AES Key at myself?
    Thank you very much!


  • Contest Winner

    @meddie Please read the documentation and the sketch carefully. It quite clearly states in both documentation and code that you need to define STORE_AES_KEY to generate and store an AES key.



  • @Anticimex
    sorry sorry for so many questions, i have read the how to use already some times, but maybe its my bad english or the fear to do something wrong or to destroy the chip. I get a little bit unsure.

    Now i get both keys. If i understood correctly, the keys are now stored, i have now to put the shown keys to the sketch as HMAC and AES Key, and run this sketch on the sensor nodes.
    On the gateway on which i generated the keys i dont need to do anything more as to upload the gateway sketch ?
    Thank you very much for your support!


  • Contest Winner

    @meddie assuming you locked the configuration of the atsha, no you should not need to do more.



  • @Anticimex said in πŸ’¬ Sensebender Gateway:

    @meddie Sorry, missed that post.
    You have SKIP_KEY_STORAGE defined so no keys will be stored. This is the default and intentional, to avoid people just executing the sketch and accidentally overwrite existing keys.
    Furthermore, you have selected to personalize a ATSHA device, and have it generate the keys. That means that you have to define LOCK_CONFIGURATION or the ATSHA random number generator will not work.

    @Anticimex
    sorry i have one more question, because i didnt fully understand this. In the gettings started how to you wrote:

    Pick a β€œmaster” device with serial debug port.
    Set the following sketch configuration of the personalizer:
    ...
    
    Enable SKIP_KEY_STORAGE
    ...
    
    Execute the sketch on the β€œmaster” device to obtain a randomized key. Save this key to a secure location and keep it confidential so that you can retrieve it if you need to personalize more devices later on.
    Now reconfigure the sketch with these settings:
    ...
    Disable SKIP_KEY_STORAGE
    ...
    Put the saved key in the user_key_data variable.
    Now execute the sketch on all devices you want to personalize with this secret key.
    

    on the first run i have to enable SKIP_KEY_STORAGE so i removed the comments.
    But here in forum you write i have to disable this. After i has disabled it wroked fine for me.

    But now i have to run the sketch on my node, and i think i have to disable the SKIP function too, because i need that the keys will be stored in the node.

    So if i am right, the on both runs the SKIP function has to be commented out? Or i am wrong?
    Thank you.


  • Contest Winner

    @meddie If your read the text carefully it says:
    Set the following sketch configuration of the personalizer:
    ...
    Execute the sketch on the β€œmaster” device to obtain a randomized key. Save this key to a secure location and keep it confidential so that you can retrieve it if you need to personalize more devices later on.
    Now reconfigure the sketch with these settings:
    ...
    Now execute the sketch on all devices you want to personalize with this secret key.

    So in other words; you first use the settings described in the first setting, execute that once. Follow the instructions carefully. Write down the key you got. Then you reconfigure the sketch and execute it on all devices you want to personalize. That is, you execute it twice on the first device.
    I wrote that you need to undefine SKIP_KEY_STORAGE if you want to store a key. But the first set of instructions in the documentation is not saying that you are supposed to store a key. It says "Execute the sketch on the β€œmaster” device to obtain a randomized key."

    So the documentation is correct, and describe a flow where you personalize nodes and gateways with the minimum amount of changes needed. First you generate a key, and this step can actually be skipped altogether if you just make your own random key or password to use for HMAC/AES.
    Then you reconfigure the personalizer to use your generated (or selected) key and write it to all your devices.



  • @Anticimex
    but as i runned the sketch with SKIP_KEY_STORAGE defined, so no keys were generated.

    i did not like to say that the documentation is incorrect, i like your documentation and your work very well! i just didnt understand it!

    Thank you very much!
    Greets Eddie


  • Contest Winner

    @meddie are you sure you ran with the exact settings described for generating the keys? The SKIP_KEY_STORAGE flag does not prevent the keys from being generated. They are still printed in the serial log. It prevents the keys from being stored to the atsha204a device.



  • i fear to write again, but my fail story goes on 😞
    i have uploaded on the gateway this sketch:

    /**
    * 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-2015 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.
    *
    *******************************
    *
    * REVISION HISTORY
    * Version 1.0 - Henrik EKblad
    * Contribution by a-lurker and Anticimex,
    * Contribution by Norbert Truchsess <norbert.truchsess@t-online.de>
    * Contribution by Tomas Hozza <thozza@gmail.com>
    *
    *
    * DESCRIPTION
    * The EthernetGateway sends data received from sensors to the ethernet link.
    * The gateway also accepts input on ethernet interface, which is then sent out to the radio network.
    *
    * This GW code is designed for Sensebender GateWay / (Arduino Zero variant)
    *
    * Wire connections (OPTIONAL):
    * - Inclusion button should be connected to SW2
    *
    * LEDs on board (default assignments):
    * - Orange: USB RX/TX - Blink when receiving / transmitting on USB CDC device
    * - Yellow: RX  - Blink fast on radio message recieved. In inclusion mode will blink fast only on presentation recieved
    * - Green : TX  - Blink fast on radio message transmitted. In inclusion mode will blink slowly
    * - Red   : ERR - Fast blink on error during transmission error or recieve crc error
    * - Blue  : free - (use with LED_BLUE macro)
    *
    */
    
    #include <stdint.h>
    #include <pins_arduino.h>
    #define SKETCH_VERSION "0.2"
    // Enable debug prints to serial monitor
    #define MY_DEBUG
    #define MY_DEBUG_VERBOSE_SIGNING
    
    // Enable and select radio type attached
    #define MY_RADIO_NRF24
    //#define MY_RADIO_RFM69
    
    // Set LOW transmit power level as default, if you have an amplified NRF-module and
    // power your radio separately with a good regulator you can turn up PA level.
    //#define MY_RF24_PA_LEVEL RF24_PA_HIGH
    
    #define MY_SIGNING_ATSHA204
    //#define MY_SIGNING_NODE_WHITELISTING {{.nodeId = GATEWAY_ADDRESS,.serial = {0x09,0x08,0x07,0x06,0x05,0x04,0x03,0x02,0x01}}}
    //#define MY_SIGNING_REQUEST_SIGNATURES
    #ifndef MY_SIGNING_SOFT_RANDOMSEED_PIN
    #define MY_SIGNING_SOFT_RANDOMSEED_PIN 7
    #endif                              
    #ifndef MY_SIGNING_ATSHA204_PIN
    #define MY_SIGNING_ATSHA204_PIN 17
    #endif        
    #define MY_RF24_ENABLE_ENCRYPTION
        
    // Enable gateway ethernet module type
    #define MY_GATEWAY_W5100
    
    // W5100 Ethernet module SPI enable (optional if using a shield/module that manages SPI_EN signal)
    //#define MY_W5100_SPI_EN 4
    
    // Enable Soft SPI for NRF radio (note different radio wiring is required)
    // The W5100 ethernet module seems to have a hard time co-operate with
    // radio on the same spi bus.
    #if !defined(MY_W5100_SPI_EN) && !defined(ARDUINO_ARCH_SAMD)
    #define MY_SOFTSPI
    #define MY_SOFT_SPI_SCK_PIN 14
    #define MY_SOFT_SPI_MISO_PIN 16
    #define MY_SOFT_SPI_MOSI_PIN 15
    #endif
    
    // When W5100 is connected we have to move CE/CSN pins for NRF radio
    #ifndef MY_RF24_CE_PIN
    #define MY_RF24_CE_PIN 5
    #endif
    #ifndef MY_RF24_CS_PIN
    #define MY_RF24_CS_PIN 6
    #endif
    
    // Enable to UDP
    //#define MY_USE_UDP
    
    #define MY_IP_ADDRESS 10,0,0,253   // If this is disabled, DHCP is used to retrieve address
    // Renewal period if using DHCP
    //#define MY_IP_RENEWAL_INTERVAL 60000
    // The port to keep open on node server mode / or port to contact in client mode
    #define MY_PORT 5003
    
    // Controller ip address. Enables client mode (default is "server" mode).
    // Also enable this if MY_USE_UDP is used and you want sensor data sent somewhere.
    //#define MY_CONTROLLER_IP_ADDRESS 192, 168, 178, 254
    
    // The MAC address can be anything you want but should be unique on your network.
    // Newer boards have a MAC address printed on the underside of the PCB, which you can (optionally) use.
    // Note that most of the Ardunio examples use  "DEAD BEEF FEED" for the MAC address.
    #define MY_MAC_ADDRESS 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED
    
    // Enable inclusion mode
    #define MY_INCLUSION_MODE_FEATURE
    // Enable Inclusion mode button on gateway
    #define MY_INCLUSION_BUTTON_FEATURE
    
    // Inverses behavior of inclusion button (if using external pullup)
    //#define MY_INCLUSION_BUTTON_EXTERNAL_PULLUP
    
    // Set inclusion mode duration (in seconds)
    #define MY_INCLUSION_MODE_DURATION 60
    // Digital pin used for inclusion mode button
    //#define MY_INCLUSION_MODE_BUTTON_PIN  3
    
    // Set blinking period
    #define MY_DEFAULT_LED_BLINK_PERIOD 300
    
    // Inverses the behavior of leds
    //#define MY_WITH_LEDS_BLINKING_INVERSE
    
    // Flash leds on rx/tx/err
    // Uncomment to override default HW configurations
    //#define MY_DEFAULT_ERR_LED_PIN 4  // Error led pin
    //#define MY_DEFAULT_RX_LED_PIN  6  // Receive led pin
    //#define MY_DEFAULT_TX_LED_PIN  5  // the PCB, on board LED
    
    
    #if defined(MY_USE_UDP)
    #include <EthernetUdp.h>
    #endif
    #include <Ethernet.h>
    #include <MySensors.h>
    #include <SD.h>
    //#include <drivers/ATSHA204/ATSHA204.cpp>
    
    Sd2Card card;
    
    #define EEPROM_VERIFICATION_ADDRESS 0x01
    
    static uint8_t num_of_leds = 5;
    static uint8_t leds[] = {LED_BLUE, LED_RED, LED_GREEN, LED_YELLOW, LED_ORANGE};
    
    void setup()
    {
      // Setup locally attached sensors
    }
    
    void presentation()
    {
      // Present locally attached sensors
    }
    
    void loop()
    {
      // Send locally attached sensor data here
    }
    
    
    void preHwInit()
    {
    
      pinMode(MY_SWC1, INPUT_PULLUP);
      pinMode(MY_SWC2, INPUT_PULLUP);
      if (digitalRead(MY_SWC1) && digitalRead(MY_SWC2)) {
        return;
      }
    
      uint8_t tests = 0;
    
      for (int i=0; i< num_of_leds; i++) {
        pinMode(leds[i], OUTPUT);
      }
      uint8_t led_state = 0;
      if (digitalRead(MY_SWC1)) {
        while (!Serial) {
          digitalWrite(LED_BLUE, led_state);
          led_state ^= 0x01;
          delay(500);
        } // Wait for USB to be connected, before spewing out data.
      }
      digitalWrite(LED_BLUE, LOW);
      if (Serial) {
        Serial.println("Sensebender GateWay test routine");
        Serial.print("Mysensors core version : ");
        Serial.println(MYSENSORS_LIBRARY_VERSION);
        Serial.print("GateWay sketch version : ");
        Serial.println(SKETCH_VERSION);
        Serial.println("----------------------------------");
        Serial.println();
      }
      if (testSha204()) {
        digitalWrite(LED_GREEN, HIGH);
        tests++;
      }
      if (testSDCard()) {
        digitalWrite(LED_YELLOW, HIGH);
        tests++;
      }
    
      if (testEEProm()) {
        digitalWrite(LED_ORANGE, HIGH);
        tests++;
      }
      if (testAnalog()) {
        digitalWrite(LED_BLUE, HIGH);
        tests++;
      }
      if (tests == 4) {
        while(1) {
          for (int i=0; i<num_of_leds; i++) {
            digitalWrite(leds[i], HIGH);
            delay(200);
            digitalWrite(leds[i], LOW);
          }
        }
      } else {
        while (1) {
          digitalWrite(LED_RED, HIGH);
          delay(200);
          digitalWrite(LED_RED, LOW);
          delay(200);
        }
      }
    
    }
    
    bool testSha204()
    {
      uint8_t rx_buffer[SHA204_RSP_SIZE_MAX];
      uint8_t ret_code;
      if (Serial) {
        Serial.print("- > SHA204 ");
      }
      atsha204_init(MY_SIGNING_ATSHA204_PIN);
      ret_code = atsha204_wakeup(rx_buffer);
    
      if (ret_code == SHA204_SUCCESS) {
        ret_code = atsha204_getSerialNumber(rx_buffer);
        if (ret_code != SHA204_SUCCESS) {
          if (Serial) {
            Serial.println(F("Failed to obtain device serial number. Response: "));
          }
          Serial.println(ret_code, HEX);
        } else {
          if (Serial) {
            Serial.print(F("Ok (serial : "));
            for (int i=0; i<9; i++) {
              if (rx_buffer[i] < 0x10) {
                Serial.print('0'); // Because Serial.print does not 0-pad HEX
              }
              Serial.print(rx_buffer[i], HEX);
            }
            Serial.println(")");
          }
          return true;
        }
      } else {
        if (Serial) {
          Serial.println(F("Failed to wakeup SHA204"));
        }
      }
      return false;
    }
    
    bool testSDCard()
    {
      if (Serial) {
        Serial.print("- > SD CARD ");
      }
      if (!card.init(SPI_HALF_SPEED, MY_SDCARD_CS)) {
        if (Serial) {
          Serial.println("SD CARD did not initialize!");
        }
      } else {
        if (Serial) {
          Serial.print("SD Card initialized correct! - ");
          Serial.print("type detected : ");
          switch(card.type()) {
          case SD_CARD_TYPE_SD1:
            Serial.println("SD1");
            break;
          case SD_CARD_TYPE_SD2:
            Serial.println("SD2");
            break;
          case SD_CARD_TYPE_SDHC:
            Serial.println("SDHC");
            break;
          default:
            Serial.println("Unknown");
          }
        }
        return true;
      }
      return false;
    }
    
    bool testEEProm()
    {
      uint8_t eeprom_d1, eeprom_d2;
      SerialUSB.print(" -> EEPROM ");
      Wire.begin();
      eeprom_d1 = i2c_eeprom_read_byte(EEPROM_VERIFICATION_ADDRESS);
      delay(500);
      eeprom_d1 = ~eeprom_d1; // invert the bits
      i2c_eeprom_write_byte(EEPROM_VERIFICATION_ADDRESS, eeprom_d1);
      delay(500);
      eeprom_d2 = i2c_eeprom_read_byte(EEPROM_VERIFICATION_ADDRESS);
      if (eeprom_d1 == eeprom_d2) {
        SerialUSB.println("PASSED");
        i2c_eeprom_write_byte(EEPROM_VERIFICATION_ADDRESS, ~eeprom_d1);
        return true;
      }
      SerialUSB.println("FAILED!");
      return false;
    }
    
    bool testAnalog()
    {
      int bat_detect = analogRead(MY_BAT_DETECT);
      Serial.print("-> analog : ");
      Serial.print(bat_detect);
      if (bat_detect < 400 || bat_detect > 650) {
        Serial.println(" Failed");
        return false;
      }
      Serial.println(" Passed");
      return true;
    }
    


  • and on the node this sketch:

    /*
     * 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-2015 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 <stdint.h>
    #include <pins_arduino.h>
    #define MY_DEBUG
    #define MY_DEBUG_VERBOSE_SIGNING
    #define MY_RADIO_NRF24
    //#define MY_SIGNING_SOFT
    #define MY_SIGNING_ATSHA204
    //#define MY_SIGNING_NODE_WHITELISTING {{.nodeId = GATEWAY_ADDRESS,.serial = {0x09,0x08,0x07,0x06,0x05,0x04,0x03,0x02,0x01}}}
    #define MY_SIGNING_REQUEST_SIGNATURES
    #ifndef MY_SIGNING_SOFT_RANDOMSEED_PIN
    #define MY_SIGNING_SOFT_RANDOMSEED_PIN 7
    #endif
    #ifndef MY_SIGNING_ATSHA204_PIN
    #define MY_SIGNING_ATSHA204_PIN 17
    #endif
    #define MY_RF24_ENABLE_ENCRYPTION
    #include <MySensors.h>
    

    But the node does not connect and i get this on the serial monitor:

    0 MCO:BGN:INIT NODE,CP=RNNNAA-,VER=2.1.1
    4 TSM:INIT
    4 TSF:WUR:MS=0
    12 TSM:INIT:TSP OK
    14 TSF:SID:OK,ID=100
    16 TSM:FPAR
    18 Will not sign message for destination 255 as it does not require it
    67 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    2076 !TSM:FPAR:NO REPLY
    2078 TSM:FPAR
    2080 Will not sign message for destination 255 as it does not require it
    2127 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    4139 !TSM:FPAR:NO REPLY
    4141 TSM:FPAR
    4143 Will not sign message for destination 255 as it does not require it
    4190 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    6199 !TSM:FPAR:NO REPLY
    6201 TSM:FPAR
    6203 Will not sign message for destination 255 as it does not require it
    6250 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    8259 !TSM:FPAR:FAIL
    8261 TSM:FAIL:CNT=1
    8263 TSM:FAIL:PDT
    18266 TSM:FAIL:RE-INIT
    18268 TSM:INIT
    18276 TSM:INIT:TSP OK
    18278 TSF:SID:OK,ID=100
    18280 TSM:FPAR
    18282 Will not sign message for destination 255 as it does not require it
    18331 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    20340 !TSM:FPAR:NO REPLY
    20342 TSM:FPAR
    20344 Will not sign message for destination 255 as it does not require it
    20393 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    22403 !TSM:FPAR:NO REPLY
    22405 TSM:FPAR
    22407 Will not sign message for destination 255 as it does not require it
    22456 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    24465 !TSM:FPAR:NO REPLY
    24467 TSM:FPAR
    24469 Will not sign message for destination 255 as it does not require it
    24518 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    26527 !TSM:FPAR:FAIL
    26529 TSM:FAIL:CNT=2
    26531 TSM:FAIL:PDT
    36534 TSM:FAIL:RE-INIT
    36536 TSM:INIT
    36544 TSM:INIT:TSP OK
    36546 TSF:SID:OK,ID=100
    36548 TSM:FPAR
    36550 Will not sign message for destination 255 as it does not require it
    36599 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    38610 !TSM:FPAR:NO REPLY
    38612 TSM:FPAR
    38615 Will not sign message for destination 255 as it does not require it
    38664 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    40673 !TSM:FPAR:NO REPLY
    40675 TSM:FPAR
    40677 Will not sign message for destination 255 as it does not require it
    40726 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    42735 !TSM:FPAR:NO REPLY
    42737 TSM:FPAR
    42739 Will not sign message for destination 255 as it does not require it
    42788 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    44800 !TSM:FPAR:FAIL
    44802 TSM:FAIL:CNT=3
    44804 TSM:FAIL:PDT
    54808 TSM:FAIL:RE-INIT
    54810 TSM:INIT
    54818 TSM:INIT:TSP OK
    54820 TSF:SID:OK,ID=100
    54822 TSM:FPAR
    54824 Will not sign message for destination 255 as it does not require it
    54874 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    56883 !TSM:FPAR:NO REPLY
    56885 TSM:FPAR
    56887 Will not sign message for destination 255 as it does not require it
    56936 TSF:MSG:SEND,100-100-255-255,s=255,c=3,t=7,pt=0,l=0,sg=0,ft=0,st=OK:
    

    please help me once again
    Thank you


  • Contest Winner

    @meddie if you want your node to sign messages to the gateway you have to tell the gateway to require it. The log says that it does not require it and it is clear from your gateway sketch that you have disabled the requirement.
    Is that your problem?
    EDIT: I see that the messages are broadcasts, those will never be signed. So the "will not sign messages" are perfectly normal no matter how you configure your gateway in this case.
    The problem, at least based on the node log is that your node cannot find a parent to communicate with for some reason.


  • Contest Winner

    @meddie for parsing the log file you can use this tool


  • Contest Winner

    @meddie I also see that you fail to find parent. Have you verified that you had working node-gateway communication before you enabled signing?



  • @Anticimex
    Hi, i have just uploaded the GatewayW5100 Sketch to the Gateway and the HumidtyTemp Sketch to the Node and it works fine, but without signing and encryption.


  • Contest Winner

    @meddie You had encryption enabled when it failed? That could explain the failure of the broadcast if you did not have a matching setting between the nodes/gateway.



  • @Anticimex
    yes the encryption was enabled. Should i upload the personalized sketch again with my keys?


  • Contest Winner

    @meddie You can just run an unmodified personalizer to have it read the EEPROM contents. That way you can verify that all devices share the exact same AES key. Assuming a mismatch in the AES key was the reason for the problem.
    But I strongly encourage you to just enable one security feature at a time if you are not sure what you are doing or it will be hard to debug what is going wrong.



  • @Anticimex
    yes, i try to activate one feature and when it works the next. So i decided to activate the encryption and then when it works then i try to activate the signing. But first i would to check the keys like you said and when i now upload the securitypersonalization sketch unmodified i dont get any output on the serial monitor.
    😞


  • Contest Winner

    @meddie Well, you have to make the patch to the baud rate and the changes we discussed earlier. I presume you did something necessary since you got output previously.



  • @Anticimex
    when i run the personalizer sketch i see in all keys FFFFFF....... What does it mean that no keys are stored?


  • Contest Winner

    @meddie yes, that mean eeprom is in default state. The node has not been properly personalized.



  • @Anticimex
    ok, i think i know what went wrong! But i dont know how to fix it. On the first run when i tried came the prompt to sens space to lock configuration i did it.
    Now when i upload the modified personalization sketch with my keys i get this output on serial monitor:
    of course i removed my keys with xx!

    Device serial:   {0xXX,0xXX,0xXX,0xXX,0xXX,0xXX,0xXX,0xXX,0xXX}
    xxxxxxxxxxxxxxxxxxxxx
    Skipping configuration write and lock (configuration already locked).
    Chip configuration:
    EEPROM DATA:
    SOFT_HMAC_KEY | FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
    SOFT_SERIAL   | FFFFFFFFFFFFFFFFFF
    AES_KEY       | XXFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
    ATSHA204A DATA:
               SN[0:1]           |         SN[2:3]           | XX   XX | XX   XX   
                              Revnum                         | 00   09   04   00   
                              SN[4:7]                        | XX   XX   XX   XX   
        SN[8]    |  Reserved13   | I2CEnable | Reserved15    | EE | 10 | 00 | 00   
      I2CAddress |  TempOffset   |  OTPmode  | SelectorMode  | C8 | 00 | 55 | 00   
             SlotConfig00        |       SlotConfig01        | 8F   80 | 80   A1   
             SlotConfig02        |       SlotConfig03        | 82   E0 | A3   60   
             SlotConfig04        |       SlotConfig05        | 94   40 | A0   85   
             SlotConfig06        |       SlotConfig07        | 86   40 | 87   07   
             SlotConfig08        |       SlotConfig09        | 0F   00 | 89   F2   
             SlotConfig0A        |       SlotConfig0B        | 8A   7A | 0B   8B   
             SlotConfig0C        |       SlotConfig0D        | 0C   4C | DD   4D   
             SlotConfig0E        |       SlotConfig0F        | C2   42 | AF   8F   
      UseFlag00  | UpdateCount00 | UseFlag01 | UpdateCount01 | FF | 00 | FF | 00   
      UseFlag02  | UpdateCount02 | UseFlag03 | UpdateCount03 | FF | 00 | FF | 00   
      UseFlag04  | UpdateCount04 | UseFlag05 | UpdateCount05 | FF | 00 | FF | 00   
      UseFlag06  | UpdateCount06 | UseFlag07 | UpdateCount07 | FF | 00 | FF | 00   
                          LastKeyUse[0:3]                    | FF   FF   FF   FF   
                          LastKeyUse[4:7]                    | FF   FF   FF   FF   
                          LastKeyUse[8:B]                    | FF   FF   FF   FF   
                          LastKeyUse[C:F]                    | FF   FF   FF   FF   
      UserExtra  |    Selector   | LockValue |  LockConfig   | 00 | 00 | 55 | 00   
    Using this user supplied HMAC key:
    #define MY_HMAC_KEY 0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,\
                        0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx,0xxx
    Writing key to slot 0...
    Data not locked. Define LOCK_DATA to lock for real.
    --------------------------------
    Personalization is now complete.
    Configuration is LOCKED
    Data is UNLOCKED
    

    i thin this is the reason:

    Skipping configuration write and lock (configuration already locked).
    

    and what i find very interestin that the first two signs of AES Key are correct the rest of them are FFFFF

    AES_KEY       | XXFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
    

    is it possible to unlock the configuration or did i kill the chip?
    Thank you
    Greets Eddie


  • Contest Winner

    @meddie you cannot undo a lock, and you have to lock the chip in order to use it. And it is not an error that it reports chip is already locked since you have locked it already.
    Furthermore, AES key and eeprom has nothing to do with the atsha204a chip so the lock state of the chip is irrelevant.
    Now, why your AES key is only partially stored, I am not sure. But my bet would be that you have an error in the line where you define it in the sketch. A space or something like that.
    Finally, as long as you don't lock the data zone, and you don't tamper with the configuration bits for the atsha204a device, you cannot destroy the chip. You can always replace the hmac key, which is the only thing you program to the atsha using the personalizer. Except for the chip configuration bits, and those the sketch handles for you and once config is locked they are fixed in place.


 

341
Online

8.4k
Users

9.2k
Topics

97.3k
Posts