Release 1.7.0 (#137)

Author: Anilm3

CHANGELOG.md

@@ -1,5 +1,10 @@
 # libddwaf release
 
+### v1.7.0  ([unstable](https://github.com/DataDog/libddwaf/blob/master/README.md#versioning-semantics)) - 2023/02/06
+#### Changes
+- Handle lifetime extension ([#135](https://github.com/DataDog/libddwaf/pull/135))
+- Create macos universal binary ([#136](https://github.com/DataDog/libddwaf/pull/136))
+
 ### v1.6.2  ([unstable](https://github.com/DataDog/libddwaf/blob/master/README.md#versioning-semantics)) - 2023/01/26
 #### Changes
 - Add boolean getter ([#132](https://github.com/DataDog/libddwaf/pull/132))

UPGRADING.md

@@ -1,5 +1,33 @@
 # Upgrading libddwaf
 
+### Upgrading from `1.6.x` to `1.7.0`
+
+There are no API changes in 1.7.0, however `ddwaf_handle` is now reference-counted and shared between the user and each `ddwaf_context`. This means that it is now possible to call `ddwaf_destroy` on a `ddwaf_handle` without invalidating any `ddwaf_context` in use instantiated from said `ddwaf_handle`. For example, the following snippet is now perfectly legal and will work as expected (note that any checks have been omitted for brevity):
+
+```c
+    ddwaf_handle handle = ddwaf_init(&rule, &config, NULL);
+    ddwaf_object_free(&rule);
+
+    ddwaf_context context = ddwaf_context_init(handle);
+
+    // Destroying the handle should not invalidate the context
+    ddwaf_destroy(handle);
+
+    ...
+
+    ddwaf_run(context, &parameter, NULL, LONG_TIME);
+
+    // Both the context and the handle are destroyed here
+    ddwaf_context_destroy(context);
+```
+
+To expand on the example above:
+- `ddwaf_destroy` only destroys the `ddwaf_handle` if there are no more references to it, otherwise it relinquishes ownership to the rest of the contexts.
+- If there is more than one valid context after the user calls `ddwaf_destroy`, each context will reduce the reference count on `ddwaf_context_destroy` until it reaches zero, at which point the `ddwaf_handle` will be freed.
+- Once the user calls `ddwaf_destroy` on the `ddwaf_handle`, their reference becomes invalid and no more operations can be performed on it, including instantiating further contexts.
+
+Note that this doesn't make `ddwaf_handle` universally thread-safe, for example, replacing an existing `ddwaf_handle` shared by multiple threads still requires synchronisation.
+
 ## Upgrading from `v1.4.0` to `1.5.0`
 
 ### Actions

tests/TestInterface.cpp

@@ -296,7 +296,7 @@ TEST(FunctionalTests, HandleBad)
 /*ddwaf_destroy(handle2);*/
 /*}*/
 
-TEST(FunctionalTests, ddwaf_get_version) { EXPECT_STREQ(ddwaf_get_version(), "1.6.2"); }
+TEST(FunctionalTests, ddwaf_get_version) { EXPECT_STREQ(ddwaf_get_version(), "1.7.0"); }
 
 TEST(FunctionalTests, ddwaf_runNull)
 {

version

@@ -1 +1 @@
-1.6.2
+1.7.0