forked from moloch--/RootTheBox
/
rootthebox.py
executable file
·661 lines (538 loc) · 17.1 KB
/
rootthebox.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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
#!/usr/bin/env python
'''
Copyright 2012 Root the Box
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
http://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.
----------------------------------------------------------------------------
This file is the main starting point for the application, based on the
command line arguments it calls various components setup/start/etc.
'''
from __future__ import print_function
import os
import nose
import random
import logging
from datetime import datetime
from tornado.options import define, options
from libs.ConsoleColors import *
from libs.ConfigHelpers import save_config
from setup import __version__
def current_time():
''' Nicely formatted current time as a string '''
return str(datetime.now()).split(' ')[1].split('.')[0]
def start():
''' Update the database schema '''
try:
from handlers import update_db
update_db()
except Exception as error:
logging.error("Error: %s" % error)
if "Can't locate revision identified" not in str(error):
#Skipped if alembic record ahead for branch compatibility
os._exit(1)
''' Starts the application '''
from handlers import start_server
logging.info(INFO + '%s : Starting RTB on port %s' % (current_time(), options.listen_port))
start_server()
def setup():
'''
Creates/bootstraps the database.
If you're a real developer you'll figure out how to remove the
warning yourself. Don't merge any code the removes it.
'''
is_devel = options.setup.startswith('dev')
if is_devel:
print("%sWARNING:%s Setup is in development mode %s" % (
WARN + bold, W, WARN,
))
message = "I know what the fuck I am doing"
resp = raw_input(PROMPT + 'Please type "%s": ' % message)
if resp.replace('"', '').lower().strip() != message.lower():
os._exit(1)
print(INFO + '%s : Creating the database ...' % current_time())
from setup.create_database import create_tables, engine, metadata
create_tables(engine, metadata, is_devel)
print(INFO + '%s : Bootstrapping the database ...' % current_time())
import setup.bootstrap
# Display Details
if is_devel:
environ = bold + R + "Development boot strap" + W
details = ", admin password is 'nimda123'."
else:
environ = bold + "Production boot strap" + W
details = '.'
from handlers import update_db
update_db(False)
print(INFO + '%s completed successfully%s' % (environ, details))
def recovery():
''' Starts the recovery console '''
from setup.recovery import RecoveryConsole
print(INFO + '%s : Starting recovery console ...' % current_time())
console = RecoveryConsole()
try:
console.cmdloop()
except KeyboardInterrupt:
print(INFO + "Have a nice day!")
def setup_xml():
''' Imports XML file(s) '''
from setup.xmlsetup import import_xml
for index, xml_param in enumerate(xml_params):
print(INFO + "Processing %d of %d .xml file(s) ..." % (
index + 1, len(xml_params)
))
import_xml(xml_param)
print(INFO + "%s : Completed processing of all .xml file(s)" % (
current_time()
))
def tests():
''' Creates a temporary sqlite database and runs the unit tests '''
print(INFO + '%s : Running unit tests ...' % current_time())
from tests import setup_database, teardown_database
db_name = 'test-%04s' % random.randint(0, 9999)
setup_database(db_name)
nose.run(module='tests', argv=[os.getcwd() + '/tests'])
teardown_database(db_name)
def restart():
'''
Shutdown the actual process and restart the service.
Useful for rootthebox.cfg changes.
'''
pid = os.getpid()
print(INFO + '%s : Restarting the service (%i)...' % (current_time(), pid))
os.execl('./setup/restart.sh', '')
def update():
''' Update RTB to the latest repository code. '''
os.system("git pull")
def version():
from sqlalchemy import __version__ as orm_version
from tornado import version as tornado_version
print(bold + "Root the Box%s v%s" % (W, __version__))
print(bold + " SQL Alchemy%s v%s" % (W, orm_version))
print(bold + " Torando%s v%s" % (W, tornado_version))
def check_cwd():
''' Checks to make sure the cwd is the application root directory '''
app_root = os.path.dirname(os.path.abspath(__file__))
if app_root != os.getcwd():
print(INFO + "Switching CWD to '%s'" % app_root)
os.chdir(app_root)
########################################################################
# Application Settings
########################################################################
# HTTP Server Settings
define("origin",
default="ws://localhost:8888",
group="server",
help="validate websocket connections against this origin")
define("listen_port",
default=8888,
group="server",
help="run instances starting the given port",
type=int)
define("listen_interface",
default="0.0.0.0",
group="server",
help="attach to which interface. 0.0.0.0 implies all available.")
define("session_age",
default=int(60 * 60),
group="server",
help="max session age (seconds)",
type=int)
define("x_headers",
default=False,
group="server",
help="honor the `X-FORWARDED-FOR` and `X-REAL-IP` http headers",
type=bool)
define("ssl",
default=False,
group="server",
help="enable the use of ssl/tls",
type=bool)
define("certfile",
default="",
group="server",
help="the certificate file path (for ssl/tls)")
define("keyfile",
default="",
group="server",
help="the key file path (for ssl/tls)")
define("admin_ips",
multiple=True,
default=['127.0.0.1', '::1'],
group="server",
help="whitelist of ip addresses that can access the admin ui (use empty list to allow all ip addresses)")
# Application Settings
define("debug",
default=False,
group="application",
help="start the application in debugging mode",
type=bool)
define("autostart_game",
default=False,
group="application",
help="start the game automatically",
type=bool)
define("avatar_dir",
default="./files/avatars",
group="application",
help="the directory to store avatar files")
define("share_dir",
default="./files/shares",
group="application",
help="the directory to store shared files")
define("flag_attachment_dir",
default="./files/flag_attachments",
group="application",
help="the directory to store flag attachment files")
define("source_code_market_dir",
default="./files/source_code_market",
group="application",
help="the directory to store source code market files")
define("game_materials_dir",
default="./files/game_materials",
group="application",
help="the directory to store applications, docs, and other materials for the game")
define("use_box_materials_dir",
default=True,
group="application",
help="show files belonging to a box in the box page",
type=bool)
define("force_download_game_materials",
default=True,
group="application",
help="force the browser to download game materials (instead of just viewing them)",
type=bool)
# ReCAPTCHA
define("use_recaptcha",
default=True,
help="enable the use of recaptcha for bank passwords",
group='recaptcha',
type=bool)
define("recaptcha_api_key",
default="6LcJJ88SAAAAAFzcmQqDPWGKRQXmJ0DCiZoPWTZf",
group='recaptcha',
help="recaptcha api key")
# Database settings
define("sql_dialect",
default="mysql",
group="database",
help="define the type of database (mysql|postgres|sqlite)")
define("sql_database",
default="rootthebox",
group="database",
help="the sql database name")
define("sql_host",
default="127.0.0.1",
group="database",
help="database sever hostname")
define("sql_port",
default=3306,
group="database",
help="database tcp port",
type=int)
define("sql_user",
default="rtb",
group="database",
help="database username")
define("sql_password",
default="rtb",
group="database",
help="database password, if applicable")
define("log_sql",
default=False,
group="database",
help="Log SQL queries for debugging")
# Memcached settings
define("memcached",
default="127.0.0.1",
group="cache",
help="memcached sever hostname")
define("memcached_port",
default=11011,
group="cache",
help="memcached tcp port",
type=int)
# Game Settings
try:
# python2
game_type = basestring
except NameError:
# python 3
game_type = str
define("game_name",
default="Root the Box",
group="game",
help="the name of the current game",
type=game_type)
define("ctf_logo",
default="/static/images/rtb2.png",
group="game",
help="the image displayed on the welcome page",
type=game_type)
define("ctf_tagline",
default="A Game of Hackers",
group="game",
help="the tagline displayed on the welcome page",
type=game_type)
define("org_footer",
default="",
group="game",
help="Organization footer - righthand text / html",
type=game_type)
define("story_character",
default="/static/images/morris.jpg",
group="game",
help="the character image displayed on the communication dialog",
type=game_type)
define("chat_url",
default="",
group="game",
help="slack/discord/... chat url for menu",
type=game_type)
define("restrict_registration",
default=False,
group="game",
help="require registration tokens",
type=bool)
define("require_email",
default=True,
group="game",
help="require email for registration",
type=bool)
define("public_teams",
default=True,
group="game",
help="allow anyone to create a new team",
type=bool)
define("show_mvp",
default=True,
group="game",
help="display the mvp list on scoreboard",
type=bool)
define("show_captured_flag",
default=False,
group="game",
help="allow player to see the flag token after capture",
type=bool)
define("hints_taken",
default=False,
group="game",
help="display number of hints taken on scoreboard",
type=bool)
define("global_notification",
default=False,
group="game",
help="notify all players of flag captures and level unlocks",
type=bool)
define("teams",
default=True,
group="game",
help="turn off teams - individual playstyle",
type=bool)
define("max_team_size",
default=4,
group="game",
help="max number of players on any one team",
type=int)
define("team_sharing",
default=True,
group="game",
help="team sharing - pastebin and file share",
type=bool)
define("min_user_password_length",
default=12,
group="game",
help="min user password length",
type=int)
define("banking",
default=False,
group="game",
help="turn off bank scoring - point scoreboard",
type=bool)
define("max_password_length",
default=7,
group="game",
help="max bank password length",
type=int)
define("use_bots",
default=False,
group="game",
help="enable the use of botnets",
type=bool)
define("botnet_db",
default="files/botnet.db",
group="game",
help="botnet database path")
define("bot_reward",
default=50,
group="game",
help="the reward per-interval for a single bot",
type=int)
define("use_black_market",
default=False,
group="game",
help="enable the use of the black market",
type=bool)
define("password_upgrade_cost",
default=1000,
group="game",
help="price to upgrade a password hash algorithm",
type=int)
define("bribe_cost",
default=2500,
group="game",
help="the base bribe cost to swat another player",
type=int)
define("starting_team_money",
default=500,
group="game",
help="the starting money for a new team when using banking",
type=int)
define("whitelist_box_ips",
default=False,
group="game",
help="whitelist box ip addresses (for botnets)",
type=bool)
define("story_mode",
default=False,
group="game",
help="Morris story with secure communique dialog screen after capture success",
type=bool)
define("scoreboard_visibility",
default="public",
group="game",
help="Visibility of the Scoreboard - public, players, admins",
type=game_type)
define("dynamic_flag_value",
default=False,
group="game",
help="decrease reward for flags based on captures",
type=bool)
define("max_flag_attempts",
default=100,
group="game",
help="limits the number of attempts to capture a flag",
type=int)
define("flag_value_decrease",
default=10,
group="game",
help="decrease flag reward by this percent per capture",
type=int)
define("penalize_flag_value",
default=False,
group="game",
help="penalize score for incorrect capture attempts",
type=bool)
define("flag_penalty_cost",
default=20,
group="game",
help="penalty as a percentage of flag value",
type=int)
define("flag_start_penalty",
default=2,
group="game",
help="when to start - 1 = incorrect first attempt, 2 = second attempt, etc",
type=int)
define("flag_stop_penalty",
default=5,
group="game",
help="when to stop - 4 = incorrect forth attempt, 5 = fifth attempt, etc",
type=int)
define("default_theme",
default="Cyborg",
group="game",
help="the default css theme")
define("allow_user_to_change_theme",
default=True,
group="game",
type=bool,
help="Is the user allowed to change theme")
define("rank_by",
default="money",
group="game",
help="rank teams by (flags or money)")
define("max_pastebin_size",
default=4096,
group="game",
help="Pastebin Character limit")
# I/O Loop Settings
define("history_snapshot_interval",
default=int(60000 * 5),
group="game",
help="interval to create history snapshots (milliseconds)",
type=int)
define("bot_reward_interval",
default=int(60000 * 15),
group="game",
help="interval for rewarding botnets (milliseconds)",
type=int)
# Process modes/flags
define("setup",
default="",
help="setup a database (prod|devel)")
define("xml",
multiple=True,
default=[],
help="import xml file(s)")
define("recovery",
default=False,
help="start the recovery console",
type=bool)
define("start",
default=False,
help="start the server",
type=bool)
define("restart",
default=False,
help="restart the server",
type=bool)
define("update",
default=False,
help="pull the latest code via github",
type=bool)
define("version",
default=False,
help="display version information and exit",
type=bool)
define("save",
default=False,
help="save the current configuration to file",
type=bool)
define("config",
default="files/rootthebox.cfg",
help="root the box configuration file")
if __name__ == '__main__':
# We need this to pull the --config option
options.parse_command_line()
check_cwd()
if options.version:
version()
elif options.save or not os.path.isfile(options.config):
save_config()
logging.info("Please add the db username and password to the cfg and set any advanced configuration options.")
os._exit(1)
else:
logging.debug("Parsing config file `%s`" % (
os.path.abspath(options.config),
))
options.parse_config_file(options.config)
# Make sure that cli args always have president over the file
options.parse_command_line()
if options.setup.lower()[:3] in ['pro', 'dev']:
setup()
elif options.start:
start()
elif options.restart:
restart()
elif options.recovery:
recovery()
elif options.update:
update()
else:
print("\tNo options specified. Examples: 'rootthebox.py --setup=prod' or 'rootthebox.py --start'")