README.adoc 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. = OAuth 2.0 Resource Server Sample
  2. This sample demonstrates integrating Resource Server with a mock Authorization Server, though it can be modified to integrate
  3. with your favorite Authorization Server.
  4. With it, you can run the integration tests or run the application as a stand-alone service to explore how you can
  5. secure your own service with OAuth 2.0 Bearer Tokens using Spring Security.
  6. == 1. Running the tests
  7. To run the tests, do:
  8. ```bash
  9. ./gradlew integrationTest
  10. ```
  11. Or import the project into your IDE and run `ServerOAuth2ResourceServerApplicationTests` from there.
  12. === What is it doing?
  13. By default, the tests are pointing at a mock Authorization Server instance.
  14. The tests are configured with a set of hard-coded tokens originally obtained from the mock Authorization Server,
  15. and each makes a query to the Resource Server with their corresponding token.
  16. The Resource Server subsquently verifies with the Authorization Server and authorizes the request, returning the phrase
  17. ```bash
  18. Hello, subject!
  19. ```
  20. where "subject" is the value of the `sub` field in the JWT returned by the Authorization Server.
  21. == 2. Running the app
  22. To run as a stand-alone application, do:
  23. ```bash
  24. ./gradlew bootRun
  25. ```
  26. Or import the project into your IDE and run `ServerOAuth2ResourceServerApplication` from there.
  27. Once it is up, you can use the following token:
  28. ```bash
  29. export TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJzdWJqZWN0IiwiZXhwIjo0NjgzODA1MTI4fQ.ULEPdHG-MK5GlrTQMhgqcyug2brTIZaJIrahUeq9zaiwUSdW83fJ7W1IDd2Z3n4a25JY2uhEcoV95lMfccHR6y_2DLrNvfta22SumY9PEDF2pido54LXG6edIGgarnUbJdR4rpRe_5oRGVa8gDx8FnuZsNv6StSZHAzw5OsuevSTJ1UbJm4UfX3wiahFOQ2OI6G-r5TB2rQNdiPHuNyzG5yznUqRIZ7-GCoMqHMaC-1epKxiX8gYXRROuUYTtcMNa86wh7OVDmvwVmFioRcR58UWBRoO1XQexTtOQq_t8KYsrPZhb9gkyW8x2bAQF-d0J0EJY8JslaH6n4RBaZISww
  30. ```
  31. And then make this request:
  32. ```bash
  33. curl -H "Authorization: Bearer $TOKEN" localhost:8080
  34. ```
  35. Which will respond with the phrase:
  36. ```bash
  37. Hello, subject!
  38. ```
  39. where `subject` is the value of the `sub` field in the JWT returned by the Authorization Server.
  40. Or this:
  41. ```bash
  42. export TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJzdWJqZWN0Iiwic2NvcGUiOiJtZXNzYWdlOnJlYWQiLCJleHAiOjQ2ODM4MDUxNDF9.h-j6FKRFdnTdmAueTZCdep45e6DPwqM68ZQ8doIJ1exi9YxAlbWzOwId6Bd0L5YmCmp63gGQgsBUBLzwnZQ8kLUgUOBEC3UzSWGRqMskCY9_k9pX0iomX6IfF3N0PaYs0WPC4hO1s8wfZQ-6hKQ4KigFi13G9LMLdH58PRMK0pKEvs3gCbHJuEPw-K5ORlpdnleUTQIwINafU57cmK3KocTeknPAM_L716sCuSYGvDl6xUTXO7oPdrXhS_EhxLP6KxrpI1uD4Ea_5OWTh7S0Wx5LLDfU6wBG1DowN20d374zepOIEkR-Jnmr_QlR44vmRqS5ncrF-1R0EGcPX49U6A
  43. curl -H "Authorization: Bearer $TOKEN" localhost:8080/message
  44. ```
  45. Will respond with:
  46. ```bash
  47. secret message
  48. ```
  49. == 2. Testing against other Authorization Servers
  50. _In order to use this sample, your Authorization Server must support JWTs that either use the "scope" or "scp" attribute._
  51. To change the sample to point at your Authorization Server, simply find this property in the `application.yml`:
  52. ```yaml
  53. spring:
  54. security:
  55. oauth2:
  56. resourceserver:
  57. jwt:
  58. jwk-set-uri: ${mockwebserver.url}/.well-known/jwks.json
  59. ```
  60. And change the property to your Authorization Server's JWK set endpoint:
  61. ```yaml
  62. spring:
  63. security:
  64. oauth2:
  65. resourceserver:
  66. jwt:
  67. jwk-set-uri: https://dev-123456.oktapreview.com/oauth2/default/v1/keys
  68. ```
  69. And then you can run the app the same as before:
  70. ```bash
  71. ./gradlew bootRun
  72. ```
  73. Make sure to obtain valid tokens from your Authorization Server in order to play with the sample Resource Server.
  74. To use the `/` endpoint, any valid token from your Authorization Server will do.
  75. To use the `/message` endpoint, the token should have the `message:read` scope.