-
Notifications
You must be signed in to change notification settings - Fork 129
/
aws_inventory.py
320 lines (258 loc) · 11.9 KB
/
aws_inventory.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
#!/usr/bin/env python
import argparse
import logging
import os.path
import botocore
from opinel.utils.console import configPrintException
import aws_inventory.config
import aws_inventory.blacklist
import aws_inventory.invoker
# create a module logger and ignore messages outside of the module. botocore was spewing messages
logging.basicConfig()
LOGGER = logging.getLogger(aws_inventory.__name__)
LOGGER.addFilter(logging.Filter(aws_inventory.__name__))
def setup_logging(verbose):
LOGGER.setLevel(logging.DEBUG if verbose else logging.INFO)
def parse_args(args=None):
parser = argparse.ArgumentParser(
description='Discover resources in an AWS account.'
)
parser.add_argument('--profile',
default='default',
help='Name of the profile (default: %(default)s)')
parser.add_argument('--mfa-serial',
help='serial number of MFA device')
parser.add_argument('--mfa-code',
help='MFA code')
parser.add_argument('--csv-credentials',
help='CSV file containing account credentials')
parser.add_argument('--services',
default=[],
nargs='+',
help='Name of AWS services to include')
parser.add_argument('--exclude',
dest='excluded_services',
default=[],
nargs='+',
help='Name of AWS services to exclude')
parser.add_argument('--regions',
default=[],
nargs='+',
help='Name of regions to include, defaults to all')
parser.add_argument('--list-svcs',
action='store_true',
help=('Print a list of available services (ignore service and region '
'filters) and exit'))
parser.add_argument('--list-operations',
action='store_true',
help='Print a list of operations to invoke for a given service and exit')
parser.add_argument('--dry-run',
action='store_true',
help=('Go through local API discovery, but do not actually invoke any API. '
'Useful for checking filtering of regions, services, and operations.'
))
parser.add_argument('--op-blacklist',
type=argparse.FileType('r'),
default='operation_blacklist.conf',
help=(
'Configuration file listing service operations to avoid invoking ' +
'(default: %(default)s)'
))
parser.add_argument('--exceptions-dump', help='File to dump the exceptions store')
parser.add_argument('--responses-dump', help='File to dump the responses store')
parser.add_argument('--gui-data-file',
help='File to the GUI data (default: {})'.format(
aws_inventory.config.GUI_DATA_FILENAME_TEMPLATE.template
))
parser.add_argument('--debug',
action='store_true',
help='Print debugging information')
parser.add_argument('-v', '--verbose',
action='store_true',
help='Print the account resources to stdout')
parser.add_argument('-V', '--version',
action='store_true',
help='Print version and exit')
parsed = parser.parse_args(args)
# Fill in filename-based defaults. We can't use "default" kwarg because we need another
# commandline arg, namely the profile name.
if not parsed.gui_data_file:
tool_dir = os.path.dirname(__file__)
relative_path = aws_inventory.config.GUI_DATA_FILENAME_TEMPLATE.substitute(
profile=parsed.profile
)
parsed.gui_data_file = os.path.join(tool_dir, relative_path)
return parsed
def filter_services(api_model, services=frozenset(), excluded_services=frozenset()):
"""Build a list of services by merging together a white- and black-list.
:param dict api_model: the reference API model
:param frozenset services: services to include
:param frozenset excluded_services: services to exclude
:rtype: frozenset
:return: the list of merged services
"""
available = frozenset(api_model.keys())
if services:
invalid = services - available
if invalid:
raise ValueError('Invalid requested service(s): {}'.format(invalid))
enabled = services
else:
enabled = available
if excluded_services:
invalid = excluded_services - available
if invalid:
raise ValueError('Invalid excluded service(s): {}'.format(invalid))
enabled = enabled - excluded_services
return enabled
def filter_operations(api_model, op_blacklist_parser, regions, services):
"""Build a list of operations.
:param dict api_model: the reference API model
:param OpBlacklistParser op_blacklist_parser: the blacklist parser
:param list regions: regions to include
:param list services: services to include
:rtype: dict
:return: dict describing operations from a service and available regions
"""
svc_descriptors = {}
for svc_name in services:
# validate regions against ones available for service
available_regions = api_model[svc_name]['regions']
if available_regions:
if regions:
invalid_regions = frozenset(regions) - available_regions
if invalid_regions:
LOGGER.warning('[%s] Invalid region(s): %s.', svc_name, ', '.join(invalid_regions))
target_regions = frozenset(regions) - invalid_regions
if not target_regions:
LOGGER.warning('[%s] No valid regions after applying service and region '
'filters.', svc_name)
else:
target_regions = available_regions
else:
target_regions = [None]
svc_descriptors[svc_name] = {'regions': target_regions}
LOGGER.debug('[%s] Service region(s) to inspect: %s.',
svc_name,
', '.join(target_regions if available_regions else ['global']))
operations = []
if target_regions:
for svc_op in api_model[svc_name]['ops']:
if op_blacklist_parser.is_blacklisted(svc_name, svc_op):
LOGGER.debug('[%s] Excluding blacklisted API "%s".', svc_name, svc_op)
else:
operations.append(svc_op)
if not operations:
LOGGER.warning('[%s] No operations to invoke for specified regions.', svc_name)
LOGGER.info(
'[%s] service summary - %d API(s), %d region(s).',
svc_name,
len(operations),
len(target_regions))
svc_descriptors[svc_name]['ops'] = operations
return svc_descriptors
def build_api_model():
"""Build a model of the available API.
:rtype: dict
:return: dict describing operations from a service and available regions
"""
boto_session = botocore.session.get_session()
LOGGER.debug('Building service list.')
available_services = frozenset(boto_session.get_available_services())
svc_descriptors = {}
for svc_name in available_services:
# validate regions
available_regions = frozenset(boto_session.get_available_regions(svc_name))
svc_descriptors[svc_name] = {'regions': available_regions}
if available_regions:
LOGGER.debug(
'[%s] Available service region(s): %s.',
svc_name,
', '.join(available_regions))
else:
LOGGER.warning(
'[%s] Unable to obtain a valid region. Assuming service is region agnostic (i.e., '
'global).', svc_name)
operations = []
# get operation names from local service model files
api_version = boto_session.get_config_variable('api_versions').get(svc_name, None)
service_model = boto_session.get_service_model(svc_name, api_version=api_version)
# Filter out operations we don't care about. Currently we care about operations with
# names indicating a list- or describe-like action and the operation doesn't require
# any params.
# create list of desired service operations
for svc_op in service_model.operation_names:
if aws_inventory.config.SVC_OPS_RE.match(svc_op):
operation_model = service_model.operation_model(svc_op)
try:
if not operation_model.input_shape.required_members:
operations.append(svc_op)
except AttributeError:
# no input shape
operations.append(svc_op)
svc_descriptors[svc_name]['ops'] = operations
return svc_descriptors
def main(args):
setup_logging(args.debug)
if args.version:
print aws_inventory.__version__
return
api_model = build_api_model()
if args.list_svcs:
print '\n'.join(sorted(filter_services(api_model)))
return
# configure the debug level for opinel
configPrintException(args.debug)
# validate services against API mode #
available_services = api_model.keys()
if args.services:
invalid_included_services = [svc for svc in args.services if svc not in available_services]
if invalid_included_services:
raise EnvironmentError('Invalid service(s) specified: {}'.format(
', '.join(invalid_included_services))
)
if args.excluded_services:
invalid_excluded_services = [svc for svc in args.excluded_services if svc not in available_services]
if invalid_excluded_services:
raise EnvironmentError('Invalid service(s) to exclude: {}'.format(
', '.join(invalid_excluded_services))
)
# validate regions against API model #
if args.regions:
available_regions = set()
for svc in available_services:
available_regions.update(api_model[svc]['regions'])
invalid_regions = [region for region in args.regions if region not in available_regions]
if invalid_regions:
raise EnvironmentError('Invalid region(s) specified: {}'.format(
', '.join(invalid_regions))
)
# create the list of services to analyze
services = filter_services(api_model,
frozenset(args.services),
frozenset(args.excluded_services))
if not services:
raise EnvironmentError('List of AWS services to be analyzed is empty.')
LOGGER.debug('%d AWS service(s) to inspect: %s.', len(services), ', '.join(services))
op_blacklist_parser = aws_inventory.blacklist.OpBlacklistParser(args.op_blacklist, api_model)
service_descriptors = filter_operations(api_model, op_blacklist_parser, args.regions, services)
if not service_descriptors:
raise EnvironmentError('No operations to invoke for specifed AWS services and regions.')
ops_count = 0
for svc_name in service_descriptors:
ops_count += (
len(service_descriptors[svc_name]['ops']) *
len(service_descriptors[svc_name]['regions'])
)
if args.list_operations:
print '[{}]\n{}\n'.format(
svc_name,
'\n'.join(service_descriptors[svc_name]['ops']) or '# NONE'
)
if args.list_operations:
print 'Total operations to invoke: {}'.format(ops_count)
else:
LOGGER.debug('Total operations to invoke: %d.', ops_count)
aws_inventory.invoker.ApiInvoker(args, service_descriptors, ops_count).start()
if __name__ == '__main__':
main(parse_args())