Skip to content

Commit cb6e649

Browse files
committed
Clarify governance and security in README.md
Also: fix BucketIT file name.
1 parent 7094195 commit cb6e649

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@
3939
* [Build & Run](#build--run)
4040
* [Java](#java)
4141
* [Kotlin](#kotlin)
42+
* [Governance model](#governance-model)
43+
* [Vulnerability reports](#vulnerability-reports)
44+
* [Security](#security)
4245
* [Contributing](#contributing)
4346
* [Licensing](#licensing)
4447
<!-- TOC -->
@@ -272,7 +275,7 @@ Example with configuration via environment variables:
272275

273276
#### Start using the Fabric8 Docker-Maven-Plugin
274277

275-
Our [integration tests](integration-tests) are using the Amazon S3 Client to verify the server functionality against the S3Mock. During the Maven build, the Docker image is started using the [docker-maven-plugin](https://dmp.fabric8.io/) and the corresponding ports are passed to the JUnit test through the `maven-failsafe-plugin`. See [`BucketV2IT`](integration-tests/src/test/kotlin/com/adobe/testing/s3mock/its/BucketV2IT.kt) as an example on how it's used in the code.
278+
Our [integration tests](integration-tests) are using the Amazon S3 Client to verify the server functionality against the S3Mock. During the Maven build, the Docker image is started using the [docker-maven-plugin](https://dmp.fabric8.io/) and the corresponding ports are passed to the JUnit test through the `maven-failsafe-plugin`. See [`BucketIT`](integration-tests/src/test/kotlin/com/adobe/testing/s3mock/its/BucketIT.kt) as an example on how it's used in the code.
276279

277280
This way, one can easily switch between calling the S3Mock or the real S3 endpoint and this doesn't add any additional Java dependencies to the project.
278281

@@ -575,9 +578,23 @@ This repo is built with Java 17, output is _currently_ bytecode compatible with
575578
### Kotlin
576579
The [Integration Tests](integration-tests) are built in Kotlin.
577580
581+
## Governance model
582+
583+
The project owner and leads makes all final decisions. See the `developers` section in the [pom.xml](pom.xml) for a list of leads.
584+
585+
## Vulnerability reports
586+
587+
S3Mock uses GitHub actions to produce an SBOM and to check dependencies for vulnerabilities. All vulnerabilities are evaluated and fixed if possible.
588+
Vulnerabilities may also be reported through the GitHub issue tracker.
589+
590+
## Security
591+
592+
S3Mock is not intended to be used in production environments. It is a mock server that is meant to be used in development and testing environments only. It does not implement all security features of AWS S3, and should not be used as a replacement for AWS S3 in production.
593+
It is implemented using [Spring Boot](https://github.com/spring-projects/spring-boot), which is a Java framework that is designed to be secure by default.
594+
578595
## Contributing
579596
580-
Contributions are welcomed! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.
597+
Contributions are welcome! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.
581598
582599
## Licensing
583600

0 commit comments

Comments
 (0)