-
Notifications
You must be signed in to change notification settings - Fork 12
Add scope diagrams section with C4 Level 1 and Level 2 diagrams #159
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
Open
jeremycaine
wants to merge
1
commit into
w3c:main
Choose a base branch
from
jeremycaine:scope-diagrams
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # LWS Protocol — System Context (C4 Level 1) | ||
|
|
||
| ```mermaid | ||
| C4Context | ||
| title LWS Protocol — system context | ||
|
|
||
| Person(user, "User", "Person accessing resources") | ||
| System(client, "Client application", "Requests and manages resources") | ||
| System(lws, "LWS server", "Manages resource hierarchy and access") | ||
| System_Ext(idp, "Identity provider", "Issues signed credentials") | ||
| System_Ext(ext, "External resources", "Web resources under management") | ||
|
|
||
| Rel(user, client, "uses") | ||
| Rel(client, lws, "HTTP requests") | ||
| Rel(lws, idp, "validates credential") | ||
| Rel(lws, ext, "mediates access to") | ||
| ``` | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,27 @@ | ||||||
| # LWS Protocol — Container Diagram (C4 Level 2) | ||||||
|
|
||||||
| ```mermaid | ||||||
| C4Container | ||||||
| title LWS Protocol — container diagram | ||||||
|
|
||||||
| Person(user, "User", "Person accessing resources") | ||||||
| System(client, "Client application", "Requests and manages resources") | ||||||
| System_Ext(idp, "Identity provider", "Issues signed credentials") | ||||||
| System_Ext(ext, "External resources", "Web resources under management") | ||||||
|
|
||||||
| Boundary(lws, "LWS server") { | ||||||
| Container(authn, "Authentication", "Validates credential against identity provider") | ||||||
| Container(authz, "Authorization", "Enforces resource manager access decisions") | ||||||
| Container(rm, "Resource Management", "Manages containers, containment and linksets") | ||||||
| Container(era, "External Resource Access", "Mediates access to external web resources") | ||||||
| } | ||||||
|
|
||||||
| Rel(user, client, "uses") | ||||||
| Rel(client, authn, "presents credential") | ||||||
| Rel(authn, idp, "validates credential") | ||||||
| Rel(authn, authz, "confirmed identity") | ||||||
| Rel(authz, rm, "permitted operation") | ||||||
| Rel(rm, era, "resolves resource") | ||||||
| Rel(era, ext, "accesses") | ||||||
| ``` | ||||||
| Issue: The internal organisation of container, containment and linkset management within the LWS server is not yet defined in the protocol. This diagram reflects current terminology and is subject to revision. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -171,8 +171,36 @@ <h2>Security and Privacy</h2> | |||||
| A <dfn>LWS Client</dfn> is an HTTP client [[!rfc9112]] that complies with all of the relevant "MUST" statements in this specification. Specifically, the relevant normative "MUST" statements in <a href="#operations"></a> of this document MUST be respected. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| </p> | ||||||
| </section> | ||||||
| </section> | ||||||
|
|
||||||
| <section id="scope-diagrams"> <!-- becomes 2.4 Scope Diagrams --> | ||||||
| <h2>Scope Diagrams</h2> | ||||||
| <p> | ||||||
| The following diagrams are platform-independent models | ||||||
| to guide implementation. | ||||||
| </p> | ||||||
| <p> | ||||||
| Figure 1 shows the System Context, identifying the user, the systems | ||||||
| that interact with a compliant LWS server, and the external systems on | ||||||
| which the protocol depends. | ||||||
| </p> | ||||||
| <figure id="fig-1-system-context"> | ||||||
| <img src="diagrams/fig-1-system-context.svg" | ||||||
| alt="LWS Protocol system context diagram showing the user, client application, LWS server, identity provider, and external resources"/> | ||||||
| <figcaption>LWS Protocol — system context (C4 Level 1)</figcaption> | ||||||
| </figure> | ||||||
| <p> | ||||||
| Figure 2 shows the Container Diagram, describing the protocol-level | ||||||
| responsibilities within a compliant LWS server and the relationships | ||||||
| between them. | ||||||
| </p> | ||||||
| <figure id="fig-2-container-diagram"> | ||||||
| <img src="diagrams/fig-2-container-diagram.svg" | ||||||
| alt="LWS Protocol container diagram showing authentication, authorization, resource management, and external resource access within the LWS server boundary"/> | ||||||
| <figcaption>LWS Protocol — container diagram (C4 Level 2)</figcaption> | ||||||
| </figure> | ||||||
| </section> | ||||||
|
|
||||||
| </section> | ||||||
| <section id="terminology"> | ||||||
| <h2>Terminology</h2> | ||||||
| <p> | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean by "external resources"? Are these the same as the "LWS resources" we defined in the terminology? If so, it might be best to re-use that term.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.