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

Jump to bottom

explicit channel auth scheme #182

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

explicit channel auth scheme #182

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6012fc8
explicit channel auth scheme
elf-pavlik Jul 6, 2023
2f924b7
Update protocol.html
csarven Jul 14, 2023
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
11 changes: 11 additions & 0 deletions protocol.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -755,13 +755,20 @@ <h3 property="schema:name" content="Description Resource Data Model">Description
<code> "subscription": [{</code>
<code> "id": "https://websocket.example/subscription",</code>
<code> "channelType": "WebSocketChannel2023",</code>
<code> "channelAuthScheme": ["CapabilityURL"],</code>
<code> "feature": ["endAt", "rate", "state"]</code>
<code> }, {</code>
<code> "id": "https://webhook.example/subscription",</code>
<code> "channelType": "WebhookChannel2023",</code>
<code> "channelAuthScheme": ["CapabilityURL", "SolidOIDC"]</code>
<code> "feature": ["endAt", "rate", "state"]</code>
<code> }],</code>
<code> "channel": [{</code>
<code> "id": "https://channel.example/guinan/profile",</code>
<code> "type": "WebSocketChannel2023",</code>
<code> "topic": "https://example.org/guinan/profile",</code>
<code> "receiveFrom": "wss://websocket.example/guinan/profile",</code>
<code> "authScheme": "None",</code>
<code> "rate": "PT1M"</code>
<code> }]</code>
<code>}</code></pre>
Expand All @@ -779,6 +786,7 @@ <h3 property="schema:name" content="Subscription Service Data Model">Subscriptio
<ul>
<li id="notify-subscription-id">One <code>id</code> property to identify the subscription service.</li>
<li id="notify-channelType">One <code>channelType</code> property to state the <a href="#notification-channel-types" rel="rdfs:seeAlso">notification channel type</a>.</li>
<li id="notify-channelAuthScheme">One or many <code>channelAuthScheme</code> property to state the supported authentication schemes.</li>
Copy link
Member

Choose a reason for hiding this comment

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

I couldn't suggest a change to add a paragraph/section (perhaps right after #authentication-authorization or a new subsection of the #protocol section.) The following suggestion would refer to Authentication Scheme.

Suggested change
<li id="notify-channelAuthScheme">One or many <code>channelAuthScheme</code> property to state the supported authentication schemes.</li>
<li id="notify-channelAuthScheme">One or many <code>channelAuthScheme</code> property to state the supported <a href="#authentication-scheme">authentication schemes</a>.</li>

<li id="notify-feature">Zero, one, or many <code>feature</code> properties to state the supported <a href="#notification-features" rel="rdfs:seeAlso">features</a>.</li>
</ul>

Expand All @@ -791,6 +799,7 @@ <h3 property="schema:name" content="Subscription Service Data Model">Subscriptio
<code> ],</code>
<code> "id": "https://websocket.example/subscription",</code>
<code> "channelType": "WebSocketChannel2023",</code>
<code> "channelAuthScheme": ["CapabilityURL"],</code>
<code> "feature": ["endAt", "rate", "state"]</code>
<code>}</code></pre>

Expand All @@ -807,6 +816,7 @@ <h3 property="schema:name" content="Notification Channel Data Model">Notificatio
<ul>
<li id="notify-channel-id">One <code>id</code> property to identify the notification channel.</li>
<li id="notify-channel-type">One <code>type</code> property to state the <a href="#notification-channel-types" rel="rdfs:seeAlso">notification channel type</a>.</li>
<li id="notify-channel-authScheme">One <code>authScheme</code> property to state the authentication scheme used for the channel.</li>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<li id="notify-channel-authScheme">One <code>authScheme</code> property to state the authentication scheme used for the channel.</li>
<li id="notify-channel-authScheme">One <code>authScheme</code> property to state the <a href="#authentication-scheme">authentication scheme</a> used for the channel.</li>

Copy link
Member

Choose a reason for hiding this comment

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

Curious.. is authScheme intended to be consumed by SubscriptionClient? Or towards recording what's currently in use (and for unspecified use)?

Is it required / what might not function if omitted?

Copy link
Member

@csarven csarven Jul 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I presume "None" will map to notify:None .. but we mean something like notify:AuthenticationSchemeIsNotUsed?

<li id="notify-topic">At least one <code rel="dcterms:subject" resource="http://www.w3.org/ns/solid/notifications#topic">topic</code> property to identify the resource that the notifications are about.</li>
<li id="notify-feature-types">Zero, one, or many properties stating a particular <a href="#notification-features" rel="rdfs:seeAlso">feature</a>.</li>
</ul>
Expand Down Expand Up @@ -840,6 +850,7 @@ <h3 property="schema:name" content="Notification Channel Data Model">Notificatio
<code> "type": "WebSocketChannel2023",</code>
<code> "topic": "https://example.org/guinan/profile",</code>
<code> "receiveFrom": "wss://websocket.example/d4cf3f19",</code>
<code> "authScheme": "CapabilityURL",</code>
<code> "startAt": "2023-01-01T07:00:00.000Z",</code>
<code> "endAt": "2023-01-01T09:00:00.000Z",</code>
<code> "rate": "PT5M",</code>
Expand Down