google-cloud-web_security_scanner-v1 0.7.1 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/web_security_scanner/v1/version.rb +1 -1
- data/lib/google/cloud/web_security_scanner/v1/web_security_scanner/client.rb +41 -9
- data/lib/google/cloud/web_security_scanner/v1/web_security_scanner/rest/client.rb +257 -7
- data/lib/google/cloud/web_security_scanner/v1/web_security_scanner/rest/service_stub.rb +14 -2
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- data/proto_docs/google/cloud/websecurityscanner/v1/scan_config.rb +2 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 44b6d933c756838fff0ece271b3374c155ef06e0f7a127caa5b4a14d196b48b4
|
4
|
+
data.tar.gz: 6c6f5807319d636a37f6b6832a3dbc3e88c3d92e3d36739556addeede698839b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 60ce2c753dace9c85093894504ff959a9e653c913524642233f77c0f2a4312c960f3a4582433561fda98da20a7bd16b4662281fde580900a44c6923396e597ff
|
7
|
+
data.tar.gz: e9fefb678060e2f901e6e1333935d9ac1b5ef594c361d4a70f36565d63d752e1a369504a1ffe7b87ec8308141e7cde45715c6e1bc00bb5a80f67d7e8ccaee486
|
data/AUTHENTICATION.md
CHANGED
@@ -1,151 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
7
|
-
credentials will be discovered automatically. When running on other
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
9
|
-
path to the
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
11
|
-
for the account (or the JSON itself) in
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
14
|
-
during development.
|
3
|
+
The recommended way to authenticate to the google-cloud-web_security_scanner-v1 library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
15
6
|
|
16
7
|
## Quickstart
|
17
8
|
|
18
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
26
14
|
|
27
|
-
|
28
|
-
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
29
17
|
|
30
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-cloud-web_security_scanner-v1 library aims to make authentication
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
38
|
-
|
39
|
-
**Credentials** are discovered in the following order:
|
40
|
-
|
41
|
-
1. Specify credentials in method arguments
|
42
|
-
2. Specify credentials in configuration
|
43
|
-
3. Discover credentials path in environment variables
|
44
|
-
4. Discover credentials JSON in environment variables
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
46
|
-
6. Discover GCP credentials
|
47
|
-
|
48
|
-
### Google Cloud Platform environments
|
22
|
+
3. Write code as if already authenticated.
|
49
23
|
|
50
|
-
|
51
|
-
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
54
26
|
|
55
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
63
|
-
containers where writing files is difficult or not encouraged.
|
29
|
+
The google-cloud-web_security_scanner-v1 library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
64
33
|
|
65
|
-
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
{::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Credentials}):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
74
41
|
|
75
|
-
|
76
|
-
require "google/cloud/web_security_scanner/v1"
|
77
|
-
|
78
|
-
ENV["WEB_SECURITY_SCANNER_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
79
43
|
|
80
|
-
client
|
81
|
-
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
82
49
|
|
83
|
-
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
84
53
|
|
85
|
-
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
54
|
+
To configure a credentials file for an individual client initialization:
|
87
55
|
|
88
56
|
```ruby
|
89
57
|
require "google/cloud/web_security_scanner/v1"
|
90
58
|
|
91
59
|
client = ::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Client.new do |config|
|
92
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
93
61
|
end
|
94
62
|
```
|
95
63
|
|
96
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
97
65
|
|
98
66
|
```ruby
|
99
67
|
require "google/cloud/web_security_scanner/v1"
|
100
68
|
|
101
69
|
::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Client.configure do |config|
|
102
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
103
71
|
end
|
104
72
|
|
105
73
|
client = ::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Client.new
|
106
74
|
```
|
107
75
|
|
108
|
-
###
|
76
|
+
### Environment Variables
|
109
77
|
|
110
|
-
|
111
|
-
|
112
|
-
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
113
82
|
|
114
|
-
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
115
87
|
|
116
|
-
|
117
|
-
|
118
|
-
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-cloud-web_security_scanner-v1
|
93
|
+
checks for credentials are:
|
119
94
|
|
120
|
-
|
121
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
122
97
|
|
123
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/web_security_scanner/v1"
|
124
100
|
|
125
|
-
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
127
|
-
connect to most services with google-cloud-web_security_scanner-v1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
128
102
|
|
129
|
-
|
130
|
-
|
131
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Client.new
|
104
|
+
```
|
132
105
|
|
133
|
-
|
134
|
-
2. Create a new project or click on an existing project.
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
136
|
-
here, you will enable the APIs that your application requires.
|
106
|
+
### Local ADC file
|
137
107
|
|
138
|
-
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
139
111
|
|
140
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
141
113
|
|
142
|
-
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
144
115
|
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
149
120
|
|
150
|
-
|
151
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
@@ -32,6 +32,9 @@ module Google
|
|
32
32
|
# attempts to exercise as many user inputs and event handlers as possible.
|
33
33
|
#
|
34
34
|
class Client
|
35
|
+
# @private
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "websecurityscanner.$UNIVERSE_DOMAIN$"
|
37
|
+
|
35
38
|
# @private
|
36
39
|
attr_reader :web_security_scanner_stub
|
37
40
|
|
@@ -143,6 +146,15 @@ module Google
|
|
143
146
|
@config
|
144
147
|
end
|
145
148
|
|
149
|
+
##
|
150
|
+
# The effective universe domain
|
151
|
+
#
|
152
|
+
# @return [String]
|
153
|
+
#
|
154
|
+
def universe_domain
|
155
|
+
@web_security_scanner_stub.universe_domain
|
156
|
+
end
|
157
|
+
|
146
158
|
##
|
147
159
|
# Create a new WebSecurityScanner client object.
|
148
160
|
#
|
@@ -176,8 +188,9 @@ module Google
|
|
176
188
|
credentials = @config.credentials
|
177
189
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
178
190
|
# but only if the default endpoint does not have a region prefix.
|
179
|
-
enable_self_signed_jwt = @config.endpoint
|
180
|
-
|
191
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
192
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
193
|
+
!@config.endpoint.split(".").first.include?("-"))
|
181
194
|
credentials ||= Credentials.default scope: @config.scope,
|
182
195
|
enable_self_signed_jwt: enable_self_signed_jwt
|
183
196
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -188,10 +201,13 @@ module Google
|
|
188
201
|
|
189
202
|
@web_security_scanner_stub = ::Gapic::ServiceStub.new(
|
190
203
|
::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Stub,
|
191
|
-
credentials:
|
192
|
-
endpoint:
|
204
|
+
credentials: credentials,
|
205
|
+
endpoint: @config.endpoint,
|
206
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
207
|
+
universe_domain: @config.universe_domain,
|
193
208
|
channel_args: @config.channel_args,
|
194
|
-
interceptors: @config.interceptors
|
209
|
+
interceptors: @config.interceptors,
|
210
|
+
channel_pool_config: @config.channel_pool
|
195
211
|
)
|
196
212
|
end
|
197
213
|
|
@@ -1416,9 +1432,9 @@ module Google
|
|
1416
1432
|
# end
|
1417
1433
|
#
|
1418
1434
|
# @!attribute [rw] endpoint
|
1419
|
-
#
|
1420
|
-
#
|
1421
|
-
# @return [::String]
|
1435
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
1436
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
1437
|
+
# @return [::String,nil]
|
1422
1438
|
# @!attribute [rw] credentials
|
1423
1439
|
# Credentials to send with calls. You may provide any of the following types:
|
1424
1440
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -1464,13 +1480,20 @@ module Google
|
|
1464
1480
|
# @!attribute [rw] quota_project
|
1465
1481
|
# A separate project against which to charge quota.
|
1466
1482
|
# @return [::String]
|
1483
|
+
# @!attribute [rw] universe_domain
|
1484
|
+
# The universe domain within which to make requests. This determines the
|
1485
|
+
# default endpoint URL. The default value of nil uses the environment
|
1486
|
+
# universe (usually the default "googleapis.com" universe).
|
1487
|
+
# @return [::String,nil]
|
1467
1488
|
#
|
1468
1489
|
class Configuration
|
1469
1490
|
extend ::Gapic::Config
|
1470
1491
|
|
1492
|
+
# @private
|
1493
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1471
1494
|
DEFAULT_ENDPOINT = "websecurityscanner.googleapis.com"
|
1472
1495
|
|
1473
|
-
config_attr :endpoint,
|
1496
|
+
config_attr :endpoint, nil, ::String, nil
|
1474
1497
|
config_attr :credentials, nil do |value|
|
1475
1498
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1476
1499
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -1485,6 +1508,7 @@ module Google
|
|
1485
1508
|
config_attr :metadata, nil, ::Hash, nil
|
1486
1509
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1487
1510
|
config_attr :quota_project, nil, ::String, nil
|
1511
|
+
config_attr :universe_domain, nil, ::String, nil
|
1488
1512
|
|
1489
1513
|
# @private
|
1490
1514
|
def initialize parent_config = nil
|
@@ -1505,6 +1529,14 @@ module Google
|
|
1505
1529
|
end
|
1506
1530
|
end
|
1507
1531
|
|
1532
|
+
##
|
1533
|
+
# Configuration for the channel pool
|
1534
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
1535
|
+
#
|
1536
|
+
def channel_pool
|
1537
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
1538
|
+
end
|
1539
|
+
|
1508
1540
|
##
|
1509
1541
|
# Configuration RPC class for the WebSecurityScanner API.
|
1510
1542
|
#
|
@@ -34,6 +34,9 @@ module Google
|
|
34
34
|
# attempts to exercise as many user inputs and event handlers as possible.
|
35
35
|
#
|
36
36
|
class Client
|
37
|
+
# @private
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "websecurityscanner.$UNIVERSE_DOMAIN$"
|
39
|
+
|
37
40
|
# @private
|
38
41
|
attr_reader :web_security_scanner_stub
|
39
42
|
|
@@ -145,6 +148,15 @@ module Google
|
|
145
148
|
@config
|
146
149
|
end
|
147
150
|
|
151
|
+
##
|
152
|
+
# The effective universe domain
|
153
|
+
#
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
|
+
def universe_domain
|
157
|
+
@web_security_scanner_stub.universe_domain
|
158
|
+
end
|
159
|
+
|
148
160
|
##
|
149
161
|
# Create a new WebSecurityScanner REST client object.
|
150
162
|
#
|
@@ -172,8 +184,9 @@ module Google
|
|
172
184
|
credentials = @config.credentials
|
173
185
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
174
186
|
# but only if the default endpoint does not have a region prefix.
|
175
|
-
enable_self_signed_jwt = @config.endpoint
|
176
|
-
|
187
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
188
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
189
|
+
!@config.endpoint.split(".").first.include?("-"))
|
177
190
|
credentials ||= Credentials.default scope: @config.scope,
|
178
191
|
enable_self_signed_jwt: enable_self_signed_jwt
|
179
192
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -183,7 +196,12 @@ module Google
|
|
183
196
|
@quota_project_id = @config.quota_project
|
184
197
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
185
198
|
|
186
|
-
@web_security_scanner_stub = ::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::ServiceStub.new
|
199
|
+
@web_security_scanner_stub = ::Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::ServiceStub.new(
|
200
|
+
endpoint: @config.endpoint,
|
201
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
202
|
+
universe_domain: @config.universe_domain,
|
203
|
+
credentials: credentials
|
204
|
+
)
|
187
205
|
end
|
188
206
|
|
189
207
|
# Service calls
|
@@ -218,6 +236,22 @@ module Google
|
|
218
236
|
# @return [::Google::Cloud::WebSecurityScanner::V1::ScanConfig]
|
219
237
|
#
|
220
238
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
239
|
+
#
|
240
|
+
# @example Basic example
|
241
|
+
# require "google/cloud/web_security_scanner/v1"
|
242
|
+
#
|
243
|
+
# # Create a client object. The client can be reused for multiple calls.
|
244
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
245
|
+
#
|
246
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
247
|
+
# request = Google::Cloud::WebSecurityScanner::V1::CreateScanConfigRequest.new
|
248
|
+
#
|
249
|
+
# # Call the create_scan_config method.
|
250
|
+
# result = client.create_scan_config request
|
251
|
+
#
|
252
|
+
# # The returned object is of type Google::Cloud::WebSecurityScanner::V1::ScanConfig.
|
253
|
+
# p result
|
254
|
+
#
|
221
255
|
def create_scan_config request, options = nil
|
222
256
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
223
257
|
|
@@ -281,6 +315,22 @@ module Google
|
|
281
315
|
# @return [::Google::Protobuf::Empty]
|
282
316
|
#
|
283
317
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
318
|
+
#
|
319
|
+
# @example Basic example
|
320
|
+
# require "google/cloud/web_security_scanner/v1"
|
321
|
+
#
|
322
|
+
# # Create a client object. The client can be reused for multiple calls.
|
323
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
324
|
+
#
|
325
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
326
|
+
# request = Google::Cloud::WebSecurityScanner::V1::DeleteScanConfigRequest.new
|
327
|
+
#
|
328
|
+
# # Call the delete_scan_config method.
|
329
|
+
# result = client.delete_scan_config request
|
330
|
+
#
|
331
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
332
|
+
# p result
|
333
|
+
#
|
284
334
|
def delete_scan_config request, options = nil
|
285
335
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
286
336
|
|
@@ -344,6 +394,22 @@ module Google
|
|
344
394
|
# @return [::Google::Cloud::WebSecurityScanner::V1::ScanConfig]
|
345
395
|
#
|
346
396
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
397
|
+
#
|
398
|
+
# @example Basic example
|
399
|
+
# require "google/cloud/web_security_scanner/v1"
|
400
|
+
#
|
401
|
+
# # Create a client object. The client can be reused for multiple calls.
|
402
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
403
|
+
#
|
404
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
405
|
+
# request = Google::Cloud::WebSecurityScanner::V1::GetScanConfigRequest.new
|
406
|
+
#
|
407
|
+
# # Call the get_scan_config method.
|
408
|
+
# result = client.get_scan_config request
|
409
|
+
#
|
410
|
+
# # The returned object is of type Google::Cloud::WebSecurityScanner::V1::ScanConfig.
|
411
|
+
# p result
|
412
|
+
#
|
347
413
|
def get_scan_config request, options = nil
|
348
414
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
349
415
|
|
@@ -415,6 +481,26 @@ module Google
|
|
415
481
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1::ScanConfig>]
|
416
482
|
#
|
417
483
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
484
|
+
#
|
485
|
+
# @example Basic example
|
486
|
+
# require "google/cloud/web_security_scanner/v1"
|
487
|
+
#
|
488
|
+
# # Create a client object. The client can be reused for multiple calls.
|
489
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
490
|
+
#
|
491
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
492
|
+
# request = Google::Cloud::WebSecurityScanner::V1::ListScanConfigsRequest.new
|
493
|
+
#
|
494
|
+
# # Call the list_scan_configs method.
|
495
|
+
# result = client.list_scan_configs request
|
496
|
+
#
|
497
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
498
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
499
|
+
# result.each do |item|
|
500
|
+
# # Each element is of type ::Google::Cloud::WebSecurityScanner::V1::ScanConfig.
|
501
|
+
# p item
|
502
|
+
# end
|
503
|
+
#
|
418
504
|
def list_scan_configs request, options = nil
|
419
505
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
420
506
|
|
@@ -484,6 +570,22 @@ module Google
|
|
484
570
|
# @return [::Google::Cloud::WebSecurityScanner::V1::ScanConfig]
|
485
571
|
#
|
486
572
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
573
|
+
#
|
574
|
+
# @example Basic example
|
575
|
+
# require "google/cloud/web_security_scanner/v1"
|
576
|
+
#
|
577
|
+
# # Create a client object. The client can be reused for multiple calls.
|
578
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
579
|
+
#
|
580
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
581
|
+
# request = Google::Cloud::WebSecurityScanner::V1::UpdateScanConfigRequest.new
|
582
|
+
#
|
583
|
+
# # Call the update_scan_config method.
|
584
|
+
# result = client.update_scan_config request
|
585
|
+
#
|
586
|
+
# # The returned object is of type Google::Cloud::WebSecurityScanner::V1::ScanConfig.
|
587
|
+
# p result
|
588
|
+
#
|
487
589
|
def update_scan_config request, options = nil
|
488
590
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
489
591
|
|
@@ -547,6 +649,22 @@ module Google
|
|
547
649
|
# @return [::Google::Cloud::WebSecurityScanner::V1::ScanRun]
|
548
650
|
#
|
549
651
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
652
|
+
#
|
653
|
+
# @example Basic example
|
654
|
+
# require "google/cloud/web_security_scanner/v1"
|
655
|
+
#
|
656
|
+
# # Create a client object. The client can be reused for multiple calls.
|
657
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
658
|
+
#
|
659
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
660
|
+
# request = Google::Cloud::WebSecurityScanner::V1::StartScanRunRequest.new
|
661
|
+
#
|
662
|
+
# # Call the start_scan_run method.
|
663
|
+
# result = client.start_scan_run request
|
664
|
+
#
|
665
|
+
# # The returned object is of type Google::Cloud::WebSecurityScanner::V1::ScanRun.
|
666
|
+
# p result
|
667
|
+
#
|
550
668
|
def start_scan_run request, options = nil
|
551
669
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
552
670
|
|
@@ -611,6 +729,22 @@ module Google
|
|
611
729
|
# @return [::Google::Cloud::WebSecurityScanner::V1::ScanRun]
|
612
730
|
#
|
613
731
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
732
|
+
#
|
733
|
+
# @example Basic example
|
734
|
+
# require "google/cloud/web_security_scanner/v1"
|
735
|
+
#
|
736
|
+
# # Create a client object. The client can be reused for multiple calls.
|
737
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
738
|
+
#
|
739
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
740
|
+
# request = Google::Cloud::WebSecurityScanner::V1::GetScanRunRequest.new
|
741
|
+
#
|
742
|
+
# # Call the get_scan_run method.
|
743
|
+
# result = client.get_scan_run request
|
744
|
+
#
|
745
|
+
# # The returned object is of type Google::Cloud::WebSecurityScanner::V1::ScanRun.
|
746
|
+
# p result
|
747
|
+
#
|
614
748
|
def get_scan_run request, options = nil
|
615
749
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
616
750
|
|
@@ -683,6 +817,26 @@ module Google
|
|
683
817
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1::ScanRun>]
|
684
818
|
#
|
685
819
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
820
|
+
#
|
821
|
+
# @example Basic example
|
822
|
+
# require "google/cloud/web_security_scanner/v1"
|
823
|
+
#
|
824
|
+
# # Create a client object. The client can be reused for multiple calls.
|
825
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
826
|
+
#
|
827
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
828
|
+
# request = Google::Cloud::WebSecurityScanner::V1::ListScanRunsRequest.new
|
829
|
+
#
|
830
|
+
# # Call the list_scan_runs method.
|
831
|
+
# result = client.list_scan_runs request
|
832
|
+
#
|
833
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
834
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
835
|
+
# result.each do |item|
|
836
|
+
# # Each element is of type ::Google::Cloud::WebSecurityScanner::V1::ScanRun.
|
837
|
+
# p item
|
838
|
+
# end
|
839
|
+
#
|
686
840
|
def list_scan_runs request, options = nil
|
687
841
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
688
842
|
|
@@ -748,6 +902,22 @@ module Google
|
|
748
902
|
# @return [::Google::Cloud::WebSecurityScanner::V1::ScanRun]
|
749
903
|
#
|
750
904
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
905
|
+
#
|
906
|
+
# @example Basic example
|
907
|
+
# require "google/cloud/web_security_scanner/v1"
|
908
|
+
#
|
909
|
+
# # Create a client object. The client can be reused for multiple calls.
|
910
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
911
|
+
#
|
912
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
913
|
+
# request = Google::Cloud::WebSecurityScanner::V1::StopScanRunRequest.new
|
914
|
+
#
|
915
|
+
# # Call the stop_scan_run method.
|
916
|
+
# result = client.stop_scan_run request
|
917
|
+
#
|
918
|
+
# # The returned object is of type Google::Cloud::WebSecurityScanner::V1::ScanRun.
|
919
|
+
# p result
|
920
|
+
#
|
751
921
|
def stop_scan_run request, options = nil
|
752
922
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
753
923
|
|
@@ -820,6 +990,26 @@ module Google
|
|
820
990
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1::CrawledUrl>]
|
821
991
|
#
|
822
992
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
993
|
+
#
|
994
|
+
# @example Basic example
|
995
|
+
# require "google/cloud/web_security_scanner/v1"
|
996
|
+
#
|
997
|
+
# # Create a client object. The client can be reused for multiple calls.
|
998
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
999
|
+
#
|
1000
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1001
|
+
# request = Google::Cloud::WebSecurityScanner::V1::ListCrawledUrlsRequest.new
|
1002
|
+
#
|
1003
|
+
# # Call the list_crawled_urls method.
|
1004
|
+
# result = client.list_crawled_urls request
|
1005
|
+
#
|
1006
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1007
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1008
|
+
# result.each do |item|
|
1009
|
+
# # Each element is of type ::Google::Cloud::WebSecurityScanner::V1::CrawledUrl.
|
1010
|
+
# p item
|
1011
|
+
# end
|
1012
|
+
#
|
823
1013
|
def list_crawled_urls request, options = nil
|
824
1014
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
825
1015
|
|
@@ -885,6 +1075,22 @@ module Google
|
|
885
1075
|
# @return [::Google::Cloud::WebSecurityScanner::V1::Finding]
|
886
1076
|
#
|
887
1077
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1078
|
+
#
|
1079
|
+
# @example Basic example
|
1080
|
+
# require "google/cloud/web_security_scanner/v1"
|
1081
|
+
#
|
1082
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1083
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
1084
|
+
#
|
1085
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1086
|
+
# request = Google::Cloud::WebSecurityScanner::V1::GetFindingRequest.new
|
1087
|
+
#
|
1088
|
+
# # Call the get_finding method.
|
1089
|
+
# result = client.get_finding request
|
1090
|
+
#
|
1091
|
+
# # The returned object is of type Google::Cloud::WebSecurityScanner::V1::Finding.
|
1092
|
+
# p result
|
1093
|
+
#
|
888
1094
|
def get_finding request, options = nil
|
889
1095
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
890
1096
|
|
@@ -962,6 +1168,26 @@ module Google
|
|
962
1168
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1::Finding>]
|
963
1169
|
#
|
964
1170
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1171
|
+
#
|
1172
|
+
# @example Basic example
|
1173
|
+
# require "google/cloud/web_security_scanner/v1"
|
1174
|
+
#
|
1175
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1176
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
1177
|
+
#
|
1178
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1179
|
+
# request = Google::Cloud::WebSecurityScanner::V1::ListFindingsRequest.new
|
1180
|
+
#
|
1181
|
+
# # Call the list_findings method.
|
1182
|
+
# result = client.list_findings request
|
1183
|
+
#
|
1184
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1185
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1186
|
+
# result.each do |item|
|
1187
|
+
# # Each element is of type ::Google::Cloud::WebSecurityScanner::V1::Finding.
|
1188
|
+
# p item
|
1189
|
+
# end
|
1190
|
+
#
|
965
1191
|
def list_findings request, options = nil
|
966
1192
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
967
1193
|
|
@@ -1027,6 +1253,22 @@ module Google
|
|
1027
1253
|
# @return [::Google::Cloud::WebSecurityScanner::V1::ListFindingTypeStatsResponse]
|
1028
1254
|
#
|
1029
1255
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1256
|
+
#
|
1257
|
+
# @example Basic example
|
1258
|
+
# require "google/cloud/web_security_scanner/v1"
|
1259
|
+
#
|
1260
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1261
|
+
# client = Google::Cloud::WebSecurityScanner::V1::WebSecurityScanner::Rest::Client.new
|
1262
|
+
#
|
1263
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1264
|
+
# request = Google::Cloud::WebSecurityScanner::V1::ListFindingTypeStatsRequest.new
|
1265
|
+
#
|
1266
|
+
# # Call the list_finding_type_stats method.
|
1267
|
+
# result = client.list_finding_type_stats request
|
1268
|
+
#
|
1269
|
+
# # The returned object is of type Google::Cloud::WebSecurityScanner::V1::ListFindingTypeStatsResponse.
|
1270
|
+
# p result
|
1271
|
+
#
|
1030
1272
|
def list_finding_type_stats request, options = nil
|
1031
1273
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1032
1274
|
|
@@ -1092,9 +1334,9 @@ module Google
|
|
1092
1334
|
# end
|
1093
1335
|
#
|
1094
1336
|
# @!attribute [rw] endpoint
|
1095
|
-
#
|
1096
|
-
#
|
1097
|
-
# @return [::String]
|
1337
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
1338
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
1339
|
+
# @return [::String,nil]
|
1098
1340
|
# @!attribute [rw] credentials
|
1099
1341
|
# Credentials to send with calls. You may provide any of the following types:
|
1100
1342
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -1131,13 +1373,20 @@ module Google
|
|
1131
1373
|
# @!attribute [rw] quota_project
|
1132
1374
|
# A separate project against which to charge quota.
|
1133
1375
|
# @return [::String]
|
1376
|
+
# @!attribute [rw] universe_domain
|
1377
|
+
# The universe domain within which to make requests. This determines the
|
1378
|
+
# default endpoint URL. The default value of nil uses the environment
|
1379
|
+
# universe (usually the default "googleapis.com" universe).
|
1380
|
+
# @return [::String,nil]
|
1134
1381
|
#
|
1135
1382
|
class Configuration
|
1136
1383
|
extend ::Gapic::Config
|
1137
1384
|
|
1385
|
+
# @private
|
1386
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1138
1387
|
DEFAULT_ENDPOINT = "websecurityscanner.googleapis.com"
|
1139
1388
|
|
1140
|
-
config_attr :endpoint,
|
1389
|
+
config_attr :endpoint, nil, ::String, nil
|
1141
1390
|
config_attr :credentials, nil do |value|
|
1142
1391
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1143
1392
|
allowed.any? { |klass| klass === value }
|
@@ -1149,6 +1398,7 @@ module Google
|
|
1149
1398
|
config_attr :metadata, nil, ::Hash, nil
|
1150
1399
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1151
1400
|
config_attr :quota_project, nil, ::String, nil
|
1401
|
+
config_attr :universe_domain, nil, ::String, nil
|
1152
1402
|
|
1153
1403
|
# @private
|
1154
1404
|
def initialize parent_config = nil
|
@@ -30,16 +30,28 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
def initialize endpoint:, credentials:
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
34
34
|
# These require statements are intentionally placed here to initialize
|
35
35
|
# the REST modules only when it's required.
|
36
36
|
require "gapic/rest"
|
37
37
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
endpoint_template: endpoint_template,
|
40
|
+
universe_domain: universe_domain,
|
41
|
+
credentials: credentials,
|
39
42
|
numeric_enums: true,
|
40
43
|
raise_faraday_errors: false
|
41
44
|
end
|
42
45
|
|
46
|
+
##
|
47
|
+
# The effective universe domain
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
def universe_domain
|
52
|
+
@client_stub.universe_domain
|
53
|
+
end
|
54
|
+
|
43
55
|
##
|
44
56
|
# Baseline implementation for the create_scan_config REST call
|
45
57
|
#
|
@@ -21,6 +21,7 @@ module Google
|
|
21
21
|
module Api
|
22
22
|
# Required information for every language.
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
24
25
|
# @return [::String]
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
@@ -304,6 +305,19 @@ module Google
|
|
304
305
|
# seconds: 360 # 6 minutes
|
305
306
|
# total_poll_timeout:
|
306
307
|
# seconds: 54000 # 90 minutes
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
309
|
+
# @return [::Array<::String>]
|
310
|
+
# List of top-level fields of the request message, that should be
|
311
|
+
# automatically populated by the client libraries based on their
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
313
|
+
#
|
314
|
+
# Example of a YAML configuration:
|
315
|
+
#
|
316
|
+
# publishing:
|
317
|
+
# method_settings:
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
319
|
+
# auto_populated_fields:
|
320
|
+
# - request_id
|
307
321
|
class MethodSettings
|
308
322
|
include ::Google::Protobuf::MessageExts
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
@@ -77,6 +77,7 @@ module Google
|
|
77
77
|
|
78
78
|
# Scan authentication configuration.
|
79
79
|
# @!attribute [rw] google_account
|
80
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
80
81
|
# @return [::Google::Cloud::WebSecurityScanner::V1::ScanConfig::Authentication::GoogleAccount]
|
81
82
|
# Authentication using a Google account.
|
82
83
|
# @!attribute [rw] custom_account
|
@@ -90,6 +91,7 @@ module Google
|
|
90
91
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
91
92
|
|
92
93
|
# Describes authentication configuration that uses a Google account.
|
94
|
+
# @deprecated This message is deprecated and may be removed in the next major version update.
|
93
95
|
# @!attribute [rw] username
|
94
96
|
# @return [::String]
|
95
97
|
# Required. The user name of the Google account.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-web_security_scanner-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.9.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.21.1
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.21.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
230
230
|
- !ruby/object:Gem::Version
|
231
231
|
version: '0'
|
232
232
|
requirements: []
|
233
|
-
rubygems_version: 3.
|
233
|
+
rubygems_version: 3.5.3
|
234
234
|
signing_key:
|
235
235
|
specification_version: 4
|
236
236
|
summary: Scans your Compute and App Engine apps for common web vulnerabilities.
|