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

Unclear portion of openIdConnectUrl for openIdConnect securitySchema #3152

Closed
shiup opened this issue Jan 27, 2023 · 10 comments
Closed

Unclear portion of openIdConnectUrl for openIdConnect securitySchema #3152

shiup opened this issue Jan 27, 2023 · 10 comments
Labels
bug security: auth Authentication including overlap with authorization security
Milestone

Comments

@shiup
Copy link

shiup commented Jan 27, 2023

https://spec.openapis.org/oas/v3.1.0

Security Scheme Object
Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06).

the link above points to oauth discovery.

Does it apply to the openIdConnectUrl for openIdConnect securitySchema ? Should the openIdConnectUrl be driven by https://openid.net/specs/openid-connect-discovery-1_0.html ?

image

Please help clarify, thanks

@handrews
Copy link
Member

This just seems like a bug where the link is wrong. If the link for openIdConnect did not point to OAuth would this otherwise be clear?

@handrews handrews added the security: auth Authentication including overlap with authorization label Feb 1, 2024
@AxelNennker
Copy link
Contributor

I think the link should be replaced

Security Scheme Object
Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html).

@handrews
Copy link
Member

@AxelNennker if you'd like to submit a PR that would be welcome! It would need to start on the v3.0.4-dev branch, on the versions/3.0.4.md file. Then it will get propagated to 3.1.1 and 3.2.0.

shilpa-padgaonkar added a commit to shilpa-padgaonkar/OpenAPI-Specification that referenced this issue Feb 24, 2024
shilpa-padgaonkar added a commit to shilpa-padgaonkar/OpenAPI-Specification that referenced this issue Feb 24, 2024
@handrews handrews added this to the v3.0.4 milestone May 22, 2024
@handrews
Copy link
Member

I think the only thing left to do here is to forward-port the change to v3.1.1 and v3.2.0, correct?

@AxelNennker
Copy link
Contributor

Yes

@handrews
Copy link
Member

handrews commented May 23, 2024

@AxelNennker @shilpa-padgaonkar: In 3.1.1 it looks like the draft IETF RFC you replaced was already replaced by RFC 8414. Is it still appropriate to replace 8414 with what you did in 3.0.4? (I'm guessing yes, but I was just going to blind-port the commit and don't have the slightest clue how any of this stuff works or time to learn it right now)

@AxelNennker
Copy link
Contributor

I think I would have the 3.1.1 text in all versions:

openIdConnectUrl string openIdConnect REQUIRED. Well-known URL to discover the OpenID provider metadata.

handrews pushed a commit to handrews/OpenAPI-Specification that referenced this issue Jun 3, 2024
Fixes OAI#3152

Signed-off-by: Henry H. Andrews <andrews_henry@yahoo.com>
@handrews
Copy link
Member

handrews commented Jun 3, 2024

@AxelNennker ah, that change was PR #3718, and thanks for reminding me because it needs to be backported to 3.0.4. I was asking about PR #3607 for this issue.

@AxelNennker
Copy link
Contributor

Yes, #3607 should be in all version since openidConnectUrl was introduced to OAI

handrews pushed a commit to handrews/OpenAPI-Specification that referenced this issue Jun 4, 2024
Fixes OAI#3152

Signed-off-by: Henry H. Andrews <andrews_henry@yahoo.com>
handrews pushed a commit to handrews/OpenAPI-Specification that referenced this issue Jun 6, 2024
Fixes OAI#3152

Signed-off-by: Henry H. Andrews <andrews_henry@yahoo.com>
@handrews
Copy link
Member

PRs merged for 3.0.4, 3.1.1, and 3.2.0!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug security: auth Authentication including overlap with authorization security
Projects
None yet
Development

No branches or pull requests

3 participants