mirror of
https://github.com/fleetdm/fleet
synced 2026-05-17 05:58:40 +00:00
a683185bb3
<!-- Add the related story/sub-task/bug number, like Resolves #123, or remove if NA --> **Related issue:** Resolves #33502 This fixes the mentioned issue by always sorting the found variables in length descending, to ensure we process the longest variables first, avoiding us processing a smaller variation of a longer variable first breaking substitution. # Checklist for submitter If some of the following don't apply, delete the relevant line. - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files) for more information. ## Testing - [x] Added/updated automated tests - [x] QA'd all new/changed functionality manually
103 lines
3.7 KiB
Go
103 lines
3.7 KiB
Go
// Package variables provides functionality for handling Fleet variables,
|
|
// which are template placeholders that can be substituted with actual values
|
|
// in various contexts.
|
|
package variables
|
|
|
|
import (
|
|
"regexp"
|
|
"sort"
|
|
"strings"
|
|
)
|
|
|
|
// fleetVariableRegex matches Fleet variables in content.
|
|
// It supports two formats:
|
|
// - $FLEET_VAR_NAME - without braces
|
|
// - ${FLEET_VAR_NAME} - with braces
|
|
//
|
|
// The regex captures the variable name (without the FLEET_VAR_ prefix) in named groups.
|
|
var fleetVariableRegex = regexp.MustCompile(`(\$FLEET_VAR_(?P<name1>\w+))|(\${FLEET_VAR_(?P<name2>\w+)})`)
|
|
|
|
// ProfileDataVariableRegex matches variables present in <data> section of Apple profile, which may cause validation issues.
|
|
// This is specific to DigiCert certificate data variables.
|
|
var ProfileDataVariableRegex = regexp.MustCompile(`(\$FLEET_VAR_DIGICERT_DATA_(?P<name1>\w+))|(\${FLEET_VAR_DIGICERT_DATA_(?P<name2>\w+)})`)
|
|
|
|
// Find finds all Fleet variables in the given content and returns them as a map
|
|
// without the FLEET_VAR_ prefix. Returns nil if no variables are found.
|
|
//
|
|
// For example, if the content contains "$FLEET_VAR_HOST_UUID" and "${FLEET_VAR_HOST_EMAIL}",
|
|
// this function will return map[string]struct{}{"HOST_UUID": {}, "HOST_EMAIL": {}}.
|
|
func Find(contents string) map[string]struct{} {
|
|
resultSlice := FindKeepDuplicates(contents)
|
|
if len(resultSlice) == 0 {
|
|
return nil
|
|
}
|
|
return dedupe(resultSlice)
|
|
}
|
|
|
|
// FindKeepDuplicates finds all Fleet variables in the given content and returns them
|
|
// as a slice without the FLEET_VAR_ prefix. Duplicates are preserved in the result.
|
|
//
|
|
// This is useful when you need to know the order or frequency of variable occurrences.
|
|
func FindKeepDuplicates(contents string) []string {
|
|
var result []string
|
|
matches := fleetVariableRegex.FindAllStringSubmatch(contents, -1)
|
|
if len(matches) == 0 {
|
|
return nil
|
|
}
|
|
|
|
nameToIndex := make(map[string]int, 2)
|
|
for i, name := range fleetVariableRegex.SubexpNames() {
|
|
if name == "" {
|
|
continue
|
|
}
|
|
nameToIndex[name] = i
|
|
}
|
|
|
|
for _, match := range matches {
|
|
for _, i := range nameToIndex {
|
|
if match[i] != "" {
|
|
result = append(result, match[i])
|
|
}
|
|
}
|
|
}
|
|
|
|
// sort result array by length descending, to ensure longer variables are processed first
|
|
sortedResults := make([]string, len(result))
|
|
copy(sortedResults, result)
|
|
sort.Slice(sortedResults, func(i, j int) bool {
|
|
return len(sortedResults[i]) > len(sortedResults[j])
|
|
})
|
|
return sortedResults
|
|
}
|
|
|
|
// dedupe removes duplicates from the slice and returns a map for O(1) lookups.
|
|
func dedupe(varsWithDupes []string) map[string]struct{} {
|
|
result := make(map[string]struct{}, len(varsWithDupes))
|
|
for _, v := range varsWithDupes {
|
|
result[v] = struct{}{}
|
|
}
|
|
return result
|
|
}
|
|
|
|
// Replace replaces all occurrences of a specific Fleet variable with the given value.
|
|
// The variableName should be provided without the FLEET_VAR_ prefix.
|
|
// This function replaces both braced and non-braced versions of the variable.
|
|
//
|
|
// For example, Replace(content, "HOST_UUID", "123-456") will replace both
|
|
// $FLEET_VAR_HOST_UUID and ${FLEET_VAR_HOST_UUID} with "123-456".
|
|
func Replace(contents string, variableName string, value string) string {
|
|
// Replace both braced and non-braced versions
|
|
result := strings.ReplaceAll(contents, "$FLEET_VAR_"+variableName, value)
|
|
result = strings.ReplaceAll(result, "${FLEET_VAR_"+variableName+"}", value)
|
|
return result
|
|
}
|
|
|
|
// Contains checks if the given content contains any Fleet variables.
|
|
func Contains(contents string) bool {
|
|
return fleetVariableRegex.MatchString(contents)
|
|
}
|
|
|
|
// ContainsBytes checks if the given content contains any Fleet variables (bytes version).
|
|
func ContainsBytes(contents []byte) bool {
|
|
return fleetVariableRegex.Match(contents)
|
|
}
|