scorecard/checks/binary_artifact.go
Naveen 3e1890fe35
Binary Artifact check (#563)
* Implemented binary artifact checks
2021-06-21 15:49:31 +00:00

94 lines
2.3 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"
"path/filepath"
"github.com/h2non/filetype"
"github.com/h2non/filetype/types"
"github.com/ossf/scorecard/checker"
)
//nolint
func init() {
registerCheck(CheckBinaryArtifacts, BinaryArtifacts)
}
const CheckBinaryArtifacts string = "Binary-Artifacts"
// BinaryArtifacts will check the repository if it contains binary artifacts.
func BinaryArtifacts(c *checker.CheckRequest) checker.CheckResult {
return CheckFilesContent(CheckBinaryArtifacts, "*", false, c, checkBinaryFileContent)
}
func checkBinaryFileContent(path string, content []byte,
logf func(s string, f ...interface{})) (bool, error) {
binaryFileTypes := map[string]bool{
"crx": true,
"deb": true,
"dex": true,
"dey": true,
"elf": true,
"bin": true,
"o": true,
"so": true,
"iso": true,
"class": true,
"jar": true,
"bundle": true,
"dylib": true,
"lib": true,
"msi": true,
"acm": true,
"ax": true,
"cpl": true,
"dll": true,
"drv": true,
"efi": true,
"exe": true,
"mui": true,
"ocx": true,
"scr": true,
"sys": true,
"tsp": true,
"pyc": true,
"pyo": true,
"par": true,
"rpm": true,
"swf": true,
"torrent": true,
"cab": true,
}
var t types.Type
var err error
if t, err = filetype.Get(content); err != nil {
return false, fmt.Errorf("failed in getting the content type %w", err)
}
if _, ok := binaryFileTypes[t.Extension]; ok {
logf("!! binary-artifact %s", path)
return false, nil
} else if _, ok := binaryFileTypes[filepath.Ext(path)]; ok {
// falling back to file based extension.
logf("!! binary-artifact %s", path)
return false, nil
}
return true, nil
}