Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Context - Spring + OAuth2

...

Notes: Current implementation is specific to either Keycloak or Cognito flow, not necessarily generic to auth providers

Proposed TIS OAuth2 Flow - Stateful

To implement a more generic OAuth2 flow, the filter chain in the web security config will be changed to use the Spring Security oauth2Login provider as below:

...

  • Retrieve the appropriate claim from the token to be matched with the username in the profile service

  • Verify the user exists, and retrieve the user’s roles and principles for authorization

  • Set the calling service’s security context with the retrieved authorities (do we want to do this?)#

A high level idea of this can be seen below:

image-20241213-111227.pngImage Added

And an example implementation referring to real repositories/classes:

Drawio
mVer2
zoom1
simple0
inComment0
custContentId4450975911
pageId4450910534
lbox1
diagramDisplayNameUntitled Diagram-1732882607371.drawio
contentVer1
revision5
baseUrlhttps://hee-tis.atlassian.net/wiki
diagramNameUntitled Diagram-1732882607371.drawio
pCenter0
width1061.0000000000002
links
tbstyle
height656.5000000000003

A more specific example idea of a real implementation can be split into two parts:

...

  1. SharedAuthencticationSuccessHandler (implements AuthenticationSuccessHandler) (needs new name)

    • Instantiated with following dependencies/params:

      • SecurityContext(is this bad?) - for setting granted authorities

      • JwtUtil(another shared component, see below) - for decoding token to retrieve user details

      • UserDetailsService - for retrieving user details

    • Does the following in its onAuthenticationSuccessmethod:

      • Decodes token to find username (email) using JwtUtil

      • Fetches user details from UserDetailsService

      • Extracts granted authorities from UserInfo and sets them in SecurityContext

      • Authorization can now be performed on controllers etc within the calling service

  2. JwtUtil class (again, needs a better name)

    • Instantiated with the following dependencies/params:

      • jwkSetUri String configured as an application property

      • jwtIssuer String configured as an application property

      • usernameClaimString configured as an application property (this is because we use email as the username)

      • creates a NimbusJwtDecoder Bean from jwkSetUri and jwtIssuer

    • Does the following:

      • Method to retrieve the username from the token

    • UserDetailsService - Already exists, fetches user infor by user name

...

Given the above, each service receiving a token (e.g. profile) would need to be configured with the following application properties:

...

  • One Ticket to implement the new Shared Components (enough of a vertical slice?)

  • One Ticket per service to switch over configuration (possibly with different subtasks depending on authorization/redirect requirements of each service)

Tech Sharing 12/12/24

...

Login to cognito and grab a token somehow (browser, service logs/ whatever)

...

Close InCognito Browsers

...

Start User Management on your working branch

...

Open Postman

...

Send a request with the token in the Authorization header.

...

View file
nameOauthCognito_2.pptx