go lock rules - defer FP fix

trailofbits · Apr 3, 2024 · b7ed449 · b7ed449
1 parent 17b707c
commit b7ed449
Show file tree

Hide file tree

Showing 4 changed files with 154 additions and 0 deletions.
diff --git a/go/missing-runlock-on-rwmutex.go b/go/missing-runlock-on-rwmutex.go
@@ -61,6 +61,7 @@ func (c *RWContainer) inc(name string) error {
 		return fmt.Errorf("letter not allowed")
 	}
 	c.mu.RUnlock()
+	// ok: missing-runlock-on-rwmutex
 	return nil
 }
 
@@ -84,6 +85,7 @@ func (c *RWContainer) inc_FP(name string) error {
 		return fmt.Errorf("letter not allowed")
 	}
 	c.mu.RUnlock()
+	// ok: missing-runlock-on-rwmutex
 	return nil
 }
 
@@ -102,3 +104,71 @@ func (c *RWContainer) inc5(name string) error {
 	// ok: missing-runlock-on-rwmutex
 	return nil
 }
+
+func (c *RWContainer) inc6(name string) error {
+	c.mu.RLock()
+	c.counters[name]++
+	defer func() {
+		fmt.Println("before runlock")
+		c.mu.RUnlock()
+		fmt.Println("after runlock")
+	}()
+	// ok: missing-runlock-on-rwmutex
+	return nil
+}
+
+func (c *RWContainer) inc6b(name string) error {
+	c.mu.RLock()
+	unlocker := c.mu.RUnlock
+	c.counters[name]++
+	defer func() {
+		fmt.Println("before runlock")
+		unlocker()
+		fmt.Println("after runlock")
+	}()
+	// todook: missing-runlock-on-rwmutex
+	return nil
+}
+
+func (c *RWContainer) inc7(name string) error {
+	c.mu.RLock()
+	c.counters[name]++
+	defer func(earlyExit bool) {
+		fmt.Println("before runlock")
+		if (earlyExit) {
+			// todoruleid: missing-runlock-on-rwmutex
+			return
+		}
+		c.mu.RUnlock()
+		fmt.Println("after runlock")
+	}(false)
+	// ok: missing-runlock-on-rwmutex
+	return nil
+}
+
+func (c *RWContainer) inc8(name string) error {
+	c.mu.RLock()
+	c.counters[name]++
+	_, err := fmt.Println("test if")
+	if err != nil {
+	    c.mu.RUnlock()
+	    // ok: missing-runlock-on-rwmutex
+	    return nil, err
+	}
+	// ruleid: missing-runlock-on-rwmutex
+	return nil
+}
+
+func (c *RWContainer) inc8b(name string) error {
+	c.mu.RLock()
+	c.counters[name]++
+	unlocker := c.mu.RUnlock
+	_, err := fmt.Println("test if")
+	if err != nil {
+	    unlocker()
+	    // todook: missing-runlock-on-rwmutex
+	    return nil, err
+	}
+	// ruleid: missing-runlock-on-rwmutex
+	return nil
+}
diff --git a/go/missing-runlock-on-rwmutex.yaml b/go/missing-runlock-on-rwmutex.yaml
@@ -35,6 +35,13 @@ rules:
       - pattern-not-inside: |
           defer $T.RUnlock()
           ...
+      - pattern-not-inside: |
+          defer func(...) {
+            ...
+            $T.RUnlock()
+            ...
+          }(...)
+          ...
       - pattern-not-inside: |
           $FOO(..., ..., func(...) { 
               ... 

diff --git a/go/missing-unlock-before-return.go b/go/missing-unlock-before-return.go
@@ -61,6 +61,7 @@ func (c *Container) inc(name string) error {
 		return fmt.Errorf("letter not allowed")
 	}
 	c.mu.Unlock()
+	// ok: missing-unlock-before-return
 	return nil
 }
 
@@ -73,6 +74,7 @@ func (c *Container) inc_FP(name string) error {
 		return fmt.Errorf("letter not allowed")
 	}
 	c.mu.Unlock()
+	// ok: missing-unlock-before-return
 	return nil
 }
 
@@ -86,6 +88,7 @@ func (c *Container) inc2(name string) error {
 		panic("letter not allowed")
 	}
 	c.mu.Unlock()
+	// ok: missing-unlock-before-return
 	return nil
 }
 
@@ -98,6 +101,7 @@ func (c *Container) inc2_FP(name string) error {
 		panic("letter not allowed")
 	}
 	c.mu.Unlock()
+	// ok: missing-unlock-before-return
 	return nil
 }
 
@@ -129,4 +133,70 @@ func (c *Container) inc5(name string) error {
 	return nil
 }
 
+func (c *Container) inc6(name string) error {
+	c.mu.Lock()
+	c.counters[name]++
+	defer func() {
+		fmt.Println("before unlock")
+		c.mu.Unlock()
+		fmt.Println("after unlock")
+	}()
+	// ok: missing-unlock-before-return
+	return nil
+}
+
+func (c *Container) inc6b(name string) error {
+	c.mu.Lock()
+	unlocker := c.mu.Unlock
+	c.counters[name]++
+	defer func() {
+		fmt.Println("before unlock")
+		unlocker()
+		fmt.Println("after unlock")
+	}()
+	// todook: missing-unlock-before-return
+	return nil
+}
+
+func (c *Container) inc7(name string) error {
+	c.mu.Lock()
+	c.counters[name]++
+	defer func(earlyExit bool) {
+		fmt.Println("before unlock")
+		if (earlyExit) {
+			// todoruleid: missing-unlock-before-return
+			return
+		}
+		c.mu.Unlock()
+		fmt.Println("after unlock")
+	}(false)
+	// ok: missing-unlock-before-return
+	return nil
+}
+
+func (c *Container) inc8(name string) error {
+	c.mu.Lock()
+	c.counters[name]++
+	_, err := fmt.Println("test if")
+	if err != nil {
+	    c.mu.Unlock()
+	    // ok: missing-unlock-before-return
+	    return nil, err
+	}
+	// ruleid: missing-unlock-before-return
+	return nil
+}
 
+func (c *Container) inc8b(name string) error {
+	c.mu.Lock()
+	c.counters[name]++
+	unlocker := c.mu.Unlock
+	_, err := fmt.Println("test if")
+	if err != nil {
+	    unlocker()
+	    // todook: missing-unlock-before-return
+	    return nil, err
+	}
+	// ruleid: missing-unlock-before-return
+	return nil
+}
diff --git a/go/missing-unlock-before-return.yaml b/go/missing-unlock-before-return.yaml
@@ -36,6 +36,13 @@ rules:
       - pattern-not-inside: |
           defer $T.Unlock()
           ...
+      - pattern-not-inside: |
+          defer func(...) {
+            ...
+            $T.Unlock()
+            ...
+          }(...)
+          ...
       - pattern-not-inside: |
           $FOO(..., ..., func(...) { 
               ...