DRAFT: [jaxrs-spec][quarkus] Emit @Authenticated for HTTP Basic, Bearer, api-key and OAuth2 or OpenID with empty scopes#23680
Draft
Ignacio-Vidal wants to merge 5 commits intoOpenAPITools:masterfrom
Conversation
7479247 to
5daad84
Compare
5daad84 to
9b2aa6e
Compare
Contributor
There was a problem hiding this comment.
1 issue found across 17 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="quarkus-security-github-issue.md">
<violation number="1" location="quarkus-security-github-issue.md:59">
P1: OpenAPI scope requirements are conjunctive, but this mapping uses `@RolesAllowed` OR semantics and can under-enforce multi-scope authorization.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| | `apiKey` | `@Authenticated` | An API key validates identity only. No role check is applicable. | | ||
| | `oauth2` with empty scopes (`[]`) | `@Authenticated` | An empty scope list means "any authenticated user" — no specific authorization is required beyond a valid token. | | ||
| | `openIdConnect` with empty scopes (`[]`) | `@Authenticated` | Same reasoning as OAuth2 with empty scopes. | | ||
| | `oauth2` with explicit scopes | `@RolesAllowed({"scope1", "scope2"})` | In Quarkus, OAuth2/OIDC token scopes are mapped to `SecurityIdentity` roles. `@RolesAllowed` receives the scopes as role names. | |
Contributor
There was a problem hiding this comment.
P1: OpenAPI scope requirements are conjunctive, but this mapping uses @RolesAllowed OR semantics and can under-enforce multi-scope authorization.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At quarkus-security-github-issue.md, line 59:
<comment>OpenAPI scope requirements are conjunctive, but this mapping uses `@RolesAllowed` OR semantics and can under-enforce multi-scope authorization.</comment>
<file context>
@@ -0,0 +1,209 @@
+| `apiKey` | `@Authenticated` | An API key validates identity only. No role check is applicable. |
+| `oauth2` with empty scopes (`[]`) | `@Authenticated` | An empty scope list means "any authenticated user" — no specific authorization is required beyond a valid token. |
+| `openIdConnect` with empty scopes (`[]`) | `@Authenticated` | Same reasoning as OAuth2 with empty scopes. |
+| `oauth2` with explicit scopes | `@RolesAllowed({"scope1", "scope2"})` | In Quarkus, OAuth2/OIDC token scopes are mapped to `SecurityIdentity` roles. `@RolesAllowed` receives the scopes as role names. |
+| `openIdConnect` with explicit scopes | `@RolesAllowed({"scope1"})` | Same as OAuth2 with scopes. |
+| OR list with at least one empty-scope scheme | `@Authenticated` | The least restrictive alternative dominates: if any scheme allows any authenticated user, the effective gate is authentication only. |
</file context>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is part of #23691 to improve the support for Authentication and Authorisation in the jaxrx-spec/quarkus server generator.
It emits
@io.quarkus.security.Authenticatedon JAX-RS interface methods and implementation stubs when an operation security has either:PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Emit
@io.quarkus.security.Authenticatedon Quarkus JAX-RS endpoints that require authentication without scopes, so generated APIs enforce auth but not role scopes. Supports OAuth2/OpenID with empty scopes,basic,bearer, andapiKey, handles multi-flow and mixed OR lists, and respects global security with per-operation overrides; gated byuseQuarkusSecurityAnnotations.x-quarkus-authenticatedinJavaJAXRSSpecServerCodegen(viashouldAddAuthenticatedAnnotation) and render inapiInterface.mustacheandapiMethod.mustache.apiKey, mixed-type OR, and global security withsecurity: []overrides; covers interface-only and implementation stubs and ensures a single annotation per method.Written for commit 0e19ebe. Summary will update on new commits.