Skip to content

Commit b9b8903

Browse files
pgerhardrwinch
authored andcommitted
Documented dependencies opaque Resource Server
Extended the documentation for the opaque Resource Server in order to clearly state which dependencies are required in order for the minimal deployment to work. Replaced dead link for Contribute guidelines in README.adoc Closes gh-8391
1 parent 5cd1ec7 commit b9b8903

File tree

3 files changed

+18
-3
lines changed

3 files changed

+18
-3
lines changed

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring
5858
https://spring.io/services[Commercial support] is available too.
5959

6060
== Contributing
61-
https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.md[contributor guidelines] for details.
61+
https://help.github.com/articles/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.adoc[contributor guidelines] for details.
6262

6363
== License
6464
Spring Security is Open Source software released under the

docs/manual/src/docs/asciidoc/_includes/reactive/oauth2/resource-server.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ This authorization server can be consulted by resource servers to authorize requ
1414
A complete working example for {gh-samples-url}/boot/oauth2resourceserver-webflux[*JWTs*] is available in the {gh-samples-url}[Spring Security repository].
1515
====
1616

17-
== Dependencies
17+
[[webflux-oauth2resourceserver-jwt-minimaldependencies]]
18+
== Minimal Dependencies for JWT
1819

1920
Most Resource Server support is collected into `spring-security-oauth2-resource-server`.
2021
However, the support for decoding and verifying JWTs is in `spring-security-oauth2-jose`, meaning that both are necessary in order to have a working resource server that supports JWT-encoded Bearer Tokens.
@@ -549,6 +550,12 @@ ReactiveJwtDecoder jwtDecoder() {
549550
return jwtDecoder;
550551
}
551552
----
553+
[[webflux-oauth2resourceserver-opaque-minimaldependencies]]
554+
=== Minimal Dependencies for Introspection
555+
As described in <<oauth2resourceserver-jwt-minimaldependencies,Minimal Dependencies for JWT>> most of Resource Server support is collected in `spring-security-oauth2-resource-server`.
556+
However unless a custom <<webflux-oauth2resourceserver-opaque-introspector-bean,`ReactiveOpaqueTokenIntrospector`>> is provided, the Resource Server will fallback to ReactiveOpaqueTokenIntrospector.
557+
Meaning that both `spring-security-oauth2-resource-server` and `oauth2-oidc-sdk` are necessary in order to have a working minimal Resource Server that supports opaque Bearer Tokens.
558+
Please refer to `spring-security-oauth2-resource-server` in order to determin the correct version for `oauth2-oidc-sdk`.
552559

553560
[[webflux-oauth2resourceserver-opaque-minimalconfiguration]]
554561
=== Minimal Configuration for Introspection

docs/manual/src/docs/asciidoc/_includes/servlet/oauth2/oauth2-resourceserver.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ image:{icondir}/number_4.png[] If authentication is successful, then __Success__
5858
* The <<servlet-authentication-authentication>> is set on the <<servlet-authentication-securitycontextholder>>.
5959
* The `BearerTokenAuthenticationFilter` invokes `FilterChain.doFilter(request,response)` to continue with the rest of the application logic.
6060

61-
=== Dependencies for JWT
61+
[[oauth2resourceserver-jwt-minimaldependencies]]
62+
=== Minimal Dependencies for JWT
6263

6364
Most Resource Server support is collected into `spring-security-oauth2-resource-server`.
6465
However, the support for decoding and verifying JWTs is in `spring-security-oauth2-jose`, meaning that both are necessary in order to have a working resource server that supports JWT-encoded Bearer Tokens.
@@ -1052,6 +1053,13 @@ NOTE: Spring isn't a cache provider, so you'll need to make sure to include the
10521053
NOTE: Whether it's socket or cache timeouts, you may instead want to work with Nimbus directly.
10531054
To do so, remember that `NimbusJwtDecoder` ships with a constructor that takes Nimbus's `JWTProcessor`.
10541055

1056+
[[oauth2resourceserver-opaque-minimaldependencies]]
1057+
=== Minimal Dependencies for Introspection
1058+
As described in <<oauth2resourceserver-jwt-minimaldependencies,Minimal Dependencies for JWT>> most of Resource Server support is collected in `spring-security-oauth2-resource-server`.
1059+
However unless a custom <<oauth2resourceserver-opaque-introspector,`OpaqueTokenIntrospector`>> is provided, the Resource Server will fallback to NimbusOpaqueTokenIntrospector.
1060+
Meaning that both `spring-security-oauth2-resource-server` and `oauth2-oidc-sdk` are necessary in order to have a working minimal Resource Server that supports opaque Bearer Tokens.
1061+
Please refer to `spring-security-oauth2-resource-server` in order to determin the correct version for `oauth2-oidc-sdk`.
1062+
10551063
[[oauth2resourceserver-opaque-minimalconfiguration]]
10561064
=== Minimal Configuration for Introspection
10571065

0 commit comments

Comments
 (0)