Changelog for PubNub FreeRTOS SDK

Added	Add custom message type support for the following APIs: publish, signal, share file, subscribe and history. Add `pubnub_set_ipv4_connectivity` and `pubnub_set_ipv6_connectivity` to `pubnub_coreapi` to switch preferred connectivity protocol.
Fixed	Make sure that in case of connection close (including because of error) proxy context object will be reset.

Fixed	Fix CMakeLists to build correctly on Windows.
Modified	Prepare CMakeLists to support builds for Arm64 architecture.

Added

Add core Event Engine implementation with the required set of types and methods.
Add Subscribe Event Engine built atop of the core Event Engine implementation.
Add the following entities: channel, channel group, uuid and channel metadata objects.
Add objects to manage subscriptions and provides interface for update listeners.
Add new event listeners, which make it possible to add listeners to a specific entity or group of entities (though subscription and subscription set).
Added ability to configure automated retry policies for failed requests.

Fixed

Removed additional null byte character.

Added

Add delete message API support to the advanced history module.

Fixed

Add the missing ttl parameter to the pubnub_publish_options for extended publish configuration.

Fixed

Fixed custom bool type for CMake builds.

Fixed

Fix query values for boolean flags for history endpoint (include meta, include uuid, include message type and reverse).

Added	Added `filter` and `sort` parameters to be closer to the other SDKs with object API. Configurable `bool` type.
Fixed	Missing features needed for grant token API in CMakeLIsts.txt.

Fixed

Added missing subscribe v2 crypto implementation.

Fixed

Fixed cmake build for not ESP32 builds.

Added	Provided support for ESP32 devices via ESP-IDF framework. Provided support for MBedTLS library used within esp32 platform.
Modified	Replace `strncpy` with `strcpy` in blocks where it is safer to be used.

Added	Added possibility to use strings in actions API.
Modified	`pubnub_action_type` enum has been deprecated.

Fixed	Fix too small amount of memory allocated for aes cbc algorithm in some cases.
Modified	Add possibility to include address sanitizer in build via CMake.

Added

Provide CMake support.
Adjust build.cs unreal engine file for CMake build.

Added

Add #if switches into files that are related to PubNub features to not rely only on makefiles. [Be careful when update. It's not a breaking change at all but might fail build for custom makefiles!].

Fixed

Handle unencrypted message while getting messages with crypto.

Added

Provided PUBNUB_EXTERN macro to extern C functions.

Fixed

Fix pubnub_free() function on not initialised PubNub that can cause exceptions/undefined behaviours.

Fixed

Provide missing publish() function overload for QT wrapper that allows set publish related options.

Added	Add the `PUBNUB_QT_MOVE_TO_THREAD` flag as default to give users the opportunity to manage threads by themselves.
Fixed	Move `pubnub_qt` into QT main thread by default to be sure that timers will be run in it.

Added	Update the crypto module structure and add enhanced AES-CBC cryptor.
Fixed	Improved security of crypto implementation by increasing the cipher key entropy by a factor of two. Fixed missing return from failed `pbaes256_decrypt_alloc()` function.

Added

Provide module files to integrate SDK with Unreal Enigne.

Added	Add `publisher` field into `pubnub_v2_message`.
Fixed	Fixed `flags` and `region` values that always equaled `0`.

Fixed	Conditionally use of using newest openssl API Ipv4 parsing is needed for working with proxy. Include object file with that function for proxy builds.
Modified	Use newest openssl API.

Modified

Conditionally use sha256 when build is linked with OpenSSL 3+ version.

Added	Updated QT to version `6.*`.
Fixed	Fixed not building QT module. Align QT module with current SDK state.
Modified	Removed some states, classes and structs that aren't currently used.

Added	Added pubnub_set_state_ex to support heartbeat.
Fixed	Removed state param from subscribe request. Added state param to hearbeat request.

Fixed	Fixed hanging allocated memory after error in `parse_token` by cleaning the result memory on `cbor` error.
Modified	Implemented more tests for `pubnub_token_parse` function to increase confidence about that function. Refactored implementation of some tests' setups.

Fixed

Fixed compilation error for MSVC in pubnub_parse_token function.

Fixed

Fixed crashing parsing token for not valid values by logging an error and returning NULL.

Fixed

Fixed wrong pointer reallocation in string concatenation.
Fixed allocation counter that was not taking to the account recursed allocations.

Fixed	Improved accuracy of the base64 encoding size what fixes buffer underflow in encryption module. Fixed undefined behaviours in `pubnub_encrypt_decrypt_iv_sample.c` by including some additional checks and variable initialisations.
Modified	Made same base for encrypt functions what makes codes easier to understand and maintain.

Fixed

ERR_load_BIO_strings() is deprecated in OpenSSL 3.0. Low-level encoding primitives are also deprecated. EVP_EncodeBlock() is available in all currently supported OpenSSL releases.

Added

Add user_id configuration option that deprecates uuid ones.
BREAKING CHANGES: now user_id (old uuid) is a required property!.

Fixed

Fix memory leak in cpp parse_token method.
Fix buffer overflow in core pubnub_parse_token function for some cases.
Fix buffer overflow in core pubnub_encrypt function for randomized initial vector.

Fixed

Fix wrong parsing uuid in parse_token.
Fix case sensitive header check.

Added

Implemented Fetch History.

Fixed

Removed extra parenthesis in get_dns_ip function code.
Added uuid query param to history, set/get state, wherenow, channel-group operations.

Fixed

Handle state for subscribe and resubscribe.

Fixed

Support system name servers in async DNS client.
Fix multiple memory safety and leak issues.
Fix slash char encoding for pnsdk.

Added	Add token permissions revoke functionality.
Fixed	Remove body from `signature` calculation for requests with DELETE HTTP method.
Modified	Update `.pubnub.yml` file with access token revoke and secret key all access.

Fixed

Filter-expr query param typo.

Fixed

Encode = (equal) sign for filter expression.

Added	Implemented PAMv3 support.
Fixed	Handle subscribe error for empty channel-group.

Fixed

Error codes for missing subscribe timetoken.

Added

Added PAMv3 Grant Token support.

Added

BREAKING CHANGE - Added PUBNUB_RAND_INIT_VECTOR to support dynamic IV, default to true.

Fixed

Handling Access Denied server error in Pubnub Access Manager requests.

Added

Implemented Pubnub Access Manager Support.
Implemented Objects V2. Removed Objects V1.

Added

Added support for Universal Windows(UWP).

Fixed

Fix DNS servers rotation during transaction origin DNS resolution timeout.

Modified

Dynamically allocate memory for uuid in pubnub_set_uuid function.

Fixed

Properly handle DNS retries and stale HTTP Kept-Alive connections

Fixed

Fix assertion failure while retrying timed out DNS queries with multiple contexts

Modified

Add support for automatic sending of heartbeat messages with sync interface (POSIX and Windows)

Modified

Add support for automatic sending of heartbeat messages on Windows, callback.

Modified

Support automatic sending of heartbeat messages (only on POSIX, callback, for now).

Fixed

Fix Qt

Modified	Introduce Actions API Add 'include_meta' parameter to pubnub_history_ex()
Fixed	Fix stopwatch not working after 25 days

Fixed

Restore get/set connection timeout in C++ wrapper

Modified	Retry if DNS server does not respond. Number of retries is a compile-time parameter.
Fixed	In C++, fix transaction finishing before user starts to wait for it to finish.

Modified	Introduce Objects API
Fixed	Fix high history (extended/full) handling of 'reverse' and other boolean parameters

Modified	Introduce separate connection timer, to control/limit the duration of DNS resolving and connection establishment, which should be much shorter than full transaction timer, which has to be >5 min for subscribe
Fixed	Fix high CPU load in callback interface when no context, thus socket, is executing a transaction

Modified

Detect TCP/IP connect timeout in callback mode w/sockets - does not seem to work on Windows
Add set_proxy_none() to pubnub::context

Fixed

Proxy admin functions (set, get) were not protected by mutex/monitor, so caused a race condition
Setting new proxy might have been ignored until the resolved DNS addresses of the previous proxy expire.
If all resolved addresses on file expire, we would report transaction failure instead of just asking for new ones.

Modified

Improvements in sockets and DNS error reporting

Modified

Introduce Signals support
Support subscribe V2 in C++ & Qt
Add pubnub_stop() for graceful shutdown when using callback interface

Modified

Introduce minimal transaction timer duration
Use QTime for transaction timer duration

Modified

Use TTL from DNS response (cache resolved addresses)
Better identification of the platform we run on
Detect authenticating proxy that works incorrectly

Modified

Will try other address from (async) DNS response if first one fails
Will try secondary (async) DNS server if primary doesn't work

Modified

Update pubnub_allooc_std.c to pubnub_cancel() changes

Modified

Support Message Counts API

Modified

Support IPv6 for DNS resolution (mostly for callback interface)

Fixed

URL encode channel name(s)

Modified	Update samples to changes in pubnub_cancel() and other interface changes Update samples to use time() instead of clock() as clock() can measure CPU-only time instead of real time Update Qt functional tests and make them reliable UUID is now part of the Pubnub context (instead of a pointer to it). This makes handling its lifetime easier, yet does not incur much memory increase
Fixed	C++ wrapper and Qt did not have proper multithreading support as they did not protect _their_ data. Now that is fixed.

Fixed

Fix memory leak regarding OpenSSL

Modified	Publish can now be GZIPed (if done via POST)
Fixed	Publish via POST encrypted could publish garbage and fail

Modified	Publish can now be done via POST
Fixed	Several smaller DNS en/de/coding issues fixed

Modified

pubnub_await() in the sync interface now reports PNR_TIMEOUT on, well, (transaction) timeout

Fixed

DNS en/de/coding could fail on some toolchains because of alignment issues.

Fixed

TLS connection timeout was prone to errors due to time synchronisation and such.

Fixed

Fix wrong detection of PNR_TIMEOUT, by reset of TLS connect timer when connection is established.

Fixed

Fix DNS decoding

Added

Add support for pubnub_subscribe_v2() w/filter expressions
pubnub_cancel() returns is it done, or it just started the cancellation
Code that is only for TLS/SSL ifdef-ed out when not building w/TLS/SSL
Functional tests for C++ updated and now run on each commit

Fixed	Improved handling of lost connection while in HTTP Keep-Alive
Added	pubnub_free() now implies pubnub_cancel() pubnub_cancel() will now call pbnc_fsm() in the sync interface. Combined with previous, this makes it possible to call pubnub_free() in sync interface and have it succeed even if transaction is ongoing.

Added

Removed (unused) option to ignore TLS/SSL errors

Added	Support HTTPS CONNECT proxy Can set proxy via IP address and `localhost` Adhere to Connection: close from server Functional tests improved, can run concurrently
Fixed	Possible pointer out of bounds fixed in JSON parser MacOS build fixed

Added

Support OpenSSL 1.1.x with callback interface
Add support for filter expressions on subscribe
Enable receiving GZIP-ed reply

Added

Enable setting HTTP Keep-Alive use on/off for C++ and Qt

Added	Enable reading system DNS on Windows
Fixed	Small fixes in system DNS reading/parsing

Added	Callback interface uses (our own) async DNS Enable sending meta data when publishing Enable setting `norep` (do not replicate) when publishing (with `store=false`, publish becomes "fire") On MacOS, use SO_NOSIGPIPE to avoid SIGPIPE on the socket
Fixed	Small fixes for async DNS Bad handling of new transaction started in the callback and HTTP keep-alive was active Bad handling of error (connection lost) when starting a new transaction on a HTTP kept-alive connection

Added	On Linux, use MSG_NOSIGNAL to avoid SIGPIPE on send() Add API to read proxy configuration Send up-to-date version info in User-Agent HTTP header
Fixed	Avoid (currently harmless) inconsistent locking order Fix HTTP GET & CONNECT proxy w/HTTP Keep-Alive

Fixed

Unify default blocking I/O setting to block in sync and non-block in callback interface

Fixed

Read from OpenSSL in a loop, to handle more than one record received at a time
Fix minor race condition on timer expiry

Added

Use HTTP Keep-alive, where possible

Fixed

Fix removing the first context from the timer list

Added	Support OpenSSL 1.1.0+ (BIO_(s\|g)et_conn_ip -> BIO_(s\|g)et_conn_address)
Fixed	Handle chunks larger than http_buff Fix receiving data longer than http_buff at a time

Fixed

Cleanups, fix build issue and warnings on Windows

Fixed

Fix resource leaks in C++ pubnub::futres on Windows

Fixed

Fix build issues on Mac

Fixed

Fix high CPU utilization when network out on Mac

Fixed

Fix off-by-one error

Fixed

Fix handling of recv() errrno on MacOS

Added	Support OpenSSL 1.1.0+ (removed BIO_set_conn_port_int)
Fixed	Some logging code was not using proper types

Fixed

Fix potential issue in interpreting UTF-8 char values

Fixed

Fix off-by-one error

Fixed	Fix handling of segmented messages
Added	Improve exising and add new logging

Added	Improve parsing of bad publish/subscribe key error Add option to turn of SSL/TLS session reuse PNR_TIMEOUT no longer resets the time token
Fixed	Fixes and improvements of the console sample application

Fixed

Fix C++ pubnub::futres destructor hanging up

Added

First "core feature complete" release

v4.15.0

v4.14.1

v4.14.0

v4.13.1

v4.13.0

v4.12.3

v4.12.2

v4.12.1

v4.12.0

v4.11.2

v4.11.1

v4.11.0

v4.10.0

v4.9.1

v4.9.0

v4.8.0

v4.7.1

v4.7.0

v4.6.2

v4.6.1

v4.6.0

v4.5.0

v4.4.0

v4.3.0

v4.2.2

v4.2.1

v4.2.0

v4.1.0

v4.0.6

v4.0.5

v4.0.4

v4.0.3

v4.0.2

v4.0.1

v4.0.0

v3.5.2

v3.5.1

v3.5.0

v3.4.3

v3.4.2

v3.4.1

v3.4.0

v3.3.2

v3.3.1

v3.3.0

v3.2.0

v3.1.0

v3.0.0

v2.14.0

v2.13.0

v2.12.7

v2.12.6

v2.12.5

v2.12.4

v2.12.3

v2.12.2

v2.12.1

v2.12.0

v2.11.1

v2.11.0

v2.10.2

v2.10.1

v2.10.0

v2.9.4

v2.9.3

v2.9.2

v2.9.1

v2.9.0

v2.8.4

v2.8.3

v2.8.2

v2.8.1

v2.8.0

v2.7.0

v2.6.4

v2.6.3

v2.6.2

v2.6.1

v2.6.0

v2.5.8