Welcome to this lesson on Session-Based Authentication. In the previous lesson, we explored API authentication using API keys, focusing on how these keys act as a passcode for gaining access to protected endpoints. Here, we take a step further and explore session-based authentication, a method where the server maintains user session information, providing a stateful experience.

Unlike API keys, which are stateless, session-based authentication provides a user-friendly way to manage active sessions, track user interactions, and facilitate access to resources. By the end of this lesson, you will be capable of signing up, logging in, accessing protected resources, and logging out using session-based authentication with Requests-Scala.

Session-based authentication is a process that allows users to stay logged into a system as they interact with different endpoints in an application. Whether you are using a web browser or a client like a Scala application to interact with a RESTful API, session-based authentication involves maintaining user session information on the server, creating a stateful experience.

When you log in to a RESTful API using your Scala client, the server starts a "session" for you. This session is like a temporary ID card that validates your identity during your interactions with the API. A critical part of this process involves a "cookie," which is a small piece of data sent from the server and stored by your client.

In the context of a Scala-based client:

• Session Creation: After logging in by sending a POST request with your username and password, the server creates a unique session ID, often returned in a cookie.
• Ongoing Requests: Your Scala client, with the help of libraries like Requests-Scala, automatically includes this session ID in subsequent requests to the API. This allows the server to recognize the session without needing to re-enter your credentials.
• Session Termination: When your client logs out by sending a logout request, the server invalidates the session, stopping further requests with the old session ID from succeeding, safeguarding your session integrity.

By using libraries such as Requests-Scala, you can manage cookies and session data seamlessly, enabling effective interaction with RESTful API endpoints while maintaining user state securely.

Before diving into the authentication steps, it is crucial to understand how to manage sessions using Requests-Scala. Requests-Scala is known for its simplicity and ease of use when making HTTP requests. A pivotal feature of this library is the ability to manage session data across multiple requests effortlessly.

Here’s how you can establish a session using Requests-Scala:

Scala
Copy to clipboard
1import requests.*
2
3val session = requests.Session()

Why Use requests.Session?

• Stateful Interactions: requests.Session maintains session information such as cookies between requests. Once you log in to an API, it stores the session ID and includes it automatically in subsequent requests.
• Efficiency: Using a session can reduce the overhead of establishing new connections for each request, making your interactions with the API more efficient.
• Consistency: All requests made from a session object share the same persistent storage, ensuring consistent behavior throughout your API interactions.

A session object is particularly useful when implementing session-based authentication. After creating a session, you can perform all authentication steps — signing up, logging in, accessing resources, and logging out — all within this persistent context. The continuity offered by sessions assures that user state and authorization are maintained seamlessly across multiple API requests, providing a cohesive user experience. Here is a generic example of how you can use it for requests:

Scala
Copy to clipboard
1// Similar to requests.get(), but maintains session data
2val response = session.get("http://example.com")

Having understood the basics of session management, let's proceed to the practical implementation of session-based authentication using Requests-Scala.

In the first step of session-based authentication, you need to create a user account. This action is performed by sending a POST request to the API's signup endpoint. Below is the code example showing how this can be accomplished:

Scala
Copy to clipboard
1import requests.*
2import scala.util.{Try, Success, Failure}
3import ujson.*
4
5@main def solution(): Unit = 
6  // Base URL for the API
7  val baseUrl = "http://localhost:8000"
8
9  // Signup details with a username and password
10  val authDetails = Obj("username" -> "testuser", "password" -> "testpass123")
11
12  // Attempt the signup request and handle the response
13  val signupResult = for
14    signupResponse <- Try(session.post(s"$baseUrl/auth/signup", data = authDetails))
15  yield signupResponse
16
17  signupResult match
18    case Success(signupResponse) if signupResponse.statusCode == 200 =>
19      println("Signed up successfully!")
20      println(signupResponse.text())
21    case Success(signupResponse) =>
22      println(s"Failed to sign up: ${signupResponse.text()}")
23    case Failure(exception) =>
24      println(s"An error occurred: ${exception.getMessage}")

In this example, a user account is created by submitting a POST request to the /auth/signup endpoint, along with a username and password. If the request is successful, a confirmation message and the server’s response are displayed; otherwise, error details are provided.

Upon successful signup, you would see the following output, confirming that the account has been created:

Plain text
Copy to clipboard
1Signed up successfully!
2{"message": "Signup successful. Please log in to continue."}

Since the API doesn't establish or return a session during signup, you have the option to use requests.post() instead of session.post(). However, using session.post() from the outset ensures code consistency and prepares you for future steps where session persistence becomes crucial.

In scenarios where an API logs you in automatically during signup, using session.post() guarantees that the session is maintained, allowing immediate access to protected endpoints without an additional login.

After signing up, the next step is to log in and initiate a session. This involves posting login credentials to an authentication endpoint and leveraging the requests.Session object to maintain session state. Here's an example of how this is implemented:

Scala
Copy to clipboard
1// Attempt the login request and handle the response
2val loginResult = for
3  loginResponse <- Try(session.post(s"$baseUrl/auth/login", data = authDetails))
4yield loginResponse
5
6loginResult match
7  case Success(loginResponse) if loginResponse.statusCode == 200 =>
8    println("Logged in successfully!")
9    println(loginResponse.text())
10
11    // Retrieve and print the session ID
12    val sessionId = session.cookies.get("session")
13    println(s"\nSession ID: $sessionId")
14  case Success(loginResponse) =>
15    println(s"Failed to log in: ${loginResponse.text()}")
16  case Failure(exception) =>
17    println(s"An error occurred: ${exception.getMessage}")

In this code snippet, after signing up, you proceed to log in via a POST request to /auth/login, re-using the session object to keep the session active. Successful login messages are shown if the credentials are accepted and the session is active, and the session ID is printed; otherwise, error details are displayed. Successful login results in the following output:

Plain text
Copy to clipboard
1Logged in successfully!
2{"message": "Login successful"}
3
4Session ID: Some(eyJhdXRoZW50aWNhdGVkIjp0cnVlLCJ1c2VybmFtZSI6InRlc3R1c2VyMjIyIn0.Z5JFJQ.sF2NX5wOgSF5GVqEmuS2YAawIWM)

With an active session established, you can simply use your session object to make requests to protected endpoints of the API. Here's an example of how to achieve this:

Scala
Copy to clipboard
1// Attempt to access a protected endpoint
2val todosResult = for
3  todosResponse <- Try(session.get(s"$baseUrl/todos"))
4yield todosResponse
5
6todosResult match
7  case Success(todosResponse) if todosResponse.statusCode == 200 =>
8    println("Accessed todos successfully!")
9    println(todosResponse.text())
10  case Success(todosResponse) =>
11    println(s"Failed to access todos: ${todosResponse.text()}")
12  case Failure(exception) =>
13    println(s"An error occurred: ${exception.getMessage}")

Here, a GET request is used to access the /todos endpoint, assuming it's protected and requires an active session. When access is granted, it indicates that your session is valid and active; otherwise, error responses are provided in case of a failure. Accessing the protected resource successfully will produce the following output:

Plain text
Copy to clipboard
1Accessed todos successfully!
2[{"description": "Milk, eggs, bread, and coffee", "done": false, "id": 1, "title": "Buy groceries"}, {"description": "Check in and catch up", "done": true, "id": 2, "title": "Call mom"}, {"description": "Summarize Q4 performance metrics", "done": false, "id": 3, "title": "Finish project report"}, {"description": "30 minutes of cardio", "done": true, "id": 4, "title": "Workout"}]

To end the session and log out by targeting the /auth/logout endpoint, ensuring that the session is cleanly terminated, you can use the following:

Scala
Copy to clipboard
1// Attempt to log out from the API
2val logoutResult = for
3  logoutResponse <- Try(session.post(s"$baseUrl/auth/logout"))
4yield logoutResponse
5
6logoutResult match
7  case Success(logoutResponse) if logoutResponse.statusCode == 200 =>
8    println("Logged out successfully!")
9    println(logoutResponse.text())
10  case Success(logoutResponse) =>
11    println(s"Failed to log out: ${logoutResponse.text()}")
12  case Failure(exception) =>
13    println(s"An error occurred: ${exception.getMessage}")

To log out, a POST request is made to /auth/logout, notifying the server to terminate the session. A successful logout message is displayed upon completion; otherwise, error responses are provided if the request fails. After logging out, you will see the following message as confirmation:

Plain text
Copy to clipboard
1Logged out successfully!
2{"message": "Logout successful"}

After ending the session and logging out, any attempt to access protected endpoints without logging back in will fail. This is because the session is no longer active, and the server won't recognize your session ID. Here’s the output you can expect when trying to access a protected endpoint after logging out:

Plain text
Copy to clipboard
1An HTTP error occurred: 401 Client Error: UNAUTHORIZED for url: http://localhost:8000/todos
2Error: Valid session required

In this lesson, we journeyed through the process of session-based authentication using Requests-Scala, covering signing up, logging in, accessing secure resources, and logging out. By maintaining an active session, you have learned to manage user states effectively and securely — an important aspect of API interaction.

As you transition to the practice exercises, these methods will form the backbone of your hands-on experience in securing endpoints. The upcoming practices are designed to reinforce your understanding and mastery of session-based authentication, preparing you for subsequent lessons that explore even more advanced methods. Dive into these exercises with confidence, applying what you've learned in a practical, results-oriented way.