Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maint #663 - Holistic changes #449

Merged
merged 4 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions slate/source/includes/introduction/_fdo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Future Dated Obligations


```diff
Updated 'MAY retire' statements from 'by (date)' to 'from (date)'
```

The standards, as published from time to time, may include specific statements indicating that a specific section of the standards will not take effect until a future date or may cease to have effect on some future date.

Expand All @@ -20,12 +22,12 @@ The table below highlights these areas of the standards.
|[Get Scheduled Payments for Account V2](#cdr-banking-api_get-scheduled-payments-for-account)|<ul><li>Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024**</li><li>Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024**</li></ul> | March 11th 2024 |
|[Get Scheduled Payments Bulk V2](#cdr-banking-api_get-scheduled-payments-bulk)|<ul><li>Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024**</li><li>Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024**</li></ul> | March 11th 2024 |
|[Get Scheduled Payments For Specific Accounts V2](#cdr-banking-api_get-scheduled-payments-for-specific-accounts)|<ul><li>Data Holders **MUST** implement v2 of this endpoint by **March 11th 2024**</li><li>Data Holders **MAY** retire v1 of this endpoint from **September 9th 2024**</li></ul> | March 11th 2024 |
|[Get Metrics V3](#cdr-admin-api_get-metrics)|<ul><li>Data Holders **MAY** retire v3 of this endpoint by the earlier of **13th May 2024** or when the ACCC announce that this version is no longer being called</li><li>Data Holders going live on, or after, 1st November 2023 are not required to support this version</li></ul>| May 13th 2024 |
|[Get Metrics V3](#cdr-admin-api_get-metrics)|<ul><li>Data Holders **MAY** retire v3 of this endpoint from the earlier of **13th May 2024** or when the ACCC announce that this version is no longer being called</li><li>Data Holders going live on, or after, 1st November 2023 are not required to support this version</li></ul>| May 13th 2024 |
|[Get Metrics v5](#cdr-admin-api_get-metrics)|<ul><li>Data Holders **MUST** implement v5 of this endpoint by **May 13th 2024**</li><li>Data Holders **MAY** deprecate v4 of this endpoint once v5 is implemented</li></ul>| May 13th 2024 |
|[Data Holder Dashboards](#consumer-experience_dashboard-standards_data-holder-dashboards)|Data Holders **MUST** implement the following CX Standards by **July 1st 2024**<ul><li>Data Holder Dashboard: Amending authorisation details<li>Data Holder Dashboard: Data recipient handling details</ul>| July 1st 2024 |
|[Get Billing For Account](#cdr-energy-api_get-billing-for-account)|Data Holders **MAY** retire v2 of this endpoint by **September 9th 2024** if they implement v3| September 9th 2024 |
|[Get Bulk Billing](#cdr-energy-api_get-bulk-billing)|Data Holders **MAY** retire v2 of this endpoint by **September 9th 2024** if they implement v3| September 9th 2024 |
|[Get Billing For Specific Accounts](#cdr-energy-api_get-billing-for-specific-accounts)|Data Holders **MAY** retire v2 of this endpoint by **September 9th 2024** if they implement v3| September 9th 2024 |
|[Get Generic Plan Detail](#cdr-energy-api_get-generic-plan-detail)|<ul><li>Data Holders **MUST** implement v3 of this endpoint by **November 11th 2024**</li><li>Data Holder **MAY** retire v2 of this endpoint by **March 3rd 2025**</li></ul>| November 11th 2024 |
|[Get Energy Account Detail](#cdr-energy-api_get-energy-account-detail)|<ul><li>Data Holders **MUST** implement v4 of this endpoint by **November 11th 2024**</li><li>Data Holder **MAY** retire v3 of this endpoint by **March 3rd 2025**</li></ul>| November 11th 2024 |
|[Get Billing For Account](#cdr-energy-api_get-billing-for-account)|Data Holders **MAY** retire v2 of this endpoint from **September 9th 2024** if they implement v3| September 9th 2024 |
|[Get Bulk Billing](#cdr-energy-api_get-bulk-billing)|Data Holders **MAY** retire v2 of this endpoint from **September 9th 2024** if they implement v3| September 9th 2024 |
|[Get Billing For Specific Accounts](#cdr-energy-api_get-billing-for-specific-accounts)|Data Holders **MAY** retire v2 of this endpoint from **September 9th 2024** if they implement v3| September 9th 2024 |
|[Get Generic Plan Detail](#cdr-energy-api_get-generic-plan-detail)|<ul><li>Data Holders **MUST** implement v3 of this endpoint by **November 11th 2024**</li><li>Data Holder **MAY** retire v2 of this endpoint from **March 3rd 2025**</li></ul>| November 11th 2024 |
|[Get Energy Account Detail](#cdr-energy-api_get-energy-account-detail)|<ul><li>Data Holders **MUST** implement v4 of this endpoint by **November 11th 2024**</li><li>Data Holder **MAY** retire v3 of this endpoint from **March 3rd 2025**</li></ul>| November 11th 2024 |
|[Transaction Security Ciphers](#transaction-security)|Data Holders and Data Recipients **MUST** only support BCP195 recommended ciphers by **March 17th 2025**| March 17th 2025 |
26 changes: 4 additions & 22 deletions slate/source/includes/nfrs/_reporting-requirements.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,7 @@
## Reporting Requirements
The mechanism for reporting will be via the CDR [Administration Endpoints](#admin-apis).

The following information is to be reported:
```diff
Removed outdated reporting detail and updated link to Get Metrics endpoint
```

- Availability for current month
- Availability for each of the previous twelve months
- Percentage of calls within performance threshold for current day
- Percentage of calls within performance threshold for each of the previous seven days
- Number of calls within each performance tier for current day
- Number of calls within each performance tier for each of the previous seven days
- Average response time within each performance tier for current day
- Average response time within each performance tier for each of the previous seven days
- Number of sessions for current day
- Number of sessions for each of the previous seven days
- Peak total TPS for current day
- Peak total TPS for each of the previous seven days
- Average TPS for current day
- Average TPS for each of the previous seven days
- Number of calls resulting in error due to server execution for current day
- Number of calls resulting in error due to server execution for each of the previous seven days
- Number of calls rejected due to traffic thresholds for current day
- Number of calls rejected due to traffic thresholds for each of the previous seven days
- Number of customers with active authorisations
- Number of Data Recipient Software Products with active authorisations
The mechanism for reporting will be via the [Get Metrics endpoint](#cdr-admin-api_get-metrics).
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This release addresses the following minor defects raised on [Standards Staging]

This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):

- [Standards Maintenance #XXX - Title](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/XXX)
- [Standards Maintenance #663 - Maintenance Iteration 21 Holistic Feedback](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/663)


### Decision Proposals
Expand All @@ -34,13 +34,13 @@ This release addresses the following Decision Proposals published on [Standards]
|Change|Description|Link|
|------|-----------|----|
| Change summary | [**Standards Staging #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/XXX): Change detail | [Standards section](../../#section)
| Change summary | [**Standards Maintenance #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/XXX): Change detail | [Standards section](../../#section)
| Change summary | [**Decision Proposal #XXX**](https://github.com/ConsumerDataStandardsAustralia/standards/issues/XXX): Change detail | [Standards section](../../#section)


## Introduction
|Change|Description|Link|
|------|-----------|----|
| Clarified endpoint retirement dates | [**Standards Maintenance #663**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/663#issuecomment-2472253052): Updated 'MAY retire' statements from 'by (date)' to 'from (date)' | [Future Dated Obligations](../../#future-dated-obligations)


## High Level Standards
Expand All @@ -56,6 +56,8 @@ This release addresses the following Decision Proposals published on [Standards]
## Information Security Profile
|Change|Description|Link|
|------|-----------|----|
| Updated link | [**Standards Maintenance #663**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/663#issuecomment-2370626204): Resolved broken link referring to section 3 of MTLS | [Holder of Key Mechanism](../../#holder-of-key-mechanism)
| Clarified 'CDR Arrangement JWT method' details | [**Standards Maintenance #663**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/663#issuecomment-2445941229): Removed duplicate line and clarified 'CDR Arrangement JWT method' details | [CDR Arrangement Revocation End Point](../../#cdr-arrangement-revocation-end-point)


## Register Standards
Expand All @@ -71,6 +73,7 @@ This release addresses the following Decision Proposals published on [Standards]
## Non-Functional Requirements
|Change|Description|Link|
|------|-----------|----|
| Updated Reporting Requirements section | [**Standards Maintenance #663**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/663#issuecomment-2359965763): Removed outdated reporting detail and updated link to Get Metrics endpoint | [Reporting Requirements](../../?diff#reporting-requirements)


## Additional Standards
Expand Down
10 changes: 6 additions & 4 deletions slate/source/includes/security/_transport_security.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Transaction Security

### Use of TLS
All HTTP calls MUST be made using HTTPS incorporating TLS >= 1.2.

Expand All @@ -21,13 +22,14 @@ Note that, by implication, resource requests MUST be validated to ensure the cli

OAUTB SHALL NOT be supported due to a lack industry support.

**[[MTLS]](#nref-MTLS)** HoK allows issued tokens to be bound to a client certificate as specified in [section 3](https://tools.ietf.org/id/draft-ietf-oauth-mtls-07.html#SenderConstrainedAccess) of **[[MTLS]](#nref-MTLS)**.


### Ciphers
```diff
Resolved broken link referring to section 3 of MTLS
```

**[[MTLS]](#nref-MTLS)** HoK allows issued tokens to be bound to a client certificate as specified in [section 3](https://www.rfc-editor.org/rfc/rfc8705.html#name-mutual-tls-client-certifica) of **[[MTLS]](#nref-MTLS)**.


### Ciphers

**Until March 17th 2025, the following SHALL requirements apply:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,23 @@ Data Holders and Data Recipient Software Products MUST implement a CDR Arrangeme

<br/>

```diff
Clarified 'CDR Arrangement JWT method' details
```

**CDR Arrangement Form Parameter method**

The request **MUST** include the following parameters using the ``application/x-www-form-urlencoded`` format in the HTTP request entity-body:
The request **MUST** include the following parameter using the `application/x-www-form-urlencoded` format in the HTTP request entity-body:

* ``cdr_arrangement_id``: The ID of the arrangement that the client wants to revoke.
* _cdr_arrangement_id_: The ID of the arrangement that the client wants to revoke.

**CDR Arrangement JWT method**

The request **MUST** include the following parameters using the application/x-www-form-urlencoded format in the HTTP request entity-body:

* ``cdr_arrangement_jwt``: A signed JWT that includes the ``cdr_arrangement_id``.
* ``cdr_arrangement_jwt``: A newly signed JWT with the following parameters in accordance with **[[JWT]](#nref-JWT)**:
* ``cdr_arrangement_id``: The ID of the arrangement that the client wants to revoke.
The request **MUST** include the following parameter using the `application/x-www-form-urlencoded` format in the HTTP request entity-body:

The ``cdr_arrangement_jwt`` **SHOULD** include all parameters in accordance with Data Holders calling Data Recipients using [Self-Signed JWT Client Authentication](https://consumerdatastandardsaustralia.github.io/standards/#self-signed-jwt-client-authentication).
* _cdr_arrangement_jwt_: A newly signed JWT with the following parameters in accordance with **[[JWT]](#nref-JWT)**:
* _cdr_arrangement_id_: The ID of the arrangement that the client wants to revoke.
* This JWT **SHOULD** also include all parameters in accordance with Data Holders calling Data Recipients using [Self-Signed JWT Client Authentication](https://consumerdatastandardsaustralia.github.io/standards/#self-signed-jwt-client-authentication).

**Data Holder hosted endpoint**

Expand Down