diff --git a/remediation/workflow/addworkflow.go b/remediation/workflow/addworkflow.go new file mode 100644 index 00000000..593de38d --- /dev/null +++ b/remediation/workflow/addworkflow.go @@ -0,0 +1,50 @@ +package workflow + +import ( + "fmt" + "io/ioutil" + "os" + "path" + "sort" + "strings" +) + +const CodeQLWorkflowFileName = "codeql.yml" + +type WorkflowParameters struct { + LanguagesToAdd []string + DefaultBranch string +} + +func getTemplate(file string) (string, error) { + templatePath := os.Getenv("WORKFLOW_TEMPLATES") + + if templatePath == "" { + templatePath = "../../workflow-templates" + } + + template, err := ioutil.ReadFile(path.Join(templatePath, file)) + if err != nil { + return "", err + } + + return string(template), nil +} + +func AddWorkflow(name string, workflowParameters WorkflowParameters) (string, error) { + if name == "codeql" { + codeqlWorkflow, err := getTemplate(CodeQLWorkflowFileName) + if err != nil { + return "", err + } + + sort.Strings(workflowParameters.LanguagesToAdd) + codeqlWorkflow = strings.ReplaceAll(codeqlWorkflow, "$default-branch", fmt.Sprintf(`"%s"`, workflowParameters.DefaultBranch)) + codeqlWorkflow = strings.ReplaceAll(codeqlWorkflow, "$detected-codeql-languages", strings.Join(workflowParameters.LanguagesToAdd, ", ")) + codeqlWorkflow = strings.ReplaceAll(codeqlWorkflow, "$cron-weekly", fmt.Sprintf(`"%s"`, "0 0 * * 1")) // Note: Runs every monday at 12:00 AM + + return codeqlWorkflow, nil + } else { + return "", fmt.Errorf("match for %s Workflow name not found", name) + } +} diff --git a/remediation/workflow/addworkflow_test.go b/remediation/workflow/addworkflow_test.go new file mode 100644 index 00000000..5d8c8ad2 --- /dev/null +++ b/remediation/workflow/addworkflow_test.go @@ -0,0 +1,54 @@ +package workflow + +import ( + "io/ioutil" + "reflect" + "testing" +) + +func Test_AddWorkflow(t *testing.T) { + tests := []struct { + workflowName string + workflowParameters WorkflowParameters + expectedError bool + expectedOutputFile string + }{ + { + workflowName: "codeql", + workflowParameters: WorkflowParameters{ + LanguagesToAdd: []string{"cpp", "go", "java"}, + DefaultBranch: "main", + }, + expectedError: false, + expectedOutputFile: "../../testfiles/expected-codeql.yml", + }, + { + workflowName: "xyz", + workflowParameters: WorkflowParameters{ + LanguagesToAdd: []string{"cpp"}, + DefaultBranch: "main", + }, + expectedError: true, + expectedOutputFile: "", + }, + } + + for _, test := range tests { + output, err := AddWorkflow(test.workflowName, test.workflowParameters) + if err != nil { + if !test.expectedError { + t.Errorf("Error adding Workflow: %v", err) + } + continue + } + expectedOutput, err := ioutil.ReadFile(test.expectedOutputFile) + if err != nil { + t.Errorf("Error in reading file: %v", err) + } + + if !reflect.DeepEqual(output, string(expectedOutput)) { + t.Errorf("test failed %s did not match expected output\n%s", test.workflowName, output) + } + } + +} diff --git a/testfiles/expected-codeql.yml b/testfiles/expected-codeql.yml new file mode 100644 index 00000000..df80d4d9 --- /dev/null +++ b/testfiles/expected-codeql.yml @@ -0,0 +1,76 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: ["main"] + pull_request: + # The branches below must be a subset of the branches above + branches: ["main"] + schedule: + - cron: "0 0 * * 1" + +permissions: # added using https://github.com/step-security/secure-workflows + contents: read + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [cpp, go, java] + # CodeQL supports [ $supported-codeql-languages ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 + with: + category: "/language:${{matrix.language}}" \ No newline at end of file diff --git a/workflow-templates/codeql.yml b/workflow-templates/codeql.yml new file mode 100644 index 00000000..9037cdbb --- /dev/null +++ b/workflow-templates/codeql.yml @@ -0,0 +1,76 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [$default-branch] + pull_request: + # The branches below must be a subset of the branches above + branches: [$default-branch] + schedule: + - cron: $cron-weekly + +permissions: # added using https://github.com/step-security/secure-workflows + contents: read + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [$detected-codeql-languages] + # CodeQL supports [ $supported-codeql-languages ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 + with: + category: "/language:${{matrix.language}}" \ No newline at end of file