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

The "body" location value for security schemes is underspecified #1037

Closed
mmccool opened this issue Jan 20, 2021 · 3 comments · Fixed by #1058
Closed

The "body" location value for security schemes is underspecified #1037

mmccool opened this issue Jan 20, 2021 · 3 comments · Fixed by #1058
Labels
Security security-tracker Group bringing to attention of security, or tracked by the security Group but not needing response.

Comments

@mmccool
Copy link
Contributor

mmccool commented Jan 20, 2021

When a security key is embedded in the body of a message (eg as a POST) it will typically be part of a larger structured payload, so a data schema is required and the identification of a particular element in that schema as the key (or other elements, there might be more than one, i.e. a client id AND a key) is needed. This needs to be clarified in the definition of the "body" location specifier in security schemes.

@mmccool mmccool changed the title The "body" location value for security schemes is underspecfied The "body" location value for security schemes is underspecified Jan 20, 2021
@mmccool mmccool added Security security-needs-resolution Issue the security Group has raised and looks for a response on. labels Jan 20, 2021
@mmccool
Copy link
Contributor Author

mmccool commented Jan 20, 2021

One option here is to allow use of "name" for "body" to allow identification of a data schema element. Note however this is not currently a required element for body (so we can't make it mandatory without breaking backward compatibility in 1.1). Also, "name" is only one element, so does not allow for multiple values. Another approach would be to annotate the data schema with semantic types to identify the keys, client ids, and so forth, which might also be applicable to the uri template location mechanism.

@egekorkan
Copy link
Contributor

egekorkan commented Jan 20, 2021

to refer to the specific parts of the body, we can use JSON Pointers

@mmccool mmccool added Propose closing Problem will be closed shortly if there is no veto. and removed security-needs-resolution Issue the security Group has raised and looks for a response on. labels Feb 17, 2021
@mmccool
Copy link
Contributor Author

mmccool commented Feb 17, 2021

Propose closing, BUT maybe want to follow up on JSON Pointers idea mentioned by Ege. Issue is "name" needs to refer to a particular element of a data schema (but, over several different data schemas, so would be relative to the top of each schema). A small edit to the current spec that says the name is a JSON Pointer relative to the top of the data schema might be appropriate. I can do a PR if people agree, and then we can close this.

@w3cbot w3cbot added the security-needs-resolution Issue the security Group has raised and looks for a response on. label Feb 17, 2021
@sebastiankb sebastiankb removed the Propose closing Problem will be closed shortly if there is no veto. label Mar 10, 2021
@plehegar plehegar added security-tracker Group bringing to attention of security, or tracked by the security Group but not needing response. and removed security-needs-resolution Issue the security Group has raised and looks for a response on. labels Oct 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Security security-tracker Group bringing to attention of security, or tracked by the security Group but not needing response.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants