update.h

Go to the documentation of this file.

//  Copyright (C) 2015-2020 Virgil Security, Inc.
//
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are
//  met:
//
//      (1) Redistributions of source code must retain the above copyright
//      notice, this list of conditions and the following disclaimer.
//
//      (2) Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in
//      the documentation and/or other materials provided with the
//      distribution.
//
//      (3) Neither the name of the copyright holder nor the names of its
//      contributors may be used to endorse or promote products derived from
//      this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
//  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
//  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
//  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
//  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//
//  Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
 
#ifndef VS_UPDATE_H
#define VS_UPDATE_H
 
#include <global-hal.h>
#include <stdbool.h>
#include <virgil/iot/storage_hal/storage_hal.h>
#include <virgil/iot/status_code/status_code.h>
#include <virgil/iot/provision/provision.h>
 
#ifdef __cplusplus
namespace VirgilIoTKit {
extern "C" {
#endif
 
enum vs_update_file_type_id_t {
    VS_UPDATE_FIRMWARE, 
    VS_UPDATE_TRUST_LIST, 
    VS_UPDATE_USER_FILES = 256 
};
 
typedef struct __attribute__((__packed__)) {
    uint16_t type; 
    vs_file_info_t info; 
} vs_update_file_type_t;
 
struct vs_update_interface_t;
 
bool
vs_update_equal_file_type(vs_update_file_type_t *file_type, const vs_update_file_type_t *unknown_file_type);
 
vs_status_e
vs_update_compare_version(const vs_file_version_t *update_ver, const vs_file_version_t *current_ver);
 
#define VS_UPDATE_DEFAULT_DESC_BUF_SZ (49)
 
const char *
vs_update_file_version_str(const vs_file_version_t *version, char *opt_buf, size_t buf_sz);
 
#define VS_UPDATE_FILE_VERSION_STR_STATIC(VER_PTR) vs_update_file_version_str(VER_PTR, NULL, 0)
 
const char *
vs_update_file_type_str(const vs_update_file_type_t *file_type, char *opt_buf, size_t buf_sz);
 
#define VS_UPDATE_FILE_TYPE_STR_STATIC(TYPE_PTR) vs_update_file_type_str(TYPE_PTR, NULL, 0)
 
typedef vs_status_e (*vs_update_get_header_size_cb_t)(void *context, vs_update_file_type_t *file_type, uint32_t *header_size);
 
typedef vs_status_e (*vs_update_get_file_size_cb_t)(void *context, vs_update_file_type_t *file_type, const void *file_header, uint32_t *file_size);
 
typedef vs_status_e (*vs_update_has_footer_cb_t)(void *context, vs_update_file_type_t *file_type, bool *has_footer);
 
typedef vs_status_e (*vs_update_inc_data_offset_cb_t)(void *context, vs_update_file_type_t *file_type, uint32_t current_offset, uint32_t loaded_data_size, uint32_t *next_offset);
 
typedef vs_status_e (*vs_update_get_header_cb_t)(void *context, vs_update_file_type_t *file_type, void *header_buffer, uint32_t buffer_size, uint32_t *header_size);
 
typedef vs_status_e (*vs_update_get_data_cb_t)(void *context, vs_update_file_type_t *file_type, const void *file_header, void *data_buffer, uint32_t buffer_size, uint32_t *data_size, uint32_t data_offset);
 
typedef vs_status_e (*vs_update_get_footer_cb_t)(void *context, vs_update_file_type_t *file_type, const void *file_header, void *footer_buffer, uint32_t buffer_size, uint32_t *footer_size);
 
typedef vs_status_e (*vs_update_set_header_cb_t)(void *context, vs_update_file_type_t *file_type, const void *file_header, uint32_t header_size, uint32_t *file_size);
 
typedef vs_status_e (*vs_update_set_data_cb_t)(void *context, vs_update_file_type_t *file_type, const void *file_header, const void *file_data, uint32_t data_size, uint32_t data_offset);
 
typedef vs_status_e (*vs_update_set_footer_cb_t)(void *context, vs_update_file_type_t *file_type, const void *file_header, const void *file_footer, uint32_t footer_size);
 
typedef void (*vs_update_delete_object_cb_t)(void *context, vs_update_file_type_t *file_type);
 
typedef vs_status_e (*vs_update_verify_object_cb_t)(void *context, vs_update_file_type_t *file_type);
 
typedef void (*vs_update_free_item_cb_t)(void *context, vs_update_file_type_t *file_type);
 
typedef struct __attribute__((__packed__)) vs_update_interface_t {
    vs_update_get_header_size_cb_t    get_header_size; 
    vs_update_get_file_size_cb_t      get_file_size; 
    vs_update_has_footer_cb_t         has_footer; 
    vs_update_inc_data_offset_cb_t    inc_data_offset; 
    vs_update_get_header_cb_t         get_header; 
    vs_update_get_data_cb_t           get_data; 
    vs_update_get_footer_cb_t         get_footer; 
    vs_update_set_header_cb_t         set_header; 
    vs_update_set_data_cb_t           set_data; 
    vs_update_set_footer_cb_t         set_footer; 
    vs_update_delete_object_cb_t        delete_object; 
    vs_update_verify_object_cb_t        verify_object; 
    vs_update_free_item_cb_t          free_item; 
    vs_storage_op_ctx_t *storage_context; 
} vs_update_interface_t;
 
#ifdef __cplusplus
} // extern "C"
} // namespace VirgilIoTKit
#endif
 
#endif // VS_UPDATE_H