mirror of
https://github.com/securego/gosec.git
synced 2024-11-05 19:45:51 +00:00
109 lines
3.9 KiB
Go
109 lines
3.9 KiB
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 "github.com/securego/gosec"
|
|
|
|
// RuleDefinition contains the description of a rule and a mechanism to
|
|
// create it.
|
|
type RuleDefinition struct {
|
|
ID string
|
|
Description string
|
|
Create gosec.RuleBuilder
|
|
}
|
|
|
|
// RuleList is a mapping of rule ID's to rule definitions
|
|
type RuleList map[string]RuleDefinition
|
|
|
|
// Builders returns all the create methods for a given rule list
|
|
func (rl RuleList) Builders() map[string]gosec.RuleBuilder {
|
|
builders := make(map[string]gosec.RuleBuilder)
|
|
for _, def := range rl {
|
|
builders[def.ID] = def.Create
|
|
}
|
|
return builders
|
|
}
|
|
|
|
// RuleFilter can be used to include or exclude a rule depending on the return
|
|
// value of the function
|
|
type RuleFilter func(string) bool
|
|
|
|
// NewRuleFilter is a closure that will include/exclude the rule ID's based on
|
|
// the supplied boolean value.
|
|
func NewRuleFilter(action bool, ruleIDs ...string) RuleFilter {
|
|
rulelist := make(map[string]bool)
|
|
for _, rule := range ruleIDs {
|
|
rulelist[rule] = true
|
|
}
|
|
return func(rule string) bool {
|
|
if _, found := rulelist[rule]; found {
|
|
return action
|
|
}
|
|
return !action
|
|
}
|
|
}
|
|
|
|
// Generate the list of rules to use
|
|
func Generate(filters ...RuleFilter) RuleList {
|
|
rules := []RuleDefinition{
|
|
// misc
|
|
{"G101", "Look for hardcoded credentials", NewHardcodedCredentials},
|
|
{"G102", "Bind to all interfaces", NewBindsToAllNetworkInterfaces},
|
|
{"G103", "Audit the use of unsafe block", NewUsingUnsafe},
|
|
{"G104", "Audit errors not checked", NewNoErrorCheck},
|
|
{"G106", "Audit the use of ssh.InsecureIgnoreHostKey function", NewSSHHostKey},
|
|
{"G107", "Url provided to HTTP request as taint input", NewSSRFCheck},
|
|
{"G108", "Profiling endpoint is automatically exposed", NewPprofCheck},
|
|
|
|
// injection
|
|
{"G201", "SQL query construction using format string", NewSQLStrFormat},
|
|
{"G202", "SQL query construction using string concatenation", NewSQLStrConcat},
|
|
{"G203", "Use of unescaped data in HTML templates", NewTemplateCheck},
|
|
{"G204", "Audit use of command execution", NewSubproc},
|
|
|
|
// filesystem
|
|
{"G301", "Poor file permissions used when creating a directory", NewMkdirPerms},
|
|
{"G302", "Poor file permissions used when creation file or using chmod", NewFilePerms},
|
|
{"G303", "Creating tempfile using a predictable path", NewBadTempFile},
|
|
{"G304", "File path provided as taint input", NewReadFile},
|
|
{"G305", "File path traversal when extracting zip archive", NewArchive},
|
|
|
|
// crypto
|
|
{"G401", "Detect the usage of DES, RC4, MD5 or SHA1", NewUsesWeakCryptography},
|
|
{"G402", "Look for bad TLS connection settings", NewIntermediateTLSCheck},
|
|
{"G403", "Ensure minimum RSA key length of 2048 bits", NewWeakKeyStrength},
|
|
{"G404", "Insecure random number source (rand)", NewWeakRandCheck},
|
|
|
|
// blacklist
|
|
{"G501", "Import blacklist: crypto/md5", NewBlacklistedImportMD5},
|
|
{"G502", "Import blacklist: crypto/des", NewBlacklistedImportDES},
|
|
{"G503", "Import blacklist: crypto/rc4", NewBlacklistedImportRC4},
|
|
{"G504", "Import blacklist: net/http/cgi", NewBlacklistedImportCGI},
|
|
{"G505", "Import blacklist: crypto/sha1", NewBlacklistedImportSHA1},
|
|
}
|
|
|
|
ruleMap := make(map[string]RuleDefinition)
|
|
|
|
RULES:
|
|
for _, rule := range rules {
|
|
for _, filter := range filters {
|
|
if filter(rule.ID) {
|
|
continue RULES
|
|
}
|
|
}
|
|
ruleMap[rule.ID] = rule
|
|
}
|
|
return ruleMap
|
|
}
|