https://github.com/hardiksinghbehl/firebase-integration-spring-boot
Spring-boot application integrating with Firestore and Firebase Authentication to build a CRUD application.
https://github.com/hardiksinghbehl/firebase-integration-spring-boot
firebase-admin-sdk firebase-auth firebase-storage firestore firestore-crud java-21 spring-boot-3 spring-security-6
Last synced: about 1 year ago
JSON representation
Spring-boot application integrating with Firestore and Firebase Authentication to build a CRUD application.
- Host: GitHub
- URL: https://github.com/hardiksinghbehl/firebase-integration-spring-boot
- Owner: hardikSinghBehl
- License: unlicense
- Created: 2021-08-28T12:54:58.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T09:55:30.000Z (about 2 years ago)
- Last Synced: 2025-04-09T23:50:51.540Z (about 1 year ago)
- Topics: firebase-admin-sdk, firebase-auth, firebase-storage, firestore, firestore-crud, java-21, spring-boot-3, spring-security-6
- Language: Java
- Homepage:
- Size: 197 KB
- Stars: 25
- Watchers: 1
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Firebase Authentication and Firestore Integration in Spring Boot
##### A reference proof-of-concept that leverages [Firestore Database](https://firebase.google.com/docs/firestore) to perform CRUD operations and [Firebase Authentication](https://firebase.google.com/docs/auth) with Spring-Security to authenticate users.
##### 🛠upgraded to Spring Boot 3 and Spring Security 6 ðŸ›
### Application Flow and Security Configuration
The project simulates a rudimentary Task Management Application.
API endpoints dealing with user account creation and login credentials validation are made public, by annotating their corresponding controller methods with custom annotation [@PublicEndpoint](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/configuration/PublicEndpoint.java).
Requests to the configured API paths will not be evaluated by the Security filter with the logic being governed by [ApiEndpointSecurityInspector](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/utility/ApiEndpointSecurityInspector.java).
Below is a sample controller method declared as public which will be exempted from authentication checks:
```java
@PublicEndpoint
@PostMapping(value = "/login")
public ResponseEntity login(@RequestBody UserLoginRequest userLoginRequest) {
final var response = userService.login(userLoginRequest);
return ResponseEntity.ok(response);
}
```
API requests to private endpoints, handling CRUD operations on the [Task](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/entity/Task.java) entity are intercepted by the [JwtAuthenticationFilter](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/filter/JwtAuthenticationFilter.java), which is added to the security filter chain and configured in the [SecurityConfiguration](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/configuration/SecurityConfiguration.java). The custom filter holds the responsibility for verifying the authenticity of the incoming access token by communicating with the Firebase Authentication service and populating the security context.
Post successful authentication, [AuthenticatedUserIdProvider](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/utility/AuthenticatedUserIdProvider.java) is responsible for retrieving the authenticated user-id from the security context. This helps the [Service layer](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/service/TaskService.java) maintain relationship between the current authenticated user and their corresponding Tasks. If an authenticated user attempts to perform any action on Tasks not owned by them, then the below API response is sent back to the client.
```json
{
"Status": "403 FORBIDDEN",
"Description": "Access Denied: Insufficient privileges to perform this action."
}
```
In the event of authentication failure, when the access token received in the HTTP Request Headers is not valid, the below API response is sent back to the client.
```json
{
"Status": "401 UNAUTHORIZED",
"Description": "Authentication failure: Token missing, invalid or expired"
}
```
The above JSON response is dispatched to the client as a result of [CustomAuthenticationEntryPoint](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/configuration/CustomAuthenticationEntryPoint.java) configured within the [SecurityConfiguration](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/configuration/SecurityConfiguration.java) which assumes any exception thrown by the Security filter is due to token verification failure. Hence, the implementation instantiates [TokenVerificationException](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/exception/TokenVerificationException.java) and delegates the responsibility of exception handling to [ExceptionResponseHandler](https://github.com/hardikSinghBehl/firebase-integration-spring-boot/blob/main/src/main/java/com/behl/flare/exception/ExceptionResponseHandler.java).
---
### Local Setup
To run the application locally, ensure you have the following prerequisites:
* A private key associated with the service account to establish a connection with Firebase.
* The Web API key of the Firebase project you've created to invoke the Firebase Authentication REST API.
* The created Firebase Authentication service has the `Email/Password` native sign-in provider enabled.
Create a file named `private-key.json` in the base directory and paste the contents of the service account's private key into this file.
Execute the following commands in the project's base directory to build the application image and start the backend application container:
```bash
FIREBASE_PRIVATE_KEY=$(cat private-key.json)
```
```bash
FIREBASE_WEB_API_KEY=your-web-api-key-here
```
```bash
sudo docker-compose build
```
```bash
sudo FIREBASE_PRIVATE_KEY="$FIREBASE_PRIVATE_KEY" FIREBASE_WEB_API_KEY="$FIREBASE_WEB_API_KEY" docker-compose up -d
```
To remove the environment variables from memory after the application has started, the below commands can be executed
```bash
unset FIREBASE_PRIVATE_KEY
```
```bash
unset FIREBASE_WEB_API_KEY
```
---
### Visual Walkthrough
https://github.com/hardikSinghBehl/firebase-integration-spring-boot/assets/69693621/293d23f5-6783-4f1a-82c2-445532a67384