Release v3.2.4 (20201017)

Author: bryan-hunt

CMakeLists.txt

@@ -2,10 +2,10 @@ cmake_minimum_required(VERSION 2.6.4)
 project (cryptoauthlib)
 
 # Set the current release version
-set(VERSION "3.2.3")
+set(VERSION "3.2.4")
 set(VERSION_MAJOR 3)
 set(VERSION_MINOR 2)
-set(VERSION_PATCH 3)
+set(VERSION_PATCH 4)
 
 # Build Options
 option(BUILD_TESTS "Create Test Application with library" OFF)
@@ -21,6 +21,8 @@ if(WIN32)
 string(REPLACE "\\" "/" LOCAL_APP_DATA "$ENV{LOCALAPPDATA}/Microchip")
 set(DEFAULT_LIB_PATH "${LOCAL_APP_DATA}" CACHE
     STRING "The default absolute library path")
+set(DEFAULT_INC_PATH "${LOCAL_APP_DATA}/${PROJECT_NAME}" CACHE
+    STRING "The default include install path")
 set(DEFAULT_CONF_PATH "${LOCAL_APP_DATA}" CACHE
     STRING "The default location of ${PROJECT_NAME}.conf")
 set(DEFAULT_STORE_PATH "${LOCAL_APP_DATA}/${PROJECT_NAME}" CACHE
@@ -29,6 +31,8 @@ else()
 include(GNUInstallDirs)
 set(DEFAULT_LIB_PATH "${CMAKE_INSTALL_FULL_LIBDIR}" CACHE
     STRING "The default absolute library path")
+set(DEFAULT_INC_PATH "${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}" CACHE
+    STRING "The default include install path")
 set(DEFAULT_CONF_PATH "${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME}" CACHE
     STRING "The default location of ${PROJECT_NAME}.conf")
 set(DEFAULT_STORE_PATH "${CMAKE_INSTALL_FULL_LOCALSTATEDIR}/lib/${PROJECT_NAME}" CACHE
@@ -82,8 +86,12 @@ install(CODE "
                  DESTINATION ${DEFAULT_CONF_PATH})
         endif()
         ")
-install(DIRECTORY DESTINATION ${DEFAULT_STORE_PATH})
-install(CODE "execute_process(COMMAND chmod 1777 ${DEFAULT_STORE_PATH})")
+install(DIRECTORY DESTINATION ${DEFAULT_STORE_PATH}
+        DIRECTORY_PERMISSIONS
+          OWNER_EXECUTE OWNER_WRITE OWNER_READ
+          GROUP_EXECUTE GROUP_WRITE GROUP_READ
+          WORLD_EXECUTE WORLD_WRITE WORLD_READ
+        )
 install(CODE "
         if(NOT EXISTS ${DEFAULT_STORE_PATH}/slot.conf.tmpl)
             file(INSTALL ${PROJECT_SOURCE_DIR}/app/pkcs11/slot.conf.tmpl

README.md

@@ -1,4 +1,4 @@
-CryptoAuthLib - Microchip CryptoAuthentication Library
+CryptoAuthLib - Microchip CryptoAuthentication Library {#mainpage}
 ====================================================
 
 Introduction
@@ -10,6 +10,7 @@ device. The family of devices supported currently are:
 - [ATECC108A](http://www.microchip.com/ATECC108A)
 - [ATECC508A](http://www.microchip.com/ATECC508A)
 - [ATECC608A](http://www.microchip.com/ATECC608A)
+- [ATECC608B](http://www.microchip.com/ATECC608B)
 
 The best place to start is with the [Microchip Trust Platform](https://www.microchip.com/design-centers/security-ics/trust-platform)
 

app/README.md

@@ -1,8 +1,13 @@
-app directory - Purpose
-===================
+Application Support
+========================
 
 This directory is for application specific implementation of various use cases.
 
 Methods in this directory provide a simple API to perform potentially complex 
 combinations of calls to the main library or API.
 
+@subpage app_info_ip_prot
+
+@subpage app_info_pkcs11
+
+@subpage app_info_secure_boot

app/ip_protection/README.md

@@ -1,5 +1,7 @@
 IP Protection with Symmetric Authentication
-------------------------
+===========================================
+@page app_info_ip_prot IP Protection with Symmetric Authentication
+
 The IP protection can be easily integrated to the existing projects.The user project should include symmetric_authentication.c & symmetric_authentication.h files which contains the api
 - **symmetric_authenticate()** - For Performing the authentication between host & device.
 

app/pkcs11/README.md

@@ -1,3 +1,7 @@
+PKCS11 Application Information
+===========================================
+@page app_info_pkcs11 PKCS11 Application Information
+
 # Setting up cryptoauthlib as a PKCS11 Provider for your system (LINUX)
 
 These instructions are for building, installing and configuring cryptoauthlib as a pkcs11
@@ -341,4 +345,3 @@ $ p11tool --provider=/usr/lib/libcryptoauth.so
              6e:bf:00:e2:61:f2:7c:82:10:d6:87:d8:06:0f:10:3b:d8:d9
     ```
 
-

app/secure_boot/README.md

@@ -1,4 +1,6 @@
-# Secure boot using ATECC608
+Secure boot using ATECC608
+=========================================================
+@page app_info_secure_boot Secure boot using ATECC608
 
 The SecureBoot command is a new feature on the
 [ATECC608A](https://www.microchip.com/wwwproducts/en/ATECC608A) device compared
@@ -80,4 +82,4 @@ Examples
 -----------
 For more information about secure boot, please see the example implementation
 project and documentation at:
-https://github.com/MicrochipTech/cryptoauth_usecase_secureboot
+https://github.com/MicrochipTech/cryptoauth_usecase_secureboot

app/tng/readme.md

@@ -4,4 +4,7 @@ This folder has a number of convenience functions for working with TNG devices
 (currently ATECC608A-MAHTN-T).
 
 These devices have standard certificates that can be easily read using the
-functions in tng_atcacert_client.h
+functions in tng_atcacert_client.h
+
+@ingroup tng_
+

app/tng/tng_atca.c

@@ -45,22 +45,22 @@ typedef struct
 static tng_cert_map_element g_tng_cert_def_map[] =
 {
 #ifdef ATCA_TNG_LEGACY_SUPPORT
-    { "wdNxAjae", &g_tngtls_cert_def_2_device  },
-    { "Rsuy5YJh", &g_tngtls_cert_def_2_device  },
-    { "BxZvm6q2", &g_tnglora_cert_def_2_device },
+    { "wdNxAjae", &g_tngtls_cert_def_2_device          },
+    { "Rsuy5YJh", &g_tngtls_cert_def_2_device          },
+    { "BxZvm6q2", &g_tnglora_cert_def_2_device         },
 #endif
 #ifdef ATCA_TFLEX_SUPPORT
-    { "MKMwyhP1", &g_tflxtls_cert_def_4_device },
+    { "MKMwyhP1", &g_tflxtls_cert_def_4_device         },
 #endif
 #ifdef ATCA_TNGTLS_SUPPORT
-    { "KQp2ZkD8", &g_tngtls_cert_def_3_device  },
-    { "x6tjuZMy", &g_tngtls_cert_def_3_device  },
+    { "KQp2ZkD8", &g_tngtls_cert_def_3_device          },
+    { "x6tjuZMy", &g_tngtls_cert_def_3_device          },
 #endif
 #ifdef ATCA_TNGLORA_SUPPORT
-    { "jsMu7iYO", &g_tnglora_cert_def_4_device },
-    { "09qJNxI3", &g_tnglora_cert_def_4_device },
+    { "jsMu7iYO", &g_tnglora_cert_def_4_device         },
+    { "09qJNxI3", &g_tnglora_cert_def_4_device         },
 #endif
-    { "",         NULL                         }
+    { "",         NULL                                 }
 };
 
 static const size_t g_tng_cert_def_cnt = sizeof(g_tng_cert_def_map) / sizeof(tng_cert_map_element) - 1;
@@ -122,4 +122,4 @@ ATCA_STATUS tng_get_device_pubkey(uint8_t *public_key)
     }
 
     return status;
-}
+}

app/tng/tnglora_cert_def_1_signer.c

@@ -31,7 +31,7 @@
 extern const uint8_t g_tngtls_cert_template_1_signer[];
 extern const atcacert_cert_element_t g_tngtls_cert_elements_1_signer[];
 
-const atcacert_def_t g_tnglora_cert_def_1_signer = {
+SHARED_LIB_EXPORT const atcacert_def_t g_tnglora_cert_def_1_signer = {
     .type                = CERTTYPE_X509,
     .template_id         = 1,
     .chain_id            = 0,

app/tng/tnglora_cert_def_1_signer.h

@@ -37,8 +37,7 @@ extern "C" {
 /** \ingroup tng_
  * @{
  */
-
-extern const atcacert_def_t g_tnglora_cert_def_1_signer;
+ATCA_DLL const atcacert_def_t g_tnglora_cert_def_1_signer;
 
 /** @} */