https://github.com/swisscom/sample-uaa-spring-boot-service-provider
https://github.com/swisscom/sample-uaa-spring-boot-service-provider
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/swisscom/sample-uaa-spring-boot-service-provider
- Owner: swisscom
- License: apache-2.0
- Created: 2016-07-19T10:44:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T15:19:17.000Z (over 1 year ago)
- Last Synced: 2025-04-15T10:18:03.354Z (about 1 year ago)
- Language: Java
- Size: 24.4 KB
- Stars: 4
- Watchers: 36
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Sample Spring boot OAuth2 service provider for UAA
Demo app that authenticates its users against an OAuth2 provider (i.e. UAA) using the `authorization code` grant type,
meaning this app will store the session (and JWT) in its backend.
It uses Spring boot and Spring security (based on https://github.com/spring-guides/tut-spring-boot-oauth2).
It is primarily designed to run on CloudFoundry, since it expects the OAuth2 configuration to be passed in `VCAP_SERVICES.
## How it works
When the app is accessed by an unauthenticated user, it redirects the user to the OAuth2 provider (standard OAuth2 `Authorization code` flow).
When the user logs in on the OAuth2 provider, he is redirected back to the app.
The app completes the OAuth2 flow and receives the user's info (using the Userinfo endpoint), i.e. its attributes like firstname, lastname.
It was tested with [UAA](https://github.com/cloudfoundry/uaa) acting as OAuth2 provider, but should work fine with other providers (i.e. Facebook, Github etc.).
## Configure, deploy and test
The app expects a `VCAP_SERVICES` env variable containing a service with a tag `oauth2` or a `credentials` with a key `authorizationEndpointUrl`,
so make sure it is set when running the app.
When deploying to CloudFoundry, one can use a [User provided service instance](https://docs.cloudfoundry.org/devguide/services/user-provided.html) to achieve this.
Full example:
```
# compile & push the app
mvn clean package
cf push oauth2-simple --random-route --no-start -p target/oauth2-simple-0.0.1-SNAPSHOT.jar
# Now create the user provided service which will be provided to the app in VCAP_SERVICES.
# The client specified here must be created manually beforehand on the OAuth2 provider.
CREDENTIALS='{"authorizationEndpoint": "/oauth/authorize", "tokenEndpoint": "/oauth/token", "userInfoEndpoint": "/userinfo", "logoutEndpoint": "/logout.do", "clientId": "", "clientSecret": ""}'
cf create-user-provided-service OAUTH2-CLIENT -p $CREDENTIALS -t oauth2
# Bind & start the app to make the service instance available
cf bind-service oauth2-simple OAUTH2-CLIENT
cf start oauth2-simple
```
Now access the app in your browser, which redirects you to the UAA/OAuth2 provider you specified in the configuration.
After login, the user attributes passed to the app will be shown:
```
{
"details":
{
"user_id":"e814ddc8-1b28-422f-b34a-1aa0c97beb31",
"user_name":"jdoe",
"given_name":"John",
"family_name":"Doe",
"email":"john.doe@example.com",
"name":"John Doe"
},
"authorities":[{"authority":"ROLE_USER"}],
"authenticated":true,
"principal":"e814ddc8-1b28-422f-b34a-1aa0c97beb31",
"credentials":"N/A",
"name":"e814ddc8-1b28-422f-b34a-1aa0c97beb31"
}
```
## Sample overview
### Authorization code
- Service provider (Spring boot): https://github.com/swisscom/sample-uaa-spring-boot-service-provider
- Service provider (Ruby): https://github.com/swisscom/sample-uaa-ruby-service-provider
### Implicit flow & Client Credentials
> **_WARNING:_** [PKCE's](https://oauth.net/2/pkce/) secure implementation renders the implicit flow obsolete, as it is [vulnerable](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#section-2.1.2) and must not be used anymore.
- Client (VueJS): https://github.com/swisscom/sample-uaa-vue-client
- Client (React & Redux):https://github.com/swisscom/sample-uaa-react-redux-client
- Client (AngularJS): https://github.com/swisscom/sample-uaa-angular-client
- Resource Server (Spring boot): https://github.com/swisscom/sample-uaa-spring-boot-resource-server
- Resource Server (Ruby): https://github.com/swisscom/sample-uaa-ruby-resource-server