diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..d59ca45 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +github: [siewer]# Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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/pom.xml b/pom.xml index c13846b..0052706 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ io.mixeway MixewayOpenVasRestAPI - 1.0.0-SNAPSHOT + 1.2.0-SNAPSHOT jar MixewayOpenVasRestAPI @@ -83,6 +83,21 @@ javassist 3.25.0-GA + + org.springframework + spring-test + 5.2.3.RELEASE + + + junit + junit + + + org.apache.commons + commons-lang3 + 3.12.0 + + diff --git a/readme.md b/readme.md index 78bae30..3b7c114 100644 --- a/readme.md +++ b/readme.md @@ -87,7 +87,6 @@ Path | HTTP Method | Request Body | Description /initialize | POST |
{
"username":"openvasadmin",
"password":"changeit"
}
| Testing endpoint for verification if everything works properly /createtarget | POST |
{
"user": {
"username":"openvasadmin",
"password":"changeit"
},
"params": {
"name":"test_target",
"hosts":"127.0.0.0/28"
}
}
| Method which will create targets with `name` and host values `hosts` /createtask | POST |
{
"user": {
"username":"openvasadmin",
"password":"changeit"
},
"params": {
"config_id":"ffffff-ffff-ffff-ffffffffffff",
"target_id":"ffffff-ffff-ffff-ffffffffffff",
"name":"task_name",
"scanner_id":"ffffff-ffff-ffff-ffffffffffff"
}
}
| Method which will create taks with given configuration, on particular scan and selected target -/modifytask/{taskId} | POST |
{
"user": {
"username":"openvasadmin",
"password":"changeit"
},
"params": {
"task_id":"ffffff-ffff-ffff-ffffffffffff",
"target_id":"ffffff-ffff-ffff-ffffffffffff"
}
}
| Method which modify target for givent taks /starttask | POST |
{
"user": {
"username":"openvasadmin",
"password":"changeit"
},
"params": {
"task_id":"ffffff-ffff-ffff-ffffffffffff"
}
}
| Starting task by task_id /checktask | POST |
{
"user": {
"username":"openvasadmin",
"password":"changeit"
},
"params": {
"task_id":"ffffff-ffff-ffff-ffffffffffff"
}
}
| Checking status of task (Running, completed) /getreport | POST |
{
"user": {
"username":"openvasadmin",
"password":"changeit"
},
"params": {
"report_id":"ffffff-ffff-ffff-ffffffffffff"
}
}
| Getting vulnerabilities from OpenVAS by report_id diff --git a/src/main/java/pl/orange/bst/mixer/NoAuthSecurityConfig.java b/src/main/java/pl/orange/bst/mixer/NoAuthSecurityConfig.java new file mode 100644 index 0000000..961b7e6 --- /dev/null +++ b/src/main/java/pl/orange/bst/mixer/NoAuthSecurityConfig.java @@ -0,0 +1,35 @@ +package pl.orange.bst.mixer; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Profile; +import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity; +import org.springframework.security.config.annotation.web.builders.HttpSecurity; +import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; +import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter; +import org.springframework.security.core.authority.AuthorityUtils; +import org.springframework.security.core.userdetails.User; +import org.springframework.security.core.userdetails.UserDetails; +import org.springframework.security.core.userdetails.UserDetailsService; +import org.springframework.security.core.userdetails.UsernameNotFoundException; + +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +@Configuration +@EnableWebSecurity +@EnableGlobalMethodSecurity(prePostEnabled = true) +@Profile("noauth") +public class NoAuthSecurityConfig extends WebSecurityConfigurerAdapter { + + + @Override + protected void configure(HttpSecurity http) throws Exception { + http.csrf().disable(); + http + .authorizeRequests() + .antMatchers("/**").permitAll(); + } +} diff --git a/src/main/java/pl/orange/bst/mixer/Config.java b/src/main/java/pl/orange/bst/mixer/SecurityConfig.java similarity index 94% rename from src/main/java/pl/orange/bst/mixer/Config.java rename to src/main/java/pl/orange/bst/mixer/SecurityConfig.java index 3d45fc1..c37dafe 100644 --- a/src/main/java/pl/orange/bst/mixer/Config.java +++ b/src/main/java/pl/orange/bst/mixer/SecurityConfig.java @@ -8,6 +8,7 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Profile; import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; @@ -26,7 +27,8 @@ @Configuration @EnableWebSecurity @EnableGlobalMethodSecurity(prePostEnabled = true) -public class Config extends WebSecurityConfigurerAdapter { +@Profile("!noauth") +public class SecurityConfig extends WebSecurityConfigurerAdapter { @Value("${allowed.users}") private String commonNames; diff --git a/src/main/java/pl/orange/bst/mixer/Test.java b/src/main/java/pl/orange/bst/mixer/Test.java new file mode 100644 index 0000000..3cf7224 --- /dev/null +++ b/src/main/java/pl/orange/bst/mixer/Test.java @@ -0,0 +1,57 @@ +/* + * @created 2021-01-27 : 09:38 + * @project MixewayScanner + * @author siewer + */ +package pl.orange.bst.mixer; + +import org.junit.runner.RunWith; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.test.context.support.AnnotationConfigContextLoader; +import pl.orange.bst.mixer.openvas.helper.XmlOperationBuilder; +import pl.orange.bst.mixer.openvas.pojo.User; + +import javax.xml.bind.JAXBException; +import java.util.HashMap; + +@RunWith(SpringRunner.class) +@ContextConfiguration(classes= AnnotationConfigContextLoader.class) +public class Test { + + + @org.junit.Test + public void createTarget() throws JAXBException { + XmlOperationBuilder xob = new XmlOperationBuilder(); + User user = new User("gvmadmin","1qaz@WSX"); + HashMap params =new HashMap<>(); + params.put("hosts","192.168.1.1,192.168.1.2"); + params.put("name","random_rtarget"); + System.out.println("Create TargeT:"); + System.out.println(buildCommandPrefix(user) + "\""+xob.buildCreateTarget(user, params)+"\""); + } + @org.junit.Test + public void createTask() throws JAXBException { + XmlOperationBuilder xob = new XmlOperationBuilder(); + User user = new User("gvmadmin","1qaz@WSX"); + HashMap params =new HashMap<>(); + params.put("report_id","c9299f55-c17f-4e33-a3b0-48809213ee6d"); + System.out.println("Create task:"); + System.out.println(buildCommandPrefix(user) + "'"+xob.buildGetReport(user, params)+"'"); + } + @org.junit.Test + public void getReport() throws JAXBException { + XmlOperationBuilder xob = new XmlOperationBuilder(); + User user = new User("gvmadmin","1qaz@WSX"); + HashMap params =new HashMap<>(); + params.put("report_id","c9299f55-c17f-4e33-a3b0-48809213ee6d"); + System.out.println("Create task:"); + System.out.println(buildCommandPrefix(user) + "'"+xob.buildGetReport(user, params)+"'"); + } + + + + public String buildCommandPrefix(User user){ + return String.format("gvm-cli --gmp-username=%s --gmp-password=%s socket --socketpath %s --xml ",user.getUsername(), user.getPassword(), "/opt/gvm/var/run/gvmd.sock"); + } +} diff --git a/src/main/java/pl/orange/bst/mixer/openvas/OpenVasClient.java b/src/main/java/pl/orange/bst/mixer/openvas/OpenVasClient.java index 7cd3764..0cbd066 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/OpenVasClient.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/OpenVasClient.java @@ -11,6 +11,7 @@ import javax.xml.parsers.ParserConfigurationException; import org.apache.commons.io.IOUtils; +import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; @@ -33,6 +34,8 @@ public class OpenVasClient { @Value("${openvasmd.socket}") private String socket; + @Value("${gvm-cli.exec}") + private String gvmCli; XmlOperationBuilder xob = new XmlOperationBuilder(); private static final Logger log = LoggerFactory.getLogger(OpenVasClient.class); @@ -64,47 +67,124 @@ public String taskStatus(RestRequestBody body) throws JAXBException, SAXExceptio return getTaskStatusResponse(body.getUser(), body.getParams()); } public ReportXml getReport(RestRequestBody body) throws JAXBException, SAXException, IOException, ParserConfigurationException { - return getReportResponse(body.getUser(), body.getParams()); + List vulns = new ArrayList<>(); + int start =0; + vulns = loadVulns(body.getUser(), body.getParams(), start, vulns); + return new ReportXml(vulns); } - - private ReportXml getReportResponse(User user, HashMap params) throws JAXBException, SAXException, IOException, ParserConfigurationException { - ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli socket --socketpath "+socket+" --xml '"+xob.buildGetReport(user, params)+"'"); + + /** + * Version 11 + */ + private List loadVulns(User user, HashMap params, int start, List vulns) throws JAXBException, SAXException, IOException, ParserConfigurationException { + //ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli --timeout 600 socket --socketpath " + socket + " --xml '" + xob.buildGetResult(user, params, start) + "'"); + ProcessBuilder pb = new ProcessBuilder("bash", "-c", buildCommandPrefix(user) + "'"+xob.buildGetResult(user, params, start)+"'"); String output = IOUtils.toString(pb.start().getInputStream()); Document doc = DocumentBuilderFactory.newInstance() - .newDocumentBuilder() - .parse(new InputSource(new StringReader(output))); - Element reportNodeResponse = (Element) doc.getElementsByTagName("get_reports_response").item(0); - Element reportNode = (Element) reportNodeResponse.getElementsByTagName("report").item(0); - Element reportNode2 = (Element) reportNode.getElementsByTagName("report").item(0); - Element results = (Element) reportNode2.getElementsByTagName("results").item(0); + .newDocumentBuilder() + .parse(new InputSource(new StringReader(output))); + Element results = (Element) doc.getElementsByTagName("get_results_response").item(0); + Element count = (Element) doc.getElementsByTagName("result_count").item(0); + int resultsCount = Integer.parseInt(count.getElementsByTagName("filtered").item(0).getTextContent()); + log.info("Loading vulns for page {} and reportid: {}, result count {}", start, params.get(ConstantStrings.REPORT_ID), resultsCount); + NodeList vulnNode = results.getElementsByTagName("result"); - List vulns = new ArrayList<>(); - if (vulnNode != null) { - int length = vulnNode.getLength(); - for (int i = 0; i < length; i++) { - if (vulnNode.item(i).getNodeType() == Node.ELEMENT_NODE) { - Element el = (Element) vulnNode.item(i); - try { - Vuln v = new Vuln(); - v.setName(el.getElementsByTagName("name").item(0).getTextContent()); - v.setHost(el.getElementsByTagName("host").item(0).getFirstChild().getTextContent()); - v.setDesc(el.getElementsByTagName("description").item(0).getTextContent()); - v.setPort(el.getElementsByTagName("port").item(0).getTextContent()); - v.setThreat(el.getElementsByTagName("threat").item(0).getTextContent()); - vulns.add(v); - } catch (NullPointerException n) { - log.warn("Something is wrong with one of the results, nullpoitner returned"); - } - } - } - } - + int length = vulnNode.getLength(); + for (int i = 0; i < length; i++) { + if (vulnNode.item(i).getNodeType() == Node.ELEMENT_NODE) { + Element el = (Element) vulnNode.item(i); + try { + Vuln v = new Vuln(); + v.setName(el.getElementsByTagName("name").item(0).getTextContent()); + v.setHost(el.getElementsByTagName("host").item(0).getFirstChild().getTextContent()); + v.setDesc(el.getElementsByTagName("description").item(0).getTextContent()); + v.setPort(el.getElementsByTagName("port").item(0).getTextContent()); + if(StringUtils.isNumeric(el.getElementsByTagName("severity").item(0).getTextContent())) { + v.setThreat(getThreat(el.getElementsByTagName("severity").item(0).getTextContent())); + } else { + Element severityNvt = (Element) el.getElementsByTagName("severity").item(0); + v.setThreat(getThreat(severityNvt.getElementsByTagName("score").item(0).getTextContent())); + } + vulns.add(v); + } catch (NullPointerException n) { + //n.printStackTrace(); + log.info("Something is wrong with one of the results, nullpoitner returned"); + } + } + } + } + log.info("Vunlns contains {} records", vulns.size()); + if (((start * 1000) + 1000) < resultsCount){ + start++; + vulns.addAll(loadVulns(user, params,start, vulns)); + } + + return vulns; + } + + private String getThreat(String severity) { + double sev = Double.parseDouble(severity); + if (sev == 0.0){ + return "Info"; + } else if (sev <=4.0){ + return "Low"; + } else if (sev <=6.0) { + return "Medium"; + } else if (sev <=8.0){ + return "High"; + } else { + return "Critical"; + } + } + + /** + * Version 9 + */ + + private ReportXml getReportResponse(User user, HashMap params) throws JAXBException, SAXException, IOException, ParserConfigurationException { + List vulns = new ArrayList<>(); + try { + ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli --timeout 600 socket --socketpath " + socket + " --xml '" + xob.buildGetReport(user, params) + "'"); + String output = IOUtils.toString(pb.start().getInputStream()); + Document doc = DocumentBuilderFactory.newInstance() + .newDocumentBuilder() + .parse(new InputSource(new StringReader(output))); + Element reportNodeResponse = (Element) doc.getElementsByTagName("get_reports_response").item(0); + Element reportNode = (Element) reportNodeResponse.getElementsByTagName("report").item(0); + Element reportNode2 = (Element) reportNode.getElementsByTagName("report").item(0); + Element results = (Element) reportNode2.getElementsByTagName("results").item(0); + NodeList vulnNode = results.getElementsByTagName("result"); + + + if (vulnNode != null) { + int length = vulnNode.getLength(); + for (int i = 0; i < length; i++) { + if (vulnNode.item(i).getNodeType() == Node.ELEMENT_NODE) { + Element el = (Element) vulnNode.item(i); + try { + Vuln v = new Vuln(); + v.setName(el.getElementsByTagName("name").item(0).getTextContent()); + v.setHost(el.getElementsByTagName("host").item(0).getFirstChild().getTextContent()); + v.setDesc(el.getElementsByTagName("description").item(0).getTextContent()); + v.setPort(el.getElementsByTagName("port").item(0).getTextContent()); + v.setThreat(el.getElementsByTagName("threat").item(0).getTextContent()); + vulns.add(v); + } catch (NullPointerException n) { + log.warn("Something is wrong with one of the results, nullpoitner returned"); + } + } + } + } + } catch (NullPointerException e){ + log.warn("No results"); + } return new ReportXml(vulns); } + private String getTaskStatusResponse(User user, HashMap params) throws JAXBException, SAXException, IOException, ParserConfigurationException { - ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli socket --socketpath "+socket+" --xml '"+xob.buildGetTask(user, params)+"'"); + ProcessBuilder pb = new ProcessBuilder("bash", "-c", buildCommandPrefix(user) + "'"+xob.buildGetTask(user, params)+"'"); String output = IOUtils.toString(pb.start().getInputStream()); Document doc = DocumentBuilderFactory.newInstance() .newDocumentBuilder() @@ -118,8 +198,10 @@ private String getTaskStatusResponse(User user, HashMap params) return null; } private String getRunTask(User user, HashMap params) throws JAXBException, SAXException, IOException, ParserConfigurationException { - ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli socket --socketpath "+socket+" --xml '"+xob.buildStartTask(user, params)+"'"); + ProcessBuilder pb = new ProcessBuilder("bash", "-c", buildCommandPrefix(user) + "'"+xob.buildStartTask(user, params)+"'"); String output = IOUtils.toString(pb.start().getInputStream()); + log.debug("Request for starttask is {}", buildCommandPrefix(user) + "'"+xob.buildStartTask(user, params)+"'"); + log.debug("Output for starttask is {}", output); Document doc = DocumentBuilderFactory.newInstance() .newDocumentBuilder() .parse(new InputSource(new StringReader(output))); @@ -131,7 +213,7 @@ private String getRunTask(User user, HashMap params) throws JAXB return null; } private String getModifyTaskResponse(User user, HashMap params) throws JAXBException, SAXException, IOException, ParserConfigurationException { - ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli socket --socketpath "+socket+" --xml '"+xob.buildModifyTask(user, params)+"'"); + ProcessBuilder pb = new ProcessBuilder("bash", "-c", buildCommandPrefix(user) + "'"+xob.buildModifyTask(user, params)+"'"); String output = IOUtils.toString(pb.start().getInputStream()); Document doc = DocumentBuilderFactory.newInstance() .newDocumentBuilder() @@ -144,7 +226,7 @@ private String getModifyTaskResponse(User user, HashMap params) return null; } private String getCreateTaskResponse(User user, HashMap params) throws JAXBException, SAXException, IOException, ParserConfigurationException { - ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli socket --socketpath "+socket+" --xml '"+xob.buildCreateTask(user, params)+"'"); + ProcessBuilder pb = new ProcessBuilder("bash", "-c", buildCommandPrefix(user) + "'"+xob.buildCreateTask(user, params)+"'"); String output = IOUtils.toString(pb.start().getInputStream()); Document doc = DocumentBuilderFactory.newInstance() .newDocumentBuilder() @@ -157,8 +239,8 @@ private String getCreateTaskResponse(User user, HashMap params) return null; } private String getConfigResponse(User user) throws SAXException, IOException, ParserConfigurationException, JAXBException { - ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli socket --socketpath "+socket+" --xml \""+xob.buildGetConfig(user)+"\""); - System.out.println("gvm-cli socket --socketpath "+socket+" --xml \""+xob.buildGetConfig(user)+"\""); + log.info("About to execute: {} {} {} '{}'","bash","-c", buildCommandPrefix(user),xob.buildGetConfig(user) ); + ProcessBuilder pb = new ProcessBuilder("bash", "-c", buildCommandPrefix(user) + "'"+xob.buildGetConfig(user)+"'"); String output = IOUtils.toString(pb.start().getInputStream()); Document doc = DocumentBuilderFactory.newInstance() .newDocumentBuilder() @@ -179,7 +261,7 @@ private String getConfigResponse(User user) throws SAXException, IOException, Pa } private String getScannerResponse(User user) throws SAXException, IOException, ParserConfigurationException, JAXBException { - ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli socket --socketpath "+socket+" --xml \""+xob.buildGetScanners(user)+"\""); + ProcessBuilder pb = new ProcessBuilder("bash", "-c", buildCommandPrefix(user) + "'"+xob.buildGetScanners(user)+"'"); String output = IOUtils.toString(pb.start().getInputStream()); Document doc = DocumentBuilderFactory.newInstance() .newDocumentBuilder() @@ -200,8 +282,10 @@ private String getScannerResponse(User user) throws SAXException, IOException, P } private String getCreateTargetRespnse(User user, HashMap params) throws JAXBException, SAXException, IOException, ParserConfigurationException { - ProcessBuilder pb = new ProcessBuilder("bash", "-c", "gvm-cli socket --socketpath "+socket+" --xml \""+xob.buildCreateTarget(user, params)+"\""); + ProcessBuilder pb = new ProcessBuilder("bash", "-c", buildCommandPrefix(user) + "'"+xob.buildCreateTarget(user, params)+"'"); String output = IOUtils.toString(pb.start().getInputStream()); + log.debug("Request for createtarget is {}", buildCommandPrefix(user) + "'"+xob.buildCreateTarget(user, params)+"'"); + log.debug("Output for createtarget is {}", output); Document doc = DocumentBuilderFactory.newInstance() .newDocumentBuilder() .parse(new InputSource(new StringReader(output))); @@ -213,4 +297,7 @@ private String getCreateTargetRespnse(User user, HashMap params) return null; } + public String buildCommandPrefix(User user){ + return String.format("%s --timeout 600 --gmp-username=%s --gmp-password=%s socket --socketpath %s --xml ",gvmCli,user.getUsername(), user.getPassword(), socket); + } } diff --git a/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetConfig.java b/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetConfig.java index 29423b5..9aae2fc 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetConfig.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetConfig.java @@ -5,32 +5,11 @@ import pl.orange.bst.mixer.openvas.pojo.Authenticate; import pl.orange.bst.mixer.openvas.pojo.User; -@XmlRootElement(name="commands") +@XmlRootElement(name="get_configs") public class CommandsGetConfig { - private Authenticate authenticate; - private String get_configs; - - public Authenticate getAuthenticate() { - return authenticate; - } - - public void setAuthenticate(Authenticate authenticate) { - this.authenticate = authenticate; - } - - - public String getGet_configs() { - return get_configs; - } - - public void setGet_configs(String get_configs) { - this.get_configs = get_configs; - } public CommandsGetConfig(User user) { - this.setAuthenticate(new Authenticate(user)); - this.setGet_configs(""); } public CommandsGetConfig() {} } diff --git a/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetResults.java b/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetResults.java new file mode 100644 index 0000000..395e5d3 --- /dev/null +++ b/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetResults.java @@ -0,0 +1,39 @@ +/* + * @created 2020-09-28 : 16:14 + * @project MixewayScanner + * @author siewer + */ +package pl.orange.bst.mixer.openvas.helper; + +import pl.orange.bst.mixer.openvas.pojo.Authenticate; +import pl.orange.bst.mixer.openvas.pojo.GetResults; +import pl.orange.bst.mixer.openvas.pojo.Report; +import pl.orange.bst.mixer.openvas.pojo.User; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; + +@XmlRootElement(name="commands") +@XmlAccessorType(XmlAccessType.FIELD) +public class CommandsGetResults { + + private Authenticate authenticate; + @XmlElement(name="get_results") + private GetResults getResults; + public Authenticate getAuthenticate() { + return authenticate; + } + public void setAuthenticate(Authenticate authenticate) { + this.authenticate = authenticate; + } + + public CommandsGetResults(){} + + public CommandsGetResults(User user, int start, String report_id){ + this.authenticate = new Authenticate(user); + this.getResults = new GetResults(report_id, start); + } + +} \ No newline at end of file diff --git a/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetScanner.java b/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetScanner.java index 65cbc1f..0c8568f 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetScanner.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/helper/CommandsGetScanner.java @@ -5,26 +5,10 @@ import pl.orange.bst.mixer.openvas.pojo.Authenticate; import pl.orange.bst.mixer.openvas.pojo.User; -@XmlRootElement(name="commands") +@XmlRootElement(name="get_scanners") public class CommandsGetScanner { - private Authenticate authenticate; - private String get_scanners; - public Authenticate getAuthenticate() { - return authenticate; - } - public void setAuthenticate(Authenticate authenticate) { - this.authenticate = authenticate; - } - public String getGet_scanners() { - return get_scanners; - } - public void setGet_scanners(String get_scanners) { - this.get_scanners = get_scanners; - } - + public CommandsGetScanner() {} public CommandsGetScanner(User user) { - this.setAuthenticate(new Authenticate(user)); - this.setGet_scanners(""); } } diff --git a/src/main/java/pl/orange/bst/mixer/openvas/helper/XmlOperationBuilder.java b/src/main/java/pl/orange/bst/mixer/openvas/helper/XmlOperationBuilder.java index a443f71..c4b3cbe 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/helper/XmlOperationBuilder.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/helper/XmlOperationBuilder.java @@ -7,25 +7,19 @@ import javax.xml.bind.JAXBException; import javax.xml.bind.Marshaller; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; import pl.orange.bst.mixer.ConstantStrings; -import pl.orange.bst.mixer.openvas.pojo.Config; -import pl.orange.bst.mixer.openvas.pojo.CreateTarget; -import pl.orange.bst.mixer.openvas.pojo.CreateTask; -import pl.orange.bst.mixer.openvas.pojo.DeleteTarget; -import pl.orange.bst.mixer.openvas.pojo.GetTask; -import pl.orange.bst.mixer.openvas.pojo.ModifyTask; -import pl.orange.bst.mixer.openvas.pojo.Report; -import pl.orange.bst.mixer.openvas.pojo.Scanner; -import pl.orange.bst.mixer.openvas.pojo.StartTask; -import pl.orange.bst.mixer.openvas.pojo.Target; -import pl.orange.bst.mixer.openvas.pojo.User; +import pl.orange.bst.mixer.openvas.OpenVasClient; +import pl.orange.bst.mixer.openvas.pojo.*; @Component public class XmlOperationBuilder { - + private static final Logger log = LoggerFactory.getLogger(XmlOperationBuilder.class); public String buildGetConfig(User user) throws JAXBException { + log.info("Getting Config info"); CommandsGetConfig cgc = new CommandsGetConfig(user); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsGetConfig.class); Marshaller marshaller = jaxbContext.createMarshaller(); @@ -35,6 +29,7 @@ public String buildGetConfig(User user) throws JAXBException { return sw.toString(); } public String buildGetScanners(User user) throws JAXBException { + log.info("Getting scanners info"); CommandsGetScanner cgs = new CommandsGetScanner(user); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsGetScanner.class); Marshaller marshaller = jaxbContext.createMarshaller(); @@ -44,50 +39,54 @@ public String buildGetScanners(User user) throws JAXBException { return sw.toString(); } public String buildCreateTarget(User user, HashMap target) throws JAXBException { - CommandsCreateTarget cct = new CommandsCreateTarget(user); + log.info("Creating target for {}", target.get(ConstantStrings.HOSTS)); + //CommandsCreateTarget cct = new CommandsCreateTarget(user); CreateTarget ct = new CreateTarget(); ct.setHosts(target.get(ConstantStrings.HOSTS)); ct.setName(target.get(ConstantStrings.TARGET_NAME)); - cct.setCreateTarget(ct); + //cct.setCreateTarget(ct); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsCreateTarget.class); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); StringWriter sw = new StringWriter(); - marshaller.marshal(cct, sw); + marshaller.marshal(ct, sw); return sw.toString(); } public String buildDeleteTarget(User user, HashMap target) throws JAXBException { - CommandsDeleteTarget cdt = new CommandsDeleteTarget(user); + //CommandsDeleteTarget cdt = new CommandsDeleteTarget(user); DeleteTarget dt = new DeleteTarget(); dt.setTargetId(target.get(ConstantStrings.TARGET_ID)); - cdt.setDeleteTarget(dt); + //cdt.setDeleteTarget(dt); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsDeleteTarget.class); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); StringWriter sw = new StringWriter(); - marshaller.marshal(cdt, sw); + marshaller.marshal(dt, sw); return sw.toString(); } public String buildCreateTask(User user, HashMap target) throws JAXBException { - CommandsCreateTask cct = new CommandsCreateTask(user); + log.info("Creating task for {}",target.get(ConstantStrings.TARGET_NAME)); + //CommandsCreateTask cct = new CommandsCreateTask(user); CreateTask ct = new CreateTask(); ct.setConfig(new Config(target.get(ConstantStrings.CONFIG_ID))); ct.setScanner(new Scanner(target.get(ConstantStrings.SCANNER_ID))); ct.setTarget(new Target(target.get(ConstantStrings.TARGET_ID))); ct.setName(target.get(ConstantStrings.TARGET_NAME)); - cct.setCreateTask(ct); + //cct.setCreateTask(ct); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsCreateTask.class); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); StringWriter sw = new StringWriter(); - marshaller.marshal(cct, sw); + marshaller.marshal(ct, sw); return sw.toString(); } public String buildModifyTask(User user, HashMap target) throws JAXBException { - CommandsModifyTask cmt = new CommandsModifyTask(user, new ModifyTask(target.get(ConstantStrings.TASK_ID), new Target(target.get(ConstantStrings.TARGET_ID)))); + log.info("Modyfing task {}",target.get(ConstantStrings.TASK_ID)); + //CommandsModifyTask cmt = new CommandsModifyTask(user, new ModifyTask(target.get(ConstantStrings.TASK_ID), new Target(target.get(ConstantStrings.TARGET_ID)))); + ModifyTask cmt = new ModifyTask(target.get(ConstantStrings.TASK_ID), new Target(target.get(ConstantStrings.TARGET_ID))); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsModifyTask.class); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); @@ -97,7 +96,9 @@ public String buildModifyTask(User user, HashMap target) throws } public String buildStartTask(User user, HashMap target) throws JAXBException { - CommandsStartTask cst = new CommandsStartTask(user, new StartTask(target.get(ConstantStrings.TASK_ID))); + log.info("Starting task {}", target.get(ConstantStrings.TASK_ID)); + //CommandsStartTask cst = new CommandsStartTask(user, new StartTask(target.get(ConstantStrings.TASK_ID))); + StartTask cst = new StartTask(target.get(ConstantStrings.TASK_ID)); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsStartTask.class); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); @@ -107,7 +108,8 @@ public String buildStartTask(User user, HashMap target) throws J } public String buildGetTask(User user, HashMap target) throws JAXBException { - CommandsGetTasks cgt = new CommandsGetTasks(user, new GetTask(target.get(ConstantStrings.TASK_ID))); + //CommandsGetTasks cgt = new CommandsGetTasks(user, new GetTask(target.get(ConstantStrings.TASK_ID))); + GetTask cgt = new GetTask(target.get(ConstantStrings.TASK_ID)); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsGetTasks.class); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); @@ -117,7 +119,9 @@ public String buildGetTask(User user, HashMap target) throws JAX } public String buildGetReport(User user, HashMap target) throws JAXBException { - CommandsGetReport cgr = new CommandsGetReport(user, new Report(target.get(ConstantStrings.REPORT_ID))); + log.info("Building report for report_id {}",target.get(ConstantStrings.REPORT_ID)); + //CommandsGetReport cgr = new CommandsGetReport(user, new Report(target.get(ConstantStrings.REPORT_ID))); + Report cgr = new Report(target.get(ConstantStrings.REPORT_ID)); JAXBContext jaxbContext = JAXBContext.newInstance(CommandsGetReport.class); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); @@ -127,4 +131,17 @@ public String buildGetReport(User user, HashMap target) throws J } + public String buildGetResult(User user, HashMap target, int page) throws JAXBException { + //CommandsGetResults cgr = new CommandsGetResults(user, page, target.get(ConstantStrings.REPORT_ID)); + GetResults cgr = new GetResults(target.get(ConstantStrings.REPORT_ID), page); + JAXBContext jaxbContext = JAXBContext.newInstance(CommandsGetResults.class); + Marshaller marshaller = jaxbContext.createMarshaller(); + marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); + StringWriter sw = new StringWriter(); + marshaller.marshal(cgr, sw); + return sw.toString(); + } + + + } diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/CreateTarget.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/CreateTarget.java index 34c7726..161069f 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/pojo/CreateTarget.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/CreateTarget.java @@ -1,10 +1,24 @@ package pl.orange.bst.mixer.openvas.pojo; +import javax.xml.bind.annotation.XmlElement; +import javax.xml.bind.annotation.XmlRootElement; + +@XmlRootElement(name = "create_target") public class CreateTarget { private String name; private String hosts; private String alive_tests; + private PortList port_list; + + public PortList getPort_list() { + return port_list; + } + + public void setPort_list(PortList port_list) { + this.port_list = port_list; + } + public String getName() { return name; } @@ -24,6 +38,7 @@ public void setAlive_tests(String alive_tests) { this.alive_tests = alive_tests; } public CreateTarget() { + this.port_list = new PortList(); this.setAlive_tests("Consider Alive"); } diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/CreateTask.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/CreateTask.java index 7096495..9d827be 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/pojo/CreateTask.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/CreateTask.java @@ -1,5 +1,8 @@ package pl.orange.bst.mixer.openvas.pojo; +import javax.xml.bind.annotation.XmlRootElement; + +@XmlRootElement(name = "create_task") public class CreateTask { private String name; private Config config; diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/DeleteTarget.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/DeleteTarget.java index 53c8e38..7b15c6f 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/pojo/DeleteTarget.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/DeleteTarget.java @@ -3,7 +3,9 @@ import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlRootElement; +@XmlRootElement(name = "delete_target") @XmlAccessorType(XmlAccessType.FIELD) public class DeleteTarget { diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/GetResults.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/GetResults.java new file mode 100644 index 0000000..a3e4de7 --- /dev/null +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/GetResults.java @@ -0,0 +1,22 @@ +/* + * @created 2020-09-28 : 16:15 + * @project MixewayScanner + * @author siewer + */ +package pl.orange.bst.mixer.openvas.pojo; + +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlRootElement; + +@XmlRootElement(name = "get_results") +public class GetResults { + @XmlAttribute(name="filter") + String filter; + + public GetResults(String reportId, int start){ + this.filter ="report_id="+reportId+" first="+(start * 1000 + 1)+" rows=1000"; + } + + public GetResults() { + } +} diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/GetTask.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/GetTask.java index 448edc9..7a8122f 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/pojo/GetTask.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/GetTask.java @@ -3,9 +3,10 @@ import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlRootElement; @XmlAccessorType(XmlAccessType.FIELD) - +@XmlRootElement(name = "get_tasks") public class GetTask { @XmlAttribute(name="task_id") @@ -22,4 +23,6 @@ public void setTaskId(String taskId) { public GetTask(String id) { this.setTaskId(id); } + + public GetTask(){} } diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/ModifyTask.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/ModifyTask.java index 8c0b565..20c5b4e 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/pojo/ModifyTask.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/ModifyTask.java @@ -3,9 +3,10 @@ import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlRootElement; @XmlAccessorType(XmlAccessType.FIELD) - +@XmlRootElement(name = "modify_task") public class ModifyTask { @XmlAttribute(name="task_id") private String taskId; diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/PortList.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/PortList.java new file mode 100644 index 0000000..66d1d47 --- /dev/null +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/PortList.java @@ -0,0 +1,16 @@ +/* + * @created 2021-01-27 : 10:09 + * @project MixewayScanner + * @author siewer + */ +package pl.orange.bst.mixer.openvas.pojo; + +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlRootElement; + +public class PortList { + + @XmlAttribute + private String id="33d0cd82-57c6-11e1-8ed1-406186ea4fc5"; + +} diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/Report.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/Report.java index a8825d1..c21b747 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/pojo/Report.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/Report.java @@ -3,14 +3,18 @@ import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlRootElement; @XmlAccessorType(XmlAccessType.FIELD) +@XmlRootElement(name = "get_reports") public class Report { @XmlAttribute(name="report_id") private String reportId; @XmlAttribute(name="ignore_pagination") private Boolean ignorePagination = true; + @XmlAttribute(name = "details") + private String details = "True"; public String getReportId() { return reportId; @@ -23,6 +27,7 @@ public void setReportId(String reportId) { public Report(String id) { this.setReportId(id); } + public Report(){} public Boolean getIgnorePagination() { return ignorePagination; diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/StartTask.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/StartTask.java index 9922ee0..354308e 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/pojo/StartTask.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/StartTask.java @@ -3,8 +3,10 @@ import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlRootElement; @XmlAccessorType(XmlAccessType.FIELD) +@XmlRootElement(name = "start_task") public class StartTask { @XmlAttribute(name="task_id") private String taskId; @@ -20,5 +22,6 @@ public void setTaskId(String taskId) { public StartTask(String id) { this.setTaskId(id); } + public StartTask(){} } diff --git a/src/main/java/pl/orange/bst/mixer/openvas/pojo/User.java b/src/main/java/pl/orange/bst/mixer/openvas/pojo/User.java index b359af3..68f9d32 100644 --- a/src/main/java/pl/orange/bst/mixer/openvas/pojo/User.java +++ b/src/main/java/pl/orange/bst/mixer/openvas/pojo/User.java @@ -23,6 +23,9 @@ public User prepare() { this.setUsername(ConstantStrings.escape(this.getUsername())); return this; } - + public User(String username, String password) { + this.username = username; + this.password = password; + } } diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index 231d01b..4b784d4 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -1,10 +1,12 @@ server.port: 8444 -server.ssl.key-store: pki/localhost.p12 -server.ssl.key-store-password: changeit +server.ssl.key-store: /Users/gs/pki/new.p12 +server.ssl.key-store-password: 1qaz@WSX server.ssl.keyStoreType: PKCS12 -server.ssl.key-alias=mixer -server.ssl.trust-store=etc/pki/trust.jks +server.ssl.key-alias=mixeway +server.ssl.trust-store=/Users/gs/pki/trust.jks server.ssl.trust-store-password=changeit -server.ssl.client-auth=need -openvasmd.socket=/usr/local/var/run/openvasmd.sock -allowed.users=localhost,127.0.0.1 \ No newline at end of file +server.ssl.client-auth=want +openvasmd.socket=/Users/gs/gvm/gvmd.sock +allowed.users=localhost,127.0.0.1 +gvm-cli.exec=gvm-cli +logging.level.root=WARN \ No newline at end of file