This repository has been archived by the owner on Sep 5, 2023. It is now read-only.
/
security_center_grpc_transport.py
435 lines (345 loc) · 15.1 KB
/
security_center_grpc_transport.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
# -*- coding: utf-8 -*-
#
# Copyright 2020 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
import google.api_core.operations_v1
from google.cloud.securitycenter_v1.proto import securitycenter_service_pb2_grpc
class SecurityCenterGrpcTransport(object):
"""gRPC transport class providing stubs for
google.cloud.securitycenter.v1 SecurityCenter 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="securitycenter.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,
options={
"grpc.max_send_message_length": -1,
"grpc.max_receive_message_length": -1,
}.items(),
)
self._channel = channel
# gRPC uses objects called "stubs" that are bound to the
# channel and provide a basic method for each RPC.
self._stubs = {
"security_center_stub": securitycenter_service_pb2_grpc.SecurityCenterStub(
channel
),
}
# Because this API includes a method that returns a
# long-running operation (proto: google.longrunning.Operation),
# instantiate an LRO client.
self._operations_client = google.api_core.operations_v1.OperationsClient(
channel
)
@classmethod
def create_channel(
cls, address="securitycenter.googleapis.com:443", credentials=None, **kwargs
):
"""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.
kwargs (dict): Keyword arguments, which are passed to the
channel creation.
Returns:
grpc.Channel: A gRPC channel object.
"""
return google.api_core.grpc_helpers.create_channel(
address, credentials=credentials, scopes=cls._OAUTH_SCOPES, **kwargs
)
@property
def channel(self):
"""The gRPC channel used by the transport.
Returns:
grpc.Channel: A gRPC channel object.
"""
return self._channel
@property
def get_iam_policy(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.get_iam_policy`.
Gets the access control policy on the specified Source.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].GetIamPolicy
@property
def group_assets(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.group_assets`.
Filters an organization's assets and groups them by their specified
properties.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].GroupAssets
@property
def group_findings(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.group_findings`.
Filters an organization or source's findings and groups them by their
specified properties.
To group across all sources provide a ``-`` as the source id. Example:
/v1/organizations/{organization\_id}/sources/-/findings
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].GroupFindings
@property
def test_iam_permissions(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.test_iam_permissions`.
Returns the permissions that a caller has on the specified source.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].TestIamPermissions
@property
def create_source(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.create_source`.
Creates a source.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].CreateSource
@property
def create_finding(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.create_finding`.
Creates a finding. The corresponding source must exist for finding creation
to succeed.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].CreateFinding
@property
def create_notification_config(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.create_notification_config`.
Creates a notification config.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].CreateNotificationConfig
@property
def delete_notification_config(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.delete_notification_config`.
Deletes a notification config.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].DeleteNotificationConfig
@property
def get_notification_config(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.get_notification_config`.
Gets a notification config.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].GetNotificationConfig
@property
def get_organization_settings(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.get_organization_settings`.
Gets the settings for an organization.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].GetOrganizationSettings
@property
def get_source(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.get_source`.
Gets a source.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].GetSource
@property
def list_assets(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.list_assets`.
Lists an organization's assets.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].ListAssets
@property
def list_findings(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.list_findings`.
Lists an organization or source's findings.
To list across all sources provide a ``-`` as the source id. Example:
/v1/organizations/{organization\_id}/sources/-/findings
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].ListFindings
@property
def list_notification_configs(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.list_notification_configs`.
Lists notification configs.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].ListNotificationConfigs
@property
def list_sources(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.list_sources`.
Lists all sources belonging to an organization.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].ListSources
@property
def run_asset_discovery(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.run_asset_discovery`.
Runs asset discovery. The discovery is tracked with a long-running
operation.
This API can only be called with limited frequency for an organization.
If it is called too frequently the caller will receive a
TOO\_MANY\_REQUESTS error.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].RunAssetDiscovery
@property
def set_finding_state(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.set_finding_state`.
Updates the state of a finding.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].SetFindingState
@property
def set_iam_policy(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.set_iam_policy`.
Sets the access control policy on the specified Source.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].SetIamPolicy
@property
def update_finding(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.update_finding`.
Creates or updates a finding. The corresponding source must exist for a
finding creation to succeed.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].UpdateFinding
@property
def update_notification_config(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.update_notification_config`.
Updates a notification config.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].UpdateNotificationConfig
@property
def update_organization_settings(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.update_organization_settings`.
Updates an organization's settings.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].UpdateOrganizationSettings
@property
def update_source(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.update_source`.
Updates a source.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].UpdateSource
@property
def update_security_marks(self):
"""Return the gRPC stub for :meth:`SecurityCenterClient.update_security_marks`.
Updates security marks.
Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
deserialized response object.
"""
return self._stubs["security_center_stub"].UpdateSecurityMarks