Skip to content

Commit 806fde2

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 ec9b775 commit 806fde2

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
@@ -76,6 +76,18 @@ Supported keys include:
7676
| `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. | | |
7777
| `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 |
7878

79+
> [!WARNING]
80+
> **Security Considerations for `storage.oci.repository.insecure`**
81+
>
82+
> 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.
83+
>
84+
> **Security Risks:**
85+
> - **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.
86+
> - **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.
87+
> - **SLSA Guarantees Violation**: Tampered provenance can lead to violation of SLSA (Supply chain Levels for Software Artifacts) guarantees that Tekton Chains promises to provide.
88+
>
89+
> **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).
90+
7991
#### docstore
8092

8193
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)