Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cloudcreate-dk authored Mar 21, 2024
1 parent 9721d3b commit f4b1036
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,35 @@
## License
Essentials is released under version 2.0 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0)

## Versions
# Security

Several of the components, as well as their subcomponents and/or supporting classes, allows the user of the components to provide customized:
- table names
- column names
- collection names
- etc.

By using naming conventions for Postgresql table/column/index names and MongoDB Collection names, Essentials attempts to provide an initial layer of defense intended to reduce the risk of malicious input.
**However, Essentials does not offer exhaustive protection, nor does it assure the complete security of the resulting SQL and Mongo Queries/Updates against injection threats.**
> The responsibility for implementing protective measures against malicious API input and configuration values lies exclusively with the users/developers using the Essentials components and its supporting classes.
> Users must ensure thorough sanitization and validation of API input parameters, SQL table/column/index names as well as MongoDB collection names.
**Insufficient attention to these practices may leave the application vulnerable to attacks, endangering the security and integrity of the database.**

> Please see the **Security** notices for Essentials `components/README.md`, as well as **Security** notices for the individual components, to familiarize yourself with the security
> risks related to using the Essentials Components:
> - `foundation-types/README.md`
> - `components/postgresql-distributed-fenced-lock/README.md`
> - `components/springdata-mongo-distributed-fenced-lock/README.md`
> - `components/postgresql-queue/README.md`
> - `components/springdata-mongo-queue/README.md`
> - `components/postgresql-event-store/README.md`
> - `components/eventsourced-aggregates/README.md`
> - `components/spring-boot-starter-postgresql/README.md`
> - `components/spring-boot-starter-postgresql-event-store/README.md`
> - `components/spring-boot-starter-mongodb/README.md`
## Versions

| Essentials version | Java compatibility | Spring Boot compatibility |
|----------------------------------------------------------------------------------------------|--------------------|---------------------------|
Expand Down

0 comments on commit f4b1036

Please sign in to comment.