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

Add informative text defining use of proxy-to link relation type #1670

Closed
benfrancis opened this issue Aug 17, 2022 · 6 comments · Fixed by #1821
Closed

Add informative text defining use of proxy-to link relation type #1670

benfrancis opened this issue Aug 17, 2022 · 6 comments · Fixed by #1821
Assignees
Labels
Editorial Issues with no technical impact on implementations Review for CR transition Security

Comments

@benfrancis
Copy link
Member

First raised in #1324.

The proxy-to link relation type recommended in the table in section 5.3.4.1 Link is not defined anywhere.

The table references the W3C WoT Security and WoT Binding Templates documents, but I can't find a definition in either of them.

Unless a definition can be found (or added to the WoT Thing Description specification), I suggest removing this line from the table.

@github-actions github-actions bot added the needs-triage Automatically added to new issues. TF should triage them with proper labels label Aug 17, 2022
@sebastiankb
Copy link
Contributor

@mmccool would be this ok or should we keep it, since we have it also in TD 1.0?

@sebastiankb sebastiankb removed the needs-triage Automatically added to new issues. TF should triage them with proper labels label Sep 12, 2022
@sebastiankb
Copy link
Contributor

based on yesterday's discussion: label it as at-risk and if there is no veto during CR phase we will remove it

@mmccool
Copy link
Contributor

mmccool commented Sep 21, 2022

OK with that, but we probably do need to add some informative text if we keep it, to avoid ambiguity with "proxy" field in securityDefinitions. Probably this link type should be used in "virtual Things" acting as a proxy/shadow for another thing.

@mmccool mmccool changed the title The proxy-to link relation type is not defined anywhere Add informative text defining use of proxy-to link relation type Sep 21, 2022
@mmccool mmccool added the Editorial Issues with no technical impact on implementations label Sep 21, 2022
@mmccool mmccool self-assigned this Sep 21, 2022
@mmccool
Copy link
Contributor

mmccool commented Sep 26, 2022

The Security TF is looking at this, but we did not get to it this week, and next week the mtg will be cancelled due to the plugfest. However, I will explicitly put it on the agenda for the week after next.

@mmccool
Copy link
Contributor

mmccool commented Oct 10, 2022

Discussion (Security TF 2022.10.10)

  • Security TF Members still need to look at it in more depth... if they have more comments they can add them here, these should be considered my thoughts for now, although we did discuss this issue in the meeting and took a look at the existing text in the TD spec.
  • First approximation: both make sense and can be used together.
    • The "proxy-to" link indicates WHAT is being proxied
    • The "proxy" field in the security scheme is used to provide security metadata for the proxy itself, e.g. what kind of authentication is needed, that is, HOW to connect to the proxy itself.
    • So if you do have a proxy, you could reasonably use both.
  • We do lack even one implementation, however, let alone two. However, Intel implemented a proxy service and could provide at least one that also uses proxy-to.
  • HOWEVER: This table itself is not part of an assertion, and each row in the table is NOT marked as an assertion.
    • Therefore we have no test data for these, and I expect that if we did a lot of the others would also be at-risk.
    • My understanding was that this table was a list of example values for the rel field in link, but was not a closed set (e.g. others could be used).
    • However, the text right before the table uses the word "recommended" but it is not an RFC2119 assertion. So we could also change this text to say "for example" instead of "recommended" if we are not going to use assertions here.
    • At this point I think it is impractical to convert every row in this table to an assertion.
  • The last point said, some informative text would be helpful for proxy-to, e.g. in the table, comparing it to "proxy" in the SecurityScheme.
    • Something like the following additional sentence could be added to the description of "proxy-to" in the table: "Additional security metadata may be provided using the "proxy" field in a SecurityScheme."

@sebastiankb
Copy link
Contributor

@mmccool

The last point said, some informative text would be helpful for proxy-to, e.g. in the table, comparing it to "proxy" in the SecurityScheme.

are you going to provide a PR for it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Editorial Issues with no technical impact on implementations Review for CR transition Security
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants