Added
- 'obuspa -c add' CLI command now supports setting child parameters
- SIGTERM signal handler to cleanly shutdown
- USP_SIGNAL_Reboot API function to initiate shutting down, then
rebooting the device
- USP_LOG_GetLogLevel and USP_LOG_SetLogLevel API functions to
atomically access the log level at runtime
Fixed
- Compilation failure when #include'ing only usp_api.h
(enable_callstack_debug should be declared in usp_api.h)
- Race hazard preventing graceful shutdown. Occurs if re-initiating
shutdown whilst in the process of shutting down
- Race hazard causing USP Broker to reject all messages from a USP
Service. Occurs when USP Service disconnects, then immediately
reconnects over UDS MTP, whilst USP Broker is waiting for a synchronous
USP response
Updated
- Code has been updated to use the latest v1.5.2 release of protobuf-c
Fixed
- A certificate file in the MUTABLE_CERT_DIR that did not contain Alias
could be left open. Note: This cannot occur if the certificate was added
using Device.LocalAgent.AddCertificate().
Added
- Device.LocalAgent.AddCertificate() support. See QUICK_START_GUIDE.md
for how to use this feature.
- can_mtp_connect vendor hook should also control Bulk Data Collection
report generation
Fixed
- Compilation failure with recent USP_PROCESS_DoWorkSync changes when
REMOVE_USP_BROKER is defined
- Removed Clang static analyzer false positives
Added
- Device.Security.Certificate may be removed from OBUSPA's data model
using the define REMOVE_DEVICE_SECURITY_CERTIFICATE in vendor_defs.h.
This does not affect Device.LocalAgent.Certificate, which still reports
the trust store certificates.
- Configure options to enable address sanitizer (--enable-asan) and
thread sanitizer builds (--enable-tsan) have been added. These options
are disabled by default.
- To support compilation of OBUSPA data model plug-ins, the build
process now installs header files to $(includedir)/obuspa
Fixed
- USP Command and Event arguments should not be allowed to be registered
more than once
Modified
- 'obuspa -c' output has been made cleaner, containing only logs from
the data model thread
- The m4-extra directory and AX_CHECK_XXX autotools macros (added in
v10.0.8) have been removed, as they filter rather than stop the build if
unsupported compiler options are used.
Added
- Functions to access the data model from vendor threads
(USP_PROCESS_DoWorkSync, USP_PROCESS_DM_GetParameterValue,
USP_PROCESS_DM_SetParameterValue)
- Configure option (--enable-hardening) to enable compiler hardening
flags (disabled by default)
Fixed
- Concurrent CLI invocations can get stuck
Modified
- Maximum allowed MTP frame size received has been increased to 5MB
(from 64K)
Fixed
- Suppress annoying warnings when using OBUSPA CLI commands
- MQTT client should not disconnect if no Response Topic
- R-GET.0 not applied for partial paths
- USP Services should not reuse group_ids registered by internal data
model providers
- Crash if object creation notification contains too many keys
Fixed
- Wildcarded delete response with allow_partial=true incorrect if one
instance not permitted to be deleted
- MQTT connection not retried if TLS handshake fails and libmoquitto
version<2.0.13
- MQTT Send message queue gets stuck if packet too large
Added
- Support for permission Targets containing search expressions
(configured by ALLOWED_PARAMS_FOR_SE_BASED_PERMS in vendor_defs.h)
Fixed
- MQTT client should disconnect if no Response Topic
- Changing LocalAgent.MTP.Enable should not assert when Protocol is UDS
- LocalAgent.MTP.{i}.Status is not working for UDS MTP
- Async Operation max concurrency limit regression (broken in v10.0.0)
Fixed
- ControllerTrust Permission Order uniqueness should be enforced when
Add request with allow_partial=false adds multiple permissions with the
same Order
- GSDM response should not contain unique keys for child objects when
first_level_only=true
Fixed
- First object creation notification after bootup may be missed
- CLI initiated event arguments do not support JSON formatted data
- Provide better documentation for OBUSPA CLI -c commands
- Removed .gitattributes file, as this causes problems when building
OBUSPA for OpenWRT
Fixed
- Code should compile with --disable-bulkdata (regression introduced in
v10.0.1)
- Wrong error code returned in USP conformance test 1.100
- Crash occurs if USP Service registers a DM element, but does not
provide it in the GSDM response
Changes from v9.0.9
Added
- Instance based permissions
- Reason and Cause arguments have been added to Device.Reboot(),
Device.FactoryReset() and Device.Boot!
- Get response only contains the names of objects that also have Obj
read permissions (in addition to Param read permissions) (USPv1.4)
Fixed
- Potential memory leak in DEVICE_SECURITY_SetALPN
Added
- USP 1.4: GSDM should contain unique keys
- USP 1.4: GSDM should support request of non-objects
Fixed
- Periodic! notifications should be sent after the Boot! event
- Empty string should not be interpreted as 0 by parameter value
conversion functions
Added
- USP Broker: Optimize Get requests spanning multiple USP Services
- USP Broker: Search Expressions optimizations (pass through of requests
and subscriptions containing search expressions to USP Services)
Fixed
- Compilation failures when INCLUDE_PROGRAMMATIC_FACTORY_RESET is
defined (GitHub PR#122)
Added
- HardwareVersion can also be specified by an environment variable
(USP_BOARD_HW_VERSION)
Fixed
- Crash that could occur once at startup if the controller trust
permissions table contained invalid data
Added
- USP Broker support for registration of parameters, events and USP
commands (USP 1.4)
- Bulk Data Collection over MQTT
Fixed
- Event and OperationComplete subscriptions to 'Device.' on a USP Broker
now set subscriptions on each USP Service containing only the DM
elements that were registered
- USP Conformance test 11.11 failure: MQTT PUBLISH frames should not be
sent until SUBACK frame indicates successfully subscribed
Added
- New CLI command for interacting directly with USP Services, when
obuspa runs as a USP Broker:
`obuspa -c service [endpoint] [command] [path-expr] [optional: value or
notify type]`
Added
- Improved MQTT MTP debug
Fixed
- USP Service acting as pure Controller does not accept responses unless
Broker is in the USP Service's Controller table
Fixed
- Get requests with max_depth >= 0x80000000 should return full sub-tree
- USP Connect record not always sent immediately after connection on
MQTT
Removed
- Unmaintained MQTT tests
Fixed
- MQTT keep alive can now be completely disabled (if required) when
linking with libmosquitto v2.0.x
- OBUSPA should subscribe to all topics indicated by the subscribe-topic
user properties in the CONNACK [R-MQTT.15]
- OBUSPA should delete pending USP notifications (on MQTT MTP) if
notification has expired whilst waiting to be sent
- MQTT connection blocks for too long if server is unresponsive. To
workaround the underlying issue in libmosquitto, OBUSPA tests for server
responsiveness by transiently connecting, before proceeding with the
libmosquitto connect (if responsive).
- OBUSPA should disconnect if unable to subscribe to anything
[R-MQTT.17]
- Device.MQTT.Client.{i}.Name should be auto-assigned by the agent, if
not given at creation time, and immutable thereafter
- Device.MQTT.Client.{i}.RequestResponseInfo should control whether
response information is requested in the CONNECT frame. Previously it
was always requested, regardless of the value of the parameter
- Removed unimplemented parameter:
Device.MQTT.Client.{i}.RequestProblemInfo
- Modifying MQTT KeepAliveTime should not force a reconnect
- MQTTv5 Assigned Client Identifier is not being saved in
Device.MQTT.Client.{i}.ClientID
- MQTT ConnectRetryTime parameter modifications should apply at the next
retry [GH #109]
- MQTT CleanSession and CleanStart parameter modifications should apply
at the next retry
- STOMP ServerRetryMaxInterval parameter modifications should apply at
the next retry
Added
- Device.LocalAgent.X_VANTIVA-COM_PreConnectTimeout controls how long to
wait for the can_mtp_connect vendor hook to allow connection, before
connecting anyway
- USP_REGISTER_Object_UniqueKey() validates that the unique key
parameters have not already been registered
Fixed
- Compiling without UDS fails [GH#110]
- WebSocket client does not send Boot! event (regression introduced in
v8.0)
- WebSocket client not started after MTP dynamically added to controller
table (regression introduced in v8.0)
Added
- USP Broker: CLI initiated gets have been optimized to pass through the
path to the USP Service, when possible
- USP Broker: Support a USP Service registering Device.DNS.SD before
Device.DNS (in separate register messages)
- USP Broker: Workaround for USP Services which have limitations on the
number of parameters requested in a get
- USP Broker: Support additional DM elements registered directly under
Device.
Fixed
- Get instances failures during path resolution should be gracefully
ignored
- An unused variable warning seen during cmake based builds has been
addressed
Fixed
- USP Broker should not assume hierarchically ordered fields in GSDM and
get instances responses
- STOMP connects shouldn't block the data model thread
Added
- A new core vendor hook has been added (modify_firmware_updated_cb_t),
which allows the FirmwareUpdated argument of the Boot! event to be
modified from the default determined by OBUSPA.
- New function: USP_PROCESS_DoWork() performs work (via a callback) in
the context of the data model thread (GH#93). Example usage: Initiating
the setting of parameters from a non-data model thread.
Fixed
- E2E session context SessionId fields are printed incorrectly in logs
on 32-bit devices
Fixed
- Prevent a parent object's parameters being spread across more than one
resolved_path_result in the GetResponse, if it has many child object
instances
- Example mqtt factory reset database should not contain wildcard in
ResponseTopicConfigured (GH#78)
Fixed
- USP Agent should attempt to restart all async operations, even if one
restart fails
- Object creation notifications should not be sent at start up, if the
object has a refresh instances vendor hook
- Instance cache should not expire during the phases of processing a USP
request
- libjson modified to replace non-UTF8 characters with the Unicode
replacement character (U+FFFD) instead of asserting
Added
- New function: USP_REGISTER_AsyncOperation_MaxConcurrency() to register
whether a USP command allows another invocation whilst running
Added
- CMake support (GH#69)
- Development environment within Docker container
Modified
- Memory allocation wrapper functions refactored to avoid erroneous
warnings when compiling with -Wuse-after-free
Fixed
- Updated Dockerfile to use Ubuntu Kinetic which includes the required
versions of libmosquitto and libwebsockets
- If 'obuspa -c get' truncates the printing of a parameter value, this
is now indicated
- Added note that start transaction vendor hook must never return a
failure, as it is not possible for OBUSPA to handle the failure in all
cases
Fixed
- OnBoardRequest notification should be retried, if corresponding
NotifyResponse not received
- Adding a Controller MTP object fails, if Protocol is not specified and
CoAP is disabled ('configure --disable-coap')
Fixed
- GH#30: MQTT publish QoS cannot be configured (stuck at 0)
- GH#64: Crash if PeriodicNotifInterval is set to 0
- GH#55: Ubuntu 22 (latest) contains earlier version of libwebsockets
than Ubuntu 20
- Requirement for libwebsockets version >= 4.1.0 made explicit in
configure.ac
- GetResponse optimized for large numbers of object instances
- USP Record should be ignored if the protobuf cannot be unpacked
- Default value for RebootCause would be better as "FactoryReset"
- MQTT exponential backoff reconnect time was 1 second too long
- Alias should be registered as a unique key for LocalAgent.Certificate
Modified
- MQTT Content Type property changed to usp.msg (changed R-MQTT.27)
- A USP Set referencing zero instances returns an empty success (changed
TP-469 conformance test 1.23)
Fixed
- For MQTTv3.x MTP, Agent should subscribe to wildcarded agent topic and
publish to topic containing '/reply-to='
- libmosquitto subscribe/unsubscribe functions were being called
unnecessarily (and failing)
- MQTT_DeleteSubscription() was being called unnecessarily (and failing)
- Memory leak when unescaping a received MQTT response topic
- MQTT subscription topic must be unique
- MQTT subscription topic must be non empty string
- When changing a subscription’s topic, The agent was unsubscribing from
the new topic (not the old topic)
- For MQTTv5 MTP, Agent should subscribe to topic from CONNACK, if
available
- Missing mutex protection in some MQTT functions
Fixed
- When disabling the agent's MQTT client, the MQTT DISCONNECT frame is
not sent and socket stays open
- Errors in received USP packets should be handled according to
requirements in R-MTP.5
Fixed
- Agent's websocket server is not restarted after IP address change or
initial failure
- GetSupportedDM response should indicate that parameters registered
with USP_REGISTER_DBParam_SecureWithType() are readable
Added
- USP 1.2 Connect and Disconnect record support
- WebSockets example factory reset file
Fixed
- 64 bit signed and unsigned integer parameter values are now
represented with full precision in JSON encoded data (for Bulk Data
Collection reports and Boot! event). To enable the old behavior (which
represented them as floating point doubles) comment out the
REPRESENT_JSON_NUMBERS_WITH_FULL_PRECISION define in vendor_defs.h
- Bulk Data Collection Protocol parameter is validating against old
value, not new value
- Empty Subscription ID should not be allowed
Modified
- MQTT function header comments
Added
- Basic End-to-End session context support (mainly segmentation and
reassembly aspects). Disabled by default. To enable, uncomment
E2ESESSION_EXPERIMENTAL_USP_V_1_2 in vendor_defs.h
- Device.DeviceInfo.UpTime parameter
Fixed
- Compile error if MQTT and STOMP are disabled
- getopt_long options structure was wrong for authcert option
- Password in STOMP header should be escaped
- Set Message obj_path is not required to contain an instance number
Modified
- Removed GET_RESPONSE_SIMPLE_FORMAT from vendor_defs.h. In USP 1.2 it
was clarified that only the simple format must be used.
