├── .gitignore ├── LICENSE ├── README.md ├── __init__.py ├── config.html ├── models.py ├── requirements.txt ├── templates └── containers.html └── utils.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # mypy 101 | .mypy_cache/ 102 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CTFd-Docker 2 | Plugin to give CTFd the ability to manage Docker containers 3 | 4 | This feature was extracted from CTFd and made into a plugin during the development of the plugin architecture. 5 | -------------------------------------------------------------------------------- /__init__.py: -------------------------------------------------------------------------------- 1 | from flask import current_app as app, render_template, request, redirect, jsonify, url_for, Blueprint 2 | from CTFd.utils import admins_only, is_admin, cache 3 | from CTFd.models import db 4 | from .models import Containers 5 | 6 | from . import utils 7 | 8 | def load(app): 9 | app.db.create_all() 10 | admin_containers = Blueprint('admin_containers', __name__, template_folder='templates') 11 | 12 | 13 | @admin_containers.route('/admin/containers', methods=['GET']) 14 | @admins_only 15 | def list_container(): 16 | containers = Containers.query.all() 17 | for c in containers: 18 | c.status = utils.container_status(c.name) 19 | c.ports = ', '.join(utils.container_ports(c.name, verbose=True)) 20 | return render_template('containers.html', containers=containers) 21 | 22 | 23 | @admin_containers.route('/admin/containers//stop', methods=['POST']) 24 | @admins_only 25 | def stop_container(container_id): 26 | container = Containers.query.filter_by(id=container_id).first_or_404() 27 | if utils.container_stop(container.name): 28 | return '1' 29 | else: 30 | return '0' 31 | 32 | 33 | @admin_containers.route('/admin/containers//start', methods=['POST']) 34 | @admins_only 35 | def run_container(container_id): 36 | container = Containers.query.filter_by(id=container_id).first_or_404() 37 | if utils.container_status(container.name) == 'missing': 38 | if utils.run_image(container.name): 39 | return '1' 40 | else: 41 | return '0' 42 | else: 43 | if utils.container_start(container.name): 44 | return '1' 45 | else: 46 | return '0' 47 | 48 | 49 | @admin_containers.route('/admin/containers//delete', methods=['POST']) 50 | @admins_only 51 | def delete_container(container_id): 52 | container = Containers.query.filter_by(id=container_id).first_or_404() 53 | if utils.delete_image(container.name): 54 | db.session.delete(container) 55 | db.session.commit() 56 | db.session.close() 57 | return '1' 58 | 59 | 60 | @admin_containers.route('/admin/containers/new', methods=['POST']) 61 | @admins_only 62 | def new_container(): 63 | name = request.form.get('name') 64 | if not set(name) <= set('abcdefghijklmnopqrstuvwxyz0123456789-_'): 65 | return redirect(url_for('admin_containers.list_container')) 66 | buildfile = request.form.get('buildfile') 67 | files = request.files.getlist('files[]') 68 | utils.create_image(name=name, buildfile=buildfile, files=files) 69 | utils.run_image(name) 70 | return redirect(url_for('admin_containers.list_container')) 71 | 72 | 73 | @admin_containers.route('/admin/containers/import', methods=['POST']) 74 | @admins_only 75 | def import_container(): 76 | name = request.form.get('name') 77 | if not set(name) <= set('abcdefghijklmnopqrstuvwxyz0123456789-_'): 78 | return redirect(url_for('admin_containers.list_container')) 79 | utils.import_image(name=name) 80 | return redirect(url_for('admin_containers.list_container')) 81 | 82 | app.register_blueprint(admin_containers) -------------------------------------------------------------------------------- /config.html: -------------------------------------------------------------------------------- 1 | {% extends "admin/base.html" %} 2 | 3 | {% block content %} 4 | {% endblock %} 5 | 6 | {% block scripts %} 7 | 10 | {% endblock %} -------------------------------------------------------------------------------- /models.py: -------------------------------------------------------------------------------- 1 | from CTFd.models import db 2 | 3 | 4 | class Containers(db.Model): 5 | id = db.Column(db.Integer, primary_key=True) 6 | name = db.Column(db.String(80)) 7 | buildfile = db.Column(db.Text) 8 | 9 | def __init__(self, name, buildfile): 10 | self.name = name 11 | self.buildfile = buildfile 12 | 13 | def __repr__(self): 14 | return "".format(self.id, self.name) -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CTFd/CTFd-Docker/1908cb1467665d1918d164551f1e7a337dd4a8b5/requirements.txt -------------------------------------------------------------------------------- /templates/containers.html: -------------------------------------------------------------------------------- 1 | {% extends "admin/base.html" %} 2 | 3 | {% block content %} 4 | 38 | 39 | 62 | 63 | 64 | 87 | 88 | 89 |
90 |
91 |
92 |

Containers

93 | 96 | 99 |
100 |
101 | {% if containers %} 102 | 103 | 104 | 105 | 107 | 109 | 111 | 113 | 114 | 115 | 116 | {% for c in containers %} 117 | 118 | 119 | 120 | 121 | 131 | 132 | {% endfor %} 133 | 134 |
Status 106 | Name 108 | Ports 110 | Settings 112 |
{{ c.status }}{{ c.name }}{{ c.ports }} 122 | 123 | {% if c.status != 'running' %} 124 | 125 | {% else %} 126 | 127 | {% endif %} 128 | 129 | 130 |
135 | {% endif %} 136 |
137 | {% endblock %} 138 | 139 | {% block scripts %} 140 | 190 | {% endblock %} 191 | -------------------------------------------------------------------------------- /utils.py: -------------------------------------------------------------------------------- 1 | from CTFd.utils import admins_only, is_admin, cache 2 | from CTFd.models import db 3 | from .models import Containers 4 | 5 | import json 6 | import subprocess 7 | import socket 8 | import tempfile 9 | 10 | 11 | @cache.memoize() 12 | def can_create_container(): 13 | try: 14 | subprocess.check_output(['docker', 'version']) 15 | return True 16 | except (subprocess.CalledProcessError, OSError): 17 | return False 18 | 19 | 20 | def import_image(name): 21 | try: 22 | info = json.loads(subprocess.check_output(['docker', 'inspect', '--type=image', name])) 23 | container = Containers(name=name, buildfile=None) 24 | db.session.add(container) 25 | db.session.commit() 26 | db.session.close() 27 | return True 28 | except subprocess.CalledProcessError: 29 | return False 30 | 31 | 32 | def create_image(name, buildfile, files): 33 | if not can_create_container(): 34 | return False 35 | folder = tempfile.mkdtemp(prefix='ctfd') 36 | tmpfile = tempfile.NamedTemporaryFile(dir=folder, delete=False) 37 | tmpfile.write(buildfile) 38 | tmpfile.close() 39 | 40 | for f in files: 41 | if f.filename.strip(): 42 | filename = os.path.basename(f.filename) 43 | f.save(os.path.join(folder, filename)) 44 | # repository name component must match "[a-z0-9](?:-*[a-z0-9])*(?:[._][a-z0-9](?:-*[a-z0-9])*)*" 45 | # docker build -f tmpfile.name -t name 46 | try: 47 | cmd = ['docker', 'build', '-f', tmpfile.name, '-t', name, folder] 48 | print(cmd) 49 | subprocess.call(cmd) 50 | container = Containers(name, buildfile) 51 | db.session.add(container) 52 | db.session.commit() 53 | db.session.close() 54 | rmdir(folder) 55 | return True 56 | except subprocess.CalledProcessError: 57 | return False 58 | 59 | 60 | def is_port_free(port): 61 | s = socket.socket() 62 | result = s.connect_ex(('127.0.0.1', port)) 63 | if result == 0: 64 | s.close() 65 | return False 66 | return True 67 | 68 | 69 | def delete_image(name): 70 | try: 71 | subprocess.call(['docker', 'rm', name]) 72 | subprocess.call(['docker', 'rmi', name]) 73 | return True 74 | except subprocess.CalledProcessError: 75 | return False 76 | 77 | 78 | def run_image(name): 79 | try: 80 | info = json.loads(subprocess.check_output(['docker', 'inspect', '--type=image', name])) 81 | 82 | try: 83 | ports_asked = info[0]['Config']['ExposedPorts'].keys() 84 | ports_asked = [int(re.sub('[A-Za-z/]+', '', port)) for port in ports_asked] 85 | except KeyError: 86 | ports_asked = [] 87 | 88 | cmd = ['docker', 'run', '-d'] 89 | ports_used = [] 90 | for port in ports_asked: 91 | if is_port_free(port): 92 | cmd.append('-p') 93 | cmd.append('{}:{}'.format(port, port)) 94 | else: 95 | cmd.append('-p') 96 | ports_used.append('{}'.format(port)) 97 | cmd += ['--name', name, name] 98 | print(cmd) 99 | subprocess.call(cmd) 100 | return True 101 | except subprocess.CalledProcessError: 102 | return False 103 | 104 | 105 | def container_start(name): 106 | try: 107 | cmd = ['docker', 'start', name] 108 | subprocess.call(cmd) 109 | return True 110 | except subprocess.CalledProcessError: 111 | return False 112 | 113 | 114 | def container_stop(name): 115 | try: 116 | cmd = ['docker', 'stop', name] 117 | subprocess.call(cmd) 118 | return True 119 | except subprocess.CalledProcessError: 120 | return False 121 | 122 | 123 | def container_status(name): 124 | try: 125 | data = json.loads(subprocess.check_output(['docker', 'inspect', '--type=container', name])) 126 | status = data[0]["State"]["Status"] 127 | return status 128 | except subprocess.CalledProcessError: 129 | return 'missing' 130 | 131 | 132 | 133 | def container_ports(name, verbose=False): 134 | try: 135 | info = json.loads(subprocess.check_output(['docker', 'inspect', '--type=container', name])) 136 | if verbose: 137 | ports = info[0]["NetworkSettings"]["Ports"] 138 | if not ports: 139 | return [] 140 | final = [] 141 | for port in ports.keys(): 142 | final.append("".join([ports[port][0]["HostPort"], '->', port])) 143 | return final 144 | else: 145 | ports = info[0]['Config']['ExposedPorts'].keys() 146 | if not ports: 147 | return [] 148 | ports = [int(re.sub('[A-Za-z/]+', '', port)) for port in ports] 149 | return ports 150 | except subprocess.CalledProcessError: 151 | return [] --------------------------------------------------------------------------------