TR-369a2 – User Services Platform (USP)

Issue: 1 Amendment 2

Issue Date: January 2022

Table of Contents

List of Figures

  1. USP Agent and Controller Architecture
  2. Receiving a X.509 Certificate
  3. Example: USP Request/Response over the CoAP MTP
  4. WebSocket Session Handshake
  5. USP Request using a WebSocket Session
  6. USP over STOMP Architecture
  7. USP over MQTT Architecture
  8. MQTT Packets
  9. Processing of Received USP Records
  10. E2E Segmentation and Reassembly
  11. TLS Session Handshake
  12. A successful request/response sequence
  13. A failed request/response sequence
  14. Operate Message Flow for Synchronous Operations
  15. Operate Message Flow for Asynchronous Operations
  16. Receiving a USP Record
  17. USP Record without USP Layer Secure Message Exchange
  18. Sending a USP Record
  19. Checking a Certificate
  20. Determining the Role
  21. Trusted Broker with Received Record
  22. Trusted Broker Sending a Record
  23. Deployment Unit State Diagram
  24. Execution Unit State Diagram
  25. Possible Multi-Execution Environment Implementation
  26. Example of MTP Proxy in LAN with WAN Controller
  27. CoAP-STOMP MTP Proxy Example Flow
  28. IoT Data Model
  29. IoT individual device models
  30. IoT proxied device model
  31. IoT threshold trigger sensitivity
  32. IoT threshold trigger hold time
  33. IoT threshold trigger rest time
  34. IoT threshold trigger minimum duration

List of Tables

  1. Proxy Building Block Functions
  2. Possible MTP Proxy Methods

Notice

The Broadband Forum is a non-profit corporation organized to create guidelines for broadband network system development and deployment. This Technical Report has been approved by members of the Forum. This Technical Report is subject to change. This Technical Report is owned and copyrighted by the Broadband Forum, and all rights are reserved. Portions of this Technical Report may be owned and/or copyrighted by Broadband Forum members.

Intellectual Property

Recipients of this Technical Report are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of this Technical Report, or use of any software code normatively referenced in this Technical Report, and to provide supporting documentation.

Terms of Use

1. License

Broadband Forum hereby grants you the right, without charge, on a perpetual, non-exclusive and worldwide basis, to utilize the Technical Report for the purpose of developing, making, having made, using, marketing, importing, offering to sell or license, and selling or licensing, and to otherwise distribute, products complying with the Technical Report, in all cases subject to the conditions set forth in this notice and any relevant patent and other intellectual property rights of third parties (which may include members of Broadband Forum). This license grant does not include the right to sublicense, modify or create derivative works based upon the Technical Report except to the extent this Technical Report includes text implementable in computer code, in which case your right under this License to create and modify derivative works is limited to modifying and creating derivative works of such code. For the avoidance of doubt, except as qualified by the preceding sentence, products implementing this Technical Report are not deemed to be derivative works of the Technical Report.

2. NO WARRANTIES

THIS TECHNICAL REPORT IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT AND ANY IMPLIED WARRANTIES ARE EXPRESSLY DISCLAIMED. ANY USE OF THIS TECHNICAL REPORT SHALL BE MADE ENTIRELY AT THE USER’S OR IMPLEMENTER’S OWN RISK, AND NEITHER THE BROADBAND FORUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY USER, IMPLEMENTER, OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS TECHNICAL REPORT, INCLUDING BUT NOT LIMITED TO, ANY CONSEQUENTIAL, SPECIAL, PUNITIVE, INCIDENTAL, AND INDIRECT DAMAGES.

3. THIRD PARTY RIGHTS

Without limiting the generality of Section 2 above, BROADBAND FORUM ASSUMES NO RESPONSIBILITY TO COMPILE, CONFIRM, UPDATE OR MAKE PUBLIC ANY THIRD PARTY ASSERTIONS OF PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS THAT MIGHT NOW OR IN THE FUTURE BE INFRINGED BY AN IMPLEMENTATION OF THE TECHNICAL REPORT IN ITS CURRENT, OR IN ANY FUTURE FORM. IF ANY SUCH RIGHTS ARE DESCRIBED ON THE TECHNICAL REPORT, BROADBAND FORUM TAKES NO POSITION AS TO THE VALIDITY OR INVALIDITY OF SUCH ASSERTIONS, OR THAT ALL SUCH ASSERTIONS THAT HAVE OR MAY BE MADE ARE SO LISTED.

All copies of this Technical Report (or any portion hereof) must include the notices, legends, and other provisions set forth on this page.

Issue History

Issue Number Changes
Release 1.0 Release contains specification for the User Services Platform 1.0
Release 1.0.1 Added examples and clarifications to end-to-end messaging, use of endpoint ID, typographical fixes
Release 1.0.2 Typographical and example fixes
Release 1.1

Release contains specification for the User Services Platform 1.1.

  • Adds MQTT support as a Message Transfer Protocol
  • Adds a theory of operations for IoT control using USP Agents
  • Clarifications on protocol functions, error messages, and updates to examples
Release 1.1.2 Clarifies several examples, requirements, and error types
Release 1.2
  • Deprecates the use of COAP as an MTP
  • GetSupportedDM now allows retrieval of parameter data types
  • GetSupportedDM now allows the Agent to provide information about whether or not it will ignore ValueChange subscriptions on a given parameter
  • GetSupportedDM now provides information about whether a command is synchronous vs. asynchronous
  • GetSupportedDM now allows requests on specific object instances and handles divergent data models
  • Defines discovery mechanisms for Endpoints connected to STOMP and MQTT brokers
  • Clarifies the use of search paths vs. unique key addressing in the Add message
  • Clarifies the use of required parameters and defaults for unique keys in the Add message
  • Annex A now provides a theory of operations for use of the USPEventNotif mechanism for bulk data collection using the Push! event
  • Annex A defines a new bulk data collection over MQTT mechanism
  • DHCP discovery mechanism now provides a Controller Endpoint ID to the Agent
  • Enhances ease of use and clarifies requirements for use of TLS in USP Record integrity
  • Adds USP connect and disconnect records for use independent of MTP
  • Adds USP Record specific error mechanism and error codes
  • USP Records can now include an empty payload
  • Get requests can now include a max_depth flag to limit response size
  • Get response format has been clarified to return separate elements for each sub-object
  • Clarifies the requirements around processing an entire message in the event of a failed operation when allow_partial is true vs. false
  • Clarifies the response behavior for Get, Set, and Delete when using a path that matches no instances
  • Fixes and enhances the use of error codes for the Operate message
  • Clarifies and updates Controller credential/authentication theory of operations and flow diagrams
  • Clarifies the use of subjectAltName in certificates

Comments or questions about this Broadband Forum Technical Report should be directed to .

Editors

Name Company Email Role
Barbara Stark AT&T barbara.stark@att.com Editor/USP Project Lead
Tim Spets Assia tspets@assia-inc.com Editor/USP Project Lead
Jason Walls QA Cafe, LLC jason@qacafe.com Editor/Broadband User Services Work Area Director
John Blackford Commscope john.blackford@commscope.com Editor/Broadband User Services Work Area Director

Acknowledgments

The following individuals are being acknowledged for their efforts in the testing and development of this specification.

Name Company Email
Jean-Didier Ott Orange jeandidier.ott@orange.com
Timothy Carey Nokia timothy.carey@nokia.com
Steven Nicolai Arris Steven.Nicolai@arris.com
Apostolos Papageorgiou NEC apostolos.Papageorgiou@neclab.eu
Mark Tabry Google mtab@google.com
Klaus Wich Huawei klaus.wich@huawei.com
Daniel Egger Axiros daniel.egger@axiros.com
Bahadir Danisik Nokia bahadir.danisik@nokia.com
William Lupton Broadband Forum wlupton@broadband-forum.org
Matthieu Anne Orange matthieu.anne@orange.com
Thales Fragoso Axiros thales.fragoso@axiros.com