Package websecurityscanner is an auto-generated package for the Web Security Scanner API.
Scans your Compute and App Engine apps for common web vulnerabilities.
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
Functions
func DefaultAuthScopes
func DefaultAuthScopes() [] string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type CallOptions struct {
CreateScanConfig [] gax
. CallOption
DeleteScanConfig [] gax
. CallOption
GetScanConfig [] gax
. CallOption
ListScanConfigs [] gax
. CallOption
UpdateScanConfig [] gax
. CallOption
StartScanRun [] gax
. CallOption
GetScanRun [] gax
. CallOption
ListScanRuns [] gax
. CallOption
StopScanRun [] gax
. CallOption
ListCrawledUrls [] gax
. CallOption
GetFinding [] gax
. CallOption
ListFindings [] gax
. CallOption
ListFindingTypeStats [] gax
. CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type Client struct {
// The call options for this service.
CallOptions * CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with Web Security Scanner API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
func NewClient
NewClient creates a new web security scanner client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
func (c * Client
) Connection() * grpc
. ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) CreateScanConfig
func (c * Client
) CreateScanConfig(ctx context
. Context
, req * websecurityscannerpb
. CreateScanConfigRequest
, opts ... gax
. CallOption
) (* websecurityscannerpb
. ScanConfig
, error
)
CreateScanConfig creates a new ScanConfig.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.CreateScanConfigRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateScanConfig(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) DeleteScanConfig
func (c * Client
) DeleteScanConfig(ctx context
. Context
, req * websecurityscannerpb
. DeleteScanConfigRequest
, opts ... gax
. CallOption
) error
DeleteScanConfig deletes an existing ScanConfig and its child resources.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.DeleteScanConfigRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteScanConfig(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) GetFinding
func (c * Client
) GetFinding(ctx context
. Context
, req * websecurityscannerpb
. GetFindingRequest
, opts ... gax
. CallOption
) (* websecurityscannerpb
. Finding
, error
)
GetFinding gets a Finding.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.GetFindingRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetFinding(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetScanConfig
func (c * Client
) GetScanConfig(ctx context
. Context
, req * websecurityscannerpb
. GetScanConfigRequest
, opts ... gax
. CallOption
) (* websecurityscannerpb
. ScanConfig
, error
)
GetScanConfig gets a ScanConfig.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.GetScanConfigRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetScanConfig(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetScanRun
func (c * Client
) GetScanRun(ctx context
. Context
, req * websecurityscannerpb
. GetScanRunRequest
, opts ... gax
. CallOption
) (* websecurityscannerpb
. ScanRun
, error
)
GetScanRun gets a ScanRun.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.GetScanRunRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetScanRun(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ListCrawledUrls
func (c * Client
) ListCrawledUrls(ctx context
. Context
, req * websecurityscannerpb
. ListCrawledUrlsRequest
, opts ... gax
. CallOption
) * CrawledUrlIterator
ListCrawledUrls list CrawledUrls under a given ScanRun.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
"google.golang.org/api/iterator"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.ListCrawledUrlsRequest{
// TODO: Fill request struct fields.
}
it := c.ListCrawledUrls(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListFindingTypeStats
func (c * Client
) ListFindingTypeStats(ctx context
. Context
, req * websecurityscannerpb
. ListFindingTypeStatsRequest
, opts ... gax
. CallOption
) (* websecurityscannerpb
. ListFindingTypeStatsResponse
, error
)
ListFindingTypeStats list all FindingTypeStats under a given ScanRun.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.ListFindingTypeStatsRequest{
// TODO: Fill request struct fields.
}
resp, err := c.ListFindingTypeStats(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ListFindings
func (c * Client
) ListFindings(ctx context
. Context
, req * websecurityscannerpb
. ListFindingsRequest
, opts ... gax
. CallOption
) * FindingIterator
ListFindings list Findings under a given ScanRun.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
"google.golang.org/api/iterator"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.ListFindingsRequest{
// TODO: Fill request struct fields.
}
it := c.ListFindings(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListScanConfigs
func (c * Client
) ListScanConfigs(ctx context
. Context
, req * websecurityscannerpb
. ListScanConfigsRequest
, opts ... gax
. CallOption
) * ScanConfigIterator
ListScanConfigs lists ScanConfigs under a given project.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
"google.golang.org/api/iterator"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.ListScanConfigsRequest{
// TODO: Fill request struct fields.
}
it := c.ListScanConfigs(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListScanRuns
func (c * Client
) ListScanRuns(ctx context
. Context
, req * websecurityscannerpb
. ListScanRunsRequest
, opts ... gax
. CallOption
) * ScanRunIterator
ListScanRuns lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
"google.golang.org/api/iterator"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.ListScanRunsRequest{
// TODO: Fill request struct fields.
}
it := c.ListScanRuns(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) StartScanRun
func (c * Client
) StartScanRun(ctx context
. Context
, req * websecurityscannerpb
. StartScanRunRequest
, opts ... gax
. CallOption
) (* websecurityscannerpb
. ScanRun
, error
)
StartScanRun start a ScanRun according to the given ScanConfig.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.StartScanRunRequest{
// TODO: Fill request struct fields.
}
resp, err := c.StartScanRun(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) StopScanRun
func (c * Client
) StopScanRun(ctx context
. Context
, req * websecurityscannerpb
. StopScanRunRequest
, opts ... gax
. CallOption
) (* websecurityscannerpb
. ScanRun
, error
)
StopScanRun stops a ScanRun. The stopped ScanRun is returned.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.StopScanRunRequest{
// TODO: Fill request struct fields.
}
resp, err := c.StopScanRun(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) UpdateScanConfig
func (c * Client
) UpdateScanConfig(ctx context
. Context
, req * websecurityscannerpb
. UpdateScanConfigRequest
, opts ... gax
. CallOption
) (* websecurityscannerpb
. ScanConfig
, error
)
UpdateScanConfig updates a ScanConfig. This method support partial update of a ScanConfig.
Example
package main
import (
websecurityscanner "cloud.google.com/go/websecurityscanner/apiv1"
"context"
websecurityscannerpb "google.golang.org/genproto/googleapis/cloud/websecurityscanner/v1"
)
func main() {
ctx := context.Background()
c, err := websecurityscanner.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &websecurityscannerpb.UpdateScanConfigRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateScanConfig(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
CrawledUrlIterator
type CrawledUrlIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* websecurityscannerpb
. CrawledUrl
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
CrawledUrlIterator manages a stream of *websecurityscannerpb.CrawledUrl.
func (*CrawledUrlIterator) Next
func (it * CrawledUrlIterator
) Next() (* websecurityscannerpb
. CrawledUrl
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*CrawledUrlIterator) PageInfo
func (it * CrawledUrlIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
FindingIterator
type FindingIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* websecurityscannerpb
. Finding
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
FindingIterator manages a stream of *websecurityscannerpb.Finding.
func (*FindingIterator) Next
func (it * FindingIterator
) Next() (* websecurityscannerpb
. Finding
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*FindingIterator) PageInfo
func (it * FindingIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ScanConfigIterator
type ScanConfigIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* websecurityscannerpb
. ScanConfig
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
ScanConfigIterator manages a stream of *websecurityscannerpb.ScanConfig.
func (*ScanConfigIterator) Next
func (it * ScanConfigIterator
) Next() (* websecurityscannerpb
. ScanConfig
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ScanConfigIterator) PageInfo
func (it * ScanConfigIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ScanRunIterator
type ScanRunIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* websecurityscannerpb
. ScanRun
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
ScanRunIterator manages a stream of *websecurityscannerpb.ScanRun.
func (*ScanRunIterator) Next
func (it * ScanRunIterator
) Next() (* websecurityscannerpb
. ScanRun
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ScanRunIterator) PageInfo
func (it * ScanRunIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
