forked from tenable/pyTenable
-
Notifications
You must be signed in to change notification settings - Fork 0
/
queries.py
295 lines (242 loc) · 9.89 KB
/
queries.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
'''
Queries
=======
The following methods allow for interaction into the Tenable.sc
:sc-api:`Query <Query.html>` API. These items are typically seen
under the **Workflow -> Query** section of Tenable.sc.
Methods available on ``sc.queries``:
.. rst-class:: hide-signature
.. autoclass:: QueryAPI
:members:
'''
from .base import SCEndpoint
from tenable.utils import dict_merge
class QueryAPI(SCEndpoint):
def _constructor(self, *filters, **kw):
'''
Handles parsing the keywords and returns a query definition document
'''
query = self._query_constructor(*filters, **kw)
kw = dict_merge(kw, query.get('query', dict()))
if 'name' in kw:
self._check('name', kw['name'], str)
if 'description' in kw:
self._check('description', kw['description'], str)
if 'tags' in kw:
self._check('tags', kw['tags'], str)
if 'sort_field' in kw:
kw['sortField'] = self._check(
'sort_field', kw['sort_field'], str)
del(kw['sort_field'])
if 'sort_direction' in kw:
kw['sortDir'] = self._check(
'sort_direction', kw['sort_direction'], str,
choices=['ASC', 'DESC'], case='upper')
del(kw['sort_direction'])
if 'offset' in kw:
kw['startOffset'] = self._check('offset', kw['offset'], int)
del(kw['offset'])
if 'limit' in kw:
kw['endOffset'] = self._check('limit', kw['limit'], int)
del(kw['limit'])
if 'owner_id' in kw:
kw['ownerID'] = str(self._check(
'owner_id', kw['owner_id'], int))
del(kw['owner_id'])
if 'context' in kw:
self._check('context', kw['context'], str)
if 'browse_cols' in kw:
kw['browseColumns'] = ','.join(self._check(
'browse_cols', kw['browse_cols'], list))
del(kw['browse_cols'])
if 'browse_sort_col' in kw:
kw['browseSortColumn'] = self._check(
'browse_sort_col', kw['browse_sort_col'], str)
del(kw['browse_sort_col'])
if 'browse_sort_direction' in kw:
kw['browseSortDirection'] = self._check(
'browse_sort_direction', kw['browse_sort_direction'],
str, case='upper', choices=['ASC', 'DESC'])
del(kw['browse_sort_direction'])
return kw
def create(self, name, tool, data_type, *filters, **kw):
'''
Creates a query.
:sc-api:`query: create <Query.html#query_POST>`
Args:
name (str):
The name of the new query
tool (str):
The tool to use to query the data.
data_type (str):
The type of data to query.
*filters (tuple, optional):
The filters to use for the query. Refer to the documentation
within the :ref:'tenable.sc.analysis' for more information on
how to construct these.
browse_cols (list, optional):
What columns are set to be browsable for the analysis view.
browse_sort_col (str, optional):
The browsable column in which to sort on.
browse_sort_dir (str, optional):
The direction in which to sort. Valid values are ``asc`` and
``desc``.
description (str, optional):
The description for the query.
limit (int, optional):
The limit to the number of records to return. If nothing is
specified, the API defaults to 100 records.
offset (int, optional):
The number of records to skip before returning results. If
nothing is specified, then the default is 0.
owner_id (int, optional):
The identifier stating the owner of the query. If left
unspecified, then the default is the current user.
sort_direction (str, optional):
The direction in which to sort. Valid values are ``asc`` and
``desc``.
sort_field (str, optional):
The field in which to sort the results.
tags (str, optional):
Tags definition for the query.
Returns:
:obj:`dict`:
The newly created query.
Examples:
>>> query = sc.queries.create('New Query', 'vulndetails', 'vuln',
... ('pluginID', '=', '19506'))
'''
kw['name'] = name
kw['tool'] = tool
kw['type'] = data_type
payload = self._constructor(*filters, **kw)
return self._api.post('query', json=payload).json()['response']
def details(self, id, fields=None):
'''
Returns the details for a specific query.
:sc-api:`query: details <Query.html#QueryRESTReference-/query/{id}>`
Args:
id (int): The identifier for the query.
fields (list, optional): A list of attributes to return.
Returns:
:obj:`dict`:
The query resource record.
Examples:
>>> query = sc.queries.details(1)
>>> pprint(query)
'''
params = dict()
if fields:
params['fields'] = ','.join([self._check('field', f, str) for f in fields])
return self._api.get('query/{}'.format(self._check('id', id, int)),
params=params).json()['response']
def edit(self, id, *filters, **kw):
'''
Edits a query.
:sc-api:`query: edit <Query.html#query_id_PATCH>`
Args:
*filters (tuple, optional):
The filters to use for the query. Refer to the documentation
within the :ref:'tenable.sc.analysis' for more information on
how to construct these.
browse_cols (str, optional):
What columns are set to be browsable for the analysis view.
browse_sort_col (list, optional):
The browsable column in which to sort on.
browse_sort_dir (str, optional):
The direction in which to sort. Valid values are ``asc`` and
``desc``.
description (str, optional):
The description for the query.
limit (int, optional):
The limit to the number of records to return. If nothing is
specified, the API defaults to 100 records.
name (str, optional):
The name of the new query
offset (int, optional):
The number of records to skip before returning results. If
nothing is specified, then the default is 0.
owner_id (int, optional):
The identifier stating the owner of the query. If left
unspecified, then the default is the current user.
sort_direction (str, optional):
The direction in which to sort. Valid values are ``asc`` and
``desc``.
sort_field (str, optional):
The field in which to sort the results.
tags (str, optional):
Tags definition for the query.
tool (str, optional):
The tool to use to query the data.
type (str, optional):
The type of data to query.
Returns:
:obj:` dict`:
The newly updated query.
Examples:
>>> query = sc.queries.edit()
'''
payload = self._constructor(*filters, **kw)
return self._api.patch('query/{}'.format(
self._check('id', id, int)), json=payload).json()['response']
def delete(self, id):
'''
Removes a query.
:sc-api:`query: delete <Query.html#query_id_DELETE>`
Args:
id (int): The numeric identifier for the query to remove.
Returns:
:obj:`str`:
An empty response.
Examples:
>>> sc.queries.delete(1)
'''
return self._api.delete('query/{}'.format(
self._check('id', id, int))).json()['response']
def list(self, fields=None):
'''
Retrieves the list of query definitions.
:sc-api:`query: list <Query.html#QueryRESTReference-/query>`
Args:
fields (list, optional):
A list of attributes to return for each query.
Returns:
:obj:`list`:
A list of query resources.
Examples:
>>> for query in sc.queries.list():
... pprint(query)
'''
params = dict()
if fields:
params['fields'] = ','.join([self._check('field', f, str)
for f in fields])
return self._api.get('query', params=params).json()['response']
def share(self, id, *groups):
'''
Shares the specified query to another user group.
:sc-api:`query: share <Query.html#QueryRESTReference-/query/{id}/share>`
Args:
id (int): The numeric id for the query.
*groups (int): The numeric id of the group(s) to share to.
Returns:
:obj:`dict`:
The updated query resource.
Examples:
>>> sc.queries.share(1, group_1, group_2)
'''
return self._api.post('query/{}/share'.format(
self._check('id', id, int)), json={
'groups': [{'id': self._check('group:id', i, int)}
for i in groups]}).json()['response']
def tags(self):
'''
Retrieves the list of unique tags associated to queries.
:sc-api:`query: tags <Query.html#QueryRESTReference-/query/tag>`
Returns:
:obj:`list`:
List of tags
Examples:
>>> tags = sc.queries.tags()
'''
return self._api.get('query/tag').json()['response']