Skip to content

Commit

Permalink
all: gofmt
Browse files Browse the repository at this point in the history 
Gofmt to update doc comments to the new formatting.

For golang/go#51082.

Change-Id: I5fd6eaa2a711d27051045aaaef45799a12777e48
Reviewed-on: https://go-review.googlesource.com/c/vuln/+/399605
Run-TryBot: Russ Cox <rsc@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Auto-Submit: Russ Cox <rsc@golang.org>
Reviewed-by: Roland Shoemaker <roland@golang.org>
  • Loading branch information
@stanislavkononiuk
stanislavkononiuk committed Apr 11, 2022
1 parent fa6a11c commit fd3a68d
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 54 deletions.
4 changes: 2 additions & 2 deletions client/client.go
View file
Expand Up @@ -12,7 +12,7 @@
// was added. The index file is called indx.json, and has the
// following format:
//
// map[string]time.Time (DBIndex)
// map[string]time.Time (DBIndex)
//
// Each vulnerable module is represented by an individual JSON file
// which contains all of the vulnerabilities in that module. The path
Expand All @@ -21,7 +21,7 @@
// golang.org/x/crypto.json file. The per-module JSON files have
// the following format:
//
// []osv.Entry
// []osv.Entry
//
// A single client.Client can be used to access multiple vulnerability
// databases. When looking up vulnerable module each database is
Expand Down
11 changes: 6 additions & 5 deletions cmd/govulncheck/main.go
View file
Expand Up @@ -11,7 +11,7 @@
// It uses static analysis or the binary's symbol table to narrow down reports to only
// those that potentially affect the application.
//
// WARNING WARNING WARNING
// # WARNING WARNING WARNING
//
// govulncheck is still experimental and neither its output or the vulnerability
// database should be relied on to be stable or comprehensive.
Expand Down Expand Up @@ -290,10 +290,11 @@ func latestFixed(as []osv.Affected) string {
// summarizeCallStack returns a short description of the call stack.
// It uses one of two forms, depending on what the lowest function F in topPkgs
// calls:
// - If it calls a function V from the vulnerable package, then summarizeCallStack
// returns "F calls V".
// - If it calls a function G in some other package, which eventually calls V,
// it returns "F calls G, which eventually calls V".
// - If it calls a function V from the vulnerable package, then summarizeCallStack
// returns "F calls V".
// - If it calls a function G in some other package, which eventually calls V,
// it returns "F calls G, which eventually calls V".
//
// If it can't find any of these functions, summarizeCallStack returns the empty string.
func summarizeCallStack(cs vulncheck.CallStack, topPkgs map[string]bool, vulnPkg string) string {
// Find the lowest function in the top packages.
Expand Down
2 changes: 1 addition & 1 deletion vulncheck/binary_test.go
View file
Expand Up @@ -131,7 +131,7 @@ func TestBinary(t *testing.T) {
}
}

// hasGoBuild reports whether the current system can build programs with ``go build''
// hasGoBuild reports whether the current system can build programs with “go build”
// and then run them with os.StartProcess or exec.Command.
//
// Duplicated from std/internal/testenv
Expand Down
5 changes: 3 additions & 2 deletions vulncheck/helpers_test.go
View file
Expand Up @@ -25,8 +25,9 @@ func (mc *mockClient) GetByModule(ctx context.Context, a string) ([]*osv.Entry,
}

// testClient contains the following test vulnerabilities
// golang.org/amod/avuln.{VulnData.Vuln1, vulnData.Vuln2}
// golang.org/bmod/bvuln.{Vuln}
//
// golang.org/amod/avuln.{VulnData.Vuln1, vulnData.Vuln2}
// golang.org/bmod/bvuln.{Vuln}
var testClient = &mockClient{
ret: map[string][]*osv.Entry{
"golang.org/amod": []*osv.Entry{
Expand Down
12 changes: 6 additions & 6 deletions vulncheck/source.go
View file
Expand Up @@ -17,12 +17,12 @@ import (
)

// Source detects vulnerabilities in pkgs and computes slices of
// - imports graph related to an import of a package with some
// known vulnerabilities
// - requires graph related to a require of a module with a
// package that has some known vulnerabilities
// - call graph leading to the use of a known vulnerable function
// or method
// - imports graph related to an import of a package with some
// known vulnerabilities
// - requires graph related to a require of a module with a
// package that has some known vulnerabilities
// - call graph leading to the use of a known vulnerable function
// or method
func Source(ctx context.Context, pkgs []*Package, cfg *Config) (_ *Result, err error) {
defer derrors.Wrap(&err, "vulncheck.Source")

Expand Down
67 changes: 34 additions & 33 deletions vulncheck/source_test.go
View file
Expand Up @@ -19,13 +19,13 @@ import (
// for the Config.ImportsOnly=true mode. The inlined test code has
// the following package (left) and module (right) imports graphs:
//
// entry/x entry/y entry
// \ / \ / \
// amod/avuln zmod/z amod zmod
// | |
// wmod/w wmod
// | |
// bmod/bvuln bmod
// entry/x entry/y entry
// \ / \ / \
// amod/avuln zmod/z amod zmod
// | |
// wmod/w wmod
// | |
// bmod/bvuln bmod
//
// Packages ending in "vuln" have some known vulnerabilities.
func TestImportsOnly(t *testing.T) {
Expand Down Expand Up @@ -171,37 +171,38 @@ func TestImportsOnly(t *testing.T) {
// TestCallGraph checks for call graph vuln slicing correctness.
// The inlined test code has the following call graph
//
// x.X
// / | \
// / d.D1 avuln.VulnData.Vuln1
// / / |
// c.C1 d.internal.Vuln1
// |
// avuln.VulnData.Vuln2
// x.X
// / | \
// / d.D1 avuln.VulnData.Vuln1
// / / |
// c.C1 d.internal.Vuln1
// |
// avuln.VulnData.Vuln2
//
// --------------------y.Y-------------------------------
// / / \ \ \ \
// / / \ \ \ \
// / / \ \ \ \
// c.C4 c.vulnWrap.V.Vuln1(=nil) c.C2 bvuln.Vuln c.C3 c.C3$1
// | | |
// y.benign e.E
// --------------------y.Y-------------------------------
// / / \ \ \ \
// / / \ \ \ \
// / / \ \ \ \
// c.C4 c.vulnWrap.V.Vuln1(=nil) c.C2 bvuln.Vuln c.C3 c.C3$1
// | | |
// y.benign e.E
//
// and this slice
//
// x.X
// / | \
// / d.D1 avuln.VulnData.Vuln1
// / /
// c.C1
// |
// avuln.VulnData.Vuln2
// x.X
// / | \
// / d.D1 avuln.VulnData.Vuln1
// / /
// c.C1
// |
// avuln.VulnData.Vuln2
//
// y.Y
// |
// bvuln.Vuln
// | |
// e.E
//
// y.Y
// |
// bvuln.Vuln
// | |
// e.E
// related to avuln.VulnData.{Vuln1, Vuln2} and bvuln.Vuln vulnerabilities.
func TestCallGraph(t *testing.T) {
e := packagestest.Export(t, packagestest.Modules, []packagestest.Module{
Expand Down
11 changes: 6 additions & 5 deletions vulncheck/utils.go
View file
Expand Up @@ -98,8 +98,8 @@ func siteCallees(call ssa.CallInstruction, callgraph *callgraph.Graph) []*ssa.Fu

// dbTypeFormat formats the name of t according how types
// are encoded in vulnerability database:
// - pointer designation * is skipped
// - full path prefix is skipped as well
// - pointer designation * is skipped
// - full path prefix is skipped as well
func dbTypeFormat(t types.Type) string {
switch tt := t.(type) {
case *types.Pointer:
Expand All @@ -118,9 +118,10 @@ func dbTypeFormat(t types.Type) string {
// enclosing package, but not globally.
//
// Examples:
// func (a A) foo (...) {...} -> A.foo
// func foo(...) {...} -> foo
// func (b *B) bar (...) {...} -> B.bar
//
// func (a A) foo (...) {...} -> A.foo
// func foo(...) {...} -> foo
// func (b *B) bar (...) {...} -> B.bar
func dbFuncName(f *ssa.Function) string {
selectBound := func(f *ssa.Function) types.Type {
// If f is a "bound" function introduced by ssa for a given type, return the type.
Expand Down

0 comments on commit fd3a68d

Please sign in to comment.