Go Vulnerability Management (x/vuln)

https://pkg.go.dev/golang.org/x/vuln
Admin
Go Vulnerability Management provides tooling for analyzing codebases and binaries to detect known...
Tokens:32,393
Snippets:340
Trust Score:9.6
Update:9 hours ago
Show doc for...
Tokens:
Raw
### Install govulncheck with go install

Source: https://pkg.go.dev/golang.org/x/vuln

Installs the latest version of govulncheck using the go install command. This is the recommended way to get the tool.

```bash
go install golang.org/x/vuln/cmd/govulncheck@latest
```

--------------------------------

### Example call stack summary output

Source: https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck

Example output format showing how govulncheck summarizes a call stack, indicating the file, line, column, and the vulnerable function call.

```text
main.go:[line]:[column]: mypackage.main calls golang.org/x/text/language.Parse
```

--------------------------------

### (*Cmd).Start() error

Source: https://pkg.go.dev/golang.org/x/vuln/scan

Start starts the specified command but does not wait for it to complete. After a successful call to Start, the Wait method must be called to release associated system resources.

```APIDOC
## (*Cmd).Start() error

### Description
Start starts the specified command but does not wait for it to complete. After a successful call to Start, the Wait method must be called to release associated system resources.

### Method Signature
func (c *Cmd) Start() error

### Parameters
- **c** (*Cmd) - Required - The Cmd instance to start.

### Returns
- **error** - An error if the command fails to start; otherwise nil.
```

--------------------------------

### Wrap usage example

Source: https://pkg.go.dev/golang.org/x/vuln/internal/derrors

Example usage of derrors.Wrap in a defer statement to add context to an error, allowing unwrapping to recover the original error.

```go
defer derrors.Wrap(&err, "copy(%s, %s)", dst, src)

```

--------------------------------

### PackageGraph.GetModule

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Gets a module at the given path, creating it if it does not exist.

```APIDOC
## PackageGraph.GetModule

### Description
Gets module at path if one exists. Otherwise, it creates a module and returns it.

### Method Signature
```go
func (g *PackageGraph) GetModule(path string) *packages.Module
```

### Parameters
- **path** (string) - Required - The module path.

### Returns
- **\*packages.Module** - The module at the path, or a newly created one.
```

--------------------------------

### ShowFlag.Get

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

Get returns the value of the ShowFlag as an interface{}.

```APIDOC
## ShowFlag.Get

### Description
Returns the value of the ShowFlag as an interface{}.

### Method
Get

### Signature
func (v *ShowFlag) Get() interface{}

### Parameters
None

### Returns
- **interface{}** - The current value of the flag.

```

--------------------------------

### (*Cmd).Wait() error

Source: https://pkg.go.dev/golang.org/x/vuln/scan

Wait waits for the command to exit. The command must have been started by Start. If the command fails to run or does not complete successfully, the returned error wraps an error implementing an ExitCode() int interface. Callers can use errors.As to retrieve the exit code. Wait releases any resources associated with the Cmd.

```APIDOC
## (*Cmd).Wait() error

### Description
Wait waits for the command to exit. The command must have been started by Start. If the command fails to run or does not complete successfully, the returned error wraps an error implementing an ExitCode() int interface. Callers can use errors.As to retrieve the exit code. Wait releases any resources associated with the Cmd.

### Method Signature
func (c *Cmd) Wait() error

### Parameters
- **c** (*Cmd) - Required - The Cmd instance to wait for.

### Returns
- **error** - An error if the command fails to run or does not complete successfully; otherwise nil.
```

--------------------------------

### NewTable

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

NewTable decodes the Go symbol table (the ".gosymtab" section in ELF), returning an in-memory representation. Starting with Go 1.3, the Go symbol table no longer includes symbol data.

```APIDOC
## NewTable

### Description
Decodes the Go symbol table (the ".gosymtab" section in ELF), returning an in-memory representation. Starting with Go 1.3, the Go symbol table no longer includes symbol data.

### Method
func NewTable(symtab []byte, pcln *LineTable) (*Table, error)

### Parameters
- **symtab** ([]byte) - Required - The raw symbol table data.
- **pcln** (*LineTable) - Required - The line table for the binary.

### Return Value
- ***Table** - The decoded symbol table.
- **error** - An error if decoding fails.

```

--------------------------------

### Run govulncheck on source code

Source: https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck@v1.9.0

Run govulncheck from the module directory using the same package path syntax as the go command. If no vulnerabilities are found, a short message is displayed; otherwise, each vulnerability is shown with a call stack summary.

```bash
$ cd my-module
$ govulncheck ./...
```

--------------------------------

### Command(ctx context.Context, arg ...string) *Cmd

Source: https://pkg.go.dev/golang.org/x/vuln/scan

Command returns a Cmd struct to execute govulncheck with the given arguments. It is the entry point for creating a new govulncheck command.

```APIDOC
## Command(ctx context.Context, arg ...string) *Cmd

### Description
Command returns the Cmd struct to execute govulncheck with the given arguments.

### Function Signature
func Command(ctx context.Context, arg ...string) *Cmd

### Parameters
- **ctx** (context.Context) - Required - The context for the command execution.
- **arg** (...string) - Optional - Arguments to pass to the govulncheck command.

### Returns
- **\*Cmd** - A pointer to the Cmd struct representing the govulncheck command.
```

--------------------------------

### Run govulncheck on a compiled binary

Source: https://pkg.go.dev/golang.org/x/vuln/cmd/govulncheck@v1.9.0

Pass the path to the binary file with the '-mode binary' flag. Govulncheck uses the binary's symbol information to find mentions of vulnerable functions, and output omits call stacks.

```bash
$ govulncheck -mode binary $HOME/go/bin/my-go-program
```

--------------------------------

### func GoTagToSemver(tag string) string

Source: https://pkg.go.dev/golang.org/x/vuln/internal/semver

Converts a Go tag to a semver version. This is a modified copy of pkgsite/internal/stdlib:VersionForTag.

```APIDOC
## func GoTagToSemver(tag string) string

### Description
Converts a Go tag to a semver version. This is a modified copy of pkgsite/internal/stdlib:VersionForTag.

### Signature
`func GoTagToSemver(tag string) string`

### Parameters
- **tag** (string) - Required - The Go tag to convert.

### Returns
- **string** - The corresponding semver version.
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/golang.org/x/vuln/internal/client

NewClient returns a client that reads the vulnerability database in source (an "http" or "file" prefixed URL). It supports databases following the API described in https://go.dev/security/vuln/database#api.

```APIDOC
## NewClient

### Description
NewClient returns a client that reads the vulnerability database in source (an "http" or "file" prefixed URL). It supports databases following the API described in https://go.dev/security/vuln/database#api.

### Function Signature
func NewClient(source string, opts *Options) (_ *Client, err error)

### Parameters
- **source** (string) - Required - The source URL, prefixed with "http" or "file".
- **opts** (*Options) - Optional - Options for the client, including an HTTP client.

### Returns
- **client** (*Client) - A new Client instance.
- **err** (error) - An error if the client could not be created.
```

--------------------------------

### type Region

Source: https://pkg.go.dev/golang.org/x/vuln/internal/sarif

Represents a region in a physical location, specifying start line and column.

```APIDOC
## type Region

### Description
Represents a region in a physical location, specifying start line and column.

### Fields
- **StartLine** (int) - The start line.
- **StartColumn** (int) - The start column.
- **EndLine** (int) - The end line.
- **EndColumn** (int) - The end column.

```

--------------------------------

### func (t *Table) SymByAddr(addr uint64) *Sym

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

Returns the text, data, or bss symbol starting at the given address.

```APIDOC
## func (t *Table) SymByAddr(addr uint64) *Sym

### Description
Returns the text, data, or bss symbol starting at the given address.

### Method
SymByAddr

### Parameters
- **addr** (uint64) - Required - The address to look up.

### Returns
- **\*Sym** - The symbol starting at the given address.
```

--------------------------------

### func Binary(ctx context.Context, handler govulncheck.Handler, bin *Bin, ...) error

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Binary detects vulnerabilities in a compiled binary. It takes a context, a handler for reporting results, and a Bin object representing the binary to analyze.

```APIDOC
## func Binary

### Description
Binary detects vulnerabilities in a compiled binary. It takes a context, a handler for reporting results, and a Bin object representing the binary to analyze.

### Signature
```go
func Binary(ctx context.Context, handler govulncheck.Handler, bin *Bin, ...) error
```

### Parameters
- `ctx` (context.Context) - Required - The context for the operation.
- `handler` (govulncheck.Handler) - Required - Handler for reporting vulnerabilities.
- `bin` (*Bin) - Required - The binary to analyze.
- `...` - Additional parameters (not specified).

### Returns
- `error` - Returns an error if the analysis fails.
```

--------------------------------

### NewLineTable

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

NewLineTable returns a new PC/line table corresponding to the encoded data. Text must be the start address of the corresponding text segment.

```APIDOC
## NewLineTable

### Description
NewLineTable returns a new PC/line table corresponding to the encoded data. Text must be the start address of the corresponding text segment.

### Function Signature
```go
func NewLineTable(data []byte, text uint64) *LineTable
```

### Parameters
- **data** ([]byte) - Required - The encoded line table data.
- **text** (uint64) - Required - The start address of the corresponding text segment.

### Returns
- **\*LineTable** - A new line table.

```

--------------------------------

### type ScanFlag string

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

ScanFlag is used for parsing and validation of govulncheck -scan flag. It implements flag.Value interface with Get, Set, and String methods.

```APIDOC
## type ScanFlag string

### Description
ScanFlag is used for parsing and validation of govulncheck -scan flag.

### Methods

#### func (f *ScanFlag) Get() interface{}

Returns the current value of the flag.

#### func (f *ScanFlag) Set(s string) error

Sets the flag value from a string. Returns an error if the value is invalid.

#### func (f *ScanFlag) String() string

Returns the string representation of the flag value.
```

--------------------------------

### Run govulncheck in module

Source: https://pkg.go.dev/golang.org/x/vuln

Runs govulncheck inside your module to analyze the codebase for vulnerabilities. The command scans the current directory and its subdirectories.

```bash
govulncheck ./...
```

--------------------------------

### type ModeFlag string

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

ModeFlag is used for parsing and validation of govulncheck -mode flag. It implements flag.Value interface with Get, Set, and String methods.

```APIDOC
## type ModeFlag string

### Description
ModeFlag is used for parsing and validation of govulncheck -mode flag.

### Methods

#### func (f *ModeFlag) Get() interface{}

Returns the current value of the flag.

#### func (f *ModeFlag) Set(s string) error

Sets the flag value from a string. Returns an error if the value is invalid.

#### func (f *ModeFlag) String() string

Returns the string representation of the flag value.
```

--------------------------------

### func RunGovulncheck(ctx context.Context, env []string, r io.Reader, stdout io.Writer, ...) error

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

Runs the govulncheck vulnerability scanner with the given context, environment, input, and output streams.

```APIDOC
## func RunGovulncheck

### Description
Runs the govulncheck vulnerability scanner with the given context, environment, input, and output streams.

### Function Signature
`func RunGovulncheck(ctx context.Context, env []string, r io.Reader, stdout io.Writer, ...) error`

### Parameters
- **ctx** (context.Context) - The context for the operation.
- **env** ([]string) - Environment variables for the scan.
- **r** (io.Reader) - Input reader.
- **stdout** (io.Writer) - Output writer.
- **...** - Additional parameters (not specified).

### Returns
- **error** - An error if the scan fails.
```

--------------------------------

### type FormatFlag string

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

FormatFlag is used for parsing and validation of govulncheck -format flag. It implements flag.Value interface with Get, Set, and String methods.

```APIDOC
## type FormatFlag string

### Description
FormatFlag is used for parsing and validation of govulncheck -format flag.

### Methods

#### func (f *FormatFlag) Get() interface{}

Returns the current value of the flag.

#### func (f *FormatFlag) Set(s string) error

Sets the flag value from a string. Returns an error if the value is invalid.

#### func (f *FormatFlag) String() string

Returns the string representation of the flag value.
```

--------------------------------

### ShowFlag.String

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

String returns the string representation of the ShowFlag.

```APIDOC
## ShowFlag.String

### Description
Returns the string representation of the ShowFlag.

### Method
String

### Signature
func (v *ShowFlag) String() string

### Parameters
None

### Returns
- **string** - The string representation of the flag.

```

--------------------------------

### LineTable.InlineTree

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

InlineTree returns the inline tree for a given function as a sequence of InlinedCalls. It requires the value of the gosym.FuncSymName symbol, the base address of the memory region, and a ReaderAt positioned at the start of that region.

```APIDOC
## LineTable.InlineTree

### Description
InlineTree returns the inline tree for Func f as a sequence of InlinedCalls. goFuncValue is the value of the gosym.FuncSymName symbol. baseAddr is the address of the memory region (ELF Prog) containing goFuncValue. progReader is a ReaderAt positioned at the start of that region.

### Function Signature
```go
func (t *LineTable) InlineTree(f *Func, goFuncValue, baseAddr uint64, progReader io.ReaderAt) ([]InlinedCall, error)
```

### Parameters
- **f** (\*Func) - Required - The function for which to get the inline tree.
- **goFuncValue** (uint64) - Required - The value of the gosym.FuncSymName symbol.
- **baseAddr** (uint64) - Required - The address of the memory region containing goFuncValue.
- **progReader** (io.ReaderAt) - Required - A ReaderAt positioned at the start of the memory region.

### Returns
- **[]InlinedCall** - A sequence of InlinedCalls representing the inline tree.
- **error** - An error if the operation fails.

```

--------------------------------

### NewInMemoryClient

Source: https://pkg.go.dev/golang.org/x/vuln/internal/client

NewInMemoryClient creates a Client that reads from an in-memory list of OSV entries.

```APIDOC
## NewInMemoryClient

### Description
NewInMemoryClient creates a Client that reads from an in-memory list of OSV entries.

### Function Signature
func NewInMemoryClient(entries []*osv.Entry) (*Client, error)

### Parameters
- **entries** ([]*osv.Entry) - Required - The list of OSV entries to use as the database.

### Returns
- **client** (*Client) - A new Client instance.
- **err** (error) - An error if the client could not be created.
```

--------------------------------

### SBOM struct

Source: https://pkg.go.dev/golang.org/x/vuln/internal/govulncheck

SBOM contains minimal information about the artifacts govulncheck is scanning.

```APIDOC
## SBOM struct

### Description
SBOM contains minimal information about the artifacts govulncheck is scanning.

### Type Definition
```go
type SBOM struct {
	// The go version used by govulncheck when scanning, which also defines
	// the version of the standard library used for detecting vulns.
	GoVersion string `json:"go_version,omitempty"`

	// The set of modules included in the scan.
	Modules []*Module `json:"modules,omitempty"`

	// The roots of the scan, as package paths.
	// For binaries, this will be the main package.
	// For source code, this will be the packages matching the provided package patterns.
	Roots []string `json:"roots,omitempty"`
}
```

### Fields
- **GoVersion** (string) - The go version used by govulncheck when scanning, which also defines the version of the standard library used for detecting vulns.
- **Modules** ([]*Module) - The set of modules included in the scan.
- **Roots** ([]string) - The roots of the scan, as package paths. For binaries, this will be the main package. For source code, this will be the packages matching the provided package patterns.
```

--------------------------------

### func ReadExe(file string) (Version, error)

Source: https://pkg.go.dev/golang.org/x/vuln/internal/goversion

ReadExe reports information about the Go version used to build the program executable named by file. It returns a Version struct containing the release version, module information, and crypto-related flags.

```APIDOC
## func ReadExe(file string) (Version, error)

### Description
ReadExe reports information about the Go version used to build the program executable named by file.

### Signature
```go
func ReadExe(file string) (Version, error)
```

### Parameters
- **file** (string) - Required - Path to the program executable file.

### Returns
- **Version** - The version information struct.
- **error** - An error if reading the executable fails.

### Version Struct
```go
type Version struct {
    Release        string // Go version (runtime.Version in the program)
    ModuleInfo     string // program's module information
    BoringCrypto   bool   // program uses BoringCrypto
    StandardCrypto bool   // program uses standard crypto (replaced by BoringCrypto)
    FIPSOnly       bool   // program imports "crypto/tls/fipsonly"
}
```

### Example
```go
ver, err := goversion.ReadExe("/path/to/binary")
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Go version: %s\n", ver.Release)
```
```

--------------------------------

### func RunGovulncheck(ctx context.Context, env []string, r io.Reader, stdout io.Writer, stderr io.Writer, args []string) error

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

RunGovulncheck performs the main govulncheck functionality. On failure, the returned error wraps an exit code error (see scan.Cmd.Wait).

```APIDOC
## func RunGovulncheck(ctx context.Context, env []string, r io.Reader, stdout io.Writer, stderr io.Writer, args []string) error

### Description
RunGovulncheck performs the main govulncheck functionality. On failure, the returned error wraps an exit code error (see scan.Cmd.Wait).

### Signature
```go
func RunGovulncheck(ctx context.Context, env []string, r io.Reader, stdout io.Writer, stderr io.Writer, args []string) error
```

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **env** ([]string) - Required - Environment variables.
- **r** (io.Reader) - Required - Input reader.
- **stdout** (io.Writer) - Required - Standard output writer.
- **stderr** (io.Writer) - Required - Standard error writer.
- **args** ([]string) - Required - Command-line arguments.

### Returns
- **error** - An error if the operation fails, wrapping an exit code error.
```

--------------------------------

### func (t *Table) LineToPC(file string, line int) (pc uint64, fn *Func, err error)

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

LineToPC returns the PC for the given file and line number.

```APIDOC
## Table.LineToPC

### Description
LineToPC returns the PC for the given file and line number.

### Function Signature
func (t *Table) LineToPC(file string, line int) (pc uint64, fn *Func, err error)

### Parameters
- **file** (string) - Required - The file name.
- **line** (int) - Required - The line number.

### Returns
- **pc** (uint64) - The program counter.
- **fn** (*Func) - The function.
- **err** (error) - An error if any.
```

--------------------------------

### func ExtractPackagesAndSymbols(file string) ([]*packages.Module, []Symbol, *debug.BuildInfo, error)

Source: https://pkg.go.dev/golang.org/x/vuln/internal/buildinfo

Extracts symbols, packages, modules from a Go binary file as well as the binary's metadata. If the symbol table is not available (e.g., stripped binaries), it returns module and binary info but without symbol info.

```APIDOC
## func ExtractPackagesAndSymbols

### Description
Extracts symbols, packages, modules from a Go binary file as well as the binary's metadata. If the symbol table is not available (e.g., stripped binaries), it returns module and binary info but without symbol info.

### Signature
```go
func ExtractPackagesAndSymbols(file string) ([]*packages.Module, []Symbol, *debug.BuildInfo, error)
```

### Parameters
- **file** (string) - Required - Path to the Go binary file.

### Returns
- **[]*packages.Module** - List of modules extracted from the binary.
- **[]Symbol** - List of symbols extracted from the binary.
- ***debug.BuildInfo** - Build metadata of the binary.
- **error** - Error if extraction fails.

### Errors
- Returns an error if the file cannot be read or parsed.
- If the symbol table is not available, returns module and binary info but without symbol info (no error).
```

--------------------------------

### func (t *Table) PCToLine(pc uint64) (file string, line int, fn *Func)

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

PCToLine returns the file, line, and function for the given PC.

```APIDOC
## Table.PCToLine

### Description
PCToLine returns the file, line, and function for the given PC.

### Function Signature
func (t *Table) PCToLine(pc uint64) (file string, line int, fn *Func)

### Parameters
- **pc** (uint64) - Required - The program counter.

### Returns
- **file** (string) - The file name.
- **line** (int) - The line number.
- **fn** (*Func) - The function.
```

--------------------------------

### func Source(ctx context.Context, handler govulncheck.Handler, cfg *govulncheck.Config, ...) error

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Source detects vulnerabilities in Go source code. It takes a context, a handler, and a configuration for the analysis.

```APIDOC
## func Source

### Description
Source detects vulnerabilities in Go source code. It takes a context, a handler, and a configuration for the analysis.

### Signature
```go
func Source(ctx context.Context, handler govulncheck.Handler, cfg *govulncheck.Config, ...) error
```

### Parameters
- `ctx` (context.Context) - Required - The context for the operation.
- `handler` (govulncheck.Handler) - Required - Handler for reporting vulnerabilities.
- `cfg` (*govulncheck.Config) - Required - Configuration for the analysis.
- `...` - Additional parameters (not specified).

### Returns
- `error` - Returns an error if the analysis fails.
```

--------------------------------

### func (r ReviewStatus) String() string

Source: https://pkg.go.dev/golang.org/x/vuln/internal/osv

Returns the string representation of the ReviewStatus.

```APIDOC
## func (r ReviewStatus) String() string

### Description
Returns the string representation of the ReviewStatus.

### Method
N/A (Go method)

### Endpoint
N/A

### Parameters
- **r** (ReviewStatus) - Required - The receiver.

### Request Example
```go
status := ReviewStatus("REVIEWED")
str := status.String()
```

### Response
#### Success Response
- **string** - The string representation.

#### Response Example
```go
str := status.String() // "REVIEWED"
```
```

--------------------------------

### PackageGraph.LoadPackagesAndMods

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Loads packages specified by patterns into the graph.

```APIDOC
## PackageGraph.LoadPackagesAndMods

### Description
Loads the packages specified by the patterns into the graph. See golang.org/x/tools/go/packages.Load for details of how it works.

### Method Signature
```go
func (g *PackageGraph) LoadPackagesAndMods(cfg *packages.Config, tags []string, patterns []string, wantSymbols bool) error
```

### Parameters
- **cfg** (*packages.Config) - Required - The configuration for loading packages.
- **tags** ([]string) - Required - Build tags to apply.
- **patterns** ([]string) - Required - Package patterns to load.
- **wantSymbols** (bool) - Required - Whether to load symbol information.

### Returns
- **error** - An error if loading fails.
```

--------------------------------

### PackageGraph.SBOM

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Returns the SBOM for the graph.

```APIDOC
## PackageGraph.SBOM

### Description
Returns the SBOM for the graph.

### Method Signature
```go
func (g *PackageGraph) SBOM() *govulncheck.SBOM
```

### Returns
- **\*govulncheck.SBOM** - The SBOM.
```

--------------------------------

### PackageGraph.GetPackage

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Returns the package matching the path, adding a new one if not known.

```APIDOC
## PackageGraph.GetPackage

### Description
Returns the package matching the path. If the graph does not already know about the package, a new one is added.

### Method Signature
```go
func (g *PackageGraph) GetPackage(path string) *packages.Package
```

### Parameters
- **path** (string) - Required - The package path.

### Returns
- **\*packages.Package** - The package matching the path.
```

--------------------------------

### func NewTable(symtab []byte, pcln *LineTable) (*Table, error)

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

NewTable creates a new Table from the given symbol table and line table.

```APIDOC
## NewTable

### Description
NewTable creates a new Table from the given symbol table and line table.

### Function Signature
func NewTable(symtab []byte, pcln *LineTable) (*Table, error)

### Parameters
- **symtab** ([]byte) - Required - The symbol table data.
- **pcln** (*LineTable) - Required - The line table.

### Returns
- **\*Table** - A pointer to the new Table.
- **error** - An error if any.
```

--------------------------------

### type Bin

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Bin represents a compiled binary for vulnerability analysis.

```APIDOC
## type Bin

### Description
Bin represents a compiled binary for vulnerability analysis.

### Methods

#### func (bin *Bin) SBOM() (sbom *govulncheck.SBOM)

##### Description
SBOM returns the Software Bill of Materials for the binary.

##### Signature
```go
func (bin *Bin) SBOM() (sbom *govulncheck.SBOM)
```

##### Returns
- `*govulncheck.SBOM` - The SBOM for the binary.
```

--------------------------------

### func (s *Sym) PackageName() string

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

PackageName returns the package name of the symbol.

```APIDOC
## Sym.PackageName

### Description
PackageName returns the package name of the symbol.

### Function Signature
func (s *Sym) PackageName() string

### Returns
- **string** - The package name.
```

--------------------------------

### TextHandler.Progress

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

Progress writes progress updates during govulncheck execution.

```APIDOC
## TextHandler.Progress

### Description
Writes progress updates during govulncheck execution.

### Method
Progress

### Signature
func (h *TextHandler) Progress(progress *govulncheck.Progress) error

### Parameters
- **progress** (*govulncheck.Progress) - Required - The progress update.

### Returns
- **error** - An error if writing fails.

```

--------------------------------

### PackageGraph.Modules

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Returns the modules in the graph.

```APIDOC
## PackageGraph.Modules

### Description
Returns the modules in the graph.

### Method Signature
```go
func (g *PackageGraph) Modules() []*packages.Module
```

### Returns
- **[]*packages.Module** - The modules in the graph.
```

--------------------------------

### TextHandler.Config

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

Config writes version information only if --version was set.

```APIDOC
## TextHandler.Config

### Description
Writes version information only if --version was set.

### Method
Config

### Signature
func (h *TextHandler) Config(config *govulncheck.Config) error

### Parameters
- **config** (*govulncheck.Config) - Required - The configuration object.

### Returns
- **error** - An error if writing fails.

```

--------------------------------

### Constant IDDirectory

Source: https://pkg.go.dev/golang.org/x/vuln/internal

Defines the name of the directory that contains entries listed by their IDs.

```go
const IDDirectory = "ID"
```

--------------------------------

### NewPackageGraph

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Creates a new PackageGraph instance.

```APIDOC
## NewPackageGraph

### Description
Creates a new PackageGraph instance.

### Function Signature
```go
func NewPackageGraph(goVersion string) *PackageGraph
```

### Parameters
- **goVersion** (string) - Required - The Go version to use for the graph.

### Returns
- **\*PackageGraph** - A new PackageGraph instance.
```

--------------------------------

### Client.ByModules

Source: https://pkg.go.dev/golang.org/x/vuln/internal/client

ByModules returns a list of responses containing the OSV entries corresponding to each request. The order of the requests is preserved, and each request has a response even if there are no entries (in which case the Entries field is nil).

```APIDOC
## Client.ByModules

### Description
ByModules returns a list of responses containing the OSV entries corresponding to each request. The order of the requests is preserved, and each request has a response even if there are no entries (in which case the Entries field is nil).

### Method Signature
func (c *Client) ByModules(ctx context.Context, reqs []*ModuleRequest) (_ []*ModuleResponse, err error)

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **reqs** ([]*ModuleRequest) - Required - A list of module requests to query.

### Returns
- **responses** ([]*ModuleResponse) - A list of responses, one per request, in the same order.
- **err** (error) - An error if the operation failed.
```

--------------------------------

### ShowFlag.Set

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

Set parses a string and sets the value of the ShowFlag.

```APIDOC
## ShowFlag.Set

### Description
Parses a string and sets the value of the ShowFlag.

### Method
Set

### Signature
func (v *ShowFlag) Set(s string) error

### Parameters
- **s** (string) - Required - The string value to set.

### Returns
- **error** - An error if parsing fails.

```

--------------------------------

### func SemverToGoTag(v string) string

Source: https://pkg.go.dev/golang.org/x/vuln/internal/semver

Converts a semver version to a Go tag. This is a modified copy of pkgsite/internal/stlib:TagForVersion.

```APIDOC
## func SemverToGoTag(v string) string

### Description
Converts a semver version to a Go tag. This is a modified copy of pkgsite/internal/stlib:TagForVersion.

### Signature
`func SemverToGoTag(v string) string`

### Parameters
- **v** (string) - Required - The semver version to convert.

### Returns
- **string** - The corresponding Go tag.
```

--------------------------------

### Constants for pseudo-module paths (GoStdModulePath, GoCmdModulePath, UnknownModulePath, UnknownPackagePath)

Source: https://pkg.go.dev/golang.org/x/vuln/internal

Defines internal Go module path strings used when listing vulnerabilities in the standard library, the go command, and for unknown modules/packages. These are pseudo-module paths that are not valid module paths and must not be passed to module.EscapePath. Keep in sync with vulndb/internal/database/generate.go.

```go
const (
	// GoStdModulePath is the internal Go module path string used
	// when listing vulnerabilities in standard library.
	GoStdModulePath = "stdlib"

	// GoCmdModulePath is the internal Go module path string used
	// when listing vulnerabilities in the go command.
	GoCmdModulePath = "toolchain"

	// UnknownModulePath is a special module path for when we cannot work out
	// the module for a package.
	UnknownModulePath = "unknown-module"

	// UnknownPackagePath is a special package path for when we cannot work out
	// the packagUnknownModulePath = "unknown"
	UnknownPackagePath = "unknown-package"
)
```

--------------------------------

### func (r ReviewStatus) MarshalJSON() ([]byte, error)

Source: https://pkg.go.dev/golang.org/x/vuln/internal/osv

Marshals the ReviewStatus to JSON.

```APIDOC
## func (r ReviewStatus) MarshalJSON() ([]byte, error)

### Description
Marshals the ReviewStatus to JSON.

### Method
N/A (Go method)

### Endpoint
N/A

### Parameters
- **r** (ReviewStatus) - Required - The receiver.

### Request Example
```go
status := ReviewStatus("REVIEWED")
jsonBytes, err := status.MarshalJSON()
```

### Response
#### Success Response
- **[]byte** - The JSON-encoded representation of the ReviewStatus.
- **error** - An error if marshaling fails.

#### Response Example
```go
jsonBytes, err := status.MarshalJSON() // jsonBytes = []byte(`"REVIEWED"`)
```
```

--------------------------------

### TextHandler.SBOM

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

SBOM writes SBOM data.

```APIDOC
## TextHandler.SBOM

### Description
Writes SBOM data.

### Method
SBOM

### Signature
func (h *TextHandler) SBOM(sbom *govulncheck.SBOM) error

### Parameters
- **sbom** (*govulncheck.SBOM) - Required - The SBOM data.

### Returns
- **error** - An error if writing fails.

```

--------------------------------

### TextHandler.Finding

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

Finding gathers vulnerability findings to be written.

```APIDOC
## TextHandler.Finding

### Description
Gathers vulnerability findings to be written.

### Method
Finding

### Signature
func (h *TextHandler) Finding(finding *govulncheck.Finding) error

### Parameters
- **finding** (*govulncheck.Finding) - Required - The finding to gather.

### Returns
- **error** - An error if gathering fails.

```

--------------------------------

### TextHandler.OSV

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

OSV gathers OSV entries to be written.

```APIDOC
## TextHandler.OSV

### Description
Gathers OSV entries to be written.

### Method
OSV

### Signature
func (h *TextHandler) OSV(entry *osv.Entry) error

### Parameters
- **entry** (*osv.Entry) - Required - The OSV entry to gather.

### Returns
- **error** - An error if gathering fails.

```

--------------------------------

### Reference

Source: https://pkg.go.dev/golang.org/x/vuln/internal/osv

Reference is a reference URL containing additional information, advisories, issue tracker entries, etc., about the vulnerability.

```APIDOC
## Reference

### Description
Reference is a reference URL containing additional information, advisories, issue tracker entries, etc., about the vulnerability.

### Type
struct

### Fields
- **Type** (ReferenceType) - Required - The type of reference.
- **URL** (string) - Required - The fully-qualified URL of the reference.

### JSON Representation
```json
{
  "type": "ADVISORY",
  "url": "https://example.com/advisory"
}
```

### See Also
- [OSV Schema - references](https://ossf.github.io/osv-schema/#references-field)
```

--------------------------------

### func (t *Table) PCToFunc(pc uint64) *Func

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

PCToFunc returns the function containing the given PC.

```APIDOC
## Table.PCToFunc

### Description
PCToFunc returns the function containing the given PC.

### Function Signature
func (t *Table) PCToFunc(pc uint64) *Func

### Parameters
- **pc** (uint64) - Required - The program counter.

### Returns
- **\*Func** - The function, or nil if not found.
```

--------------------------------

### type Tool

Source: https://pkg.go.dev/golang.org/x/vuln/internal/sarif

Represents the tool in SARIF, containing driver information.

```APIDOC
## type Tool

### Description
Represents the tool in SARIF, containing driver information.

### Fields
- **Driver** (Driver) - The driver information.

```

--------------------------------

### func Compact(finding *govulncheck.Finding) []*govulncheck.Frame

Source: https://pkg.go.dev/golang.org/x/vuln/internal/traces

Compact returns a summarization of finding.Trace. The first returned element is the vulnerable symbol and the last element is the exit point of the user module. There can also be two elements in between, if applicable, which are the two elements preceding the user module exit point.

```APIDOC
## func Compact

### Description
Compact returns a summarization of finding.Trace. The first returned element is the vulnerable symbol and the last element is the exit point of the user module. There can also be two elements in between, if applicable, which are the two elements preceding the user module exit point.

### Function Signature
```go
func Compact(finding *govulncheck.Finding) []*govulncheck.Frame
```

### Parameters
- **finding** (*govulncheck.Finding) - Required - The finding containing the trace to be summarized.

### Returns
- **[]*govulncheck.Frame** - A slice of frames representing the summarized trace. The first element is the vulnerable symbol, the last is the exit point of the user module, and optionally two intermediate frames.
```

--------------------------------

### Table.PCToFunc

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

PCToFunc returns the function containing the program counter pc, or nil if there is no such function.

```APIDOC
## Table.PCToFunc

### Description
Returns the function containing the program counter pc, or nil if there is no such function.

### Method
func (t *Table) PCToFunc(pc uint64) *Func

### Parameters
- **pc** (uint64) - Required - The program counter.

### Return Value
- ***Func** - The function containing the PC, or nil.

```

--------------------------------

### Table.LineToPC

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

LineToPC looks up the first program counter on the given line in the named file. It returns UnknownPathError or UnknownLineError if there is an error looking up this line.

```APIDOC
## Table.LineToPC

### Description
Looks up the first program counter on the given line in the named file. It returns UnknownPathError or UnknownLineError if there is an error looking up this line.

### Method
func (t *Table) LineToPC(file string, line int) (pc uint64, fn *Func, err error)

### Parameters
- **file** (string) - Required - The file name.
- **line** (int) - Required - The line number.

### Return Value
- **pc** (uint64) - The program counter.
- **fn** (*Func) - The function containing the PC, or nil.
- **err** (error) - An error if lookup fails.

```

--------------------------------

### func NewLineTable(data []byte, text uint64) *LineTable

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

NewLineTable creates a new LineTable from the given data and text base address.

```APIDOC
## NewLineTable

### Description
NewLineTable creates a new LineTable from the given data and text base address.

### Function Signature
func NewLineTable(data []byte, text uint64) *LineTable

### Parameters
- **data** ([]byte) - Required - The line table data.
- **text** (uint64) - Required - The text base address.

### Returns
- **\*LineTable** - A pointer to the new LineTable.
```

--------------------------------

### func (s *Sym) Static() bool

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

Static reports whether the symbol is static.

```APIDOC
## Sym.Static

### Description
Static reports whether the symbol is static.

### Function Signature
func (s *Sym) Static() bool

### Returns
- **bool** - True if the symbol is static, false otherwise.
```

--------------------------------

### func IsStdPackage(pkg string) bool

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

IsStdPackage reports whether the given package path is a standard library package.

```APIDOC
## func IsStdPackage

### Description
IsStdPackage reports whether the given package path is a standard library package.

### Signature
```go
func IsStdPackage(pkg string) bool
```

### Parameters
- `pkg` (string) - Required - The package path.

### Returns
- `bool` - True if the package is a standard library package.
```

--------------------------------

### NewTextHandler

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

NewTextHandler returns a handler that writes govulncheck output as text.

```APIDOC
## NewTextHandler

### Description
Returns a handler that writes govulncheck output as text.

### Method
NewTextHandler

### Signature
func NewTextHandler(w io.Writer) *TextHandler

### Parameters
- **w** (io.Writer) - Required - The writer to write output to.

### Returns
- **\*TextHandler** - A new text handler.

```

--------------------------------

### func Less(v1, v2 string) bool

Source: https://pkg.go.dev/golang.org/x/vuln/internal/semver

Returns whether v1 is less than v2, where v1 and v2 are semver versions with either a "v", "go" or no prefix.

```APIDOC
## func Less(v1, v2 string) bool

### Description
Returns whether v1 < v2, where v1 and v2 are semver versions with either a "v", "go" or no prefix.

### Signature
`func Less(v1, v2 string) bool`

### Parameters
- **v1** (string) - Required - The first semver version.
- **v2** (string) - Required - The second semver version.

### Returns
- **bool** - True if v1 is less than v2, false otherwise.
```

--------------------------------

### TextHandler.Flush

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

Flush writes any buffered output.

```APIDOC
## TextHandler.Flush

### Description
Flushes any buffered output.

### Method
Flush

### Signature
func (h *TextHandler) Flush() error

### Parameters
None

### Returns
- **error** - An error if flushing fails.

```

--------------------------------

### FetchVulnerabilities

Source: https://pkg.go.dev/golang.org/x/vuln/internal/vulncheck

Fetches vulnerabilities that affect the supplied modules.

```APIDOC
## FetchVulnerabilities

### Description
Fetches vulnerabilities that affect the supplied modules.

### Function Signature
```go
func FetchVulnerabilities(ctx context.Context, c *client.Client, modules []*packages.Module) ([]*ModVulns, error)
```

### Parameters
- **ctx** (context.Context) - Required - The context for the operation.
- **c** (*client.Client) - Required - The client used to fetch vulnerabilities.
- **modules** ([]*packages.Module) - Required - The modules to check for vulnerabilities.

### Returns
- **[]*ModVulns** - The vulnerabilities grouped per module.
- **error** - An error if the operation fails.
```

--------------------------------

### type Symbol

Source: https://pkg.go.dev/golang.org/x/vuln/internal/buildinfo

Represents a symbol extracted from a Go binary, containing the package name and symbol name.

```APIDOC
## type Symbol

### Description
Represents a symbol extracted from a Go binary, containing the package name and symbol name.

### Definition
```go
type Symbol struct {
	Pkg  string `json:"pkg,omitempty"`
	Name string `json:"name,omitempty"`
}
```

### Fields
- **Pkg** (string) - Package name of the symbol.
- **Name** (string) - Name of the symbol.
```

--------------------------------

### Table.PCToLine

Source: https://pkg.go.dev/golang.org/x/vuln/internal/gosym

PCToLine looks up line number information for a program counter. If there is no information, it returns fn == nil.

```APIDOC
## Table.PCToLine

### Description
Looks up line number information for a program counter. If there is no information, it returns fn == nil.

### Method
func (t *Table) PCToLine(pc uint64) (file string, line int, fn *Func)

### Parameters
- **pc** (uint64) - Required - The program counter.

### Return Value
- **file** (string) - The file name.
- **line** (int) - The line number.
- **fn** (*Func) - The function, or nil if no information.

```

--------------------------------

### ShowFlag.Update

Source: https://pkg.go.dev/golang.org/x/vuln/internal/scan

Update updates the text handler h with values of the flag.

```APIDOC
## ShowFlag.Update

### Description
Updates the text handler h with values of the flag.

### Method
Update

### Signature
func (v ShowFlag) Update(h *TextHandler)

### Parameters
- **h** (*TextHandler) - Required - The text handler to update.

### Returns
None

```
Tokens:
Raw