Initial work to allow but not require dynamic sized data (#84)

* Better control of primary block lifecycle

* Using BSL_Data more consistently to avoid frontend QCBOR dependency

Author: BrianSipos

docs/api/dictionary.txt

@@ -78,10 +78,12 @@ decrypt
 DECRYPT
 decrypted
 DefaultSecuritContext's
+deallocated
 deinit
 Deinit
 deinitialize
 Deinitializes
+dereference
 dir
 DocID
 doxygen

src/BPSecLib_Private.h

@@ -43,7 +43,6 @@
 #include <syslog.h>
 #include <time.h>
 #include <sys/types.h>
-#include <qcbor/UsefulBuf.h>
 
 #include "BPSecLib_Public.h"
 
@@ -289,105 +288,8 @@ void BSL_LogEvent(int severity, const char *filename, int lineno, const char *fu
 
 #define ASSERT_POSTCONDITION(expr) ASSERT_TEMPL(expr, "Panic: Precondition failed to satisfy")
 
-// TODO(Bvb): These can be moved to backend, or removed.
-/// Data pointer for BSL_Data_t
-typedef uint8_t *BSL_DataPtr_t;
-/// Pointer to constant data for BSL_Data_t
-typedef const uint8_t *BSL_DataConstPtr_t;
-
-/** Heap data storage and views.
- */
-typedef struct BSL_Data_s
-{
-    /// @brief True if this data is a copy
-    bool owned;
-    /// @brief Pointer to the front of the buffer
-    BSL_DataPtr_t ptr;
-    /// @brief Size of the data buffer
-    size_t len;
-} BSL_Data_t;
-
-/** Static initializer for a data store.
- * @sa BSL_Data_Init()
- */
-#define BSL_DATA_INIT_NULL                    \
-    {                                         \
-        .owned = false, .ptr = NULL, .len = 0 \
-    }
-
-/**
- * Return size of library context
- */
-size_t BSL_LibCtx_Sizeof(void);
-
-/** Initialize an empty data struct.
- *
- * @param[in,out] data The data to initialize, which must not be NULL.
- * @return Zero upon success.
- * @sa BSL_DATA_INIT_NULL
- */
-int BSL_Data_Init(BSL_Data_t *data);
-
-/** Initialize with an owned buffer of size bytelen
- *
- * @todo Clarify to indicate this calls MALLOC.
- *
- * @param[in,out] data The data to initialize.
- * @param[in] bytelen Length of buffer to allocate.
- * @return Zero upon success.
- */
-int BSL_Data_InitBuffer(BSL_Data_t *data, size_t bytelen);
-
-/** Initialize a data struct as an overlay on optional external data.
- *
- * @param[in,out] data The data to initialize, which must not be NULL.
- * @param[in] len The total length to allocate, which may be zero.
- * @param[in] src An optional source buffer to point to.
- * @return Zero upon success.
- */
-int BSL_Data_InitView(BSL_Data_t *data, size_t len, BSL_DataPtr_t src);
-
-/// @overload
-void BSL_Data_InitMove(BSL_Data_t *data, BSL_Data_t *src);
-
-/** De-initialize a data struct, freeing if necessary.
- *
- * @param[in,out] data The data to de-initialize, which must not be NULL.
- * @return Zero upon success.
- * @post The struct must be initialized before using again.
- */
-int BSL_Data_Deinit(BSL_Data_t *data);
-
-/** Resize the data, copying if necessary.
- *
- * @param[in,out] data The data to resize, which must not be NULL.
- * @param[in] len The new total size.
- * @return Zero upon success.
- */
-int BSL_Data_Resize(BSL_Data_t *data, size_t len);
-
-/** Set an initialized data struct to a given size.
- *
- * @param[in,out] data The data to copy into, which must not be NULL.
- * @param[in] len The total length to allocate, which may be non-zero.
- * @param[in] src An optional source buffer to copy from, from which @c len
- * bytes will be copied.
- * @return Zero upon success.
- */
-int BSL_Data_CopyFrom(BSL_Data_t *data, size_t len, BSL_DataConstPtr_t src);
-
-/** Append an initialized data struct with a given size.
- *
- * @param[in,out] data The data to copy into, which must not be NULL.
- * @param[in] len The total length to allocate, which may be non-zero.
- * @param[in] src An optional source buffer to copy from, from which @c len
- * bytes will be copied.
- * @return Zero upon success.
- */
-int BSL_Data_AppendFrom(BSL_Data_t *data, size_t len, BSL_DataConstPtr_t src);
-
 /// @brief Forward declaration for file-like sequential reader.
-typedef struct BSL_SeqReader BSL_SeqReader_t;
+typedef struct BSL_SeqReader_s BSL_SeqReader_t;
 
 /** Release resources from a sequential reader.
  *
@@ -407,7 +309,7 @@ int BSL_SeqReader_Deinit(BSL_SeqReader_t *obj);
 int BSL_SeqReader_Get(BSL_SeqReader_t *obj, uint8_t *buf, size_t *bufsize);
 
 /// @brief Forward-declaration for file-like interface for a sequential writer.
-typedef struct BSL_SeqWriter BSL_SeqWriter_t;
+typedef struct BSL_SeqWriter_s BSL_SeqWriter_t;
 
 /** Release resources from a sequential writer.
  *
@@ -582,17 +484,6 @@ typedef enum
  */
 int BSL_BundleCtx_GetBundleMetadata(const BSL_BundleRef_t *bundle, BSL_PrimaryBlock_t *result_primary_block);
 
-/** @brief Returns an array in which each element contains the id of the corresponding block.abort
- *
- * @param[in] bundle    Bundle context
- * @param[in] array_count   Number of elements in `block_id_index_array`
- * @param[out] block_id_index_array Array of `array_count` elements for results
- * @param[out] result_count Contains the number of elements put into the array
- * @return 0 on success, negative on error
- */
-int BSL_BundleCtx_GetBlockIds(const BSL_BundleRef_t *bundle, size_t array_count, uint64_t *block_ids_array,
-                              size_t *result_count);
-
 /** @brief Returns information about the bundle Canonical block
  *
  * @param[in] bundle Context bundle
@@ -638,6 +529,10 @@ int BSL_BundleCtx_DeleteBundle(BSL_BundleRef_t *bundle);
  */
 int BSL_BundleCtx_ReallocBTSD(BSL_BundleRef_t *bundle, uint64_t block_num, size_t bytesize);
 
+BSL_SeqReader_t *BSL_BundleCtx_ReadBTSD(BSL_BundleRef_t *bundle, uint64_t block_num);
+
+BSL_SeqWriter_t *BSL_BundleCtx_WriteBTSD(BSL_BundleRef_t *bundle, uint64_t block_num);
+
 #define BSL_DEFAULT_BYTESTR_LEN (128)
 
 /** @brief Security role of an operation
@@ -678,7 +573,7 @@ typedef struct BSL_SecResult_s BSL_SecResult_t;
  * @return 0 on success, negative on error
  */
 int BSL_SecResult_Init(BSL_SecResult_t *self, uint64_t result_id, uint64_t context_id, uint64_t target_block_num,
-                       BSL_Data_t content);
+                       const BSL_Data_t *content);
 
 /** Return true when internal invariant checks pass
  *
@@ -1022,19 +917,19 @@ int BSL_AbsSecBlock_StripResults(BSL_AbsSecBlock_t *self, uint64_t target_block_
  *
  * @param[in] self This ASB.
  * @param[in] buf A buffer with allocated space for the encoded CBOR
- * or the @c SizeCalculateUsefulBuf value to get the real size.
+ * or a zero-length buffer to calculate the needed size.
  * @return Integer contains number of bytes written to buffer, negative indicates error.
  *
  */
-ssize_t BSL_AbsSecBlock_EncodeToCBOR(const BSL_AbsSecBlock_t *self, UsefulBuf buf);
+ssize_t BSL_AbsSecBlock_EncodeToCBOR(const BSL_AbsSecBlock_t *self, BSL_Data_t *buf);
 
 /** Decodes and populates this ASB from a CBOR string.
  *
  * @param[in,out] self This allocated, but uninitialized ASB to populate.
- * @param[in] encoded_cbor A buffer containing a CBOR string representing the ASB
+ * @param[in] buf A buffer containing a CBOR string representing the ASB
  * @return Negative on error
  */
-int BSL_AbsSecBlock_DecodeFromCBOR(BSL_AbsSecBlock_t *self, const BSL_Data_t *encoded_cbor);
+int BSL_AbsSecBlock_DecodeFromCBOR(BSL_AbsSecBlock_t *self, const BSL_Data_t *buf);
 
 /** @brief Represents the output following execution of a security operation.
  */

src/BPSecLib_Public.h

@@ -36,6 +36,7 @@
 #include <stdint.h>
 
 #include "BSLConfig.h"
+#include "Data.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -51,6 +52,11 @@ extern "C" {
 /// Forward declaration for BSL library context.
 typedef struct BSL_LibCtx_s BSL_LibCtx_t;
 
+/**
+ * Return size of library context
+ */
+size_t BSL_LibCtx_Sizeof(void);
+
 /// @brief Forward declaration of ::BSL_SecurityResponseSet_s, which contains information for BSL and the host BPA to
 /// process the Bundle.
 typedef struct BSL_SecurityResponseSet_s BSL_SecurityResponseSet_t;
@@ -134,7 +140,7 @@ typedef struct BSL_HostEIDPattern_s
 
 /** @brief Reference to a Bundle owned and stored in the host BPA
  *
- * @note The BSL internally never attempts to parse the opaque pointer contained here.
+ * @note The BSL internally never attempts to dereference the opaque pointer contained here.
  */
 typedef struct BSL_BundleRef_s
 {
@@ -144,6 +150,9 @@ typedef struct BSL_BundleRef_s
 /** @brief Contains Bundle Primary Block fields and metadata.
  *
  *  @note This contains a *snapshot* of the fields at the time it was queried. It is not a pointer.
+ *
+ * Instances are initialized as part of BSL_BundleCtx_GetBundleMetadata().
+ * Instances are de-initialized with BSL_PrimaryBlock_deinit().
  */
 typedef struct BSL_PrimaryBlock_s
 {
@@ -158,11 +167,25 @@ typedef struct BSL_PrimaryBlock_s
     uint64_t      field_lifetime;             ///< CBOR-decoded lifetime
     uint64_t      field_frag_offset;          ///< CBOR-decoded fragment offset (warning, may not be implemented yet).
     uint64_t      field_adu_length;           ///< CBOR-decoded field of ADU length
-    size_t        block_count; ///< Helpful count of total canonical blocks in bundle, not a field of the header.
-    uint8_t      *cbor;
-    size_t        cbor_len;
+
+    /// Helpful count of total canonical blocks in bundle, not a field of the header.
+    size_t block_count;
+    /** Array of size #block_count containing canonical block numbers in
+     * the same order in which they appear in the bundle.
+     */
+    uint64_t *block_numbers;
+
+    /** The encoded form of the primary block as contiguous data.
+     */
+    BSL_Data_t encoded;
 } BSL_PrimaryBlock_t;
 
+/** Deinitialize the use of a primary block metadata.
+ *
+ * @param[in,out] obj The instance to deinit.
+ */
+void BSL_PrimaryBlock_deinit(BSL_PrimaryBlock_t *obj);
+
 /** @brief Structure containing parsed Canonical Block fields.
  *
  *  @note This contains a *snapshot* of the fields at the time it was queried. It is not a pointer.
@@ -172,7 +195,7 @@ typedef struct BSL_CanonicalBlock_s
     uint64_t block_num; ///< CBOR-decoded block number (should always be > 0)
     uint64_t type_code; ///< CBOR-decoded block type code (should be > 0)
     uint64_t flags;     ///< CBOR-decoded flags field
-    uint64_t crc;       ///< CBOR-decoded block CRC
+    uint64_t crc_type;  ///< CBOR-decoded block CRC Type
     void    *btsd;      ///< Pointer to BTSD owned by the host BPA
     size_t   btsd_len;  ///< Length in bytes of the BTSD pointer.
 } BSL_CanonicalBlock_t;
@@ -196,10 +219,6 @@ typedef struct
     /// @brief Host BPA function to populate a Primary Block struct.
     int (*bundle_metadata_fn)(const BSL_BundleRef_t *bundle_ref, BSL_PrimaryBlock_t *result_primary_block);
 
-    /// @brief Host BPA function to populate a pre-allocated array with canonical block IDs
-    int (*bundle_get_block_ids)(const BSL_BundleRef_t *bundle_ref, size_t array_count, uint64_t *array_block_ids,
-                                size_t *result_count);
-
     /// @brief Host BPA function to populate a Canonical Block struct for a given block number.
     int (*block_metadata_fn)(const BSL_BundleRef_t *bundle_ref, uint64_t block_num, BSL_CanonicalBlock_t *result_block);
 

src/CMakeLists.txt

@@ -25,20 +25,21 @@ configure_file(BSLConfig.c.in BSLConfig.c @ONLY)
 
 # Frontend library
 set(BSL_FRONT_H
+  ${CMAKE_CURRENT_BINARY_DIR}/BSLConfig.h
+  ${CMAKE_CURRENT_SOURCE_DIR}/Data.h
   ${CMAKE_CURRENT_SOURCE_DIR}/BPSecLib_Private.h
   ${CMAKE_CURRENT_SOURCE_DIR}/BPSecLib_Public.h
-  ${CMAKE_CURRENT_BINARY_DIR}/BSLConfig.h
   ${CMAKE_CURRENT_SOURCE_DIR}/CryptoInterface.h
 )
 
 set(BSL_FRONT_C
   ${CMAKE_CURRENT_BINARY_DIR}/BSLConfig.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/Data.c
 )
 
 add_library(bsl_front)
 target_sources(bsl_front PUBLIC ${BSL_FRONT_H})
 target_sources(bsl_front PRIVATE ${BSL_FRONT_C})
-target_link_libraries(bsl_front PUBLIC QCBOR::qcbor)
 
 set_target_properties(bsl_front
     PROPERTIES
@@ -120,7 +121,6 @@ set(BSL_DYNAMIC_H
 
 set(BSL_DYNAMIC_C
   ${CMAKE_CURRENT_SOURCE_DIR}/backend/AbsSecBlock.c
-  ${CMAKE_CURRENT_SOURCE_DIR}/backend/UtilDefs_Data.c
   ${CMAKE_CURRENT_SOURCE_DIR}/backend/HostInterface.c
   ${CMAKE_CURRENT_SOURCE_DIR}/backend/PublicInterfaceImpl.c
   ${CMAKE_CURRENT_SOURCE_DIR}/backend/LoggingStderr.c

src/backend/UtilDefs_Data.c src/Data.csrc/backend/UtilDefs_Data.c renamed to src/Data.c

@@ -20,21 +20,20 @@
  * subcontract 1700763.
  */
 /** @file
- * @ingroup backend_dyn
+ * @ingroup frontend
  * Implementation of the data containers for handling variable-sized buffers and ownership.
  */
+#include "Data.h"
+#include "BPSecLib_Private.h"
 #include <string.h>
 
-#include <BPSecLib_Private.h>
-
 static void bsl_data_int_reset(BSL_Data_t *data)
 {
     ASSERT_ARG_NONNULL(data);
 
     data->owned = false;
     data->ptr   = NULL;
     data->len   = 0;
-    memset(data, 0, sizeof(*data));
 }
 
 static void bsl_data_int_free(BSL_Data_t *data)