- Notifications
You must be signed in to change notification settings - Fork914
feat(provisioner/terraform/tfparse): add support for built-in Terraform functions#16183
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
3 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
4 changes: 2 additions & 2 deletionscoderd/templateversions_test.go
This file contains hidden or 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
7 changes: 7 additions & 0 deletionsgo.mod
This file contains hidden or 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
8 changes: 8 additions & 0 deletionsgo.sum
This file contains hidden or 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
162 changes: 162 additions & 0 deletionsprovisioner/terraform/tfparse/funcs.go
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| package tfparse | ||
| import ( | ||
| "github.com/aquasecurity/trivy-iac/pkg/scanners/terraform/parser/funcs" | ||
| "github.com/hashicorp/hcl/v2/ext/tryfunc" | ||
| ctyyaml "github.com/zclconf/go-cty-yaml" | ||
| "github.com/zclconf/go-cty/cty" | ||
| "github.com/zclconf/go-cty/cty/function" | ||
| "github.com/zclconf/go-cty/cty/function/stdlib" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
| // Functions returns a set of functions that are safe to use in the context of | ||
| // evaluating Terraform expressions without any ability to reference local files. | ||
| // Functions that refer to file operations are replaced with stubs that return a | ||
| // descriptive error to the user. | ||
| func Functions() map[string]function.Function { | ||
| return allFunctions | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| var ( | ||
| // Adapted from github.com/aquasecurity/trivy-iac@v0.8.0/pkg/scanners/terraform/parser/functions.go | ||
| // We cannot support all available functions here, as the result of reading a file will be different | ||
| // depending on the execution environment. | ||
| safeFunctions = map[string]function.Function{ | ||
| "abs": stdlib.AbsoluteFunc, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Post-merge thought: how do we align Terraform versions? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. From what I could tell it doesn't look like these functions change all that often. However, f Terraform adds a new function in future, we'll need to add support for it ourselves. Then again, so will There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Cool, I think we're fine here and we can just update the lib. | ||
| "basename": funcs.BasenameFunc, | ||
| "base64decode": funcs.Base64DecodeFunc, | ||
| "base64encode": funcs.Base64EncodeFunc, | ||
| "base64gzip": funcs.Base64GzipFunc, | ||
| "base64sha256": funcs.Base64Sha256Func, | ||
| "base64sha512": funcs.Base64Sha512Func, | ||
| "bcrypt": funcs.BcryptFunc, | ||
| "can": tryfunc.CanFunc, | ||
| "ceil": stdlib.CeilFunc, | ||
| "chomp": stdlib.ChompFunc, | ||
| "cidrhost": funcs.CidrHostFunc, | ||
| "cidrnetmask": funcs.CidrNetmaskFunc, | ||
| "cidrsubnet": funcs.CidrSubnetFunc, | ||
| "cidrsubnets": funcs.CidrSubnetsFunc, | ||
| "coalesce": funcs.CoalesceFunc, | ||
| "coalescelist": stdlib.CoalesceListFunc, | ||
| "compact": stdlib.CompactFunc, | ||
| "concat": stdlib.ConcatFunc, | ||
| "contains": stdlib.ContainsFunc, | ||
| "csvdecode": stdlib.CSVDecodeFunc, | ||
| "dirname": funcs.DirnameFunc, | ||
| "distinct": stdlib.DistinctFunc, | ||
| "element": stdlib.ElementFunc, | ||
| "chunklist": stdlib.ChunklistFunc, | ||
| "flatten": stdlib.FlattenFunc, | ||
| "floor": stdlib.FloorFunc, | ||
| "format": stdlib.FormatFunc, | ||
| "formatdate": stdlib.FormatDateFunc, | ||
| "formatlist": stdlib.FormatListFunc, | ||
| "indent": stdlib.IndentFunc, | ||
| "index": funcs.IndexFunc, // stdlib.IndexFunc is not compatible | ||
| "join": stdlib.JoinFunc, | ||
| "jsondecode": stdlib.JSONDecodeFunc, | ||
| "jsonencode": stdlib.JSONEncodeFunc, | ||
| "keys": stdlib.KeysFunc, | ||
| "length": funcs.LengthFunc, | ||
| "list": funcs.ListFunc, | ||
| "log": stdlib.LogFunc, | ||
| "lookup": funcs.LookupFunc, | ||
| "lower": stdlib.LowerFunc, | ||
| "map": funcs.MapFunc, | ||
| "matchkeys": funcs.MatchkeysFunc, | ||
| "max": stdlib.MaxFunc, | ||
| "md5": funcs.Md5Func, | ||
| "merge": stdlib.MergeFunc, | ||
| "min": stdlib.MinFunc, | ||
| "parseint": stdlib.ParseIntFunc, | ||
| "pow": stdlib.PowFunc, | ||
| "range": stdlib.RangeFunc, | ||
| "regex": stdlib.RegexFunc, | ||
| "regexall": stdlib.RegexAllFunc, | ||
| "replace": funcs.ReplaceFunc, | ||
| "reverse": stdlib.ReverseListFunc, | ||
| "rsadecrypt": funcs.RsaDecryptFunc, | ||
| "setintersection": stdlib.SetIntersectionFunc, | ||
| "setproduct": stdlib.SetProductFunc, | ||
| "setsubtract": stdlib.SetSubtractFunc, | ||
| "setunion": stdlib.SetUnionFunc, | ||
| "sha1": funcs.Sha1Func, | ||
| "sha256": funcs.Sha256Func, | ||
| "sha512": funcs.Sha512Func, | ||
| "signum": stdlib.SignumFunc, | ||
| "slice": stdlib.SliceFunc, | ||
| "sort": stdlib.SortFunc, | ||
| "split": stdlib.SplitFunc, | ||
| "strrev": stdlib.ReverseFunc, | ||
| "substr": stdlib.SubstrFunc, | ||
| "timestamp": funcs.TimestampFunc, | ||
| "timeadd": stdlib.TimeAddFunc, | ||
| "title": stdlib.TitleFunc, | ||
| "tostring": funcs.MakeToFunc(cty.String), | ||
| "tonumber": funcs.MakeToFunc(cty.Number), | ||
| "tobool": funcs.MakeToFunc(cty.Bool), | ||
| "toset": funcs.MakeToFunc(cty.Set(cty.DynamicPseudoType)), | ||
| "tolist": funcs.MakeToFunc(cty.List(cty.DynamicPseudoType)), | ||
| "tomap": funcs.MakeToFunc(cty.Map(cty.DynamicPseudoType)), | ||
| "transpose": funcs.TransposeFunc, | ||
| "trim": stdlib.TrimFunc, | ||
| "trimprefix": stdlib.TrimPrefixFunc, | ||
| "trimspace": stdlib.TrimSpaceFunc, | ||
| "trimsuffix": stdlib.TrimSuffixFunc, | ||
| "try": tryfunc.TryFunc, | ||
| "upper": stdlib.UpperFunc, | ||
| "urlencode": funcs.URLEncodeFunc, | ||
| "uuid": funcs.UUIDFunc, | ||
| "uuidv5": funcs.UUIDV5Func, | ||
| "values": stdlib.ValuesFunc, | ||
| "yamldecode": ctyyaml.YAMLDecodeFunc, | ||
| "yamlencode": ctyyaml.YAMLEncodeFunc, | ||
| "zipmap": stdlib.ZipmapFunc, | ||
| } | ||
| // the below functions are not safe for usage in the context of tfparse, as their return | ||
| // values may change depending on the underlying filesystem. | ||
| stubFileFunctions = map[string]function.Function{ | ||
| "abspath": makeStubFunction("abspath", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "file": makeStubFunction("file", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "fileexists": makeStubFunction("fileexists", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "fileset": makeStubFunction("fileset", cty.String, function.Parameter{Name: "path", Type: cty.String}, function.Parameter{Name: "pattern", Type: cty.String}), | ||
| "filebase64": makeStubFunction("filebase64", cty.String, function.Parameter{Name: "path", Type: cty.String}, function.Parameter{Name: "pattern", Type: cty.String}), | ||
| "filebase64sha256": makeStubFunction("filebase64sha256", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "filebase64sha512": makeStubFunction("filebase64sha512", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "filemd5": makeStubFunction("filemd5", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "filesha1": makeStubFunction("filesha1", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "filesha256": makeStubFunction("filesha256", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "filesha512": makeStubFunction("filesha512", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| "pathexpand": makeStubFunction("pathexpand", cty.String, function.Parameter{Name: "path", Type: cty.String}), | ||
| } | ||
| allFunctions = mergeMaps(safeFunctions, stubFileFunctions) | ||
| ) | ||
| // mergeMaps returns a new map which is the result of merging each key and value | ||
| // of all maps in ms, in order. Successive maps may override values of previous | ||
| // maps. | ||
| func mergeMaps[K, V comparable](ms ...map[K]V) map[K]V { | ||
| merged := make(map[K]V) | ||
| for _, m := range ms { | ||
| for k, v := range m { | ||
| merged[k] = v | ||
| } | ||
| } | ||
| return merged | ||
| } | ||
| // makeStubFunction returns a function.Function with the required return type and parameters | ||
| // that will always return an unknown type and an error. | ||
| func makeStubFunction(name string, returnType cty.Type, params ...function.Parameter) function.Function { | ||
| var spec function.Spec | ||
| spec.Params = params | ||
| spec.Type = function.StaticReturnType(returnType) | ||
| spec.Impl = func(_ []cty.Value, _ cty.Type) (cty.Value, error) { | ||
| return cty.UnknownVal(returnType), xerrors.Errorf("function %q may not be used here", name) | ||
| } | ||
| return function.New(&spec) | ||
| } | ||
2 changes: 1 addition & 1 deletionprovisioner/terraform/tfparse/tfparse.go
This file contains hidden or 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
44 changes: 42 additions & 2 deletionsprovisioner/terraform/tfparse/tfparse_test.go
This file contains hidden or 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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.