annotations: introduce security annotations. #28
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is the start of some work to automate tracking of fields that should be set in the presence of untrusted downstreams/upstreams. In the future we could add recommended settings etc. Relates to envoyproxy/envoy#9087 Signed-off-by: Harvey Tuch <htuch@google.com>
mattklein123
reviewed
May 1, 2020
Signed-off-by: Harvey Tuch <htuch@google.com>
Signed-off-by: Harvey Tuch <htuch@google.com>
Signed-off-by: Harvey Tuch <htuch@google.com>
htuch
added a commit
to htuch/envoy
that referenced
this pull request
May 5, 2020
…vironments. This PR is an early prototype of a new flow for indicating that fields needs to be set in the presence of untrusted downstreams/upstreams. Based on the (yet to be merged) cncf/udpa#28, a worked example of a YAML example in bootstrap.proto for overload_manager is provided. The new security annotations are validated during docs build for correctness and used to generate inline docs where fields are defined. This is intended to supplement and eventually replace https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/edge#best-practices-edge. Work still to be done: - Decide if this is the approach we want to take. - Fix protoformat toolchain to work with fields inside the annotations. - Annotate remaining fields from https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/edge#best-practices-edge - Cleanup protodoc Python for style reasons and make error handling more robust. Risk level: Low Testing: Docs inspection Part of envoyproxy#9087 Signed-off-by: Harvey Tuch <htuch@google.com>
|
See envoyproxy/envoy#11058 for usage. |
Signed-off-by: Harvey Tuch <htuch@google.com>
|
Dropped the example configs in favor of a manifest based approach inside the Envoy repo, ready for review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the start of some work to automate tracking of fields that
should be set in the presence of untrusted downstreams/upstreams. In the
future we could add recommended settings etc.
Relates to envoyproxy/envoy#9087
Signed-off-by: Harvey Tuch htuch@google.com