Skip to content

Commit

Permalink
Websecurityscanner: add 'synth.py'. (#6087)
Browse files Browse the repository at this point in the history
Closes #6076.
  • Loading branch information
tseaver authored Sep 25, 2018
1 parent 068a349 commit 7ee9725
Show file tree
Hide file tree
Showing 5 changed files with 562 additions and 174 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# -*- coding: utf-8 -*-
#
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -13,9 +15,11 @@
# limitations under the License.
"""Wrappers for protocol buffer enum types."""

import enum


class Finding(object):
class FindingType(object):
class FindingType(enum.IntEnum):
"""
Types of Findings.
Expand Down Expand Up @@ -60,7 +64,7 @@ class FindingType(object):


class ScanConfig(object):
class UserAgent(object):
class UserAgent(enum.IntEnum):
"""
Type of user agents used for scanning.
Expand All @@ -75,7 +79,7 @@ class UserAgent(object):
CHROME_ANDROID = 2
SAFARI_IPHONE = 3

class TargetPlatform(object):
class TargetPlatform(enum.IntEnum):
"""
Cloud platforms supported by Cloud Web Security Scanner.
Expand All @@ -91,7 +95,7 @@ class TargetPlatform(object):


class ScanRun(object):
class ExecutionState(object):
class ExecutionState(enum.IntEnum):
"""
Types of ScanRun execution state.
Expand All @@ -107,7 +111,7 @@ class ExecutionState(object):
SCANNING = 2
FINISHED = 3

class ResultState(object):
class ResultState(enum.IntEnum):
"""
Types of ScanRun result state.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,263 @@
# -*- coding: utf-8 -*-
#
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import google.api_core.grpc_helpers

from google.cloud.websecurityscanner_v1alpha.proto import web_security_scanner_pb2_grpc


class WebSecurityScannerGrpcTransport(object):
"""gRPC transport class providing stubs for
google.cloud.websecurityscanner.v1alpha WebSecurityScanner API.
The transport provides access to the raw gRPC stubs,
which can be used to take advantage of advanced
features of gRPC.
"""
# The scopes needed to make gRPC calls to all of the methods defined
# in this service.
_OAUTH_SCOPES = ('https://www.googleapis.com/auth/cloud-platform', )

def __init__(self,
channel=None,
credentials=None,
address='websecurityscanner.googleapis.com:443'):
"""Instantiate the transport class.
Args:
channel (grpc.Channel): A ``Channel`` instance through
which to make calls. This argument is mutually exclusive
with ``credentials``; providing both will raise an exception.
credentials (google.auth.credentials.Credentials): The
authorization credentials to attach to requests. These
credentials identify this application to the service. If none
are specified, the client will attempt to ascertain the
credentials from the environment.
address (str): The address where the service is hosted.
"""
# If both `channel` and `credentials` are specified, raise an
# exception (channels come with credentials baked in already).
if channel is not None and credentials is not None:
raise ValueError(
'The `channel` and `credentials` arguments are mutually '
'exclusive.', )

# Create the channel.
if channel is None:
channel = self.create_channel(
address=address,
credentials=credentials,
)

# gRPC uses objects called "stubs" that are bound to the
# channel and provide a basic method for each RPC.
self._stubs = {
'web_security_scanner_stub':
web_security_scanner_pb2_grpc.WebSecurityScannerStub(channel),
}

@classmethod
def create_channel(cls,
address='websecurityscanner.googleapis.com:443',
credentials=None):
"""Create and return a gRPC channel object.
Args:
address (str): The host for the channel to use.
credentials (~.Credentials): The
authorization credentials to attach to requests. These
credentials identify this application to the service. If
none are specified, the client will attempt to ascertain
the credentials from the environment.
Returns:
grpc.Channel: A gRPC channel object.
"""
return google.api_core.grpc_helpers.create_channel(
address,
credentials=credentials,
scopes=cls._OAUTH_SCOPES,
)

@property
def create_scan_config(self):
"""Return the gRPC stub for {$apiMethod.name}.
Creates a new ScanConfig.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].CreateScanConfig

@property
def delete_scan_config(self):
"""Return the gRPC stub for {$apiMethod.name}.
Deletes an existing ScanConfig and its child resources.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].DeleteScanConfig

@property
def get_scan_config(self):
"""Return the gRPC stub for {$apiMethod.name}.
Gets a ScanConfig.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].GetScanConfig

@property
def list_scan_configs(self):
"""Return the gRPC stub for {$apiMethod.name}.
Lists ScanConfigs under a given project.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].ListScanConfigs

@property
def update_scan_config(self):
"""Return the gRPC stub for {$apiMethod.name}.
Updates a ScanConfig. This method support partial update of a ScanConfig.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].UpdateScanConfig

@property
def start_scan_run(self):
"""Return the gRPC stub for {$apiMethod.name}.
Start a ScanRun according to the given ScanConfig.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].StartScanRun

@property
def get_scan_run(self):
"""Return the gRPC stub for {$apiMethod.name}.
Gets a ScanRun.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].GetScanRun

@property
def list_scan_runs(self):
"""Return the gRPC stub for {$apiMethod.name}.
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
stop time.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].ListScanRuns

@property
def stop_scan_run(self):
"""Return the gRPC stub for {$apiMethod.name}.
Stops a ScanRun. The stopped ScanRun is returned.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].StopScanRun

@property
def list_crawled_urls(self):
"""Return the gRPC stub for {$apiMethod.name}.
List CrawledUrls under a given ScanRun.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].ListCrawledUrls

@property
def get_finding(self):
"""Return the gRPC stub for {$apiMethod.name}.
Gets a Finding.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].GetFinding

@property
def list_findings(self):
"""Return the gRPC stub for {$apiMethod.name}.
List Findings under a given ScanRun.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].ListFindings

@property
def list_finding_type_stats(self):
"""Return the gRPC stub for {$apiMethod.name}.
List all FindingTypeStats under a given ScanRun.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs['web_security_scanner_stub'].ListFindingTypeStats
Loading

0 comments on commit 7ee9725

Please sign in to comment.