aboutsummaryrefslogtreecommitdiff
path: root/_content/doc/tutorial
diff options
context:
space:
mode:
authorariathaker <ariathaker@gmail.com>2023-06-23 15:44:32 -0500
committerHyang-Ah Hana Kim <hyangah@gmail.com>2023-06-29 16:45:50 +0000
commitea9861c44c08bb451262c252f8a18862fa25e6bc (patch)
treed2d9635e884dcdced5326a47a6ead3f5165aa088 /_content/doc/tutorial
parentef4c8eb0dac101108bdd330846ac409b43975a97 (diff)
downloadgo-x-website-ea9861c44c08bb451262c252f8a18862fa25e6bc.tar.xz
_content/doc/tutorial: Added VS Code Go tutorial
Added tutorial on vulnerability scanning in IDE with VS Code Go, with images. Change-Id: I68bbd5cd6d1bf277ac37f1fa1069eb09aef3fb04 Reviewed-on: https://go-review.googlesource.com/c/website/+/505776 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Brandon Kessler <bkessler@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
Diffstat (limited to '_content/doc/tutorial')
-rw-r--r--_content/doc/tutorial/editor_tutorial_1.pngbin0 -> 99127 bytes
-rw-r--r--_content/doc/tutorial/editor_tutorial_2.pngbin0 -> 110257 bytes
-rw-r--r--_content/doc/tutorial/editor_tutorial_3.pngbin0 -> 235998 bytes
-rw-r--r--_content/doc/tutorial/editor_tutorial_4.pngbin0 -> 217430 bytes
-rw-r--r--_content/doc/tutorial/editor_tutorial_5.pngbin0 -> 111512 bytes
-rw-r--r--_content/doc/tutorial/govulncheck-ide.md115
6 files changed, 115 insertions, 0 deletions
diff --git a/_content/doc/tutorial/editor_tutorial_1.png b/_content/doc/tutorial/editor_tutorial_1.png
new file mode 100644
index 00000000..88893aab
--- /dev/null
+++ b/_content/doc/tutorial/editor_tutorial_1.png
Binary files differ
diff --git a/_content/doc/tutorial/editor_tutorial_2.png b/_content/doc/tutorial/editor_tutorial_2.png
new file mode 100644
index 00000000..dbb06a35
--- /dev/null
+++ b/_content/doc/tutorial/editor_tutorial_2.png
Binary files differ
diff --git a/_content/doc/tutorial/editor_tutorial_3.png b/_content/doc/tutorial/editor_tutorial_3.png
new file mode 100644
index 00000000..3d853cf4
--- /dev/null
+++ b/_content/doc/tutorial/editor_tutorial_3.png
Binary files differ
diff --git a/_content/doc/tutorial/editor_tutorial_4.png b/_content/doc/tutorial/editor_tutorial_4.png
new file mode 100644
index 00000000..b56366cb
--- /dev/null
+++ b/_content/doc/tutorial/editor_tutorial_4.png
Binary files differ
diff --git a/_content/doc/tutorial/editor_tutorial_5.png b/_content/doc/tutorial/editor_tutorial_5.png
new file mode 100644
index 00000000..8e3210a5
--- /dev/null
+++ b/_content/doc/tutorial/editor_tutorial_5.png
Binary files differ
diff --git a/_content/doc/tutorial/govulncheck-ide.md b/_content/doc/tutorial/govulncheck-ide.md
new file mode 100644
index 00000000..53e6dc40
--- /dev/null
+++ b/_content/doc/tutorial/govulncheck-ide.md
@@ -0,0 +1,115 @@
+<!--{
+ "Title": "Tutorial: Find and fix vulnerable dependencies with VS Code Go",
+ "Breadcrumb": true
+}-->
+
+[Back to Go Security](/security)
+
+You can scan your code for vulnerabilities directly out of your editor with the Go extension for Visual Studio Code.
+
+Note: for an explanation of the vulnerability fix included in the images below, see the [govulncheck tutorial](https://go.dev/doc/tutorial/govulncheck).
+
+## Prerequisites:
+
+- **Go 1.18 or later.** Govulncheck is designed to work with Go 1.18 onwards. For installation instructions, see [Installing Go](https://go.dev/doc/install). We recommend using the latest version of Go to follow this tutorial.
+- **VS Code**, updated to the latest version. [Download here](https://code.visualstudio.com/). You can also use Vim (see [here](https://go.dev/security/vuln/editor#editor-specific-instructions) for details), but this tutorial focuses on VS Code Go.
+- **VS Code Go extension**, which can be [downloaded here](https://marketplace.visualstudio.com/items?itemName=golang.go).
+- **Editor-specific settings changes.** You will need to modify your IDE settings according to [these specifications](https://go.dev/security/vuln/editor#editor-specific-instructions) before being able to replicate the results below.
+
+
+## How to scan for vulnerabilities using VS Code Go
+
+**Step 1.** Run "Go: Toggle Vulncheck"
+
+The [Toggle Vulncheck](https://github.com/golang/vscode-go/wiki/Commands#go-toggle-vulncheck) command displays vulnerability analysis for all the dependencies listed in your modules. To use this command, open the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) in your IDE (Ctrl+Shift+P on Linux/Windows or Cmd+Shift+P on Mac OS) and run “Go: Toggle Vulncheck.” In your go.mod file, you will see the diagnostics for vulnerable dependencies that are used both directly and indirectly in your code.
+
+<div class="image">
+ <center>
+ <img style="width: 100%" width="2110" height="952" src="editor_tutorial_1.png" alt="Run Toggle Vulncheck"></img>
+ </center>
+</div>
+
+Note: To reproduce this tutorial on your own editor, copy the code below into your main.go file.
+
+```
+// This program takes language tags as command-line
+// arguments and parses them.
+
+package main
+
+import (
+ "fmt"
+ "os"
+
+ "golang.org/x/text/language"
+)
+
+func main() {
+ for _, arg := range os.Args[1:] {
+ tag, err := language.Parse(arg)
+ if err != nil {
+ fmt.Printf("%s: error: %v\n", arg, err)
+ } else if tag == language.Und {
+ fmt.Printf("%s: undefined\n", arg)
+ } else {
+ fmt.Printf("%s: tag %s\n", arg, tag)
+ }
+ }
+}
+```
+
+Then, make sure the corresponding go.mod file for the program looks like this:
+
+
+```
+module module1
+
+go 1.18
+
+require golang.org/x/text v0.3.5
+```
+
+Now, run `go mod tidy` to ensure that your go.sum file is updated.
+
+**Step 2.** Run govulncheck via a code action.
+
+Running govulncheck using a code action allows you to focus on the dependencies that are actually called in your code. Code actions in VS Code are marked by lightbulb icons; hover over the relevant dependency to see information about the vulnerability, then select “Quick Fix” to be shown a menu of options. Of these, choose “run govulncheck to verify.” This will return the relevant govulncheck output in your terminal.
+
+<div class="image">
+ <center>
+ <img style="width: 100%" width="2110" height="952" src="editor_tutorial_2.png" alt="govulncheck code action"></img>
+ </center>
+</div>
+
+<div class="image">
+ <center>
+ <img style="width: 100%" width="2110" height="952" src="editor_tutorial_3.png" alt="VS Code Go govulncheck output"></img>
+ </center>
+</div>
+
+**Step 3**. Hover over a dependency listed in your go.mod file.
+
+The relevant govulncheck output about a specific dependency can also be found by hovering over the dependency in the go.mod file. For a quick look at dependency information, this option is even more efficient than using a code action.
+
+<div class="image">
+ <center>
+ <img style="width: 100%" width="2110" height="952" src="editor_tutorial_4.png" alt="Hover over dependency for vulnerability information"></img>
+ </center>
+</div>
+
+**Step 4.** Upgrade to a "fixed in" version of your dependency.
+
+Code actions can also be used to quickly upgrade to a version of your dependency where the vulnerability is fixed. Do this by selecting the “Upgrade” option in the code action drop-down menu.
+
+<div class="image">
+ <center>
+ <img style="width: 100%" width="2110" height="952" src="editor_tutorial_5.png" alt="Upgrade to Latest via code action menu"></img>
+ </center>
+</div>
+
+
+## Additional resources
+
+- See [this page](https://go.dev/security/vuln/editor) for more information about vulnerability scanning in your IDE. The [Notes and Caveats section](https://go.dev/security/vuln/editor#notes-and-caveats), in particular, discusses special cases for which vulnerability scanning may be more complex than in the example above.
+- The [Go Vulnerability Database](https://pkg.go.dev/vuln/) contains information from many existing sources in addition to direct reports by Go package maintainers to the Go security team.
+- See [Go Vulnerability Management](https://go.dev/security/vuln/) page provides a high-level view of Go's architecture for detecting, reporting and managing vulnerabilities. \ No newline at end of file