vulncheck-oss / sdk

Bring the VulnCheck API to your Go applications.

The VulnCheck SDK

Bring the VulnCheck API to your Go applications.

Installation

go get github.com/vulncheck-oss/sdk

Examples

Connecting to the API

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

response, err := client.GetPurl("pkg:hex/coherence@0.1.2")

if err != nil {
    panic(err)
}

fmt.Println(response.GetData())

CPE

response, err := client.GetCpe("cpe:/a:microsoft:internet_explorer:8.0.6001:beta")

if err != nil {
    panic(err)
}

fmt.Println(response.GetData())

BACKUP

response, err := client.GetIndexBackup("initial-access")

if err != nil {
    panic(err)
}

fmt.Println(response.GetData())

INDICES

response, err := client.GetIndices()

if err != nil {
    panic(err)
}

fmt.Println(response.GetData())

INDEX

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)

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

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.