├── .gitignore
├── LICENSE
├── README.md
└── docker_challenges
├── __init__.py
├── assets
├── create.html
├── create.js
├── update.html
├── update.js
├── view.html
└── view.js
├── config.json
├── requirements.txt
└── templates
├── admin_docker_status.html
└── docker_config.html
/.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 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | pip-wheel-metadata/
24 | share/python-wheels/
25 | *.egg-info/
26 | .installed.cfg
27 | *.egg
28 | MANIFEST
29 |
30 | # PyInstaller
31 | # Usually these files are written by a python script from a template
32 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
33 | *.manifest
34 | *.spec
35 |
36 | # Installer logs
37 | pip-log.txt
38 | pip-delete-this-directory.txt
39 |
40 | # Unit test / coverage reports
41 | htmlcov/
42 | .tox/
43 | .nox/
44 | .coverage
45 | .coverage.*
46 | .cache
47 | nosetests.xml
48 | coverage.xml
49 | *.cover
50 | *.py,cover
51 | .hypothesis/
52 | .pytest_cache/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | target/
76 |
77 | # Jupyter Notebook
78 | .ipynb_checkpoints
79 |
80 | # IPython
81 | profile_default/
82 | ipython_config.py
83 |
84 | # pyenv
85 | .python-version
86 |
87 | # pipenv
88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
91 | # install all needed dependencies.
92 | #Pipfile.lock
93 |
94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95 | __pypackages__/
96 |
97 | # Celery stuff
98 | celerybeat-schedule
99 | celerybeat.pid
100 |
101 | # SageMath parsed files
102 | *.sage.py
103 |
104 | # Environments
105 | .env
106 | .venv
107 | env/
108 | venv/
109 | ENV/
110 | env.bak/
111 | venv.bak/
112 |
113 | # Spyder project settings
114 | .spyderproject
115 | .spyproject
116 |
117 | # Rope project settings
118 | .ropeproject
119 |
120 | # mkdocs documentation
121 | /site
122 |
123 | # mypy
124 | .mypy_cache/
125 | .dmypy.json
126 | dmypy.json
127 |
128 | # Pyre type checker
129 | .pyre/
130 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # CTFd Docker Plugin
2 | This plugin for CTFd will allow your competing teams/users to start dockerized images for presented challenges. It adds a challenge type "docker" that can be assigned a specific docker image/tag. A few notable requirements:
3 |
4 | * Docker Config must be set first. You can access this via `/admin/docker_config`. Currently supported config is pure http (no encryption/authentication) or full TLS with client certificate validation. Configuration information for TLS can be found here: https://docs.docker.com/engine/security/https/
5 | * This plugin is written so that challenges are stored by tags. For example, StormCTF stores all docker challenges for InfoSeCon2019 in the `stormctf/infosecon2019` repository. A challenge example would be `stormctf/infosecon2019:arbit`. This is how you would call the challenge when creating a new challenge.
6 |
7 |
8 | ## Important Notes
9 |
10 | * It is unknown if using the same tag twice will cause issues. This plugin was written to avoid this issue, but it has not been fully tested.
11 | * As with all plugins, please security test your Scoreboard before launching the CTF. This plugin has been tested and vetted in the StormCTF environment, but yours may vary.
12 | * This version of the plugin is modified for CTFd version 3.7. Tested on Version 3.7.7
13 |
14 | *Requires flask_wtf*
15 | `pip install flask_wtf`
16 |
17 | ## Features
18 |
19 | * Allows players to spawn their own docker container for docker challenges.
20 | * 5 minute revert timer.
21 | * 2 hour stale container nuke.
22 | * Status panel for Admins to manage docker containers currently active.
23 | * Support for client side validation TLS docker api connections (HIGHLY RECOMMENDED).
24 | * Docker container kill on solve.
25 | * (Mostly) Seamless integration with CTFd.
26 | * **Untested**: _Should_ be able to seamlessly integrate with other challenge types.
27 |
28 | ## Installation / Configuration
29 |
30 | * Drop the folder `docker_challenges` into `CTFd/CTFd/plugins` (Exactly this name).
31 | * Restart CTFd.
32 | * Navigate to `/admin/docker_config`. Add your configuration information. Click Submit.
33 | * Add your required repositories for this CTF. You can select multiple by holding CTRL when clicking. Click Submit.
34 | * Click Challenges, Select `docker` for challenge type. Create a challenge as normal, but select the correct docker tag for this challenge.
35 | * Double check the front end shows "Start Docker Instance" on the challenge.
36 | * Confirm users are able to start/revert and access docker challenges.
37 | * For web challenges, configure http://host:port in the connection field, this is changed automagically when the docker is started
38 | * Host an awesome CTF!
39 |
40 | ### Update: 20210206
41 | Works with 3.2.1
42 |
43 | * Updated the entire plugin to work with the new CTFd.
44 |
45 | ### Update: 20250507
46 | Works with 3.7.7 and added features:
47 | * Proper check for duplicate containers, a user can run only one at a time.
48 | * Added stop container function.
49 | * Enhanced the Status panel for Admins.
50 | * Some GUI enhancements
51 | * Improved error handling
52 |
53 | #### Credits
54 |
55 | * https://github.com/offsecginger (Twitter: @offsec_ginger)
56 | * Jaime Geiger (For Original Plugin assistance) (Twitter: @jgeigerm)
57 |
--------------------------------------------------------------------------------
/docker_challenges/__init__.py:
--------------------------------------------------------------------------------
1 | import traceback
2 |
3 | from CTFd.plugins.challenges import BaseChallenge, CHALLENGE_CLASSES, get_chal_class
4 | from CTFd.plugins.flags import get_flag_class
5 | from CTFd.utils.user import get_ip
6 | from CTFd.utils.uploads import delete_file
7 | from CTFd.plugins import register_plugin_assets_directory, bypass_csrf_protection
8 | from CTFd.schemas.tags import TagSchema
9 | from CTFd.models import db, ma, Challenges, Teams, Users, Solves, Fails, Flags, Files, Hints, Tags, ChallengeFiles
10 | from CTFd.utils.decorators import admins_only, authed_only, during_ctf_time_only, require_verified_emails
11 | from CTFd.utils.decorators.visibility import check_challenge_visibility, check_score_visibility
12 | from CTFd.utils.user import get_current_team
13 | from CTFd.utils.user import get_current_user
14 | from CTFd.utils.user import is_admin, authed
15 | from CTFd.utils.config import is_teams_mode
16 | from CTFd.api import CTFd_API_v1
17 | from CTFd.api.v1.scoreboard import ScoreboardDetail
18 | import CTFd.utils.scores
19 | from CTFd.api.v1.challenges import ChallengeList, Challenge
20 | from flask_restx import Namespace, Resource
21 | from flask import request, Blueprint, jsonify, abort, render_template, url_for, redirect, session
22 | # from flask_wtf import FlaskForm
23 | from wtforms import (
24 | FileField,
25 | HiddenField,
26 | PasswordField,
27 | RadioField,
28 | SelectField,
29 | StringField,
30 | TextAreaField,
31 | SelectMultipleField,
32 | BooleanField,
33 | )
34 | # from wtforms import TextField, SubmitField, BooleanField, HiddenField, FileField, SelectMultipleField
35 | from wtforms.validators import DataRequired, ValidationError, InputRequired
36 | from werkzeug.utils import secure_filename
37 | import requests
38 | import tempfile
39 | from CTFd.utils.dates import unix_time
40 | from datetime import datetime
41 | import json
42 | import hashlib
43 | import random
44 | from CTFd.plugins import register_admin_plugin_menu_bar
45 |
46 | from CTFd.forms import BaseForm
47 | from CTFd.forms.fields import SubmitField
48 | from CTFd.utils.config import get_themes
49 |
50 | from pathlib import Path
51 |
52 |
53 | class DockerConfig(db.Model):
54 | """
55 | Docker Config Model. This model stores the config for docker API connections.
56 | """
57 | id = db.Column(db.Integer, primary_key=True)
58 | hostname = db.Column("hostname", db.String(64), index=True)
59 | tls_enabled = db.Column("tls_enabled", db.Boolean, default=False, index=True)
60 | ca_cert = db.Column("ca_cert", db.String(2200), index=True)
61 | client_cert = db.Column("client_cert", db.String(2000), index=True)
62 | client_key = db.Column("client_key", db.String(3300), index=True)
63 | repositories = db.Column("repositories", db.String(1024), index=True)
64 |
65 |
66 | class DockerChallengeTracker(db.Model):
67 | """
68 | Docker Container Tracker. This model stores the users/teams active docker containers.
69 | """
70 | id = db.Column(db.Integer, primary_key=True)
71 | team_id = db.Column("team_id", db.String(64), index=True)
72 | user_id = db.Column("user_id", db.String(64), index=True)
73 | docker_image = db.Column("docker_image", db.String(64), index=True)
74 | timestamp = db.Column("timestamp", db.Integer, index=True)
75 | revert_time = db.Column("revert_time", db.Integer, index=True)
76 | instance_id = db.Column("instance_id", db.String(128), index=True)
77 | ports = db.Column('ports', db.String(128), index=True)
78 | host = db.Column('host', db.String(128), index=True)
79 | challenge = db.Column('challenge', db.String(256), index=True)
80 |
81 | class DockerConfigForm(BaseForm):
82 | id = HiddenField()
83 | hostname = StringField(
84 | "Docker Hostname", description="The Hostname/IP and Port of your Docker Server"
85 | )
86 | tls_enabled = RadioField('TLS Enabled?')
87 | ca_cert = FileField('CA Cert')
88 | client_cert = FileField('Client Cert')
89 | client_key = FileField('Client Key')
90 | repositories = SelectMultipleField('Repositories')
91 | submit = SubmitField('Submit')
92 |
93 |
94 | def define_docker_admin(app):
95 | admin_docker_config = Blueprint('admin_docker_config', __name__, template_folder='templates',
96 | static_folder='assets')
97 |
98 | @admin_docker_config.route("/admin/docker_config", methods=["GET", "POST"])
99 | @admins_only
100 | def docker_config():
101 | docker = DockerConfig.query.filter_by(id=1).first()
102 | form = DockerConfigForm()
103 | if request.method == "POST":
104 | if docker:
105 | b = docker
106 | else:
107 | b = DockerConfig()
108 | try:
109 | ca_cert = request.files['ca_cert'].stream.read()
110 | except:
111 | traceback.print_exc()
112 | ca_cert = ''
113 | try:
114 | client_cert = request.files['client_cert'].stream.read()
115 | except:
116 | traceback.print_exc()
117 | client_cert = ''
118 | try:
119 | client_key = request.files['client_key'].stream.read()
120 | except:
121 | traceback.print_exc()
122 | client_key = ''
123 | if len(ca_cert) != 0: b.ca_cert = ca_cert
124 | if len(client_cert) != 0: b.client_cert = client_cert
125 | if len(client_key) != 0: b.client_key = client_key
126 | b.hostname = request.form['hostname']
127 | b.tls_enabled = request.form['tls_enabled']
128 | if b.tls_enabled == "True":
129 | b.tls_enabled = True
130 | else:
131 | b.tls_enabled = False
132 | if not b.tls_enabled:
133 | b.ca_cert = None
134 | b.client_cert = None
135 | b.client_key = None
136 | try:
137 | b.repositories = ','.join(request.form.to_dict(flat=False)['repositories'])
138 | except:
139 | traceback.print_exc()
140 | b.repositories = None
141 | db.session.add(b)
142 | db.session.commit()
143 | docker = DockerConfig.query.filter_by(id=1).first()
144 | try:
145 | repos = get_repositories(docker)
146 | except:
147 | traceback.print_exc()
148 | repos = list()
149 | if len(repos) == 0:
150 | form.repositories.choices = [("ERROR", "Failed to Connect to Docker")]
151 | else:
152 | form.repositories.choices = [(d, d) for d in repos]
153 | dconfig = DockerConfig.query.first()
154 | try:
155 | selected_repos = dconfig.repositories
156 | if selected_repos == None:
157 | selected_repos = list()
158 | # selected_repos = dconfig.repositories.split(',')
159 | except:
160 | traceback.print_exc()
161 | selected_repos = []
162 | return render_template("docker_config.html", config=dconfig, form=form, repos=selected_repos)
163 |
164 | app.register_blueprint(admin_docker_config)
165 |
166 |
167 | def define_docker_status(app):
168 | admin_docker_status = Blueprint('admin_docker_status', __name__, template_folder='templates',
169 | static_folder='assets')
170 |
171 | @admin_docker_status.route("/admin/docker_status", methods=["GET", "POST"])
172 | @admins_only
173 | def docker_admin():
174 | docker_config = DockerConfig.query.filter_by(id=1).first()
175 | docker_tracker = DockerChallengeTracker.query.all()
176 | for i in docker_tracker:
177 | if is_teams_mode():
178 | name = Teams.query.filter_by(id=i.team_id).first()
179 | i.team_id = name.name
180 | else:
181 | name = Users.query.filter_by(id=i.user_id).first()
182 | i.user_id = name.name
183 | return render_template("admin_docker_status.html", dockers=docker_tracker)
184 |
185 | app.register_blueprint(admin_docker_status)
186 |
187 |
188 | kill_container = Namespace("nuke", description='Endpoint to nuke containers')
189 |
190 |
191 | @kill_container.route("", methods=['POST', 'GET'])
192 | class KillContainerAPI(Resource):
193 | @admins_only
194 | def get(self):
195 | container = request.args.get('container')
196 | full = request.args.get('all')
197 | docker_config = DockerConfig.query.filter_by(id=1).first()
198 | docker_tracker = DockerChallengeTracker.query.all()
199 | if full == "true":
200 | for c in docker_tracker:
201 | delete_container(docker_config, c.instance_id)
202 | DockerChallengeTracker.query.filter_by(instance_id=c.instance_id).delete()
203 | db.session.commit()
204 |
205 | elif container != 'null' and container in [c.instance_id for c in docker_tracker]:
206 | delete_container(docker_config, container)
207 | DockerChallengeTracker.query.filter_by(instance_id=container).delete()
208 | db.session.commit()
209 |
210 | else:
211 | return False
212 | return True
213 |
214 |
215 | def do_request(docker, url, headers=None, method='GET'):
216 | tls = docker.tls_enabled
217 | prefix = 'https' if tls else 'http'
218 | host = docker.hostname
219 | URL_TEMPLATE = '%s://%s' % (prefix, host)
220 | try:
221 | if tls:
222 | cert, verify = get_client_cert(docker)
223 | if (method == 'GET'):
224 | r = requests.get(url=f"%s{url}" % URL_TEMPLATE, cert=cert, verify=verify, headers=headers)
225 | elif (method == 'DELETE'):
226 | r = requests.delete(url=f"%s{url}" % URL_TEMPLATE, cert=cert, verify=verify, headers=headers)
227 | # Clean up the cert files:
228 | for file_path in [*cert, verify]:
229 | if file_path:
230 | Path(file_path).unlink(missing_ok=True)
231 | else:
232 | if (method == 'GET'):
233 | r = requests.get(url=f"%s{url}" % URL_TEMPLATE, headers=headers)
234 | elif (method == 'DELETE'):
235 | r = requests.delete(url=f"%s{url}" % URL_TEMPLATE, headers=headers)
236 | except:
237 | traceback.print_exc()
238 | r = []
239 | return r
240 |
241 |
242 | def get_client_cert(docker):
243 | # this can be done more efficiently, but works for now.
244 | try:
245 | ca = docker.ca_cert
246 | client = docker.client_cert
247 | ckey = docker.client_key
248 | ca_file = tempfile.NamedTemporaryFile(delete=False)
249 | ca_file.write(ca.encode())
250 | ca_file.seek(0)
251 | client_file = tempfile.NamedTemporaryFile(delete=False)
252 | client_file.write(client.encode())
253 | client_file.seek(0)
254 | key_file = tempfile.NamedTemporaryFile(delete=False)
255 | key_file.write(ckey.encode())
256 | key_file.seek(0)
257 | CERT = (client_file.name, key_file.name)
258 | except:
259 | traceback.print_exc()
260 | CERT = None
261 | return CERT, ca_file.name
262 |
263 |
264 | # For the Docker Config Page. Gets the Current Repositories available on the Docker Server.
265 | def get_repositories(docker, tags=False, repos=False):
266 | r = do_request(docker, '/images/json?all=1')
267 | result = list()
268 | for i in r.json():
269 | if not i['RepoTags'] == []:
270 | if not i['RepoTags'][0].split(':')[0] == '':
271 | if repos:
272 | if not i['RepoTags'][0].split(':')[0] in repos:
273 | continue
274 | if not tags:
275 | result.append(i['RepoTags'][0].split(':')[0])
276 | else:
277 | result.append(i['RepoTags'][0])
278 | return list(set(result))
279 |
280 |
281 | def get_unavailable_ports(docker):
282 | r = do_request(docker, '/containers/json?all=1')
283 | result = list()
284 | for i in r.json():
285 | if not i['Ports'] == []:
286 | for p in i['Ports']:
287 | result.append(p['PublicPort'])
288 | return result
289 |
290 |
291 | def get_required_ports(docker, image):
292 | r = do_request(docker, f'/images/{image}/json?all=1')
293 | result = r.json()['Config']['ExposedPorts'].keys()
294 | return result
295 |
296 |
297 | def create_container(docker, image, team, portbl):
298 | tls = docker.tls_enabled
299 | CERT = None
300 | if not tls:
301 | prefix = 'http'
302 | else:
303 | prefix = 'https'
304 | host = docker.hostname
305 | URL_TEMPLATE = '%s://%s' % (prefix, host)
306 | needed_ports = get_required_ports(docker, image)
307 | team = hashlib.md5(team.encode("utf-8")).hexdigest()[:10]
308 | container_name = "%s_%s" % (image.split(':')[1], team)
309 | assigned_ports = dict()
310 | for i in needed_ports:
311 | while True:
312 | assigned_port = random.choice(range(30000, 60000))
313 | if assigned_port not in portbl:
314 | assigned_ports['%s/tcp' % assigned_port] = {}
315 | break
316 | ports = dict()
317 | bindings = dict()
318 | tmp_ports = list(assigned_ports.keys())
319 | for i in needed_ports:
320 | ports[i] = {}
321 | bindings[i] = [{"HostPort": tmp_ports.pop()}]
322 | headers = {'Content-Type': "application/json"}
323 | data = json.dumps({"Image": image, "ExposedPorts": ports, "HostConfig": {"PortBindings": bindings}})
324 | if tls:
325 | cert, verify = get_client_cert(docker)
326 | r = requests.post(url="%s/containers/create?name=%s" % (URL_TEMPLATE, container_name), cert=cert,
327 | verify=verify, data=data, headers=headers)
328 | result = r.json()
329 | s = requests.post(url="%s/containers/%s/start" % (URL_TEMPLATE, result['Id']), cert=cert, verify=verify,
330 | headers=headers)
331 | # Clean up the cert files:
332 | for file_path in [*cert, verify]:
333 | if file_path:
334 | Path(file_path).unlink(missing_ok=True)
335 |
336 | else:
337 | r = requests.post(url="%s/containers/create?name=%s" % (URL_TEMPLATE, container_name),
338 | data=data, headers=headers)
339 | print(r.request.method, r.request.url, r.request.body)
340 | result = r.json()
341 | print(result)
342 | # name conflicts are not handled properly
343 | s = requests.post(url="%s/containers/%s/start" % (URL_TEMPLATE, result['Id']), headers=headers)
344 | return result, data
345 |
346 |
347 | def delete_container(docker, instance_id):
348 | headers = {'Content-Type': "application/json"}
349 | do_request(docker, f'/containers/{instance_id}?force=true', headers=headers, method='DELETE')
350 | return True
351 |
352 |
353 | class DockerChallengeType(BaseChallenge):
354 | id = "docker"
355 | name = "docker"
356 | templates = {
357 | 'create': '/plugins/docker_challenges/assets/create.html',
358 | 'update': '/plugins/docker_challenges/assets/update.html',
359 | 'view': '/plugins/docker_challenges/assets/view.html',
360 | }
361 | scripts = {
362 | 'create': '/plugins/docker_challenges/assets/create.js',
363 | 'update': '/plugins/docker_challenges/assets/update.js',
364 | 'view': '/plugins/docker_challenges/assets/view.js',
365 | }
366 | route = '/plugins/docker_challenges/assets'
367 | blueprint = Blueprint('docker_challenges', __name__, template_folder='templates', static_folder='assets')
368 |
369 | @staticmethod
370 | def update(challenge, request):
371 | """
372 | This method is used to update the information associated with a challenge. This should be kept strictly to the
373 | Challenges table and any child tables.
374 |
375 | :param challenge:
376 | :param request:
377 | :return:
378 | """
379 | data = request.form or request.get_json()
380 | for attr, value in data.items():
381 | setattr(challenge, attr, value)
382 |
383 | db.session.commit()
384 | return challenge
385 |
386 | @staticmethod
387 | def delete(challenge):
388 | """
389 | This method is used to delete the resources used by a challenge.
390 | NOTE: Will need to kill all containers here
391 |
392 | :param challenge:
393 | :return:
394 | """
395 | Fails.query.filter_by(challenge_id=challenge.id).delete()
396 | Solves.query.filter_by(challenge_id=challenge.id).delete()
397 | Flags.query.filter_by(challenge_id=challenge.id).delete()
398 | files = ChallengeFiles.query.filter_by(challenge_id=challenge.id).all()
399 | for f in files:
400 | delete_file(f.id)
401 | ChallengeFiles.query.filter_by(challenge_id=challenge.id).delete()
402 | Tags.query.filter_by(challenge_id=challenge.id).delete()
403 | Hints.query.filter_by(challenge_id=challenge.id).delete()
404 | DockerChallenge.query.filter_by(id=challenge.id).delete()
405 | Challenges.query.filter_by(id=challenge.id).delete()
406 | db.session.commit()
407 |
408 | @staticmethod
409 | def read(challenge):
410 | """
411 | This method is in used to access the data of a challenge in a format processable by the front end.
412 |
413 | :param challenge:
414 | :return: Challenge object, data dictionary to be returned to the user
415 | """
416 | challenge = DockerChallenge.query.filter_by(id=challenge.id).first()
417 | data = {
418 | 'id': challenge.id,
419 | 'name': challenge.name,
420 | 'value': challenge.value,
421 | 'docker_image': challenge.docker_image,
422 | 'description': challenge.description,
423 | 'category': challenge.category,
424 | 'state': challenge.state,
425 | 'max_attempts': challenge.max_attempts,
426 | 'type': challenge.type,
427 | 'type_data': {
428 | 'id': DockerChallengeType.id,
429 | 'name': DockerChallengeType.name,
430 | 'templates': DockerChallengeType.templates,
431 | 'scripts': DockerChallengeType.scripts,
432 | }
433 | }
434 | return data
435 |
436 | @staticmethod
437 | def create(request):
438 | """
439 | This method is used to process the challenge creation request.
440 |
441 | :param request:
442 | :return:
443 | """
444 | data = request.form or request.get_json()
445 | challenge = DockerChallenge(**data)
446 | db.session.add(challenge)
447 | db.session.commit()
448 | return challenge
449 |
450 | @staticmethod
451 | def attempt(challenge, request):
452 | """
453 | This method is used to check whether a given input is right or wrong. It does not make any changes and should
454 | return a boolean for correctness and a string to be shown to the user. It is also in charge of parsing the
455 | user's input from the request itself.
456 |
457 | :param challenge: The Challenge object from the database
458 | :param request: The request the user submitted
459 | :return: (boolean, string)
460 | """
461 |
462 | data = request.form or request.get_json()
463 | print(request.get_json())
464 | print(data)
465 | submission = data["submission"].strip()
466 | flags = Flags.query.filter_by(challenge_id=challenge.id).all()
467 | for flag in flags:
468 | if get_flag_class(flag.type).compare(flag, submission):
469 | return True, "Correct"
470 | return False, "Incorrect"
471 |
472 | @staticmethod
473 | def solve(user, team, challenge, request):
474 | """
475 | This method is used to insert Solves into the database in order to mark a challenge as solved.
476 |
477 | :param team: The Team object from the database
478 | :param chal: The Challenge object from the database
479 | :param request: The request the user submitted
480 | :return:
481 | """
482 | data = request.form or request.get_json()
483 | submission = data["submission"].strip()
484 | docker = DockerConfig.query.filter_by(id=1).first()
485 | try:
486 | if is_teams_mode():
487 | docker_containers = DockerChallengeTracker.query.filter_by(
488 | docker_image=challenge.docker_image).filter_by(team_id=team.id).first()
489 | else:
490 | docker_containers = DockerChallengeTracker.query.filter_by(
491 | docker_image=challenge.docker_image).filter_by(user_id=user.id).first()
492 | delete_container(docker, docker_containers.instance_id)
493 | DockerChallengeTracker.query.filter_by(instance_id=docker_containers.instance_id).delete()
494 | except:
495 | pass
496 | solve = Solves(
497 | user_id=user.id,
498 | team_id=team.id if team else None,
499 | challenge_id=challenge.id,
500 | ip=get_ip(req=request),
501 | provided=submission,
502 | )
503 | db.session.add(solve)
504 | db.session.commit()
505 | # trying if this solces the detached instance error...
506 | #db.session.close()
507 |
508 | @staticmethod
509 | def fail(user, team, challenge, request):
510 | """
511 | This method is used to insert Fails into the database in order to mark an answer incorrect.
512 |
513 | :param team: The Team object from the database
514 | :param chal: The Challenge object from the database
515 | :param request: The request the user submitted
516 | :return:
517 | """
518 | data = request.form or request.get_json()
519 | submission = data["submission"].strip()
520 | wrong = Fails(
521 | user_id=user.id,
522 | team_id=team.id if team else None,
523 | challenge_id=challenge.id,
524 | ip=get_ip(request),
525 | provided=submission,
526 | )
527 | db.session.add(wrong)
528 | db.session.commit()
529 | #db.session.close()
530 |
531 |
532 | class DockerChallenge(Challenges):
533 | __mapper_args__ = {'polymorphic_identity': 'docker'}
534 | id = db.Column(None, db.ForeignKey('challenges.id'), primary_key=True)
535 | docker_image = db.Column(db.String(128), index=True)
536 |
537 |
538 | # API
539 | container_namespace = Namespace("container", description='Endpoint to interact with containers')
540 |
541 |
542 | @container_namespace.route("", methods=['POST', 'GET'])
543 | class ContainerAPI(Resource):
544 | @authed_only
545 | # I wish this was Post... Issues with API/CSRF and whatnot. Open to a Issue solving this.
546 | def get(self):
547 | container = request.args.get('name')
548 | if not container:
549 | return abort(403, "No container specified")
550 | challenge = request.args.get('challenge')
551 | if not challenge:
552 | return abort(403, "No challenge name specified")
553 |
554 | docker = DockerConfig.query.filter_by(id=1).first()
555 | containers = DockerChallengeTracker.query.all()
556 | if container not in get_repositories(docker, tags=True):
557 | return abort(403,f"Container {container} not present in the repository.")
558 | if is_teams_mode():
559 | session = get_current_team()
560 | # First we'll delete all old docker containers (+2 hours)
561 | for i in containers:
562 | if int(session.id) == int(i.team_id) and (unix_time(datetime.utcnow()) - int(i.timestamp)) >= 7200:
563 | delete_container(docker, i.instance_id)
564 | DockerChallengeTracker.query.filter_by(instance_id=i.instance_id).delete()
565 | db.session.commit()
566 | check = DockerChallengeTracker.query.filter_by(team_id=session.id).filter_by(docker_image=container).first()
567 | else:
568 | session = get_current_user()
569 | for i in containers:
570 | if int(session.id) == int(i.user_id) and (unix_time(datetime.utcnow()) - int(i.timestamp)) >= 7200:
571 | delete_container(docker, i.instance_id)
572 | DockerChallengeTracker.query.filter_by(instance_id=i.instance_id).delete()
573 | db.session.commit()
574 | check = DockerChallengeTracker.query.filter_by(user_id=session.id).filter_by(docker_image=container).first()
575 |
576 | # If this container is already created, we don't need another one.
577 | if check != None and not (unix_time(datetime.utcnow()) - int(check.timestamp)) >= 300:
578 | return abort(403,"To prevent abuse, dockers can be reverted and stopped after 5 minutes of creation.")
579 | # Delete when requested
580 | elif check != None and request.args.get('stopcontainer'):
581 | delete_container(docker, check.instance_id)
582 | if is_teams_mode():
583 | DockerChallengeTracker.query.filter_by(team_id=session.id).filter_by(docker_image=container).delete()
584 | else:
585 | DockerChallengeTracker.query.filter_by(user_id=session.id).filter_by(docker_image=container).delete()
586 | db.session.commit()
587 | return {"result": "Container stopped"}
588 | # The exception would be if we are reverting a box. So we'll delete it if it exists and has been around for more than 5 minutes.
589 | elif check != None:
590 | delete_container(docker, check.instance_id)
591 | if is_teams_mode():
592 | DockerChallengeTracker.query.filter_by(team_id=session.id).filter_by(docker_image=container).delete()
593 | else:
594 | DockerChallengeTracker.query.filter_by(user_id=session.id).filter_by(docker_image=container).delete()
595 | db.session.commit()
596 |
597 | # Check if a container is already running for this user. We need to recheck the DB first
598 | containers = DockerChallengeTracker.query.all()
599 | for i in containers:
600 | if int(session.id) == int(i.user_id):
601 | return abort(403,f"Another container is already running for challenge: {i.challenge}. Please stop this first. You can only run one container.")
602 |
603 | portsbl = get_unavailable_ports(docker)
604 | create = create_container(docker, container, session.name, portsbl)
605 | ports = json.loads(create[1])['HostConfig']['PortBindings'].values()
606 | entry = DockerChallengeTracker(
607 | team_id=session.id if is_teams_mode() else None,
608 | user_id=session.id if not is_teams_mode() else None,
609 | docker_image=container,
610 | timestamp=unix_time(datetime.utcnow()),
611 | revert_time=unix_time(datetime.utcnow()) + 300,
612 | instance_id=create[0]['Id'],
613 | ports=','.join([p[0]['HostPort'] for p in ports]),
614 | host=str(docker.hostname).split(':')[0],
615 | challenge=challenge
616 | )
617 | db.session.add(entry)
618 | db.session.commit()
619 | #db.session.close()
620 | return
621 |
622 |
623 | active_docker_namespace = Namespace("docker", description='Endpoint to retrieve User Docker Image Status')
624 |
625 |
626 | @active_docker_namespace.route("", methods=['POST', 'GET'])
627 | class DockerStatus(Resource):
628 | """
629 | The Purpose of this API is to retrieve a public JSON string of all docker containers
630 | in use by the current team/user.
631 | """
632 |
633 | @authed_only
634 | def get(self):
635 | docker = DockerConfig.query.filter_by(id=1).first()
636 | if is_teams_mode():
637 | session = get_current_team()
638 | tracker = DockerChallengeTracker.query.filter_by(team_id=session.id)
639 | else:
640 | session = get_current_user()
641 | tracker = DockerChallengeTracker.query.filter_by(user_id=session.id)
642 | data = list()
643 | for i in tracker:
644 | data.append({
645 | 'id': i.id,
646 | 'team_id': i.team_id,
647 | 'user_id': i.user_id,
648 | 'docker_image': i.docker_image,
649 | 'timestamp': i.timestamp,
650 | 'revert_time': i.revert_time,
651 | 'instance_id': i.instance_id,
652 | 'ports': i.ports.split(','),
653 | 'host': str(docker.hostname).split(':')[0]
654 | })
655 | return {
656 | 'success': True,
657 | 'data': data
658 | }
659 |
660 |
661 | docker_namespace = Namespace("docker", description='Endpoint to retrieve dockerstuff')
662 |
663 |
664 | @docker_namespace.route("", methods=['POST', 'GET'])
665 | class DockerAPI(Resource):
666 | """
667 | This is for creating Docker Challenges. The purpose of this API is to populate the Docker Image Select form
668 | object in the Challenge Creation Screen.
669 | """
670 |
671 | @admins_only
672 | def get(self):
673 | docker = DockerConfig.query.filter_by(id=1).first()
674 | images = get_repositories(docker, tags=True, repos=docker.repositories)
675 | if images:
676 | data = list()
677 | for i in images:
678 | data.append({'name': i})
679 | return {
680 | 'success': True,
681 | 'data': data
682 | }
683 | else:
684 | return {
685 | 'success': False,
686 | 'data': [
687 | {
688 | 'name': 'Error in Docker Config!'
689 | }
690 | ]
691 | }, 400
692 |
693 |
694 |
695 | def load(app):
696 | app.db.create_all()
697 | CHALLENGE_CLASSES['docker'] = DockerChallengeType
698 | @app.template_filter('datetimeformat')
699 | def datetimeformat(value, format='%Y-%m-%d %H:%M:%S'):
700 | return datetime.fromtimestamp(value).strftime(format)
701 | register_plugin_assets_directory(app, base_path='/plugins/docker_challenges/assets')
702 | define_docker_admin(app)
703 | define_docker_status(app)
704 | CTFd_API_v1.add_namespace(docker_namespace, '/docker')
705 | CTFd_API_v1.add_namespace(container_namespace, '/container')
706 | CTFd_API_v1.add_namespace(active_docker_namespace, '/docker_status')
707 | CTFd_API_v1.add_namespace(kill_container, '/nuke')
708 |
--------------------------------------------------------------------------------
/docker_challenges/assets/create.html:
--------------------------------------------------------------------------------
1 | {% extends "admin/challenges/create.html" %}
2 | {% block category %}
3 |