Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add G307 sample code. #661

Merged
merged 8 commits into from
Jul 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 41 additions & 4 deletions rules/bad_defer.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,54 @@ func contains(methods []string, method string) bool {
func (r *badDefer) Match(n ast.Node, c *gosec.Context) (*gosec.Issue, error) {
if deferStmt, ok := n.(*ast.DeferStmt); ok {
for _, deferTyp := range r.types {
if typ, method, err := gosec.GetCallInfo(deferStmt.Call, c); err == nil {
if normalize(typ) == deferTyp.typ && contains(deferTyp.methods, method) {
return gosec.NewIssue(c, n, r.ID(), fmt.Sprintf(r.What, method, typ), r.Severity, r.Confidence), nil
}
if issue := r.checkChild(n, c, deferStmt.Call, deferTyp); issue != nil {
return issue, nil
}
if issue := r.checkFunction(n, c, deferStmt, deferTyp); issue != nil {
return issue, nil
}
}
}

return nil, nil
}

func (r *badDefer) checkChild(n ast.Node, c *gosec.Context, callExp *ast.CallExpr, deferTyp deferType) *gosec.Issue {
if typ, method, err := gosec.GetCallInfo(callExp, c); err == nil {
if normalize(typ) == deferTyp.typ && contains(deferTyp.methods, method) {
return gosec.NewIssue(c, n, r.ID(), fmt.Sprintf(r.What, method, typ), r.Severity, r.Confidence)
}
}
return nil
}

func (r *badDefer) checkFunction(n ast.Node, c *gosec.Context, deferStmt *ast.DeferStmt, deferTyp deferType) *gosec.Issue {
if anonFunc, isAnonFunc := deferStmt.Call.Fun.(*ast.FuncLit); isAnonFunc {
for _, subElem := range anonFunc.Body.List {
if issue := r.checkStmt(n, c, subElem, deferTyp); issue != nil {
return issue
}
}
}
return nil
}

func (r *badDefer) checkStmt(n ast.Node, c *gosec.Context, subElem ast.Stmt, deferTyp deferType) *gosec.Issue {
switch stmt := subElem.(type) {
case *ast.AssignStmt:
for _, rh := range stmt.Rhs {
if e, isCallExp := rh.(*ast.CallExpr); isCallExp {
return r.checkChild(n, c, e, deferTyp)
}
}
case *ast.IfStmt:
if s, is := stmt.Init.(*ast.AssignStmt); is {
return r.checkStmt(n, c, s, deferTyp)
}
}
return nil
}

// NewDeferredClosing detects unsafe defer of error returning methods
func NewDeferredClosing(id string, conf gosec.Config) (gosec.Rule, []ast.Node) {
return &badDefer{
Expand Down
85 changes: 77 additions & 8 deletions testutils/source.go
Original file line number Diff line number Diff line change
Expand Up @@ -1984,7 +1984,6 @@ func main() {
{[]string{`package main

import (
"bufio"
"fmt"
"io/ioutil"
"os"
Expand Down Expand Up @@ -2016,16 +2015,86 @@ func main() {
defer check(err)
fmt.Printf("wrote %d bytes\n", n2)

n3, err := f.WriteString("writes\n")
fmt.Printf("wrote %d bytes\n", n3)
}`}, 1, gosec.NewConfig()},
{[]string{`package main

f.Sync()
import (
"fmt"
"io/ioutil"
"log"
"os"
)

w := bufio.NewWriter(f)
n4, err := w.WriteString("buffered\n")
fmt.Printf("wrote %d bytes\n", n4)
func check(e error) {
if e != nil {
panic(e)
}
}

w.Flush()
func main() {

d1 := []byte("hello\ngo\n")
err := ioutil.WriteFile("/tmp/dat1", d1, 0744)
check(err)

allowed := ioutil.WriteFile("/tmp/dat1", d1, 0600)
check(allowed)

f, err := os.Create("/tmp/dat2")
check(err)

defer func() {
if err := f.Close(); err != nil {
log.Println(err)
}
}()

d2 := []byte{115, 111, 109, 101, 10}
n2, err := f.Write(d2)

defer check(err)
fmt.Printf("wrote %d bytes\n", n2)

}`}, 1, gosec.NewConfig()},
{[]string{`package main

import (
"fmt"
"io/ioutil"
"log"
"os"
)

func check(e error) {
if e != nil {
panic(e)
}
}

func main() {

d1 := []byte("hello\ngo\n")
err := ioutil.WriteFile("/tmp/dat1", d1, 0744)
check(err)

allowed := ioutil.WriteFile("/tmp/dat1", d1, 0600)
check(allowed)

f, err := os.Create("/tmp/dat2")
check(err)

defer func() {
err := f.Close()
if err != nil {
log.Println(err)
}
}()

d2 := []byte{115, 111, 109, 101, 10}
n2, err := f.Write(d2)

defer check(err)
fmt.Printf("wrote %d bytes\n", n2)

}`}, 1, gosec.NewConfig()},
}
Expand Down