From df2071550a237ad8903b19893f0b66b4850feefc Mon Sep 17 00:00:00 2001 From: Vedran Pavic Date: Thu, 12 Oct 2017 11:44:19 +0200 Subject: [PATCH 1/2] Fix Security OAuth2 Client documentation This commit fixes incorrect section level and sample configuration properties. [ci skip] --- .../src/main/asciidoc/spring-boot-features.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 8c137d9e006f..6b3f58530658 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -2753,7 +2753,7 @@ explicitly configure the paths that you do want to override. [[boot-features-security-oauth2]] === OAuth2 -=== Client +==== Client If you have `spring-security-oauth2-client` on your classpath you can take advantage of some auto-configuration to make it easy to set up an OAuth2 Client. This configuration makes use of the properties under `OAuth2ClientProperties`. @@ -2775,7 +2775,7 @@ You can register multiple OAuth2 clients and providers under the provider: my-oauth-provider scope: user redirect-uri: http://my-redirect-uri.com - authentication-method: basic + client-authentication-method: basic authorization-grant-type: authorization_code my-client2: client-id: abcd @@ -2784,7 +2784,7 @@ You can register multiple OAuth2 clients and providers under the provider: my-oauth-provider scope: email redirect-uri: http://my-redirect-uri.com - authentication-method: basic + client-authentication-method: basic authorization-grant-type: authorization_code provider: my-oauth-provider: From 092625391ee43d52d2c03f2a1383fe55e037141b Mon Sep 17 00:00:00 2001 From: Vedran Pavic Date: Thu, 12 Oct 2017 13:59:32 +0200 Subject: [PATCH 2/2] Use properties in Security OAuth2 Client doc config example [ci skip] --- .../main/asciidoc/spring-boot-features.adoc | 55 ++++++++----------- 1 file changed, 24 insertions(+), 31 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 6b3f58530658..305d9f6de1f6 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -2761,38 +2761,31 @@ makes use of the properties under `OAuth2ClientProperties`. You can register multiple OAuth2 clients and providers under the `spring.security.oauth2.client` prefix. For example: -[source,yaml,indent=0] +[source,properties,indent=0] ---- - spring: - security: - oauth2: - client: - registration: - my-client-1: - client-id: abcd - client-secret: password - client-name: Client for user scope - provider: my-oauth-provider - scope: user - redirect-uri: http://my-redirect-uri.com - client-authentication-method: basic - authorization-grant-type: authorization_code - my-client2: - client-id: abcd - client-secret: password - client-name: Client for email scope - provider: my-oauth-provider - scope: email - redirect-uri: http://my-redirect-uri.com - client-authentication-method: basic - authorization-grant-type: authorization_code - provider: - my-oauth-provider: - authorization-uri: http://my-auth-server/oauth/authorize - token-uri: http://my-auth-server/oauth/token - user-info-uri: http://my-auth-server/userinfo - jwk-set-uri: http://my-auth-server/token_keys - user-name-attribute: name + spring.security.oauth2.client.registration.my-client-1.client-id:=abcd + spring.security.oauth2.client.registration.my-client-1.client-secret=password + spring.security.oauth2.client.registration.my-client-1.client-name=Client for user scope + spring.security.oauth2.client.registration.my-client-1.provider=my-oauth-provider + spring.security.oauth2.client.registration.my-client-1.scope=user + spring.security.oauth2.client.registration.my-client-1.redirect-uri=http://my-redirect-uri.com + spring.security.oauth2.client.registration.my-client-1.client-authentication-method=basic + spring.security.oauth2.client.registration.my-client-1.authorization-grant-type=authorization_code + + spring.security.oauth2.client.registration.my-client-2.client-id=abcd + spring.security.oauth2.client.registration.my-client-2.client-secret=password + spring.security.oauth2.client.registration.my-client-2.client-name=Client for email scope + spring.security.oauth2.client.registration.my-client-2.provider=my-oauth-provider + spring.security.oauth2.client.registration.my-client-2.scope=email + spring.security.oauth2.client.registration.my-client-2.redirect-uri=http://my-redirect-uri.com + spring.security.oauth2.client.registration.my-client-2.client-authentication-method=basic + spring.security.oauth2.client.registration.my-client-2.authorization-grant-type=authorization_code + + spring.security.oauth2.client.provider.my-oauth-provider.authorization-uri=http://my-auth-server/oauth/authorize + spring.security.oauth2.client.provider.my-oauth-provider.token-uri=http://my-auth-server/oauth/token + spring.security.oauth2.client.provider.my-oauth-provider.user-info-uri=http://my-auth-server/userinfo + spring.security.oauth2.client.provider.my-oauth-provider.jwk-set-uri=http://my-auth-server/token_keys + spring.security.oauth2.client.provider.my-oauth-provider.user-name-attribute=name ---- NOTE: For common OAuth2 and OpenID providers such as Google, Github, Facebook and Okta,