Release v3.1.0 (20200205)

Author: bryan-hunt

.travis.yml

@@ -1,37 +1,37 @@
-language: python
-
-matrix:
-  include:
-#    - sudo: required
-#      services:
-#        - docker
-#      env:
-#        - PIP=pip
-#        - PYTHON=python
-#        - CIBW_BEFORE_BUILD_LINUX='yum install cmake -y'
-    - os: osx
-      language: generic
-      compiler: gcc
-      env:
-        - PIP=pip2
-        - PYTHON=python2
-
-script:
-  - cd python
-  - git describe --tags >VERSION
-  - cp -r ../lib .
-  - cp -r ../third_party .
-  - cp ../test/atca_utils_sizes.c .
-  - mkdir app
-  - cp -r ../app/tng app
-  - $PIP install wheel
-  - $PYTHON setup.py sdist --dist-dir wheelhouse
-  - $PIP install cibuildwheel
-  - export CIBW_SKIP='cp34-*'
-  - export CIBW_BUILD_VERBOSITY=3
-  - cibuildwheel --output-dir wheelhouse
-  - |
-    if [[ $TRAVIS_TAG ]]; then
-      $PIP install twine
-      $PYTHON -m twine upload wheelhouse/* --skip-existing
-    fi
+language: python
+
+matrix:
+  include:
+#    - sudo: required
+#      services:
+#        - docker
+#      env:
+#        - PIP=pip
+#        - PYTHON=python
+#        - CIBW_BEFORE_BUILD_LINUX='yum install cmake -y'
+    - os: osx
+      language: generic
+      compiler: gcc
+      env:
+        - PIP=pip2
+        - PYTHON=python2
+
+script:
+  - cd python
+  - git describe --exclude v* --tags --abbrev=0 >VERSION
+  - cp -r ../lib .
+  - cp -r ../third_party .
+  - cp ../test/atca_utils_sizes.c .
+  - mkdir app
+  - cp -r ../app/tng app
+  - $PIP install wheel
+  - $PYTHON setup.py sdist --dist-dir wheelhouse
+  - $PIP install cibuildwheel
+  - export CIBW_SKIP='cp34-*'
+  - export CIBW_BUILD_VERBOSITY=3
+  - cibuildwheel --output-dir wheelhouse
+  - |
+    if [[ $TRAVIS_TAG  =~ ^[0-9]+$ ]]; then
+      $PIP install twine
+      $PYTHON -m twine upload wheelhouse/* --skip-existing
+    fi

CMakeLists.txt

@@ -1,27 +1,27 @@
-cmake_minimum_required(VERSION 2.6.4)
-project (cryptoauthlib)
-
-# Set the current release version
-set(VERSION "2018.10.26")
-set(VERSION_MAJOR 2028)
-set(VERSION_MINOR 10)
-set(VERSION_PATCH 26)
-
-# Build Options
-option(BUILD_TESTS "Create Test Application with library" OFF)
-#set(ATCA_PKCS11 ON CACHE INTERNAL "")
-
-message(STATUS "Building Configuration: ${CMAKE_BUILD_TYPE}")
-
-
-if(BUILD_TESTS)
-set(ATCA_BUILD_SHARED_LIBS OFF CACHE INTERNAL "")
-endif(BUILD_TESTS)
-
-add_subdirectory(lib)
-
-# Tests
-if(BUILD_TESTS)
-add_subdirectory(test)
-endif(BUILD_TESTS)
-
+cmake_minimum_required(VERSION 2.6.4)
+project (cryptoauthlib)
+
+# Set the current release version
+set(VERSION "3.1.0")
+set(VERSION_MAJOR 3)
+set(VERSION_MINOR 1)
+set(VERSION_PATCH 0)
+
+# Build Options
+option(BUILD_TESTS "Create Test Application with library" OFF)
+#set(ATCA_PKCS11 ON CACHE INTERNAL "")
+
+message(STATUS "Building Configuration: ${CMAKE_BUILD_TYPE}")
+
+
+if(BUILD_TESTS)
+set(ATCA_BUILD_SHARED_LIBS OFF CACHE INTERNAL "")
+endif(BUILD_TESTS)
+
+add_subdirectory(lib)
+
+# Tests
+if(BUILD_TESTS)
+add_subdirectory(test)
+endif(BUILD_TESTS)
+

README.md

@@ -59,8 +59,49 @@ Examples
     asymmetric techniques.
     http://www.microchip.com/SWLibraryWeb/product.aspx?product=CryptoAuthLib
 
+Configuration
+-----------
+In order to properly configured the library there must be a header file in your
+project named `atca_config.h` at minimum this needs to contain defines for the
+hal and device types being used:
+
+```
+/* Cryptoauthlib Configuration File */
+#ifndef ATCA_CONFIG_H
+#define ATCA_CONFIG_H
+
+/* Include HALS */
+#define ATCA_HAL_I2C
+
+/* Included device support */
+#define ATCA_ATECC608A_SUPPORT
+
+/* \brief How long to wait after an initial wake failure for the POST to
+ *         complete.
+ * If Power-on self test (POST) is enabled, the self test will run on waking
+ * from sleep or during power-on, which delays the wake reply.
+ */
+#ifndef ATCA_POST_DELAY_MSEC
+#define ATCA_POST_DELAY_MSEC 25
+#endif
+
+#endif // ATCA_CONFIG_H
+```
+
+
 Release notes
 -----------
+02/05/2020 (v3.1.0)
+  - The library is now semantic versioned along with the legacy date versioning.
+    Python will continue to be released with the date version. Version APIs have
+    been updated.
+  - Configuration is done via a configuration file atca_config.h rather than
+    global compiler options. You have to add this file to your project to support
+    this version of the library. 
+  - Harmony 3 support has been added. Update harmony configurator (and content
+    loader) or manually clone crytoauthlib into your harmony directory.
+  - Additional Compiler support has been added for IAR-ARM and ARMCC
+
 11/22/2019
   - Patches for CVE-2019-16128 & CVE-2019-16129: Ensure reported packet length
     is valid for the packet being processed.