gosec/rules/fileperms.go

// (c) Copyright 2016 Hewlett Packard Enterprise Development LP
//
// 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 rules

import (
	"fmt"
	"go/ast"
	"strconv"

	gas "github.com/GoASTScanner/gas/core"
)

type FilePermissions struct {
	gas.MetaData
	mode  int64
	pkg   string
	calls []string
}

func getConfiguredMode(conf map[string]interface{}, configKey string, defaultMode int64) int64 {
	var mode int64 = defaultMode
	if value, ok := conf[configKey]; ok {
		switch value.(type) {
		case int64:
			mode = value.(int64)
		case string:
			mode, _ = strconv.ParseInt(value.(string), 0, 64)
		}
	}
	return mode
}

func (r *FilePermissions) Match(n ast.Node, c *gas.Context) (*gas.Issue, error) {
	if callexpr, matched := gas.MatchCallByPackage(n, c, r.pkg, r.calls...); matched {
		modeArg := callexpr.Args[len(callexpr.Args)-1]
		if mode, err := gas.GetInt(modeArg); err == nil && mode > r.mode {
			return gas.NewIssue(c, n, r.What, r.Severity, r.Confidence), nil
		}
	}
	return nil, nil
}

func NewFilePerms(conf map[string]interface{}) (gas.Rule, []ast.Node) {
	mode := getConfiguredMode(conf, "G302", 0600)
	return &FilePermissions{
		mode:  mode,
		pkg:   "os",
		calls: []string{"OpenFile", "Chmod"},
		MetaData: gas.MetaData{
			Severity:   gas.Medium,
			Confidence: gas.High,
			What:       fmt.Sprintf("Expect file permissions to be %#o or less", mode),
		},
	}, []ast.Node{(*ast.CallExpr)(nil)}
}

func NewMkdirPerms(conf map[string]interface{}) (gas.Rule, []ast.Node) {
	mode := getConfiguredMode(conf, "G301", 0700)
	return &FilePermissions{
		mode:  mode,
		pkg:   "os",
		calls: []string{"Mkdir", "MkdirAll"},
		MetaData: gas.MetaData{
			Severity:   gas.Medium,
			Confidence: gas.High,
			What:       fmt.Sprintf("Expect directory permissions to be %#o or less", mode),
		},
	}, []ast.Node{(*ast.CallExpr)(nil)}
}