https://github.com/mongodb-developer/mongodb-java-spring-boot-csfle
This repository contains a Java Spring Boot template to start a MongoDB project with CSFLE.
https://github.com/mongodb-developer/mongodb-java-spring-boot-csfle
Last synced: 2 months ago
JSON representation
This repository contains a Java Spring Boot template to start a MongoDB project with CSFLE.
- Host: GitHub
- URL: https://github.com/mongodb-developer/mongodb-java-spring-boot-csfle
- Owner: mongodb-developer
- License: apache-2.0
- Created: 2023-08-13T22:51:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T21:00:05.000Z (about 1 year ago)
- Last Synced: 2025-03-28T00:06:34.149Z (3 months ago)
- Language: Java
- Size: 158 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Java Spring Boot Template with MongoDB CSFLE.
This project is a template for a Java Spring Boot application with
[MongoDB Client-Side Field Level Encryption](https://docs.mongodb.com/manual/core/security-client-side-encryption/)
using Spring Data MongoDB.
For more information about this repository, read the
associated [blog post](https://www.mongodb.com/developer/code-examples/java/java-spring-data-client-side-field-level-encryption/).
The goal was to provide reusable classes and methods to easily implement MongoDB CSFLE in an existing Java Spring Boot
application.
Here are a few features in this repository:
- Multiple encrypted collections.
- Automated JSON Schema generation.
- Server side JSON Schema.
- Separated clusters for DEKs and encrypted collections.
- Automated data encryption keys generation or retrieval.
- SpEL Evaluation Extension.
- Auto-implemented repositories.
- Open API documentation 3.0.1.
# Prerequisites
- Java 17 (can't use Java 21 yet because Spring Boot 3.1.4 is not compatible)
- [MongoDB Cluster](https://www.mongodb.com/atlas/database) v7.0.2 or higher.
- [MongoDB Automatic Encryption Shared Library](https://www.mongodb.com/docs/manual/core/queryable-encryption/reference/shared-library/#download-the-automatic-encryption-shared-library)
v7.0.2 or higher.
# Getting Started
Update the [mongodb.properties](src%2Fmain%2Fresources%2Fmongodb.properties) with your
[MongoDB URIs](https://github.com/MaBeuLux88/mongodb-java-spring-boot-csfle#mongodb) and
[MongoDB Automatic Encryption Shared library path](https://github.com/MaBeuLux88/mongodb-java-spring-boot-csfle#mongodb-automatic-encryption-shared-library).
For Linux and macOS.
```bash
./mvnw spring-boot:run
```
For Windows.
```bash
mvnw.cmd spring-boot:run
```
## MongoDB
You can create a new cluster on MongoDB Atlas or, for testing and local development purposes only, you can create an
ephemeral local single node replica set with the following command:
```bash
docker run --rm -d -p 27017:27017 -h $(hostname) --name mongo mongo:7.0.2 --replSet=RS && \
sleep 5 && \
docker exec mongo mongosh --quiet --eval "rs.initiate();"
```
> Note: When you are using MongoDB Client-Side Field Level Encryption, you have the opportunity to store the data and
> the keys in two separate clusters in order to manage the keys independently of the data. You can choose to do so to
> have a different backup retention policy for your two clusters (interesting for GDPR Article 17 "Right to erasure"
> for instance). For more information,
> see [Client-Side Field Level Encryption](https://docs.mongodb.com/manual/core/security-client-side-encryption/).
## MongoDB Automatic Encryption Shared Library
Make sure
to [download](https://www.mongodb.com/docs/manual/core/queryable-encryption/reference/shared-library/#download-the-automatic-encryption-shared-library)
and extract the shared library in the folder of your choice.
```properties
crypt.shared.lib.path=/home/polux/Software/mongo_crypt_shared_v1-linux-x86_64-enterprise-debian11-7.0.2/lib/mongo_crypt_v1.so
```
# Test REST API
## Swagger 3
- Swagger 3 is already configured in this project.
- The Swagger UI can be seen
at [http://localhost:8080/swagger-ui/index.html](http://localhost:8080/swagger-ui/index.html).
- The JSON Open API documentation 3.0.1 is at [http://localhost:8080/v3/api-docs](http://localhost:8080/v3/api-docs).
- The YAML Open API documentation 3.0.1 is
at [http://localhost:8080/v3/api-docs.yaml](http://localhost:8080/v3/api-docs.yaml).
- You can also try the entire REST API directly from the Swagger interface!
## Persons
Create a `person` document:
```bash
curl -X POST http://localhost:8080/person \
-H 'Content-Type: application/json' \
-d '{
"first_name": "John",
"last_name": "Doe",
"ssn": "123-45-6789",
"blood_type": "A+"
}'
```
Find all the persons in the database. Note that the decryption is done automatically:
```bash
curl http://localhost:8080/persons
```
Find one person by SSN in the database. Note that the encryption of the SSN (for the search) is done automatically. Same
for the decryption:
```bash
curl http://localhost:8080/person/ssn/123-45-6789
```
Read the encrypted data in the `persons` collection:
```bash
mongosh "mongodb://localhost/mydb" --quiet --eval "db.persons.find()"
```
Result in the `persons` collection:
```javascript
[
{
_id: ObjectId("6537e9859f1b170d4cd25bee"),
firstName: 'John',
lastName: 'Doe',
ssn: Binary.createFromBase64("AflGzaz/YUj6m2aENIoB50MCn1rhDllb79H17xjkUMK2obL7i038eANieCC/nO7AcaPBtpOdtqqPEvNdd9VgnC6l9QaLEIC/5w+CYPujkNxFIA37PrsqMlDeL3AsMuAgTZg=", 6),
bloodType: Binary.createFromBase64("AvlGzaz/YUj6m2aENIoB50MCaHTxjCBlPZIck2gstfXB6yFfJ0KISjJJE24k3LXDoTv09GH+cwq+u6ApBuDU5OBkRe/6U8nPRKKcc5nirBLIzg==", 6),
_class: 'com.mongodb.quickstart.javaspringbootcsfle.model.PersonEntity'
}
]
```
## Companies
Create a `company` document:
```bash
curl -X POST http://localhost:8080/company \
-H 'Content-Type: application/json' \
-d '{
"name": "MongoDB",
"money": 42
}'
```
Find all the companies in the database. Note that the decryption is done automatically:
```bash
curl http://localhost:8080/companies
```
Read the encrypted data in the `companies` collection:
```bash
mongosh "mongodb://localhost/mydb" --quiet --eval "db.companies.find()"
```
Result in the `companies` collection:
```javascript
[
{
_id: ObjectId("653b1022110ea0067196894d"),
name: 'MongoDB',
money: Binary.createFromBase64("Au+QLuvvXE+gvw8N69fAbDYSjn2ep7Ye/Ap+N1YdBBuUOhLSpQtK9B7U38dx8xIcMz3sBvfOttqW8AOvRISxFa8a47T422hSnnwgCAjPNifnpA==", 6),
_class: 'com.mongodb.quickstart.javaspringbootcsfle.model.CompanyEntity'
}
]
```
# Author
Maxime Beugnet
- [email protected]
- MaBeuLux88 on [GitHub](https://github.com/mabeulux88)
- MaBeuLux88 in the [MongoDB Developer Community forum](https://www.mongodb.com/community/forums/u/MaBeuLux88/summary).