Merge pull request #58 Release Version 1.0.1 from GoogleCloudPlatform/development

# Google Cloud IoT Core Device SDK for Embedded C version  1.0.1
#### April 8, 2019

- The TLS Board Support Package (BSP) reference implementation for mbedTLS has been updated to use deterministic ECDSA signatures.

- `iotc_get_state_string` may now be used to query error strings for application debugging. See `include/iotc_error.h` to enable this feature.

- Updated the gtest framework compilation standard to c++14.  This does not affect the IoT Device SDK library sources.

- Documentation:
  - Updates to the Device SDK [API](https://googlecloudplatform.github.io/iot-device-sdk-embedded-c/api/html/) and [BSP](https://googlecloudplatform.github.io/iot-device-sdk-embedded-c/bsp/html/) doxygen documentation.
  - [`README.md`](README.md) formatting updates.
  - [`CONTRIBUTING.md`](CONTRIBUTING.md) includes a new pull request processes and a link to the Google style guidelines.

- Networking BSP:
  - Added UDP and IPv6 support.
  - Removed the function `iotc_bsp_io_net_create_socket`. Sockets should now be created in BSP implementations of `iotc_bsp_iot_net_socket_connect`.
  - See `include/bsp/iotc_bsp_io_net.h` for more information about these changes.
  - Removed `src/bsp/platform/posix/iotc_bsp_hton.h` as it was no longer required.

- Time API:
  - The `iotc_time_t` typedef is now defined as an `int64_t`.
  - Added the function `iotc_bsp_time_getmonotonictime_milliseconds`.
  - See `include/bsp/iotc_time.h` for more information about these changes.

Author: DellaBitta

.DS_Store

@@ -2,3 +2,4 @@ bin/
 obj/
 test_coverage/
 .vscode/
+.DS_Store

.gitignore

@@ -92,6 +92,11 @@ before_script:
       git clone -b v3.15.3-stable https://github.com/wolfSSL/wolfssl $HOME/build/GoogleCloudPlatform/iot-device-sdk-embedded-c/third_party/tls/wolfssl;
     fi;"
   - "$BEFORE_SCRIPT_ACTION"
+  # Add an IPv6 config - see the corresponding Travis issue
+  # https://github.com/travis-ci/travis-ci/issues/8361
+  - if [ "${TRAVIS_OS_NAME}" == "linux" ]; then 
+      sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6';
+    fi
 script:
   - "set -e"
   - "cd $HOME/build/GoogleCloudPlatform/iot-device-sdk-embedded-c"

.travis.yml

@@ -25,11 +25,10 @@ accept your pull requests.
 1. The repo owner will respond to your issue promptly.
 1. If your proposed change is accepted, and you haven't already done so, sign a
    Contributor License Agreement (see details above).
-1. Fork the desired repo, develop and test your code changes.
+1. Fork the desired repo, develop and test your code changes based off of the `development` branch.
 1. Ensure that your code adheres to the existing style in the sample to which
-   you are contributing. Refer to the
-   [Google Cloud Platform Samples Style Guide](https://github.com/GoogleCloudPlatform/Template/wiki/style.html)
-   for the recommended coding standards for this organization.
+   you are contributing.
+1. If your code requires a tutorial, readme, or other documentation, please refer to the
+   [Google Cloud Platform Community Tutorial Style Guide](https://cloud.google.com/community/tutorials/styleguide) for the recommended coding standards for this organization.
 1. Ensure that your code has an appropriate set of unit tests which all pass.
-1. Submit a pull request.
-
+1. Submit a pull request against the `development` branch. The master branch is for official releases only.

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 # Copyright 2018-2019 Google LLC
 #
-# This is part of the Google Cloud IoT Device SDK for Embedded C,
-# it is licensed under the BSD 3-Clause license; you may not use this file
+# This is part of the Google Cloud IoT Device SDK for Embedded C.
+# It is licensed under the BSD 3-Clause license; you may not use this file
 # except in compliance with the License.
 #
 # You may obtain a copy of the License at:
@@ -33,7 +33,7 @@ MD ?= @
 IOTC_BSP_TLS ?= mbedtls
 
 # Cryptographic BSP implementation
-IOTC_BSP_CRYPTO ?= mbedtls
+IOTC_BSP_CRYPTO ?= $(IOTC_BSP_TLS)
 
 #detect if the build happen on Travis
 ifdef TRAVIS_OS_NAME

Makefile

@@ -7,35 +7,39 @@ The Device SDK supports concurrent Pub/Sub traffic on a non-blocking socket impl
 For more details, see the user guide in the `docs` directory.
 
 ## Source
-To get the source, clone from the master branch of the Google Cloud IoT Device SDK for Embedded C GitHub repository:
+To get the source, clone from the `master` branch of the [Google Cloud IoT
+Device SDK for Embedded C GitHub
+repository](https://github.com/GoogleCloudPlatform/iot-device-sdk-embedded-c.git):
 
-[https://github.com/googlecloudplatform/iot-device-sdk-embedded-c](https://github.com/googlecloudplatform/iot-device-sdk-embedded-c)
+```
+git clone https://github.com/GoogleCloudPlatform/iot-device-sdk-embedded-c.git
+```
 
 ### Directory structure
 
-- **bin**: Executables and libraries produced by a build.
-- **doc**: Documentation: Doxygen references, user guide, and porting guide.
-- **examples**: Example source with makefiles. After you build with `make`, this directory will also contain the example executables.
-- **include**: Header files of the Device SDK API. You must add this directory to the header include path when compiling your application against the source.
-- **include/bsp**: Header files of the Board Support Package (BSP). Functions declared here must be defined in a device-specific BSP implementation. When compiling your BSP source, make sure this directory is on the include path.
-- **make**: Build system configuration files.
-- **obj**: Object files generated during a build.
-- **res**: Resource files (for example, trusted root CA certificates.)
-- **src**: The source files of the Device SDK. A BSP implementation is provided for POSIX.
-- **third_party**: Third-party open-source components.
-- **tools**: Scripts used by the maintainers of the repository.
+- `bin`: Executables and libraries produced by a build.
+- [`doc`](doc): Documentation: Doxygen references, user guide, and porting guide.
+- [`examples`](examples): Example source with makefiles. After you build with `make`, this directory will also contain the example executables.
+- [`include`](include): Header files of the Device SDK API. You must add this directory to the header include path when compiling your application against the source.
+- [`include/bsp`](include/bsp): Header files of the Board Support Package (BSP). Functions declared here must be defined in a device-specific BSP implementation. When compiling your BSP source, make sure this directory is on the include path.
+- [`make`](make): Build system configuration files.
+- `obj`: Object files generated during a build.
+- [`res`](res): Resource files (for example, trusted root CA certificates.)
+- [`src`](src): The source files of the Device SDK. A BSP implementation is provided for POSIX.
+- [`third_party`](third_party): Third-party open-source components.
+- [`tools`](tools): Scripts used by the maintainers of the repository.
 
 ## Building
 
-The default build environment for the Device SDK is `make`. It invokes [GCC](https://www.gnu.org/software/gcc/) to produce a native build on a POSIX host. This serves as the default development environment on Ubuntu.
+The default build tool for the Device SDK is `make`. It invokes [GCC](https://www.gnu.org/software/gcc/) to produce a native build on a POSIX host. This serves as the default development environment on Ubuntu.
 
 Run the following command to build the Device SDK:
 
 ```
 make
 ```
 
-The source can be cross-compiled to other target platforms via custom toolchains and the makefile, or with a specific device SDK’s IDE. For more information, see the porting guide in `doc/porting_guide.md`.
+The source can be cross-compiled to other target platforms via custom toolchains and the makefile, or with a specific device SDK’s IDE. For more information, see [the porting guide](doc/porting_guide.md).
 
 ### Building a TLS static library
 
@@ -50,9 +54,9 @@ make clean
 make IOTC_BSP_TLS=wolfssl
 ```
 
-The value of IOTC_BSP_TLS determines which script is run.
-- mbedTLS: `res/tls/build_mbedtls.sh`
-- wolfSSL: `res/tls/build_wolfssl.sh`
+The value of `IOTC_BSP_TLS` determines which script is run.
+- mbedTLS: [`res/tls/build_mbedtls.sh`](res/tls/build_mbedtls.sh)
+- wolfSSL: [`res/tls/build_wolfssl.sh`](res/tls/build_wolfssl.sh)
 
 The mbedTLS build script includes a git clone and branch checkout of the mbedTLS source (upon confirmation of the license agreement). However, the wolfSSL build script requires you to clone the repository yourself. When you run `make IOTC_BSP_TLS=wolfSSL`, instructions are provided for cloning the repository.
 
@@ -78,7 +82,7 @@ Before building the examples, build both the Device SDK static library and a TLS
 1. Create a project, registry and device in Cloud IoT Core.
 2. Create [Cloud IoT Core device credentials](https://cloud.google.com/iot/docs/how-tos/credentials/keys).
 3. Follow the steps in the examples README.md files to provision the device credentials and build the client applications.
-4. Run `make` in the examples home folders. The `make` process automatically downloads the Google Root CA PEM file to the example directories. The file enables TLS when communicating with Cloud IoT Core.
+4. Run `make` in the [`examples`](examples) folder. The `make` process automatically downloads the Google Root CA PEM file to the example directories. The file enables TLS when communicating with Cloud IoT Core.
 
 To securely connect to Cloud IoT Core, a root CA `.pem` file must be in the current working directory of the example executables. By default, the file is in `res/trusted_RootCA_certs/roots.pem` and contains two certificates that validate Cloud IoT Core credentials. The `make` process automatically moves this file from `res/trusted_RootCA_certs/roots.pem` to the correct location.
 
@@ -93,7 +97,7 @@ Follow the steps below to perform the cross-compilation process.
 - Build a TLS BSP implementation to invoke the TLS SDK for your platform. Store these in a new directory `src/bsp/tls/TARGET_TLS_SOLUTION`.
 - Build a Cryptography BSP implementation to handle key signatures of JWTs on your target platform in the directory `src/bsp/crypto/TARGET_CRYPTO_SOLUCTION`.
 
-For more details on the cross-compilation process, see the porting guide in `doc/porting_guide.md`.
+For more details on the cross-compilation process, see [the porting guide](doc/porting_guide.md).
 
 ## Security
 
@@ -109,27 +113,28 @@ The Device SDK supports other TLS libraries through the BSP TLS API. For informa
 
 Branch      | Build status
 ------------|-------------
-master      | ![travis-private-repo-icon-master]
-
-[travis-private-repo-icon-master]: https://travis-ci.com/GoogleCloudPlatform/iot-device-sdk-embedded-c.svg?token=tzWdJymp9duuAGWpamkM&branch=master
+master      | [![Build Status][travis-badge]][travis-url]
 
+[travis-badge]: https://travis-ci.com/GoogleCloudPlatform/iot-device-sdk-embedded-c.svg?branch=master
+[travis-url]: https://travis-ci.com/GoogleCloudPlatform/iot-device-sdk-embedded-c
 
 ## Contributing
 
-For information about contributing to this repository, see `CONTRIBUTING.MD`.
+For information about contributing to this repository, see
+[`CONTRIBUTING.md`](CONTRIBUTING.md).
 
 ## Learn more
 
-Review the following documentation.
+Review the following documentation:
 
-- [doc/user_guide.md](https://github.com/GoogleCloudPlatform/iot-device-sdk-embedded-c/blob/master/doc/user_guide.md): User guide that covers Device SDK features and usage.
-- [doc/porting_guide.md](https://github.com/GoogleCloudPlatform/iot-device-sdk-embedded-c/blob/master/doc/porting_guide.md): Porting guide that provides information about porting the Device SDK to target devices.
-- Device SDK [API](https://googlecloudplatform.github.io/iot-device-sdk-embedded-c/api/html/index.html) and [BSP](https://googlecloudplatform.github.io/iot-device-sdk-embedded-c/bsp/html/index.html) references.
+- [`doc/user_guide.md`](doc/user_guide.md): User guide that covers Device SDK features and usage.
+- [`doc/porting_guide.md`](doc/porting_guide.md): Porting guide that provides information about porting the Device SDK to target devices.
+- Device SDK [API](https://googlecloudplatform.github.io/iot-device-sdk-embedded-c/api/html/) and [BSP](https://googlecloudplatform.github.io/iot-device-sdk-embedded-c/bsp/html/) references.
 
 ## License
 
 Copyright 2018-2019 Google LLC
 
 Licensed under the BSD 3-Clause license.
 
-For more information, see `LICENSE.md`.
+For more information, see [`LICENSE.md`](LICENSE.md).

README.md

@@ -1,3 +1,28 @@
+# Google Cloud IoT Core Device SDK for Embedded C version  1.0.1
+#### April 8, 2019
+
+- The TLS Board Support Package (BSP) reference implementation for mbedTLS has been updated to use deterministic ECDSA signatures.
+
+- `iotc_get_state_string` may now be used to query error strings for application debugging. See `include/iotc_error.h` to enable this feature.
+
+- Updated the gtest framework compilation standard to c++14.  This does not affect the IoT Device SDK library sources.
+
+- Documentation:
+  - Updates to the Device SDK [API](https://googlecloudplatform.github.io/iot-device-sdk-embedded-c/api/html/) and [BSP](https://googlecloudplatform.github.io/iot-device-sdk-embedded-c/bsp/html/) doxygen documentation.
+  - [`README.md`](README.md) formatting updates.
+  - [`CONTRIBUTING.md`](CONTRIBUTING.md) includes a new pull request processes and a link to the Google style guidelines.
+
+- Networking BSP:
+  - Added UDP and IPv6 support.
+  - Removed the function `iotc_bsp_io_net_create_socket`. Sockets should now be created in BSP implementations of `iotc_bsp_iot_net_socket_connect`.
+  - See `include/bsp/iotc_bsp_io_net.h` for more information about these changes.
+  - Removed `src/bsp/platform/posix/iotc_bsp_hton.h` as it was no longer required.
+
+- Time API:
+  - The `iotc_time_t` typedef is now defined as an `int64_t`.
+  - Added the function `iotc_bsp_time_getmonotonictime_milliseconds`.
+  - See `include/bsp/iotc_time.h` for more information about these changes.
+
 # Google Cloud IoT Core Device SDK for Embedded C version  1.0
 #### February 22, 2019