-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add security considerations #909
Conversation
|
docs/docs/security-considerations.md
Outdated
Thus, it's not possible to disambiguate, for example, pods spawned from a deployment, or to limit the amount of certificates issued per policy. | ||
|
||
Container image references from Kubernetes resource definitions are taken into account when generating the policy. | ||
A mutable reference may lead to policy failures or unverified image content, depending on the Contrast runtime. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably try to catch this and either log a warning or abort entirely.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, but I'd lean towards keeping the advice here for now and remove it once we agreed on a path forward (which is not obvious, considering other methods of integrity protection, like the tardev snapshotter or signed images).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For sure, implementing that would be way out of the scope of this pr.
69fb22d
to
35ff1cb
Compare
All feedback addressed. |
docs/docs/security-considerations.md
Outdated
Container image references from Kubernetes resource definitions are taken into account when generating the policy. | ||
A mutable reference may lead to policy failures or unverified image content, depending on the Contrast runtime. | ||
Reliability and security can only be ensured with a full image reference, including digest. | ||
The [`docker pull` documentation] explains pinned image references in detail. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a link missing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a shortcut reference link. I like that it does not interrupt the sentence in the markdown source.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Did you envision this as a high-level section below the "workload deployment"?
Remember to add the sidebar entry before merging.
Co-authored-by: Tom Dohrmann <[email protected]> Co-authored-by: Moritz Eckert <[email protected]>
35ff1cb
to
a72a9b6
Compare
I reconsidered and moved it into Architecture for now - don't think this needs to be a top level item. |
Outlines a couple of DOs and DON'Ts when writing apps for Contrast. The idea is that, after reading the recommendations, an author of a Kubernetes app can tell what's safe to do in YAML and what needs scrutiny.