{"id":19775041,"url":"https://github.com/freertos/corehttp","last_synced_at":"2025-04-04T13:10:21.023Z","repository":{"id":42386056,"uuid":"290592099","full_name":"FreeRTOS/coreHTTP","owner":"FreeRTOS","description":"Client implementation of a subset of HTTP 1.1 protocol designed for embedded devices.","archived":false,"fork":false,"pushed_at":"2025-01-16T17:52:32.000Z","size":2343,"stargazers_count":88,"open_issues_count":7,"forks_count":79,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-03-28T12:06:46.050Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FreeRTOS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-26T19:57:10.000Z","updated_at":"2025-03-25T07:22:02.000Z","dependencies_parsed_at":"2023-02-01T12:01:36.872Z","dependency_job_id":"6008b0a9-65c9-49a2-92a2-7831188f5e89","html_url":"https://github.com/FreeRTOS/coreHTTP","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeRTOS%2FcoreHTTP","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeRTOS%2FcoreHTTP/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeRTOS%2FcoreHTTP/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeRTOS%2FcoreHTTP/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FreeRTOS","download_url":"https://codeload.github.com/FreeRTOS/coreHTTP/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247182355,"owners_count":20897379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T05:14:39.388Z","updated_at":"2025-04-04T13:10:21.005Z","avatar_url":"https://github.com/FreeRTOS.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# coreHTTP Client Library\n\n**[API Documentation Pages for current and previous releases of this library can be found here](https://freertos.github.io/coreHTTP/)**\n\n\nThis repository contains a C language HTTP client library designed for embedded\nplatforms. It has no dependencies on any additional libraries other than the\nstandard C library, [llhttp](https://github.com/nodejs/llhttp), and a\ncustomer-implemented transport interface. This library is distributed under the\n[MIT Open Source License](LICENSE).\n\nThis library has gone through code quality checks including verification that no\nfunction has a\n[GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html)\nscore over 8. This library has also undergone both static code analysis from\n[Coverity static analysis](https://scan.coverity.com/), and validation of memory\nsafety and data structure invariance through the\n[CBMC automated reasoning tool](https://www.cprover.org/cbmc/).\n\nSee memory requirements for this library\n[here](./docs/doxygen/include/size_table.md).\n\n**coreHTTP v3.1.1\n[source code](https://github.com/FreeRTOS/coreHTTP/tree/v3.1.1/source) is part\nof the\n[FreeRTOS 202406.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202406.00-LTS)\nrelease.**\n\n## coreHTTP Config File\n\nThe HTTP client library exposes configuration macros that are required for\nbuilding the library. A list of all the configurations and their default values\nare defined in\n[core_http_config_defaults.h](source/include/core_http_config_defaults.h). To\nprovide custom values for the configuration macros, a custom config file named\n`core_http_config.h` can be provided by the user application to the library.\n\nBy default, a `core_http_config.h` custom config is required to build the\nlibrary. To disable this requirement and build the library with default\nconfiguration values, provide `HTTP_DO_NOT_USE_CUSTOM_CONFIG` as a compile time\npreprocessor macro.\n\n**The HTTP client library can be built by either**:\n\n- Defining a `core_http_config.h` file in the application, and adding it to the\n  include directories for the library build. **OR**\n- Defining the `HTTP_DO_NOT_USE_CUSTOM_CONFIG` preprocessor macro for the\n  library build.\n\n## Building the Library\n\nThe [httpFilePaths.cmake](httpFilePaths.cmake) file contains the information of\nall source files and header include paths required to build the HTTP client\nlibrary.\n\nAs mentioned in the [previous section](#coreHTTP-Config-File), either a custom\nconfig file (i.e. `core_http_config.h`) OR `HTTP_DO_NOT_USE_CUSTOM_CONFIG` macro\nneeds to be provided to build the HTTP client library.\n\nFor a CMake example of building the HTTP library with the `httpFilePaths.cmake`\nfile, refer to the `coverity_analysis` library target in\n[test/CMakeLists.txt](test/CMakeLists.txt) file.\n\n## Building Unit Tests\n\n### Platform Prerequisites\n\n- For running unit tests, the following are required:\n  - **C90 compiler** like gcc\n  - **CMake 3.13.0 or later**\n  - **Ruby 2.0.0 or later** is required for this repository's\n    [CMock test framework](https://github.com/ThrowTheSwitch/CMock).\n- For running the coverage target, the following are required:\n  - **gcov**\n  - **lcov**\n\n### Steps to build **Unit Tests**\n\n1. Go to the root directory of this repository.\n\n1. Run the _cmake_ command:\n   `cmake -S test -B build -DBUILD_CLONE_SUBMODULES=ON `\n\n1. Run this command to build the library and unit tests: `make -C build all`\n\n1. The generated test executables will be present in `build/bin/tests` folder.\n\n1. Run `cd build \u0026\u0026 ctest` to execute all tests and view the test run summary.\n\n## CBMC\n\nTo learn more about CBMC and proofs specifically, review the training material\n[here](https://model-checking.github.io/cbmc-training).\n\nThe `test/cbmc/proofs` directory contains CBMC proofs.\n\nIn order to run these proofs you will need to install CBMC and other tools by\nfollowing the instructions\n[here](https://model-checking.github.io/cbmc-training/installation.html).\n\n## Reference examples\n\nThe AWS IoT Device SDK for Embedded C repository contains demos of using the\nHTTP client library\n[here](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/http)\non a POSIX platform. These can be used as reference examples for the library\nAPI.\n\n## Documentation\n\n### Existing Documentation\n\nFor pre-generated documentation, please see the documentation linked in the\nlocations below:\n\n|                                                       Location                                                       |\n| :------------------------------------------------------------------------------------------------------------------: |\n| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |\n|       [API Documentation](https://freertos.github.io/coreHTTP/main/index.html)        |\n\nNote that the latest included version of coreHTTP may differ across\nrepositories.\n\n### Generating Documentation\n\nThe Doxygen references were created using Doxygen version 1.9.6. To generate the\nDoxygen pages, please run the following command from the root of this\nrepository:\n\n```shell\ndoxygen docs/doxygen/config.doxyfile\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on\ncontributing.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreertos%2Fcorehttp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreertos%2Fcorehttp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreertos%2Fcorehttp/lists"}