// (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 ( "go/ast" "regexp" "github.com/securego/gosec" ) type sqlStatement struct { gosec.MetaData // Contains a list of patterns which must all match for the rule to match. patterns []*regexp.Regexp } func (s *sqlStatement) ID() string { return s.MetaData.ID } // See if the string matches the patterns for the statement. func (s *sqlStatement) MatchPatterns(str string) bool { for _, pattern := range s.patterns { if !pattern.MatchString(str) { return false } } return true } type sqlStrConcat struct { sqlStatement } func (s *sqlStrConcat) ID() string { return s.MetaData.ID } // see if we can figure out what it is func (s *sqlStrConcat) checkObject(n *ast.Ident) bool { if n.Obj != nil { return n.Obj.Kind != ast.Var && n.Obj.Kind != ast.Fun } return false } // Look for "SELECT * FROM table WHERE " + " ' OR 1=1" func (s *sqlStrConcat) Match(n ast.Node, c *gosec.Context) (*gosec.Issue, error) { if node, ok := n.(*ast.BinaryExpr); ok { if start, ok := node.X.(*ast.BasicLit); ok { if str, e := gosec.GetString(start); e == nil { if !s.MatchPatterns(str) { return nil, nil } if _, ok := node.Y.(*ast.BasicLit); ok { return nil, nil // string cat OK } if second, ok := node.Y.(*ast.Ident); ok && s.checkObject(second) { return nil, nil } return gosec.NewIssue(c, n, s.ID(), s.What, s.Severity, s.Confidence), nil } } } return nil, nil } // NewSQLStrConcat looks for cases where we are building SQL strings via concatenation func NewSQLStrConcat(id string, conf gosec.Config) (gosec.Rule, []ast.Node) { return &sqlStrConcat{ sqlStatement: sqlStatement{ patterns: []*regexp.Regexp{ regexp.MustCompile(`(?)(SELECT|DELETE|INSERT|UPDATE|INTO|FROM|WHERE) `), }, MetaData: gosec.MetaData{ ID: id, Severity: gosec.Medium, Confidence: gosec.High, What: "SQL string concatenation", }, }, }, []ast.Node{(*ast.BinaryExpr)(nil)} } type sqlStrFormat struct { sqlStatement calls gosec.CallList noIssue gosec.CallList } // Looks for "fmt.Sprintf("SELECT * FROM foo where '%s', userInput)" func (s *sqlStrFormat) Match(n ast.Node, c *gosec.Context) (*gosec.Issue, error) { // argIndex changes the function argument which gets matched to the regex argIndex := 0 // TODO(gm) improve confidence if database/sql is being used if node := s.calls.ContainsCallExpr(n, c); node != nil { // if the function is fmt.Fprintf, search for SQL statement in Args[1] instead if sel, ok := node.Fun.(*ast.SelectorExpr); ok { if sel.Sel.Name == "Fprintf" { // if os.Stderr or os.Stdout is in Arg[0], mark as no issue if arg, ok := node.Args[0].(*ast.SelectorExpr); ok { if ident, ok := arg.X.(*ast.Ident); ok { if s.noIssue.Contains(ident.Name, arg.Sel.Name) { return nil, nil } } } // the function is Fprintf so set argIndex = 1 argIndex = 1 } } // concats callexpr arg strings together if needed before regex evaluation if argExpr, ok := node.Args[argIndex].(*ast.BinaryExpr); ok { if fullStr, ok := gosec.ConcatString(argExpr); ok { if s.MatchPatterns(fullStr) { return gosec.NewIssue(c, n, s.ID(), s.What, s.Severity, s.Confidence), nil } } } if arg, e := gosec.GetString(node.Args[argIndex]); s.MatchPatterns(arg) && e == nil { return gosec.NewIssue(c, n, s.ID(), s.What, s.Severity, s.Confidence), nil } } return nil, nil } // NewSQLStrFormat looks for cases where we're building SQL query strings using format strings func NewSQLStrFormat(id string, conf gosec.Config) (gosec.Rule, []ast.Node) { rule := &sqlStrFormat{ calls: gosec.NewCallList(), noIssue: gosec.NewCallList(), sqlStatement: sqlStatement{ patterns: []*regexp.Regexp{ regexp.MustCompile("(?)(SELECT|DELETE|INSERT|UPDATE|INTO|FROM|WHERE) "), regexp.MustCompile("%[^bdoxXfFp]"), }, MetaData: gosec.MetaData{ ID: id, Severity: gosec.Medium, Confidence: gosec.High, What: "SQL string formatting", }, }, } rule.calls.AddAll("fmt", "Sprint", "Sprintf", "Sprintln", "Fprintf") rule.noIssue.AddAll("os", "Stdout", "Stderr") return rule, []ast.Node{(*ast.CallExpr)(nil)} }