Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.19.1 release prep #405

Merged
merged 2 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

cmake_minimum_required(VERSION 3.16)

project(wolfMQTT VERSION 1.19.0 LANGUAGES C)
project(wolfMQTT VERSION 1.19.1 LANGUAGES C)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/functions.cmake)
Expand Down
9 changes: 8 additions & 1 deletion ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
## Release Notes

### v1.19.1 (11/06/2024)
Release 1.19.1 has been developed according to wolfSSL's development and QA process (see link below) and successfully passed the quality criteria.
https://www.wolfssl.com/about/wolfssl-software-development-process-quality-assurance

* wolfssl 5.7.2 time_helper type adjustments for Espressif example by @gojimmypi in #404
* Fix Doxygen issues by @embhorn in #403

### v1.19.0 (3/22/2024)
Release 1.19.0 has been developed according to wolfSSL's development and QA process (see link below) and successfully passed the quality criteria.
https://www.wolfssl.com/about/wolfssl-software-development-process-quality-assurance
Expand Down Expand Up @@ -314,7 +321,7 @@ https://www.wolfssl.com/about/wolfssl-software-development-process-quality-assur
* Refactor to use new `MQTT_CODE_STDIN_WAKE` return code for examples using STDIN to send publish messages (normal blocking mode only).

### v0.12 (12/20/16)
* Fixes issue with read timeout in non-blocking mode with TLS enabled being teated as socket error.
* Fixes issue with read timeout in non-blocking mode with TLS enabled being treated as socket error.
* Fixed issue with “msg->stat” not getting reset on failure or timeout.
* Fix to not link libwolfssl with ./configure --disable-tls.
* Added AWS IoT Example and test script.
Expand Down
2 changes: 1 addition & 1 deletion IDE/ARDUINO/wolfmqtt_client/wolfmqtt_client.ino
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ static int mqttclient_message_cb(MqttClient *client, MqttMessage *msg,
byte buf[PRINT_BUFFER_SIZE + 1];
word32 len;

(void)client; /* Supress un-used argument */
(void)client; /* Suppress un-used argument */

if (msg_new) {
/* Determine min size to dump */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ echo NOTICE: This used the experimental sparse checkout.
echo See https://git-scm.com/docs/git-sparse-checkout/2.37.0
echo and https://github.blog/2020-01-17-bring-your-monorepo-down-to-size-with-sparse-checkout/
echo ""
echo intialize...
echo initialize...
git init

echo remote origin https://github.com/wolfSSL/wolfMQTT.git
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -310,31 +310,31 @@
/***** END CONFIG_IDF_TARGET_ESP32C6 *****/

#elif defined(CONFIG_IDF_TARGET_ESP32H2)
/* wolfSSL Hardware Acceleration not yet implemented */
/* wolfSSL hardware acceleration not yet implemented */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
#define NO_WOLFSSL_ESP32_CRYPT_RSA_PRI
/***** END CONFIG_IDF_TARGET_ESP32H2 *****/

#elif defined(CONFIG_IDF_TARGET_ESP8266)
/* There's no hardware accleration on the ESP8266 */
/* There's no hardware acceleration on the ESP8266 */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
#define NO_WOLFSSL_ESP32_CRYPT_RSA_PRI
/***** END CONFIG_IDF_TARGET_ESP266 *****/

#elif defined(CONFIG_IDF_TARGET_ESP8684)
/* There's no Hardware Acceleration available on ESP8684 */
/* There's no hardware acceleration available on ESP8684 */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
#define NO_WOLFSSL_ESP32_CRYPT_RSA_PRI
/***** END CONFIG_IDF_TARGET_ESP8684 *****/

#else
/* Anything else encountered, disable HW accleration */
/* Anything else encountered, disable HW acceleration */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
Expand Down Expand Up @@ -362,7 +362,7 @@

/* #define HASH_SIZE_LIMIT */ /* for test.c */

/* #define NO_HW_MATH_TEST */ /* Optionall turn off HW math checks */
/* #define NO_HW_MATH_TEST */ /* Optionally turn off HW math checks */

/* Optionally include alternate HW test library: alt_hw_test.h */
/* When enabling, the ./components/wolfssl/CMakeLists.txt file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ esp_err_t set_time_from_string(const char* time_buffer)


if (ret == 8) {
/* we found a match for all componets */
/* we found a match for all components */

const char *months[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
"Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
Expand Down Expand Up @@ -203,7 +203,7 @@ esp_err_t set_time_from_string(const char* time_buffer)
ESP_LOGI(TAG, "Time updated to %s", time_buffer);
}
else {
ESP_LOGE(TAG, "Failed to set system time with strig: %s",
ESP_LOGE(TAG, "Failed to set system time with string: %s",
time_buffer);
}
}
Expand Down Expand Up @@ -250,7 +250,7 @@ esp_err_t set_time(void)
esp_show_current_datetime();

#ifdef LIBWOLFSSL_VERSION_GIT_HASH_DATE
/* initialy set a default approximate time from recent git commit */
/* Initially set a default approximate time from recent git commit */
ESP_LOGI(TAG, "Found git hash date, attempting to set system date.");
set_time_from_string(LIBWOLFSSL_VERSION_GIT_HASH_DATE);
esp_show_current_datetime();
Expand Down Expand Up @@ -349,7 +349,7 @@ esp_err_t set_time_wait_for_ntp(void)
#endif

if (ret == ESP_OK) {
ESP_LOGI(TAG, "Successfuly set time via NTP servers.");
ESP_LOGI(TAG, "Successfully set time via NTP servers.");
}
else {
ESP_LOGW(TAG, "Warning: Failed to set time with NTP: "
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ int wifi_init_sta(void)
.ssid = EXAMPLE_ESP_WIFI_SSID,
.password = EXAMPLE_ESP_WIFI_PASS,
/* Authmode threshold resets to WPA2 as default if password matches
* WPA2 standards (pasword len => 8). If you want to connect the
* WPA2 standards (password len => 8). If you want to connect the
* device to deprecated WEP/WPA networks, Please set the threshold
* value WIFI_AUTH_WEP/WIFI_AUTH_WPA_PSK and set the password with
* length and format matching to WIFI_AUTH_WEP/WIFI_AUTH_WPA_PSK
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -310,31 +310,31 @@
/***** END CONFIG_IDF_TARGET_ESP32C6 *****/

#elif defined(CONFIG_IDF_TARGET_ESP32H2)
/* wolfSSL Hardware Acceleration not yet implemented */
/* wolfSSL hardware acceleration not yet implemented */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
#define NO_WOLFSSL_ESP32_CRYPT_RSA_PRI
/***** END CONFIG_IDF_TARGET_ESP32H2 *****/

#elif defined(CONFIG_IDF_TARGET_ESP8266)
/* There's no hardware accleration on the ESP8266 */
/* There's no hardware acceleration on the ESP8266 */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
#define NO_WOLFSSL_ESP32_CRYPT_RSA_PRI
/***** END CONFIG_IDF_TARGET_ESP266 *****/

#elif defined(CONFIG_IDF_TARGET_ESP8684)
/* There's no Hardware Acceleration available on ESP8684 */
/* There's no hardware acceleration available on ESP8684 */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
#define NO_WOLFSSL_ESP32_CRYPT_RSA_PRI
/***** END CONFIG_IDF_TARGET_ESP8684 *****/

#else
/* Anything else encountered, disable HW accleration */
/* Anything else encountered, disable HW acceleration */
#define NO_ESP32_CRYPT
#define NO_WOLFSSL_ESP32_CRYPT_HASH
#define NO_WOLFSSL_ESP32_CRYPT_AES
Expand Down Expand Up @@ -362,7 +362,7 @@

/* #define HASH_SIZE_LIMIT */ /* for test.c */

/* #define NO_HW_MATH_TEST */ /* Optionall turn off HW math checks */
/* #define NO_HW_MATH_TEST */ /* Optionally turn off HW math checks */

/* Optionally include alternate HW test library: alt_hw_test.h */
/* When enabling, the ./components/wolfssl/CMakeLists.txt file
Expand Down
2 changes: 1 addition & 1 deletion IDE/STM32CUBE/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The wolfMQTT Cube Pack can be found [here](https://www.wolfssl.com/files/ide/I-C

4. In the `Software Packs` configuration category of the `.ioc` file, click on the wolfMQTT pack and enable the library by checking the box.

5. The Pack defaults to using custom IO provided by the user. Modify `IDE/STM32CUBE/userio_template.h` to supply the custom IO. If you'd like to use LwIP instead, configure the wolfMQTT IO settings in the `.ioc` to enable LwIP compatibilty. You'll also have to enable LwIP in the `Middleware` configuration category of the project. Make sure that `LWIP_DNS (DNS Module)` is enabled in the LwIP general settings.
5. The Pack defaults to using custom IO provided by the user. Modify `IDE/STM32CUBE/userio_template.h` to supply the custom IO. If you'd like to use LwIP instead, configure the wolfMQTT IO settings in the `.ioc` to enable LwIP compatibility. You'll also have to enable LwIP in the `Middleware` configuration category of the project. Make sure that `LWIP_DNS (DNS Module)` is enabled in the LwIP general settings.

6. Save your changes and select yes to the prompt asking about generating code.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ To simplify testing a stress build option has been added, `--enable-stress=[args
The Stress option enables multithreading and nonblocking, and adds defines for
`TEST_NONBLOCK`, `NUM_PUB_TASKS`, and `NUM_PUB_PER_TASK`.

Examples of useage:
Examples of usage:
- `--enable-stress`: stress with default options.
- `--enable-stress=t7,p8`: stress with 7 threads, and 8 publishes per thread.
- `--enable-stress=t7,p8 --enable-curl`: same as above, but with curl backend.
Expand Down
6 changes: 3 additions & 3 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# All right reserved.

AC_COPYRIGHT([Copyright (C) 2014-2024 wolfSSL Inc.])
AC_INIT([wolfmqtt],[1.19.0],[https://github.com/wolfssl/wolfMQTT/issues],[wolfmqtt],[http://www.wolfssl.com])
AC_INIT([wolfmqtt],[1.19.1],[https://github.com/wolfssl/wolfMQTT/issues],[wolfmqtt],[http://www.wolfssl.com])

AC_PREREQ([2.63])
AC_CONFIG_AUX_DIR([build-aux])
Expand All @@ -24,7 +24,7 @@ AC_ARG_PROGRAM
AC_CONFIG_MACRO_DIR([m4])
AC_CONFIG_HEADERS([src/config.h])

WOLFMQTT_LIBRARY_VERSION=17:1:0
WOLFMQTT_LIBRARY_VERSION=17:2:0
# | | |
# +------+ | +---+
# | | |
Expand Down Expand Up @@ -456,7 +456,7 @@ for option in $OPTION_FLAGS; do
continue
fi

# allow user to igonore system options
# allow user to ignore system options
ignoresys=no
if [[[ $noequalsign == _* ]]] ;
then
Expand Down
2 changes: 1 addition & 1 deletion examples/azure/azureiothub.c
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ static int SasTokenCreate(char* sasToken, int sasTokenLen)
/* URL encode uri (device name) */
url_encode(mRfc3986, (byte*)AZURE_DEVICE_NAME, deviceName);

/* Build signature sting "uri \n expiration" */
/* Build signature string "uri \n expiration" */
XSNPRINTF(sigData, sizeof(sigData), AZURE_SIG_FMT, deviceName, lTime);

/* HMAC-SHA256 Hash sigData using decoded key */
Expand Down
2 changes: 1 addition & 1 deletion examples/mqttnet.c
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ static int NetRead(void *context, byte* buf, int buf_len,
#elif defined(ENABLE_MQTT_CURL)

/* How many times to retry after a timeout. */
#define MQTT_CURL_NUM_RETRY (2)
#define MQTT_CURL_NUM_RETRY (3)

#if defined(WOLFMQTT_NONBLOCK) && defined(WOLFMQTT_TEST_NONBLOCK)
/* Tells the calling function to either return early with
Expand Down
2 changes: 1 addition & 1 deletion pre-commit.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ git stash pop -q
# restore current config
echo "\nRestoring current config\n"
mv tmp.status config.status
# don't show output incase error from above
# don't show output in case error from above
./config.status >/dev/null 2>&1
#mv tmp.options.h wolfmqtt/options.h
make clean >/dev/null 2>&1
Expand Down
2 changes: 1 addition & 1 deletion scripts/client.test
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ broker_pid=$no_pid
source scripts/test_common.sh

# Use minimum of 2 seconds
# The check timout will sometimes incorrectly trigger if 1 second is used
# The check timeout will sometimes incorrectly trigger if 1 second is used
def_args="-T -C 2000"

# Check for mosquitto
Expand Down
2 changes: 1 addition & 1 deletion scripts/multithread.test
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ broker_pid=$no_pid
source scripts/test_common.sh

# Use minimum of 2 seconds
# The check timout will sometimes incorrectly trigger if 1 second is used
# The check timeout will sometimes incorrectly trigger if 1 second is used
def_args="-T -C 2000"

# Check for mosquitto
Expand Down
2 changes: 1 addition & 1 deletion scripts/nbclient.test
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ broker_pid=$no_pid
source scripts/test_common.sh

# Use minimum of 2 seconds
# The check timout will sometimes incorrectly trigger if 1 second is used
# The check timeout will sometimes incorrectly trigger if 1 second is used
def_args="-T -C 2000"

# Check for mosquitto
Expand Down
4 changes: 2 additions & 2 deletions wolfmqtt/version.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
extern "C" {
#endif

#define LIBWOLFMQTT_VERSION_STRING "1.19.0"
#define LIBWOLFMQTT_VERSION_HEX 0x01019000
#define LIBWOLFMQTT_VERSION_STRING "1.19.1"
#define LIBWOLFMQTT_VERSION_HEX 0x01019001

#ifdef __cplusplus
}
Expand Down
Loading