feat: check format of enveloped objects and block cross namespace placement #1072
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
ryanzhang-oss
force-pushed
the
block-crossnamespace
branch
from
49395b9 to
e4f2f05
Compare
jwtty
reviewed
Mar 8, 2025
| content, jsonErr := yaml.ToJSON([]byte(value)) | ||
| if jsonErr != nil { | ||
| return nil, jsonErr | ||
| } | ||
| var uManifest unstructured.Unstructured | ||
| if unMarshallErr := uManifest.UnmarshalJSON(content); unMarshallErr != nil { | ||
| klog.ErrorS(unMarshallErr, "manifest has invalid content", "manifestKey", key, "envelopResource", klog.KObj(uConfigMap)) |
There was a problem hiding this comment.
Suggested change
| klog.ErrorS(unMarshallErr, "manifest has invalid content", "manifestKey", key, "envelopResource", klog.KObj(uConfigMap)) | |
| klog.ErrorS(unMarshallErr, "manifest has invalid content", "manifestKey", key, "envelopeResource", klog.KObj(uConfigMap)) |
| var uManifest unstructured.Unstructured | ||
| if unMarshallErr := uManifest.UnmarshalJSON(content); unMarshallErr != nil { | ||
| klog.ErrorS(unMarshallErr, "manifest has invalid content", "manifestKey", key, "envelopResource", klog.KObj(uConfigMap)) | ||
| return nil, fmt.Errorf("the object with manifest key `%s` in evenlop config `%s` is malformatted, err: %w", key, klog.KObj(uConfigMap), unMarshallErr) |
There was a problem hiding this comment.
Suggested change
| return nil, fmt.Errorf("the object with manifest key `%s` in evenlop config `%s` is malformatted, err: %w", key, klog.KObj(uConfigMap), unMarshallErr) | |
| return nil, fmt.Errorf("the object with manifest key `%s` in envelope config `%s` is malformatted, err: %w", key, klog.KObj(uConfigMap), unMarshallErr) |
| return nil, fmt.Errorf("the object with manifest key `%s` in evenlop config `%s` is malformatted, err: %w", key, klog.KObj(uConfigMap), unMarshallErr) | ||
| } | ||
| if len(uManifest.GetNamespace()) != 0 && uManifest.GetNamespace() != configMap.Namespace { | ||
| return nil, fmt.Errorf("the namespaced object `%s` in evenlop config `%s` is placed in a different namespace `%s` ", uManifest.GetName(), klog.KObj(uConfigMap), uManifest.GetNamespace()) |
There was a problem hiding this comment.
Suggested change
| return nil, fmt.Errorf("the namespaced object `%s` in evenlop config `%s` is placed in a different namespace `%s` ", uManifest.GetName(), klog.KObj(uConfigMap), uManifest.GetNamespace()) | |
| return nil, fmt.Errorf("the namespaced object `%s` in envelope config `%s` is placed in a different namespace `%s` ", uManifest.GetName(), klog.KObj(uConfigMap), uManifest.GetNamespace()) |
zhiying-lin
reviewed
Mar 10, 2025
| return nil, fmt.Errorf("the object with manifest key `%s` in evenlop config `%s` is malformatted, err: %w", key, klog.KObj(uConfigMap), unMarshallErr) | ||
| } | ||
| if len(uManifest.GetNamespace()) != 0 && uManifest.GetNamespace() != configMap.Namespace { | ||
| return nil, fmt.Errorf("the namespaced object `%s` in evenlop config `%s` is placed in a different namespace `%s` ", uManifest.GetName(), klog.KObj(uConfigMap), uManifest.GetNamespace()) |
There was a problem hiding this comment.
Suggested change
| return nil, fmt.Errorf("the namespaced object `%s` in evenlop config `%s` is placed in a different namespace `%s` ", uManifest.GetName(), klog.KObj(uConfigMap), uManifest.GetNamespace()) | |
| return nil, fmt.Errorf("placing a namespaced object `%s` using evenlop config `%s` in a different namespace `%s` is not allowed", uManifest.GetName(), klog.KObj(uConfigMap), uManifest.GetNamespace()) |
Comment on lines
+284
to
+285
| t.Errorf("extractResFromConfigMap() error = %v, wantErr %v", err, tt.wantErr) | ||
| return |
There was a problem hiding this comment.
Suggested change
| t.Errorf("extractResFromConfigMap() error = %v, wantErr %v", err, tt.wantErr) | |
| return | |
| t.Fatalf("extractResFromConfigMap() error = %v, wantErr %v", err, tt.wantErr) |
can use fatalf instead
| @@ -1245,11 +1245,20 @@ func extractResFromConfigMap(uConfigMap *unstructured.Unstructured) ([]fleetv1be | |||
| return nil, err | |||
| } | |||
| // the list order is not stable as the map traverse is random | |||
| for _, value := range configMap.Data { | |||
There was a problem hiding this comment.
not sure what happens when configMap.Data is empty.
michaelawyu
reviewed
Mar 10, 2025
| if unMarshallErr := uManifest.UnmarshalJSON(content); unMarshallErr != nil { | ||
| klog.ErrorS(unMarshallErr, "manifest has invalid content", "manifestKey", key, "envelopResource", klog.KObj(uConfigMap)) | ||
| return nil, fmt.Errorf("the object with manifest key `%s` in evenlop config `%s` is malformatted, err: %w", key, klog.KObj(uConfigMap), unMarshallErr) | ||
| } |
There was a problem hiding this comment.
Hi Ryan! Just a nit here: would it be good if we add a comment here mentioning that namespaced objects that do not have a namespace value specified would pass the check here but fail at the work applier end?
There was a problem hiding this comment.
So they will not have assigned the same namespace as the configMap?
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.
Description of your changes
Fixes #
I have:
make reviewableto ensure this PR is ready for review.How has this code been tested
Special notes for your reviewer