Merges Axis public header file into signed_video_sign.h (#502)

Also, renames sv_axis_communications_internal.h to
sv_axis_communications.h.

Co-authored-by: bjornvolcker <[email protected]>

Author: bjornvolcker

lib/src/includes/signed_video_sign.h

@@ -513,6 +513,36 @@ signed_video_set_hash_algo(signed_video_t *self, const char *name_or_oid);
 SignedVideoReturnCode
 signed_viedo_set_max_signing_frames(signed_video_t *self, unsigned max_signing_frames);
 
+/**
+ * @brief Sets an attestation report to the Signed Video session
+ *
+ * The attestation report is defined as the Public key |attestation| and a
+ * |certificate_chain|. This attestation report is stored and added to the generated SEI
+ * as optional metadata, that is, metadata that is not always present.
+ *
+ * This API must be called before the session starts to have an impact.
+ *
+ * Excluding |attestation| implies that the signing key is factory provisioned and an
+ * attestation is not needed. Leave out |attestation| with a NULL pointer.
+ * It is assumed that the |attestation| is at most 255 bytes large, hence
+ * |attestation_size| fits in a single byte.
+ *
+ * @param sv Pointer to the Signed Video session.
+ * @param attestation Pointer to the key attestation. A NULL means that the signing key is
+ *   factory provisioned.
+ * @param attestation_size The size of the key attestation. Set to 0 if no attestation
+ *   should be set.
+ * @param certificate_chain Pointer to the certificate chain. SV_NOT_SUPPORTED is returned
+ *   if an attempt to replace an existing certificate_chain is made.
+ *
+ * @return SV_OK upon success, otherwise an appropriate error.
+ */
+SignedVideoReturnCode
+sv_vendor_axis_communications_set_attestation_report(signed_video_t *sv,
+    const void *attestation,
+    uint8_t attestation_size,
+    const char *certificate_chain);
+
 #ifdef __cplusplus
 }
 #endif

lib/src/includes/sv_vendor_axis_communications.h

@@ -27,7 +27,7 @@
 #include "legacy/legacy_tlv.h"  // legacy_tlv_decode()
 #include "legacy_validation.h"  // Has public declarations
 #include "sv_authenticity.h"  // update_accumulated_validation()
-#include "sv_axis_communications_internal.h"
+#include "sv_axis_communications.h"
 #include "sv_openssl_internal.h"  // sv_openssl_verify_hash()
 #include "sv_tlv.h"  // sv_tlv_find_tag()
 

lib/src/legacy/legacy_auth.c

@@ -28,7 +28,7 @@
 #include "includes/signed_video_common.h"  // Return codes
 #include "includes/signed_video_openssl.h"  // sign_or_verify_data_t
 #include "sv_authenticity.h"  // allocate_memory_and_copy_string, transfer_product_info()
-#include "sv_axis_communications_internal.h"
+#include "sv_axis_communications.h"
 #include "sv_openssl_internal.h"  // openssl_public_key_malloc()
 #include "sv_tlv.h"  // sv_read_8bits, sv_read_16bits, sv_read_32bits, sv_read_64bits_signed
 

lib/src/legacy/legacy_tlv.c

@@ -5,7 +5,6 @@ signedvideoframework_public_headers = files(
   'includes/signed_video_openssl.h',
   'includes/signed_video_sign.h',
   'includes/signed_video_signing_plugin.h',
-  'includes/sv_vendor_axis_communications.h'
 )
 
 signedvideoframework_sources = files(
@@ -14,7 +13,7 @@ signedvideoframework_sources = files(
   'sv_authenticity.c',
   'sv_authenticity.h',
   'sv_axis_communications.c',
-  'sv_axis_communications_internal.h',
+  'sv_axis_communications.h',
   'sv_bu_list.c',
   'sv_bu_list.h',
   'sv_codec_av1.c',

lib/src/meson.build

@@ -25,7 +25,7 @@
 #include "includes/signed_video_openssl.h"  // pem_pkey_t, sign_or_verify_data_t
 #include "legacy_validation.h"
 #include "sv_authenticity.h"  // sv_create_local_authenticity_report_if_needed()
-#include "sv_axis_communications_internal.h"
+#include "sv_axis_communications.h"
 #include "sv_bu_list.h"  // bu_list_append()
 #include "sv_defines.h"  // svrc_t
 #include "sv_internal.h"  // gop_info_t, validation_flags_t

lib/src/sv_auth.c

@@ -18,6 +18,8 @@
  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
+#include "sv_axis_communications.h"
+
 #include <assert.h>
 #include <openssl/bio.h>  // BIO_*
 #include <openssl/evp.h>  // EVP_*
@@ -27,8 +29,7 @@
 #include <stdbool.h>
 #include <stdlib.h>  // malloc, memcpy, calloc, free
 
-#include "includes/sv_vendor_axis_communications.h"
-#include "sv_axis_communications_internal.h"
+#include "includes/signed_video_sign.h"
 #include "sv_internal.h"  // signed_video_t
 #include "sv_tlv.h"
 
@@ -829,7 +830,7 @@ get_axis_communications_certificate_chain(void *handle)
   return (const char *)self->certificate_chain;
 }
 
-// Definitions of public APIs declared in sv_vendor_axis_communications.h.
+// Definitions of public APIs declared in signed_video_sign.h.
 
 SignedVideoReturnCode
 sv_vendor_axis_communications_set_attestation_report(signed_video_t *sv,

lib/src/sv_axis_communications.c

@@ -33,7 +33,7 @@
 #include "includes/signed_video_openssl.h"  // pem_pkey_t, sign_or_verify_data_t
 #include "includes/signed_video_signing_plugin.h"
 #include "sv_authenticity.h"  // sv_latest_validation_init()
-#include "sv_axis_communications_internal.h"
+#include "sv_axis_communications.h"
 #include "sv_bu_list.h"  // bu_list_create(), bu_list_free()
 #include "sv_codec_internal.h"  // parse_h264_nalu_header(), parse_av1_obu_header()
 #include "sv_defines.h"  // svrc_t

lib/src/sv_axis_communications_internal.h lib/src/sv_axis_communications.hlib/src/sv_axis_communications_internal.h renamed to lib/src/sv_axis_communications.h

@@ -27,7 +27,7 @@
 #include "includes/signed_video_sign.h"
 #include "includes/signed_video_signing_plugin.h"
 #include "sv_authenticity.h"  // allocate_memory_and_copy_string
-#include "sv_axis_communications_internal.h"
+#include "sv_axis_communications.h"
 #include "sv_codec_internal.h"  // METADATA_TYPE_USER_PRIVATE
 #include "sv_defines.h"  // svrc_t, sv_tlv_tag_t
 #include "sv_internal.h"  // gop_info_t