First cut at ks_flash support for attribute get/set/delete API.

Passes minimal unit-testing and the same minimal tests report that it
does deliver the desired performance speed-up.  More testing and much
cleanup still needed.

Attribute API not quite stable yet, we're probably going to want to
remove all the singleton attribute operations from the RPC protocol,
and it turns out that ks_delete_attributes() has enough code in common
with ks_set_attributes() that it makes more sense to handle the former
as a special case of the latter.

1 files changed, 62 insertions, 15 deletions

diff --git a/hal_internal.h b/hal_internal.h
index 6b82b9c..554ca62 100644
--- a/hal_internal.h
+++ b/hal_internal.h
@@ -575,34 +575,46 @@ extern const hal_ks_driver_t
 
 static inline hal_error_t hal_ks_init(const hal_ks_driver_t * const driver)
 {
-  if (driver == NULL || driver->init == NULL)
+  if (driver == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (driver->init == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return driver->init(driver);
 }
 
 static inline hal_error_t hal_ks_shutdown(const hal_ks_driver_t * const driver)
 {
-  if (driver == NULL || driver->shutdown == NULL)
+  if (driver == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (driver->shutdown == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return driver->shutdown(driver);
 }
 
 static inline hal_error_t hal_ks_open(const hal_ks_driver_t * const driver,
 			       hal_ks_t **ks)
 {
-  if (driver == NULL || driver->open == NULL || ks == NULL)
+  if (driver == NULL || ks == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (driver->open == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return driver->open(driver, ks);
 }
 
 static inline hal_error_t hal_ks_close(hal_ks_t *ks)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->close == NULL)
+  if (ks == NULL || ks->driver == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->close == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->close(ks);
 }
 
@@ -610,9 +622,12 @@ static inline hal_error_t hal_ks_store(hal_ks_t *ks,
                                        hal_pkey_slot_t *slot,
                                        const uint8_t * const der,  const size_t der_len)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->store == NULL || slot == NULL || der == NULL)
+  if (ks == NULL || ks->driver == NULL || slot == NULL || der == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->store == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->store(ks, slot, der, der_len);
 }
 
@@ -620,18 +635,24 @@ static inline hal_error_t hal_ks_fetch(hal_ks_t *ks,
                                        hal_pkey_slot_t *slot,
                                        uint8_t *der, size_t *der_len, const size_t der_max)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->fetch == NULL || slot == NULL)
+  if (ks == NULL || ks->driver == NULL || slot == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->fetch == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->fetch(ks, slot, der, der_len, der_max);
 }
 
 static inline hal_error_t hal_ks_delete(hal_ks_t *ks,
                                         hal_pkey_slot_t *slot)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->delete == NULL || slot == NULL)
+  if (ks == NULL || ks->driver == NULL || slot == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->delete == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->delete(ks, slot);
 }
 
@@ -642,9 +663,12 @@ static inline hal_error_t hal_ks_list(hal_ks_t *ks,
                                       unsigned *result_len,
                                       const unsigned result_max)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->list == NULL)
+  if (ks == NULL || ks->driver == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->list == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->list(ks, client, session, result, result_len, result_max);
 }
 
@@ -661,9 +685,12 @@ static inline hal_error_t hal_ks_match(hal_ks_t *ks,
                                        const unsigned result_max,
                                        const hal_uuid_t * const previous_uuid)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->match == NULL)
+  if (ks == NULL || ks->driver == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->match == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->match(ks, client, session, type, curve, flags, attributes, attributes_len,
                            result, result_len, result_max, previous_uuid);
 }
@@ -674,9 +701,12 @@ static inline  hal_error_t hal_ks_set_attribute(hal_ks_t *ks,
                                                 const uint8_t * const value,
                                                 const size_t value_len)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->set_attribute == NULL || slot == NULL)
+  if (ks == NULL || ks->driver == NULL || slot == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->set_attribute == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->set_attribute(ks, slot, type, value, value_len);
 }
 
@@ -687,9 +717,12 @@ static inline hal_error_t hal_ks_get_attribute(hal_ks_t *ks,
                                                size_t *value_len,
                                                const size_t value_max)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->get_attribute == NULL || slot == NULL)
+  if (ks == NULL || ks->driver == NULL || slot == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->get_attribute == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->get_attribute(ks, slot, type, value, value_len, value_max);
 }
 
@@ -697,9 +730,12 @@ static inline hal_error_t hal_ks_delete_attribute(hal_ks_t *ks,
                                                   hal_pkey_slot_t *slot,
                                                   const uint32_t type)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->delete_attribute == NULL || slot == NULL)
+  if (ks == NULL || ks->driver == NULL || slot == NULL)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->delete_attribute == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->delete_attribute(ks, slot, type);
 }
 
@@ -708,10 +744,13 @@ static inline  hal_error_t hal_ks_set_attributes(hal_ks_t *ks,
                                                  const hal_rpc_pkey_attribute_t *attributes,
                                                  const unsigned attributes_len)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->set_attributes == NULL || slot == NULL ||
+  if (ks == NULL || ks->driver == NULL || slot == NULL ||
       attributes == NULL || attributes_len == 0)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->set_attributes == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   for (int i = 0; i < attributes_len; i++)
     if (attributes[i].length == 0 || attributes[i].value == NULL)
       return HAL_ERROR_BAD_ARGUMENTS;
@@ -726,11 +765,14 @@ static inline hal_error_t hal_ks_get_attributes(hal_ks_t *ks,
                                                 uint8_t *attributes_buffer,
                                                 const size_t attributes_buffer_len)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->get_attributes == NULL || slot == NULL ||
+  if (ks == NULL || ks->driver == NULL || slot == NULL ||
       attributes == NULL || attributes_len == 0 ||
       attributes_buffer == NULL || attributes_buffer_len == 0)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->get_attributes == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->get_attributes(ks, slot, attributes, attributes_len,
                                     attributes_buffer, attributes_buffer_len);
 }
@@ -740,10 +782,13 @@ static inline hal_error_t hal_ks_delete_attributes(hal_ks_t *ks,
                                                    const uint32_t *types,
                                                    const unsigned types_len)
 {
-  if (ks == NULL || ks->driver == NULL || ks->driver->delete_attributes == NULL || slot == NULL ||
+  if (ks == NULL || ks->driver == NULL || slot == NULL ||
       types == NULL || types_len == 0)
     return HAL_ERROR_BAD_ARGUMENTS;
 
+  if (ks->driver->delete_attributes == NULL)
+    return HAL_ERROR_NOT_IMPLEMENTED;
+
   return ks->driver->delete_attributes(ks, slot, types, types_len);
 }
 
@@ -881,6 +926,8 @@ extern hal_error_t hal_ks_index_fsck(hal_ks_index_t *ksi);
  * Keystore attribute utilities, for use by keystore drivers.
  */
 
+extern const size_t hal_ks_attribute_header_size;
+
 extern hal_error_t hal_ks_attribute_scan(const uint8_t * const bytes,
                                          const size_t bytes_len,
                                          hal_rpc_pkey_attribute_t *attributes,