diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 index 0000000..f6de4c1 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,107 @@ +## Release Notes + +### wolfTPM Release 1.5 (02/20/2019) + +**Summary** + +Adds support for the Microchip ATTPM20 TPM 2.0 module and Barebox bootloader. Improvements for TLS client/server examples and overall performance. Adds TPM wrappers for HMAC, AES Key Loading and Benchmarking support for RNG/AES/Hashing/TLS. + +**Detail** + +* Fixed issue with cleanup not unregistering the crypto callback. (PR #60) +* Added support for Microchip ATTPM20 part. (PR #59) +* Added support for Barebox (experimental). (PR #52) +* Added TLS benchmarking for CPS and KB/Sec. Enabled with `TLS_BENCH_MODE`. (PR #56) +* Added TLS client/server support for symmetric AES/HMAC/RNG and mutual auth. (PR #56) +* Added TIS locking protection for concurrent process access. Enabled using `WOLFTPM_TIS_LOCK`. (PR #56) +* Added symmetric AES encrypt and decrypt wrappers and examples. (PR #54 and PR #55) +* Added HMAC wrappers and examples. (PR #56) +* Added wrappers and examples for loading external HMAC and AES keys. (PR #56) +* Added delete key wrapper and example. (PR #58) +* Added ECDH support for ephemeral key generation and shared secret. (PR #50) +* Added benchmark support for RNG, AES (CTR, CBC, CFB) 128/256 and SHA-1, SHA-256, SHA-384 and SHA-512. (PR #54) +* Added new `wolfTPM2_GetCapabilities` wrapper API for getting chip info. (PR #51) +* Added command and response logging use `./configure --enable-debug=verbose` or `#define WOLFTPM_DEBUG_VERBOSE`. (PR #54) +* Added option to enable raw IO logging using `WOLFTPM_DEBUG_IO`. (PR #54) +* Added option to disable TPM Benchmark code using `NO_TPM_BENCH`. (#60) +* Added examples/README.md for setup instructions. +* Tuned max SPI clock and performance for supported TPM 2.0 chips. (PR #56) +* Cleanup to move common test parameters into examples/tpm_test.h. (PR #54) +* Updated benchmarks and console output for examples in README.md. + +### wolfTPM Release 1.4 (11/13/2018) + +* Fixed cryptodev ECC callback to use R and S for the signature verify. (PR #39) +* Fixed printf type warnings with `DEBUG_WOLFTPM` defined. (PR #37) +* Fixed detection of correct hash algorithm in `wolfTPM2_VerifyHash`. (PR #39) +* Fix bug with native example where TPM2_Shutdown failure would loop. (PR #34) +* Fix to decoupled the fixed TPM algorithms/sizes from wolfCrypt build options. (PR #35) +* Fix for building with different wolfCrypt options. (PR #26) +* Fix for byte swap build error. (PR #26) +* Fix CSR example CertName to use designated initializers to resolve use against different wolfSSL versions. (PR #25) +* Improved portability by eliminating the packed TPM2_HEADER. (PR #45) +* Improved stack reduction by eliminating the private section from WOLFTPM2_KEY struct. (PR #31) +* Added TLS server example for wolfTPM. (PR #30) +* Added more RSA and ECC key loading examples. (PR #47) +* Added support for loading an external private keys using new API's `wolfTPM2_LoadPrivateKey`, `wolfTPM2_LoadRsaPrivateKey`, and `wolfTPM2_LoadEccPrivateKey`. (PR #46) +* Added example for reading the firmware version using `TPM2_GetCapability` with `TPM_PT_FIRMWARE_VERSION_1`. (PR #44) +* Added hashing wrappers and tests using new API's: `wolfTPM2_HashStart`, `wolfTPM2_HashUpdate` and `wolfTPM2_HashFinish`. (PR #40) +* Added PKCS7 7 sign/verify example demonstrating large data case using chunked buffer and new `_ex` functions. (PR #32) +* Added Key Generation to benchmark. (PR #33) +* Added ST33TP I2C TPM 2.0 support (`./configure --enable-st33 --enable-i2c`). (PR #33) +* Added ST33TP SPI TPM 2.0 support (`--enable-st33` or `#define WOLFTPM_ST33`). (PR #25) +* Added support for Atmel ASF SPI. (PR #25) +* Added example for IAR EWARM. (PR #27) +* Added ECC verify test using public key and NIST test vectors. (PR #39) +* Added new RNG wrapper API `wolfTPM2_GetRandom`. (PR #36) +* Added macro for hardware RNG max request as `MAX_RNG_REQ_SIZE`. (PR #36) +* Added instructions for enabling SPI and I2C on the Raspberry Pi. (PR #34) +* Added support for symmetric AES encrypt/decrypt. (PR #29) +* Added wrapper to help with creation of symmetric keys. (PR #29) +* Added advanced IO callback support (enabled using `--enable-advio` or `#define WOLFTPM_ADV_IO`). (PR #25) +* Added overridable define `WOLFTPM_LOCALITY_DEFAULT` for the locality used. (PR #28) +* Added `XTPM_WAIT()` macro to enable custom wait between polling. (PR #28) +* Added build option to disable wolfCrypt dependency using `./configure --disable-wolfcrypt` or `#define WOLFTPM2_NO_WOLFCRYPT`. (PR #24) +* Removed unused SET, CLEAR, TRUE, FALSE macros. (PR #28) +* Cleanup DEBUG_WOLFTPM ifdef's around all printfs in library proper. (PR #38) +* Cleanup of line lengths. (PR #37) +* Cleanup of wrapper test to move test data into `tpm_test.h`. (PR #47) +* Cleanup of the packet code to handle determining of size (mark/place). (PR #46) +* Cleanup of the IO callback examples. (PR #25) +* Cleanup of TIS layer improve return code and timeout handling. (PR #28) +* Cleanup to move types and configuration/port specific items into new `tpm2_types.h`. (PR #24) + +### wolfTPM Release 1.3 (07/20/2018) + +* Fixed the TIS TPM_BASE_ADDRESS to conform to specification. (PR #19) +* Fixed static analysis warnings. (PR #20) +* Fixed minor build warnings with different compilers. (PR #21) +* Fixed TPM failure for RSA exponents less than 7 by using software based RSA. (PR #23) +* Added TPM benchmarking support. (PR #16) +* Added functions to import/export public keys as wolf format. (PR #15) +* Added PKCS7 example to show sign/verify with TPM. (PR #17) +* Added CSR example to generate certificate request based on TPM key. (PR #17) +* Added CSR signing script `./certs/certreq.sh` to create certificate using self-signed CA. (PR #17) +* Added TLS Client example that uses TPM based key for client certificate. (PR #17) +* Added support for wolfSSL `WOLF_CRYPT_DEV` callbacks to enable TPM based ECC and RSA private keys. (PR #17) +* Added ability to clear/reset TPM using `./examples/wrap/wrap_test 1` (PR #17) +* Moved some of the example configuration into `./examples/tpm_io.h`. (PR #17) + +### wolfTPM Release 1.1 (03/09/2018) + +* Added TPM2 wrapper layer to simplify key creation, RSA encrypt/decrypt, ECC sign/verify and ECDH. +* Added TPM2 wrapper example code. +* Added Linux SPI support for running on Raspberry Pi. +* Fixes for TPM2 command and response assembly and parsing. +* Fixes to support authentication for command and response. +* Progress on supporting parameter encryption/decryption. +* Refactor of TIS and Packet layers into new files. +* Fixes/improvements to `wolfTPM2_GetRCString` for error code and string reporting. +* Added new `TPM2_Cleanup` function. +* New tests for TPM2 native API's (test coverage is about 75%). + +### wolfTPM Release 1.0 (02/06/2018) + +* Support for all TPM2 native API's using TIS and SPI IO callback. +* Helper for getting TPM return code string `TPM2_GetRCString`. +* TPM 2.0 demo code in `examples/tpm/tpm2_demo.c` with support for STM32 CubeMX SPI as reference. diff --git a/Makefile.am b/Makefile.am index 1bfe396..e25b831 100644 --- a/Makefile.am +++ b/Makefile.am @@ -38,6 +38,7 @@ include IDE/include.am include certs/include.am EXTRA_DIST+= README.md +EXTRA_DIST+= ChangeLog.md EXTRA_DIST+= LICENSE EXTRA_DIST+= autogen.sh diff --git a/README.md b/README.md index 4933d2a..392eae4 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,6 @@ Build wolfTPM: make ``` - ### Build options and defines ``` @@ -154,88 +153,6 @@ make WOLFTPM_TIS_LOCK Enable Linux Named Semaphore for locking access to SPI device for concurrent access between processes. ``` -## Release Notes - - -### wolfTPM Release 1.4 (11/13/2018) - -* Fixed cryptodev ECC callback to use R and S for the signature verify. (PR #39) -* Fixed printf type warnings with `DEBUG_WOLFTPM` defined. (PR #37) -* Fixed detection of correct hash algorithm in `wolfTPM2_VerifyHash`. (PR #39) -* Fix bug with native example where TPM2_Shutdown failure would loop. (PR #34) -* Fix to decoupled the fixed TPM algorithms/sizes from wolfCrypt build options. (PR #35) -* Fix for building with different wolfCrypt options. (PR #26) -* Fix for byte swap build error. (PR #26) -* Fix CSR example CertName to use designated initializers to resolve use against different wolfSSL versions. (PR #25) -* Improved portability by eliminating the packed TPM2_HEADER. (PR #45) -* Improved stack reduction by eliminating the private section from WOLFTPM2_KEY struct. (PR #31) -* Added TLS server example for wolfTPM. (PR #30) -* Added more RSA and ECC key loading examples. (PR #47) -* Added support for loading an external private keys using new API's `wolfTPM2_LoadPrivateKey`, `wolfTPM2_LoadRsaPrivateKey`, and `wolfTPM2_LoadEccPrivateKey`. (PR #46) -* Added example for reading the firmware version using `TPM2_GetCapability` with `TPM_PT_FIRMWARE_VERSION_1`. (PR #44) -* Added hashing wrappers and tests using new API's: `wolfTPM2_HashStart`, `wolfTPM2_HashUpdate` and `wolfTPM2_HashFinish`. (PR #40) -* Added PKCS7 7 sign/verify example demonstrating large data case using chunked buffer and new `_ex` functions. (PR #32) -* Added Key Generation to benchmark. (PR #33) -* Added ST33TP I2C TPM 2.0 support (`./configure --enable-st33 --enable-i2c`). (PR #33) -* Added ST33TP SPI TPM 2.0 support (`--enable-st33` or `#define WOLFTPM_ST33`). (PR #25) -* Added support for Atmel ASF SPI. (PR #25) -* Added example for IAR EWARM. (PR #27) -* Added ECC verify test using public key and NIST test vectors. (PR #39) -* Added new RNG wrapper API `wolfTPM2_GetRandom`. (PR #36) -* Added macro for hardware RNG max request as `MAX_RNG_REQ_SIZE`. (PR #36) -* Added instructions for enabling SPI and I2C on the Raspberry Pi. (PR #34) -* Added support for symmetric AES encrypt/decrypt. (PR #29) -* Added wrapper to help with creation of symmetric keys. (PR #29) -* Added advanced IO callback support (enabled using `--enable-advio` or `#define WOLFTPM_ADV_IO`). (PR #25) -* Added overridable define `WOLFTPM_LOCALITY_DEFAULT` for the locality used. (PR #28) -* Added `XTPM_WAIT()` macro to enable custom wait between polling. (PR #28) -* Added build option to disable wolfCrypt dependency using `./configure --disable-wolfcrypt` or `#define WOLFTPM2_NO_WOLFCRYPT`. (PR #24) -* Removed unused SET, CLEAR, TRUE, FALSE macros. (PR #28) -* Cleanup DEBUG_WOLFTPM ifdef's around all printfs in library proper. (PR #38) -* Cleanup of line lengths. (PR #37) -* Cleanup of wrapper test to move test data into `tpm_test.h`. (PR #47) -* Cleanup of the packet code to handle determining of size (mark/place). (PR #46) -* Cleanup of the IO callback examples. (PR #25) -* Cleanup of TIS layer improve return code and timeout handling. (PR #28) -* Cleanup to move types and configuration/port specific items into new `tpm2_types.h`. (PR #24) - - -### wolfTPM Release 1.3 (07/20/2018) - -* Fixed the TIS TPM_BASE_ADDRESS to conform to specification. (PR #19) -* Fixed static analysis warnings. (PR #20) -* Fixed minor build warnings with different compilers. (PR #21) -* Fixed TPM failure for RSA exponents less than 7 by using software based RSA. (PR #23) -* Added TPM benchmarking support. (PR #16) -* Added functions to import/export public keys as wolf format. (PR #15) -* Added PKCS7 example to show sign/verify with TPM. (PR #17) -* Added CSR example to generate certificate request based on TPM key. (PR #17) -* Added CSR signing script `./certs/certreq.sh` to create certificate using self-signed CA. (PR #17) -* Added TLS Client example that uses TPM based key for client certificate. (PR #17) -* Added support for wolfSSL `WOLF_CRYPT_DEV` callbacks to enable TPM based ECC and RSA private keys. (PR #17) -* Added ability to clear/reset TPM using `./examples/wrap/wrap_test 1` (PR #17) -* Moved some of the example configuration into `./examples/tpm_io.h`. (PR #17) - -### wolfTPM Release 1.1 (03/09/2018) - -* Added TPM2 wrapper layer to simplify key creation, RSA encrypt/decrypt, ECC sign/verify and ECDH. -* Added TPM2 wrapper example code. -* Added Linux SPI support for running on Raspberry Pi. -* Fixes for TPM2 command and response assembly and parsing. -* Fixes to support authentication for command and response. -* Progress on supporting parameter encryption/decryption. -* Refactor of TIS and Packet layers into new files. -* Fixes/improvements to `wolfTPM2_GetRCString` for error code and string reporting. -* Added new `TPM2_Cleanup` function. -* New tests for TPM2 native API's (test coverage is about 75%). - -### wolfTPM Release 1.0 (02/06/2018) - -* Support for all TPM2 native API's using TIS and SPI IO callback. -* Helper for getting TPM return code string `TPM2_GetRCString`. -* TPM 2.0 demo code in `examples/tpm/tpm2_demo.c` with support for STM32 CubeMX SPI as reference. - - ## Running Examples These examples demonstrate features of a TPM 2.0 module. The examples create RSA and ECC keys in NV for testing using handles defined in `./examples/tpm_io.h`. The PKCS #7 and TLS examples require generating CSR's and signing them using a test script. See `examples/README.md` for details on using the examples. To run the TLS sever and client on same machine you must build with `WOLFTPM_TIS_LOCK` to enable concurrent access protection. diff --git a/configure.ac b/configure.ac index 81de036..c2d0ac3 100644 --- a/configure.ac +++ b/configure.ac @@ -3,7 +3,7 @@ # All right reserved. AC_COPYRIGHT([Copyright (C) 2014-2018 wolfSSL Inc.]) -AC_INIT([wolftpm],[1.4.0],[https://github.com/wolfssl/wolfTPM/issues],[wolftpm],[http://www.wolfssl.com]) +AC_INIT([wolftpm],[1.5.0],[https://github.com/wolfssl/wolfTPM/issues],[wolftpm],[http://www.wolfssl.com]) AC_PREREQ([2.63]) AC_CONFIG_AUX_DIR([build-aux]) @@ -23,7 +23,7 @@ AC_ARG_PROGRAM AC_CONFIG_MACRO_DIR([m4]) AC_CONFIG_HEADERS([src/config.h]) -WOLFTPM_LIBRARY_VERSION=4:0:0 +WOLFTPM_LIBRARY_VERSION=5:0:0 # | | | # +------+ | +---+ # | | | diff --git a/wolftpm/version.h b/wolftpm/version.h index 556ca44..f2f54f5 100644 --- a/wolftpm/version.h +++ b/wolftpm/version.h @@ -34,8 +34,8 @@ extern "C" { #endif -#define LIBWOLFTPM_VERSION_STRING "1.4.0" -#define LIBWOLFTPM_VERSION_HEX 0x01004000 +#define LIBWOLFTPM_VERSION_STRING "1.5.0" +#define LIBWOLFTPM_VERSION_HEX 0x01005000 #ifdef __cplusplus }