diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a318744 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Gradle +.gradle +gradle** +# Eclipse, Idea, ... +.settings +.idea +bin +build +doc diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..826fb36 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +All notable changes to this project will are documented in this changelog file. + +## [1.0.0] - 2022-01-01 +### Added +- common functionality +- server and client implementation +- 7 basic challenges + - Buffer Over-read (simulated) + - Command Execution + - SQL Injection + - Enumeration + - XML + - Horizontal Access Control + - Vertical Access Control \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/README.md b/README.md new file mode 100644 index 0000000..534721c --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# ![Vulnerable Client-Server Application (VuCSA)](http://vucsa.warxim.com/img/logo.png) +# Vulnerable Client-Server Application (VuCSA) +Vulnerable client-server application (VuCSA) is made for learning/presenting how to perform penetration tests of non-http thick clients. +It is written in Java (with JavaFX graphical user interface). + +Currently the vulnerable application contains the following challenges: +1. Buffer Over-read (simulated) +2. Command Execution +3. SQL Injection +4. Enumeration +5. XML +6. Horizontal Access Control +7. Vertical Access Control + +If you want to know how to solve these challenges, take a look at the [PETEP website](http://petep.warxim.com/methodology/), +which describes how to use the open-source tool PETEP to exploit them. + +**Tip:** Before you start hacking, do not forget to check the data structure of messages bellow. + +## How to Run +In order to run the vulnerable server and client, you can use one of releases on GitHub +or run gradle assemble, which creates distribution packages (for both Windows and Unix). +These packages contain sh/bat scripts that will run the server and client using JVM. + +## Project Structure +Project is divided into three modules: +- **vulnerable-common** - common functionality for both client and server (including protocol processing utilities) +- **vulnerable-client** - vulnerable client with JavaFX GUI +- **vulnerable-server** - vulnerable server for terminal use + +## Data Structure +Messages transmitted between server and client have the following simple format: + + [type][target][length][payload] + 32b 32b 32b ??? + +These four parts have the following meaning: +- **type** - type of the message (used for serialization/deserialization) +- **target** - target handler that will receive the message +- **length** - length of the payload +- **payload** - data serialized into bytes diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..b7e2185 --- /dev/null +++ b/build.gradle @@ -0,0 +1,42 @@ +plugins { + id 'java' + id 'application' +} + +group 'com.warxim' +version '1.0' + +repositories { + mavenCentral() +} + +dependencies { + compile project(":vucsa-common") + compile project(":vucsa-client") + compile project(":vucsa-server") +} + +distributions { + main { + distributionBaseName = "vucsa" + contents { + from("LICENSE.md") { + into "" + } + + from("CHANGELOG.md") { + into "" + } + + from("scripts") { + into "" + } + + from("vucsa-server/server") { + into "server" + } + + startScripts.onlyIf {false} + } + } +} \ No newline at end of file diff --git a/scripts/client.bat b/scripts/client.bat new file mode 100644 index 0000000..760cf3d --- /dev/null +++ b/scripts/client.bat @@ -0,0 +1,12 @@ +@echo off +set JAVA_EXE=java.exe +set JAVAW_EXE=javaw.exe +set DIRNAME=%~dp0 +set APP_HOME=%DIRNAME% +set CMD_LINE_ARGS=%* +set DEFAULT_JVM_OPTS= +set CLASSPATH=%APP_HOME%\lib\* +set MAIN_CLASS="com.warxim.vucsa.client.Main" + +rem Start Vulnerable Client with GUI (without console). +start "" /b "%JAVAW_EXE%" %DEFAULT_JVM_OPTS% -classpath "%CLASSPATH%" %MAIN_CLASS% %CMD_LINE_ARGS% diff --git a/scripts/client.sh b/scripts/client.sh new file mode 100644 index 0000000..0a1bac4 --- /dev/null +++ b/scripts/client.sh @@ -0,0 +1,11 @@ +#!/bin/bash + +JAVA="java" +APP_HOME="`pwd`" +DEFAULT_JVM_OPTS= +CMD_LINE_ARGS=$@ +CLASSPATH=$APP_HOME/lib/* +MAIN_CLASS="com.warxim.vucsa.client.Main" +LOG_FILE=client.log + +nohup $JAVA -cp "$CLASSPATH" $MAIN_CLASS $CMD_LINE_ARGS > $LOG_FILE & diff --git a/scripts/server.bat b/scripts/server.bat new file mode 100644 index 0000000..5a4ee28 --- /dev/null +++ b/scripts/server.bat @@ -0,0 +1,12 @@ +@echo off +set JAVA_EXE=java.exe +set JAVAW_EXE=javaw.exe +set DIRNAME=%~dp0 +set APP_HOME=%DIRNAME% +set CMD_LINE_ARGS=%* +set DEFAULT_JVM_OPTS= +set CLASSPATH=%APP_HOME%\lib\* +set MAIN_CLASS="com.warxim.vucsa.server.Main" + +rem Start Vulnerable Server without GUI (let console open). +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% -classpath "%CLASSPATH%" %MAIN_CLASS% %CMD_LINE_ARGS% diff --git a/scripts/server.sh b/scripts/server.sh new file mode 100644 index 0000000..1117140 --- /dev/null +++ b/scripts/server.sh @@ -0,0 +1,11 @@ +#!/bin/bash + +JAVA="java" +APP_HOME="`pwd`" +DEFAULT_JVM_OPTS= +CMD_LINE_ARGS=$@ +CLASSPATH=$APP_HOME/lib/* +MAIN_CLASS="com.warxim.vucsa.server.Main" +LOG_FILE=server.log + +$JAVA -cp "$CLASSPATH" $MAIN_CLASS $CMD_LINE_ARGS diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..a180b54 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,6 @@ +rootProject.name = 'VuCSA' + +include 'vucsa-common' +include 'vucsa-client' +include 'vucsa-server' + diff --git a/vucsa-client/build.gradle b/vucsa-client/build.gradle new file mode 100644 index 0000000..8c29067 --- /dev/null +++ b/vucsa-client/build.gradle @@ -0,0 +1,59 @@ +plugins { + id 'java-library' + id 'java' + id 'eclipse' + id 'application' + id 'org.openjfx.javafxplugin' version '0.0.13' +} + +javafx { + version = "11.0.2" + modules = ['javafx.controls', 'javafx.fxml', 'javafx.web'] +} + +group 'com.warxim' +version '1.0' +mainClassName = 'com.warxim.vucsa.client.Main' + +repositories { + mavenCentral() +} + +dependencies { + implementation project(':vucsa-common') + + compileOnly 'org.projectlombok:lombok:1.18.24' + annotationProcessor 'org.projectlombok:lombok:1.18.24' + + implementation group: 'org.openjfx', name: 'javafx-base', version: javafx.version, classifier: 'win' + implementation group: 'org.openjfx', name: 'javafx-base', version: javafx.version, classifier: 'mac' + implementation group: 'org.openjfx', name: 'javafx-base', version: javafx.version, classifier: 'linux' + implementation group: 'org.openjfx', name: 'javafx-controls', version: javafx.version, classifier: 'win' + implementation group: 'org.openjfx', name: 'javafx-controls', version: javafx.version, classifier: 'mac' + implementation group: 'org.openjfx', name: 'javafx-controls', version: javafx.version, classifier: 'linux' + implementation group: 'org.openjfx', name: 'javafx-fxml', version: javafx.version, classifier: 'win' + implementation group: 'org.openjfx', name: 'javafx-fxml', version: javafx.version, classifier: 'mac' + implementation group: 'org.openjfx', name: 'javafx-fxml', version: javafx.version, classifier: 'linux' + implementation group: 'org.openjfx', name: 'javafx-graphics', version: javafx.version, classifier: 'win' + implementation group: 'org.openjfx', name: 'javafx-graphics', version: javafx.version, classifier: 'mac' + implementation group: 'org.openjfx', name: 'javafx-graphics', version: javafx.version, classifier: 'linux' + implementation group: 'org.openjfx', name: 'javafx-media', version: javafx.version, classifier: 'win' + implementation group: 'org.openjfx', name: 'javafx-media', version: javafx.version, classifier: 'mac' + implementation group: 'org.openjfx', name: 'javafx-media', version: javafx.version, classifier: 'linux' + implementation group: 'org.openjfx', name: 'javafx-web', version: javafx.version, classifier: 'win' + implementation group: 'org.openjfx', name: 'javafx-web', version: javafx.version, classifier: 'mac' + implementation group: 'org.openjfx', name: 'javafx-web', version: javafx.version, classifier: 'linux' +} + +// Export com.sun.javafx.css (for css editing) +application { + applicationDefaultJvmArgs = [ + "--add-opens=javafx.graphics/com.sun.javafx.css=ALL-UNNAMED" + ] + executableDir = '' +} + +// Set run working directory to build/run +File runningDir = new File('build/run') +runningDir.mkdirs() +tasks.run.workingDir = runningDir \ No newline at end of file diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/Bundle.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/Bundle.java new file mode 100644 index 0000000..31c234b --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/Bundle.java @@ -0,0 +1,63 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client; + +import com.warxim.vucsa.client.core.ClientManager; +import lombok.Getter; + +/** + * Singleton for client assets. + */ +@Getter +public final class Bundle { + /** + * Singleton instance. + */ + private static volatile Bundle instance; + + /** + * Client manager + */ + private final ClientManager clientManager; + + private Bundle() { + clientManager = new ClientManager(); + } + + /** + * Creates instance of bundle or returns existing instance if it exists. + * @return Bundle instance + */ + public static Bundle getInstance() { + if (instance == null) { + synchronized(Bundle.class) { + if (instance == null) { + instance = new Bundle(); + } + } + } + + return instance; + } + + /** + * Destroys the bundle. + */ + public void destroy() { + // nothing to destroy + } +} \ No newline at end of file diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/Main.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/Main.java new file mode 100644 index 0000000..67f9593 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/Main.java @@ -0,0 +1,49 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client; + +import com.warxim.vucsa.client.gui.GuiApplication; +import com.warxim.vucsa.client.gui.GuiBundle; +import com.warxim.vucsa.client.gui.dialog.Dialogs; +import javafx.application.Application; + +/** + * Main client application class. + */ +public final class Main { + public static void main(String... args) { + init(); + launch(); + } + + /** + * Initializes GUI bundle. + */ + private static void init() { + var guiBundle = GuiBundle.getInstance(); + Dialogs.setDefaultIcon(guiBundle.getLogo()); + } + + /** + * Launches GUI application. + */ + private static void launch() { + Application.launch(GuiApplication.class); + } + + private Main() {} +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/ChallengeController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/ChallengeController.java new file mode 100644 index 0000000..aacbb9c --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/ChallengeController.java @@ -0,0 +1,35 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.common.message.Message; + +/** + * Base class of challenge controllers. + */ +public abstract class ChallengeController { + /** + * Sends message using client manager. + * @param message Message to be sent + * @return {@code true} if the message has been successfully sent + */ + protected boolean sendMessage(Message message) { + var clientManager = Bundle.getInstance().getClientManager(); + return clientManager.sendMessage(message); + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/ChallengeWrapper.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/ChallengeWrapper.java new file mode 100644 index 0000000..0ef3c69 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/ChallengeWrapper.java @@ -0,0 +1,39 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge; + +import com.warxim.vucsa.common.connection.listener.ConnectionListener; +import javafx.scene.Node; +import lombok.Builder; +import lombok.Value; + +/** + * Wrapper for keeping JavaFX node and controller of a challenge. + */ +@Value +@Builder +public class ChallengeWrapper implements ConnectionListener { + /** + * Challenge node, which is displayed in the tab. + */ + Node node; + + /** + * Controller for controlling the challenge GUI. + */ + ChallengeController controller; +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/bufferoverread/BufferOverreadController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/bufferoverread/BufferOverreadController.java new file mode 100644 index 0000000..5696e7e --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/bufferoverread/BufferOverreadController.java @@ -0,0 +1,131 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.bufferoverread; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.challenge.ChallengeController; +import com.warxim.vucsa.client.gui.dialog.Dialogs; +import com.warxim.vucsa.common.ChallengeConstant; +import com.warxim.vucsa.common.message.bufferoverread.StringListMessage; +import javafx.application.Platform; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.ContextMenu; +import javafx.scene.control.ListView; +import javafx.scene.control.MenuItem; + +import java.net.URL; +import java.util.List; +import java.util.ResourceBundle; + +/** + * Buffer over-read controller handles buffer over-read challenge, which uses simple echo with transformation of input + * to simulate buffer over-read vulnerability. + */ +public class BufferOverreadController extends ChallengeController implements Initializable { + private final BufferOverreadHandler handler = new BufferOverreadHandler(this); + + @FXML + private ListView requestInput; + @FXML + private ListView responseInput; + + @Override + public void initialize(URL location, ResourceBundle resources) { + initHandler(); + initDefaultItems(); + initContextMenu(); + } + + /** + * Sets items to the input component. + * @param items Items to be set + */ + public void setItems(List items) { + Platform.runLater(() -> responseInput.getItems().setAll(items)); + } + + /** + * Sends items to server. + */ + @FXML + private void onSendClick(ActionEvent event) { + var items = requestInput.getItems(); + var message = StringListMessage.builder() + .target(ChallengeConstant.BUFFER_OVERREAD_TARGET) + .items(items) + .build(); + sendMessage(message); + } + + /** + * Adds new item. + */ + @FXML + private void onAddItemClick(ActionEvent event) { + var maybeValue = Dialogs.createTextInputDialog("Add Item", "Value"); + if (maybeValue.isEmpty()) { + return; + } + requestInput.getItems().add(maybeValue.get()); + } + + /** + * Removes existing item. + */ + @FXML + private void onRemoveItemClick(ActionEvent event) { + var selected = requestInput.getSelectionModel().getSelectedIndex(); + if (selected < 0) { + return; + } + + requestInput.getItems().remove(selected); + } + + /** + * Initializes buffer over-read message handler. + */ + private void initHandler() { + Bundle.getInstance().getClientManager().registerHandler(ChallengeConstant.BUFFER_OVERREAD_TARGET, handler); + } + + /** + * Initializes default items in the challenge GUI. + */ + private void initDefaultItems() { + requestInput.getItems().add("Item 1"); + requestInput.getItems().add("Item 2"); + requestInput.getItems().add("Item 3"); + } + + /** + * Initializes context menu of request input. + */ + private void initContextMenu() { + var menu = new ContextMenu(); + var addItem = new MenuItem("Add"); + addItem.setOnAction(this::onAddItemClick); + var removeItem = new MenuItem("Remove"); + removeItem.setOnAction(this::onRemoveItemClick); + + menu.getItems().add(addItem); + menu.getItems().add(removeItem); + requestInput.setContextMenu(menu); + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/bufferoverread/BufferOverreadHandler.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/bufferoverread/BufferOverreadHandler.java new file mode 100644 index 0000000..96e523d --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/bufferoverread/BufferOverreadHandler.java @@ -0,0 +1,42 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.bufferoverread; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.bufferoverread.StringListMessage; +import lombok.RequiredArgsConstructor; + +/** + * Handler for handling messages for buffer over-read challenge. + */ +@RequiredArgsConstructor +public class BufferOverreadHandler implements MessageHandler { + private final BufferOverreadController controller; + + @Override + public boolean supports(Message message) { + return message instanceof StringListMessage; + } + + @Override + public boolean handleMessage(Connection connection, Message message) { + controller.setItems(((StringListMessage) message).getItems()); + return true; + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/commandexecution/CommandExecutionController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/commandexecution/CommandExecutionController.java new file mode 100644 index 0000000..3abc517 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/commandexecution/CommandExecutionController.java @@ -0,0 +1,89 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.commandexecution; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.challenge.ChallengeController; +import com.warxim.vucsa.common.ChallengeConstant; +import com.warxim.vucsa.common.message.commandexecution.request.PingRequest; +import javafx.application.Platform; +import javafx.beans.value.ObservableValue; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.TextArea; +import javafx.scene.control.TextField; + +import java.net.URL; +import java.util.ResourceBundle; + +/** + * Command execution controller handles command execution challenge. + *

Requests server to do PING command and shows output.

+ */ +public class CommandExecutionController extends ChallengeController implements Initializable { + private final CommandExecutionHandler handler = new CommandExecutionHandler(this); + + @FXML + private TextField hostInput; + @FXML + private TextArea resultOutput; + + @Override + public void initialize(URL location, ResourceBundle resources) { + initHandler(); + hostInput.textProperty().addListener(this::onHostInputChange); + } + /** + * Sets output to the text area. + * @param output Output to be set + */ + public void setOutput(String output) { + Platform.runLater(() -> resultOutput.setText(output)); + } + + /** + * Sends ping request to server. + */ + @FXML + private void onPingClick(ActionEvent event) { + var message = PingRequest.builder() + .target(ChallengeConstant.COMMAND_EXECUTION_TARGET) + .host(hostInput.getText()) + .build(); + sendMessage(message); + } + + /** + * Initializes command execution message handler. + */ + private void initHandler() { + Bundle.getInstance().getClientManager().registerHandler(ChallengeConstant.COMMAND_EXECUTION_TARGET, handler); + } + + /** + * Removes invalid characters from host input on change. + */ + private void onHostInputChange( + ObservableValue observable, + String oldValue, + String newValue) { + if (!newValue.matches("0-9a-zA-Z\\.-")) { + hostInput.setText(newValue.replaceAll("[^0-9a-zA-Z.-]", "")); + } + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/commandexecution/CommandExecutionHandler.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/commandexecution/CommandExecutionHandler.java new file mode 100644 index 0000000..260a0d2 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/commandexecution/CommandExecutionHandler.java @@ -0,0 +1,39 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.commandexecution; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.commandexecution.response.PingResponse; +import lombok.RequiredArgsConstructor; + +@RequiredArgsConstructor +public class CommandExecutionHandler implements MessageHandler { + private final CommandExecutionController controller; + + @Override + public boolean supports(Message message) { + return message instanceof PingResponse; + } + + @Override + public boolean handleMessage(Connection connection, Message message) { + controller.setOutput(((PingResponse) message).getOutput()); + return true; + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/enumeration/EnumerationController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/enumeration/EnumerationController.java new file mode 100644 index 0000000..7a963df --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/enumeration/EnumerationController.java @@ -0,0 +1,94 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.enumeration; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.challenge.ChallengeController; +import com.warxim.vucsa.common.ChallengeConstant; +import com.warxim.vucsa.common.message.enumeration.LoginStatus; +import com.warxim.vucsa.common.message.enumeration.request.LoginRequest; +import javafx.application.Platform; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.Label; +import javafx.scene.control.PasswordField; +import javafx.scene.control.TextField; + +import java.net.URL; +import java.util.ResourceBundle; + +/** + * Enumeration controller handles enumeration challenge. + *

Simulates user login and displays result.

+ */ +public class EnumerationController extends ChallengeController implements Initializable { + private final EnumerationHandler handler = new EnumerationHandler(this); + + @FXML + private TextField usernameInput; + @FXML + private PasswordField passwordInput; + @FXML + private Label resultLabel; + + @Override + public void initialize(URL location, ResourceBundle resources) { + initHandler(); + } + + /** + * Sets login result to the GUI. + * @param status Login status + * @param userSecret Secret of logged user + */ + public void setResult(LoginStatus status, String userSecret) { + Platform.runLater(() -> { + switch (status) { + case SUCCESS: + resultLabel.setText("Successfully logged in! Your secret is: \"" + userSecret + "\""); + break; + case WRONG_USERNAME: + resultLabel.setText("Wrong username!"); + break; + case WRONG_PASSWORD: + resultLabel.setText("Wrong password!"); + break; + } + }); + } + + /** + * Sends login request to the server. + */ + @FXML + private void onLoginClick(ActionEvent event) { + var message = LoginRequest.builder() + .target(ChallengeConstant.ENUMERATION_TARGET) + .username(usernameInput.getText()) + .password(passwordInput.getText()) + .build(); + sendMessage(message); + } + + /** + * Initializes enumeration message handler. + */ + private void initHandler() { + Bundle.getInstance().getClientManager().registerHandler(ChallengeConstant.ENUMERATION_TARGET, handler); + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/enumeration/EnumerationHandler.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/enumeration/EnumerationHandler.java new file mode 100644 index 0000000..fc4a0d0 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/enumeration/EnumerationHandler.java @@ -0,0 +1,43 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.enumeration; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.enumeration.response.LoginResponse; +import lombok.RequiredArgsConstructor; + +/** + * Handler for login response messages for enumeration challenge. + */ +@RequiredArgsConstructor +public class EnumerationHandler implements MessageHandler { + private final EnumerationController controller; + + @Override + public boolean supports(Message message) { + return message instanceof LoginResponse; + } + + @Override + public boolean handleMessage(Connection connection, Message message) { + var loginResponse = ((LoginResponse) message); + controller.setResult(loginResponse.getStatus(), loginResponse.getUserSecret()); + return true; + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/DocumentItem.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/DocumentItem.java new file mode 100644 index 0000000..2ef7ea5 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/DocumentItem.java @@ -0,0 +1,35 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.horizontalaccesscontrol; + +import lombok.Builder; +import lombok.Value; + +/** + * Document item for displaying user's documents overview. + */ +@Builder +@Value +public class DocumentItem { + int id; + String name; + + @Override + public String toString() { + return name; + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/HorizontalAccessControlController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/HorizontalAccessControlController.java new file mode 100644 index 0000000..3fdf5ab --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/HorizontalAccessControlController.java @@ -0,0 +1,98 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.horizontalaccesscontrol; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.challenge.ChallengeController; +import com.warxim.vucsa.common.ChallengeConstant; +import com.warxim.vucsa.common.message.horizontalaccesscontrol.request.DocumentContentRequest; +import javafx.application.Platform; +import javafx.beans.value.ObservableValue; +import javafx.fxml.Initializable; +import javafx.fxml.FXML; +import javafx.scene.control.ListView; +import javafx.scene.control.TextArea; + +import java.net.URL; +import java.util.ResourceBundle; + +/** + * Horizontal access controller handles horizontal access challenge. + *

Simulates document management of logged user and allows him to download document content of his documents.

+ */ +public class HorizontalAccessControlController extends ChallengeController implements Initializable { + private final HorizontalAccessControlHandler handler = new HorizontalAccessControlHandler(this); + + @FXML + private ListView documentInput; + @FXML + private TextArea contentOutput; + + @Override + public void initialize(URL location, ResourceBundle resources) { + initHandler(); + initDocuments(); + } + + /** + * Sets document content to GUI. + * @param content Content of the document + */ + public void setDocument(String content) { + Platform.runLater(() -> contentOutput.setText(content)); + } + + /** + * Initializes horizontal access control message handler. + */ + private void initHandler() { + Bundle.getInstance().getClientManager().registerHandler(ChallengeConstant.HORIZONTAL_ACCESS_CONTROL_DOCUMENT_CONTENT_TARGET, handler); + } + + /** + * Initializes document overview. + */ + private void initDocuments() { + documentInput.getItems().add(DocumentItem.builder() + .id(8435) + .name("My first secret document") + .build()); + documentInput.getItems().add(DocumentItem.builder() + .id(12002) + .name("Favorite books") + .build()); + documentInput.getSelectionModel().selectedItemProperty().addListener(this::onDocumentSelectionChange); + } + + /** + * Sends request for document content to the server, when document gets selected. + */ + private void onDocumentSelectionChange( + ObservableValue observable, + DocumentItem oldValue, + DocumentItem newValue + ) { + if (newValue == null) { + return; + } + + sendMessage(DocumentContentRequest.builder() + .target(ChallengeConstant.HORIZONTAL_ACCESS_CONTROL_DOCUMENT_CONTENT_TARGET) + .documentId(newValue.getId()) + .build()); + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/HorizontalAccessControlHandler.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/HorizontalAccessControlHandler.java new file mode 100644 index 0000000..4f2ece5 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/horizontalaccesscontrol/HorizontalAccessControlHandler.java @@ -0,0 +1,43 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.horizontalaccesscontrol; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.horizontalaccesscontrol.response.DocumentContentResponse; +import lombok.RequiredArgsConstructor; + +/** + * Handler for document content response for horizontal access control challenge. + */ +@RequiredArgsConstructor +public class HorizontalAccessControlHandler implements MessageHandler { + private final HorizontalAccessControlController controller; + + @Override + public boolean supports(Message message) { + return message instanceof DocumentContentResponse; + } + + @Override + public boolean handleMessage(Connection connection, Message message) { + var documentContentResponse = ((DocumentContentResponse) message); + controller.setDocument(documentContentResponse.getContent()); + return true; + } +} \ No newline at end of file diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/sqlinjection/SqlInjectionController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/sqlinjection/SqlInjectionController.java new file mode 100644 index 0000000..8bf129f --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/sqlinjection/SqlInjectionController.java @@ -0,0 +1,110 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.sqlinjection; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.challenge.ChallengeController; +import com.warxim.vucsa.common.ChallengeConstant; +import com.warxim.vucsa.common.message.sqlinjection.request.SearchRequest; +import com.warxim.vucsa.common.message.sqlinjection.FoodEntity; +import javafx.application.Platform; +import javafx.beans.value.ObservableValue; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.TableColumn; +import javafx.scene.control.TableView; +import javafx.scene.control.TextField; +import javafx.scene.control.cell.PropertyValueFactory; + +import java.net.URL; +import java.util.List; +import java.util.ResourceBundle; + +/** + * SQL Injection Controller handles SQL injection challenge. + *

Simulates food menu search and displays found food.

+ */ +public class SqlInjectionController extends ChallengeController implements Initializable { + private final SqlInjectionHandler handler = new SqlInjectionHandler(this); + + @FXML + private TextField searchInput; + @FXML + private TableView resultTable; + @FXML + private TableColumn idColumn; + @FXML + private TableColumn nameColumn; + @FXML + private TableColumn descriptionColumn; + @FXML + private TableColumn priceColumn; + + @Override + public void initialize(URL location, ResourceBundle resources) { + initHandler(); + initTable(); + searchInput.textProperty().addListener(this::onSearchInputChange); + } + + /** + * Sets items to the table. + * @param items Items to be set + */ + public void setItems(List items) { + Platform.runLater(() -> resultTable.getItems().setAll(items)); + } + + @FXML + private void onSearchClick(ActionEvent event) { + var message = SearchRequest.builder() + .target(ChallengeConstant.SQL_INJECTION_TARGET) + .search(searchInput.getText()) + .build(); + sendMessage(message); + } + + /** + * Initializes sql injection message handler. + */ + private void initHandler() { + Bundle.getInstance().getClientManager().registerHandler(ChallengeConstant.SQL_INJECTION_TARGET, handler); + } + + /** + * Initializes table columns. + */ + private void initTable() { + idColumn.setCellValueFactory(new PropertyValueFactory<>("id")); + nameColumn.setCellValueFactory(new PropertyValueFactory<>("name")); + descriptionColumn.setCellValueFactory(new PropertyValueFactory<>("description")); + priceColumn.setCellValueFactory(new PropertyValueFactory<>("price")); + } + + /** + * Removes invalid characters from search input on change. + */ + private void onSearchInputChange( + ObservableValue observable, + String oldValue, + String newValue) { + if (!newValue.matches("\\s0-9a-zA-Z\\.-")) { + searchInput.setText(newValue.replaceAll("[^\\s0-9a-zA-Z.-]", "")); + } + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/sqlinjection/SqlInjectionHandler.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/sqlinjection/SqlInjectionHandler.java new file mode 100644 index 0000000..d8bce1d --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/sqlinjection/SqlInjectionHandler.java @@ -0,0 +1,42 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.sqlinjection; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.sqlinjection.response.SearchResponse; +import lombok.RequiredArgsConstructor; + +/** + * Handler for search responses for SQL injection challenge. + */ +@RequiredArgsConstructor +public class SqlInjectionHandler implements MessageHandler { + private final SqlInjectionController controller; + + @Override + public boolean supports(Message message) { + return message instanceof SearchResponse; + } + + @Override + public boolean handleMessage(Connection connection, Message message) { + controller.setItems(((SearchResponse) message).getEntities()); + return true; + } +} \ No newline at end of file diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlController.java new file mode 100644 index 0000000..cb9b60c --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlController.java @@ -0,0 +1,138 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.verticalaccesscontrol; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.challenge.ChallengeController; +import com.warxim.vucsa.common.ChallengeConstant; +import com.warxim.vucsa.common.message.verticalaccesscontrol.UserRole; +import com.warxim.vucsa.common.message.verticalaccesscontrol.request.SecretRequest; +import com.warxim.vucsa.common.message.verticalaccesscontrol.request.UserInfoRequest; +import javafx.application.Platform; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.Label; +import javafx.scene.layout.AnchorPane; + +import java.net.URL; +import java.util.ResourceBundle; + +/** + * Vertical access controller handles vertical access challenge. + *

Simulates sending of user info from the server to the client about his session.

+ */ +public class VerticalAccessControlController extends ChallengeController implements Initializable { + private final VerticalAccessControlUserInfoHandler userInfoHandler = new VerticalAccessControlUserInfoHandler(this); + private final VerticalAccessControlSecretHandler secretHandler = new VerticalAccessControlSecretHandler(this); + + @FXML + private Label usernameLabel; + @FXML + private Label roleLabel; + + @FXML + private AnchorPane guestPane; + @FXML + private AnchorPane userPane; + @FXML + private AnchorPane adminPane; + @FXML + private Label secretLabel; + + @Override + public void initialize(URL location, ResourceBundle resources) { + initHandler(); + initPanes(); + } + + /** + * Sets user to the GUI. + * @param username Name of the user + * @param role Role of the user + */ + public void setUser(String username, UserRole role) { + Platform.runLater(() -> { + usernameLabel.setText(username); + roleLabel.setText(role.name()); + + if (role.equals(UserRole.GUEST)) { + guestPane.setVisible(true); + userPane.setVisible(false); + adminPane.setVisible(false); + secretLabel.setText("-"); + } else if (role.equals(UserRole.USER)) { + guestPane.setVisible(false); + userPane.setVisible(true); + adminPane.setVisible(false); + secretLabel.setText("-"); + } else if (role.equals(UserRole.ADMIN)) { + guestPane.setVisible(false); + userPane.setVisible(false); + adminPane.setVisible(true); + secretLabel.setText("-"); + } + }); + } + + /** + * Sets user secret to the GUI. + * @param secret Secret to be set + */ + public void setSecret(String secret) { + Platform.runLater(() -> secretLabel.setText(secret)); + } + + /** + * Sends request for user info to the server. + */ + @FXML + private void onRefreshClick(ActionEvent event) { + var message = UserInfoRequest.builder() + .target(ChallengeConstant.VERTICAL_ACCESS_CONTROL_USER_INFO_TARGET) + .build(); + sendMessage(message); + } + + /** + * Sends request for downloading secret to the server. + */ + @FXML + private void onDownloadSecretClick(ActionEvent event) { + var message = SecretRequest.builder() + .target(ChallengeConstant.VERTICAL_ACCESS_CONTROL_SECRET_TARGET) + .build(); + sendMessage(message); + } + + /** + * Initializes vertical access control message handlers. + */ + private void initHandler() { + Bundle.getInstance().getClientManager().registerHandler(ChallengeConstant.VERTICAL_ACCESS_CONTROL_USER_INFO_TARGET, userInfoHandler); + Bundle.getInstance().getClientManager().registerHandler(ChallengeConstant.VERTICAL_ACCESS_CONTROL_SECRET_TARGET, secretHandler); + } + + /** + * Hides all panes. + */ + private void initPanes() { + guestPane.setVisible(false); + userPane.setVisible(false); + adminPane.setVisible(false); + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlSecretHandler.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlSecretHandler.java new file mode 100644 index 0000000..e3666fe --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlSecretHandler.java @@ -0,0 +1,43 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.verticalaccesscontrol; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.verticalaccesscontrol.response.SecretResponse; +import lombok.RequiredArgsConstructor; + +/** + * Handler for secret response for vertical access control challenge. + */ +@RequiredArgsConstructor +public class VerticalAccessControlSecretHandler implements MessageHandler { + private final VerticalAccessControlController controller; + + @Override + public boolean supports(Message message) { + return message instanceof SecretResponse; + } + + @Override + public boolean handleMessage(Connection connection, Message message) { + var secretResponse = ((SecretResponse) message); + controller.setSecret(secretResponse.getSecret()); + return true; + } +} \ No newline at end of file diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlUserInfoHandler.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlUserInfoHandler.java new file mode 100644 index 0000000..d70ae8c --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/verticalaccesscontrol/VerticalAccessControlUserInfoHandler.java @@ -0,0 +1,43 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.verticalaccesscontrol; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.verticalaccesscontrol.response.UserInfoResponse; +import lombok.RequiredArgsConstructor; + +/** + * Handler for user info response for vertical access control challenge. + */ +@RequiredArgsConstructor +public class VerticalAccessControlUserInfoHandler implements MessageHandler { + private final VerticalAccessControlController controller; + + @Override + public boolean supports(Message message) { + return message instanceof UserInfoResponse; + } + + @Override + public boolean handleMessage(Connection connection, Message message) { + var info = ((UserInfoResponse) message); + controller.setUser(info.getUsername(), info.getRole()); + return true; + } +} \ No newline at end of file diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/xml/XmlController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/xml/XmlController.java new file mode 100644 index 0000000..7ec5fb1 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/xml/XmlController.java @@ -0,0 +1,156 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.xml; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.challenge.ChallengeController; +import com.warxim.vucsa.client.gui.dialog.Dialogs; +import com.warxim.vucsa.common.ChallengeConstant; +import com.warxim.vucsa.common.message.xml.StorageItem; +import com.warxim.vucsa.common.message.xml.StorageMessage; +import javafx.application.Platform; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.ContextMenu; +import javafx.scene.control.MenuItem; +import javafx.scene.control.TableColumn; +import javafx.scene.control.TableView; +import javafx.scene.control.cell.PropertyValueFactory; + +import java.net.URL; +import java.util.List; +import java.util.ResourceBundle; + +/** + * XML controller handles XML challenge. + *

This challenge acts like a simple ECHO functionality (simulates "storage"), but with vulnerable deserialization implementation.

+ */ +public class XmlController extends ChallengeController implements Initializable { + private final XmlHandler handler = new XmlHandler(this); + + @FXML + private TableView requestTable; + @FXML + private TableColumn requestKeyColumn; + @FXML + private TableColumn requestValueColumn; + @FXML + private TableView responseTable; + @FXML + private TableColumn responseKeyColumn; + @FXML + private TableColumn responseValueColumn; + + @Override + public void initialize(URL location, ResourceBundle resources) { + initHandler(); + initDefaultItems(); + initTable(); + initContextMenu(); + } + + /** + * Sets storage items to the GUI. + * @param items Items to be set + */ + public void setItems(List items) { + Platform.runLater(() -> responseTable.getItems().setAll(items)); + } + + /** + * Sends storage items to server to "save" them. + */ + @FXML + private void onSendClick(ActionEvent event) { + var message = StorageMessage.builder() + .target(ChallengeConstant.XML_TARGET) + .items(requestTable.getItems()) + .build(); + sendMessage(message); + } + + /** + * Adds new item. + */ + @FXML + private void onAddItemClick(ActionEvent event) { + var maybePair = Dialogs.createTextPairDialog("Add Item", "Key", "Value"); + if (maybePair.isEmpty()) { + return; + } + var pair = maybePair.get(); + requestTable.getItems().add(StorageItem.builder() + .key(pair.getKey()) + .value(pair.getValue()) + .build()); + } + + /** + * Removes existing item. + */ + @FXML + private void onRemoveItemClick(ActionEvent event) { + var selected = requestTable.getSelectionModel().getSelectedIndex(); + if (selected < 0) { + return; + } + + requestTable.getItems().remove(selected); + } + + /** + * Initializes buffer over-read message handler. + */ + private void initHandler() { + Bundle.getInstance().getClientManager().registerHandler(ChallengeConstant.XML_TARGET, handler); + } + + /** + * Initializes default items in the challenge GUI. + */ + private void initDefaultItems() { + requestTable.getItems().add(StorageItem.builder().key("Item 1").value("VALUE 1").build()); + requestTable.getItems().add(StorageItem.builder().key("Item 2").value("VALUE 2").build()); + requestTable.getItems().add(StorageItem.builder().key("Item 3").value("VALUE 3").build()); + } + + /** + * Initializes table columns. + */ + private void initTable() { + requestKeyColumn.setCellValueFactory(new PropertyValueFactory<>("key")); + requestValueColumn.setCellValueFactory(new PropertyValueFactory<>("value")); + responseKeyColumn.setCellValueFactory(new PropertyValueFactory<>("key")); + responseValueColumn.setCellValueFactory(new PropertyValueFactory<>("value")); + } + + /** + * Initializes context menu of request input. + */ + private void initContextMenu() { + var menu = new ContextMenu(); + var addItem = new MenuItem("Add"); + addItem.setOnAction(this::onAddItemClick); + var removeItem = new MenuItem("Remove"); + removeItem.setOnAction(this::onRemoveItemClick); + + menu.getItems().add(addItem); + menu.getItems().add(removeItem); + requestTable.setContextMenu(menu); + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/xml/XmlHandler.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/xml/XmlHandler.java new file mode 100644 index 0000000..7a61d04 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/challenge/xml/XmlHandler.java @@ -0,0 +1,42 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.challenge.xml; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.xml.StorageMessage; +import lombok.RequiredArgsConstructor; + +/** + * Handler for storage messages from server for XML challenge. + */ +@RequiredArgsConstructor +public class XmlHandler implements MessageHandler { + private final XmlController controller; + + @Override + public boolean supports(Message message) { + return message instanceof StorageMessage; + } + + @Override + public boolean handleMessage(Connection connection, Message message) { + controller.setItems(((StorageMessage) message).getItems()); + return true; + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/core/Client.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/core/Client.java new file mode 100644 index 0000000..4461a39 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/core/Client.java @@ -0,0 +1,58 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.core; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.connection.listener.ConnectionListener; +import com.warxim.vucsa.common.message.MessageHandler; + +import java.io.IOException; +import java.net.Socket; +import java.util.logging.Level; +import java.util.logging.Logger; + +/** + * Client, which is used to communicate with the server. + *

The client is created through ClientManager, when user starts it in the Settings tab.

+ */ +public class Client extends Connection { + private final ClientConfig config; + + public Client( + ClientConfig config, + ConnectionListener connectionListener, + MessageHandler messageHandler) { + super(1, connectionListener, messageHandler); + this.config = config; + } + + @Override + protected boolean handleBeforeStart() { + if (!super.handleBeforeStart()) { + return false; + } + + try { + socket = new Socket(config.getServerHost(), config.getServerPort()); + } catch (IOException e) { + Logger.getGlobal().log(Level.SEVERE, "Could not start client socket!", e); + return false; + } + + return true; + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/core/ClientConfig.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/core/ClientConfig.java new file mode 100644 index 0000000..a9e5688 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/core/ClientConfig.java @@ -0,0 +1,37 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.core; + +import lombok.Builder; +import lombok.Value; + +/** + * Client configuration. + */ +@Value +@Builder +public class ClientConfig { + /** + * Server host (127.0.0.1, www.example.org, ...) + */ + String serverHost; + + /** + * Server port (8765, ...) + */ + int serverPort; +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/core/ClientManager.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/core/ClientManager.java new file mode 100644 index 0000000..24597db --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/core/ClientManager.java @@ -0,0 +1,128 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.core; + +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.connection.ConnectionState; +import com.warxim.vucsa.common.connection.listener.ConnectionListener; +import com.warxim.vucsa.common.connection.listener.ConnectionListenerManager; +import com.warxim.vucsa.common.message.Message; +import com.warxim.vucsa.common.message.MessageHandler; +import com.warxim.vucsa.common.message.MessageHandlerManager; + +/** + * Client manager for managing client connection. + *

Wraps all required components and handles client creation, start, stop, ...

+ */ +public class ClientManager implements ConnectionListener { + private final ConnectionListenerManager connectionListenerManager; + private final MessageHandlerManager messageHandlerManager; + private Client client; + + public ClientManager() { + this.connectionListenerManager = new ConnectionListenerManager(); + this.messageHandlerManager = new MessageHandlerManager(); + connectionListenerManager.registerListener(this); + } + + /** + * Creates and starts client core. + * @param config Client configuration + */ + public synchronized void start(ClientConfig config) { + if (client != null) { + return; + } + + client = new Client(config, connectionListenerManager, messageHandlerManager); + client.start(); + } + + /** + * Stops client core. + */ + public synchronized void stop() { + if (client == null) { + return; + } + + client.stop(); + } + + /** + * Obtains client core state. + * @return Connection state + */ + public synchronized ConnectionState getState() { + if (client == null) { + return ConnectionState.STOPPED; + } + + return client.getState(); + } + + /** + * Sends message using the client if it is available. + *

If the client is not available, does nothing.

+ * @return {@code true} if the message was sent + */ + public synchronized boolean sendMessage(Message message) { + if (client != null && getState() == ConnectionState.STARTED) { + client.sendMessage(message); + return true; + } + return false; + } + + /** + * Registers connection listener. + * @param clientListener Listener to be registered + */ + public void registerConnectionListener(ConnectionListener clientListener) { + connectionListenerManager.registerListener(clientListener); + } + + /** + * Unregisters connection listener. + * @param clientListener Listener to be unregistered + */ + public void unregisterConnectionListener(ConnectionListener clientListener) { + connectionListenerManager.unregisterListener(clientListener); + } + + /** + * Registers message handler. + * @param target Target identifier of the handler + * @param messageHandler Handler to be registered + */ + public void registerHandler(int target, MessageHandler messageHandler) { + messageHandlerManager.registerHandler(target, messageHandler); + } + + /** + * Unregisters message handler. + * @param target Target identifier of the handler + */ + public void unregisterHandler(int target) { + messageHandlerManager.unregisterHandler(target); + } + + @Override + public void onConnectionStop(Connection connection) { + client = null; + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiApplication.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiApplication.java new file mode 100644 index 0000000..562fd73 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiApplication.java @@ -0,0 +1,67 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.gui; + +import com.sun.javafx.css.StyleManager; +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.common.Constant; +import com.warxim.vucsa.common.connection.ConnectionState; +import com.warxim.vucsa.client.gui.controller.ApplicationController; +import javafx.application.Application; +import javafx.fxml.FXMLLoader; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.stage.Stage; + +/** + * Client GUI application. + *

Starts Vulnerable Client GUI.

+ */ +public class GuiApplication extends Application { + @Override + public void start(Stage stage) throws Exception { + Application.setUserAgentStylesheet(Application.STYLESHEET_MODENA); + StyleManager.getInstance().addUserAgentStylesheet(getClass().getResource(GuiConstant.MAIN_CSS_PATH).toString()); + + var fxmlLoader = new FXMLLoader(getClass().getResource("/fxml/Application.fxml")); + fxmlLoader.setController(new ApplicationController()); + + Parent root = fxmlLoader.load(); + + var scene = new Scene(root); + stage.setTitle("VuCSA Client v" + Constant.VERSION); + stage.getIcons().add(GuiBundle.getInstance().getLogo()); + stage.setWidth(1200); + stage.setHeight(900); + stage.setScene(scene); + + stage.show(); + } + + @Override + public void stop() throws Exception { + super.stop(); + + var clientManager = Bundle.getInstance().getClientManager(); + if (clientManager != null && clientManager.getState() != ConnectionState.STOPPED) { + clientManager.stop(); + } + + Bundle.getInstance().destroy(); + GuiBundle.getInstance().destroy(); + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiBundle.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiBundle.java new file mode 100644 index 0000000..5bafba1 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiBundle.java @@ -0,0 +1,87 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.gui; + +import com.warxim.vucsa.client.gui.controller.ApplicationController; +import javafx.scene.image.Image; +import lombok.Getter; + +import java.util.Objects; + +/** + * Singleton for client GUI assets. + */ +@Getter +public final class GuiBundle { + /** + * Singleton instance. + */ + private static volatile GuiBundle instance; + + /** + * Logo icon + */ + private final Image logo; + + /** + * Application controller + */ + private ApplicationController applicationController; + + private GuiBundle() { + logo = new Image(Objects.requireNonNull(getClass().getResourceAsStream("/img/Logo.png"))); + } + + /** + * Creates instance of bundle or returns existing instance if it exists. + * @return Bundle instance + */ + public static GuiBundle getInstance() { + if (instance == null) { + synchronized(GuiBundle.class) { + if (instance == null) { + instance = new GuiBundle(); + } + } + } + + return instance; + } + + /** + * Obtains application controller, which handles main application window UI + * @return Application controller + */ + public ApplicationController getApplicationController() { + return applicationController; + } + + /** + * Sets application controller, which handles main application window UI + * @param controller Application controller + */ + public void setApplicationController(ApplicationController controller) { + applicationController = controller; + } + + /** + * Destroys the bundle. + */ + public void destroy() { + // no action needed + } +} \ No newline at end of file diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiConstant.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiConstant.java new file mode 100644 index 0000000..5a0d856 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/GuiConstant.java @@ -0,0 +1,30 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.gui; + +public final class GuiConstant { + /** + * Path to main CSS file of the application + */ + public static final String MAIN_CSS_PATH = "/css/Main.css"; + + public static final int LOG_TAB_ORDER = 1; + public static final int SETTINGS_TAB_ORDER = 2; + public static final int CHALLENGES_TAB_ORDER = 10; + + private GuiConstant() {} +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/ApplicationController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/ApplicationController.java new file mode 100644 index 0000000..70c90f0 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/ApplicationController.java @@ -0,0 +1,195 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.gui.controller; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.challenge.commandexecution.CommandExecutionController; +import com.warxim.vucsa.client.challenge.enumeration.EnumerationController; +import com.warxim.vucsa.client.challenge.verticalaccesscontrol.VerticalAccessControlController; +import com.warxim.vucsa.client.challenge.ChallengeController; +import com.warxim.vucsa.client.challenge.ChallengeWrapper; +import com.warxim.vucsa.client.challenge.bufferoverread.BufferOverreadController; +import com.warxim.vucsa.client.challenge.horizontalaccesscontrol.HorizontalAccessControlController; +import com.warxim.vucsa.client.challenge.sqlinjection.SqlInjectionController; +import com.warxim.vucsa.client.challenge.xml.XmlController; +import com.warxim.vucsa.client.gui.GuiBundle; +import com.warxim.vucsa.client.gui.GuiConstant; +import com.warxim.vucsa.client.gui.dialog.AboutDialog; +import com.warxim.vucsa.client.util.GuiUtils; +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.connection.ConnectionState; +import com.warxim.vucsa.common.connection.listener.ConnectionListener; +import javafx.application.Platform; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.FXMLLoader; +import javafx.fxml.Initializable; +import javafx.scene.Node; +import javafx.scene.control.TabPane; + +import java.io.IOException; +import java.net.URL; +import java.util.LinkedList; +import java.util.List; +import java.util.ResourceBundle; +import java.util.logging.Level; +import java.util.logging.Logger; + +/** + * Main application controller, which handles the whole application. + */ +public class ApplicationController implements Initializable, ConnectionListener { + private final List challengeWrappers = new LinkedList<>(); + + @FXML + private TabPane tabs; + + @Override + public void initialize(URL location, ResourceBundle resources) { + GuiBundle.getInstance().setApplicationController(this); + Bundle.getInstance().getClientManager().registerConnectionListener(this); + + initApplicationTabs(); + initChallengeTabs(); + + Logger.getGlobal().info("Application initialized!"); + } + + /** + * Exits application dialog. + */ + @FXML + private void onExitMenuClick(ActionEvent event) { + Platform.exit(); + } + /** + * Shows application about dialog. + */ + + @FXML + private void showAbout(ActionEvent e) { + AboutDialog.show(); + } + + @Override + public void onConnectionStart(Connection connection) { + Platform.runLater(() -> + challengeWrappers.forEach(challengeWrapper -> challengeWrapper.getNode().setDisable(false)) + ); + } + + @Override + public void onConnectionStop(Connection connection) { + Platform.runLater(() -> + challengeWrappers.forEach(challengeWrapper -> challengeWrapper.getNode().setDisable(true)) + ); + } + + /** + * Registers new tab to main tabs. + * @param title Title of the tab + * @param node Node to be added as a child into the tab + * @param order Order of the tab (where should the tab be placed) + */ + private void registerTab(String title, Node node, int order) { + GuiUtils.addTabToTabPane(tabs, title, node, order); + } + + /** + * Initializes application tab. + */ + private void initApplicationTab(String title, String template, Object controller, int order) { + try { + var fxmlLoader = new FXMLLoader(getClass().getResource(template)); + fxmlLoader.setController(controller); + registerTab(title, fxmlLoader.load(), order); + } catch (IOException e) { + Logger.getGlobal().log(Level.SEVERE, "Could not add settings tab", e); + } + } + + /** + * Initializes challenge tab and saves it to {@code challengeWrappers}. + */ + private void initChallengeTab(String title, String template, ChallengeController controller, int order) { + try { + var fxmlLoader = new FXMLLoader(getClass().getResource(template)); + fxmlLoader.setController(controller); + var node = (Node) fxmlLoader.load(); + var wrapper = ChallengeWrapper.builder() + .controller(controller) + .node(node) + .build(); + challengeWrappers.add(wrapper); + node.setDisable(Bundle.getInstance().getClientManager().getState() == ConnectionState.STOPPED); + registerTab(title, node, order); + } catch (IOException e) { + Logger.getGlobal().log(Level.SEVERE, "Could not add settings tab", e); + } + } + + /** + * Initializes main application tabs. + */ + private void initApplicationTabs() { + initApplicationTab("Log", "/fxml/tab/LogTab.fxml", new LogController(), GuiConstant.LOG_TAB_ORDER); + initApplicationTab("Settings", "/fxml/tab/SettingsTab.fxml", new SettingsController(), GuiConstant.SETTINGS_TAB_ORDER); + } + + /** + * Initializes challenge tabs. + *

Creates challenges and adds them to the tab pane.

+ */ + private void initChallengeTabs() { + var tabOrder = GuiConstant.CHALLENGES_TAB_ORDER; + initChallengeTab( + "Buffer Over-read", + "/fxml/challenge/bufferoverread/BufferOverreadTab.fxml", + new BufferOverreadController(), + ++tabOrder); + initChallengeTab( + "SQL Injection", + "/fxml/challenge/sqlinjection/SqlInjectionTab.fxml", + new SqlInjectionController(), + ++tabOrder); + initChallengeTab( + "Enumeration", + "/fxml/challenge/enumeration/EnumerationTab.fxml", + new EnumerationController(), + ++tabOrder); + initChallengeTab( + "Command Execution", + "/fxml/challenge/commandexecution/CommandExecutionTab.fxml", + new CommandExecutionController(), + ++tabOrder); + initChallengeTab( + "XML", + "/fxml/challenge/xml/XmlTab.fxml", + new XmlController(), + ++tabOrder); + initChallengeTab( + "Horizontal Access Control", + "/fxml/challenge/horizontalaccesscontrol/HorizontalAccessControlTab.fxml", + new HorizontalAccessControlController(), + ++tabOrder); + initChallengeTab( + "Vertical Access Control", + "/fxml/challenge/verticalaccesscontrol/VerticalAccessControlTab.fxml", + new VerticalAccessControlController(), + ++tabOrder); + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/LogController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/LogController.java new file mode 100644 index 0000000..bd8b328 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/LogController.java @@ -0,0 +1,150 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.gui.controller; + +import javafx.application.Platform; +import javafx.css.PseudoClass; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.ScrollPane; +import javafx.scene.text.Font; +import javafx.scene.text.FontWeight; +import javafx.scene.text.Text; +import javafx.scene.text.TextFlow; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.net.URL; +import java.util.ResourceBundle; +import java.util.logging.Handler; +import java.util.logging.Level; +import java.util.logging.LogRecord; +import java.util.logging.Logger; + +/** + * Log tab controller. + *

Displays logs from {@link Logger#getGlobal()}.

+ */ +public final class LogController extends Handler implements Initializable { + /** + * Maximum number of Text elements in text flow. + */ + private static final int LIMIT_LOG_CHILDREN = 150; + + private static final PseudoClass INFO_PSEUDO_CLASS = PseudoClass.getPseudoClass("info"); + private static final PseudoClass SEVERE_PSEUDO_CLASS = PseudoClass.getPseudoClass("severe"); + private static final PseudoClass WARNING_PSEUDO_CLASS = PseudoClass.getPseudoClass("warning"); + private static final PseudoClass FINE_PSEUDO_CLASS = PseudoClass.getPseudoClass("fine"); + private static final PseudoClass CONFIG_PSEUDO_CLASS = PseudoClass.getPseudoClass("config"); + private static final PseudoClass OTHER_PSEUDO_CLASS = PseudoClass.getPseudoClass("other"); + + /** + * Text flow for logs. + */ + @FXML + private TextFlow logFlow; + /** + * Scroll pane containing text flow. + */ + @FXML + private ScrollPane scrollPane; + + @Override + public void initialize(URL location, ResourceBundle resources) { + Logger.getGlobal().addHandler(this); + } + + @Override + public void publish(LogRecord logRecord) { + Platform.runLater(() -> this.addLogRecord(logRecord)); + } + + @Override + public void flush() { + // No action needed. + } + + @Override + public void close() { + // No action needed. + } + + /** + * Adds log logRecord to the flow. + */ + private void addLogRecord(LogRecord logRecord) { + // Level. + var level = logRecord.getLevel(); + + Text levelText; + if (level == Level.INFO) { + levelText = new Text("[INFO] "); + levelText.pseudoClassStateChanged(INFO_PSEUDO_CLASS, true); + } else if (level == Level.SEVERE) { + levelText = new Text("[SEVERE] "); + levelText.pseudoClassStateChanged(SEVERE_PSEUDO_CLASS, true); + } else if (level == Level.WARNING) { + levelText = new Text("[WARNING] "); + levelText.pseudoClassStateChanged(WARNING_PSEUDO_CLASS, true); + } else if (level == Level.FINE) { + levelText = new Text("[FINE] "); + levelText.pseudoClassStateChanged(FINE_PSEUDO_CLASS, true); + } else if (level == Level.CONFIG) { + levelText = new Text("[CONFIG] "); + levelText.pseudoClassStateChanged(CONFIG_PSEUDO_CLASS, true); + } else { + levelText = new Text("[OTHER] "); + levelText.pseudoClassStateChanged(OTHER_PSEUDO_CLASS, true); + } + levelText.getStyleClass().add("log-logRecord"); + levelText.setFont(Font.font(null, FontWeight.BOLD, 11)); + + // Message. + var messageText = new Text(logRecord.getMessage()); + + logFlow.getChildren().add(levelText); + logFlow.getChildren().add(messageText); + + // Exception. + if (logRecord.getThrown() != null) { + var exception = new StringWriter(); + exception.append(System.lineSeparator()); + exception.append("\tException:"); + exception.append(System.lineSeparator()); + exception.append("\t"); + logRecord.getThrown().printStackTrace(new PrintWriter(exception)); + var exceptionText = new Text(exception.toString()); + logFlow.getChildren().add(exceptionText); + } + + // Separator. + var logSeparator = new Text(System.lineSeparator()); + logSeparator.setFont(Font.font(null, FontWeight.NORMAL, 1)); + logSeparator.setLineSpacing(0); + logFlow.getChildren().add(logSeparator); + + // Limit children. + var size = logFlow.getChildren().size(); + if (size > LIMIT_LOG_CHILDREN) { + logFlow.getChildren().remove(0, size - LIMIT_LOG_CHILDREN); + } + + // Scroll down automatically. + scrollPane.layout(); + scrollPane.setVvalue(1D); + } +} \ No newline at end of file diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/SettingsController.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/SettingsController.java new file mode 100644 index 0000000..c9fa53f --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/controller/SettingsController.java @@ -0,0 +1,152 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.gui.controller; + +import com.warxim.vucsa.client.Bundle; +import com.warxim.vucsa.client.core.ClientConfig; +import com.warxim.vucsa.client.gui.dialog.Dialogs; +import com.warxim.vucsa.common.Constant; +import com.warxim.vucsa.common.connection.Connection; +import com.warxim.vucsa.common.connection.ConnectionState; +import com.warxim.vucsa.common.connection.listener.ConnectionListener; +import javafx.application.Platform; +import javafx.event.ActionEvent; +import javafx.fxml.FXML; +import javafx.fxml.Initializable; +import javafx.scene.control.Button; +import javafx.scene.control.Label; +import javafx.scene.control.TextField; + +import java.net.URL; +import java.util.Optional; +import java.util.ResourceBundle; + +/** + * Controller for settings tab. + */ +public class SettingsController implements Initializable, ConnectionListener { + private static final String CONNECT_TEXT = "CONNECT"; + private static final String DISCONNECT_TEXT = "DISCONNECT"; + + @FXML + private TextField serverHostInput; + @FXML + private TextField serverPortInput; + @FXML + private Label statusLabel; + @FXML + private Label serverHostLabel; + @FXML + private Label serverPortLabel; + @FXML + private Button startStopButton; + + @Override + public void initialize(URL location, ResourceBundle resources) { + serverHostInput.setText(Constant.DEFAULT_SERVER_HOST); + serverPortInput.setText(String.valueOf(Constant.DEFAULT_SERVER_PORT)); + startStopButton.setText(CONNECT_TEXT); + onConnectionStop(null); + var clientManager = Bundle.getInstance().getClientManager(); + clientManager.registerConnectionListener(this); + } + + @Override + public void onConnectionStart(Connection connection) { + Platform.runLater(() -> { + statusLabel.getStyleClass().add("status-connected"); + statusLabel.getStyleClass().removeAll("status-disconnected"); + statusLabel.setText("CONNECTED"); + startStopButton.setText(DISCONNECT_TEXT); + }); + } + + @Override + public void onConnectionStop(Connection connection) { + Platform.runLater(() -> { + statusLabel.getStyleClass().removeAll("status-connected"); + statusLabel.getStyleClass().add("status-disconnected"); + statusLabel.setText("DISCONNECTED"); + startStopButton.setText(CONNECT_TEXT); + }); + } + + /** + * Starts or stops client using client manager. + */ + @FXML + private void onStartStopClick(ActionEvent event) { + var clientManager = Bundle.getInstance().getClientManager(); + var clientState = clientManager.getState(); + if (clientState == ConnectionState.STARTED) { + clientManager.stop(); + startStopButton.setText(CONNECT_TEXT); + } else if (clientState == ConnectionState.STOPPED) { + var settings = validateAndGetSettings(); + if (settings.isEmpty()) { + return; + } + var config = ClientConfig.builder() + .serverHost(serverHostInput.getText()) + .serverPort(Integer.parseInt(serverPortInput.getText())) + .build(); + clientManager.start(config); + serverHostLabel.setText(serverHostInput.getText()); + serverPortLabel.setText(serverPortInput.getText()); + startStopButton.setText(DISCONNECT_TEXT); + } + } + + /** + * Checks if the settings is valid and returns the settings if it is valid. + */ + private Optional validateAndGetSettings() { + var serverHost = serverHostInput.getText(); + var serverPort = serverPortInput.getText(); + if (serverHost.isBlank()) { + Dialogs.createErrorDialog( + "Server host required", + "You have to specify server host!"); + return Optional.empty(); + } + + if (serverPort.isBlank() || !isInteger(serverPort)) { + Dialogs.createErrorDialog( + "Server port required", + "You have to specify server port!"); + return Optional.empty(); + } + + var settings = ClientConfig.builder() + .serverHost(serverHost) + .serverPort(Integer.parseInt(serverPort)) + .build(); + return Optional.of(settings); + } + + /** + * Returns true if the value is a valid integer. + */ + private static boolean isInteger(String value) { + try { + Integer.parseInt(value); + return true; + } catch(NumberFormatException e){ + return false; + } + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/dialog/AboutDialog.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/dialog/AboutDialog.java new file mode 100644 index 0000000..d2b6c58 --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/dialog/AboutDialog.java @@ -0,0 +1,115 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.gui.dialog; + +import com.warxim.vucsa.client.gui.GuiBundle; +import com.warxim.vucsa.common.Constant; +import javafx.event.ActionEvent; +import javafx.geometry.Insets; +import javafx.scene.control.Alert; +import javafx.scene.control.Hyperlink; +import javafx.scene.control.Label; +import javafx.scene.image.ImageView; +import javafx.scene.layout.GridPane; +import javafx.stage.Stage; + +import java.awt.*; +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.util.logging.Level; +import java.util.logging.Logger; + +/** + * About dialog. + */ +public final class AboutDialog { + private AboutDialog() { + } + + /** + * Shows about dialog. + */ + public static void show() { + var alert = new Alert(Alert.AlertType.INFORMATION); + + alert.setTitle("About VuCSA"); + alert.setHeaderText("VuCSA v" + Constant.VERSION); + + var icon = GuiBundle.getInstance().getLogo(); + + var image = new ImageView(icon); + image.setFitWidth(50); + image.setFitHeight(50); + alert.setGraphic(image); + + ((Stage) alert.getDialogPane().getScene().getWindow()).getIcons().add(icon); + + // Info + var infoLabel = new Label("Vulnerable client-server application (VuCSA) is made for learning/presenting how to perform penetration tests of non-http thick clients."); + + // Version + var versionLabel = new Label("Version:"); + versionLabel.getStyleClass().add("input-label"); + var versionValueLabel = new Label(Constant.VERSION); + + // Link + var linkLabel = new Label("Website: "); + linkLabel.getStyleClass().add("input-label"); + var link = new Hyperlink(Constant.WEB); + link.setOnAction(AboutDialog::onWebClick); + + // Copyright + var copyrightLabel = new Label("Copyright (C) Michal Valka, 2022, all rights reserved."); + + // Grid + var grid = new GridPane(); + grid.setMaxWidth(Double.MAX_VALUE); + grid.setHgap(10); + grid.setVgap(10); + grid.setPadding(new Insets(20, 150, 10, 10)); + + // Info + grid.add(infoLabel, 0, 0, 2, 1); + + // Version + grid.add(versionLabel, 0, 1); + grid.add(versionValueLabel, 1, 1); + + // Link + grid.add(linkLabel, 0, 2); + grid.add(link, 1, 2); + + // Copyright + grid.add(copyrightLabel, 0, 3, 2, 1); + + alert.getDialogPane().setContent(grid); + + alert.showAndWait(); + } + + /** + * Opens VuCSA website. + */ + private static void onWebClick(ActionEvent event) { + try { + Desktop.getDesktop().browse(new URI(Constant.WEB)); + } catch (IOException | URISyntaxException e) { + Logger.getGlobal().log(Level.SEVERE, "Could not open VuCSA link."); + } + } +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/dialog/Dialogs.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/dialog/Dialogs.java new file mode 100644 index 0000000..276300d --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/gui/dialog/Dialogs.java @@ -0,0 +1,298 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.gui.dialog; + +import javafx.geometry.Insets; +import javafx.scene.control.*; +import javafx.scene.control.Alert.AlertType; +import javafx.scene.image.Image; +import javafx.scene.layout.GridPane; +import javafx.scene.layout.Priority; +import javafx.stage.Stage; +import javafx.util.Pair; + +import java.io.PrintWriter; +import java.io.StringWriter; +import java.util.List; +import java.util.Optional; + +/** + * Dialog helper. + */ +public final class Dialogs { + private static Image defaultIcon; + + /** + * Gets default icon of PETEP. + * @return JavaFX image object + */ + public static Image getDefaultIcon() { + return defaultIcon; + } + + /** + * Sets default icon of PETEP. + * @param icon Icon to be used through the whole PETEP. + */ + public static void setDefaultIcon(Image icon) { + defaultIcon = icon; + } + + /** + * Creates simple error dialog (with error icon). + * @param title Dialog title + * @param message Dialog content message + */ + public static void createErrorDialog(String title, String message) { + var alert = new Alert(AlertType.ERROR); + alert.setTitle(title); + alert.setHeaderText(title); + alert.setContentText(message); + ((Stage) alert.getDialogPane().getScene().getWindow()).getIcons().add(defaultIcon); + alert.showAndWait(); + } + + /** + * Creates simple success dialog (with info icon). + * @param title Dialog title + * @param message Dialog content message + */ + public static void createInfoDialog(String title, String message) { + var alert = new Alert(AlertType.INFORMATION); + alert.setTitle(title); + alert.setHeaderText(title); + alert.setContentText(message); + ((Stage) alert.getDialogPane().getScene().getWindow()).getIcons().add(defaultIcon); + alert.showAndWait(); + } + + /** + * Creates simple exception dialog. + * @param title Dialog title + * @param message Dialog content message + * @param exception Exception to be displayed in textarea. + */ + public static void createExceptionDialog(String title, String message, Exception exception) { + var alert = new Alert(AlertType.ERROR); + alert.setTitle(title); + alert.setHeaderText(title); + alert.setContentText(message); + + ((Stage) alert.getDialogPane().getScene().getWindow()).getIcons().add(defaultIcon); + + var stringWriter = new StringWriter(); + var printWriter = new PrintWriter(stringWriter); + exception.printStackTrace(printWriter); + var exceptionText = stringWriter.toString(); + + var textArea = new TextArea(exceptionText); + textArea.setEditable(false); + textArea.setWrapText(true); + + textArea.setMaxWidth(Double.MAX_VALUE); + textArea.setMaxHeight(Double.MAX_VALUE); + GridPane.setVgrow(textArea, Priority.ALWAYS); + GridPane.setHgrow(textArea, Priority.ALWAYS); + + var label = new Label("The exception stacktrace was:"); + + var expContent = new GridPane(); + expContent.setMaxWidth(Double.MAX_VALUE); + expContent.add(label, 0, 0); + expContent.add(textArea, 0, 1); + + alert.getDialogPane().setExpandableContent(expContent); + + alert.showAndWait(); + } + + /** + * Creates simple yes / no / cancel dialog. + * @param title Dialog title + * @param message Dialog content message + * @return {@code Optional.of(true)} if yes has been clicked;
+ * {@code Optional.of(false)} if no has been clicked;
+ * {@code Optional.empty()} otherwise + */ + public static Optional createYesOrNoOrCancelDialog(String title, String message) { + var alert = new Alert(AlertType.CONFIRMATION, message, ButtonType.YES, ButtonType.NO, ButtonType.CANCEL); + alert.setTitle(title); + alert.setHeaderText(title); + ((Stage) alert.getDialogPane().getScene().getWindow()).getIcons().add(defaultIcon); + + alert.showAndWait(); + + var result = alert.getResult(); + if (result == ButtonType.YES) { + return Optional.of(Boolean.TRUE); + } else if (result == ButtonType.NO) { + return Optional.of(Boolean.FALSE); + } + return Optional.empty(); + } + + /** + * Creates simple yes / no dialog. + * @param title Dialog title + * @param message Dialog content message + * @return {@code true} if yes has been clicked;
+ * {@code false} if no has been clicked + */ + public static boolean createYesOrNoDialog(String title, String message) { + var alert = new Alert(AlertType.CONFIRMATION, message, ButtonType.YES, ButtonType.NO); + alert.setTitle(title); + alert.setHeaderText(title); + ((Stage) alert.getDialogPane().getScene().getWindow()).getIcons().add(defaultIcon); + + alert.showAndWait(); + + return alert.getResult() == ButtonType.YES; + } + + /** + * Creates simple text input dialog. (Empty default value.) + * @param title Dialog title + * @param message Dialog content message + * @return Entered value. (Empty optional if the dialog has been closed/canceled.] + */ + public static Optional createTextInputDialog(String title, String message) { + return createTextInputDialog(title, message, ""); + } + + /** + * Creates simple text input dialog. + * @param title Dialog title + * @param message Dialog content message + * @param value Default input value + * @return Entered value. (Empty optional if the dialog has been closed/canceled.) + */ + public static Optional createTextInputDialog(String title, String message, String value) { + var dialog = new TextInputDialog(value); + dialog.setTitle(title); + dialog.setHeaderText(title); + dialog.setContentText(message); + + ((Stage) dialog.getDialogPane().getScene().getWindow()).getIcons().add(defaultIcon); + + return dialog.showAndWait(); + } + + /** + * Creates simple choice dialog. + * @param title Dialog title + * @param message Dialog content message + * @param choices Choices to display in dialog + * @param value Default selected choice + * @return Chosen value. (Empty optional if the dialog has been closed/canceled.) + */ + public static Optional createChoiceDialog(String title, String message, List choices, T value) { + var dialog = new ChoiceDialog<>(value, choices); + dialog.setTitle(title); + dialog.setHeaderText(title); + dialog.setContentText(message); + + ((Stage) dialog.getDialogPane().getScene().getWindow()).getIcons().add(defaultIcon); + + return dialog.showAndWait(); + } + + /** + * Creates simple choice dialog. + * @param title Dialog title + * @param message Dialog content message + * @param choices Choices to display in dialog + * @return Chosen value. (Empty optional if the dialog has been closed/canceled.) + */ + public static Optional createChoiceDialog(String title, String message, List choices) { + return createChoiceDialog(title, message, choices, null); + } + + /** + * Creates dialog for text pair input. + *

Lets user enter two string values.

+ * @param title Dialog title + * @param firstLabel Label of first input + * @param secondLabel Label of second input + * @return Entered values. (Empty optional if the dialog has been closed/canceled.) + */ + public static Optional> createTextPairDialog( + String title, + String firstLabel, + String secondLabel) { + return createTextPairDialog(title, firstLabel, secondLabel, "", ""); + } + + /** + * Creates dialog for text pair input with default values. + *

Lets user enter two string values.

+ * @param title Dialog title + * @param firstLabel Label of first input + * @param secondLabel Label of second input + * @param firstValue Default value for first input + * @param secondValue Default value for second input + * @return Entered values. (Empty optional if the dialog has been closed/canceled.) + */ + public static Optional> createTextPairDialog( + String title, + String firstLabel, + String secondLabel, + String firstValue, + String secondValue) { + var dialog = new Dialog>(); + dialog.setTitle(title); + dialog.setHeaderText(title); + + ((Stage) dialog.getDialogPane().getScene().getWindow()).getIcons().add(defaultIcon); + + dialog.getDialogPane().getButtonTypes().addAll(ButtonType.OK, ButtonType.CANCEL); + + var keyLabel = new Label(firstLabel); + var keyInput = new TextField(firstValue); + keyInput.setMaxWidth(Double.MAX_VALUE); + + var valueLabel = new Label(secondLabel); + var valueInput = new TextField(secondValue); + valueInput.setMaxWidth(Double.MAX_VALUE); + + var grid = new GridPane(); + grid.setMaxWidth(Double.MAX_VALUE); + grid.setHgap(10); + grid.setVgap(10); + grid.setPadding(new Insets(20, 150, 10, 10)); + + grid.add(keyLabel, 0, 0); + grid.add(keyInput, 1, 0); + GridPane.setHgrow(keyInput, Priority.ALWAYS); + + grid.add(valueLabel, 0, 1); + grid.add(valueInput, 1, 1); + GridPane.setHgrow(valueInput, Priority.ALWAYS); + + dialog.getDialogPane().setContent(grid); + + dialog.setResultConverter(buttonType -> { + if (buttonType == ButtonType.OK) { + return new Pair<>(keyInput.getText(), valueInput.getText()); + } + return null; + }); + + return dialog.showAndWait(); + } + + private Dialogs() {} +} diff --git a/vucsa-client/src/main/java/com/warxim/vucsa/client/util/GuiUtils.java b/vucsa-client/src/main/java/com/warxim/vucsa/client/util/GuiUtils.java new file mode 100644 index 0000000..a93e6ea --- /dev/null +++ b/vucsa-client/src/main/java/com/warxim/vucsa/client/util/GuiUtils.java @@ -0,0 +1,60 @@ +/* + * Vulnerable Client-Server Application (VuCSA) + * + * Copyright (C) 2021 Michal Válka + * + * This program is free software: you can redistribute it and/or modify it under the terms of the + * GNU General Public License as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without + * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with this program. If + * not, see . + */ +package com.warxim.vucsa.client.util; + +import javafx.scene.Node; +import javafx.scene.control.ScrollPane; +import javafx.scene.control.Tab; +import javafx.scene.control.TabPane; + +/** + * GUI utils. + */ +public final class GuiUtils { + private GuiUtils() { + } + + /** + * Adds tab(node) to specified tab pane using the specified order. + * (Wraps the node to a scroll pane, creates new tab and adds it to the tabPane.) + * @param tabPane Tab pane to which to add the tab + * @param title Text of the tab title + * @param node Content node, which will be a content of the tab + * @param order Order to use when adding the tab + * @return Created tab + */ + public static Tab addTabToTabPane(TabPane tabPane, String title, Node node, Integer order) { + var scrollPane = new ScrollPane(node); + + scrollPane.setFitToHeight(true); + scrollPane.setFitToWidth(true); + var tab = new Tab(title, scrollPane); + tab.setUserData(order); + + var tabs = tabPane.getTabs(); + var index = 0; + for (; index < tabs.size(); ++index) { + var currentOrder = tabs.get(index).getUserData(); + if (currentOrder == null || (Integer) currentOrder > order) { + break; + } + } + tabPane.getTabs().add(index, tab); + return tab; + } + +} diff --git a/vucsa-client/src/main/resources/css/Main.css b/vucsa-client/src/main/resources/css/Main.css new file mode 100644 index 0000000..dda8ff1 --- /dev/null +++ b/vucsa-client/src/main/resources/css/Main.css @@ -0,0 +1,79 @@ +{ + -fx-font-size: 12px; + -fx-color-background-light: #fff; + -fx-color-text-primary: #000; + -fx-fill: -fx-color-text-primary; +} + +.h1, +.h1 .text { + -fx-font-size: 15px; + -fx-font-weight: 700; +} + +.h2, +.h2 .text { + -fx-font-size: 14px; + -fx-font-weight: 700; +} + +.h3, +.h3 .text { + -fx-font-size: 13px; + -fx-font-weight: 700; +} + +.input-label { + -fx-font-weight: 700; +} + + +/* + LOG FLOW +*/ + +.log-flow { + -fx-padding: 5px; + -fx-border-style: solid; + -fx-border-width: 1; + -fx-background-color: -fx-color-background-light; +} + +.log-flow .log-record:info { + -fx-fill: -fx-color-text-primary; +} + +.log-flow .log-record:severe { + -fx-fill: #a93226; +} + +.log-flow .log-record:warning { + -fx-fill: #CA6F1E; +} + +.log-flow .log-record:fine { + -fx-fill: #229954; +} + +.log-flow .log-record:other { + -fx-fill: #344051; +} + +.log-flow .log-record:config { + -fx-fill: #2471A3; +} + + +/* + STATUS LABEL +*/ + +.status-connected, +.status-connected .text { + -fx-fill: #048b04; +} + +.status-disconnected, +.status-disconnected .text { + -fx-fill: #970202; +} \ No newline at end of file diff --git a/vucsa-client/src/main/resources/fxml/Application.fxml b/vucsa-client/src/main/resources/fxml/Application.fxml new file mode 100644 index 0000000..fa4db21 --- /dev/null +++ b/vucsa-client/src/main/resources/fxml/Application.fxml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/vucsa-client/src/main/resources/fxml/challenge/bufferoverread/BufferOverreadTab.fxml b/vucsa-client/src/main/resources/fxml/challenge/bufferoverread/BufferOverreadTab.fxml new file mode 100644 index 0000000..7a6fe7e --- /dev/null +++ b/vucsa-client/src/main/resources/fxml/challenge/bufferoverread/BufferOverreadTab.fxml @@ -0,0 +1,23 @@ + + + + + + + + + + +