Skip to content

Commit 246f3dc

Browse files
committed
docs(oci): add security warning for insecure registry flag
Add comprehensive security warning documentation for the storage.oci.repository.insecure configuration option, highlighting: - Production environment risks - Man-in-the-Middle attack vulnerabilities - SLSA guarantee violations - Development-only usage recommendations
1 parent b0670ee commit 246f3dc

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/config.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,18 @@ Supported keys include:
7878
| `storage.grafeas.notehint` (optional) | This field is used to set the [human_readable_name](https://github.com/grafeas/grafeas/blob/cd23d4dc1bef740d6d6d90d5007db5c9a2431c41/proto/v1/attestation.proto#L49) field in the Grafeas ATTESTATION note. If it is not provided, the default `This attestation note was generated by Tekton Chains` will be used. | | |
7979
| `storage.archivista.url` | The URL endpoint for the Archivista service. | A valid HTTPS URL pointing to your Archivista instance (e.g. `https://archivista.testifysec.io`). | None |
8080

81+
> [!WARNING]
82+
> **Security Considerations for `storage.oci.repository.insecure`**
83+
>
84+
> The `storage.oci.repository.insecure` flag allows connecting to OCI registries without TLS certificate verification. This feature is designed to ease developer overhead during testing and development where setting up HTTPS might be cumbersome.
85+
>
86+
> **Security Risks:**
87+
> - **Production Environment Risk**: Enabling this flag in production environments can lead to serious security compromises. Administrators must ensure this flag is only enabled for development and testing purposes.
88+
> - **Man-in-the-Middle Attacks**: Skipping TLS certificate verification makes the connection vulnerable to man-in-the-middle attacks where provenance could be tampered with.
89+
> - **SLSA Guarantees Violation**: Tampered provenance can lead to violation of SLSA (Supply chain Levels for Software Artifacts) guarantees that Tekton Chains promises to provide.
90+
>
91+
> **Recommendation**: Only use `storage.oci.repository.insecure: true` in development or test environments. For production deployments, always use secure HTTPS connections with valid TLS certificates (`storage.oci.repository.insecure: false`, which is the default).
92+
8193
#### docstore
8294

8395
You can read about the go-cloud docstore URI format [here](https://gocloud.dev/howto/docstore/). Tekton Chains supports the following docstore services:

0 commit comments

Comments
 (0)