traffic-replay: add extra check
[garming/samba-autobuild/.git] / script / traffic_replay
1 #!/usr/bin/env python
2 # Generates samba network traffic
3 #
4 # Copyright (C) Catalyst IT Ltd. 2017
5 #
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 #
19 from __future__ import print_function
20 import sys
21 import os
22 import optparse
23 import tempfile
24 import shutil
25 import random
26
27 sys.path.insert(0, "bin/python")
28
29 from samba import gensec
30 from samba.emulate import traffic
31 import samba.getopt as options
32
33
34 def print_err(*args, **kwargs):
35     print(*args, file=sys.stderr, **kwargs)
36
37
38 def main():
39
40     desc = ("Generates network traffic 'conversations' based on <summary-file>"
41             " (which should be the output file produced by either traffic_learner"
42             " or traffic_summary.pl). This traffic is sent to <dns-hostname>,"
43             " which is the full DNS hostname of the DC being tested.")
44
45     parser = optparse.OptionParser(
46         "%prog [--help|options] <summary-file> <dns-hostname>",
47         description=desc)
48
49     parser.add_option('--dns-rate', type='float', default=0,
50                       help='fire extra DNS packets at this rate')
51     parser.add_option('-B', '--badpassword-frequency',
52                       type='float', default=0.0,
53                       help='frequency of connections with bad passwords')
54     parser.add_option('-K', '--prefer-kerberos',
55                       action="store_true",
56                       help='prefer kerberos when authenticating test users')
57     parser.add_option('-I', '--instance-id', type='int', default=0,
58                       help='Instance number, when running multiple instances')
59     parser.add_option('-t', '--timing-data',
60                       help=('write individual message timing data here '
61                             '(- for stdout)'))
62     parser.add_option('--preserve-tempdir', default=False, action="store_true",
63                       help='do not delete temporary files')
64     parser.add_option('-F', '--fixed-password',
65                       type='string', default=None,
66                       help=('Password used for the test users created. '
67                             'Required'))
68     parser.add_option('-c', '--clean-up',
69                       action="store_true",
70                       help='Clean up the generated groups and user accounts')
71     parser.add_option('--random-seed', type='int', default=0,
72                       help='Use to keep randomness consistent across multiple runs')
73
74     model_group = optparse.OptionGroup(parser, 'Traffic Model Options',
75                                        'These options alter the traffic '
76                                        'generated when the summary-file is a '
77                                        'traffic-model (produced by '
78                                        'traffic_learner)')
79     model_group.add_option('-S', '--scale-traffic', type='float', default=1.0,
80                            help='Increase the number of conversations by '
81                            'this factor')
82     model_group.add_option('-D', '--duration', type='float', default=None,
83                            help=('Run model for this long (approx). '
84                                  'Default 60s for models'))
85     model_group.add_option('-r', '--replay-rate', type='float', default=1.0,
86                            help='Replay the traffic faster by this factor')
87     model_group.add_option('--traffic-summary',
88                            help=('Generate a traffic summary file and write '
89                                  'it here (- for stdout)'))
90     parser.add_option_group(model_group)
91
92     user_gen_group = optparse.OptionGroup(parser, 'Generate User Options',
93                                           "Add extra user/groups on the DC to "
94                                           "increase the DB size. These extra "
95                                           "users aren't used for traffic "
96                                           "generation.")
97     user_gen_group.add_option('-G', '--generate-users-only',
98                               action="store_true",
99                               help='Generate the users, but do not replay '
100                               'the traffic')
101     user_gen_group.add_option('-n', '--number-of-users', type='int', default=0,
102                               help='Total number of test users to create')
103     user_gen_group.add_option('--number-of-groups', type='int', default=0,
104                               help='Create this many groups')
105     user_gen_group.add_option('--average-groups-per-user',
106                               type='int', default=0,
107                               help='Assign the test users to this '
108                               'many groups on average')
109     user_gen_group.add_option('--group-memberships', type='int', default=0,
110                               help='Total memberships to assign across all '
111                               'test users and all groups')
112     parser.add_option_group(user_gen_group)
113
114     sambaopts = options.SambaOptions(parser)
115     parser.add_option_group(sambaopts)
116     parser.add_option_group(options.VersionOptions(parser))
117     credopts = options.CredentialsOptions(parser)
118     parser.add_option_group(credopts)
119
120     # the --no-password credential doesn't make sense for this tool
121     if parser.has_option('-N'):
122         parser.remove_option('-N')
123
124     opts, args = parser.parse_args()
125
126     # First ensure we have reasonable arguments
127
128     if len(args) == 1:
129         summary = None
130         host    = args[0]
131     elif len(args) == 2:
132         summary, host = args
133     else:
134         parser.print_usage()
135         return
136
137     if opts.clean_up:
138         print_err("Removing user and machine accounts")
139         lp    = sambaopts.get_loadparm()
140         creds = credopts.get_credentials(lp)
141         creds.set_gensec_features(creds.get_gensec_features() | gensec.FEATURE_SEAL)
142         ldb   = traffic.openLdb(host, creds, lp)
143         traffic.clean_up_accounts(ldb, opts.instance_id)
144         exit(0)
145
146     if summary:
147         if not os.path.exists(summary):
148             print_err("Summary file %s doesn't exist" % summary)
149             sys.exit(1)
150     # the summary-file can be ommitted for --generate-users-only and
151     # --cleanup-up, but it should be specified in all other cases
152     elif not opts.generate_users_only:
153         print_err("No summary-file specified to replay traffic from")
154         sys.exit(1)
155
156     if not opts.fixed_password:
157         print_err(("Please use --fixed-password to specify a password"
158                              " for the users created as part of this test"))
159         sys.exit(1)
160
161     if opts.random_seed:
162         random.seed(opts.random_seed)
163
164     lp = sambaopts.get_loadparm()
165     creds = credopts.get_credentials(lp)
166     creds.set_gensec_features(creds.get_gensec_features() | gensec.FEATURE_SEAL)
167
168     domain = creds.get_domain()
169     if domain:
170         lp.set("workgroup", domain)
171     else:
172         domain = lp.get("workgroup")
173         if domain == "WORKGROUP":
174             print_err(("NETBIOS domain does not appear to be "
175                        "specified, use the --workgroup option"))
176             sys.exit(1)
177
178     if not opts.realm and not lp.get('realm'):
179         print_err("Realm not specified, use the --realm option")
180         sys.exit(1)
181
182     if opts.generate_users_only and not (opts.number_of_users or
183                                          opts.number_of_groups):
184         print_err(("Please specify the number of users and/or groups "
185                    "to generate."))
186         sys.exit(1)
187
188     if opts.group_memberships and opts.average_groups_per_user:
189         print_err(("--group-memberships and --average-groups-per-user"
190                    " are incompatible options - use one or the other"))
191         sys.exit(1)
192
193     if not opts.number_of_groups and opts.average_groups_per_user:
194         print_err(("--average-groups-per-user requires "
195                    "--number-of-groups"))
196         sys.exit(1)
197
198     if opts.number_of_groups and opts.average_groups_per_user:
199         if opts.number_of_groups < opts.average_groups_per_user:
200             print_err(("--average-groups-per-user can not be more than "
201                        "--number-of-groups"))
202             sys.exit(1)
203
204     if not opts.number_of_groups and opts.group_memberships:
205         print_err("--group-memberships requires --number-of-groups")
206         sys.exit(1)
207
208     if opts.timing_data not in ('-', None):
209         try:
210             open(opts.timing_data, 'w').close()
211         except IOError as e:
212             print_err(("the supplied timing data destination "
213                        "(%s) is not writable" % opts.timing_data))
214             print_err(e)
215             sys.exit()
216
217     if opts.traffic_summary not in ('-', None):
218         try:
219             open(opts.traffic_summary, 'w').close()
220         except IOError as e:
221             print_err(("the supplied traffic summary destination "
222                        "(%s) is not writable" % opts.traffic_summary))
223             print_err(e)
224             sys.exit()
225
226     traffic.DEBUG_LEVEL = opts.debuglevel
227
228     duration = opts.duration
229     if duration is None:
230         duration = 60.0
231
232     # ingest the model or traffic summary
233     if summary:
234         try:
235             conversations, interval, duration, dns_counts = \
236                                             traffic.ingest_summaries([summary])
237
238             print_err(("Using conversations from the traffic summary "
239                        "file specified"))
240
241             # honour the specified duration if it's different to the
242             # capture duration
243             if opts.duration is not None:
244                 duration = opts.duration
245
246         except ValueError as e:
247             if not e.message.startswith('need more than'):
248                 raise
249
250             model = traffic.TrafficModel()
251
252             try:
253                 model.load(summary)
254             except ValueError:
255                 print_err(("Could not parse %s. The summary file "
256                            "should be the output from either the "
257                            "traffic_summary.pl or "
258                            "traffic_learner scripts."
259                            % summary))
260                 sys.exit()
261
262             print_err(("Using the specified model file to "
263                        "generate conversations"))
264
265             conversations = model.generate_conversations(opts.scale_traffic,
266                                                          duration,
267                                                          opts.replay_rate)
268
269     else:
270         conversations = []
271
272     if opts.debuglevel > 5:
273         for c in conversations:
274             for p in c.packets:
275                 print("    ", p)
276
277         print('=' * 72)
278
279     if opts.number_of_users and opts.number_of_users < len(conversations):
280         print_err(("--number-of-users (%d) is less than the "
281                    "number of conversations to replay (%d)"
282                    % (opts.number_of_users, len(conversations))))
283         sys.exit(1)
284
285     number_of_users = max(opts.number_of_users, len(conversations))
286     max_memberships = number_of_users * opts.number_of_groups
287
288     if not opts.group_memberships and opts.average_groups_per_user:
289         opts.group_memberships = opts.average_groups_per_user * number_of_users
290         print_err(("Using %d group-memberships based on %u average "
291                    "memberships for %d users"
292                    % (opts.group_memberships,
293                       opts.average_groups_per_user, number_of_users)))
294
295     if opts.group_memberships > max_memberships:
296         print_err(("The group memberships specified (%d) exceeds "
297                    "the total users (%d) * total groups (%d)"
298                    % (opts.group_memberships, number_of_users,
299                       opts.number_of_groups)))
300         sys.exit(1)
301
302     try:
303         ldb = traffic.openLdb(host, creds, lp)
304     except:
305         print_err(("\nInitial LDAP connection failed! Did you supply "
306                    "a DNS host name and the correct credentials?"))
307         sys.exit(1)
308
309     if opts.generate_users_only:
310         traffic.generate_users_and_groups(ldb,
311                                           opts.instance_id,
312                                           opts.fixed_password,
313                                           opts.number_of_users,
314                                           opts.number_of_groups,
315                                           opts.group_memberships)
316         sys.exit()
317
318     tempdir = tempfile.mkdtemp(prefix="samba_tg_")
319     print_err("Using temp dir %s" % tempdir)
320
321     traffic.generate_users_and_groups(ldb,
322                                       opts.instance_id,
323                                       opts.fixed_password,
324                                       number_of_users,
325                                       opts.number_of_groups,
326                                       opts.group_memberships)
327
328     accounts = traffic.generate_replay_accounts(ldb,
329                                                 opts.instance_id,
330                                                 len(conversations),
331                                                 opts.fixed_password)
332
333     statsdir = traffic.mk_masked_dir(tempdir, 'stats')
334
335     if opts.traffic_summary:
336         if opts.traffic_summary == '-':
337             summary_dest = sys.stdout
338         else:
339             summary_dest = open(opts.traffic_summary, 'w')
340
341         print_err("Writing traffic summary")
342         summaries = []
343         for c in conversations:
344             summaries += c.replay_as_summary_lines()
345
346         summaries.sort()
347         for (time, line) in summaries:
348             print(line, file=summary_dest)
349
350         exit(0)
351
352     traffic.replay(conversations, host,
353                    lp=lp,
354                    creds=creds,
355                    accounts=accounts,
356                    dns_rate=opts.dns_rate,
357                    duration=duration,
358                    badpassword_frequency=opts.badpassword_frequency,
359                    prefer_kerberos=opts.prefer_kerberos,
360                    statsdir=statsdir,
361                    domain=domain,
362                    base_dn=ldb.domain_dn(),
363                    ou=traffic.ou_name(ldb, opts.instance_id),
364                    tempdir=tempdir,
365                    domain_sid=ldb.get_domain_sid())
366
367     if opts.timing_data == '-':
368         timing_dest = sys.stdout
369     elif opts.timing_data is None:
370         timing_dest = None
371     else:
372         timing_dest = open(opts.timing_data, 'w')
373
374     print_err("Generating statistics")
375     traffic.generate_stats(statsdir, timing_dest)
376
377     if not opts.preserve_tempdir:
378         print_err("Removing temporary directory")
379         shutil.rmtree(tempdir)
380
381
382 main()