openid / openid/sharedsignals

7.1.1.3 PATCH and 7.1.1.4 PUT Switch Transmitter-Supplied Properties to SSF server-supplied properties

Open
#112 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement spec:SSF vFuture
Dominant language
Makefile
Stars
78
Forks
18
PR merge metrics
No merged PRs in 30d

Description

When creating a stream, SET PUSH and POLL are different in SSF.

For SET PUSH, a receiver stream endpoint must be pre-created. Therefore when creating a PUSH stream, the transmitter is the Stream Service config service provider.

For SET POLL, a publisher stream endpoint must be pre-created. Therefore when creating a POLL stream, the receiver is the Stream Service config service provider.

The spec uses transmitter vs. receiver without regard to RFC8935 vs 8936. This doesn't work since:

  • SET PUSH configures the receiver end
  • SET POLLING configures the transmitter end

In other words, the normative text doesn't support configuring SET PUSH streams since it would be "receiver-supplied properties".

Recommend replacing "transmitter-supplied properties" with "SSF server-supplied properties" as a simple fix.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate sections 7.1.1.3 and 7.1.1.4 in the repository's specification text and compare the transmitter/receiver terminology with the SET PUSH and SET POLL behavior described in the issue. Done means the normative wording consistently refers to SSF server-supplied properties and supports configuring both stream modes.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.