| /* |
| * Copyright (c) 2016-2017 Linaro Limited |
| * Copyright (c) 2018 Open Source Foundries Limited |
| * Copyright (c) 2018 Foundries.io |
| * Copyright (c) 2020 Linumiz |
| * Copyright (c) 2021 G-Technologies Sdn. Bhd. |
| * |
| * SPDX-License-Identifier: Apache-2.0 |
| */ |
| |
| #include <stdio.h> |
| #include <stdlib.h> |
| #include <string.h> |
| |
| #include <zephyr/data/json.h> |
| #include <zephyr/drivers/flash.h> |
| #include <zephyr/kernel.h> |
| #include <zephyr/logging/log.h> |
| #include <zephyr/logging/log_ctrl.h> |
| #include <zephyr/mgmt/hawkbit/hawkbit.h> |
| #include <zephyr/mgmt/hawkbit/config.h> |
| #include <zephyr/net/dns_resolve.h> |
| #include <zephyr/net/http/client.h> |
| #include <zephyr/net/net_ip.h> |
| #include <zephyr/net/net_mgmt.h> |
| #include <zephyr/net/socket.h> |
| #include <zephyr/settings/settings.h> |
| #include <zephyr/storage/flash_map.h> |
| #include <zephyr/sys/reboot.h> |
| |
| #include "hawkbit_device.h" |
| #include "hawkbit_firmware.h" |
| #include "hawkbit_priv.h" |
| |
| LOG_MODULE_REGISTER(hawkbit, CONFIG_HAWKBIT_LOG_LEVEL); |
| |
| #define CANCEL_BASE_SIZE 50 |
| #define RECV_BUFFER_SIZE 640 |
| #define URL_BUFFER_SIZE 300 |
| #define SHA256_HASH_SIZE 32 |
| #define DOWNLOAD_HTTP_SIZE 200 |
| #define DEPLOYMENT_BASE_SIZE 50 |
| #define RESPONSE_BUFFER_SIZE 1100 |
| #define DDI_SECURITY_TOKEN_SIZE 32 |
| #define HAWKBIT_RECV_TIMEOUT (300 * MSEC_PER_SEC) |
| #define HAWKBIT_SET_SERVER_TIMEOUT K_MSEC(300) |
| |
| #define HAWKBIT_JSON_URL "/default/controller/v1" |
| |
| #define HTTP_HEADER_CONTENT_TYPE_JSON "application/json;charset=UTF-8" |
| |
| #define SLOT1_LABEL slot1_partition |
| #define SLOT1_SIZE FIXED_PARTITION_SIZE(SLOT1_LABEL) |
| |
| static uint32_t poll_sleep = (CONFIG_HAWKBIT_POLL_INTERVAL * SEC_PER_MIN); |
| |
| static bool hawkbit_initialized; |
| |
| #ifndef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| |
| #ifdef CONFIG_HAWKBIT_DDI_GATEWAY_SECURITY |
| #define AUTH_HEADER_START "Authorization: GatewayToken " |
| #else |
| #define AUTH_HEADER_START "Authorization: TargetToken " |
| #endif /* CONFIG_HAWKBIT_DDI_GATEWAY_SECURITY */ |
| |
| #ifdef CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME |
| #define AUTH_HEADER_FULL AUTH_HEADER_START "%s" HTTP_CRLF |
| #else |
| #define AUTH_HEADER_FULL AUTH_HEADER_START CONFIG_HAWKBIT_DDI_SECURITY_TOKEN HTTP_CRLF |
| #endif /* CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME */ |
| |
| #endif /* CONFIG_HAWKBIT_DDI_NO_SECURITY */ |
| |
| static struct hawkbit_config { |
| int32_t action_id; |
| #ifdef CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME |
| char server_addr[DNS_MAX_NAME_SIZE + 1]; |
| char server_port[sizeof(STRINGIFY(__UINT16_MAX__))]; |
| #ifndef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| char ddi_security_token[DDI_SECURITY_TOKEN_SIZE + 1]; |
| #endif |
| #ifdef CONFIG_HAWKBIT_USE_DYNAMIC_CERT_TAG |
| sec_tag_t tls_tag; |
| #endif |
| #endif /* CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME */ |
| } hb_cfg; |
| |
| #ifdef CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME |
| #define HAWKBIT_SERVER hb_cfg.server_addr |
| #define HAWKBIT_PORT hb_cfg.server_port |
| #define HAWKBIT_PORT_INT atoi(hb_cfg.server_port) |
| #else |
| #define HAWKBIT_SERVER CONFIG_HAWKBIT_SERVER |
| #define HAWKBIT_PORT STRINGIFY(CONFIG_HAWKBIT_PORT) |
| #define HAWKBIT_PORT_INT CONFIG_HAWKBIT_PORT |
| #endif /* CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME */ |
| |
| #ifdef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| #define HAWKBIT_DDI_SECURITY_TOKEN NULL |
| #elif defined(CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME) |
| #define HAWKBIT_DDI_SECURITY_TOKEN hb_cfg.ddi_security_token |
| #else |
| #define HAWKBIT_DDI_SECURITY_TOKEN CONFIG_HAWKBIT_DDI_SECURITY_TOKEN |
| #endif /* CONFIG_HAWKBIT_DDI_NO_SECURITY */ |
| |
| #ifdef CONFIG_HAWKBIT_USE_DYNAMIC_CERT_TAG |
| #define HAWKBIT_CERT_TAG hb_cfg.tls_tag |
| #elif defined(HAWKBIT_USE_STATIC_CERT_TAG) |
| #define HAWKBIT_CERT_TAG CONFIG_HAWKBIT_STATIC_CERT_TAG |
| #else |
| #define HAWKBIT_CERT_TAG 0 |
| #endif /* CONFIG_HAWKBIT_USE_DYNAMIC_CERT_TAG */ |
| |
| struct hawkbit_download { |
| int download_status; |
| int download_progress; |
| size_t downloaded_size; |
| size_t http_content_size; |
| uint8_t file_hash[SHA256_HASH_SIZE]; |
| }; |
| |
| static struct hawkbit_context { |
| int sock; |
| int32_t action_id; |
| uint8_t *response_data; |
| size_t response_data_size; |
| int32_t json_action_id; |
| struct hawkbit_download dl; |
| struct http_request http_req; |
| struct flash_img_context flash_ctx; |
| uint8_t url_buffer[URL_BUFFER_SIZE]; |
| uint8_t status_buffer[CONFIG_HAWKBIT_STATUS_BUFFER_SIZE]; |
| uint8_t recv_buf_tcp[RECV_BUFFER_SIZE]; |
| enum hawkbit_response code_status; |
| bool final_data_received; |
| } hb_context; |
| |
| static union { |
| struct hawkbit_dep_res dep; |
| struct hawkbit_ctl_res base; |
| struct hawkbit_cancel cancel; |
| } hawkbit_results; |
| |
| int hawkbit_default_config_data_cb(const char *device_id, uint8_t *buffer, |
| const size_t buffer_size); |
| |
| static hawkbit_config_device_data_cb_handler_t hawkbit_config_device_data_cb_handler = |
| hawkbit_default_config_data_cb; |
| |
| K_SEM_DEFINE(probe_sem, 1, 1); |
| |
| static const struct json_obj_descr json_href_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_href, href, JSON_TOK_STRING), |
| }; |
| |
| static const struct json_obj_descr json_status_result_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_status_result, finished, JSON_TOK_STRING), |
| }; |
| |
| static const struct json_obj_descr json_status_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_status, execution, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_status, result, json_status_result_descr), |
| }; |
| |
| static const struct json_obj_descr json_ctl_res_sleep_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_ctl_res_sleep, sleep, JSON_TOK_STRING), |
| }; |
| |
| static const struct json_obj_descr json_ctl_res_polling_descr[] = { |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_ctl_res_polling, polling, json_ctl_res_sleep_descr), |
| }; |
| |
| static const struct json_obj_descr json_ctl_res_links_descr[] = { |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_ctl_res_links, deploymentBase, json_href_descr), |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_ctl_res_links, cancelAction, json_href_descr), |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_ctl_res_links, configData, json_href_descr), |
| }; |
| |
| static const struct json_obj_descr json_ctl_res_descr[] = { |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_ctl_res, config, json_ctl_res_polling_descr), |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_ctl_res, _links, json_ctl_res_links_descr), |
| }; |
| |
| static const struct json_obj_descr json_cfg_data_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_cfg_data, VIN, JSON_TOK_STRING), |
| }; |
| |
| static const struct json_obj_descr json_cfg_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_cfg, mode, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_cfg, data, json_cfg_data_descr), |
| }; |
| |
| static const struct json_obj_descr json_close_descr[] = { |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_close, status, json_status_descr), |
| }; |
| |
| static const struct json_obj_descr json_dep_res_hashes_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_hashes, sha1, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_hashes, md5, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_hashes, sha256, JSON_TOK_STRING), |
| }; |
| |
| static const struct json_obj_descr json_dep_res_links_descr[] = { |
| JSON_OBJ_DESCR_OBJECT_NAMED(struct hawkbit_dep_res_links, "download-http", download_http, |
| json_href_descr), |
| JSON_OBJ_DESCR_OBJECT_NAMED(struct hawkbit_dep_res_links, "md5sum-http", md5sum_http, |
| json_href_descr), |
| }; |
| |
| static const struct json_obj_descr json_dep_res_arts_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_arts, filename, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_dep_res_arts, hashes, json_dep_res_hashes_descr), |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_arts, size, JSON_TOK_NUMBER), |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_dep_res_arts, _links, json_dep_res_links_descr), |
| }; |
| |
| static const struct json_obj_descr json_dep_res_chunk_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_chunk, part, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_chunk, version, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_chunk, name, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_OBJ_ARRAY(struct hawkbit_dep_res_chunk, artifacts, |
| HAWKBIT_DEP_MAX_CHUNK_ARTS, num_artifacts, json_dep_res_arts_descr, |
| ARRAY_SIZE(json_dep_res_arts_descr)), |
| }; |
| |
| static const struct json_obj_descr json_dep_res_deploy_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_deploy, download, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res_deploy, update, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_OBJ_ARRAY(struct hawkbit_dep_res_deploy, chunks, HAWKBIT_DEP_MAX_CHUNKS, |
| num_chunks, json_dep_res_chunk_descr, |
| ARRAY_SIZE(json_dep_res_chunk_descr)), |
| }; |
| |
| static const struct json_obj_descr json_dep_res_descr[] = { |
| JSON_OBJ_DESCR_PRIM(struct hawkbit_dep_res, id, JSON_TOK_STRING), |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_dep_res, deployment, json_dep_res_deploy_descr), |
| }; |
| |
| static const struct json_obj_descr json_dep_fbk_descr[] = { |
| JSON_OBJ_DESCR_OBJECT(struct hawkbit_dep_fbk, status, json_status_descr), |
| }; |
| |
| static int hawkbit_settings_set(const char *name, size_t len, settings_read_cb read_cb, |
| void *cb_arg) |
| { |
| const char *next; |
| int rc; |
| |
| if (settings_name_steq(name, "action_id", &next) && !next) { |
| if (len != sizeof(hb_cfg.action_id)) { |
| return -EINVAL; |
| } |
| |
| rc = read_cb(cb_arg, &hb_cfg.action_id, sizeof(hb_cfg.action_id)); |
| LOG_DBG("<%s> = %d", "hawkbit/action_id", hb_cfg.action_id); |
| if (rc >= 0) { |
| return 0; |
| } |
| |
| return rc; |
| } |
| |
| #ifdef CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME |
| if (settings_name_steq(name, "server_addr", &next) && !next) { |
| if (len != sizeof(hb_cfg.server_addr)) { |
| return -EINVAL; |
| } |
| |
| rc = read_cb(cb_arg, &hb_cfg.server_addr, sizeof(hb_cfg.server_addr)); |
| LOG_DBG("<%s> = %s", "hawkbit/server_addr", hb_cfg.server_addr); |
| if (rc >= 0) { |
| return 0; |
| } |
| |
| return rc; |
| } |
| |
| if (settings_name_steq(name, "server_port", &next) && !next) { |
| if (len != sizeof(uint16_t)) { |
| return -EINVAL; |
| } |
| |
| uint16_t hawkbit_port = atoi(hb_cfg.server_port); |
| |
| rc = read_cb(cb_arg, &hawkbit_port, sizeof(hawkbit_port)); |
| if (hawkbit_port != atoi(hb_cfg.server_port)) { |
| snprintf(hb_cfg.server_port, sizeof(hb_cfg.server_port), "%u", |
| hawkbit_port); |
| } |
| LOG_DBG("<%s> = %s", "hawkbit/server_port", hb_cfg.server_port); |
| if (rc >= 0) { |
| return 0; |
| } |
| |
| return rc; |
| } |
| |
| if (settings_name_steq(name, "ddi_token", &next) && !next) { |
| #ifdef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| rc = read_cb(cb_arg, NULL, 0); |
| #else |
| if (len != sizeof(hb_cfg.ddi_security_token)) { |
| return -EINVAL; |
| } |
| |
| rc = read_cb(cb_arg, &hb_cfg.ddi_security_token, sizeof(hb_cfg.ddi_security_token)); |
| LOG_DBG("<%s> = %s", "hawkbit/ddi_token", hb_cfg.ddi_security_token); |
| if (rc >= 0) { |
| return 0; |
| } |
| #endif /* CONFIG_HAWKBIT_DDI_NO_SECURITY */ |
| return rc; |
| } |
| #else /* CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME */ |
| if (settings_name_steq(name, "server_addr", NULL) || |
| settings_name_steq(name, "server_port", NULL) || |
| settings_name_steq(name, "ddi_token", NULL)) { |
| rc = read_cb(cb_arg, NULL, 0); |
| return 0; |
| } |
| #endif /* CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME */ |
| |
| return -ENOENT; |
| } |
| |
| static int hawkbit_settings_export(int (*cb)(const char *name, const void *value, size_t val_len)) |
| { |
| LOG_DBG("export hawkbit settings"); |
| (void)cb("hawkbit/action_id", &hb_cfg.action_id, sizeof(hb_cfg.action_id)); |
| #ifdef CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME |
| (void)cb("hawkbit/server_addr", &hb_cfg.server_addr, sizeof(hb_cfg.server_addr)); |
| uint16_t hawkbit_port = atoi(hb_cfg.server_port); |
| (void)cb("hawkbit/server_port", &hawkbit_port, sizeof(hawkbit_port)); |
| #ifndef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| (void)cb("hawkbit/ddi_token", &hb_cfg.ddi_security_token, |
| sizeof(hb_cfg.ddi_security_token)); |
| #endif /* CONFIG_HAWKBIT_DDI_NO_SECURITY */ |
| #endif /* CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME */ |
| return 0; |
| } |
| |
| SETTINGS_STATIC_HANDLER_DEFINE(hawkbit, "hawkbit", NULL, hawkbit_settings_set, NULL, |
| hawkbit_settings_export); |
| |
| static bool start_http_client(void) |
| { |
| int ret = -1; |
| struct zsock_addrinfo *addr; |
| struct zsock_addrinfo hints = {0}; |
| int resolve_attempts = 10; |
| int protocol = IS_ENABLED(CONFIG_HAWKBIT_USE_TLS) ? IPPROTO_TLS_1_2 : IPPROTO_TCP; |
| |
| if (IS_ENABLED(CONFIG_NET_IPV6)) { |
| hints.ai_family = AF_INET6; |
| hints.ai_socktype = SOCK_STREAM; |
| } else if (IS_ENABLED(CONFIG_NET_IPV4)) { |
| hints.ai_family = AF_INET; |
| hints.ai_socktype = SOCK_STREAM; |
| } |
| |
| while (resolve_attempts--) { |
| ret = zsock_getaddrinfo(HAWKBIT_SERVER, HAWKBIT_PORT, &hints, &addr); |
| if (ret == 0) { |
| break; |
| } |
| |
| k_sleep(K_MSEC(1)); |
| } |
| |
| if (ret != 0) { |
| LOG_ERR("Failed to resolve dns: %d", ret); |
| return false; |
| } |
| |
| hb_context.sock = zsock_socket(addr->ai_family, SOCK_STREAM, protocol); |
| if (hb_context.sock < 0) { |
| LOG_ERR("Failed to create TCP socket"); |
| goto err; |
| } |
| |
| #ifdef CONFIG_HAWKBIT_USE_TLS |
| sec_tag_t sec_tag_opt[] = { |
| HAWKBIT_CERT_TAG, |
| }; |
| |
| if (zsock_setsockopt(hb_context.sock, SOL_TLS, TLS_SEC_TAG_LIST, sec_tag_opt, |
| sizeof(sec_tag_opt)) < 0) { |
| LOG_ERR("Failed to set TLS_TAG option"); |
| goto err_sock; |
| } |
| if (zsock_setsockopt(hb_context.sock, SOL_TLS, TLS_HOSTNAME, HAWKBIT_SERVER, |
| sizeof(HAWKBIT_SERVER)) < 0) { |
| goto err_sock; |
| } |
| #endif /* CONFIG_HAWKBIT_USE_TLS */ |
| |
| if (zsock_connect(hb_context.sock, addr->ai_addr, addr->ai_addrlen) < 0) { |
| LOG_ERR("Failed to connect to server"); |
| goto err_sock; |
| } |
| |
| zsock_freeaddrinfo(addr); |
| return true; |
| |
| err_sock: |
| zsock_close(hb_context.sock); |
| err: |
| zsock_freeaddrinfo(addr); |
| return false; |
| } |
| |
| static void cleanup_connection(void) |
| { |
| if (zsock_close(hb_context.sock) < 0) { |
| LOG_ERR("Failed to close the socket"); |
| } |
| } |
| |
| static int hawkbit_time2sec(const char *s) |
| { |
| int sec; |
| |
| /* Time: HH:MM:SS */ |
| sec = strtol(s, NULL, 10) * (60 * 60); |
| sec += strtol(s + 3, NULL, 10) * 60; |
| sec += strtol(s + 6, NULL, 10); |
| |
| if (sec < 0) { |
| return -1; |
| } else { |
| return sec; |
| } |
| } |
| |
| static const char *hawkbit_status_finished(enum hawkbit_status_fini f) |
| { |
| switch (f) { |
| case HAWKBIT_STATUS_FINISHED_SUCCESS: |
| return "success"; |
| case HAWKBIT_STATUS_FINISHED_FAILURE: |
| return "failure"; |
| case HAWKBIT_STATUS_FINISHED_NONE: |
| return "none"; |
| default: |
| LOG_ERR("%d is invalid", (int)f); |
| return NULL; |
| } |
| } |
| |
| static const char *hawkbit_status_execution(enum hawkbit_status_exec e) |
| { |
| switch (e) { |
| case HAWKBIT_STATUS_EXEC_CLOSED: |
| return "closed"; |
| case HAWKBIT_STATUS_EXEC_PROCEEDING: |
| return "proceeding"; |
| case HAWKBIT_STATUS_EXEC_CANCELED: |
| return "canceled"; |
| case HAWKBIT_STATUS_EXEC_SCHEDULED: |
| return "scheduled"; |
| case HAWKBIT_STATUS_EXEC_REJECTED: |
| return "rejected"; |
| case HAWKBIT_STATUS_EXEC_RESUMED: |
| return "resumed"; |
| case HAWKBIT_STATUS_EXEC_NONE: |
| return "none"; |
| default: |
| LOG_ERR("%d is invalid", (int)e); |
| return NULL; |
| } |
| } |
| |
| static int hawkbit_device_acid_update(int32_t new_value) |
| { |
| int ret; |
| hb_cfg.action_id = new_value; |
| |
| ret = settings_save_one("hawkbit/action_id", &hb_cfg.action_id, sizeof(hb_cfg.action_id)); |
| if (ret < 0) { |
| LOG_ERR("Failed to write device id: %d", ret); |
| return -EIO; |
| } |
| |
| return 0; |
| } |
| |
| int hawkbit_reset_action_id(void) |
| { |
| int ret; |
| |
| if (k_sem_take(&probe_sem, K_NO_WAIT) == 0) { |
| ret = hawkbit_device_acid_update(0); |
| k_sem_give(&probe_sem); |
| return ret; |
| } |
| return -EAGAIN; |
| } |
| |
| int32_t hawkbit_get_action_id(void) |
| { |
| return hb_cfg.action_id; |
| } |
| |
| uint32_t hawkbit_get_poll_interval(void) |
| { |
| return poll_sleep; |
| } |
| |
| /* |
| * Update sleep interval, based on results from hawkBit base polling |
| * resource |
| */ |
| static void hawkbit_update_sleep(struct hawkbit_ctl_res *hawkbit_res) |
| { |
| int sleep_time; |
| const char *sleep = hawkbit_res->config.polling.sleep; |
| |
| if (strlen(sleep) != HAWKBIT_SLEEP_LENGTH) { |
| LOG_ERR("Invalid poll sleep: %s", sleep); |
| } else { |
| sleep_time = hawkbit_time2sec(sleep); |
| if (sleep_time > 0 && poll_sleep != sleep_time) { |
| LOG_DBG("New poll sleep %d seconds", sleep_time); |
| poll_sleep = (uint32_t)sleep_time; |
| } |
| } |
| } |
| |
| /* |
| * Find URL component for the device cancel operation and action id |
| */ |
| static int hawkbit_find_cancelAction_base(struct hawkbit_ctl_res *res, char *cancel_base) |
| { |
| size_t len; |
| const char *href; |
| char *helper, *endptr; |
| |
| href = res->_links.cancelAction.href; |
| if (!href) { |
| *cancel_base = '\0'; |
| return 0; |
| } |
| |
| LOG_DBG("_links.%s.href=%s", "cancelAction", href); |
| |
| helper = strstr(href, "cancelAction/"); |
| if (!helper) { |
| /* A badly formatted cancel base is a server error */ |
| LOG_ERR("Missing %s/ in href %s", "cancelAction", href); |
| return -EINVAL; |
| } |
| |
| len = strlen(helper); |
| if (len > CANCEL_BASE_SIZE - 1) { |
| /* Lack of memory is an application error */ |
| LOG_ERR("%s %s is too big (len %zu, max %zu)", "cancelAction", helper, len, |
| CANCEL_BASE_SIZE - 1); |
| return -ENOMEM; |
| } |
| |
| strncpy(cancel_base, helper, CANCEL_BASE_SIZE); |
| |
| helper = strtok(helper, "/"); |
| if (helper == 0) { |
| return -EINVAL; |
| } |
| |
| helper = strtok(NULL, "/"); |
| if (helper == 0) { |
| return -EINVAL; |
| } |
| |
| hb_context.action_id = strtol(helper, &endptr, 10); |
| if (hb_context.action_id <= 0) { |
| LOG_ERR("Invalid action_id: %d", hb_context.action_id); |
| return -EINVAL; |
| } |
| |
| return 0; |
| } |
| |
| /* |
| * Find URL component for the device's deployment operations |
| * resource |
| */ |
| static int hawkbit_find_deployment_base(struct hawkbit_ctl_res *res, char *deployment_base) |
| { |
| const char *href; |
| const char *helper; |
| size_t len; |
| |
| href = res->_links.deploymentBase.href; |
| if (!href) { |
| *deployment_base = '\0'; |
| return 0; |
| } |
| |
| LOG_DBG("_links.%s.href=%s", "deploymentBase", href); |
| |
| helper = strstr(href, "deploymentBase/"); |
| if (!helper) { |
| /* A badly formatted deployment base is a server error */ |
| LOG_ERR("Missing %s/ in href %s", "deploymentBase", href); |
| return -EINVAL; |
| } |
| |
| len = strlen(helper); |
| if (len > DEPLOYMENT_BASE_SIZE - 1) { |
| /* Lack of memory is an application error */ |
| LOG_ERR("%s %s is too big (len %zu, max %zu)", "deploymentBase", helper, len, |
| DEPLOYMENT_BASE_SIZE - 1); |
| return -ENOMEM; |
| } |
| |
| strncpy(deployment_base, helper, DEPLOYMENT_BASE_SIZE); |
| return 0; |
| } |
| |
| /* |
| * Find URL component for this device's deployment operations |
| * resource. |
| */ |
| static int hawkbit_parse_deployment(struct hawkbit_dep_res *res, int32_t *json_action_id, |
| char *download_http, int32_t *file_size) |
| { |
| int32_t size; |
| char *endptr; |
| const char *href; |
| const char *helper; |
| struct hawkbit_dep_res_chunk *chunk; |
| size_t len, num_chunks, num_artifacts; |
| struct hawkbit_dep_res_arts *artifact; |
| |
| hb_context.action_id = strtol(res->id, &endptr, 10); |
| if (hb_context.action_id < 0) { |
| LOG_ERR("Invalid action_id: %d", hb_context.action_id); |
| return -EINVAL; |
| } |
| |
| *json_action_id = hb_context.action_id; |
| |
| num_chunks = res->deployment.num_chunks; |
| if (num_chunks != 1) { |
| LOG_ERR("Expecting 1 chunk (got %d)", num_chunks); |
| return -ENOSPC; |
| } |
| |
| chunk = &res->deployment.chunks[0]; |
| if (strcmp("bApp", chunk->part)) { |
| LOG_ERR("Only part 'bApp' is supported; got %s", chunk->part); |
| return -EINVAL; |
| } |
| |
| num_artifacts = chunk->num_artifacts; |
| if (num_artifacts != 1) { |
| LOG_ERR("Expecting 1 artifact (got %d)", num_artifacts); |
| return -EINVAL; |
| } |
| |
| artifact = &chunk->artifacts[0]; |
| if (hex2bin(artifact->hashes.sha256, SHA256_HASH_SIZE << 1, hb_context.dl.file_hash, |
| sizeof(hb_context.dl.file_hash)) != SHA256_HASH_SIZE) { |
| return -EINVAL; |
| } |
| |
| size = artifact->size; |
| |
| if (size > SLOT1_SIZE) { |
| LOG_ERR("Artifact file size too big (got %d, max is %d)", size, SLOT1_SIZE); |
| return -ENOSPC; |
| } |
| |
| /* |
| * Find the download-http href. We only support the DEFAULT |
| * tenant on the same hawkBit server. |
| */ |
| href = artifact->_links.download_http.href; |
| if (!href) { |
| LOG_ERR("Missing expected %s href", "download-http"); |
| return -EINVAL; |
| } |
| |
| helper = strstr(href, "/DEFAULT/controller/v1"); |
| if (!helper) { |
| LOG_ERR("Unexpected %s href format: %s", "download-http", helper); |
| return -EINVAL; |
| } |
| |
| len = strlen(helper); |
| if (len == 0) { |
| LOG_ERR("Empty %s", "download-http"); |
| return -EINVAL; |
| } else if (len > DOWNLOAD_HTTP_SIZE - 1) { |
| LOG_ERR("%s %s is too big (len %zu, max %zu)", "download-http", helper, len, |
| DOWNLOAD_HTTP_SIZE - 1); |
| return -ENOMEM; |
| } |
| |
| /* Success. */ |
| strncpy(download_http, helper, DOWNLOAD_HTTP_SIZE); |
| *file_size = size; |
| return 0; |
| } |
| |
| static void hawkbit_dump_deployment(struct hawkbit_dep_res *d) |
| { |
| struct hawkbit_dep_res_chunk *c = &d->deployment.chunks[0]; |
| struct hawkbit_dep_res_arts *a = &c->artifacts[0]; |
| struct hawkbit_dep_res_links *l = &a->_links; |
| |
| LOG_DBG("%s=%s", "id", d->id); |
| LOG_DBG("%s=%s", "download", d->deployment.download); |
| LOG_DBG("%s=%s", "update", d->deployment.update); |
| LOG_DBG("chunks[0].%s=%s", "part", c->part); |
| LOG_DBG("chunks[0].%s=%s", "name", c->name); |
| LOG_DBG("chunks[0].%s=%s", "version", c->version); |
| LOG_DBG("chunks[0].artifacts[0].%s=%s", "filename", a->filename); |
| LOG_DBG("chunks[0].artifacts[0].%s=%s", "hashes.sha1", a->hashes.sha1); |
| LOG_DBG("chunks[0].artifacts[0].%s=%s", "hashes.md5", a->hashes.md5); |
| LOG_DBG("chunks[0].artifacts[0].%s=%s", "hashes.sha256", a->hashes.sha256); |
| LOG_DBG("chunks[0].size=%d", a->size); |
| LOG_DBG("%s=%s", "download-http", l->download_http.href); |
| LOG_DBG("%s=%s", "md5sum-http", l->md5sum_http.href); |
| } |
| |
| int hawkbit_set_custom_data_cb(hawkbit_config_device_data_cb_handler_t cb) |
| { |
| if (IS_ENABLED(CONFIG_HAWKBIT_CUSTOM_ATTRIBUTES)) { |
| if (cb == NULL) { |
| LOG_ERR("Invalid callback"); |
| return -EINVAL; |
| } |
| |
| hawkbit_config_device_data_cb_handler = cb; |
| |
| return 0; |
| } |
| return -ENOTSUP; |
| } |
| |
| int hawkbit_default_config_data_cb(const char *device_id, uint8_t *buffer, const size_t buffer_size) |
| { |
| struct hawkbit_cfg cfg = { |
| .mode = "merge", |
| .data.VIN = device_id, |
| }; |
| |
| return json_obj_encode_buf(json_cfg_descr, ARRAY_SIZE(json_cfg_descr), &cfg, buffer, |
| buffer_size); |
| } |
| |
| #ifdef CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME |
| int hawkbit_set_config(struct hawkbit_runtime_config *config) |
| { |
| if (k_sem_take(&probe_sem, HAWKBIT_SET_SERVER_TIMEOUT) == 0) { |
| if (config->server_addr != NULL) { |
| strncpy(hb_cfg.server_addr, config->server_addr, |
| sizeof(hb_cfg.server_addr)); |
| LOG_DBG("configured %s: %s", "hawkbit/server_addr", hb_cfg.server_addr); |
| } |
| if (config->server_port != 0) { |
| snprintf(hb_cfg.server_port, sizeof(hb_cfg.server_port), "%u", |
| config->server_port); |
| LOG_DBG("configured %s: %s", "hawkbit/server_port", hb_cfg.server_port); |
| } |
| #ifndef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| if (config->auth_token != NULL) { |
| strncpy(hb_cfg.ddi_security_token, config->auth_token, |
| sizeof(hb_cfg.ddi_security_token)); |
| LOG_DBG("configured %s: %s", "hawkbit/ddi_token", |
| hb_cfg.ddi_security_token); |
| } |
| #endif /* CONFIG_HAWKBIT_DDI_NO_SECURITY */ |
| #ifdef CONFIG_HAWKBIT_USE_DYNAMIC_CERT_TAG |
| if (config->tls_tag != 0) { |
| hb_cfg.tls_tag = config->tls_tag; |
| LOG_DBG("configured %s: %d", "hawkbit/tls_tag", hb_cfg.tls_tag); |
| } |
| #endif /* CONFIG_HAWKBIT_USE_DYNAMIC_CERT_TAG */ |
| settings_save(); |
| k_sem_give(&probe_sem); |
| } else { |
| LOG_WRN("failed setting config"); |
| return -EAGAIN; |
| } |
| |
| return 0; |
| } |
| #endif /* CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME */ |
| |
| struct hawkbit_runtime_config hawkbit_get_config(void) |
| { |
| struct hawkbit_runtime_config config = { |
| .server_addr = HAWKBIT_SERVER, |
| .server_port = HAWKBIT_PORT_INT, |
| .auth_token = HAWKBIT_DDI_SECURITY_TOKEN, |
| .tls_tag = HAWKBIT_CERT_TAG, |
| }; |
| |
| return config; |
| } |
| |
| int hawkbit_init(void) |
| { |
| bool image_ok; |
| int ret = 0; |
| |
| if (hawkbit_initialized) { |
| return 0; |
| } |
| |
| ret = settings_subsys_init(); |
| if (ret < 0) { |
| LOG_ERR("Failed to initialize settings subsystem: %d", ret); |
| return ret; |
| } |
| |
| ret = settings_load_subtree("hawkbit"); |
| if (ret < 0) { |
| LOG_ERR("Failed to load settings: %d", ret); |
| return ret; |
| } |
| |
| LOG_DBG("Current action_id: %d", hb_cfg.action_id); |
| |
| image_ok = boot_is_img_confirmed(); |
| LOG_INF("Current image is%s confirmed", image_ok ? "" : " not"); |
| if (!image_ok) { |
| ret = boot_write_img_confirmed(); |
| if (ret < 0) { |
| LOG_ERR("Failed to confirm current image: %d", ret); |
| return ret; |
| } |
| |
| LOG_DBG("Marked current image as OK"); |
| ret = boot_erase_img_bank(FIXED_PARTITION_ID(SLOT1_LABEL)); |
| if (ret < 0) { |
| LOG_ERR("Failed to erase second slot: %d", ret); |
| return ret; |
| } |
| } |
| hawkbit_initialized = true; |
| |
| return ret; |
| } |
| |
| static int enum_for_http_req_string(char *userdata) |
| { |
| int i = 0; |
| char *name = http_request[i].http_req_str; |
| |
| while (name) { |
| if (strcmp(name, userdata) == 0) { |
| return http_request[i].n; |
| } |
| |
| name = http_request[++i].http_req_str; |
| } |
| |
| return 0; |
| } |
| |
| static void response_cb(struct http_response *rsp, enum http_final_call final_data, void *userdata) |
| { |
| static size_t body_len; |
| int ret, type, downloaded; |
| uint8_t *body_data = NULL, *rsp_tmp = NULL; |
| |
| type = enum_for_http_req_string(userdata); |
| |
| if (rsp->http_status_code != 200) { |
| LOG_ERR("HTTP request denied (%s): %d", (char *)userdata, rsp->http_status_code); |
| if (rsp->http_status_code == 401 || rsp->http_status_code == 403) { |
| hb_context.code_status = HAWKBIT_PERMISSION_ERROR; |
| } else { |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| } |
| return; |
| } |
| |
| switch (type) { |
| case HAWKBIT_PROBE: |
| if (hb_context.dl.http_content_size == 0) { |
| hb_context.dl.http_content_size = rsp->content_length; |
| } |
| |
| if (rsp->body_found) { |
| body_data = rsp->body_frag_start; |
| body_len = rsp->body_frag_len; |
| |
| if ((hb_context.dl.downloaded_size + body_len) > |
| hb_context.response_data_size) { |
| hb_context.response_data_size = |
| hb_context.dl.downloaded_size + body_len; |
| rsp_tmp = k_realloc(hb_context.response_data, |
| hb_context.response_data_size); |
| if (rsp_tmp == NULL) { |
| LOG_ERR("Failed to realloc memory"); |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| break; |
| } |
| |
| hb_context.response_data = rsp_tmp; |
| } |
| strncpy(hb_context.response_data + hb_context.dl.downloaded_size, body_data, |
| body_len); |
| hb_context.dl.downloaded_size += body_len; |
| } |
| |
| if (final_data == HTTP_DATA_FINAL) { |
| if (hb_context.dl.http_content_size != hb_context.dl.downloaded_size) { |
| LOG_ERR("HTTP response len mismatch, expected %d, got %d", |
| hb_context.dl.http_content_size, |
| hb_context.dl.downloaded_size); |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| break; |
| } |
| |
| hb_context.response_data[hb_context.dl.downloaded_size] = '\0'; |
| ret = json_obj_parse(hb_context.response_data, |
| hb_context.dl.downloaded_size, json_ctl_res_descr, |
| ARRAY_SIZE(json_ctl_res_descr), &hawkbit_results.base); |
| if (ret < 0) { |
| LOG_ERR("JSON parse error (%s): %d", "HAWKBIT_PROBE", ret); |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| } |
| } |
| |
| break; |
| |
| case HAWKBIT_CLOSE: |
| case HAWKBIT_REPORT: |
| case HAWKBIT_CONFIG_DEVICE: |
| break; |
| |
| case HAWKBIT_PROBE_DEPLOYMENT_BASE: |
| if (hb_context.dl.http_content_size == 0) { |
| hb_context.dl.http_content_size = rsp->content_length; |
| } |
| |
| if (rsp->body_found) { |
| body_data = rsp->body_frag_start; |
| body_len = rsp->body_frag_len; |
| |
| if ((hb_context.dl.downloaded_size + body_len) > |
| hb_context.response_data_size) { |
| hb_context.response_data_size = |
| hb_context.dl.downloaded_size + body_len; |
| rsp_tmp = k_realloc(hb_context.response_data, |
| hb_context.response_data_size); |
| if (rsp_tmp == NULL) { |
| LOG_ERR("Failed to realloc memory"); |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| break; |
| } |
| |
| hb_context.response_data = rsp_tmp; |
| } |
| strncpy(hb_context.response_data + hb_context.dl.downloaded_size, body_data, |
| body_len); |
| hb_context.dl.downloaded_size += body_len; |
| } |
| |
| if (final_data == HTTP_DATA_FINAL) { |
| if (hb_context.dl.http_content_size != hb_context.dl.downloaded_size) { |
| LOG_ERR("HTTP response len mismatch, expected %d, got %d", |
| hb_context.dl.http_content_size, |
| hb_context.dl.downloaded_size); |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| break; |
| } |
| |
| hb_context.response_data[hb_context.dl.downloaded_size] = '\0'; |
| ret = json_obj_parse(hb_context.response_data, |
| hb_context.dl.downloaded_size, json_dep_res_descr, |
| ARRAY_SIZE(json_dep_res_descr), &hawkbit_results.dep); |
| if (ret < 0) { |
| LOG_ERR("JSON parse error (%s): %d", "deploymentBase", ret); |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| } |
| } |
| |
| break; |
| |
| case HAWKBIT_DOWNLOAD: |
| if (hb_context.dl.http_content_size == 0) { |
| hb_context.dl.http_content_size = rsp->content_length; |
| } |
| |
| if (rsp->body_found) { |
| body_data = rsp->body_frag_start; |
| body_len = rsp->body_frag_len; |
| |
| ret = flash_img_buffered_write(&hb_context.flash_ctx, body_data, body_len, |
| final_data == HTTP_DATA_FINAL); |
| if (ret < 0) { |
| LOG_ERR("Failed to write flash: %d", ret); |
| hb_context.code_status = HAWKBIT_DOWNLOAD_ERROR; |
| break; |
| } |
| } |
| |
| hb_context.dl.downloaded_size = flash_img_bytes_written(&hb_context.flash_ctx); |
| |
| downloaded = hb_context.dl.downloaded_size * 100 / hb_context.dl.http_content_size; |
| |
| if (downloaded > hb_context.dl.download_progress) { |
| hb_context.dl.download_progress = downloaded; |
| LOG_DBG("Downloaded: %d%% ", hb_context.dl.download_progress); |
| } |
| |
| if (final_data == HTTP_DATA_FINAL) { |
| hb_context.final_data_received = true; |
| } |
| |
| break; |
| } |
| } |
| |
| static bool send_request(enum http_method method, enum hawkbit_http_request type, |
| enum hawkbit_status_fini finished, enum hawkbit_status_exec execution) |
| { |
| int ret = 0; |
| #ifndef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| #ifdef CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME |
| char header[DDI_SECURITY_TOKEN_SIZE + sizeof(AUTH_HEADER_START) + sizeof(HTTP_CRLF) - 1]; |
| |
| snprintf(header, sizeof(header), AUTH_HEADER_FULL, hb_cfg.ddi_security_token); |
| const char *const headers[] = {header, NULL}; |
| #else |
| static const char *const headers[] = {AUTH_HEADER_FULL, NULL}; |
| #endif /* CONFIG_HAWKBIT_SET_SETTINGS_RUNTIME */ |
| #endif /* CONFIG_HAWKBIT_DDI_NO_SECURITY */ |
| |
| memset(&hb_context.http_req, 0, sizeof(hb_context.http_req)); |
| memset(&hb_context.recv_buf_tcp, 0, sizeof(hb_context.recv_buf_tcp)); |
| hb_context.http_req.url = hb_context.url_buffer; |
| hb_context.http_req.method = method; |
| hb_context.http_req.host = HAWKBIT_SERVER; |
| hb_context.http_req.port = HAWKBIT_PORT; |
| hb_context.http_req.protocol = "HTTP/1.1"; |
| hb_context.http_req.response = response_cb; |
| hb_context.http_req.recv_buf = hb_context.recv_buf_tcp; |
| hb_context.http_req.recv_buf_len = sizeof(hb_context.recv_buf_tcp); |
| #ifndef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| hb_context.http_req.header_fields = (const char **)headers; |
| #endif |
| hb_context.final_data_received = false; |
| |
| switch (type) { |
| case HAWKBIT_PROBE: |
| /* |
| * Root resource for an individual Target |
| * GET: /{tenant}/controller/v1/{controllerId} |
| */ |
| ret = http_client_req(hb_context.sock, &hb_context.http_req, HAWKBIT_RECV_TIMEOUT, |
| "HAWKBIT_PROBE"); |
| if (ret < 0) { |
| LOG_ERR("Unable to send HTTP request (%s): %d", "HAWKBIT_PROBE", ret); |
| return false; |
| } |
| |
| break; |
| |
| case HAWKBIT_CONFIG_DEVICE: |
| /* |
| * Feedback channel for the config data action |
| * POST: /{tenant}/controller/v1/{controllerId}/configData |
| */ |
| char device_id[DEVICE_ID_HEX_MAX_SIZE] = {0}; |
| |
| if (!hawkbit_get_device_identity(device_id, DEVICE_ID_HEX_MAX_SIZE)) { |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| } |
| |
| ret = hawkbit_config_device_data_cb_handler(device_id, hb_context.status_buffer, |
| sizeof(hb_context.status_buffer)); |
| if (ret) { |
| LOG_ERR("Can't encode the JSON script (%s): %d", "HAWKBIT_CONFIG_DEVICE", |
| ret); |
| return false; |
| } |
| |
| hb_context.http_req.content_type_value = HTTP_HEADER_CONTENT_TYPE_JSON; |
| hb_context.http_req.payload = hb_context.status_buffer; |
| hb_context.http_req.payload_len = strlen(hb_context.status_buffer); |
| |
| ret = http_client_req(hb_context.sock, &hb_context.http_req, HAWKBIT_RECV_TIMEOUT, |
| "HAWKBIT_CONFIG_DEVICE"); |
| if (ret < 0) { |
| LOG_ERR("Unable to send HTTP request (%s): %d", "HAWKBIT_CONFIG_DEVICE", |
| ret); |
| return false; |
| } |
| |
| break; |
| |
| case HAWKBIT_CLOSE: |
| /* |
| * Feedback channel for cancel actions |
| * POST: /{tenant}/controller/v1/{controllerId}/cancelAction/{actionId}/feedback |
| */ |
| struct hawkbit_close close = { |
| .status.execution = hawkbit_status_execution(execution), |
| .status.result.finished = hawkbit_status_finished(finished), |
| }; |
| |
| ret = json_obj_encode_buf(json_close_descr, ARRAY_SIZE(json_close_descr), &close, |
| hb_context.status_buffer, |
| sizeof(hb_context.status_buffer)); |
| if (ret) { |
| LOG_ERR("Can't encode the JSON script (%s): %d", "HAWKBIT_CLOSE", ret); |
| return false; |
| } |
| |
| hb_context.http_req.content_type_value = HTTP_HEADER_CONTENT_TYPE_JSON; |
| hb_context.http_req.payload = hb_context.status_buffer; |
| hb_context.http_req.payload_len = strlen(hb_context.status_buffer); |
| |
| ret = http_client_req(hb_context.sock, &hb_context.http_req, HAWKBIT_RECV_TIMEOUT, |
| "HAWKBIT_CLOSE"); |
| if (ret < 0) { |
| LOG_ERR("Unable to send HTTP request (%s): %d", "HAWKBIT_CLOSE", ret); |
| return false; |
| } |
| |
| break; |
| |
| case HAWKBIT_PROBE_DEPLOYMENT_BASE: |
| /* |
| * Resource for software module (Deployment Base) |
| * GET: /{tenant}/controller/v1/{controllerId}/deploymentBase/{actionId} |
| */ |
| hb_context.http_req.content_type_value = NULL; |
| ret = http_client_req(hb_context.sock, &hb_context.http_req, HAWKBIT_RECV_TIMEOUT, |
| "HAWKBIT_PROBE_DEPLOYMENT_BASE"); |
| if (ret < 0) { |
| LOG_ERR("Unable to send HTTP request (%s): %d", |
| "HAWKBIT_PROBE_DEPLOYMENT_BASE", ret); |
| return false; |
| } |
| |
| break; |
| |
| case HAWKBIT_REPORT: |
| /* |
| * Feedback channel for the DeploymentBase action |
| * POST: /{tenant}/controller/v1/{controllerId}/deploymentBase/{actionId}/feedback |
| */ |
| const char *fini = hawkbit_status_finished(finished); |
| const char *exec = hawkbit_status_execution(execution); |
| |
| LOG_INF("Reporting deployment feedback %s (%s) for action %d", fini, exec, |
| hb_context.json_action_id); |
| |
| struct hawkbit_dep_fbk feedback = { |
| .status.execution = exec, |
| .status.result.finished = fini, |
| }; |
| |
| ret = json_obj_encode_buf(json_dep_fbk_descr, ARRAY_SIZE(json_dep_fbk_descr), |
| &feedback, hb_context.status_buffer, |
| sizeof(hb_context.status_buffer)); |
| if (ret) { |
| LOG_ERR("Can't encode the JSON script (%s): %d", "HAWKBIT_REPORT", ret); |
| return ret; |
| } |
| |
| hb_context.http_req.content_type_value = HTTP_HEADER_CONTENT_TYPE_JSON; |
| hb_context.http_req.payload = hb_context.status_buffer; |
| hb_context.http_req.payload_len = strlen(hb_context.status_buffer); |
| |
| ret = http_client_req(hb_context.sock, &hb_context.http_req, HAWKBIT_RECV_TIMEOUT, |
| "HAWKBIT_REPORT"); |
| if (ret < 0) { |
| LOG_ERR("Unable to send HTTP request (%s): %d", "HAWKBIT_REPORT", ret); |
| return false; |
| } |
| |
| break; |
| |
| case HAWKBIT_DOWNLOAD: |
| /* |
| * Resource for software module (Deployment Base) |
| * GET: /{tenant}/controller/v1/{controllerId}/softwaremodules/{softwareModuleId}/ |
| * artifacts/{fileName} |
| */ |
| ret = http_client_req(hb_context.sock, &hb_context.http_req, HAWKBIT_RECV_TIMEOUT, |
| "HAWKBIT_DOWNLOAD"); |
| if (ret < 0) { |
| LOG_ERR("Unable to send HTTP request (%s): %d", "HAWKBIT_DOWNLOAD", ret); |
| return false; |
| } |
| |
| break; |
| } |
| |
| return true; |
| } |
| |
| void hawkbit_reboot(void) |
| { |
| LOG_PANIC(); |
| sys_reboot(IS_ENABLED(CONFIG_HAWKBIT_REBOOT_COLD) ? SYS_REBOOT_COLD : SYS_REBOOT_WARM); |
| } |
| |
| static bool check_hawkbit_server(void) |
| { |
| if (strlen(HAWKBIT_SERVER) == 0) { |
| if (sizeof(CONFIG_HAWKBIT_SERVER) > 1) { |
| hawkbit_set_server_addr(CONFIG_HAWKBIT_SERVER); |
| } else { |
| LOG_ERR("no valid %s found", "hawkbit/server_addr"); |
| return false; |
| } |
| } |
| |
| if (HAWKBIT_PORT_INT == 0) { |
| if (CONFIG_HAWKBIT_PORT > 0) { |
| hawkbit_set_server_port(CONFIG_HAWKBIT_PORT); |
| } else { |
| LOG_ERR("no valid %s found", "hawkbit/server_port"); |
| return false; |
| } |
| } |
| |
| #ifndef CONFIG_HAWKBIT_DDI_NO_SECURITY |
| if (strlen(HAWKBIT_DDI_SECURITY_TOKEN) == 0) { |
| if (sizeof(CONFIG_HAWKBIT_DDI_SECURITY_TOKEN) > 1) { |
| hawkbit_set_ddi_security_token(CONFIG_HAWKBIT_DDI_SECURITY_TOKEN); |
| } else { |
| LOG_ERR("no valid %s found", "hawkbit/ddi_token"); |
| return false; |
| } |
| } |
| #endif /* CONFIG_HAWKBIT_DDI_NO_SECURITY */ |
| |
| return true; |
| } |
| |
| enum hawkbit_response hawkbit_probe(void) |
| { |
| int ret; |
| int32_t file_size = 0; |
| struct flash_img_check fic; |
| char device_id[DEVICE_ID_HEX_MAX_SIZE] = { 0 }, |
| cancel_base[CANCEL_BASE_SIZE] = { 0 }, |
| download_http[DOWNLOAD_HTTP_SIZE] = { 0 }, |
| deployment_base[DEPLOYMENT_BASE_SIZE] = { 0 }, |
| firmware_version[BOOT_IMG_VER_STRLEN_MAX] = { 0 }; |
| |
| if (!hawkbit_initialized) { |
| return HAWKBIT_NOT_INITIALIZED; |
| } |
| |
| if (!check_hawkbit_server()) { |
| return HAWKBIT_NETWORKING_ERROR; |
| } |
| |
| if (k_sem_take(&probe_sem, K_NO_WAIT) != 0) { |
| return HAWKBIT_PROBE_IN_PROGRESS; |
| } |
| |
| memset(&hb_context, 0, sizeof(hb_context)); |
| |
| hb_context.response_data_size = RESPONSE_BUFFER_SIZE; |
| hb_context.response_data = k_calloc(hb_context.response_data_size, sizeof(uint8_t)); |
| if (hb_context.response_data == NULL) { |
| LOG_ERR("Failed to allocate memory"); |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| goto error; |
| } |
| |
| if (!boot_is_img_confirmed()) { |
| LOG_ERR("Current image is not confirmed"); |
| hb_context.code_status = HAWKBIT_UNCONFIRMED_IMAGE; |
| goto error; |
| } |
| |
| if (!hawkbit_get_firmware_version(firmware_version, BOOT_IMG_VER_STRLEN_MAX)) { |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| goto error; |
| } |
| |
| if (!hawkbit_get_device_identity(device_id, DEVICE_ID_HEX_MAX_SIZE)) { |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| goto error; |
| } |
| |
| if (!start_http_client()) { |
| hb_context.code_status = HAWKBIT_NETWORKING_ERROR; |
| goto error; |
| } |
| |
| /* |
| * Query the hawkBit base polling resource. |
| */ |
| LOG_INF("Polling target data from hawkBit"); |
| |
| memset(hb_context.url_buffer, 0, sizeof(hb_context.url_buffer)); |
| hb_context.dl.http_content_size = 0; |
| hb_context.dl.downloaded_size = 0; |
| snprintk(hb_context.url_buffer, sizeof(hb_context.url_buffer), "%s/%s-%s", |
| HAWKBIT_JSON_URL, CONFIG_BOARD, device_id); |
| memset(&hawkbit_results.base, 0, sizeof(hawkbit_results.base)); |
| |
| if (!send_request(HTTP_GET, HAWKBIT_PROBE, HAWKBIT_STATUS_FINISHED_NONE, |
| HAWKBIT_STATUS_EXEC_NONE)) { |
| LOG_ERR("Send request failed (%s)", "HAWKBIT_PROBE"); |
| hb_context.code_status = HAWKBIT_NETWORKING_ERROR; |
| goto cleanup; |
| } |
| |
| if (hb_context.code_status == HAWKBIT_METADATA_ERROR || |
| hb_context.code_status == HAWKBIT_PERMISSION_ERROR) { |
| goto cleanup; |
| } |
| |
| if (hawkbit_results.base.config.polling.sleep) { |
| /* Update the sleep time. */ |
| hawkbit_update_sleep(&hawkbit_results.base); |
| LOG_DBG("config.polling.sleep=%s", hawkbit_results.base.config.polling.sleep); |
| } |
| |
| |
| if (hawkbit_results.base._links.cancelAction.href) { |
| ret = hawkbit_find_cancelAction_base(&hawkbit_results.base, cancel_base); |
| memset(hb_context.url_buffer, 0, sizeof(hb_context.url_buffer)); |
| hb_context.dl.http_content_size = 0; |
| snprintk(hb_context.url_buffer, sizeof(hb_context.url_buffer), |
| "%s/%s-%s/%s/feedback", HAWKBIT_JSON_URL, CONFIG_BOARD, device_id, |
| cancel_base); |
| memset(&hawkbit_results.cancel, 0, sizeof(hawkbit_results.cancel)); |
| |
| if (!send_request(HTTP_POST, HAWKBIT_CLOSE, HAWKBIT_STATUS_FINISHED_SUCCESS, |
| HAWKBIT_STATUS_EXEC_CLOSED)) { |
| LOG_ERR("Send request failed (%s)", "HAWKBIT_CLOSE"); |
| hb_context.code_status = HAWKBIT_NETWORKING_ERROR; |
| goto cleanup; |
| } |
| |
| hb_context.code_status = HAWKBIT_CANCEL_UPDATE; |
| goto cleanup; |
| } |
| |
| if (hawkbit_results.base._links.configData.href) { |
| LOG_DBG("_links.%s.href=%s", "configData", |
| hawkbit_results.base._links.configData.href); |
| memset(hb_context.url_buffer, 0, sizeof(hb_context.url_buffer)); |
| hb_context.dl.http_content_size = 0; |
| snprintk(hb_context.url_buffer, sizeof(hb_context.url_buffer), "%s/%s-%s/%s", |
| HAWKBIT_JSON_URL, CONFIG_BOARD, device_id, "configData"); |
| |
| if (!send_request(HTTP_PUT, HAWKBIT_CONFIG_DEVICE, HAWKBIT_STATUS_FINISHED_SUCCESS, |
| HAWKBIT_STATUS_EXEC_CLOSED)) { |
| LOG_ERR("Send request failed (%s)", "HAWKBIT_CONFIG_DEVICE"); |
| hb_context.code_status = HAWKBIT_NETWORKING_ERROR; |
| goto cleanup; |
| } |
| } |
| |
| ret = hawkbit_find_deployment_base(&hawkbit_results.base, deployment_base); |
| if (ret < 0) { |
| hb_context.code_status = HAWKBIT_METADATA_ERROR; |
| LOG_ERR("Unable to find URL for the device's deploymentBase: %d", ret); |
| goto cleanup; |
| } |
| |
| if (strlen(deployment_base) == 0) { |
| hb_context.code_status = HAWKBIT_NO_UPDATE; |
| goto cleanup; |
| } |
| |
| memset(hb_context.url_buffer, 0, sizeof(hb_context.url_buffer)); |
| hb_context.dl.http_content_size = 0; |
| hb_context.dl.downloaded_size = 0; |
| snprintk(hb_context.url_buffer, sizeof(hb_context.url_buffer), "%s/%s-%s/%s", |
| HAWKBIT_JSON_URL, CONFIG_BOARD, device_id, deployment_base); |
| memset(&hawkbit_results.dep, 0, sizeof(hawkbit_results.dep)); |
| memset(hb_context.response_data, 0, hb_context.response_data_size); |
| |
| if (!send_request(HTTP_GET, HAWKBIT_PROBE_DEPLOYMENT_BASE, HAWKBIT_STATUS_FINISHED_NONE, |
| HAWKBIT_STATUS_EXEC_NONE)) { |
| LOG_ERR("Send request failed (%s)", "HAWKBIT_PROBE_DEPLOYMENT_BASE"); |
| hb_context.code_status = HAWKBIT_NETWORKING_ERROR; |
| goto cleanup; |
| } |
| |
| if (hb_context.code_status == HAWKBIT_METADATA_ERROR) { |
| goto cleanup; |
| } |
| |
| hawkbit_dump_deployment(&hawkbit_results.dep); |
| |
| hb_context.dl.http_content_size = 0; |
| ret = hawkbit_parse_deployment(&hawkbit_results.dep, &hb_context.json_action_id, |
| download_http, &file_size); |
| if (ret < 0) { |
| LOG_ERR("Failed to parse deploymentBase: %d", ret); |
| goto cleanup; |
| } |
| |
| if (hb_cfg.action_id == (int32_t)hb_context.json_action_id) { |
| LOG_INF("Preventing repeated attempt to install %d", hb_context.json_action_id); |
| hb_context.dl.http_content_size = 0; |
| memset(hb_context.url_buffer, 0, sizeof(hb_context.url_buffer)); |
| snprintk(hb_context.url_buffer, sizeof(hb_context.url_buffer), |
| "%s/%s-%s/%s/%d/feedback", HAWKBIT_JSON_URL, CONFIG_BOARD, |
| device_id, "deploymentBase", hb_context.json_action_id); |
| |
| if (!send_request(HTTP_POST, HAWKBIT_REPORT, HAWKBIT_STATUS_FINISHED_SUCCESS, |
| HAWKBIT_STATUS_EXEC_CLOSED)) { |
| LOG_ERR("Send request failed (%s)", "HAWKBIT_REPORT"); |
| hb_context.code_status = HAWKBIT_NETWORKING_ERROR; |
| goto cleanup; |
| } |
| |
| hb_context.code_status = HAWKBIT_OK; |
| goto cleanup; |
| } |
| |
| LOG_INF("Ready to install update"); |
| |
| hb_context.dl.http_content_size = 0; |
| memset(hb_context.url_buffer, 0, sizeof(hb_context.url_buffer)); |
| snprintk(hb_context.url_buffer, sizeof(hb_context.url_buffer), "%s", download_http); |
| |
| flash_img_init(&hb_context.flash_ctx); |
| |
| if (!send_request(HTTP_GET, HAWKBIT_DOWNLOAD, HAWKBIT_STATUS_FINISHED_NONE, |
| HAWKBIT_STATUS_EXEC_NONE)) { |
| LOG_ERR("Send request failed (%s)", "HAWKBIT_DOWNLOAD"); |
| hb_context.code_status = HAWKBIT_NETWORKING_ERROR; |
| goto cleanup; |
| } |
| |
| if (hb_context.code_status == HAWKBIT_DOWNLOAD_ERROR) { |
| goto cleanup; |
| } |
| |
| /* Check if download finished */ |
| if (!hb_context.final_data_received) { |
| LOG_ERR("Download incomplete"); |
| hb_context.code_status = HAWKBIT_DOWNLOAD_ERROR; |
| goto cleanup; |
| } |
| |
| /* Verify the hash of the stored firmware */ |
| fic.match = hb_context.dl.file_hash; |
| fic.clen = hb_context.dl.downloaded_size; |
| if (flash_img_check(&hb_context.flash_ctx, &fic, FIXED_PARTITION_ID(SLOT1_LABEL))) { |
| LOG_ERR("Failed to validate stored firmware"); |
| hb_context.code_status = HAWKBIT_DOWNLOAD_ERROR; |
| goto cleanup; |
| } |
| |
| /* Request mcuboot to upgrade */ |
| if (boot_request_upgrade(BOOT_UPGRADE_TEST)) { |
| LOG_ERR("Failed to mark the image in slot 1 as pending"); |
| hb_context.code_status = HAWKBIT_DOWNLOAD_ERROR; |
| goto cleanup; |
| } |
| |
| /* If everything is successful */ |
| hb_context.code_status = HAWKBIT_UPDATE_INSTALLED; |
| hawkbit_device_acid_update(hb_context.json_action_id); |
| |
| hb_context.dl.http_content_size = 0; |
| |
| cleanup: |
| cleanup_connection(); |
| |
| error: |
| k_free(hb_context.response_data); |
| k_sem_give(&probe_sem); |
| return hb_context.code_status; |
| } |