Azure C SDKs common code
Перейти к файлу
Eric Wolz d1b23c08aa schannel dbg 2023-03-27 15:15:49 -07:00
adapters schannel dbg 2023-03-27 15:15:49 -07:00
archive/cyclonessl Fix OptionHandler_AddOption result check in tlsio_wolfssl.c, use MU_DEFINE_ENUM_WITHOUT_INVALID in OptionHandler 2019-11-13 14:20:51 -08:00
build Remove cleanup and component detection in build (leftover) 2023-02-08 16:13:21 -08:00
build_all Remove files related to MBED OS (not mbedtls\!) 2023-02-07 15:47:30 -08:00
configs Use PAL time functions in the console logger (#558) 2021-09-14 18:34:09 -07:00
deps update submodule refrence 2020-03-04 10:46:19 -08:00
devdoc Remove files related to MBED OS (not mbedtls\!) 2023-02-07 15:47:30 -08:00
inc/azure_c_shared_utility Remove files related to MBED OS (not mbedtls\!) 2023-02-07 15:47:30 -08:00
jenkins Remove files related to MBED OS (not mbedtls\!) 2023-02-07 15:47:30 -08:00
pal clang static code analyzer issues (#527) 2021-05-03 10:34:26 -07:00
samples Remove files related to MBED OS (not mbedtls\!) 2023-02-07 15:47:30 -08:00
src Fix for memory leak in http-proxy-io for retrieveoptions (#592) 2022-04-19 13:14:26 -07:00
tests add openssl 3 compat and ubuntu 22.04 (#604) 2022-08-04 10:41:38 -07:00
testtools Remove files related to MBED OS (not mbedtls\!) 2023-02-07 15:47:30 -08:00
.gitattributes Normalized linux line endings 2016-03-23 07:42:53 -07:00
.gitignore Added newer files to ignore in the gitignore file 2018-11-09 08:58:08 -08:00
.gitmodules Update umock repo and renamed files that have changed (#297) 2019-04-10 17:36:08 -07:00
CMakeLists.txt Adding support for OpenSSL engines when using curl (#602) 2022-09-16 16:49:26 -07:00
LICENSE Initial project commit file 2015-10-30 11:35:32 -07:00
README.md Minor fix to root README.md (#523) 2021-05-03 12:19:04 -07:00
SECURITY.MD remove en-us from links (#576) 2021-11-22 13:29:30 -08:00
dependencies-test.cmake Makes azure-c-shared-utility installable and a find module in CMake. Adds a flag for using installed packages instead of adding submodules. 2016-11-08 10:53:23 -08:00
dependencies.cmake Attempt to fix again dependencies 2019-05-24 13:50:45 -07:00
version.txt Replace %zu with %lu for mbed builds (#254) 2019-01-14 09:27:15 -08:00

README.md

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Azure C Shared Utility

azure-c-shared-utility is a C library providing common functionality for basic tasks (like string, list manipulation, IO, etc.).

Dependencies

azure-c-shared-utility provides 3 tlsio implementations:

  • tlsio_schannel - runs only on Windows
  • tlsio_openssl - depends on OpenSSL being installed
  • tlsio_wolfssl - depends on WolfSSL being installed

azure-c-shared-utility depends on curl for HTTPAPI for Linux.

azure-c-shared-utility uses cmake for configuring build files.

Setup

  1. Clone azure-c-shared-utility using the recursive option:
git clone --recursive https://github.com/Azure/azure-c-shared-utility.git
  1. Create a folder called cmake under azure-c-shared-utility

  2. Switch to the cmake folder and run

cmake ..
  1. Build
cmake --build .

Installation and Use

Optionally, you may choose to install azure-c-shared-utility on your machine:

  1. Switch to the cmake folder and run

    cmake -Duse_installed_dependencies=ON ../
    
    cmake --build . --target install
    

    or install using the follow commands for each platform:

    On Linux:

    sudo make install
    

    On Windows:

    msbuild /m INSTALL.vcxproj
    
  2. Use it in your project (if installed)

    find_package(azure_c_shared_utility REQUIRED CONFIG)
    target_link_library(yourlib aziotsharedutil)
    

If running tests, this requires that umock-c, azure-ctest, and azure-c-testrunnerswitcher are installed (through CMake) on your machine.

Building the tests

In order to build the tests use:

cmake .. -Drun_unittests:bool=ON

Configuration options

In order to turn on/off the tlsio implementations use the following CMAKE options:

  • -Duse_schannel:bool={ON/OFF} - turns on/off the SChannel support
  • -Duse_openssl:bool={ON/OFF} - turns on/off the OpenSSL support. If this option is used, an environment variable named OpenSSLDir should be set to point to the OpenSSL folder.
  • -Duse_wolfssl:bool={ON/OFF} - turns on/off the WolfSSL support. If this option is used, an environment variable named WolfSSLDir should be set to point to the WolfSSL folder.
  • -Duse_http:bool={ON/OFF} - turns on/off the HTTP API support.
  • -Duse_installed_dependencies:bool={ON/OFF} - turns on/off building azure-c-shared-utility using installed dependencies. This package may only be installed if this flag is ON.
  • -Drun_unittests:bool={ON/OFF} - enables building of unit tests. Default is OFF.

Porting to new devices

Instructions for porting the Azure IoT C SDK to new devices are located here.