This repository has been archived by the owner on Sep 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
140 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,146 +1,11 @@ | ||
| <p align="center"> | ||
| <img src="/logo-sdk.png" align="center" alt="VulnCheck Logo" width="150" /> | ||
| </p> | ||
| This Repo has been moved to https://github.com/vulncheck-oss/sdk-go | ||
|
|
||
| # The VulnCheck SDK | ||
| Bring the VulnCheck API to your Go applications. | ||
| You should update your `go.mod` and replace the import from: | ||
|
|
||
| [](https://github.com/vulncheck-oss/sdk/releases) | ||
| [](https://goreportcard.com/report/github.com/vulncheck-oss/sdk) | ||
| [](https://pkg.go.dev/github.com/vulncheck-oss/sdk) | ||
| [](https://github.com/vulncheck-oss/sdk/actions/workflows/lint.yml) | ||
| [](https://github.com/vulncheck-oss/sdk/actions/workflows/test.yml) | ||
| [](https://github.com/vulncheck-oss/sdk/pulls) | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| go get github.com/vulncheck-oss/sdk | ||
| ``` | ||
|
|
||
|
|
||
| ## Examples | ||
|
|
||
| ### Connecting to the API | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "github.com/vulncheck-oss/sdk" | ||
| ) | ||
|
|
||
| func main() { | ||
| client := sdk.Connect("https://api.vulncheck.com", "vulncheck_token") | ||
| fmt.Println(client.GetBaseURL()) | ||
| } | ||
| ``` | ||
|
|
||
| ### Available Methods | ||
|
|
||
| ### PURL | ||
| ```go | ||
| response, err := client.GetPurl("pkg:hex/coherence@0.1.2") | ||
|
|
||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| fmt.Println(response.GetData()) | ||
| ``` | ||
|
|
||
| ### CPE | ||
| ```go | ||
| response, err := client.GetCpe("cpe:/a:microsoft:internet_explorer:8.0.6001:beta") | ||
|
|
||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| fmt.Println(response.GetData()) | ||
| ``` | ||
|
|
||
| ### BACKUP | ||
| ```go | ||
| response, err := client.GetIndexBackup("initial-access") | ||
|
|
||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| fmt.Println(response.GetData()) | ||
| require github.com/vulncheck-oss/sdk | ||
| ``` | ||
|
|
||
| ### INDICES | ||
| to: | ||
| ```go | ||
| response, err := client.GetIndices() | ||
|
|
||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| fmt.Println(response.GetData()) | ||
| require github.com/vulncheck-oss/sdk-go | ||
| ``` | ||
|
|
||
| ### INDEX | ||
| ```go | ||
| queryParams := sdk.IndexQueryParameters{} | ||
|
|
||
| response, err := client.GetIndex("a10", queryParams) | ||
|
|
||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| fmt.Println(response.GetData()) | ||
| ``` | ||
|
|
||
| ### INDEX (looking up a CVE in the vulncheck-nvd2 index) | ||
| ```go | ||
| response, err := client.GetIndexVulncheckNvd2( | ||
| sdk.IndexQueryParameters{ | ||
| Cve: "CVE-2019-19781", | ||
| } | ||
| ) | ||
|
|
||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| description := (*response.Data[0].Descriptions)[0].Value | ||
| cvssBaseScore := (*response.Data[0].Metrics.CvssMetricV31)[0].CvssData.BaseScore | ||
| ``` | ||
|
|
||
| ### Cursor INDEX | ||
| ```go | ||
| queryParams := sdk.IndexQueryParameters{} | ||
|
|
||
| response, err := client.GetCursorIndex("vulncheck-nvd2", "cursor_string", queryParams) | ||
|
|
||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| fmt.Println(response.GetData()) | ||
| ``` | ||
|
|
||
| ## Changelog | ||
|
|
||
| Please see CHANGELOG for more information on what has changed recently. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Please see CONTRIBUTING for details. | ||
|
|
||
| ## Security Vulnerabilities | ||
|
|
||
| If you discover any security related issues, please use issue tracker. | ||
|
|
||
| ## Sponsorship | ||
|
|
||
| Development of this package is sponsored by VulnCheck learn more about us! | ||
|
|
||
| ## License | ||
|
|
||
| Apache License 2.0. Please see License File for more information. |