EnviroDIY/cryptosuite2

Cryptographic suite for Arduino (SHA, HMAC-SHA)

Cryptosuite2

Contents

• Links
• What Is Cryptosuite2?
• Install
  • Using the ZIP for Arduino
  • Manually
• Usage
  • Gotchas
• Todos
• Contributing
• Support

Links

• The code is here.
• The docs are here.

What Is Cryptosuite2?

Cryptosuite2 is a (more or less) drop in replacement for https://github.com/Cathedrow/Cryptosuite. It currently provides SHA256 and HMAC-SHA256.

Install

Using the ZIP for Arduino

Download the latest ZIP release from the release page and install it using the Arduino IDE.

Manually

• Download the library.
• Copy cryptosuite2/sha to ~/sketchbook/libraries (cp -rv cryptosuite2/sha ~/sketchbook/libraries) or ~/Arduino/libraries (cp -rv cryptosuite2/sha ~/Arduino/libraries)

Usage

Take a look at the docs.

Gotchas

• Once Sha256.result() or Sha256.resultHmac() (or sha256_hasher_gethash(), sha256_hasher_gethmac(), sha256_hasher_pad()) have been invoked Sha256.init() (or sha256_hasher_init()) must be invoked!
• The same thing applies for Sha1 and sha1_*.

Todos

You can ask for further features, but right now it seems like all the required stuff is running.

Contributing

Contributions are welcome!

Just add yourself in the contributors.yml file and send a pull request.

All contributions must be licensed under the GNU GPLv3. This is just because keeping track of various licenses is a pain in the ass.

Support

I can give you some assistance in general, but do not expect too much. I have a lot to do. Also I will fix bugs, but it might take a while.