MCU8MASS-1790 Bring back getThingName and getEndpoint, but marked as deprecated

Author: M65649

src/ecc608.cpp

@@ -52,7 +52,7 @@ ATCA_STATUS ECC608Class::begin() {
     return atcab_init(&ECCConfig);
 }
 
-ATCA_STATUS ECC608Class::readProvisionItem(const enum EccDataType type,
+ATCA_STATUS ECC608Class::readProvisionItem(const enum ecc_data_types type,
                                            uint8_t* buffer,
                                            size_t* size) {
 
@@ -124,6 +124,28 @@ ATCA_STATUS ECC608Class::readProvisionItem(const enum EccDataType type,
     return ATCA_INVALID_ID;
 }
 
+ATCA_STATUS ECC608Class::getThingName(uint8_t* thing_name, uint8_t* size) {
+    // Need this to bridge the compatibility between using size_t and uint8_t.
+    // This function will be deprecated later.
+    size_t thing_name_size = *size;
+    const ATCA_STATUS result =
+        readProvisionItem(AWS_THINGNAME, thing_name, &thing_name_size);
+    *size = thing_name_size;
+
+    return result;
+}
+
+ATCA_STATUS ECC608Class::getEndpoint(uint8_t* endpoint, uint8_t* size) {
+    // Need this to bridge the compatibility between using size_t and uint8_t.
+    // This function will be deprecated later.
+    size_t endpoint_size = *size;
+    const ATCA_STATUS result =
+        readProvisionItem(AWS_ENDPOINT, endpoint, &endpoint_size);
+    *size = endpoint_size;
+
+    return result;
+}
+
 int ECC608Class::getRootCertificateSize(size_t* size) {
     return tng_atcacert_root_cert_size(size);
 }

src/ecc608.h

@@ -9,7 +9,7 @@
 #include "cryptoauthlib/lib/atcacert/atcacert.h"
 #include "cryptoauthlib/lib/cryptoauthlib.h"
 
-enum EccDataType {
+enum ecc_data_types {
     EMPTY                 = 0,
     AWS_THINGNAME         = 1,
     AWS_ENDPOINT          = 2,
@@ -71,10 +71,40 @@ class ECC608Class {
      * will be returned.
      */
     ATCA_STATUS
-    readProvisionItem(const enum EccDataType type,
+    readProvisionItem(const enum ecc_data_types type,
                       uint8_t* buffer,
                       size_t* size);
 
+    /**
+     * @brief Retrieves the AWS thing name from the ECC608.
+     *
+     * @param thing_name [out] Buffer to store thing name in.
+     * @param size [in, out] Pointer to length of buffer. Set to the length of
+     * the thing name on return.
+     *
+     * @return ATCA_STATUS error code. If the thing name is not found
+     * ATCA_INVALID_ID will be returned.
+     */
+    __attribute__((deprecated(
+        "getThingName is deprecated, please use readProvisionItem "
+        "with AWS_THINGNAME passed as the type instead"))) ATCA_STATUS
+    getThingName(uint8_t* thing_name, uint8_t* size);
+
+    /**
+     * @brief Retrives the AWS endpoint from the ECC608.
+     *
+     * @param endpoint [out] Buffer to store endpoint in.
+     * @param size [in, out] Pointer to length of buffer. Set to the length of
+     * the endpoint on return.
+     *
+     * @return ATCA_STATUS error code. If the thing name is not found
+     * ATCA_INVALID_ID will be returned.
+     */
+    __attribute__((
+        deprecated("getEndpoint is deprecated, please use readProvisionItem "
+                   "with AWS_ENDPOINT passed as the type instead"))) ATCA_STATUS
+    getEndpoint(uint8_t* endpoint, uint8_t* size);
+
     /**
      * @brief Get the size of the root certificate (not base64 encoded. The size
      * is in raw bytes).