mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-11 00:45:36 +03:00
460 lines
12 KiB
Go
460 lines
12 KiB
Go
// Copyright 2021 Security Scorecard Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package checks
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/ossf/scorecard/v4/checker"
|
|
scut "github.com/ossf/scorecard/v4/utests"
|
|
)
|
|
|
|
type file struct {
|
|
pathfn string
|
|
content []byte
|
|
}
|
|
|
|
func testValidateGitHubActionTokenPermissions(files []file,
|
|
dl checker.DetailLogger,
|
|
) checker.CheckResult {
|
|
data := permissionCbData{
|
|
workflows: make(map[string]permissions),
|
|
}
|
|
var err error
|
|
for _, f := range files {
|
|
_, err = validateGitHubActionTokenPermissions(f.pathfn, f.content, dl, &data)
|
|
if err != nil {
|
|
break
|
|
}
|
|
}
|
|
|
|
return createResultForLeastPrivilegeTokens(data, err)
|
|
}
|
|
|
|
//nolint
|
|
func TestGithubTokenPermissions(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
filenames []string
|
|
expected scut.TestReturn
|
|
}{
|
|
{
|
|
name: "run workflow codeql write test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-run-codeql-write.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "run workflow no codeql write test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-run-no-codeql-write.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore - 1,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "run workflow write test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-run-writes-2.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 3,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "run package workflow write test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-run-package-workflow-write.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "run package write test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-run-package-write.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "run writes test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-run-writes.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "write all test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-writeall.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 0,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "read all test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-readall.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "no permission test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-absent.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 0,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "writes test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-writes.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 7,
|
|
},
|
|
},
|
|
{
|
|
name: "reads test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-reads.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 10,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "nones test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-nones.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 10,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "none test",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-none.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "status/checks write",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-status-checks.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore - 1,
|
|
NumberOfWarn: 2,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 7,
|
|
},
|
|
},
|
|
{
|
|
name: "sec-events/deployments write",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-secevent-deployments.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore - 2,
|
|
NumberOfWarn: 2,
|
|
NumberOfInfo: 3,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "contents write",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-contents.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "actions write",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-actions.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "packages write",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-packages.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 6,
|
|
},
|
|
},
|
|
{
|
|
name: "Non-yaml file",
|
|
filenames: []string{"./testdata/script.sh"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 0,
|
|
NumberOfDebug: 0,
|
|
},
|
|
},
|
|
{
|
|
name: "package workflow contents write",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-contents-writes-no-release.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 4,
|
|
},
|
|
},
|
|
{
|
|
name: "release workflow contents write",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-contents-writes-release.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 3,
|
|
NumberOfDebug: 3,
|
|
},
|
|
},
|
|
{
|
|
name: "package workflow write",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-packages-writes.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "workflow jobs only",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-jobs-only.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: 9,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 3,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "security-events write, codeql comment",
|
|
filenames: []string{"./testdata/.github/workflows/github-workflow-permissions-run-write-codeql-comment.yaml"},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore - 1,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "two files mix run-level and top-level",
|
|
filenames: []string{
|
|
"./testdata/.github/workflows/github-workflow-permissions-top-level-only.yaml",
|
|
"./testdata/.github/workflows/github-workflow-permissions-run-level-only.yaml",
|
|
},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore - 1,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 11,
|
|
},
|
|
},
|
|
{
|
|
name: "two files mix run-level and absent",
|
|
filenames: []string{
|
|
"./testdata/.github/workflows/github-workflow-permissions-run-level-only.yaml",
|
|
"./testdata/.github/workflows/github-workflow-permissions-absent.yaml",
|
|
},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 2,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 11,
|
|
},
|
|
},
|
|
{
|
|
name: "two files mix top-level and absent",
|
|
filenames: []string{
|
|
"./testdata/.github/workflows/github-workflow-permissions-top-level-only.yaml",
|
|
"./testdata/.github/workflows/github-workflow-permissions-absent.yaml",
|
|
},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MinResultScore,
|
|
NumberOfWarn: 1,
|
|
NumberOfInfo: 1,
|
|
NumberOfDebug: 12,
|
|
},
|
|
},
|
|
{
|
|
name: "read permission with GitHub pages write",
|
|
filenames: []string{
|
|
"./testdata/.github/workflows/github-workflow-permissions-gh-pages.yaml",
|
|
},
|
|
expected: scut.TestReturn{
|
|
Error: nil,
|
|
Score: checker.MaxResultScore,
|
|
NumberOfWarn: 0,
|
|
NumberOfInfo: 2,
|
|
NumberOfDebug: 5,
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
tt := tt // Re-initializing variable so it is not changed while executing the closure below
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
var files []file
|
|
var content []byte
|
|
var err error
|
|
for _, fn := range tt.filenames {
|
|
content, err = os.ReadFile(fn)
|
|
if err != nil {
|
|
panic(fmt.Errorf("cannot read file: %w", err))
|
|
}
|
|
|
|
files = append(files, file{pathfn: strings.Replace(fn, "./testdata/", "", 1), content: content})
|
|
}
|
|
|
|
dl := scut.TestDetailLogger{}
|
|
r := testValidateGitHubActionTokenPermissions(files, &dl)
|
|
if !scut.ValidateTestReturn(t, tt.name, &tt.expected, &r, &dl) {
|
|
t.Fail()
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGithubTokenPermissionsLineNumber(t *testing.T) {
|
|
t.Parallel()
|
|
tests := []struct {
|
|
name string
|
|
filename string
|
|
expected []struct {
|
|
lineNumber uint
|
|
}
|
|
}{
|
|
{
|
|
name: "Job level write permission",
|
|
filename: "./testdata/.github/workflows/github-workflow-permissions-run-no-codeql-write.yaml",
|
|
expected: []struct {
|
|
lineNumber uint
|
|
}{
|
|
{
|
|
lineNumber: 22,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "Workflow level write permission",
|
|
filename: "./testdata/.github/workflows/github-workflow-permissions-writeall.yaml",
|
|
expected: []struct {
|
|
lineNumber uint
|
|
}{
|
|
{
|
|
lineNumber: 16,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
tt := tt // Re-initializing variable so it is not changed while executing the closure below
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
content, err := os.ReadFile(tt.filename)
|
|
if err != nil {
|
|
t.Errorf("cannot read file: %v", err)
|
|
}
|
|
dl := scut.TestDetailLogger{}
|
|
p := strings.Replace(tt.filename, "./testdata/", "", 1)
|
|
files := []file{{pathfn: p, content: content}}
|
|
|
|
testValidateGitHubActionTokenPermissions(files, &dl)
|
|
for _, expectedLog := range tt.expected {
|
|
isExpectedLog := func(logMessage checker.LogMessage, logType checker.DetailType) bool {
|
|
return logMessage.Offset == expectedLog.lineNumber && logMessage.Path == p &&
|
|
logType == checker.DetailWarn
|
|
}
|
|
if !scut.ValidateLogMessage(isExpectedLog, &dl) {
|
|
t.Errorf("test failed: log message not present: %+v", tt.expected)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|