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.

Sign up for GitHub

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

[pkg] fix deferring unsafe method "Close" on type "*os.File" #3548

Merged
merged 11 commits into from
Jul 20, 2022
Merged

[pkg] fix deferring unsafe method "Close" on type "*os.File" #3548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a2cf933
fix gosec error
huof6829 Jul 14, 2022
6e5b292
fix ioctl/doc gosec
huof6829 Jul 14, 2022
ed23cbc
Merge branch 'master' into fix_gosec_recovery
huof6829 Jul 18, 2022
7b5e8e7
move into defer
huof6829 Jul 18, 2022
5c265dd
move f.Close() into defer
huof6829 Jul 19, 2022
7907629
fix err return wrong
huof6829 Jul 19, 2022
aff96d2
Merge branch 'master' into fix_gosec_recovery
huof6829 Jul 19, 2022
9f9d573
Merge branch 'master' into fix_gosec_recovery
huof6829 Jul 19, 2022
85f6ba9
Merge branch 'master' into fix_gosec_recovery
raullenchai Jul 19, 2022
746ae35
Merge branch 'master' into fix_gosec_recovery
Liuhaai Jul 19, 2022
fd151a7
Merge branch 'master' into fix_gosec_recovery
Liuhaai Jul 19, 2022
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
18 changes: 10 additions & 8 deletions ioctl/doc/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ import (
// GenMarkdownTreeCustom is the the same as GenMarkdownTree, but
// with custom filePrepender and linkHandler.
func GenMarkdownTreeCustom(c *cobra.Command, dir string, name string, path string, filePrepender func(string) string,
linkHandler func(*cobra.Command, string) string) error {
linkHandler func(*cobra.Command, string) string) (err error) {
for _, child := range c.Commands() {
if !child.IsAvailableCommand() || child.IsAdditionalHelpTopicCommand() {
continue
}
if err := GenMarkdownTreeCustom(child, dir, name, path, filePrepender, linkHandler); err != nil {
if err = GenMarkdownTreeCustom(child, dir, name, path, filePrepender, linkHandler); err != nil {
return err
}
}
Expand All @@ -32,19 +32,21 @@ func GenMarkdownTreeCustom(c *cobra.Command, dir string, name string, path strin
filename = filepath.Join(path, "README.md")
}

f, err := os.Create(filepath.Clean(filename))
var f *os.File
f, err = os.Create(filepath.Clean(filename))
if err != nil {
return err
}
defer f.Close()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you check why security scan considers f.Close() as "unsafe method"? does it mean the error is not checked? like you need to:

defer func() {
    return f.Close()
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

error is skipped by defer f.Close(). it's unsafe. error should return.
defer func() error { return f.Close() }
or return f.Close() at the end of processing is both ok

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i see, so should check/catch the error inside defer

if return f.Close() at the end, also need to handle f.Close() in L42 and L45, so defer is better

Copy link
Member

@Liuhaai Liuhaai Jul 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

although current code is acceptable, you could find a new way to improve it

Copy link
Contributor Author

@huof6829 huof6829 Jul 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok. modified


if _, err := io.WriteString(f, filePrepender(filename)); err != nil {
defer func() {
err = f.Close()
}()
if _, err = io.WriteString(f, filePrepender(filename)); err != nil {
return err
}
if err := GenMarkdownCustom(c, f, linkHandler); err != nil {
if err = GenMarkdownCustom(c, f, linkHandler); err != nil {
return err
}
return nil
return err
}

// GenMarkdownCustom creates custom markdown output.
Expand Down
8 changes: 7 additions & 1 deletion pkg/recovery/recovery.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,15 @@ func writeHeapProfile(path string) {
log.S().Errorf("crashlog: open heap profile error: %v", err)
return
}
defer f.Close()
defer func() {
if err = f.Close(); err != nil {
log.S().Errorf("crashlog: close heap profile error: %v", err)
return
}
}()
if err := pprof.WriteHeapProfile(f); err != nil {
log.S().Errorf("crashlog: write heap profile error: %v", err)
return
}
}

Expand Down