Rename master=>main ; link fixup (#2165)

This commit is contained in:
John Spaith 2021-12-01 11:07:26 -08:00 коммит произвёл GitHub
Родитель 32942abb99
Коммит de09b35289
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
31 изменённых файлов: 67 добавлений и 51 удалений

2
.github/CONTRIBUTING.md поставляемый
Просмотреть файл

@ -13,7 +13,7 @@
*Our SDKs are open-source and we do accept pull-requests if you feel like taking a stab at fixing the bug and maybe adding your name to our commit history :) Please mention any relevant issue number in the pull request description.* Please see [Contribute code](#contribute-code) below.
# Contribute code or documentation
We require pull-requests for code and documentation to be submitted against the `master` branch in order to review and run it in our gated build system. We try to maintain a high bar for code quality and maintainability, we insist on having tests associated with the code, and if necessary, additions/modifications to the requirement documents.
We require pull-requests for code and documentation to be submitted against the `main` branch in order to review and run it in our gated build system. We try to maintain a high bar for code quality and maintainability, we insist on having tests associated with the code, and if necessary, additions/modifications to the requirement documents.
Also, have you signed the [Contribution License Agreement](https://cla.microsoft.com/) ([CLA](https://cla.microsoft.com/))? A friendly bot will remind you about it when you submit your pull-request.

2
.github/ISSUE_TEMPLATE/bug-report.md поставляемый
Просмотреть файл

@ -28,7 +28,7 @@ How to Submit an Azure Support Ticket: https://docs.microsoft.com/azure/azure-su
- A detailed description.
- A Minimal Complete Reproducible Example (https://stackoverflow.com/help/mcve). This is code we can cut and paste into a readily available sample and run, or a link to a project you've written that we can compile to reproduce the bug.
- Console logs. If you are unsure how to enable logging, refer to this document: https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/Iothub_sdk_options.md
- Console logs. If you are unsure how to enable logging, refer to this document: https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/Iothub_sdk_options.md
5. Delete these instructions before submitting the bug.

6
.github/PULL_REQUEST_TEMPLATE.md поставляемый
Просмотреть файл

@ -6,13 +6,13 @@ This being said, the more you do, the quicker it'll go through our gated build!
-->
# Checklist
- [ ] I have read the [contribution guidelines] (https://github.com/Azure/azure-iot-sdk-c/blob/master/.github/CONTRIBUTING.md).
- [ ] I have read the [contribution guidelines] (https://github.com/Azure/azure-iot-sdk-c/blob/main/.github/CONTRIBUTING.md).
- [ ] I added or modified the existing tests to cover the change (we do not allow our test coverage to go down).
- If this is a modification that impacts the behavior of a public API
- [ ] I edited the corresponding document in the `devdoc` folder and added or modified requirements.
- I submitted this PR against the correct branch:
- [ ] This pull-request is submitted against the `master` branch.
- [ ] I have merged the latest `master` branch prior to submission and re-merged as needed after I took any feedback.
- [ ] This pull-request is submitted against the `main` branch.
- [ ] I have merged the latest `main` branch prior to submission and re-merged as needed after I took any feedback.
- [ ] I have squashed my changes into one with a clear description of the change.
# Reference/Link to the issue solved with this PR (if any)

Просмотреть файл

@ -22,7 +22,7 @@ jobs:
displayName: 'Setup'
- script: |
npm install check_submodules
./../../node_modules/.bin/check_submodules . master
./../../node_modules/.bin/check_submodules . main
displayName: 'Check Submodules Match'
- job: windowsx86
pool:

Просмотреть файл

@ -5,7 +5,7 @@ schedules:
displayName: Daily midnight build
branches:
include:
- master
- main
jobs:
- job: Cross_Compile

Просмотреть файл

@ -181,10 +181,10 @@ The options are presented only as compilation flags and must be appended to the
| `"XIO Receive Buffer"` | `-DcompileOption_C="-DXIO_RECEIVE_BUFFER_SIZE=<value>"` | Configure the internal XIO receive buffer.
[iothub-client-options-h]: https://github.com/Azure/azure-iot-sdk-c/blob/master/iothub_client/inc/iothub_client_options.h
[iothub-client-options-h]: https://github.com/Azure/azure-iot-sdk-c/blob/main/iothub_client/inc/iothub_client_options.h
[shared-util-options-h]: https://github.com/Azure/azure-c-shared-utility/blob/master/inc/azure_c_shared_utility/shared_util_options.h
[provisioning-device-ll-client-options-h]: https://github.com/Azure/azure-iot-sdk-c/blob/master/provisioning_client/inc/azure_prov_client/prov_device_ll_client.h
[provisioning-device-client-options-h]: https://github.com/Azure/azure-iot-sdk-c/blob/master/provisioning_client/inc/azure_prov_client/prov_device_client.h
[provisioning-device-ll-client-options-h]: https://github.com/Azure/azure-iot-sdk-c/blob/main/provisioning_client/inc/azure_prov_client/prov_device_ll_client.h
[provisioning-device-client-options-h]: https://github.com/Azure/azure-iot-sdk-c/blob/main/provisioning_client/inc/azure_prov_client/prov_device_client.h
[iot-pnp]: https://aka.ms/iotpnp
[gateway-sample]: https://github.com/Azure/azure-iot-sdk-c/tree/master/iothub_client/samples/iotedge_downstream_device_sample
[gateway-sample]: https://github.com/Azure/azure-iot-sdk-c/tree/main/iothub_client/samples/iotedge_downstream_device_sample
[tick-counter-header]: https://github.com/Azure/azure-c-shared-utility/blob/master/inc/azure_c_shared_utility/tickcounter.h

Просмотреть файл

@ -36,7 +36,7 @@ cd azure-iot-sdk-c
git submodule update --init
```
Further information regarding this step and other set up requirements can be found in this [guide](https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/devbox_setup.md). This step is only included in this document to establish the directory structure used for the rest of the example.
Further information regarding this step and other set up requirements can be found in this [guide](https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/devbox_setup.md). This step is only included in this document to establish the directory structure used for the rest of the example.
You might consider building the SDK for your local platform at this point simply to ensure you have all the required components. At the very least, you must ensure that the SDK's prerequisite libraries are installed on your Raspberry Pi. You can achieve this by running the script _setup.sh_ found in _azure-iot-sdk-c/build\_all/linux_.
@ -134,7 +134,7 @@ This document has demonstrated how to cross compile the Azure IoT SDK on a 64-bi
<https://github.com/Azure/azure-iot-sdks>
<https://github.com/Azure/azure-iot-sdks/blob/master/c/doc/devbox_setup.md>
<https://github.com/Azure/azure-iot-sdks/blob/main/c/doc/devbox_setup.md>
<https://github.com/raspberrypi/tools>

Просмотреть файл

@ -86,4 +86,4 @@ Network packets measure the number of bytes that are sent form the C-SDK with th
## Note on constrained devices
The `Embedded C SDK` is an alternative for constrained devices which enables the BYO (bring your own) network approach: IoT developers have the freedom of choice to bring MQTT client, TLS and Socket of their choice to create a device solution. Find more information about the Embedded C SDK [here](https://github.com/Azure/azure-sdk-for-c/tree/master/sdk/docs/iot).
The `Embedded C SDK` is an alternative for constrained devices which enables the BYO (bring your own) network approach: IoT developers have the freedom of choice to bring MQTT client, TLS and Socket of their choice to create a device solution. Find more information about the Embedded C SDK [here](https://github.com/Azure/azure-sdk-for-c/tree/main/sdk/docs/iot).

Просмотреть файл

@ -62,9 +62,9 @@ The design of the Azure IoT C SDK is composed of layers, each of them assigned s
| **Layer** | **C module** | **Purpose** |
|---------------------------|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Azure IoT C SDK | [iothub\_client](https://github.com/Azure/azure-iot-sdk-c/blob/master/iothub_client/inc/iothub_client.h) | Multi-threaded layer over iothub\_ll\_client (automatically performs invocation of the IoTHubClient\_LL\_DoWork function and internal callback handling) |
| Azure IoT C Low Level SDK | [iothub\_client\_ll](https://github.com/Azure/azure-iot-sdk-c/blob/master/iothub_client/inc/iothub_client_ll.h) | Main surface of the Azure IoT device client API (single-threaded) |
| Protocol Transport | [iothubtransport\*](https://github.com/Azure/azure-iot-sdk-c/tree/master/iothub_client/inc) | Provides an interface between the specific protocol API (e.g., [uamqp](https://github.com/Azure/azure-uamqp-c), [umqtt](https://github.com/Azure/azure-umqtt-c)) and the upper client SDK. It is responsible for part of the business logic, the message queuing and timeout control, options handling. |
| Azure IoT C SDK | [iothub\_client](https://github.com/Azure/azure-iot-sdk-c/blob/main/iothub_client/inc/iothub_client.h) | Multi-threaded layer over iothub\_ll\_client (automatically performs invocation of the IoTHubClient\_LL\_DoWork function and internal callback handling) |
| Azure IoT C Low Level SDK | [iothub\_client\_ll](https://github.com/Azure/azure-iot-sdk-c/blob/main/iothub_client/inc/iothub_client_ll.h) | Main surface of the Azure IoT device client API (single-threaded) |
| Protocol Transport | [iothubtransport\*](https://github.com/Azure/azure-iot-sdk-c/tree/main/iothub_client/inc) | Provides an interface between the specific protocol API (e.g., [uamqp](https://github.com/Azure/azure-uamqp-c), [umqtt](https://github.com/Azure/azure-umqtt-c)) and the upper client SDK. It is responsible for part of the business logic, the message queuing and timeout control, options handling. |
| Protocol API | [uamqp](https://github.com/Azure/azure-uamqp-c), [umqtt](https://github.com/Azure/azure-umqtt-c) or native HTTP API | Implements the specific application protocol (either AMQP, MQTT or HTTP, respectivelly) |
| TLS | [tlsio\_\*](https://github.com/Azure/azure-c-shared-utility/tree/master/adapters) | Provides a wrapper over the specific TLS API (Schannel, openssl, wolfssl, mbedtls), using the [xio](https://github.com/Azure/azure-c-shared-utility/blob/master/inc/azure_c_shared_utility/xio.h) interface that the device client SDK uses |
| Socket | [socketio\_\*](https://github.com/Azure/azure-c-shared-utility/tree/master/adapters) | Provides a wrapper over the specific socket API ([win32, berkeley, mbed](https://github.com/Azure/azure-c-shared-utility/tree/master/adapters)), using the [xio](https://github.com/Azure/azure-c-shared-utility/blob/master/inc/azure_c_shared_utility/xio.h) interface that the device client SDK uses |

Просмотреть файл

@ -0,0 +1,16 @@
# master to main branch rename instructions
The Azure IoT C SDK initially used a branch named `master` as its primary branch. This was renamed to `main` on December 1, 2021.
**If you cloned this repo after December 1, 2021, you can ignore the rest of this document.**
* Git clones after the default rename will use `main` and do the right thing.
**If you cloned this repo before December 1, 2021, You need to make changes so that your local copy of the repo will use `main` instead of `master`.**
* You can just run a new `git clone` and delete your previous clone. The new clone will use `main` as its primary branch.
* Or if you want to keep your existing copy of the repo, then you will need to run these commands
```script
git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a
```

Просмотреть файл

@ -50,7 +50,7 @@ This document describes how to setup vcpkg to build applications using Microsoft
- Hit F5 to build and run.
- More information on building the C SDK and samples can be found [here](https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/devbox_setup.md).
- More information on building the C SDK and samples can be found [here](https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/devbox_setup.md).
## Setup C SDK vcpkg for Linux or Mac development environment
@ -75,4 +75,4 @@ This document describes how to setup vcpkg to build applications using Microsoft
./iothub_ll_telemetry_sample
```
- More information on building the C SDK and samples can be found [here](https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/devbox_setup.md).
- More information on building the C SDK and samples can be found [here](https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/devbox_setup.md).

Просмотреть файл

@ -3,7 +3,7 @@
## Commands
```bash
git checkout master
git checkout main
git pull
cd c-utility
@ -90,4 +90,4 @@ The following requires NodeJS and NPM.
Run:
`/node_modules/.bin/check_submodules . master`
`/node_modules/.bin/check_submodules . main`

Просмотреть файл

@ -29,7 +29,7 @@
/**
* @brief Handle corresponding to a convenience layer device client instance.
*
* @remarks See https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/threading_notes.md for more details about convenience layer versus lower layer (LL) threading models.
* @remarks See https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/threading_notes.md for more details about convenience layer versus lower layer (LL) threading models.
*/
typedef IOTHUB_CLIENT_CORE_HANDLE IOTHUB_DEVICE_CLIENT_HANDLE;
#define IOTHUB_DEVICE_CLIENT_INSTANCE_TYPE
@ -243,7 +243,7 @@ extern "C"
* @param optionName Name of the option.
* @param value The value.
*
* @remarks Documentation for configuration options is available at https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/Iothub_sdk_options.md.
* @remarks Documentation for configuration options is available at https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/Iothub_sdk_options.md.
*
* @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
*/

Просмотреть файл

@ -20,7 +20,7 @@
* often not desired.
*
* @warning IoTHubDeviceClient_LL_* functions are NOT thread safe. See
* https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/threading_notes.md for more details.
* https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/threading_notes.md for more details.
*
*/
@ -44,7 +44,7 @@ extern "C"
/**
* @brief Handle corresponding to a lower layer (LL) device client instance.
*
* @warning The API functions that use this handle are not thread safe. See https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/threading_notes.md for more details.
* @warning The API functions that use this handle are not thread safe. See https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/threading_notes.md for more details.
*/
typedef struct IOTHUB_CLIENT_CORE_LL_HANDLE_DATA_TAG* IOTHUB_DEVICE_CLIENT_LL_HANDLE;
@ -264,7 +264,7 @@ typedef struct IOTHUB_CLIENT_CORE_LL_HANDLE_DATA_TAG* IOTHUB_DEVICE_CLIENT_LL_HA
* @param optionName Name of the option.
* @param value The value.
*
* @remarks Documentation for configuration options is available at https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/Iothub_sdk_options.md.
* @remarks Documentation for configuration options is available at https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/Iothub_sdk_options.md.
*
* @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
*/

Просмотреть файл

@ -28,7 +28,7 @@
/**
* @brief Handle corresponding to a convenience layer module client instance.
*
* @remarks See https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/threading_notes.md for more details about convenience layer versus lower layer (LL) threading models.
* @remarks See https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/threading_notes.md for more details about convenience layer versus lower layer (LL) threading models.
*/
typedef IOTHUB_CLIENT_CORE_HANDLE IOTHUB_MODULE_CLIENT_HANDLE;
#define IOTHUB_MODULE_CLIENT_INSTANCE_TYPE
@ -195,7 +195,7 @@ extern "C"
* @param value The value.
*
*
* @remarks Documentation for configuration options is available at https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/Iothub_sdk_options.md.
* @remarks Documentation for configuration options is available at https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/Iothub_sdk_options.md.
*
* @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
*/

Просмотреть файл

@ -20,7 +20,7 @@
* often not desired.
*
* @warning IoTHubModuleClient_LL_* functions are NOT thread safe. See
* https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/threading_notes.md for more details.
* https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/threading_notes.md for more details.
*
*/
@ -42,7 +42,7 @@ extern "C"
/**
* @brief Handle corresponding to a lower layer (LL) module client instance.
*
* @warning The API functions that use this handle are not thread safe. See https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/threading_notes.md for more details.
* @warning The API functions that use this handle are not thread safe. See https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/threading_notes.md for more details.
*/
typedef struct IOTHUB_MODULE_CLIENT_LL_HANDLE_DATA_TAG* IOTHUB_MODULE_CLIENT_LL_HANDLE;
@ -224,7 +224,7 @@ extern "C"
* @param optionName Name of the option.
* @param value The value.
*
* @remarks Documentation for configuration options is available at https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/Iothub_sdk_options.md.
* @remarks Documentation for configuration options is available at https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/Iothub_sdk_options.md.
*
* @return IOTHUB_CLIENT_OK upon success or an error code upon failure.
*/

Просмотреть файл

@ -165,7 +165,7 @@
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
<PropertyGroup>
<ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
<ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/main/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
</PropertyGroup>
<Error Condition="!Exists('$(VcpkgRoot)\installed\$(VcpkgTriplet)\include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)\installed\$(VcpkgTriplet)\include\azureiot\iothub.h'))" />
</Target>

Просмотреть файл

@ -163,7 +163,7 @@
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
<PropertyGroup>
<ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
<ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/main/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
</PropertyGroup>
<Error Condition="!Exists('$(VcpkgRoot)\installed\$(VcpkgTriplet)\include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)\installed\$(VcpkgTriplet)\include\azureiot\iothub.h'))" />
</Target>

Просмотреть файл

@ -185,7 +185,7 @@
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
<PropertyGroup>
<ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
<ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/main/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
</PropertyGroup>
<Error Condition="!Exists('$(VcpkgRoot)\installed\$(VcpkgTriplet)\include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)\installed\$(VcpkgTriplet)\include\azureiot\iothub.h'))" />
</Target>

Просмотреть файл

@ -185,7 +185,7 @@
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<Target Name="EnsureVcPkgPackageBuildImports" BeforeTargets="PrepareForBuild">
<PropertyGroup>
<ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
<ErrorText>This project references Vcpkg package(s) that are missing on this computer. For more information, see https://github.com/Azure/azure-iot-sdk-c/tree/main/doc/setting_up_vcpkg.md. The missing file is {0}.</ErrorText>
</PropertyGroup>
<Error Condition="!Exists('$(VcpkgRoot)\installed\$(VcpkgTriplet)\include\azureiot\iothub.h')" Text="$([System.String]::Format('$(ErrorText)', '$(VcpkgRoot)\installed\$(VcpkgTriplet)\include\azureiot\iothub.h'))" />
</Target>

Просмотреть файл

@ -17,7 +17,7 @@ default_repo = "(Azure/azure-iot-sdk-BLAH)"
parser = argparse.ArgumentParser(description="build docker image for testing")
parser.add_argument("--repo", help="repo with source", type=str, default=default_repo)
parser.add_argument(
"--commit", help="commit to apply (ref or branch)", type=str, default="master"
"--commit", help="commit to apply (ref or branch)", type=str, default="main"
)
args = parser.parse_args()

Просмотреть файл

@ -95,8 +95,8 @@ def get_docker_tags_from_commit(repo, commit):
every time. This would negate the effect of docker image caching and make builds very slow.
To make builds faster, we tag images to give docker a starting point for it's build. In effect,
if we build the C sdk from the master branch, we tag it as such. Then, next time we need to
build the C sdk from the master branch, we can load the last build and let docker use it
if we build the C sdk from the main branch, we tag it as such. Then, next time we need to
build the C sdk from the main branch, we can load the last build and let docker use it
as a starting point.
Every image we make has (at least) 4 tags. For example, an image might have:

Просмотреть файл

@ -5,7 +5,7 @@ schedules:
displayName: Daily midnight build
branches:
include:
- master
- main
variables:
ClientLibrary.Repo: $(Build.Repository.Uri)

Просмотреть файл

@ -14,9 +14,9 @@ Here is where we answer question pertaining to the IoT Provisioning Client. Ple
- **Development**: The SDK ships with a development HSM implementation that generates a test x509 certificate with a pre-generated key. This enables the developer to quickly get up and running to test their solutions.
- **Production**: For production situations, the developer should create a custom HSM library to retrieve the certificate from a hardware backed HSM or a software solution (for more information on this please see [using custom hsm](https://github.com/Azure/azure-iot-sdk-c/blob/master/provisioning_client/devdoc/using_custom_hsm.md))
- **Production**: For production situations, the developer should create a custom HSM library to retrieve the certificate from a hardware backed HSM or a software solution (for more information on this please see [using custom hsm](https://github.com/Azure/azure-iot-sdk-c/blob/main/provisioning_client/devdoc/using_custom_hsm.md))
For more information on switching between development and production scenarios, refer to [using provisioning client](https://github.com/Azure/azure-iot-sdk-c/blob/master/provisioning_client/devdoc/using_provisioning_client.md)
For more information on switching between development and production scenarios, refer to [using provisioning client](https://github.com/Azure/azure-iot-sdk-c/blob/main/provisioning_client/devdoc/using_provisioning_client.md)
For more reading on certificates information, please see [security concept document](https://docs.microsoft.com/azure/iot-dps/concepts-security#x509-certificates)
@ -24,7 +24,7 @@ Here is where we answer question pertaining to the IoT Provisioning Client. Ple
- One of the benefits of having an HSM is that it can ensure that the private key will never leave the hardware device, but to get this functionality it will require a little more code.
- You will need to write a custom HSM to be able to extract the certificate and return the alias private key to the SDK (more on this in a moment) see the [custom hsm sample](https://github.com/Azure/azure-iot-sdk-c/blob/master/provisioning_client/samples/custom_hsm_example/custom_hsm_example.c) in the SDK.
- You will need to write a custom HSM to be able to extract the certificate and return the alias private key to the SDK (more on this in a moment) see the [custom hsm sample](https://github.com/Azure/azure-iot-sdk-c/blob/main/provisioning_client/samples/custom_hsm_example/custom_hsm_example.c) in the SDK.
- You will need to have a TLS engine that can communicate with the target hardware that is connected to the device. You can review your hardware device documentation for information on obtaining a hardware TLS engine.

Просмотреть файл

@ -10,9 +10,9 @@ Outlined below are the steps to customize a device HSM for the IoThub SDK Client
## Developing a Custom Repo
- You must develop a library to provide access to the target HSM. This library will need to be a static library for which the IoThub SDK to link against. To see an example of how a custom HSM works see the [custom_hsm_example](https://github.com/Azure/azure-iot-sdk-c/tree/master/provisioning_client/samples/custom_hsm_example) project in the sdk.
- You must develop a library to provide access to the target HSM. This library will need to be a static library for which the IoThub SDK to link against. To see an example of how a custom HSM works see the [custom_hsm_example](https://github.com/Azure/azure-iot-sdk-c/tree/main/provisioning_client/samples/custom_hsm_example) project in the sdk.
- The library must implement functions defined in the [hsm_client_data file](https://github.com/Azure/azure-iot-sdk-c/tree/master/provisioning_client/adapters/hsm_client_data.h)
- The library must implement functions defined in the [hsm_client_data file](https://github.com/Azure/azure-iot-sdk-c/tree/main/provisioning_client/adapters/hsm_client_data.h)
- To expediate the development process there is a custom_hsm_example.c file that gives an example of the interface that will need to be implemented for the custom HSM.

Просмотреть файл

@ -10,7 +10,7 @@ To use the Provisioning Device client code to connect to windows or linux HSM re
cmake -Duse_prov_client:BOOL=ON ..
```
For Development scenarios, the provisioning client relies on generated test x509 certificates with a pre-generated key within [hsm_client_riot.c](https://github.com/Azure/azure-iot-sdk-c/blob/master/provisioning_client/adapters/hsm_client_riot.c)
For Development scenarios, the provisioning client relies on generated test x509 certificates with a pre-generated key within [hsm_client_riot.c](https://github.com/Azure/azure-iot-sdk-c/blob/main/provisioning_client/adapters/hsm_client_riot.c)
For Production scenarios, you need to add the USE_CUSTOM_HSM cmake flag with the full path to your custom hsm lib (see custom hsm example below).

Просмотреть файл

@ -20,4 +20,4 @@
### Running Samples
You don't need any special hardware to test the samples. After you create your [Device Provisioning hub](https://docs.microsoft.com/azure/iot-dps/quick-setup-auto-provision), you can just follow the [provisioning SDK documentation](https://github.com/Azure/azure-iot-sdk-c/blob/master/provisioning_client/devdoc/using_provisioning_client.md).
You don't need any special hardware to test the samples. After you create your [Device Provisioning hub](https://docs.microsoft.com/azure/iot-dps/quick-setup-auto-provision), you can just follow the [provisioning SDK documentation](https://github.com/Azure/azure-iot-sdk-c/blob/main/provisioning_client/devdoc/using_provisioning_client.md).

Просмотреть файл

@ -35,7 +35,7 @@ This is a quick tutorial with the steps to create and delete Individual Enrollme
[root-link]: https://github.com/Azure/azure-iot-sdk-c
[source-code-link]: ../../src
[tpm-simulator-link]: https://github.com/Azure/azure-iot-sdk-java/tree/master/provisioning/provisioning-tools/tpm-simulator
[tpm-simulator-link]: https://github.com/Azure/azure-iot-sdk-java/tree/main/provisioning/provisioning-tools/tpm-simulator
[dice-link]: https://azure.microsoft.com/blog/azure-iot-supports-new-security-hardware-to-strengthen-iot-security/
[devbox-setup-link]: ../../../doc/devbox_setup.md
[ca-cert-link]: ../../../tools/CACertificates

Просмотреть файл

@ -63,7 +63,7 @@ This is a quick tutorial with the steps to create, update, get, and delete an In
[root-link]: https://github.com/Azure/azure-iot-sdk-c
[source-code-link]: ../../src
[tpm-simulator-link]: https://github.com/Azure/azure-iot-sdk-java/tree/master/provisioning/provisioning-tools/tpm-simulator
[tpm-simulator-link]: https://github.com/Azure/azure-iot-sdk-java/tree/main/provisioning/provisioning-tools/tpm-simulator
[dice-link]: https://azure.microsoft.com/blog/azure-iot-supports-new-security-hardware-to-strengthen-iot-security/
[devbox-setup-link]: ../../../doc/devbox_setup.md
[ca-cert-link]: ../../../tools/CACertificates

Просмотреть файл

@ -74,7 +74,7 @@ The API reference documentation for the C SDKs can be found [here][c-api-referen
To find Azure IoT SDKs in other languages, please refer to the [guidance here][about-iot-sdks].
- [Azure IoT SDK for Embedded C](https://github.com/Azure/azure-sdk-for-c/tree/master/sdk/docs/iot) is an alternative for **constrained devices** which enables the BYO (bring your own) network approach: IoT developers have the freedom of choice to bring MQTT client, TLS and Socket of their choice to create a device solution.
- [Azure IoT SDK for Embedded C](https://github.com/Azure/azure-sdk-for-c/tree/main/sdk/docs/iot) is an alternative for **constrained devices** which enables the BYO (bring your own) network approach: IoT developers have the freedom of choice to bring MQTT client, TLS and Socket of their choice to create a device solution.
- [Azure IoT middleware for Azure RTOS](https://github.com/azure-rtos/netxduo/tree/master/addons/azure_iot) builds on top of the embedded SDK and tightly couples with the Azure RTOS family of networking and OS products. This gives you very performant and small applications for real-time, constrained devices.
- [Azure IoT middleware for FreeRTOS](https://github.com/Azure/azure-iot-middleware-freertos) builds on top of the embedded SDK and takes care of the MQTT stack while integrating with FreeRTOS. This maintains the focus on constrained devices and gives users a distilled Azure IoT feature set while allowing for flexibility with their networking stack.
@ -256,7 +256,7 @@ Below is a table showing the mapping of the LTS branches to the packages release
Below is a hypothetical example of versioning and tagging for the C SDK. `minor` versions are distinguished by color.
![Release Node Drawing](https://github.com/Azure/azure-iot-sdk-c/tree/master/doc/media/ReleaseNodeDrawing.jpg)
![Release Node Drawing](https://github.com/Azure/azure-iot-sdk-c/tree/main/doc/media/ReleaseNodeDrawing.jpg)
- The main branch is at version 1.8.2.
- February 23, 2020: A new feature is released on main. The version bumps to 1.9.0, is tagged `1.9.0`, and the release is tagged `2020-02-23`.

Просмотреть файл

@ -1,2 +1,2 @@
# Docker Build Samples
This directory contains sample Docker files to cross compile the Azure IoT SDK for Raspbian and MIPS32 OpenWRT targets. For more information see [here](https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/Docker_SDK_Cross_Compile.md).
This directory contains sample Docker files to cross compile the Azure IoT SDK for Raspbian and MIPS32 OpenWRT targets. For more information see [here](https://github.com/Azure/azure-iot-sdk-c/blob/main/doc/Docker_SDK_Cross_Compile.md).