From 271db29fd65952968a7e73830864847497e4bfd0 Mon Sep 17 00:00:00 2001 From: BBF Tools Date: Thu, 19 Oct 2023 08:47:29 +0000 Subject: [PATCH] 2023-10-20: Release 1.3.1 --- CHANGELOG.md | 22 +- PROJECT.yaml | 11 + docs/CHANGELOG.md | 22 +- docs/METADATA-1.md | 30 +- docs/METADATA-1.yaml | 8 +- docs/METADATA.md | 258 + docs/METADATA.yaml | 61 + docs/PROJECT.yaml.outputs | 2 +- docs/PROJECT/CHANGELOG.html | 72 +- docs/PROJECT/CHANGELOG.md.txt | 22 +- docs/PROJECT/METADATA-1.html | 54 +- docs/PROJECT/METADATA-1.md.txt | 30 +- docs/PROJECT/METADATA-1.yaml.txt | 8 +- docs/PROJECT/METADATA.html | 384 + docs/PROJECT/METADATA.md.txt | 258 + docs/PROJECT/METADATA.mk.txt | 3 + docs/PROJECT/METADATA.yaml.txt | 61 + docs/PROJECT/PROJECT.yaml.txt | 11 + docs/PROJECT/README.html | 36 + docs/PROJECT/bbf.css | 22 - docs/PROJECT/index.html | 6 +- docs/bbf.css | 22 - docs/bee.png | Bin 0 -> 6977 bytes docs/extra.css | 176 +- docs/faq/bbf.css | 22 - docs/faq/bee.png | Bin 0 -> 6977 bytes docs/faq/extra.css | 176 +- docs/faq/index-metadata.yaml | 622 - docs/faq/index.htm | 16 +- docs/faq/index.html | 16 +- docs/faq/index.json | 2 +- docs/faq/json-defaults.yaml | 16 +- docs/faq/release.css | 2 +- docs/faq/release.css.bak | 2 +- docs/faq/right.png | Bin 0 -> 2601 bytes docs/faq/tick.png | Bin 0 -> 3444 bytes docs/faq/typst-defaults.yaml | 22 + docs/faq/typst-stringify.typ | 77 + docs/faq/typst-template.typ | 282 + docs/index-metadata.yaml | 622 - docs/index.htm | 16 +- docs/index.html | 12 +- docs/index.json | 2 +- docs/json-defaults.yaml | 16 +- docs/pandoc-output.txt | 188 +- docs/pandoc-tests.xml | 77 +- docs/project-parser-output.txt | 83 +- docs/project-parser-tests.xml | 11 +- docs/release.css | 2 +- docs/release.css.bak | 2 +- docs/resources/bbf.css | 22 - docs/resources/bee.png | Bin 0 -> 6977 bytes docs/resources/extra.css | 176 +- docs/resources/index-metadata.yaml | 622 - docs/resources/index.htm | 16 +- docs/resources/index.html | 16 +- docs/resources/index.json | 2 +- docs/resources/json-defaults.yaml | 16 +- docs/resources/release.css | 2 +- docs/resources/release.css.bak | 2 +- docs/resources/right.png | Bin 0 -> 2601 bytes docs/resources/tick.png | Bin 0 -> 3444 bytes docs/resources/typst-defaults.yaml | 22 + docs/resources/typst-stringify.typ | 77 + docs/resources/typst-template.typ | 282 + docs/right.png | Bin 0 -> 2601 bytes docs/specification/WT-369-release-1.3-7.pdf | Bin 3890953 -> 0 bytes docs/specification/WT-369-release-1.3-8.pdf | Bin 0 -> 3713175 bytes docs/specification/bbf.css | 22 - docs/specification/bee.png | Bin 0 -> 6977 bytes docs/specification/extra.css | 176 +- docs/specification/index-metadata.yaml | 624 - docs/specification/index.docx | Bin 3025089 -> 2868285 bytes docs/specification/index.htm | 855 +- docs/specification/index.html | 855 +- docs/specification/index.json | 2 +- docs/specification/index.md | 20 +- docs/specification/index.pdf | Bin 3890953 -> 3713175 bytes docs/specification/index.typ | 14813 ++++++++++++++++ docs/specification/json-defaults.yaml | 16 +- .../unix-domain-socket/USP-UDS-Handshake.png | Bin 238638 -> 83028 bytes .../mtp/unix-domain-socket/USP-UDS-Record.png | Bin 213846 -> 216629 bytes docs/specification/release.css | 2 +- docs/specification/release.css.bak | 2 +- docs/specification/right.png | Bin 0 -> 2601 bytes docs/specification/tick.png | Bin 0 -> 3444 bytes docs/specification/typst-defaults.yaml | 22 + docs/specification/typst-stringify.typ | 77 + docs/specification/typst-template.typ | 282 + docs/tick.png | Bin 0 -> 3444 bytes docs/typst-defaults.yaml | 22 + docs/typst-stringify.typ | 77 + docs/typst-template.typ | 282 + .../extensions/device-modularization/index.md | 20 +- .../unix-domain-socket/USP-UDS-Handshake.png | Bin 238638 -> 83028 bytes .../mtp/unix-domain-socket/USP-UDS-Record.png | Bin 213846 -> 216629 bytes 96 files changed, 19332 insertions(+), 3957 deletions(-) create mode 100644 docs/METADATA.md create mode 100644 docs/METADATA.yaml create mode 100644 docs/PROJECT/METADATA.html create mode 100644 docs/PROJECT/METADATA.md.txt create mode 100644 docs/PROJECT/METADATA.mk.txt create mode 100644 docs/PROJECT/METADATA.yaml.txt create mode 100644 docs/bee.png create mode 100644 docs/faq/bee.png delete mode 100644 docs/faq/index-metadata.yaml create mode 100644 docs/faq/right.png create mode 100644 docs/faq/tick.png create mode 100644 docs/faq/typst-defaults.yaml create mode 100644 docs/faq/typst-stringify.typ create mode 100644 docs/faq/typst-template.typ delete mode 100644 docs/index-metadata.yaml create mode 100644 docs/resources/bee.png delete mode 100644 docs/resources/index-metadata.yaml create mode 100644 docs/resources/right.png create mode 100644 docs/resources/tick.png create mode 100644 docs/resources/typst-defaults.yaml create mode 100644 docs/resources/typst-stringify.typ create mode 100644 docs/resources/typst-template.typ create mode 100644 docs/right.png delete mode 100644 docs/specification/WT-369-release-1.3-7.pdf create mode 100644 docs/specification/WT-369-release-1.3-8.pdf create mode 100644 docs/specification/bee.png delete mode 100644 docs/specification/index-metadata.yaml create mode 100644 docs/specification/index.typ create mode 100644 docs/specification/right.png create mode 100644 docs/specification/tick.png create mode 100644 docs/specification/typst-defaults.yaml create mode 100644 docs/specification/typst-stringify.typ create mode 100644 docs/specification/typst-template.typ create mode 100644 docs/tick.png create mode 100644 docs/typst-defaults.yaml create mode 100644 docs/typst-stringify.typ create mode 100644 docs/typst-template.typ diff --git a/CHANGELOG.md b/CHANGELOG.md index 805798a..26c5ebb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,17 @@ See for the current USP specification. +## 2023-10-20: [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1] + +*Tags: [v1.3.1] (USP specification), + [v1.3.0][usp-data-models-v1.3.0] (data models didn't change)* + +### TR-369 Document +This Corrigendum has the following fixes +* Fix example by populating the empty UNIX Domain Socket references +* Small fixes to UDS example images +* Fix UnixDomainSocket path in example + ## 2023-06-14: [Release 1.3][TR-369 Amendment 3] *Tags: [v1.3.0] (USP specification), @@ -132,14 +143,14 @@ USP v1.2 Message Schema ## 2020-11-18: Release 1.1.4 -*Tags: [v1.1.2] (USP specification didn't change), +*Tags: [v1.1.4] (USP specification), [v1.1.2][usp-data-models-v1.1.2] (data models didn't change)* Corresponds to [TR-181 Issue 2 Amendment 14 Corrigendum 1](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.4) ## 2020-11-05: Release 1.1.3 -*Tags: [v1.1.2] (USP specification didn't change), +*Tags: [v1.1.3] (USP specification), [v1.1.2][usp-data-models-v1.1.2] (data models didn't change)* Corresponds to [TR-106 Amendment 10](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.10.0) and @@ -154,7 +165,7 @@ Clarifies several examples, requirements, and error types ## 2020-04-06: Release 1.1.1 -*Tags: [v1.1.0] (USP specification didn't change), +*Tags: [v1.1.1] (USP specification), [v1.1.0][usp-data-models-v1.1.0] (data models didn't change)* Regenerated data model HTML using fixed version of the BBF report tool @@ -214,6 +225,7 @@ USP v1.0 Message Schema [TR-369 Amendment 1]: https://www.broadband-forum.org/download/TR-369_Amendment-1.pdf [TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf [TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf +[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf [TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf [TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf [TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf @@ -228,6 +240,10 @@ USP v1.0 Message Schema [v1.0.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.1 [v1.0.2]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.2 [v1.1.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.0 +[v1.1.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.1 [v1.1.2]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.2 +[v1.1.3]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.3 +[v1.1.4]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.4 [v1.2.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.2.0 [v1.3.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.0 +[v1.3.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.1 diff --git a/PROJECT.yaml b/PROJECT.yaml index 7077ac6..7a77e56 100644 --- a/PROJECT.yaml +++ b/PROJECT.yaml @@ -60,6 +60,17 @@ resources: restype: schema versions: + v1.3.1: + date: 2023-10-20 + title: | + [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1] + changes: + specification: + text: | + This Corrigendum has the following fixes + * Fix example by populating the empty UNIX Domain Socket references + * Small fixes to UDS example images + * Fix UnixDomainSocket path in example v1.3.0: date: 2023-06-14 title: | diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 805798a..26c5ebb 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -4,6 +4,17 @@ See for the current USP specification. +## 2023-10-20: [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1] + +*Tags: [v1.3.1] (USP specification), + [v1.3.0][usp-data-models-v1.3.0] (data models didn't change)* + +### TR-369 Document +This Corrigendum has the following fixes +* Fix example by populating the empty UNIX Domain Socket references +* Small fixes to UDS example images +* Fix UnixDomainSocket path in example + ## 2023-06-14: [Release 1.3][TR-369 Amendment 3] *Tags: [v1.3.0] (USP specification), @@ -132,14 +143,14 @@ USP v1.2 Message Schema ## 2020-11-18: Release 1.1.4 -*Tags: [v1.1.2] (USP specification didn't change), +*Tags: [v1.1.4] (USP specification), [v1.1.2][usp-data-models-v1.1.2] (data models didn't change)* Corresponds to [TR-181 Issue 2 Amendment 14 Corrigendum 1](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.4) ## 2020-11-05: Release 1.1.3 -*Tags: [v1.1.2] (USP specification didn't change), +*Tags: [v1.1.3] (USP specification), [v1.1.2][usp-data-models-v1.1.2] (data models didn't change)* Corresponds to [TR-106 Amendment 10](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.10.0) and @@ -154,7 +165,7 @@ Clarifies several examples, requirements, and error types ## 2020-04-06: Release 1.1.1 -*Tags: [v1.1.0] (USP specification didn't change), +*Tags: [v1.1.1] (USP specification), [v1.1.0][usp-data-models-v1.1.0] (data models didn't change)* Regenerated data model HTML using fixed version of the BBF report tool @@ -214,6 +225,7 @@ USP v1.0 Message Schema [TR-369 Amendment 1]: https://www.broadband-forum.org/download/TR-369_Amendment-1.pdf [TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf [TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf +[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf [TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf [TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf [TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf @@ -228,6 +240,10 @@ USP v1.0 Message Schema [v1.0.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.1 [v1.0.2]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.2 [v1.1.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.0 +[v1.1.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.1 [v1.1.2]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.2 +[v1.1.3]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.3 +[v1.1.4]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.4 [v1.2.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.2.0 [v1.3.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.0 +[v1.3.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.1 diff --git a/docs/METADATA-1.md b/docs/METADATA-1.md index 103f238..2dd3014 100644 --- a/docs/METADATA-1.md +++ b/docs/METADATA-1.md @@ -1,25 +1,33 @@ -### Issue History {.unnumbered .unlisted .new-page} +::: {.new-page} +::: + +### Issue History {.unnumbered .unlisted} -::: {.list-table .usp-revision-history aligns=l,l widths=14,65} +::: {.list-table .issue-history aligns=l,l,l widths=14,14,65} * - Issue Number + - Approval Date - Changes * - [Release 1.0][TR-369 Issue 1] + - April 2018 - Release contains specification for the User Services Platform 1.0 Corresponds to [TR-181 Issue 2 Amendment 12](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.0.0) * - [Release 1.0.1][TR-369 Corrigendum 1] + - August 2018 - * Added examples and clarifications to end-to-end messaging, use of endpoint ID, typographical fixes * - [Release 1.0.2][TR-369 Corrigendum 2] + - November 2018 - * Typographical and example fixes * - [Release 1.1][TR-369 Amendment 1] + - October 2019 - Release contains specification for the User Services Platform 1.1 * Adds MQTT support as a Message Transfer Protocol @@ -30,19 +38,24 @@ Corresponds to [TR-181 Issue 2 Amendment 13](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.0) * - Release 1.1.1 + - April 2020 - Regenerated data model HTML using fixed version of the BBF report tool * - Release 1.1.2 + - August 2020 - Clarifies several examples, requirements, and error types * - Release 1.1.3 + - November 2020 - Corresponds to [TR-106 Amendment 10](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.10.0) and [TR-181 Issue 2 Amendment 14](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.3) * - Release 1.1.4 + - November 2020 - Corresponds to [TR-181 Issue 2 Amendment 14 Corrigendum 1](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.4) * - [Release 1.2][TR-369 Amendment 2] + - January 2022 - Release contains specification for the User Services Platform 1.2 * Clarify the expected responses in result of an `Operate` message @@ -105,6 +118,7 @@ [TR-181 Issue 2 Amendment 15](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.2.0) * - [Release 1.3][TR-369 Amendment 3] + - June 2023 - Release contains the specification for the User Services Platform 1.3 * Adds Appendix VI, "Software Modularization and USP-Enabled @@ -141,11 +155,18 @@ responses * Adds new requirement R-SEC.4b for Trusted Brokers +* - [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1] + - October 2023 + - This Corrigendum has the following fixes + * Fix example by populating the empty UNIX Domain Socket references + * Small fixes to UDS example images + * Fix UnixDomainSocket path in example + ::: ### Editors {.unnumbered .unlisted} -::: {.list-table .usp-editors aligns=l,l,l,l widths=12,10,15,21} +::: {.list-table .editors aligns=l,l,l,l widths=12,10,15,21} * - Name - Company @@ -176,7 +197,7 @@ ### Acknowledgments {.unnumbered .unlisted} -::: {.list-table .usp-acknowledgments aligns=l,l,l widths=12,10,15} +::: {.list-table .acknowledgments aligns=l,l,l widths=12,10,15} * - Name - Company @@ -231,6 +252,7 @@ [TR-369 Amendment 1]: https://www.broadband-forum.org/download/TR-369_Amendment-1.pdf [TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf [TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf +[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf [TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf [TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf [TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf diff --git a/docs/METADATA-1.yaml b/docs/METADATA-1.yaml index e80c5cd..4bff83e 100644 --- a/docs/METADATA-1.yaml +++ b/docs/METADATA-1.yaml @@ -4,15 +4,17 @@ bbfNumber: TR-369 bbfTitle: The User Services Platform bbfIssue: Issue -bbfVersion: 1 Amendment 3 -bbfMonth: June +bbfVersion: 1 Amendment 3 Corrigendum 1 +bbfMonth: October bbfYear: 2023 bbfType: Technical Report bbfStatus: '' bbfContrib: '' bbfMajor: 1 bbfMinor: 3 -bbfPatch: 0 +bbfPatch: 1 +bbfMicro: 0 +bbfExtra: 0 bbfDraft: '' bbfBuild: '' diff --git a/docs/METADATA.md b/docs/METADATA.md new file mode 100644 index 0000000..2dd3014 --- /dev/null +++ b/docs/METADATA.md @@ -0,0 +1,258 @@ + + +::: {.new-page} +::: + +### Issue History {.unnumbered .unlisted} + +::: {.list-table .issue-history aligns=l,l,l widths=14,14,65} + +* - Issue Number + - Approval Date + - Changes + +* - [Release 1.0][TR-369 Issue 1] + - April 2018 + - Release contains specification for the User Services Platform 1.0 + + Corresponds to [TR-181 Issue 2 Amendment 12](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.0.0) + +* - [Release 1.0.1][TR-369 Corrigendum 1] + - August 2018 + - * Added examples and clarifications to end-to-end messaging, use of + endpoint ID, typographical fixes + +* - [Release 1.0.2][TR-369 Corrigendum 2] + - November 2018 + - * Typographical and example fixes + +* - [Release 1.1][TR-369 Amendment 1] + - October 2019 + - 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 + + Corresponds to [TR-181 Issue 2 Amendment 13](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.0) + +* - Release 1.1.1 + - April 2020 + - Regenerated data model HTML using fixed version of the BBF report tool + +* - Release 1.1.2 + - August 2020 + - Clarifies several examples, requirements, and error types + +* - Release 1.1.3 + - November 2020 + - Corresponds to [TR-106 Amendment 10](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.10.0) and + [TR-181 Issue 2 Amendment 14](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.3) + +* - Release 1.1.4 + - November 2020 + - Corresponds to [TR-181 Issue 2 Amendment 14 Corrigendum 1](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.4) + +* - [Release 1.2][TR-369 Amendment 2] + - January 2022 + - Release contains specification for the User Services Platform 1.2 + + * Clarify the expected responses in result of an `Operate` message + (R-OPR.4) + * Deprecates the use of COAP as an MTP + * GetSupportedDM + - now provides the data types for parameter values + - now allows the Agent to provide information about whether or not + it will ignore ValueChange subscriptions on a given parameter + - now provides information about whether a command is synchronous + vs. asynchronous + - 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 + - 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 + * New USP records + - adds USP connect and disconnect records for use independent of + MTP + - adds USP Record specific error mechanism and error codes + - MQTT and STOMP no longer silently drop errors; they now report + errors in the USP Record. + - 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 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 + * Clarifies R-E2E.4 + * Deprecated and Obsolete terms are now defined in the References and + Terminology section + * Updated R-E3E.43 + * Deprecates R-MSG.2 + * Deprecates R-E2E.2 + * R-E2E.42 now makes TLS renegotiation forbidden + * Modifies R-NOT.9 and adds R-NOT.10 adjusting how the Agent and + Controller should handle the subscription_id field + + Corresponds to + [TR-106 Amendment 11](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.11.0) and + [TR-181 Issue 2 Amendment 15](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.2.0) + +* - [Release 1.3][TR-369 Amendment 3] + - June 2023 + - Release contains the specification for the User Services Platform 1.3 + + * Adds Appendix VI, "Software Modularization and USP-Enabled + Applications Theory of Operation" + * Adds new Unix Domain Socket MTP + * Adds two new messages, "Register" and "Deregister", and associated + error codes (primarily for use with Appendix VI but can be + used in many scenarios) + * Adds new Software Module Management features + * Adds a note about the use of the new TriggerAction parameter in + Subscription objects + * Updates "Authentication and Authorization" to include the use of + new SecuredRole + * Updates the Add message to allow for Search Paths and clarifies the + application of permissions during Add messages + * Obsoletes CoAP as an MTP + * Adds two new requirements regarding Unique Key immutability + * Clarifies how Set should respond when using a Search Path where one + or more objects fail to update + * Updates the use of EndpointID in WebSocket arguments + and adds an fqdn authority scheme + * Addesses a potential attack vector with using MQTT, and updates other + MQTT behavior + * Updates Annex A to explain use of the "Exclude" parameter + * Updates Discovery to include the use of DHCP options for agent-device + association + * Adds a note about USP protocol versioning and Controller/Agent + behavior + * Clarifies and updates the use of certain error codes + * Clarifies the behavior of Get messages when asking for specific + Multi-Instance Objects that don't exist + * Clarifies some behavior when responding via USP Records + * Updates message flow diagrams to remove the implication of ordered + responses + * Adds new requirement R-SEC.4b for Trusted Brokers + +* - [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1] + - October 2023 + - This Corrigendum has the following fixes + * Fix example by populating the empty UNIX Domain Socket references + * Small fixes to UDS example images + * Fix UnixDomainSocket path in example + +::: + +### Editors {.unnumbered .unlisted} + +::: {.list-table .editors aligns=l,l,l,l widths=12,10,15,21} + +* - 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 {.unnumbered .unlisted} + +::: {.list-table .acknowledgments aligns=l,l,l widths=12,10,15} + +* - 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 + +::: + +[TR-369 Amendment 1]: https://www.broadband-forum.org/download/TR-369_Amendment-1.pdf +[TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf +[TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf +[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf +[TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf +[TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf +[TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf diff --git a/docs/METADATA.yaml b/docs/METADATA.yaml new file mode 100644 index 0000000..4bff83e --- /dev/null +++ b/docs/METADATA.yaml @@ -0,0 +1,61 @@ +# do not edit! this file was created from PROJECT.yaml by project-parser.py + +# BBF-specific metadata; cf. Word properties +bbfNumber: TR-369 +bbfTitle: The User Services Platform +bbfIssue: Issue +bbfVersion: 1 Amendment 3 Corrigendum 1 +bbfMonth: October +bbfYear: 2023 +bbfType: Technical Report +bbfStatus: '' +bbfContrib: '' +bbfMajor: 1 +bbfMinor: 3 +bbfPatch: 1 +bbfMicro: 0 +bbfExtra: 0 +bbfDraft: '' +bbfBuild: '' + +# other top-level variables +notice: tr +reponame: usp +"tagline": |- + A standardized protocol to manage, monitor, update, and control + connected devices, IoT endpoints, user services and home networks +"summary": | + See for the current USP specification. +"description": | + ## What is USP? + + The **User Services Platform** is a standardized **protocol for managing, + monitoring, upgrading, and controlling connected devices**. USP allows + service providers, consumer electronics manufacturers, and end users to: + + * Create interoperable and vendor-independent **managed Wi-Fi systems**. + * Perform **lifecycle management** of consumer connected devices and + containerized microservices. + * Support **independent applications** for application-enabled services + gateways. + * Enable **IoT and consumer electronics upgradability** for critical + security patches. + * Develop applications that gather the telemetry necessary to **mass data + processing, AI, and machine learning**. + * **Bootstrap and configure** newly installed or purchased devices and + applications. + * Let customer support **monitor and troubleshoot** connected devices, + services, and home network links. + * Easily map the home network to **control service quality and monitor + threats**. + * Securely **control IoT, smart home, and smart networking functions** + locally or from the Cloud. + * **Enable multi-tenant** (i.e., multi-stakeholder) management and control. + + USP represents the natural evolution of the Broadband Forum's [CPE WAN + Management Protocol (CWMP)](http://www.broadband-forum.org/cwmp), commonly + known as TR-069. It uses an expanded version of the Device:2 Data Model to + represent device operations (firmware upgrades, reboots, etc.), network + interfaces, and service functions (IoT functions, VoIP, etc.). +bbfWorkArea: '' +bbfProjectStream: '' diff --git a/docs/PROJECT.yaml.outputs b/docs/PROJECT.yaml.outputs index 0084355..fc6d0cf 100644 --- a/docs/PROJECT.yaml.outputs +++ b/docs/PROJECT.yaml.outputs @@ -1 +1 @@ -./docs/README.md ./docs/CHANGELOG.md ./docs/METADATA-1.yaml ./docs/METADATA-1.md ./docs/METADATA-1.mk +./docs/README.md ./docs/CHANGELOG.md ./docs/METADATA-1.yaml ./docs/METADATA.yaml ./docs/METADATA-1.md ./docs/METADATA.md ./docs/METADATA-1.mk ./docs/METADATA.mk diff --git a/docs/PROJECT/CHANGELOG.html b/docs/PROJECT/CHANGELOG.html index f338f29..4feba4d 100644 --- a/docs/PROJECT/CHANGELOG.html +++ b/docs/PROJECT/CHANGELOG.html @@ -1,9 +1,55 @@ + + + + + + + + BBF – + + + + + +
+

+

TR-369: User Services Platform Change Log

See https://usp.technology for the current USP specification.

+

2023-10-20: Release +1.3.1

+

Tags: v1.3.1 +(USP specification), v1.3.0 +(data models didn’t change)

+

TR-369 Document

+

This Corrigendum has the following fixes * Fix example by populating +the empty UNIX Domain Socket references * Small fixes to UDS example +images * Fix UnixDomainSocket path in example

2023-06-14: Release 1.3

@@ -12,7 +58,7 @@

2023-06-14: v1.3.0 (data models)

-

TR-369 Document

+

TR-369 Document

Release contains the specification for the User Services Platform 1.3

    @@ -61,7 +107,7 @@

    2022-01-27: v1.2.0 (data models)

    -

    TR-369 Document

    +

    TR-369 Document

    Release contains specification for the User Services Platform 1.2

    • Clarify the expected responses in result of an Operate @@ -143,8 +189,8 @@

      USP Protocol Buffers notifications, divergent object paths, and command types

      2020-11-18: Release 1.1.4

      Tags: v1.1.2 -(USP specification didn’t change), v1.1.4 +(USP specification), v1.1.2 (data models didn’t change)

      Corresponds to 2020-11-18: Release 1.1.4 Issue 2 Amendment 14 Corrigendum 1

      2020-11-05: Release 1.1.3

      Tags: v1.1.2 -(USP specification didn’t change), v1.1.3 +(USP specification), v1.1.2 (data models didn’t change)

      Corresponds to 2020-08-04: Release 1.1.2

      Clarifies several examples, requirements, and error types

      2020-04-06: Release 1.1.1

      Tags: v1.1.0 -(USP specification didn’t change), v1.1.1 +(USP specification), v1.1.0 (data models didn’t change)

      Regenerated data model HTML using fixed version of the BBF report @@ -184,7 +230,7 @@

      2019-10-18: v1.1.0 (data models)

      -

      TR-369 Document

      +

      TR-369 Document

      Release contains specification for the User Services Platform 1.1

      • Adds MQTT support as a Message Transfer Protocol
        • @@ -207,7 +253,7 @@

        2018-11-01: v1.0.2 (data models)

        -

        TR-369 Document

        +

        TR-369 Document

        • Typographical and example fixes
        @@ -219,7 +265,7 @@

        2018-08-02: v1.0.1 (data models)

        -

        TR-369 Document

        +

        TR-369 Document

        • Added examples and clarifications to end-to-end messaging, use of endpoint ID, typographical fixes
          • @@ -232,7 +278,7 @@

          2018-04-17: v1.0.0 (data models)

          -

          TR-369 Document

          +

          TR-369 Document

          Release contains specification for the User Services Platform 1.0

          Corresponds to TR-181 @@ -241,3 +287,5 @@

          USP Protocol Buffers Schemas

          USP v1.0 Record Schema

          USP v1.0 Message Schema

          + + diff --git a/docs/PROJECT/CHANGELOG.md.txt b/docs/PROJECT/CHANGELOG.md.txt index 805798a..26c5ebb 100644 --- a/docs/PROJECT/CHANGELOG.md.txt +++ b/docs/PROJECT/CHANGELOG.md.txt @@ -4,6 +4,17 @@ See for the current USP specification. +## 2023-10-20: [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1] + +*Tags: [v1.3.1] (USP specification), + [v1.3.0][usp-data-models-v1.3.0] (data models didn't change)* + +### TR-369 Document +This Corrigendum has the following fixes +* Fix example by populating the empty UNIX Domain Socket references +* Small fixes to UDS example images +* Fix UnixDomainSocket path in example + ## 2023-06-14: [Release 1.3][TR-369 Amendment 3] *Tags: [v1.3.0] (USP specification), @@ -132,14 +143,14 @@ USP v1.2 Message Schema ## 2020-11-18: Release 1.1.4 -*Tags: [v1.1.2] (USP specification didn't change), +*Tags: [v1.1.4] (USP specification), [v1.1.2][usp-data-models-v1.1.2] (data models didn't change)* Corresponds to [TR-181 Issue 2 Amendment 14 Corrigendum 1](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.4) ## 2020-11-05: Release 1.1.3 -*Tags: [v1.1.2] (USP specification didn't change), +*Tags: [v1.1.3] (USP specification), [v1.1.2][usp-data-models-v1.1.2] (data models didn't change)* Corresponds to [TR-106 Amendment 10](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.10.0) and @@ -154,7 +165,7 @@ Clarifies several examples, requirements, and error types ## 2020-04-06: Release 1.1.1 -*Tags: [v1.1.0] (USP specification didn't change), +*Tags: [v1.1.1] (USP specification), [v1.1.0][usp-data-models-v1.1.0] (data models didn't change)* Regenerated data model HTML using fixed version of the BBF report tool @@ -214,6 +225,7 @@ USP v1.0 Message Schema [TR-369 Amendment 1]: https://www.broadband-forum.org/download/TR-369_Amendment-1.pdf [TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf [TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf +[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf [TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf [TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf [TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf @@ -228,6 +240,10 @@ USP v1.0 Message Schema [v1.0.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.1 [v1.0.2]: https://github.com/BroadbandForum/usp/releases/tag/v1.0.2 [v1.1.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.0 +[v1.1.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.1 [v1.1.2]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.2 +[v1.1.3]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.3 +[v1.1.4]: https://github.com/BroadbandForum/usp/releases/tag/v1.1.4 [v1.2.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.2.0 [v1.3.0]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.0 +[v1.3.1]: https://github.com/BroadbandForum/usp/releases/tag/v1.3.1 diff --git a/docs/PROJECT/METADATA-1.html b/docs/PROJECT/METADATA-1.html index 13ca6b1..6a29693 100644 --- a/docs/PROJECT/METADATA-1.html +++ b/docs/PROJECT/METADATA-1.html @@ -4,16 +4,19 @@ - - BBF – WT-nnn – TITLE + + BBF – + + + + +
          +

          +
          + +
          + +
          +

          Issue History

          + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Issue NumberApproval DateChanges

          Release +1.0

          April 2018

          Release contains specification for the +User Services Platform 1.0

          +

          Corresponds to TR-181 +Issue 2 Amendment 12

          Release +1.0.1August 2018
            +
          • Added examples and clarifications to end-to-end messaging, use of +endpoint ID, typographical fixes
            • +
          Release +1.0.2November 2018
            +
          • Typographical and example fixes
            • +

          Release +1.1

          October 2019

          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
            • +
          +

          Corresponds to TR-181 +Issue 2 Amendment 13

          Release 1.1.1April 2020Regenerated data model HTML using fixed +version of the BBF report tool
          Release 1.1.2August 2020Clarifies several examples, requirements, +and error types
          Release 1.1.3November 2020Corresponds to TR-106 +Amendment 10 and TR-181 +Issue 2 Amendment 14
          Release 1.1.4November 2020Corresponds to TR-181 +Issue 2 Amendment 14 Corrigendum 1

          Release +1.2

          January 2022

          Release contains specification for the +User Services Platform 1.2

          +
            +
          • Clarify the expected responses in result of an Operate +message (R-OPR.4)
            • +
          • Deprecates the use of COAP as an MTP
            • +
          • GetSupportedDM +
              +
            • now provides the data types for parameter values
              • +
            • now allows the Agent to provide information about whether or not it +will ignore ValueChange subscriptions on a given parameter
              • +
            • now provides information about whether a command is synchronous +vs. asynchronous
              • +
            • 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
              • +
            • 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
            • +
          • New USP records +
              +
            • adds USP connect and disconnect records for use independent of +MTP
              • +
            • adds USP Record specific error mechanism and error codes
              • +
            • MQTT and STOMP no longer silently drop errors; they now report +errors in the USP Record.
              • +
            • 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 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
            • +
          • Clarifies R-E2E.4
            • +
          • Deprecated and Obsolete terms are now defined in the References and +Terminology section
            • +
          • Updated R-E3E.43
            • +
          • Deprecates R-MSG.2
            • +
          • Deprecates R-E2E.2
            • +
          • R-E2E.42 now makes TLS renegotiation forbidden
            • +
          • Modifies R-NOT.9 and adds R-NOT.10 adjusting how the Agent and +Controller should handle the subscription_id field
            • +
          +

          Corresponds to TR-106 +Amendment 11 and TR-181 +Issue 2 Amendment 15

          Release +1.3

          June 2023

          Release contains the specification for +the User Services Platform 1.3

          +
            +
          • Adds Appendix VI, “Software Modularization and USP-Enabled +Applications Theory of Operation”
            • +
          • Adds new Unix Domain Socket MTP
            • +
          • Adds two new messages, “Register” and “Deregister”, and associated +error codes (primarily for use with Appendix VI but can be used in many +scenarios)
            • +
          • Adds new Software Module Management features
            • +
          • Adds a note about the use of the new TriggerAction parameter in +Subscription objects
            • +
          • Updates “Authentication and Authorization” to include the use of new +SecuredRole
            • +
          • Updates the Add message to allow for Search Paths and clarifies the +application of permissions during Add messages
            • +
          • Obsoletes CoAP as an MTP
            • +
          • Adds two new requirements regarding Unique Key immutability
            • +
          • Clarifies how Set should respond when using a Search Path where one +or more objects fail to update
            • +
          • Updates the use of EndpointID in WebSocket arguments and adds an +fqdn authority scheme
            • +
          • Addesses a potential attack vector with using MQTT, and updates +other MQTT behavior
            • +
          • Updates Annex A to explain use of the “Exclude” parameter
            • +
          • Updates Discovery to include the use of DHCP options for +agent-device association
            • +
          • Adds a note about USP protocol versioning and Controller/Agent +behavior
            • +
          • Clarifies and updates the use of certain error codes
            • +
          • Clarifies the behavior of Get messages when asking for specific +Multi-Instance Objects that don’t exist
            • +
          • Clarifies some behavior when responding via USP Records
            • +
          • Updates message flow diagrams to remove the implication of ordered +responses
            • +
          • Adds new requirement R-SEC.4b for Trusted Brokers
            • +
          Release +1.3.1October 2023This Corrigendum has the following fixes +
            +
          • Fix example by populating the empty UNIX Domain Socket +references
            • +
          • Small fixes to UDS example images
            • +
          • Fix UnixDomainSocket path in example
            • +
          +

          Editors

          + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          NameCompanyEmailRole
          Barbara StarkAT&Tbarbara.stark@att.comEditor/USP Project Lead
          Tim SpetsAssiatspets@assia-inc.comEditor/USP Project Lead
          Jason WallsQA Cafe, LLCjason@qacafe.comEditor/Broadband User Services Work Area +Director
          John BlackfordCommscopejohn.blackford@commscope.comEditor/Broadband User Services Work Area +Director
          +

          Acknowledgments

          + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          NameCompanyEmail
          Jean-Didier OttOrangejeandidier.ott@orange.com
          Timothy CareyNokiatimothy.carey@nokia.com
          Steven NicolaiArrisSteven.Nicolai@arris.com
          Apostolos PapageorgiouNECapostolos.Papageorgiou@neclab.eu
          Mark TabryGooglemtab@google.com
          Klaus WichHuaweiklaus.wich@huawei.com
          Daniel EggerAxirosdaniel.egger@axiros.com
          Bahadir DanisikNokiabahadir.danisik@nokia.com
          William LuptonBroadband Forumwlupton@broadband-forum.org
          Matthieu AnneOrangematthieu.anne@orange.com
          Thales FragosoAxirosthales.fragoso@axiros.com
          + + diff --git a/docs/PROJECT/METADATA.md.txt b/docs/PROJECT/METADATA.md.txt new file mode 100644 index 0000000..2dd3014 --- /dev/null +++ b/docs/PROJECT/METADATA.md.txt @@ -0,0 +1,258 @@ + + +::: {.new-page} +::: + +### Issue History {.unnumbered .unlisted} + +::: {.list-table .issue-history aligns=l,l,l widths=14,14,65} + +* - Issue Number + - Approval Date + - Changes + +* - [Release 1.0][TR-369 Issue 1] + - April 2018 + - Release contains specification for the User Services Platform 1.0 + + Corresponds to [TR-181 Issue 2 Amendment 12](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.0.0) + +* - [Release 1.0.1][TR-369 Corrigendum 1] + - August 2018 + - * Added examples and clarifications to end-to-end messaging, use of + endpoint ID, typographical fixes + +* - [Release 1.0.2][TR-369 Corrigendum 2] + - November 2018 + - * Typographical and example fixes + +* - [Release 1.1][TR-369 Amendment 1] + - October 2019 + - 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 + + Corresponds to [TR-181 Issue 2 Amendment 13](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.0) + +* - Release 1.1.1 + - April 2020 + - Regenerated data model HTML using fixed version of the BBF report tool + +* - Release 1.1.2 + - August 2020 + - Clarifies several examples, requirements, and error types + +* - Release 1.1.3 + - November 2020 + - Corresponds to [TR-106 Amendment 10](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.10.0) and + [TR-181 Issue 2 Amendment 14](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.3) + +* - Release 1.1.4 + - November 2020 + - Corresponds to [TR-181 Issue 2 Amendment 14 Corrigendum 1](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.1.4) + +* - [Release 1.2][TR-369 Amendment 2] + - January 2022 + - Release contains specification for the User Services Platform 1.2 + + * Clarify the expected responses in result of an `Operate` message + (R-OPR.4) + * Deprecates the use of COAP as an MTP + * GetSupportedDM + - now provides the data types for parameter values + - now allows the Agent to provide information about whether or not + it will ignore ValueChange subscriptions on a given parameter + - now provides information about whether a command is synchronous + vs. asynchronous + - 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 + - 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 + * New USP records + - adds USP connect and disconnect records for use independent of + MTP + - adds USP Record specific error mechanism and error codes + - MQTT and STOMP no longer silently drop errors; they now report + errors in the USP Record. + - 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 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 + * Clarifies R-E2E.4 + * Deprecated and Obsolete terms are now defined in the References and + Terminology section + * Updated R-E3E.43 + * Deprecates R-MSG.2 + * Deprecates R-E2E.2 + * R-E2E.42 now makes TLS renegotiation forbidden + * Modifies R-NOT.9 and adds R-NOT.10 adjusting how the Agent and + Controller should handle the subscription_id field + + Corresponds to + [TR-106 Amendment 11](https://github.com/BroadbandForum/data-model-template/releases/tag/v1.11.0) and + [TR-181 Issue 2 Amendment 15](https://github.com/BroadbandForum/usp-data-models/releases/tag/v1.2.0) + +* - [Release 1.3][TR-369 Amendment 3] + - June 2023 + - Release contains the specification for the User Services Platform 1.3 + + * Adds Appendix VI, "Software Modularization and USP-Enabled + Applications Theory of Operation" + * Adds new Unix Domain Socket MTP + * Adds two new messages, "Register" and "Deregister", and associated + error codes (primarily for use with Appendix VI but can be + used in many scenarios) + * Adds new Software Module Management features + * Adds a note about the use of the new TriggerAction parameter in + Subscription objects + * Updates "Authentication and Authorization" to include the use of + new SecuredRole + * Updates the Add message to allow for Search Paths and clarifies the + application of permissions during Add messages + * Obsoletes CoAP as an MTP + * Adds two new requirements regarding Unique Key immutability + * Clarifies how Set should respond when using a Search Path where one + or more objects fail to update + * Updates the use of EndpointID in WebSocket arguments + and adds an fqdn authority scheme + * Addesses a potential attack vector with using MQTT, and updates other + MQTT behavior + * Updates Annex A to explain use of the "Exclude" parameter + * Updates Discovery to include the use of DHCP options for agent-device + association + * Adds a note about USP protocol versioning and Controller/Agent + behavior + * Clarifies and updates the use of certain error codes + * Clarifies the behavior of Get messages when asking for specific + Multi-Instance Objects that don't exist + * Clarifies some behavior when responding via USP Records + * Updates message flow diagrams to remove the implication of ordered + responses + * Adds new requirement R-SEC.4b for Trusted Brokers + +* - [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1] + - October 2023 + - This Corrigendum has the following fixes + * Fix example by populating the empty UNIX Domain Socket references + * Small fixes to UDS example images + * Fix UnixDomainSocket path in example + +::: + +### Editors {.unnumbered .unlisted} + +::: {.list-table .editors aligns=l,l,l,l widths=12,10,15,21} + +* - 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 {.unnumbered .unlisted} + +::: {.list-table .acknowledgments aligns=l,l,l widths=12,10,15} + +* - 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 + +::: + +[TR-369 Amendment 1]: https://www.broadband-forum.org/download/TR-369_Amendment-1.pdf +[TR-369 Amendment 2]: https://www.broadband-forum.org/download/TR-369_Amendment-2.pdf +[TR-369 Amendment 3]: https://www.broadband-forum.org/download/TR-369_Amendment-3.pdf +[TR-369 Amendment 3 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Amendment-3_Corrigendum-1.pdf +[TR-369 Corrigendum 1]: https://www.broadband-forum.org/download/TR-369_Corrigendum-1.pdf +[TR-369 Corrigendum 2]: https://www.broadband-forum.org/download/TR-369_Corrigendum-2.pdf +[TR-369 Issue 1]: https://www.broadband-forum.org/download/TR-369_Issue-1.pdf diff --git a/docs/PROJECT/METADATA.mk.txt b/docs/PROJECT/METADATA.mk.txt new file mode 100644 index 0000000..ce3ed65 --- /dev/null +++ b/docs/PROJECT/METADATA.mk.txt @@ -0,0 +1,3 @@ +# do not edit! this file was created from PROJECT.yaml by project-parser.py + +PANDOCWATERMARK = diff --git a/docs/PROJECT/METADATA.yaml.txt b/docs/PROJECT/METADATA.yaml.txt new file mode 100644 index 0000000..4bff83e --- /dev/null +++ b/docs/PROJECT/METADATA.yaml.txt @@ -0,0 +1,61 @@ +# do not edit! this file was created from PROJECT.yaml by project-parser.py + +# BBF-specific metadata; cf. Word properties +bbfNumber: TR-369 +bbfTitle: The User Services Platform +bbfIssue: Issue +bbfVersion: 1 Amendment 3 Corrigendum 1 +bbfMonth: October +bbfYear: 2023 +bbfType: Technical Report +bbfStatus: '' +bbfContrib: '' +bbfMajor: 1 +bbfMinor: 3 +bbfPatch: 1 +bbfMicro: 0 +bbfExtra: 0 +bbfDraft: '' +bbfBuild: '' + +# other top-level variables +notice: tr +reponame: usp +"tagline": |- + A standardized protocol to manage, monitor, update, and control + connected devices, IoT endpoints, user services and home networks +"summary": | + See for the current USP specification. +"description": | + ## What is USP? + + The **User Services Platform** is a standardized **protocol for managing, + monitoring, upgrading, and controlling connected devices**. USP allows + service providers, consumer electronics manufacturers, and end users to: + + * Create interoperable and vendor-independent **managed Wi-Fi systems**. + * Perform **lifecycle management** of consumer connected devices and + containerized microservices. + * Support **independent applications** for application-enabled services + gateways. + * Enable **IoT and consumer electronics upgradability** for critical + security patches. + * Develop applications that gather the telemetry necessary to **mass data + processing, AI, and machine learning**. + * **Bootstrap and configure** newly installed or purchased devices and + applications. + * Let customer support **monitor and troubleshoot** connected devices, + services, and home network links. + * Easily map the home network to **control service quality and monitor + threats**. + * Securely **control IoT, smart home, and smart networking functions** + locally or from the Cloud. + * **Enable multi-tenant** (i.e., multi-stakeholder) management and control. + + USP represents the natural evolution of the Broadband Forum's [CPE WAN + Management Protocol (CWMP)](http://www.broadband-forum.org/cwmp), commonly + known as TR-069. It uses an expanded version of the Device:2 Data Model to + represent device operations (firmware upgrades, reboots, etc.), network + interfaces, and service functions (IoT functions, VoIP, etc.). +bbfWorkArea: '' +bbfProjectStream: '' diff --git a/docs/PROJECT/PROJECT.yaml.txt b/docs/PROJECT/PROJECT.yaml.txt index 7077ac6..7a77e56 100644 --- a/docs/PROJECT/PROJECT.yaml.txt +++ b/docs/PROJECT/PROJECT.yaml.txt @@ -60,6 +60,17 @@ resources: restype: schema versions: + v1.3.1: + date: 2023-10-20 + title: | + [Release 1.3.1][TR-369 Amendment 3 Corrigendum 1] + changes: + specification: + text: | + This Corrigendum has the following fixes + * Fix example by populating the empty UNIX Domain Socket references + * Small fixes to UDS example images + * Fix UnixDomainSocket path in example v1.3.0: date: 2023-06-14 title: | diff --git a/docs/PROJECT/README.html b/docs/PROJECT/README.html index 3c855ce..28b19ff 100644 --- a/docs/PROJECT/README.html +++ b/docs/PROJECT/README.html @@ -1,3 +1,37 @@ + + + + + + + + BBF – + + + + + +
          +

          +

          TR-369: The User Services Platform

          @@ -40,3 +74,5 @@

          What is USP?

          Device:2 Data Model to represent device operations (firmware upgrades, reboots, etc.), network interfaces, and service functions (IoT functions, VoIP, etc.).

          + + diff --git a/docs/PROJECT/bbf.css b/docs/PROJECT/bbf.css index e4aaf62..dd57386 100644 --- a/docs/PROJECT/bbf.css +++ b/docs/PROJECT/bbf.css @@ -190,28 +190,6 @@ ul ul, ol ol { margin: .3em 0; } -dl { - border: 3px double #ccc; /* BBF: added */ - margin-bottom: 1em; -} - -dt { - float: left; /* BBF: added */ - clear: left; /* BBF: added */ - width: 10%; /* BBF: added */ - font-weight: bold; - margin-bottom: .8em; -} - -/* BBF: TBD work out how to handle multi-paragraph dd elements */ -dd { - margin: 0 0 .8em 2em; -} - -dd:last-child { - margin-bottom: 0; -} - img { border: 0; -ms-interpolation-mode: bicubic; diff --git a/docs/PROJECT/index.html b/docs/PROJECT/index.html index 171780d..af0adca 100644 --- a/docs/PROJECT/index.html +++ b/docs/PROJECT/index.html @@ -1,4 +1,4 @@ -

          WT-369 PROJECT.yaml and its products:

          +

          WT-369 PROJECT.yaml and its products:

           diff --git a/docs/bbf.css b/docs/bbf.css index e4aaf62..dd57386 100644 --- a/docs/bbf.css +++ b/docs/bbf.css @@ -190,28 +190,6 @@ ul ul, ol ol { margin: .3em 0; } -dl { - border: 3px double #ccc; /* BBF: added */ - margin-bottom: 1em; -} - -dt { - float: left; /* BBF: added */ - clear: left; /* BBF: added */ - width: 10%; /* BBF: added */ - font-weight: bold; - margin-bottom: .8em; -} - -/* BBF: TBD work out how to handle multi-paragraph dd elements */ -dd { - margin: 0 0 .8em 2em; -} - -dd:last-child { - margin-bottom: 0; -} - img { border: 0; -ms-interpolation-mode: bicubic; diff --git a/docs/bee.png b/docs/bee.png new file mode 100644 index 0000000000000000000000000000000000000000..7322f5965c2cc38a10db6e505c23cbda755a28be GIT binary patch literal 6977 zcmZvBWmp{Bvi9H>+}+*X1_m2k0|bI3xHE(M;4T3|g6kkjun^qcg9Hx**WeH|=p}pa zd(QdJcUM2vRjc}at5#L@kA9wx(biPL#-zXm007u3$_me)w9FqtM}4}N+Pf}4DFpZD zN^*e8F{<6CO{%q_ij9T_faA$V2cRGj0FeGbo-P0a1pwtQ8vsy6p!}Ep9DyHz_~gfb z5~C=40P;T=rzibqDL=^*`)@641+}oIQ*k!8wSI1GZsq&rN6JU|caD6-fAMAVk^XHz z;Q&2}Y%Wgf84wbbbmoS9HkfxHMHsEp>Ec6B0PLNd<@c%q!{l7>a_BQ`M-v7h;^W<;ZUse5`4EWR<33)eba}TJS9u(>%{oexu^8PpC-zNqB z2`TaNxwSjg$@5P|(xL)D-v7_}-vli;d+Vp>{6*mZ2mhbG|Hd2sUkU!x`40ie`=_D* z(cr(Q_m}r+eA1Xtwfyg^AdP9ZuQd+boI4Lhn?T|l2=aYch?)7CvUwc;NTK` zMn$_hbr(u}OkPaHj8kL8T(nR@^S6%MMoh>X_RFMY{j_I#P&PaZ{xrevhC3IH`AmJu z`aA5UPr%5XwHq%)$7FJY&u{Bdu94rNGWNeofMzcXNpNt8bUX0R>(#s@W(wcF@GC1V zbBx7`9rlK`)L8AzCXn*ws*$VW8Rn-OheRklR|6E;V(YEskG|tbwImRQa;V_jfZ3W$ zGd%<|dJ?InHjjR^j?(fCnUi$u*P`rH#zm5+M0X-4-=jX;6Yx2gr+)ifH?yyAE-@~; zbf-#^iluB+k)kI)A<_?riqkm5H`+HI~;L8ER;SI6jue!!{R#HYf6MBeO+hxVQU zT-xv^G!#VAP({+Om-F|gyAn+oA9M`j>W~Z}vn&mY40#4L2bEGr0i6m=CB*9c$pp~LiLbsD`o@Qugv@@-#-4bWsK)2I8|7)4jl z#N;7M_th(J`p3nXU)9x_rKPbhd{mY-^F7_=_}XcGSodK;U9qVo?icVXb3{v%Mq2R4 z%u4oGYf~C5DUu=_%Tu*r#V{Sh{ww>L5{&0C0)KT}SJvnD`=w0aw^E2fMR#!%+&ie{@F2|Frb6O?i*myyJWF^Dd}WP7$<0-g zrC+wu=`ERvv-kb*_gBGL(>QS*x|hYC`?HwGXWAAY!A27+=CiGdN6m$5A8>|tHJr`2 zPfCsPkr~=-7|X2BN-n%oN{yNy%ME<%wuKl;lQONhhK**``-meRA7{=<65H&lxdSp`ys0&^sA< zJ1tJL^UzCw2A|DZYgY7Ibn{s9K@Aa{lyrxvzCdp;ox@r#eKHzm%HHYi*L@Z}@k2zX zW{n7G6Pp$gSk8Q$NYA?%-+MP*6*DDI!^=es!M|BZSm5wA;mNHzOTI_r#-?OFa+s!@ z-zULiV-pC+O9vYcmXi==dwQ!m+%UNmv#ERM^oCLNtz4DzXwC*}Pw%5z zzrglc8h8}K!FAW)#~ra+*+L6l{DH#GlAg7+pm%9Hg)``c@w*(`TdBcxN?YX#SI8k@YiET{IzE|=$dKo+t98m{qt{g#vdHJ;IQ{ITN5HPA+3=SE*tD! zNpK_e=IyhakwMWal!2p_dd>;;7qsvWp^{auxBB$uI9cp%)?ckyqBn@=JQ2D)1ADEU z@DYtxxvH-}@o$uj<(zKEcEjCua8km&V~jFFG29fWT+9u$2`wnEyBT^ivpK~!syJ~H z64<8+8nNRF(i?x?yw&Xe&>WhDA8bO2xEik5{y2AFu-$rd7e|}(6-2(PO^x__0~eDX zZvTsN56KktGlDCE09fv#~T;I z3`gHwc>C(-BN|G;s0Apv(H;vuBc&&$P-1#NTSl@veoyh%Vi+l2pn;*+v$?!5;xB7vz2QRocfGt5m9@~ZGeU4co0 zD3C;DTAu@V&)UysNAyX(ve9){@f`iZnzidph^SxyYldNv1g)01!e_89qoprIscOzomKWUB)JNVYVxrTq^@=8Kklb@Ar%rT8S954hH zRjMJJ)Hjuz|!6xM{z8z|wP zBGQh<`C%u?-ezw3q8i2s`IIA<1< z7ua^GB~@K*(Pc#(utZhm_$C~)S{Z8ZtCBrx^R;&VP&%Ie^MIpx^>OF?h-QwKk8t9= zL$%>Athh5)A%|MKzLIcJ-7FJ3EhmFkQa-e*mdOBufw4(j)2MGuX1~BV8SlA#W~`G6 zHh&d%cuI1~jE#(3U9hU56y9K8-_Mo3$hojzW{Y#USff#ZSUxPt2u6X!-%I3ZUP1+- ztX^gE4Tju0Gh?coAdbk4C9sk=bH$RJRjxmH&Y+s zIUbv%26lXc<6jWmDO5%3H8);P`Wiz`wYIiZy~TV^%r2@U^0t^*KNPWuI8Op4xE2m4 zimQDe^|)B#j!u0RmBT1AxnEp|#+c+%2zo`oz5a;oZSLE|-1e)_pD-nHK>>va*CP?! zC%pA(s;K>nKf@+SwZt<^*@y1kSccVcAX)-sCKLz9C-_o@Cq^t}ooh0p`;?6>{09es zOTjFcd3@ie!=!1C(!lq9YI^D$!AG&u7Nkfx=hGf?SZKxMDa%UP& znIhH2#bL~+A&Jz!gpt^J=iQ82t!=ye!o{R&JQ<$VE$|+ToEK%5uYDt?$ZZm*D_#`E zj#0D>d5bJ+eaRY!dtgkg=b$LO(C*+({Aqy!r)gIvGF|`CDlojXE}%4E%w9(6iOSFh zMSFRr)Pk={G;GTDOxEB8G&>rUd+u+F^?Ko38Z2U!mS*CxK`pI4v*B*PDZ=;{2`OaE z_*HA$iOcU_$CpQsJ4dYzT7mK(6wF}-)T|oW^g4~E4qD$wze{R_)Gv)u5KH-;6PPyF zl34o>vW{i;=CMu{c1Br)_Qb>Am*&SO?h5zq?~i8AcUxZy4I5(2 zcBaw~K<;d}k4tg1-;1fhtw`&uv6(Kny-2eRtYZ%ymE!0V+fK~ZM2t988Nvgp)N>eg zU`Yzckih;PYP`_W*rFmP_TcU_6pJGztiD|R@9Z2|n41_{XU$F#As37~HP*FQz`2*i zR_!p(8%Z1DyhrT)7x^X%>~yYn)Q14+CBxIK@m&;G4A{=Vz!64I)z-*#U+dLjT%YH3_tTY+G%tc?9r%>Wt z7yu8<&6I*{xL6&z@gly}a1{YNpiy=L2egs@N=WOXVSlEK zHKMaoL(Kxlb(cc9>$uHl<{CNPfKp1XT1rn$<380nxz$Ql^6)DJNO6B67;Xm^NjT$U ziAe(|Z1$z3E6!e(Op=28JO&A{siJ%BjWSu$d>(Q7T8IGRd?H+JfkK~%HDz7N#`6m$ z3+N|uXR0mEE*WbIdABBXIhM&u_m_EHrVnGxHcO`SeG zf_5!7YYTKXVPj7VNFUWJz!A{NBUNpRrY))`S+3Ts-q zy4-9I+TR#HILH=Iu#@GcwV{*?hpTxU%6WK`$OR~U%zoKRk8xb%Pwq&*J-%)`97?_T z@Fo9lTU0EGZhUNBE@jc_$WWBOs-;Af*{FqP2*czQ6A2mP1(i-~!A;WVz;RIeGhcP9 zhKbxuq}_>>mY+<0$@1o?#EVG5F!h)XgzG+7vX0?upyWFq3>^~$?SvJEXG10v#$VCM z8`t+Ic+)Bhu46gSksgNG*pp;$%Zw^N-#%6`nPr#fXTA*} zvIA0Q_v8iNH7`6p)gkLQu7YGU-JEP;8@kDt%$S1pwoMG%pQ)5 zvEkJ$A`;+>G`ZFJu=q2i9(}9d$)Y!j#{}gtS1r&U8KL}%7?ZfteOJsV%nbVY%rptY zWf+;VAPw9={vf+g#e||j8X0WQpX_y%4QI#KrrC*X)&CT$#lJTEJr*{uIJ^L*a@6=@ z*>HY1b1FSD8EU)j{?N_rVYX`M_hHo3BPeX_UArAhLO5UQdm_eja5C6D#7wHu2&IG3 zc1O`v1_xs7lbhWqs4Un6en|?d@hdp}-X3n0)Nz zwL&v=s(R%9Jz67ee<%40Mhn~Gyz$)yuE%tKgYHfxZN3!iiPM@O%4=8%ze*fGj_01J z+Rt$@-glV11fMHv-`?_RHaiVAWMZzWyfQZEm=l zgQ_DvaA68a`+n>qp6xT`KR`Y|Kela^{JGrH8<(haR7rfk3R;Fp{hWvyKa*}tzeSh? zoy3(2CnqPn2EL;uwJZCcY)Dq1-hW`MR_1*dC%wiW045>xcO)j^&lWD&=F`7(e`AH$ zuecu8ah);u<_n1m@OO0H@5+pao0NvT`znIZjlp4Bm4|92HvMXZN4rasarf>*Ai+h^ zk3p|mW-rqkmp zZlu6?Bzf6 z2L}$p;i^tZ!_}o|*ZcX!o;4RPbRcDj2B!I768*p_x$`f5SbteVn}|>s7PSoi2hoiY z6lYQ=#^mIu$j;5>b<8zGVS*ir4I=GWojI`6ASo5g>#Z01P3Ng+sLjO&(Ml^|xaVRYc~Hl`ORN|gxA|5FrfLbk!?{}WABkC)^0~|8tcu03{{sqayqZmZ25ePo!a2=aB~AV zj^uy=hRDXwR?8TPP3eVk!5rWzC%{dwM~^V=Tps`N=FrXIq~q*_6B^_)wWFD4Gj_DP z_49Fw6y3-46Ob|EyTLIIv;Cz)H5mo9gvZa&Tq%En8mR<+zSB16g<5kHt_?Rgx1!4x z|Kqme8kKOn^UljtKq6n| z38~PSgju0T>z>|5&Js+_7Q*522X6*S3iwi}i0r@R%PQx`uxMlo*<2pX$CKjYRq3#BF60YkC_LEmDL65H&>Kq5u zi{Z*-PoHH(hG-iLf{3)w4bAR!e-|R5J~Ioj|NN?Ly$RP0ee&^K_fC|H&R?L8X9f2r zX)N`Ke!NvwxmNXqFe>&s;AO%WR32?gg}E$2+p%J4*bSfVZhv}{`woOs6hgIeL)KVZ zTN`30sM*`wTaL4ukkduxHFco@*11cii4rN_WqIvkS#5QZe;D;ZkF)6zqv^3e?!fw<=8ke%Erm*2!bvHyHoAZW8ct%j(VB=JUoQn zr>0h7tCJmcScGKxG>RiM4n|SF#@>x>`pKlv>Ro8wDk2E7)jTCDK>Zz?J7 z{kZBkCaCAPU;f}yN@aT)MBs5d`wb1?agn?wyi_c1io7@Qq$RNso!fn^hN zcUv#b!h~D|=yXALq10wTf<>CiMZSViupjNsl(mfIf%3@LxdhNT4JxT(OhZlupD~Rg zs@UzoT~LR#DLKy)?=T*s`oI(Z{Y#zLvx4DM*Ymb{+*k+qzkp_~qOhCuxCBa38w6xQ zx!RY21Vqb+!gSlrYa&*VWT6O|)!mF4-UFRLJM1SgdQyrndc`p(DXBBHcjO9V)wk?f zj&8GN{xPV;0)CyEO8?Ffw7u}i#pgwdB!>4(YgH*fGkh{U4}stqI_!&$fU5l{PVD%p zM a.headerlink { display: inline; } -/* experimental definition list support based on ideas from - https://www.the-art-of-web.com/css/format-dl */ - -dl { - border: 3px double #ccc; - margin-bottom: 1em; -} +/* description lists */ dt { - float: left; - clear: left; - width: 15%; font-weight: bold; - margin-bottom: .8em; } -/* XXX need to work out how to handle multi-paragraph dd elements */ -dd { - margin: 0 0 .8em 2em; +/* table-like description lists, modified from a comment at + https://clicknathan.com/web-design/styling-html-5-description-lists- + formerly-known-as-definition-lists-properly */ + +/* XXX not the default; enabled by the dltable class + +/* XXX should so something similar for Typst? */ + +.dltable dl { + --dl-width: 95%; + --dt-width: 15%; + --dd-width: calc(var(--dl-width) - var(--dt-width)); +} + +.dltable.narrow dl { + --dt-width: 10%; +} + +.dltable.wide dl { + --dt-width: 25%; +} + +.dltable dl { + display: flex; + flex-wrap: wrap; + width: var(--dl-width); +} + +.dltable dl > * { + padding-top: 0.5em; +} + +.dltable dt { + width: var(--dt-width); + text-align: left; +} + +.dltable dd { + width: var(--dd-width); + padding-left: 1em; + margin-left: 0px; +} + +.dltable dd + dd { + width: var(--dl-width); + padding-left: calc(var(--dt-width) + 1em); +} + +.dltable dt + dt { + padding-right: var(--dd-width); } -dd:last-child { - margin-bottom: 0; +.dltable dt + dt + dd { + margin-top: -1.625em; /* own height including padding */ + padding-left: calc(var(--dt-width) + 1em); } /* this makes elements invisible */ diff --git a/docs/faq/bbf.css b/docs/faq/bbf.css index e4aaf62..dd57386 100644 --- a/docs/faq/bbf.css +++ b/docs/faq/bbf.css @@ -190,28 +190,6 @@ ul ul, ol ol { margin: .3em 0; } -dl { - border: 3px double #ccc; /* BBF: added */ - margin-bottom: 1em; -} - -dt { - float: left; /* BBF: added */ - clear: left; /* BBF: added */ - width: 10%; /* BBF: added */ - font-weight: bold; - margin-bottom: .8em; -} - -/* BBF: TBD work out how to handle multi-paragraph dd elements */ -dd { - margin: 0 0 .8em 2em; -} - -dd:last-child { - margin-bottom: 0; -} - img { border: 0; -ms-interpolation-mode: bicubic; diff --git a/docs/faq/bee.png b/docs/faq/bee.png new file mode 100644 index 0000000000000000000000000000000000000000..7322f5965c2cc38a10db6e505c23cbda755a28be GIT binary patch literal 6977 zcmZvBWmp{Bvi9H>+}+*X1_m2k0|bI3xHE(M;4T3|g6kkjun^qcg9Hx**WeH|=p}pa zd(QdJcUM2vRjc}at5#L@kA9wx(biPL#-zXm007u3$_me)w9FqtM}4}N+Pf}4DFpZD zN^*e8F{<6CO{%q_ij9T_faA$V2cRGj0FeGbo-P0a1pwtQ8vsy6p!}Ep9DyHz_~gfb z5~C=40P;T=rzibqDL=^*`)@641+}oIQ*k!8wSI1GZsq&rN6JU|caD6-fAMAVk^XHz z;Q&2}Y%Wgf84wbbbmoS9HkfxHMHsEp>Ec6B0PLNd<@c%q!{l7>a_BQ`M-v7h;^W<;ZUse5`4EWR<33)eba}TJS9u(>%{oexu^8PpC-zNqB z2`TaNxwSjg$@5P|(xL)D-v7_}-vli;d+Vp>{6*mZ2mhbG|Hd2sUkU!x`40ie`=_D* z(cr(Q_m}r+eA1Xtwfyg^AdP9ZuQd+boI4Lhn?T|l2=aYch?)7CvUwc;NTK` zMn$_hbr(u}OkPaHj8kL8T(nR@^S6%MMoh>X_RFMY{j_I#P&PaZ{xrevhC3IH`AmJu z`aA5UPr%5XwHq%)$7FJY&u{Bdu94rNGWNeofMzcXNpNt8bUX0R>(#s@W(wcF@GC1V zbBx7`9rlK`)L8AzCXn*ws*$VW8Rn-OheRklR|6E;V(YEskG|tbwImRQa;V_jfZ3W$ zGd%<|dJ?InHjjR^j?(fCnUi$u*P`rH#zm5+M0X-4-=jX;6Yx2gr+)ifH?yyAE-@~; zbf-#^iluB+k)kI)A<_?riqkm5H`+HI~;L8ER;SI6jue!!{R#HYf6MBeO+hxVQU zT-xv^G!#VAP({+Om-F|gyAn+oA9M`j>W~Z}vn&mY40#4L2bEGr0i6m=CB*9c$pp~LiLbsD`o@Qugv@@-#-4bWsK)2I8|7)4jl z#N;7M_th(J`p3nXU)9x_rKPbhd{mY-^F7_=_}XcGSodK;U9qVo?icVXb3{v%Mq2R4 z%u4oGYf~C5DUu=_%Tu*r#V{Sh{ww>L5{&0C0)KT}SJvnD`=w0aw^E2fMR#!%+&ie{@F2|Frb6O?i*myyJWF^Dd}WP7$<0-g zrC+wu=`ERvv-kb*_gBGL(>QS*x|hYC`?HwGXWAAY!A27+=CiGdN6m$5A8>|tHJr`2 zPfCsPkr~=-7|X2BN-n%oN{yNy%ME<%wuKl;lQONhhK**``-meRA7{=<65H&lxdSp`ys0&^sA< zJ1tJL^UzCw2A|DZYgY7Ibn{s9K@Aa{lyrxvzCdp;ox@r#eKHzm%HHYi*L@Z}@k2zX zW{n7G6Pp$gSk8Q$NYA?%-+MP*6*DDI!^=es!M|BZSm5wA;mNHzOTI_r#-?OFa+s!@ z-zULiV-pC+O9vYcmXi==dwQ!m+%UNmv#ERM^oCLNtz4DzXwC*}Pw%5z zzrglc8h8}K!FAW)#~ra+*+L6l{DH#GlAg7+pm%9Hg)``c@w*(`TdBcxN?YX#SI8k@YiET{IzE|=$dKo+t98m{qt{g#vdHJ;IQ{ITN5HPA+3=SE*tD! zNpK_e=IyhakwMWal!2p_dd>;;7qsvWp^{auxBB$uI9cp%)?ckyqBn@=JQ2D)1ADEU z@DYtxxvH-}@o$uj<(zKEcEjCua8km&V~jFFG29fWT+9u$2`wnEyBT^ivpK~!syJ~H z64<8+8nNRF(i?x?yw&Xe&>WhDA8bO2xEik5{y2AFu-$rd7e|}(6-2(PO^x__0~eDX zZvTsN56KktGlDCE09fv#~T;I z3`gHwc>C(-BN|G;s0Apv(H;vuBc&&$P-1#NTSl@veoyh%Vi+l2pn;*+v$?!5;xB7vz2QRocfGt5m9@~ZGeU4co0 zD3C;DTAu@V&)UysNAyX(ve9){@f`iZnzidph^SxyYldNv1g)01!e_89qoprIscOzomKWUB)JNVYVxrTq^@=8Kklb@Ar%rT8S954hH zRjMJJ)Hjuz|!6xM{z8z|wP zBGQh<`C%u?-ezw3q8i2s`IIA<1< z7ua^GB~@K*(Pc#(utZhm_$C~)S{Z8ZtCBrx^R;&VP&%Ie^MIpx^>OF?h-QwKk8t9= zL$%>Athh5)A%|MKzLIcJ-7FJ3EhmFkQa-e*mdOBufw4(j)2MGuX1~BV8SlA#W~`G6 zHh&d%cuI1~jE#(3U9hU56y9K8-_Mo3$hojzW{Y#USff#ZSUxPt2u6X!-%I3ZUP1+- ztX^gE4Tju0Gh?coAdbk4C9sk=bH$RJRjxmH&Y+s zIUbv%26lXc<6jWmDO5%3H8);P`Wiz`wYIiZy~TV^%r2@U^0t^*KNPWuI8Op4xE2m4 zimQDe^|)B#j!u0RmBT1AxnEp|#+c+%2zo`oz5a;oZSLE|-1e)_pD-nHK>>va*CP?! zC%pA(s;K>nKf@+SwZt<^*@y1kSccVcAX)-sCKLz9C-_o@Cq^t}ooh0p`;?6>{09es zOTjFcd3@ie!=!1C(!lq9YI^D$!AG&u7Nkfx=hGf?SZKxMDa%UP& znIhH2#bL~+A&Jz!gpt^J=iQ82t!=ye!o{R&JQ<$VE$|+ToEK%5uYDt?$ZZm*D_#`E zj#0D>d5bJ+eaRY!dtgkg=b$LO(C*+({Aqy!r)gIvGF|`CDlojXE}%4E%w9(6iOSFh zMSFRr)Pk={G;GTDOxEB8G&>rUd+u+F^?Ko38Z2U!mS*CxK`pI4v*B*PDZ=;{2`OaE z_*HA$iOcU_$CpQsJ4dYzT7mK(6wF}-)T|oW^g4~E4qD$wze{R_)Gv)u5KH-;6PPyF zl34o>vW{i;=CMu{c1Br)_Qb>Am*&SO?h5zq?~i8AcUxZy4I5(2 zcBaw~K<;d}k4tg1-;1fhtw`&uv6(Kny-2eRtYZ%ymE!0V+fK~ZM2t988Nvgp)N>eg zU`Yzckih;PYP`_W*rFmP_TcU_6pJGztiD|R@9Z2|n41_{XU$F#As37~HP*FQz`2*i zR_!p(8%Z1DyhrT)7x^X%>~yYn)Q14+CBxIK@m&;G4A{=Vz!64I)z-*#U+dLjT%YH3_tTY+G%tc?9r%>Wt z7yu8<&6I*{xL6&z@gly}a1{YNpiy=L2egs@N=WOXVSlEK zHKMaoL(Kxlb(cc9>$uHl<{CNPfKp1XT1rn$<380nxz$Ql^6)DJNO6B67;Xm^NjT$U ziAe(|Z1$z3E6!e(Op=28JO&A{siJ%BjWSu$d>(Q7T8IGRd?H+JfkK~%HDz7N#`6m$ z3+N|uXR0mEE*WbIdABBXIhM&u_m_EHrVnGxHcO`SeG zf_5!7YYTKXVPj7VNFUWJz!A{NBUNpRrY))`S+3Ts-q zy4-9I+TR#HILH=Iu#@GcwV{*?hpTxU%6WK`$OR~U%zoKRk8xb%Pwq&*J-%)`97?_T z@Fo9lTU0EGZhUNBE@jc_$WWBOs-;Af*{FqP2*czQ6A2mP1(i-~!A;WVz;RIeGhcP9 zhKbxuq}_>>mY+<0$@1o?#EVG5F!h)XgzG+7vX0?upyWFq3>^~$?SvJEXG10v#$VCM z8`t+Ic+)Bhu46gSksgNG*pp;$%Zw^N-#%6`nPr#fXTA*} zvIA0Q_v8iNH7`6p)gkLQu7YGU-JEP;8@kDt%$S1pwoMG%pQ)5 zvEkJ$A`;+>G`ZFJu=q2i9(}9d$)Y!j#{}gtS1r&U8KL}%7?ZfteOJsV%nbVY%rptY zWf+;VAPw9={vf+g#e||j8X0WQpX_y%4QI#KrrC*X)&CT$#lJTEJr*{uIJ^L*a@6=@ z*>HY1b1FSD8EU)j{?N_rVYX`M_hHo3BPeX_UArAhLO5UQdm_eja5C6D#7wHu2&IG3 zc1O`v1_xs7lbhWqs4Un6en|?d@hdp}-X3n0)Nz zwL&v=s(R%9Jz67ee<%40Mhn~Gyz$)yuE%tKgYHfxZN3!iiPM@O%4=8%ze*fGj_01J z+Rt$@-glV11fMHv-`?_RHaiVAWMZzWyfQZEm=l zgQ_DvaA68a`+n>qp6xT`KR`Y|Kela^{JGrH8<(haR7rfk3R;Fp{hWvyKa*}tzeSh? zoy3(2CnqPn2EL;uwJZCcY)Dq1-hW`MR_1*dC%wiW045>xcO)j^&lWD&=F`7(e`AH$ zuecu8ah);u<_n1m@OO0H@5+pao0NvT`znIZjlp4Bm4|92HvMXZN4rasarf>*Ai+h^ zk3p|mW-rqkmp zZlu6?Bzf6 z2L}$p;i^tZ!_}o|*ZcX!o;4RPbRcDj2B!I768*p_x$`f5SbteVn}|>s7PSoi2hoiY z6lYQ=#^mIu$j;5>b<8zGVS*ir4I=GWojI`6ASo5g>#Z01P3Ng+sLjO&(Ml^|xaVRYc~Hl`ORN|gxA|5FrfLbk!?{}WABkC)^0~|8tcu03{{sqayqZmZ25ePo!a2=aB~AV zj^uy=hRDXwR?8TPP3eVk!5rWzC%{dwM~^V=Tps`N=FrXIq~q*_6B^_)wWFD4Gj_DP z_49Fw6y3-46Ob|EyTLIIv;Cz)H5mo9gvZa&Tq%En8mR<+zSB16g<5kHt_?Rgx1!4x z|Kqme8kKOn^UljtKq6n| z38~PSgju0T>z>|5&Js+_7Q*522X6*S3iwi}i0r@R%PQx`uxMlo*<2pX$CKjYRq3#BF60YkC_LEmDL65H&>Kq5u zi{Z*-PoHH(hG-iLf{3)w4bAR!e-|R5J~Ioj|NN?Ly$RP0ee&^K_fC|H&R?L8X9f2r zX)N`Ke!NvwxmNXqFe>&s;AO%WR32?gg}E$2+p%J4*bSfVZhv}{`woOs6hgIeL)KVZ zTN`30sM*`wTaL4ukkduxHFco@*11cii4rN_WqIvkS#5QZe;D;ZkF)6zqv^3e?!fw<=8ke%Erm*2!bvHyHoAZW8ct%j(VB=JUoQn zr>0h7tCJmcScGKxG>RiM4n|SF#@>x>`pKlv>Ro8wDk2E7)jTCDK>Zz?J7 z{kZBkCaCAPU;f}yN@aT)MBs5d`wb1?agn?wyi_c1io7@Qq$RNso!fn^hN zcUv#b!h~D|=yXALq10wTf<>CiMZSViupjNsl(mfIf%3@LxdhNT4JxT(OhZlupD~Rg zs@UzoT~LR#DLKy)?=T*s`oI(Z{Y#zLvx4DM*Ymb{+*k+qzkp_~qOhCuxCBa38w6xQ zx!RY21Vqb+!gSlrYa&*VWT6O|)!mF4-UFRLJM1SgdQyrndc`p(DXBBHcjO9V)wk?f zj&8GN{xPV;0)CyEO8?Ffw7u}i#pgwdB!>4(YgH*fGkh{U4}stqI_!&$fU5l{PVD%p zM a.headerlink { display: inline; } -/* experimental definition list support based on ideas from - https://www.the-art-of-web.com/css/format-dl */ - -dl { - border: 3px double #ccc; - margin-bottom: 1em; -} +/* description lists */ dt { - float: left; - clear: left; - width: 15%; font-weight: bold; - margin-bottom: .8em; } -/* XXX need to work out how to handle multi-paragraph dd elements */ -dd { - margin: 0 0 .8em 2em; +/* table-like description lists, modified from a comment at + https://clicknathan.com/web-design/styling-html-5-description-lists- + formerly-known-as-definition-lists-properly */ + +/* XXX not the default; enabled by the dltable class + +/* XXX should so something similar for Typst? */ + +.dltable dl { + --dl-width: 95%; + --dt-width: 15%; + --dd-width: calc(var(--dl-width) - var(--dt-width)); +} + +.dltable.narrow dl { + --dt-width: 10%; +} + +.dltable.wide dl { + --dt-width: 25%; +} + +.dltable dl { + display: flex; + flex-wrap: wrap; + width: var(--dl-width); +} + +.dltable dl > * { + padding-top: 0.5em; +} + +.dltable dt { + width: var(--dt-width); + text-align: left; +} + +.dltable dd { + width: var(--dd-width); + padding-left: 1em; + margin-left: 0px; +} + +.dltable dd + dd { + width: var(--dl-width); + padding-left: calc(var(--dt-width) + 1em); +} + +.dltable dt + dt { + padding-right: var(--dd-width); } -dd:last-child { - margin-bottom: 0; +.dltable dt + dt + dd { + margin-top: -1.625em; /* own height including padding */ + padding-left: calc(var(--dt-width) + 1em); } /* this makes elements invisible */ diff --git a/docs/faq/index-metadata.yaml b/docs/faq/index-metadata.yaml deleted file mode 100644 index 0373a12..0000000 --- a/docs/faq/index-metadata.yaml +++ /dev/null @@ -1,622 +0,0 @@ -PYTHONDIR: '../../../install/pandoc//../python' -ROOTDIR: '..' -analyticstag: '' -author: [] -autoSectionLabels: true -bbfBuild: '' -bbfCertProductType: '' -bbfCertProgram: '' -bbfContrib: '' -bbfDraft: '' -bbfEditorsSpec: - before: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: editors - content: Editors - level: 3 - optional: true -bbfIssue: Issue -bbfMajor: 1 -bbfMinor: 3 -bbfMonth: June -bbfNumber: 'TR-369' -bbfPSLsSpec: - before: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: 'bbfprojectstream-project-stream-leaders' - content: ' Project Stream Leader(s)' - level: 3 - optional: true -bbfPatch: 0 -bbfProjectStream: '' -bbfRevisionHistorySpec: - after: - content: 'Comments or questions about this Broadband Forum Technical Report should be directed to info@broadband-forum.org.' - before: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - - 'new-page' - identifier: 'bbfissue-history' - content: 'Issue History' - level: 3 - headers: - - 'Issue Number!!!' - - 'Approval Date!!!!' - - 'Issue Editor!!!!!' - - 'Changes!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!' - labels: - - number - - approval - - editors - - changes - optional: true -bbfStatus: '' -bbfTitle: 'The User Services Platform' -bbfType: 'Technical Report' -bbfVersion: '1 Amendment 3' -bbfWADsSpec: - before: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: 'bbfworkarea-work-area-directors' - content: ' Work Area Director(s)' - level: 3 - optional: true -bbfWorkArea: '' -bbfYear: 2023 -bibliography: - - 'tr-069-biblio-csl.json' - - 'ansi-biblio-csl.json' - - 'iso-biblio-csl.json' - - 'w3c-biblio-csl.json' - - '3gpp-biblio-csl.json' - - 'ieee-biblio-csl.json' - - 'ietf-biblio-csl.json' - - 'itu-biblio-csl.json' -buttons: - - label: Specification - title: 'USP Specification' - url: '../specification/index.html' - - label: HTML - title: 'USP Specification Single-file HTML' - url: '../specification/index.htm' - - label: PDF - title: 'USP Specification PDF' - url: '../specification/index.pdf' - - label: 'Data Models' - title: 'USP Data Models' - url: 'https://usp-data-models.broadband-forum.org' - - label: 'Test Plan' - title: 'USP Test Plan' - url: 'https://usp-test.broadband-forum.org' - - label: Resources - title: 'USP Development Resources' - url: '../resources/index.html#sec:executive-summary' - - label: FAQ - title: 'USP Frequently Asked Questions' - url: '../faq/index.html#sec:executive-summary' -citation-style: 'bbf.csl' -code-block-filters: - pbv: - args: - from: '!attributes.from' - import: - - 'usp.usp_record_1_3_pb2' - - 'usp.usp_msg_1_3_pb2' - path: '../../../install/pandoc//../python' - to: '!classes.protobuf|json|yaml' - type: '!attributes.type' - prog: 'protobuf-verify.py' -copydate: 2023 -date: 'Issue Date: June 2023' -description: - - attr: - attributes: [] - classes: [] - identifier: 'what-is-usp' - content: 'What is USP?' - level: 2 - - content: 'The User Services Platform is a standardized protocol for managing, monitoring, upgrading, and controlling connected devices. USP allows service providers, consumer electronics manufacturers, and end users to:' - - content: - - - content: 'Create interoperable and vendor-independent managed Wi-Fi systems.' - - - content: 'Perform lifecycle management of consumer connected devices and containerized microservices.' - - - content: 'Support independent applications for application-enabled services gateways.' - - - content: 'Enable IoT and consumer electronics upgradability for critical security patches.' - - - content: 'Develop applications that gather the telemetry necessary to mass data processing, AI, and machine learning.' - - - content: 'Bootstrap and configure newly installed or purchased devices and applications.' - - - content: 'Let customer support monitor and troubleshoot connected devices, services, and home network links.' - - - content: 'Easily map the home network to control service quality and monitor threats.' - - - content: 'Securely control IoT, smart home, and smart networking functions locally or from the Cloud.' - - - content: 'Enable multi-tenant (i.e., multi-stakeholder) management and control.' - - content: 'USP represents the natural evolution of the Broadband Forum’s CPE WAN Management Protocol (CWMP), commonly known as TR-069. It uses an expanded version of the Device:2 Data Model to represent device operations (firmware upgrades, reboots, etc.), network interfaces, and service functions (IoT functions, VoIP, etc.).' -description-meta: 'TR-369 – The User Services Platform: A standardized protocol to manage, monitor, update, and control connected devices, IoT endpoints, user services and home networks' -doctitle: 'TR-369 – The User Services Platform' -faqurl: '../faq/index.html#sec:executive-summary' -figPrefix: - - Figure - - Figures -lastDelim: ' and ' -link-citations: true -linkReferences: true -lofTitle: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: 'list-of-figures' - content: 'List of Figures' - level: 3 -lolTitle: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: 'list-of-listings' - content: 'List of Listings' - level: 3 -lotTitle: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: 'list-of-tables' - content: 'List of Tables' - level: 3 -nameInLink: true -notice: tr -numberSections: true -pairDelim: ' and ' -project: 'The User Services Platform' -reference-section-title: References -references: - - URL: 'https://tools.ietf.org/html/rfc1035' - call-number: 'RFC 1035' - id: RFC1035 - issued: - year: 1987 - publisher: IETF - title: 'Domain Names - Implementation and Specification' - - URL: 'https://tools.ietf.org/html/rfc2119' - call-number: 'RFC 2119' - id: RFC2119 - issued: - year: 1997 - publisher: IETF - title: 'Key words for use in RFCs to Indicate Requirement Levels' - - URL: 'https://tools.ietf.org/html/rfc2136' - call-number: 'RFC 2136' - id: RFC2136 - issued: - year: 1997 - publisher: IETF - title: 'Dynamic Updates in the Domain Name System (DNS UPDATE)' - - URL: 'https://tools.ietf.org/html/rfc2141' - call-number: 'RFC 2141' - id: RFC2141 - issued: - year: 1997 - publisher: IETF - title: 'URN Syntax' - - URL: 'https://tools.ietf.org/html/rfc2234' - call-number: 'RFC 2234' - id: RFC2234 - issued: - year: 1997 - publisher: IETF - title: 'Augmented BNF for Syntax Specifications: ABNF' - - URL: 'https://tools.ietf.org/html/rfc2648' - call-number: 'RFC 2648' - id: RFC2648 - issued: - year: 1999 - publisher: IETF - title: 'A URN Namespace for IETF Documents' - - URL: 'https://tools.ietf.org/html/rfc3007' - call-number: 'RFC 3007' - id: RFC3007 - issued: - year: 2000 - publisher: IETF - title: 'Secure Domain Name System (DNS) Dynamic Update' - - URL: 'https://datatracker.ietf.org/doc/html/rfc3279' - call-number: 'RFC 3279' - id: RFC3279 - issued: - year: 2002 - publisher: IETF - title: 'Algorithms and Identifiers for the Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile' - - URL: 'https://tools.ietf.org/html/rfc3315' - call-number: 'RFC 3315' - id: RFC3315 - issued: - year: 2003 - publisher: IETF - title: 'Dynamic Host Configuration Protocol for IPv6 (DHCPv6)' - - URL: 'https://tools.ietf.org/html/rfc3925' - call-number: 'RFC 3925' - id: RFC3925 - issued: - year: 2004 - publisher: IETF - title: 'Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4)' - - URL: 'https://tools.ietf.org/html/rfc3986' - call-number: 'RFC 3986' - id: RFC3986 - issued: - year: 2005 - publisher: IETF - title: 'Uniform Resource Identifier (URI): Generic Syntax' - - URL: 'https://tools.ietf.org/html/rfc4033' - call-number: 'RFC 4033' - id: RFC4033 - issued: - year: 2005 - published: IETF - title: 'DNS Security Introduction and Requirements' - - URL: 'https://tools.ietf.org/html/rfc4122' - call-number: 'RFC 4122' - id: RFC4122 - issued: - year: 2005 - published: IETF - title: 'A Universally Unique IDentifier (UUID) URN Namespace' - - URL: 'https://tools.ietf.org/html/rfc4180' - call-number: 'RFC 4180' - id: RFC4180 - issued: - year: 2005 - published: IETF - title: 'Common Format and MIME Type for Comma-Separated Values (CSV) Files' - - URL: 'https://tools.ietf.org/html/rfc5246' - call-number: 'RFC 5246' - id: RFC5246 - issued: - year: 2008 - published: IETF - title: 'The Transport Layer Security (TLS) Protocol Version 1.2' - - URL: 'https://tools.ietf.org/html/rfc5280' - call-number: 'RFC 5280' - id: RFC5280 - issued: - year: 2008 - published: IETF - title: 'Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile' - - URL: 'https://tools.ietf.org/html/rfc5705' - call-number: 'RFC 5705' - id: RFC5705 - issued: - year: 2010 - publisher: IETF - title: 'Keying Material Exporters for Transport Layer Security (TLS)' - - URL: 'https://tools.ietf.org/html/rfc5869' - call-number: 'RFC 5869' - id: RFC5869 - issued: - year: 2010 - publisher: IETF - title: 'HMAC-based Extract-and-Expand Key Derivation Function (HKDF)' - - URL: 'https://tools.ietf.org/html/rfc6066' - call-number: 'RFC 6066' - id: RFC6066 - issued: - year: 2011 - publisher: IETF - title: 'Transport Layer Security (TLS) Extensions: Extension Definitions' - - URL: 'https://tools.ietf.org/html/rfc6125' - call-number: 'RFC 6125' - id: RFC6125 - issued: - year: 2011 - publisher: IETF - title: 'Representation and Verification of Domain-Based Application Service Identity within Internet Public Key Infrastructure Using X.509 (PKIX) Certificates in the Context of Transport Layer Security (TLS)' - - URL: 'https://tools.ietf.org/html/rfc6455' - call-number: 'RFC 6455' - id: RFC6455 - issued: - year: 2011 - publisher: IETF - title: 'The WebSocket Protocol' - - URL: 'https://tools.ietf.org/html/rfc6347' - call-number: 'RFC 6347' - id: RFC6347 - issued: - year: 2012 - publisher: IETF - title: 'Datagram Transport Layer Security Version 1.2' - - URL: 'https://tools.ietf.org/html/rfc6762' - call-number: 'RFC 6762' - id: RFC6762 - issued: - year: 2013 - publisher: IETF - title: 'Multicast DNS' - - URL: 'https://tools.ietf.org/html/rfc6763' - call-number: 'RFC 6763' - id: RFC6763 - issued: - year: 2013 - publisher: IETF - title: 'DNS-Based Service Discovery' - - URL: 'https://tools.ietf.org/html/rfc6818' - call-number: 'RFC 6818' - id: RFC6818 - issued: - year: 2013 - publisher: IETF - title: 'Updates to the Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile' - - URL: 'https://tools.ietf.org/html/rfc6979' - call-number: 'RFC 6979' - id: RFC6979 - issued: - year: 2013 - publisher: IETF - title: 'Deterministic Usage of the Digital Signature Algorithm (DSA) and Elliptic Curve Digital Signature Algorithm (ECDSA)' - - URL: 'https://tools.ietf.org/html/rfc7159' - call-number: 'RFC 7159' - id: RFC7159 - issued: - year: 2014 - published: IETF - title: 'The JavaScript Object Notation (JSON) Data Interchange Format' - - URL: 'https://tools.ietf.org/html/rfc7228' - call-number: 'RFC 7228' - id: RFC7228 - issued: - year: 2013 - published: IETF - title: 'Terminology for Constrained-Node Networks' - - URL: 'https://tools.ietf.org/html/rfc7252' - call-number: 'RFC 7252' - id: RFC7252 - issued: - year: 2014 - published: IETF - title: 'The Constrained Application Protocol (CoAP)' - - URL: 'https://tools.ietf.org/html/rfc7390' - call-number: 'RFC 7390' - id: RFC7390 - issued: - year: 2014 - published: IETF - title: 'Group Communication for the Constrained Application Protocol (CoAP)' - - URL: 'https://tools.ietf.org/html/rfc7925' - call-number: 'RFC 7925' - id: RFC7925 - issued: - year: 2016 - published: IETF - title: 'Transport Layer Security (TLS) / Datagram Transport Layer Security (DTLS) Profiles for the Internet of Things' - - URL: 'https://tools.ietf.org/html/rfc7959' - call-number: 'RFC 7959' - id: RFC7959 - issued: - year: 2016 - published: IETF - title: 'Block-Wise Transfers in the Constrained Application Protocol (CoAP)' - - URL: 'https://tools.ietf.org/html/rfc8446' - call-number: 'RFC 8446' - id: RFC8446 - issued: - year: 2018 - publisher: IETF - title: 'The Transport Layer Security (TLS) Protocol Version 1.3' - - URL: 'https://tools.ietf.org/html/rfc8766' - call-number: 'RFC 8766' - id: RFC8766 - issued: - year: 2020 - published: IETF - title: 'Discovery Proxy for Multicast DNS-Based Service Discovery' - - URL: 'https://www.broadband-forum.org/technical/download/TR-069.pdf' - call-number: 'TR-069 Amendment 6' - id: 'TR-069' - issued: - year: 2018 - publisher: 'Broadband Forum' - title: 'CPE WAN Management Protocol' - - URL: 'https://data-model-template.broadband-forum.org' - call-number: 'TR-106' - id: 'TR-106' - publisher: 'Broadband Forum' - title: 'Data Model Template for CWMP Endpoints and USP Agents' - - URL: 'https://usp-data-models.broadband-forum.org#Device:2' - call-number: 'TR-181 Issue 2' - id: 'TR-181' - publisher: 'Broadband Forum' - title: 'Device Data Model' - - URL: 'https://www.iana.org/' - call-number: IANA - id: IANA - publisher: IANA - title: 'Internet Assigned Numbers Authority' - - URL: 'https://imeidb.gsma.com/imei/index#' - call-number: 'IMEI Database' - id: IMEI - publisher: GSMA - title: 'International Mobile Equipment Identity' - - URL: 'https://regauth.standards.ieee.org' - call-number: Assignments - id: IEEEREG - publisher: IEEE - title: 'IEEE Registration Authority' - - URL: 'https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html' - call-number: 'MQTT 5.0' - id: 'MQTT-5-0' - publisher: OASIS - title: 'MQ Telemetry Transport 5.0' - - URL: 'http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html' - call-number: 'MQTT 3.1.1' - id: 'MQTT-3-1-1' - publisher: OASIS - title: 'MQ Telemetry Transport 3.1.1' - - URL: 'https://developers.google.com/protocol-buffers/docs/proto3' - call-number: 'Protocol Buffers v3' - id: PROTOBUF - publisher: Google - title: 'Protocol Buffers Mechanism for Serializing Structured Data Version 3' - - URL: 'https://stomp.github.io/stomp-specification-1.2.html' - call-number: 'STOMP-1-2' - id: 'STOMP-1-2' - title: 'Simple Text Oriented Message Protocol' - - URL: 'https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf' - call-number: 'FIPS PUB 180-4' - id: 'FIPS-180.4' - publisher: NIST - title: 'Secure Hash Standard (SHS)' - - URL: 'https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf' - call-number: 'FIPS PUB 186-4' - id: 'FIPS-186.4' - publisher: NIST - title: 'Digital Signature Standard (DSS)' - - URL: 'https://www.w3.org/TR/2000/NOTE-SOAP-20000508/' - call-number: 'SOAP 1.1' - id: 'SOAP-1-1' - issued: - year: 2000 - publisher: W3C - title: 'Simple Object Access Protocol (SOAP) 1.1' - - URL: 'https://www.w3.org/TR/xmlschema-2/' - call-number: 'XML Schema Part 2' - id: 'XMLSCHEMA-2' - issued: - year: 2004 - publisher: W3C - title: 'XML Schema Part 2: Datatypes Second Edition' -repodesc: 'specification source' -reponame: usp -resurl: '../resources/index.html#sec:executive-summary' -secPrefix: - - Section - - Sections -sectionsDepth: '-1' -shortname: USP -siteurl: '../index.html' -status: '' -subtitle: 'Issue: 1 Amendment 3 ' -summary: - content: 'See https://usp.technology for the current USP specification.' -tagline: 'A standardized protocol to manage, monitor, update, and control connected devices, IoT endpoints, user services and home networks' -tblPrefix: - - Table - - Tables -theme-color: '#157878' -title: 'TR-369 – The User Services Platform' -title-prefix: BBF -titleid: title -usp-msg-proto-file: 'usp-msg-1-3.proto' -usp-msg-proto-url: '../specification/usp-msg-1-3.proto' -usp-record-proto-file: 'usp-record-1-3.proto' -usp-record-proto-url: '../specification/usp-record-1-3.proto' -uspAcknowledgmentsSpec: - before: - - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: acknowledgments - content: Acknowledgments - level: 3 - - content: 'The following individuals are being acknowledged for their efforts in the testing and development of this specification.' - headers: - - 'Name!!!!!!!!!!!!!!!!!!' - - 'Company!!!!' - - 'Email!!!!!!!!!!' - optional: true -uspEditorsSpec: - before: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: 'editors-1' - content: Editors - level: 3 - headers: - - 'Name!!!!!!!!' - - 'Company!!' - - 'Email!!!!!!!!!' - - 'Role!!!!!!!!!!!!!!!' - optional: true -uspPSLsSpec: - before: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: 'bbfprojectstream-project-stream-leaders-1' - content: ' Project Stream Leaders' - level: 3 - headers: - - 'Name!!!!!!!!' - - 'Company!!' - - 'Email!!!!!!!!!' - - 'Role!!!!!!!!!!!!!!!' - optional: true -uspRevisionHistorySpec: - after: - content: 'Comments or questions about this Broadband Forum Technical Report should be directed to info@broadband-forum.org.' - before: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - - 'new-page' - identifier: 'bbfissue-history-1' - content: 'Issue History' - level: 3 - headers: - - 'Issue Number' - - 'Changes!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!' - labels: - - number - - changes - optional: true -uspWADsSpec: - before: - attr: - attributes: [] - classes: - - unnumbered - - unlisted - identifier: 'bbfworkarea-work-area-directors-1' - content: ' Work Area Directors' - level: 3 - headers: - - 'Name!!!!!!!!' - - 'Company!!' - - 'Email!!!!!!!!!' - - 'Role!!!!!!!!!!!!!!!' - optional: true -version: '' -versionNumber: '1.3' diff --git a/docs/faq/index.htm b/docs/faq/index.htm index 63b435f..6d763a9 100644 --- a/docs/faq/index.htm +++ b/docs/faq/index.htm @@ -14,8 +14,11 @@ div.columns{display: flex; gap: min(4vw, 1.5em);} div.column{flex: auto; overflow-x: auto;} div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} - ul.task-list{list-style: none;} + /* The extra [class] is a hack that increases specificity enough to + override a similar rule in reveal.js */ + ul.task-list[class]{list-style: none;} ul.task-list li input[type="checkbox"] { + font-size: inherit; width: 0.8em; margin: 0 0.8em 0.2em -1.6em; vertical-align: middle; @@ -77,6 +80,7 @@