cloud.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_CLOUD_H
#define VS_CLOUD_H
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include <virgil/iot/firmware/firmware.h>
#include <global-hal.h>
#include <virgil/iot/status_code/status_code.h>
 
#ifdef __cplusplus
namespace VirgilIoTKit {
extern "C" {
#endif
 
#define VS_UPD_URL_STR_SIZE 200
 
typedef size_t (*vs_fetch_handler_cb_t)(const char *contents, size_t chunksize, void *userdata);
 
typedef enum {
    VS_CLOUD_REQUEST_GET, 
    VS_CLOUD_REQUEST_POST 
} vs_cloud_http_method_e;
 
typedef vs_status_e (*vs_cloud_http_request_func_t)(vs_cloud_http_method_e method,
                                                    const char *url,
                                                    const char *request_body,
                                                    size_t request_body_size,
                                                    char *out_data,
                                                    vs_fetch_handler_cb_t fetch_handler,
                                                    void *hander_data,
                                                    size_t *in_out_size);
 
typedef struct {
    vs_cloud_http_request_func_t http_request; 
} vs_cloud_impl_t;
 
vs_status_e
vs_cloud_fetch_and_store_fw_file(const char *fw_file_url, vs_firmware_header_t *fetched_header);
 
vs_status_e
vs_cloud_fetch_and_store_tl(const char *tl_file_url);
 
typedef struct {
    char *topic_list;         
    uint16_t *topic_len_list; 
    size_t topic_count;       
} vs_cloud_mb_topics_list_t;
 
typedef enum {
    VS_CLOUD_MB_TOPIC_TL, 
    VS_CLOUD_MB_TOPIC_FW  
} vs_cloud_mb_topic_id_t;
 
typedef void (*vs_cloud_mb_process_custom_topic_cb_t)(const char *topic,
                                                      uint16_t topic_sz,
                                                      const uint8_t *data,
                                                      uint16_t length);
 
typedef void (*vs_cloud_mb_process_default_topic_cb_t)(const uint8_t *url, uint16_t length);
 
vs_status_e
vs_cloud_message_bin_register_default_handler(vs_cloud_mb_topic_id_t topic_id,
                                              vs_cloud_mb_process_default_topic_cb_t handler);
 
vs_status_e
vs_cloud_message_bin_register_custom_handler(vs_cloud_mb_process_custom_topic_cb_t handler);
 
typedef vs_status_e (*vs_cloud_mb_init_func_t)(const char *host,
                                               uint16_t port,
                                               const char *device_cert,
                                               const char *priv_key,
                                               const char *ca_cert);
 
typedef vs_status_e (*vs_cloud_mb_connect_subscribe_func_t)(const char *client_id,
                                                            const char *login,
                                                            const char *password,
                                                            const vs_cloud_mb_topics_list_t *topic_list,
                                                            vs_cloud_mb_process_custom_topic_cb_t process_topic);
 
typedef vs_status_e (*vs_cloud_mb_process_func_t)(void);
 
typedef struct {
    vs_cloud_mb_init_func_t init;                           
    vs_cloud_mb_connect_subscribe_func_t connect_subscribe; 
    vs_cloud_mb_process_func_t
            process; 
} vs_cloud_message_bin_impl_t;
 
vs_status_e
vs_cloud_message_bin_process(void);
 
vs_status_e
vs_cloud_init(const vs_cloud_impl_t *cloud_impl,
              const vs_cloud_message_bin_impl_t *message_bin_impl,
              vs_secmodule_impl_t *secmodule);
 
#ifdef __cplusplus
} // extern "C"
} // namespace VirgilIoTKit
#endif
 
#endif // VS_CLOUD_H