trezor-firmware/crypto/README.md

# trezor-crypto

[![Build Status](https://travis-ci.org/trezor/trezor-crypto.svg?branch=master)](https://travis-ci.org/trezor/trezor-crypto) [![gitter](https://badges.gitter.im/trezor/community.svg)](https://gitter.im/trezor/community)

Heavily optimized cryptography algorithms for embedded devices.

These include:
- AES/Rijndael encryption/decryption
- Big Number (256 bit) Arithmetics
- BIP32 Hierarchical Deterministic Wallets
- BIP39 Mnemonic code
- ECDSA signing/verifying (supports secp256k1 and nist256p1 curves,
  uses RFC6979 for deterministic signatures)
- ECDSA public key derivation
- Schnorr (BCH variant) signing/verifying
- Base32 (RFC4648 and custom alphabets)
- Base58 address representation
- Ed25519 signing/verifying (also SHA3 and Keccak variants)
- ECDH using secp256k1, nist256p1 and Curve25519
- HMAC-SHA256 and HMAC-SHA512
- PBKDF2
- RIPEMD-160
- SHA1
- SHA2-256/SHA2-512
- SHA3/Keccak
- BLAKE2s/BLAKE2b
- Chacha20-Poly1305
- unit tests (using Check - check.sf.net; in test_check.c)
- tests against OpenSSL (in test_openssl.c)
- integrated Wycheproof tests

Distibuted under MIT License.

## Some parts of the library come from external sources:

- AES: https://github.com/BrianGladman/aes
- Base58: https://github.com/luke-jr/libbase58
- BLAKE2s/BLAKE2b: https://github.com/BLAKE2/BLAKE2
- RIPEMD-160: https://github.com/ARMmbed/mbedtls
- SHA1/SHA2: http://www.aarongifford.com/computers/sha.html
- SHA3: https://github.com/rhash/RHash
- Curve25519: https://github.com/agl/curve25519-donna
- Ed25519: https://github.com/floodyberry/ed25519-donna
- Chacha20: https://github.com/wg/c20p1305
- Poly1305: https://github.com/floodyberry/poly1305-donna
update readme 2016-05-11 19:15:48 +00:00			`# trezor-crypto`
import sources 2013-08-17 12:20:15 +00:00
update readme 2016-05-11 19:15:48 +00:00			`[![Build Status](https://travis-ci.org/trezor/trezor-crypto.svg?branch=master)](https://travis-ci.org/trezor/trezor-crypto) [![gitter](https://badges.gitter.im/trezor/community.svg)](https://gitter.im/trezor/community)`
README: add travis badge 2015-07-29 18:53:36 +00:00
renamed to trezor-crypto, modified readme 2013-10-08 12:18:35 +00:00			`Heavily optimized cryptography algorithms for embedded devices.`
import sources 2013-08-17 12:20:15 +00:00
renamed to trezor-crypto, modified readme 2013-10-08 12:18:35 +00:00			`These include:`
replace blowfish with rijndael 2013-10-10 12:58:59 +00:00			`- AES/Rijndael encryption/decryption`
renamed to trezor-crypto, modified readme 2013-10-08 12:18:35 +00:00			`- Big Number (256 bit) Arithmetics`
			`- BIP32 Hierarchical Deterministic Wallets`
bip39 implementation with unit tests 2013-11-08 00:24:47 +00:00			`- BIP39 Mnemonic code`
Update documentation regarding ECDSA curves support 2015-07-07 07:38:16 +00:00			`- ECDSA signing/verifying (supports secp256k1 and nist256p1 curves,`
small readme update 2013-10-08 15:25:28 +00:00			`uses RFC6979 for deterministic signatures)`
whitespace in bip32.[ch], formatting in readme 2017-05-08 12:57:55 +00:00			`- ECDSA public key derivation`
Add support for Schnorr crypto (BCH variant) Support Schnorr signature and verification defined in https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/2019-05-15-schnorr.md. The implementation is based on https://github.com/Bitcoin-ABC/secp256k1 as well as the test vectors. 2019-04-20 14:01:04 +00:00			`- Schnorr (BCH variant) signing/verifying`
README: Add Base32 custom alphabet support 2017-06-05 18:17:30 +00:00			`- Base32 (RFC4648 and custom alphabets)`
whitespace in bip32.[ch], formatting in readme 2017-05-08 12:57:55 +00:00			`- Base58 address representation`
add more info to readme 2017-06-05 15:04:11 +00:00			`- Ed25519 signing/verifying (also SHA3 and Keccak variants)`
add ECDH to readme 2016-10-21 22:29:14 +00:00			`- ECDH using secp256k1, nist256p1 and Curve25519`
renamed to trezor-crypto, modified readme 2013-10-08 12:18:35 +00:00			`- HMAC-SHA256 and HMAC-SHA512`
use PBKDF2 for BIP39, add unit tests 2013-12-09 15:21:42 +00:00			`- PBKDF2`
renamed to trezor-crypto, modified readme 2013-10-08 12:18:35 +00:00			`- RIPEMD-160`
update readme for sources 2017-05-08 15:15:54 +00:00			`- SHA1`
			`- SHA2-256/SHA2-512`
add sha3 from rhash 2016-04-26 09:09:29 +00:00			`- SHA3/Keccak`
fix typo in readme 2017-03-30 23:36:29 +00:00			`- BLAKE2s/BLAKE2b`
add chacha20poly1305 2017-05-11 11:27:34 +00:00			`- Chacha20-Poly1305`
remove test_{sign,verify}_speed from tests.c, rename tests to test_check.c, rework test_speed 2017-06-03 21:43:58 +00:00			`- unit tests (using Check - check.sf.net; in test_check.c)`
			`- tests against OpenSSL (in test_openssl.c)`
integrate Wycheproof tests 2018-07-16 10:53:55 +00:00			`- integrated Wycheproof tests`
add more comments to readme 2013-08-21 16:07:02 +00:00
renamed to trezor-crypto, modified readme 2013-10-08 12:18:35 +00:00			`Distibuted under MIT License.`
update readme for sources 2017-05-08 15:15:54 +00:00
			`## Some parts of the library come from external sources:`

			`- AES: https://github.com/BrianGladman/aes`
			`- Base58: https://github.com/luke-jr/libbase58`
			`- BLAKE2s/BLAKE2b: https://github.com/BLAKE2/BLAKE2`
			`- RIPEMD-160: https://github.com/ARMmbed/mbedtls`
			`- SHA1/SHA2: http://www.aarongifford.com/computers/sha.html`
			`- SHA3: https://github.com/rhash/RHash`
			`- Curve25519: https://github.com/agl/curve25519-donna`
			`- Ed25519: https://github.com/floodyberry/ed25519-donna`
add chacha20poly1305 2017-05-11 11:27:34 +00:00			`- Chacha20: https://github.com/wg/c20p1305`
			`- Poly1305: https://github.com/floodyberry/poly1305-donna`