rootthebox.py

#!/usr/bin/env python3
"""
    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.
"""
# pylint: disable=unused-wildcard-import,unused-variable


from __future__ import print_function


import os
import sys
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 builtins import str, input
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

    prefix = "https://" if options.ssl else "http://"
    # TODO For docker, it would be nice to grab the mapped docker port
    listenport = C + "%slocalhost:%s" % (prefix, str(options.listen_port)) + W
    sys.stdout.flush()
    try:
        print(INFO + bold + R + "Starting RTB on %s" % listenport, flush=True)
    except:
        print(INFO + bold + R + "Starting RTB on %s" % listenport)

    result = start_server()
    if result == "restart":
        restart()


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 = input(PROMPT + 'Please type "%s": ' % message)
        if resp.replace('"', "").lower().strip() != message.lower():
            os._exit(1)
    else:
        is_devel = options.setup.startswith("docker")
    print(INFO + "%s : Creating the database ..." % current_time())
    from setup.create_database import create_tables, engine, metadata

    create_tables(engine, metadata, options.log_sql)
    sys.stdout.flush()
    print(INFO + "%s : Bootstrapping the database ..." % current_time())
    import setup.bootstrap

    # Display Details
    if is_devel:
        environ = bold + R + "Development bootstrap:"
        details = C + "Admin Username: admin, Password: rootthebox" + W
    else:
        environ = bold + "Production bootstrap" + W
        details = ""
    from handlers import update_db

    update_db(False)
    sys.stdout.flush()
    try:
        print(INFO + "%s %s" % (environ, details), flush=True)
    except:
        print(INFO + "%s %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(xml_params):
    """ 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)


def help():
    help_response = [
        "\tNo options specified. Examples: 'rootthebox.py --setup=prod' or 'rootthebox.py --start'"
    ]
    help_response.append("\t\t--recovery\tstart the recovery console")
    help_response.append("\t\t--restart\trestart the server")
    help_response.append("\t\t--save\t\tsave the current configuration to file")
    help_response.append("\t\t--setup\t\tsetup a database (prod|devel|docker)")
    help_response.append("\t\t--start\t\tstart the server")
    help_response.append("\t\t--update\tpull the latest code via github")
    help_response.append("\t\t--version\tdisplay version information and exit")
    help_response.append("\t\t--xml\t\timport xml file(s)")
    help_response.append(
        "\t\t--config\tconfiguration file location (default: files/rootthebox.cfg)"
    )
    return "\n".join(help_response)


########################################################################
#                          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,
)

define(
    "force_locale",
    default="",
    group="application",
    help="force the application to use this locale instead of the browser's locale.",
)


# ReCAPTCHA
define(
    "use_recaptcha",
    default=False,
    help="enable the use of recaptcha for bank passwords",
    group="recaptcha",
    type=bool,
)

define(
    "recaptcha_site_key",
    default="",
    group="recaptcha",
    help="recaptcha site client api key",
)

define(
    "recaptcha_secret_key",
    default="",
    group="recaptcha",
    help="recaptcha secret server 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(
    "story_signature",
    multiple=True,
    default=[" ", "Good hunting,\n    -Morris"],
    group="game",
    help="the ending at the end of the communication dialog",
    type=game_type,
)

define(
    "story_firstlogin",
    multiple=True,
    default=[
        "Hello [[b;;]$user],\n",
        "I am your new employer. You may call me [[b;;]Morris].",
        " ",
        "I hope you're well rested.  We have a lot of work to do.",
        "I have several assignments which require your... special skill set.",
        " ",
        'You may view your current assignments by selecting \n"Missions" from the Game menu.',
    ],
    group="game",
    help="the dialog displayed at first login",
    type=game_type,
)

define(
    "story_banking",
    multiple=True,
    default=[
        " ",
        "I've taken the liberty of depositing some seed money in your team's bank account.",
        "See that it's put to good use.",
    ],
    group="game",
    help="additional dialog displayed at first login if banking is enabled",
    type=game_type,
)

define(
    "story_bots",
    multiple=True,
    default=[" ", "I will also be glad to rent your botnet for $$reward per bot."],
    group="game",
    help="additional dialog displayed at first login if bots are enabled",
    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("mvp_max", default=10, group="game", help="display the top N players", type=int)

define(
    "scoreboard_right_image",
    default="",
    group="game",
    help="display image to right of scoreboard (can fade with show_mvp)",
    type=game_type,
)

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=10,
    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,
)

define(
    "chat_url",
    default="",
    group="chat",
    help="slack/discord/rocket/... chat url for menu",
    type=game_type,
)

define(
    "rocketchat_admin",
    default="",
    group="chat",
    help="admin username for rocket chat",
    type=game_type,
)

define(
    "rocketchat_password",
    default="",
    group="chat",
    help="admin password for rocket chat",
    type=game_type,
)

# Process modes/flags
define("setup", default="", help="setup a database (prod|devel|docker)")

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.setup.startswith("docker"):
        if not os.path.isfile(options.sql_database + ".db"):
            logging.info("Running Docker Setup")
            options.admin_ips = []  # Remove admin ips due to docker 127.0.0.1 mapping
            options.memcached = "memcache"
            save_config()
            setup()
        else:
            options.parse_config_file(options.config)
        options.start = True
    elif options.save or not os.path.isfile(options.config):
        save_config()
        print(
            INFO
            + bold
            + "If necessary, update the db username and password in 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(help())