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.

Sign up for GitHub

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

Introduce stream_ttl #222

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Introduce stream_ttl #222

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36900cc
Introduce push_stream_ttl in openid-sharedsignals-framework-1_0.md
TusharR-google Dec 3, 2024
d74f85b
Reword push_stream_ttl -> stream_ttl
TusharR-google Dec 3, 2024
fc933df
Merge branch 'openid:main' into main
TusharR-google Feb 11, 2025
3bf9fd6
Move stream_ttl to stream configuration, clarify refresh scenarios
TusharR-google Mar 11, 2025
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
24 changes: 24 additions & 0 deletions openid-sharedsignals-framework-1_0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@ contributor:
org: The Walt Disney Company
email: [email protected]

-
ins: T. Raibhandare
name: Tushar Raibhandare
org: Google
email: [email protected]

normative:
CLIENTCRED:
author:
Expand All @@ -85,6 +91,17 @@ normative:
target: https://tools.ietf.org/html/rfc6749#section-4.4
title: The OAuth 2.0 Authorization Framework - Client Credentials Grant

EXPIRES_IN:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you don't need to describe an RFC. You can just add its number and the kramdown tool will do the rest.

author:
- ins: D. Hardt
name: D. Hardt
date: October 2012
seriesinfo:
DOI: 10.17487/RFC6749
RFC: '6749'
target: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.14
title: The OAuth 2.0 Authorization Framework - "expires_in" Syntax

OpenID.Core:
author:
- ins: N. Sakimura
Expand Down Expand Up @@ -601,6 +618,13 @@ default_subjects
to be transmitted. The Receiver MAY remove subjects added this way via the
`remove_subject_endpoint`.

push_stream_ttl

> OPTIONAL. The lifetime of a PUSH stream in seconds, after which the Transmitter MAY either pause or disable the stream if it has not received any Receiver-initiated communication in that duration.
If the Transmitter decides to update the stream, it MUST send a Stream Updated Event to the Receiver as described in {{status}}.
If the Receiver calls any endpoint in the Event Stream Management API ({{management}}), the Transmitter must refresh the TTL of that particular stream.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might want to be explicit that contact from the receiver does not automatically move the stream out of a paused/disabled state caused by a TTL timeout.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we leave it up to the transmitter? It might complicate the spec if paused/disabled states were treated differently based on whether they were caused by a TTL timeout (Tx not allowed to automatically change the state), vs other causes like Rx requesting the pause (Tx allowed to do whatever).

The syntax is the same as that of {{EXPIRES_IN}}.

TODO: consider adding a IANA Registry for metadata, similar to Section 7.1.1 of
{{RFC8414}}. This would allow other specs to add to the metadata.

Expand Down