-
-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
327 changed files
with
3,450 additions
and
6,372 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Migration Guide from 6.x to 7.0.0 | ||
|
|
||
| ## Dependencies | ||
| - replace any spring-addons starter with `com.c4-soft.springaddons:spring-addons-starter-oidc` | ||
| - replace any spring-addons test starter with `com.c4-soft.springaddons:spring-addons-starter-oidc-test` | ||
| - depending or your needs, add a dependency to | ||
| * `org.springframework.boot:spring-boot-starter-oauth2-resource-server` for a REST API secured with access tokens | ||
| * `org.springframework.boot:spring-boot-starter-oauth2-client` when configuring `spring-cloud-gateway` as BFF or exposing server-side rendered templates with frameworks like Thymeleaf | ||
| * both of above when exposing publicly both a REST API secured with access tokens and other resources secured with sessions | ||
|
|
||
| ## Java Sources | ||
|
|
||
| ### Main Code | ||
| - rename `SpringAddonsSecurityProperties` to `SpringAddonsOidcProperties`. Also, if using nested properties, rename | ||
| * `getIssuers()` to `getOps()` | ||
| * `getLocation()` to `getIss()` | ||
| - replace `SpringAddonsOAuth2ClientProperties` with `SpringAddonsOidcProperties::getClient` (only `SpringAddonsOidcProperties` can be autowired) | ||
| - organize imports | ||
|
|
||
| ### Tests | ||
| - replace `@AutoConfigureAddonsSecurity` with `@AutoConfigureAddonsMinimalSecurity` | ||
| - replace `@AutoConfigureAddonsWebSecurity` with one of: | ||
| * `@AutoConfigureAddonsWebmvcSecurity` | ||
| * `@AutoConfigureAddonsWefluxSecurity` | ||
|
|
||
| ## Application Properties | ||
| This is probably the most tedious part of the migration. Hopefully, your IDE auto-completion and syntax highliting should help you there. | ||
|
|
||
| ### Common Configuration | ||
| - rename `com.c4-soft.springaddons.security` to `com.c4-soft.springaddons.oidc` | ||
| - rename `issuers` to `ops` which stands for OpenID Providers (`com.c4-soft.springaddons.security.issuers` becomes `com.c4-soft.springaddons.oidc.ops`) | ||
| - rename OpenID Providers `location` to `iss`: if set, the is used to add an "issuer" (tokens `iss` claim) validator to JWT decoder (`com.c4-soft.springaddons.security.issuers[].location` becomes `com.c4-soft.springaddons.oidc.ops[].iss`) | ||
| - rename`audience` to `aud`: if set, the is used to add an "audience" (tokens `aud` claim) validator to JWT decoder (`com.c4-soft.springaddons.security.issuers[].aud` becomes `com.c4-soft.springaddons.oidc.ops[].aud`) | ||
|
|
||
| CORS configuration has also improved for both clients and resource servers: `allowed-origin-patterns` is used instead of `allowed-origins`. This is a requirement for using `allow-credentials` and is also more flexible: you can define ant patterns like `https://*.my-domain.pf`. | ||
| - rename `allowed-origins` to `allowed-origin-patterns` | ||
| - add `allow-credentials` and `max-age` if it makes sens (this are added configuration options) | ||
|
|
||
| ### Resource Servers | ||
| Resource server `Security(Web)FilterChain` can now be completely disabled with `com.c4-soft.springaddons.security.resourceserver.enabled=false` | ||
|
|
||
| Resource server specific properties are grouped in a new `resourceserver` subset: | ||
| - move `cors` down 1 level into `resourceserver` (`com.c4-soft.springaddons.security.cors` becomes `com.c4-soft.springaddons.security.resourceserver.cors`) | ||
| - move `permit-all` down one level to `resourceserver` (`com.c4-soft.springaddons.security.permit-all` becomes `com.c4-soft.springaddons.security.resourceserver.permit-all`) | ||
|
|
||
| ### Clients | ||
| - rename `allowed-origins` to `allowed-origin-patterns` (`com.c4-soft.springaddons.security.client.cors.allowed-origins` becomes `com.c4-soft.springaddons.security.client.cors.allowed-origin-patterns`) |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,7 +29,7 @@ | |
| <connection>scm:git:git://github.com/ch4mpy/spring-addons.git</connection> | ||
| <developerConnection>scm:git:[email protected]:ch4mpy/spring-addons.git</developerConnection> | ||
| <url>https://github.com/ch4mpy/spring-addons</url> | ||
| <tag>spring-addons-6.1.14</tag> | ||
| <tag>HEAD</tag> | ||
| </scm> | ||
|
|
||
| <distributionManagement> | ||
|
|
@@ -101,88 +101,15 @@ | |
| <artifactId>spring-addons-oauth2-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-web-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webmvc-core</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webmvc-introspecting-resource-server</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webmvc-jwt-resource-server</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webmvc-client</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webflux-core</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webflux-introspecting-resource-server</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webflux-jwt-resource-server</artifactId> | ||
| <artifactId>spring-addons-starter-oidc</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webflux-client</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webmvc-introspecting-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webmvc-jwt-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webmvc-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webflux-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webflux-introspecting-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-webflux-jwt-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>com.c4-soft.springaddons</groupId> | ||
| <artifactId>spring-addons-keycloak</artifactId> | ||
| <artifactId>spring-addons-starter-oidc-test</artifactId> | ||
| <version>${project.version}</version> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
@@ -392,12 +319,11 @@ | |
| <profile> | ||
| <id>release</id> | ||
| <modules> | ||
| <module>starters</module> | ||
| <module>spring-addons-oauth2</module> | ||
| <module>spring-addons-web-test</module> | ||
| <module>spring-addons-oauth2-test</module> | ||
| <module>webmvc</module> | ||
| <module>webflux</module> | ||
| <module>spring-addons-starter-oidc</module> | ||
| <module>spring-addons-starter-oidc-test</module> | ||
| <module>starters</module> | ||
| </modules> | ||
| <build> | ||
| <plugins> | ||
|
|
@@ -432,12 +358,11 @@ | |
| <activeByDefault>true</activeByDefault> | ||
| </activation> | ||
| <modules> | ||
| <module>starters</module> | ||
| <module>spring-addons-oauth2</module> | ||
| <module>spring-addons-web-test</module> | ||
| <module>spring-addons-oauth2-test</module> | ||
| <module>webmvc</module> | ||
| <module>webflux</module> | ||
| <module>spring-addons-starter-oidc</module> | ||
| <module>spring-addons-starter-oidc-test</module> | ||
| <module>starters</module> | ||
| <module>samples</module> | ||
| </modules> | ||
| </profile> | ||
|
|
||
This file contains 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
This file contains 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
Oops, something went wrong.