Login & Auth Workflows
Single-Page Application OAuth Login Using Authorization Code Grant With Sessions And Refresh Tokens
By Brian Pontarelli
This workflow is used by single-page applications using the FusionAuth OAuth login interface. The single-page application navigates away from its interface and over to FusionAuth’s OAuth interface. Once the user completes their login, FusionAuth redirects back to the single-page application. This requires that the single-page application re-initialize itself, but the browser should cache the application files and be able to restart it quickly. Below is a diagram that describes the primary components of this workflow and how they interact. Keep in mind that not every interaction is covered here, just the primary login interactions. At the bottom of the diagram is a discussion of the key steps.
For all of our examples, we use a store and a forum for the same company. The store requires a user to login to view their shopping cart and the forum requires the user to login to view forum posts. We also provide a couple of example attack vectors that hackers could use if portions of the system are compromised. These cases might be theoretical or based on known exploits such as XSS (cross-site scripting).
Diagram
Legend
() --> request/response bodies
{} --> request parameters
[] --> cookies
Explanation
- The browser requests the shopping cart single-page application from the application backend
- The application backend responds with the HTML, CSS & JavaScript of the application
- The browser loads the application and as part of the initialization process, it makes a request to the application backend to see if the user is logged in
- The application backend responds with a 404 indicating the user is not logged in
- The user clicks the login link and the browser navigates away from the single-page application to FusionAuth's OAuth 2 interface. The browser requests the OAuth 2 login page from FusionAuth with a
response_type
of code indicating that it is using the authorization code grant - FusionAuth responds with the HTML, CSS & JavaScript of the login page (including the form)
- The user inputs their credentials and clicks the submit button. The browser
POST
s the form data to FusionAuth - FusionAuth returns a redirect to the application backend's OAuth 2
redirect_uri
. This redirect includes the authorization code from FusionAuth. Also, this response includes a session id for the FusionAuth OAuth 2 interface as an HTTP cookie. This cookie is HttpOnly, which prevents JavaScript from accessing it, making it less vulnerable to theft - The browser requests the application backend's OAuth
redirect_uri
with the authorization code from FusionAuth - The application backend calls FusionAuth's OAuth 2 token endpoint with the authorization code and optionally the
client_secret
- FusionAuth verifies the authorization code and
client_secret
. It returns a 200 along with a JWT and refresh token in JSON - The application backend receives the 200 from FusionAuth and creates a server-side session and stores the User object (or JWT) in it
- The application backend returns a redirect back to the single-page application. The id for the server-side session is written back to the browser in an HTTP cookie. The refresh token from FusionAuth is also written back to the browser in an HTTP cookie. These cookies are HttpOnly, which prevents JavaScript from accessing them, making them less vulnerable to theft. Additionally, all requests from the browser to the application backend will include these cookies so that the backend can retrieve the User object from the server-side session and refresh their session if it expires
- The browser requests the shopping cart single-page application from the application backend
- The application backend responds with the HTML, CSS & JavaScript of the application
- The browser loads the application and as part of the initialization process, it makes a request to the application backend to see if the user is logged in
- The application backend responds with a 200 and the User object (usually in JSON)
- The browser requests the user's shopping cart from the application backend via AJAX and includes the session and refresh token cookies
- The application backend looks up the server-side session associated with the session cookie and extends the expiration date
- The application backend loads the User object (or JWT) from the server-side session. The backend then looks up the user's shopping cart from the database (or similar location). Finally, the application backend returns the user's shopping cart contents (usually as JSON)
- A while later, the user's session expires and the user clicks on their shopping cart again. The browser requests the shopping cart from the application backend via AJAX and sends the session id and refresh token cookies to the application backend
- The application backend attempts to load the server-side session associated with session cookie and realizes it is expired. Since the browser also sent across the refresh token, the application backend calls the JWT refresh API in FusionAuth with the refresh token
- FusionAuth looks up the refresh token and returns a new JWT
- The application backend receives the 200 from FusionAuth and creates a server-side session and stores the User object (or JWT) in it
- The application backend responds with the user's shopping cart contents (usually as JSON). It also includes the new session id as a cookie that replaces the old session id in the browser
- A while later, the user's server-side session and refresh token both expire and the user clicks on their shopping cart again. The browser requests the shopping cart from the application backend via AJAX and sends the session and refresh token cookies to the application backend
- The application backend attempts to load the server-side session associated with session cookie and realizes it is expired. Since the browser also sent across the refresh token, the application backend calls the JWT refresh API in FusionAuth with the refresh token
- Since the refresh token has expired, FusionAuth returns a 404 status code
- Since FusionAuth returned a 404 status code, the application backend returns a 401 indicating that the user is no longer logged in
- At this point, the application can allow the user to log in the same way they did above
- The browser requests the forum single-page application from the application backend. This is a standard SSO login that is fully supported by FusionAuth
- The application backend responds with the HTML, CSS & JavaScript of the application
- The browser loads the application and as part of the initialization process, it makes a request to the application backend to see if the user is logged in
- The application backend responds with a 404 indicating the user is not logged in
- The user clicks the login link and the browser navigates away from the single-page application to FusionAuth's OAuth 2 interface. The browser requests the OAuth 2 login page from FusionAuth with a
response_type
of code indicating that it is using the authorization code grant. Additionally, the session cookie that was set during the first login is also sent by the browser to FusionAuth - FusionAuth realizes that the user already has a session and is already logged in. Therefore, it returns a redirect to the application backend's OAuth 2
redirect_uri
. This redirect includes the authorization code from FusionAuth - The browser requests the application backend's OAuth
redirect_uri
with the authorization code from FusionAuth - The application backend calls FusionAuth's OAuth 2 token endpoint with the authorization code and optionally the
client_secret
- FusionAuth verifies the authorization code and
client_secret
. It returns a 200 along with a JWT and refresh token in JSON. **NOTE**: all of this happens without any user interaction, hence the SSO nature of this login - The application backend receives the 200 from FusionAuth and creates a server-side session and stores the User object (or JWT) in it
- The application backend returns a redirect back to the single-page application. The id for the server-side session is written back to the browser in an HTTP cookie. The refresh token from FusionAuth is also written back to the browser in an HTTP cookie. These cookies are HttpOnly, which prevents JavaScript from accessing them, making them less vulnerable to theft. Additionally, all requests from the browser to the application backend will include these cookies so that the backend can retrieve the User object from the server-side session and refresh their session if it expires
- The browser requests the forums single-page application from the application backend
- The application backend responds with the HTML, CSS & JavaScript of the application
- The browser loads the application and as part of the initialization process, it makes a request to the application backend to see if the user is logged in
- The application backend responds with a 200 and the User object (usually in JSON)
- The browser requests the user's forum posts from the application backend via AJAX and includes the session and refresh token cookies
- The application backend looks up the server-side session associated with the session cookie and extends the expiration date
- The application backend loads the User object (or JWT) from the session associated with the session cookie. The backend then looks up the user's forum posts from the database (or similar location). Finally, the application backend returns the user's forum posts (usually as JSON)
- This is an attack vector where the attacker has stolen the user's refresh token. Here, the attacker requests the user's shopping cart with the stolen refresh token and an invalid session id
- The application backend verifies the session id and realizes it is invalid. Since the attacker also sent across the refresh token, the application backend calls the JWT refresh API in FusionAuth with the refresh token
- FusionAuth looks up the refresh token and returns a new JWT
- The application backend receives the 200 from FusionAuth and creates a server-side session and stores the User object (or JWT) in it
- The application backend uses the JWT to look up the user's shopping cart. It responds to the attacker with the user's shopping cart contents (usually as JSON). It also includes the new session id as a cookie that attacker can now use
- This is an attack vector where the attacker has stolen the user's session cookie. Here, the attacker requests the user's shopping cart with the stolen session cookie
- The application backend looks up the server-side session associated with the session cookie and extends the expiration date
- The application backend uses the session to look up the user's shopping cart. It responds to the attacker with the user's shopping cart contents (usually as JSON)
Security considerations
This is one the safest and most feature rich login workflow in FusionAuth. It has the benefit that passwords are only provided directly to FusionAuth. It also has the benefit of full SSO capabilities when the user is automatically logged into the forum application by FusionAuth. Also, the session and refresh tokens are HttpOnly cookies that are domain locked to the application backend that needs them. Plus, the User object (or JWT) is secured on the server inside a server-side session.
APIs used
Here are the FusionAuth APIs used in this example: