|
| 1 | +package maintainedactions |
| 2 | + |
| 3 | +import ( |
| 4 | + "encoding/json" |
| 5 | + "fmt" |
| 6 | + "io/ioutil" |
| 7 | + "path/filepath" |
| 8 | + "strings" |
| 9 | + |
| 10 | + "github.com/step-security/secure-repo/remediation/workflow/metadata" |
| 11 | + "github.com/step-security/secure-repo/remediation/workflow/permissions" |
| 12 | + "gopkg.in/yaml.v3" |
| 13 | +) |
| 14 | + |
| 15 | +// Action represents a GitHub Action in the maintained actions list |
| 16 | +type Action struct { |
| 17 | + Name string `json:"name"` |
| 18 | + Description string `json:"description"` |
| 19 | + ForkedFrom struct { |
| 20 | + Name string `json:"name"` |
| 21 | + } `json:"forkedFrom"` |
| 22 | + Score int `json:"score"` |
| 23 | + Image string `json:"image"` |
| 24 | +} |
| 25 | + |
| 26 | +type replacement struct { |
| 27 | + jobName string |
| 28 | + stepIdx int |
| 29 | + newAction string |
| 30 | + originalAction string |
| 31 | + latestVersion string |
| 32 | +} |
| 33 | + |
| 34 | +// LoadMaintainedActions loads the maintained actions from the JSON file |
| 35 | +func LoadMaintainedActions() (map[string]string, error) { |
| 36 | + // Read the JSON file |
| 37 | + jsonPath := filepath.Join("maintainedactions", "maintainedActions.json") |
| 38 | + |
| 39 | + data, err := ioutil.ReadFile(jsonPath) |
| 40 | + if err != nil { |
| 41 | + return nil, fmt.Errorf("failed to read maintained actions file: %v", err) |
| 42 | + } |
| 43 | + |
| 44 | + // Parse the JSON |
| 45 | + var actions []Action |
| 46 | + if err := json.Unmarshal(data, &actions); err != nil { |
| 47 | + return nil, fmt.Errorf("failed to parse maintained actions JSON: %v", err) |
| 48 | + } |
| 49 | + |
| 50 | + // Create a map of original actions to their Step Security replacements |
| 51 | + actionMap := make(map[string]string) |
| 52 | + for _, action := range actions { |
| 53 | + if action.ForkedFrom.Name != "" { |
| 54 | + actionMap[action.ForkedFrom.Name] = action.Name |
| 55 | + } |
| 56 | + } |
| 57 | + |
| 58 | + return actionMap, nil |
| 59 | +} |
| 60 | + |
| 61 | +// ReplaceActions replaces original actions with Step Security actions in a workflow |
| 62 | +func ReplaceActions(inputYaml string) (string, bool, error) { |
| 63 | + workflow := metadata.Workflow{} |
| 64 | + updated := false |
| 65 | + actionMap, err := LoadMaintainedActions() |
| 66 | + if err != nil { |
| 67 | + return "", updated, fmt.Errorf("unable to load maintained actions: %v", err) |
| 68 | + } |
| 69 | + err = yaml.Unmarshal([]byte(inputYaml), &workflow) |
| 70 | + if err != nil { |
| 71 | + return "", updated, fmt.Errorf("unable to parse yaml: %v", err) |
| 72 | + } |
| 73 | + |
| 74 | + // Step 1: Check if anything needs to be replaced |
| 75 | + |
| 76 | + var replacements []replacement |
| 77 | + |
| 78 | + for jobName, job := range workflow.Jobs { |
| 79 | + if metadata.IsCallingReusableWorkflow(job) { |
| 80 | + continue |
| 81 | + } |
| 82 | + for stepIdx, step := range job.Steps { |
| 83 | + // fmt.Println("step ", step.Uses) |
| 84 | + actionName := strings.Split(step.Uses, "@")[0] |
| 85 | + if newAction, ok := actionMap[actionName]; ok { |
| 86 | + latestVersion, err := GetLatestRelease(newAction) |
| 87 | + if err != nil { |
| 88 | + return "", updated, fmt.Errorf("unable to get latest release: %v", err) |
| 89 | + } |
| 90 | + replacements = append(replacements, replacement{ |
| 91 | + jobName: jobName, |
| 92 | + stepIdx: stepIdx, |
| 93 | + newAction: newAction, |
| 94 | + originalAction: step.Uses, |
| 95 | + latestVersion: latestVersion, |
| 96 | + }) |
| 97 | + } |
| 98 | + } |
| 99 | + } |
| 100 | + if len(replacements) == 0 { |
| 101 | + // No changes needed |
| 102 | + return inputYaml, false, nil |
| 103 | + } |
| 104 | + |
| 105 | + // Step 2: Now modify the YAML lines manually |
| 106 | + t := yaml.Node{} |
| 107 | + err = yaml.Unmarshal([]byte(inputYaml), &t) |
| 108 | + if err != nil { |
| 109 | + return "", updated, fmt.Errorf("unable to parse yaml: %v", err) |
| 110 | + } |
| 111 | + |
| 112 | + inputLines := strings.Split(inputYaml, "\n") |
| 113 | + inputLines, updated, err = replaceAction(&t, inputLines, replacements, updated) |
| 114 | + if err != nil { |
| 115 | + return "", updated, fmt.Errorf("unable to replace action: %v", err) |
| 116 | + } |
| 117 | + |
| 118 | + output := strings.Join(inputLines, "\n") |
| 119 | + |
| 120 | + return output, updated, nil |
| 121 | +} |
| 122 | + |
| 123 | +func replaceAction(t *yaml.Node, inputLines []string, replacements []replacement, updated bool) ([]string, bool, error) { |
| 124 | + for _, r := range replacements { |
| 125 | + jobsNode := permissions.IterateNode(t, "jobs", "!!map", 0) |
| 126 | + jobNode := permissions.IterateNode(jobsNode, r.jobName, "!!map", 0) |
| 127 | + stepsNode := permissions.IterateNode(jobNode, "steps", "!!seq", 0) |
| 128 | + if stepsNode == nil { |
| 129 | + continue |
| 130 | + } |
| 131 | + |
| 132 | + // Now get the specific step |
| 133 | + stepNode := stepsNode.Content[r.stepIdx] |
| 134 | + usesNode := permissions.IterateNode(stepNode, "uses", "!!str", 0) |
| 135 | + if usesNode == nil { |
| 136 | + continue |
| 137 | + } |
| 138 | + |
| 139 | + lineNum := usesNode.Line - 1 // 0-based indexing |
| 140 | + columnNum := usesNode.Column - 1 |
| 141 | + |
| 142 | + // Replace the line |
| 143 | + oldLine := inputLines[lineNum] |
| 144 | + prefix := oldLine[:columnNum] |
| 145 | + inputLines[lineNum] = prefix + r.newAction + "@" + r.latestVersion |
| 146 | + updated = true |
| 147 | + |
| 148 | + } |
| 149 | + return inputLines, updated, nil |
| 150 | +} |
0 commit comments