diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..339b07c --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +*.nessus +*.xlsx +*.spec +.idea/ +__pycache__ +build +dist +nessus_file_reader.egg-info diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..e06aa80 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,12 @@ +========== +Change Log +========== + +This document records all notable changes to `nessus file reader by LimberDuck `_. +This project adheres to `Semantic Versioning `_. + + +0.1.0 (2019-06-23) +--------------------- + +* Initial release \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /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 +. \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 63e2624..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# nessus-file-reader -nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module created to quickly parse nessus files containing the results of scans performed by using Nessus by (C) Tenable, Inc. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..bc5dcb6 --- /dev/null +++ b/README.rst @@ -0,0 +1,151 @@ +nessus file reader by LimberDuck +################################ + +*nessus file reader* by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python +module created to quickly parse nessus files containing the results of scans +performed by using Nessus by (C) Tenable, Inc. This module will let you get +data through functions grouped into categories like file, scan, host and +plugin to get specific information from the provided nessus scan files. + +|license| |repo_size| |code_size| |supported_platform| + + +.. class:: no-web no-pdf + +.. contents:: + +.. section-numbering:: + +Main features +============= + +* read data from nessus files containing results of scans performed by using Nessus by (C) Tenable, Inc. +* use `nfr_example_script.py`_. to see examples + +Usage +===== +1. Install *nessus-file-reader* module. + + .. code-block:: bash + + pip install nessus-file-reader + +2. Import *nessus-file-reader* module. + + .. code-block:: python + + import nessus_file_reader as nfr + +3. Use *file* functions to get details about provided file e.g. root, file name, file size. + + .. code-block:: python + + nessus_scan_file = './your_nessus_file.nessus' + root = nfr.file.nessus_scan_file_root_element(nessus_scan_file) + file_name = nfr.file.nessus_scan_file_name_with_path(nessus_scan_file) + file_size = nfr.file.nessus_scan_file_size_human(nessus_scan_file) + print(f'File name: {file_name}') + print(f'File size: {file_size}') + +4. Use *scan* functions to get details about provided scan e.g. report name, number of target/scanned/credentialed hosts, scan time start/end/elapsed and more. + + .. code-block:: python + + report_name = nfr.scan.report_name(root) + number_of_target_hosts = nfr.scan.number_of_target_hosts(root) + number_of_scanned_hosts = nfr.scan.number_of_scanned_hosts(root) + number_of_scanned_hosts_with_credentialed_checks_yes = nfr.scan.number_of_scanned_hosts_with_credentialed_checks_yes(root) + scan_time_start = nfr.scan.scan_time_start(root) + scan_time_end = nfr.scan.scan_time_end(root) + scan_time_elapsed = nfr.scan.scan_time_elapsed(root) + print(f' Report name: {report_name}') + print(f' Number of target/scanned/credentialed hosts: {number_of_target_hosts}/{number_of_scanned_hosts}/{number_of_scanned_hosts_with_credentialed_checks_yes}') + print(f' Scan time START - END (ELAPSED): {scan_time_start} - {scan_time_end} ({scan_time_elapsed})') + +5. Use *host* functions to get details about hosts from provided scan e.g. report hosts names, operating system, hosts scan time start/end/elapsed, number of Critical/High/Medium/Low/None findings and more. + + .. code-block:: python + + for report_host in nfr.scan.report_hosts(root): + report_host_name = nfr.host.report_host_name(report_host) + report_host_os = nfr.host.detected_os(report_host) + report_host_scan_time_start = nfr.host.host_time_start(report_host) + report_host_scan_time_end = nfr.host.host_time_end(report_host) + report_host_scan_time_elapsed = nfr.host.host_time_elapsed(report_host) + report_host_critical = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Critical') + report_host_high = nfr.host.number_of_plugins_per_risk_factor(report_host, 'High') + report_host_medium = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Medium') + report_host_low = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Low') + report_host_none = nfr.host.number_of_plugins_per_risk_factor(report_host, 'None') + print(f' Report host name: {report_host_name}') + print(f' Report host OS: {report_host_os}') + print(f' Host scan time START - END (ELAPSED): {report_host_scan_time_start} - {report_host_scan_time_end} ({report_host_scan_time_elapsed})') + print(f' Critical/High/Medium/Low/None findings: {report_host_critical}/{report_host_high}/{report_host_medium}/{report_host_low}/{report_host_none}') + +6. Use *plugin* functions to get details about plugins reported in provided scan e.g. plugins ID, plugins risk factor, plugins name. + + .. code-block:: python + + print('\tPlugin ID\t\tRisk Factor\t\t\t\tPlugin Name') + report_items_per_host = nfr.host.report_items(report_host) + for report_item in report_items_per_host: + plugin_id = int(nfr.plugin.report_item_value(report_item, 'pluginID')) + risk_factor = nfr.plugin.report_item_value(report_item, 'risk_factor') + plugin_name = nfr.plugin.report_item_value(report_item, 'pluginName') + print('\t', plugin_id, ' \t\t\t', risk_factor, ' \t\t\t', plugin_name) + +7. If you want to get output for interesting you plugin e.g. "Nessus Scan Information" use below function + + .. code-block:: python + + for report_host in nfr.scan.report_hosts(root): + pido_19506 = nfr.plugin.plugin_output(root, report_host, '19506') + print(f'Nessus Scan Information Plugin Output:\n{pido_19506}') + +8. If you know that interesting you plugin occurs more than ones for particular host e.g. "Netstat Portscanner (SSH)" use below function + + .. code-block:: python + + for report_host in nfr.scan.report_hosts(root): + pidos_14272 = nfr.plugin.plugin_outputs(root, report_host, '14272') + print(f'All findings for Netstat Portscanner (SSH): \n{pidos_14272}') + + +Meta +==== + +Change log +---------- + +See `CHANGELOG`_. + + +Licence +------- + +GNU GPLv3: `LICENSE`_. + + + +Authors +------- + +`Damian Krawczyk`_ created *nessus file reader* by LimberDuck. + +.. _Damian Krawczyk: https://limberduck.org +.. _CHANGELOG: https://github.com/LimberDuck/nessus-file-reader/blob/master/CHANGELOG.rst +.. _LICENSE: https://github.com/LimberDuck/nessus-file-reader/blob/master/LICENSE +.. _nfr_example_script.py: https://github.com/LimberDuck/nessus-file-reader/blob/master/nfr_example_script.py + +.. |license| image:: https://img.shields.io/github/license/LimberDuck/nessus-file-reader.svg + :target: https://github.com/LimberDuck/nessus-file-reader/blob/master/LICENSE + :alt: License + +.. |repo_size| image:: https://img.shields.io/github/repo-size/LimberDuck/nessus-file-reader.svg + :target: https://github.com/LimberDuck/nessus-file-reader + +.. |code_size| image:: https://img.shields.io/github/languages/code-size/LimberDuck/nessus-file-reader.svg + :target: https://github.com/LimberDuck/nessus-file-reader + +.. |supported_platform| image:: https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey.svg + :target: https://github.com/LimberDuck/nessus-file-reader diff --git a/nessus_file_reader/__about__.py b/nessus_file_reader/__about__.py new file mode 100644 index 0000000..84452fc --- /dev/null +++ b/nessus_file_reader/__about__.py @@ -0,0 +1,40 @@ +# -*- coding: utf-8 -*- +u""" +nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module +created to quickly parse nessus files containing the results of scans +performed by using Nessus by (C) Tenable, Inc. +Copyright (C) 2019 Damian Krawczyk + +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 . +""" + +__all__ = [ + "__title__", "__icon__", "__summary__", "__uri__", "__version__", "__release_date__", "__author__", + "__email__", "__license_name__", "__license_link__", "__copyright__" +] + +__title__ = "nessus file reader by LimberDuck" +__package_name__ = "nessus-file-reader" +__icon__ = "LimberDuck-nessus-file-reader.ico" +__summary__ = "nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module" \ + "created to quickly parse nessus files containing the results of scans" \ + "performed by using Nessus by (C) Tenable, Inc." +__uri__ = "https://github.com/LimberDuck" +__version__ = "0.1.0" +__release_date__ = "2019.06.23" +__author__ = u"Damian Krawczyk" +__email__ = "damian.krawczyk@limberduck.org" +__license_name__ = "GNU GPLv3" +__license_link__ = "https://www.gnu.org/licenses/gpl-3.0.en.html" +__copyright__ = u"\N{COPYRIGHT SIGN} 2019 by %s" % __author__ diff --git a/nessus_file_reader/__init__.py b/nessus_file_reader/__init__.py new file mode 100644 index 0000000..9359a40 --- /dev/null +++ b/nessus_file_reader/__init__.py @@ -0,0 +1,15 @@ +from .__about__ import ( + __title__, __icon__, __summary__, __uri__, __version__, __release_date__, __author__, + __email__, __license_name__, __license_link__, __copyright__ +) + +__all__ = [ + "__title__", "__icon__", "__summary__", "__uri__", "__version__", "__release_date__", "__author__", + "__email__", "__license_name__", "__license_link__", "__copyright__" +] + +from .file import file +from .host import host +from .plugin import plugin +from .scan import scan +name = "nessus_file_reader" diff --git a/nessus_file_reader/file/__init__.py b/nessus_file_reader/file/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/nessus_file_reader/file/file.py b/nessus_file_reader/file/file.py new file mode 100644 index 0000000..52059fc --- /dev/null +++ b/nessus_file_reader/file/file.py @@ -0,0 +1,70 @@ +# -*- coding: utf-8 -*- +u""" +nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module +created to quickly parse nessus files containing the results of scans +performed by using Nessus by (C) Tenable, Inc. +Copyright (C) 2019 Damian Krawczyk + +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 . +""" + +import os +from xml.etree.ElementTree import parse + + +def nessus_scan_file_name_with_path(file): + """ + Function returns a normalized absolute version of the path. + :param file: given nessus file + :return: normalized absolute version of the given file path. + """ + nessus_scan_file_name = os.path.abspath(file) + return nessus_scan_file_name + + +def nessus_scan_file_size(file): + """ + Function returns the size in bytes of path. + :param file: given nessus file + :return: size in bytes of path. + """ + file_size = os.path.getsize(file) + return file_size + + +def nessus_scan_file_size_human(file): + """ + Function convert nessus file size from bytes to size more convenient to read by human. + :param file: given nessus file + :return: size in human readable form + """ + size = nessus_scan_file_size(file) + suffix = 'B' + for unit in [' b', ' Ki', ' Mi', ' Gi', ' Ti', ' Pi', ' Ei', ' Zi']: + if abs(size) < 1024.0: + return "%3.1f%s%s" % (size, unit, suffix) + size /= 1024.0 + return "%.1f%s%s" % (size, 'Yi', suffix) + + +def nessus_scan_file_root_element(file): + """ + Function returns the root element for tree of given nessus file with scan results. + :param file: given nessus file + :return: root element for this tree. + """ + nessus_scan_file = nessus_scan_file_name_with_path(file) + nessus_scan_file_parsed = parse(nessus_scan_file) + root = nessus_scan_file_parsed.getroot() + return root diff --git a/nessus_file_reader/host/__init__.py b/nessus_file_reader/host/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/nessus_file_reader/host/host.py b/nessus_file_reader/host/host.py new file mode 100644 index 0000000..37ca0fe --- /dev/null +++ b/nessus_file_reader/host/host.py @@ -0,0 +1,305 @@ +# -*- coding: utf-8 -*- +u""" +nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module +created to quickly parse nessus files containing the results of scans +performed by using Nessus by (C) Tenable, Inc. +Copyright (C) 2019 Damian Krawczyk + +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 . +""" + +import re +import datetime +from nessus_file_reader.plugin import plugin + + +def report_host_name(report_host): + """ + Function returns name of given report host. + :param report_host: report host element + :return: name of given report host + """ + name = report_host.get('name') + return name + + +def host_property_value(report_host, property_name): + """ + Function returns value of given property for given target, e.g. hostname. + :param report_host: report host element + :param property_name: exact property name + :return: property value + """ + property_exist = report_host[0].find("tag/[@name='" + property_name + "']") + + if property_exist is not None: + property_value = property_exist.text + else: + property_value = None + return property_value + + +def resolved_hostname(report_host): + """ + Function returns hostname for given target. If hostname contains FQDN only hostname will be returned. + :param report_host: report host element + :return: hostname for given target + """ + hostname = host_property_value(report_host, 'hostname') + if hostname is not None: + hostname = hostname.lower() + else: + hostname = '' + return hostname.split('.')[0] + + +def resolved_ip(report_host): + """ + Function returns ip for given target. + :param report_host: report host element + :return: ip for given target + """ + host_ip = host_property_value(report_host, 'host-ip') + return host_ip + + +def resolved_fqdn(report_host): + """ + Function returns fqdn for given target. + :param report_host: report host element + :return: fqdn for given target + """ + host_fqdn = host_property_value(report_host, 'host-fqdn') + if host_fqdn is not None: + host_fqdn = host_fqdn.lower() + return host_fqdn + + +def detected_os(report_host): + """ + Function returns information about Operating System for given target. + :param report_host: report host element + :return: os for given target + """ + operating_system = host_property_value(report_host, 'operating-system') + return operating_system + + +def scanner_ip(root, report_host): + """ + Function returns scanner ip for given target based on Plugin ID 19506. + :param root: root element of scan file tree + :param report_host: report host element + :return: ip address of scanner + """ + ip = None + pido_19506 = plugin.plugin_output(root, report_host, '19506') + for line in pido_19506.split('\n'): + if re.findall('Scanner IP :', line): + ip = re.sub('Scanner IP : ', '', line) + return ip + + +def login_used(report_host): + """ + Function returns login name used during scan for given target. + :param report_host: report host element + :return: login name + """ + login = None + + for tag in report_host[0].findall("tag"): + tag_name = tag.get('name') + if re.findall('login-used', tag_name): + if tag_name is not None: + login = tag.text + return login + + +def credentialed_checks(root, report_host): + """ + Function returns confirmation if credentialed checks have been enabled during scan for given target based on + Plugin ID 19506. + :param root: root element of scan file tree + :param report_host: report host element + :return: + 'yes' + login used - if credentialed checks have been enabled + 'no' - if credentialed checks have not been enabled + """ + credentialed = None + pido_19506 = plugin.plugin_output(root, report_host, '19506') + if "No output recorded." in pido_19506 \ + or "Check Audit Trail" in pido_19506 \ + or "19506 not enabled." in pido_19506: + credentialed = 'no' + else: + for line in pido_19506.split('\n'): + if re.findall('Credentialed checks :', line): + credentialed = re.sub('Credentialed checks : ', '', line) + credentialed = re.sub(''', '', credentialed) + + return credentialed + + +def credentialed_checks_db(root, report_host): + """ + Function returns confirmation if credentialed checks have been enabled during scan for given target based on + Plugin IDs 91825 and 91827. + :param root: root element of scan file tree + :param report_host: report host element + :return: + 'yes' + info about source - if credentialed checks have been enabled + 'no' - if credentialed checks have not been enabled + """ + credentialed = None + # "91825: Oracle DB Login Possible" + pido_91825 = plugin.plugin_output(root, report_host, '91825') + if "No output recorded." in pido_91825 \ + or "Check Audit Trail" in pido_91825 \ + or "91825 not enabled." in pido_91825: + credentialed = 'no' + elif re.findall('Credentialed checks have been enabled for Oracle RDBMS server', pido_91825): + credentialed = "yes, based on plugin id 91825" + + # "91827: Microsoft SQL Server Login Possible" + pido_91827 = plugin.plugin_output(root, report_host, '91827') + if "No output recorded." in pido_91827 \ + or "Check Audit Trail" in pido_91827 \ + or "91827 not enabled." in pido_91827: + credentialed = 'no' + elif re.findall('Credentialed checks have been enabled for MSSQL server', pido_91827): + credentialed = "yes, based on plugin id 91827" + + return credentialed + + +def number_of_plugins(report_host): + """ + Function returns number of reported plugins for given target. + :param report_host: report host element + :return: number of reported plugins + """ + number_of_plugins_counter = len(report_host.findall("ReportItem")) + return number_of_plugins_counter + + +def number_of_plugins_per_risk_factor(report_host, risk_factor_level): + """ + Function returns number of all plugins reported during scan for given risk factor for given target. + :param report_host: report host element + :param risk_factor_level: + 'Critical' + 'High' + 'Medium' + 'Low' + 'None' + :return: number of plugins for given risk factor + """ + risk_factor_counter = 0 + for report_item in report_host.findall("ReportItem"): + risk_factor = report_item.find('risk_factor') + if risk_factor is not None: + if risk_factor.text == risk_factor_level: + risk_factor_counter += 1 + return risk_factor_counter + + +def number_of_compliance_plugins(report_host): + """ + Function returns number of reported compliance plugins for given target. + :param report_host: report host element + :return: number of reported compliance plugins + """ + compliance_plugin_counter = 0 + for report_item in report_host.findall("ReportItem"): + compliance = report_item.find('compliance') + if compliance is not None: + if compliance.text == 'true': + compliance_plugin_counter += 1 + return compliance_plugin_counter + + +def number_of_compliance_plugins_per_result(report_host, compliance_result): + """ + Function returns number of all compliance plugins reported during scan for given compliance result for given target. + :param report_host: report host element + :param compliance_result: + 'PASSED' + 'FAILED' + 'WARNING' + :return: number of compliance plugins for given compliance result + """ + compliance_counter = 0 + for report_item in report_host.findall("ReportItem"): + compliance = report_item.find('cm:compliance-result', namespaces={'cm': 'http://www.nessus.org/cm'}) + if compliance is not None: + if compliance.text == compliance_result: + compliance_counter += 1 + return compliance_counter + + +def report_items(report_host): + """ + Function returns all items for given target. + :param report_host: report host element + :return: list of report items + """ + items = report_host.findall("ReportItem") + return items + + +def host_time_start(report_host): + """ + Function returns scan start time for given target. + :param report_host: report host element + :return: formatted date and time when scan has been started + """ + host_start_time = host_property_value(report_host, 'HOST_START') + if host_start_time is not None: + host_start_time_formatted = datetime.datetime.strptime(host_start_time, "%a %b %d %H:%M:%S %Y") + else: + host_start_time_formatted = None + return host_start_time_formatted + + +def host_time_end(report_host): + """ + Function returns scan end time for given target. + :param report_host: report host element + :return: formatted date and time when scan has been ended + """ + host_end_time = host_property_value(report_host, 'HOST_END') + if host_end_time is not None: + host_end_time_formatted = datetime.datetime.strptime(host_end_time, "%a %b %d %H:%M:%S %Y") + else: + host_end_time_formatted = None + + return host_end_time_formatted + + +def host_time_elapsed(report_host): + """ + Function returns scan time elapsed in format HH:MM:SS for given target. + :param report_host: report host element + :return: scan time elapsed in format HH:MM:SS. + """ + host_time_start_value = host_time_start(report_host) + host_time_end_value = host_time_end(report_host) + if host_time_end_value is not None: + elapsed_time = host_time_end_value - host_time_start_value + elapsed_time = str(elapsed_time) + else: + elapsed_time = None + + return elapsed_time diff --git a/nessus_file_reader/plugin/__init__.py b/nessus_file_reader/plugin/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/nessus_file_reader/plugin/plugin.py b/nessus_file_reader/plugin/plugin.py new file mode 100644 index 0000000..ba38deb --- /dev/null +++ b/nessus_file_reader/plugin/plugin.py @@ -0,0 +1,171 @@ +# -*- coding: utf-8 -*- +u""" +nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module +created to quickly parse nessus files containing the results of scans +performed by using Nessus by (C) Tenable, Inc. +Copyright (C) 2019 Damian Krawczyk + +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 . +""" + +import re +import datetime +from nessus_file_reader.scan import scan + + +def plugin_output(root, report_host, plugin_id): + """ + Function returns plugin output for given plugin id. If particular plugin occurs in report more than once, plugin + output of last occurrence is returned. + :param root: root element of scan file tree + :param report_host: scanned host + :param plugin_id: plugin id + :return: + plugin_output - content of plugin output is returned if plugin occurs in report and has an output. + 'No output recorded.' - information if plugin occurs in report but does not contain any output. + 'Check Audit Trail.' - information if plugin has been used during scan but does not appear in report at all. + '{plugin_id} not enabled.' - information if plugin has not been enabled in policy for scan. + + """ + plugin_id = str(plugin_id) + plugin_output_content = list() + status = 0 + + if plugin_id in scan.plugin_set(root): + for report_item in report_host.findall("ReportItem"): + plugin_id_from_report = report_item.get('pluginID') + if plugin_id_from_report == plugin_id: + plugin_output_item = report_item.find('plugin_output') + if plugin_output_item is None: + plugin_output_content = 'No output recorded.' + else: + plugin_output_content = plugin_output_item.text + status = 1 + if status == 0: + plugin_output_content = 'Check Audit Trail.' + else: + plugin_output_content = f'{plugin_id} not enabled.' + return plugin_output_content + + +def plugin_outputs(root, report_host, plugin_id): + """ + Function returns plugin output for given plugin id. If particular plugin occurs in report more than once, plugin + outputs are concatenated and return as one. + :param root: root element of scan file tree + :param report_host: scanned host + :param plugin_id: plugin id + :return: + plugin_output - content of plugin output is returned if plugin occurs in report and has an output. + 'No output recorded.' - information if plugin occurs in report but does not contain any output. + 'Check Audit Trail.' - information if plugin has been used during scan but does not appear in report at all. + '{plugin_id} not enabled.' - information if plugin has not been enabled in policy for scan. + + """ + plugin_id = str(plugin_id) + plugin_output_content = list() + status = 0 + + if plugin_id in scan.plugin_set(root): + for report_item in report_host.findall("ReportItem"): + plugin_id_from_report = report_item.get('pluginID') + if plugin_id_from_report == plugin_id: + plugin_output_item = report_item.find('plugin_output') + if plugin_output_item is None: + plugin_output_content.append('No output recorded.') + else: + plugin_output_content.append(plugin_output_item.text) + status = 1 + if status == 0: + plugin_output_content.append('Check Audit Trail.') + + if len(plugin_output_content) == 1: + plugin_output_content = plugin_output_content[0] + else: + plugin_output_content = '\n'.join(plugin_output_content) + else: + plugin_output_content = f'{plugin_id} not enabled.' + + return plugin_output_content + + +def compliance_plugin(report_item): + """ + Function checks if given report item is compliance plugin. + :param report_item: particular report item for scanned host + :return: + True if report item is compliance + False if report item is not compliance + """ + compliance = report_item_value(report_item, 'compliance') + plugin_type_compliance = False + if compliance is not None: + if compliance == 'true': + plugin_type_compliance = True + else: + plugin_type_compliance = False + + return plugin_type_compliance + + +def report_item_value(report_item, report_item_name): + """ + Function returns value of given report item e.g. pluginName + :param report_item: particular report item for scanned host + :param report_item_name: exact report item name for scanned host + :return: value of given report item + """ + report_item_content_value = report_item.get(report_item_name) + + if report_item_content_value is None: + report_item_content = report_item.find(report_item_name) + if report_item_content is not None: + report_item_content_value = report_item_content.text + return report_item_content_value + + +def compliance_check_item_value(report_item, compliance_check_item_name): + """ + Function returns value of given compliance check item e.g. cm:compliance-check-name + :param report_item: particular report item for scanned host + :param compliance_check_item_name: exact compliance check item name for scanned host + :return: value of given compliance check item name + """ + compliance_check_item_content_value = None + compliance = report_item.find('compliance') + if compliance is not None: + if compliance.text == 'true': + compliance_check_item_content = \ + report_item.find(compliance_check_item_name, namespaces={'cm': 'http://www.nessus.org/cm'}) + if compliance_check_item_content is not None: + compliance_check_item_content_value = compliance_check_item_content.text + return compliance_check_item_content_value + + +def plugin_date(date): + """ + Function convert given plugin date e.g. plugin_publication_date + :param date: date from plugin + :return: formatted date + """ + date_dash = re.search("\d{4}-\d{2}-\d{2}", date) + date_slash = re.search("\d{4}/\d{2}/\d{2}", date) + + if date_dash: + date_formatted = datetime.datetime.strptime(date, "%Y-%m-%d").date() + elif date_slash: + date_formatted = datetime.datetime.strptime(date, "%Y/%m/%d").date() + else: + date_formatted = None + return date_formatted diff --git a/nessus_file_reader/scan/__init__.py b/nessus_file_reader/scan/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/nessus_file_reader/scan/scan.py b/nessus_file_reader/scan/scan.py new file mode 100644 index 0000000..6893d3c --- /dev/null +++ b/nessus_file_reader/scan/scan.py @@ -0,0 +1,502 @@ +# -*- coding: utf-8 -*- +u""" +nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module +created to quickly parse nessus files containing the results of scans +performed by using Nessus by (C) Tenable, Inc. +Copyright (C) 2019 Damian Krawczyk + +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 . +""" + +import re +import datetime +from nessus_file_reader.plugin import plugin +from nessus_file_reader import utilities + + +def report_name(root): + """ + Function returns scan report name. + :param root: root element of scan file tree + :return: scan report name + """ + name = root.find("Report").get("name") + return name + + +def policy_name(root): + """ + Function returns policy name used during scan. + :param root: root element of scan file tree + :return: policy name + """ + name = root[0].find("policyName").text + return name + + +def server_preference_value(root, preference_name): + """ + Function returns value for given server preference. + :param root: root element of scan file tree + :param preference_name: preference name + :return: + preference value - if preference exist + None - if preference does not exist + """ + status = 0 + preference_value = None + for preference in root[0][1][0].findall("preference"): + preference_name_in_report = preference.findtext('name') + if preference_name_in_report == preference_name: + preference_value = preference.findtext('value') + status = 1 + if status == 0: + preference_value = None + + return preference_value + + +def source_of_file(root): + """ + Function returns information about source of file, Tenable.sc or Nessus. + :param root: root element of scan file tree + :return: + 'Tenable.sc' if Tenable.sc is source of nessus file + 'Nessus' if Nessus is source of nessus file + """ + sc_version = server_preference_value(root, 'sc_version') + if sc_version is not None: + source = 'Tenable.sc' + else: + source = 'Nessus' + return source + + +def policy_max_hosts(root): + """ + Function returns Max simultaneous checks per host value specified in policy used during scan. + :param root: root element of scan file tree + :return: max host value or None + """ + max_hosts = server_preference_value(root, 'max_hosts') + return max_hosts + + +def policy_max_checks(root): + """ + Function returns Max simultaneous hosts per scan value specified in policy used during scan. + :param root: root element of scan file tree + :return: max checks value or None + """ + max_checks = server_preference_value(root, 'max_checks') + return max_checks + + +def policy_checks_read_timeout(root): + """ + Function returns Network timeout (in seconds) value specified in policy used during scan. + :param root: root element of scan file tree + :return: network timeout value or None + """ + checks_read_timeout = server_preference_value(root, 'checks_read_timeout') + return checks_read_timeout + + +def reverse_lookup(root): + """ + Function returns information if option Settings > Report > Output > 'Designate hosts by their DNS name' has been + turned on in policy used during scan. + :param root: root element of scan file tree + :return: + 'yes' if reverse_lookup has been enabled + 'no' if reverse_lookup has not been enabled + """ + reverse_lookup_value = server_preference_value(root, 'reverse_lookup') + return reverse_lookup_value + + +def plugin_set(root): + """ + Function returns list of plugins selected in policy used during scan. + :param root: root element of scan file tree + :return: list of plugins selected in policy or None + """ + plugin_set_list = server_preference_value(root, 'plugin_set').split(';') + return plugin_set_list + + +def plugin_preference_value(root, full_preference_name): + """ + Function returns value for given full preference name of plugin. + :param root: root element of scan file tree + :param full_preference_name: full preference name of plugin + :return: preference value or None + """ + preference = \ + root[0].find("Preferences/PluginsPreferences/item/[fullName='" + full_preference_name + "']/selectedValue") + if preference is not None: + preference_value = preference.text + else: + preference_value = None + return preference_value + + +def policy_db_sid(root): + """ + Function returns Database SID specified in policy used during scan. + :param root: root element of scan file tree + :return: Database SID name or None + """ + sid = plugin_preference_value(root, 'Database settings[entry]:Database SID :') + return sid + + +def policy_db_port(root): + """ + Function returns Database port specified in policy used during scan. + :param root: root element of scan file tree + :return: Database port or None + """ + port = plugin_preference_value(root, 'Database settings[entry]:Database port to use :') + return port + + +def policy_login_specified(root): + """ + Function returns login specified in policy used during scan. + Currently covered: smb, ssh, database, VMware vCenter SOAP API + :param root: root element of scan file tree + :return: login name or None + """ + + login_vmware_vcenter_soap_api = \ + plugin_preference_value(root, 'VMware vCenter SOAP API Settings[entry]:VMware vCenter user name :') + login_database = plugin_preference_value(root, 'Database settings[entry]:Login :') + login_smb = plugin_preference_value(root, 'Login configurations[entry]:SMB account :') + login_ssh = plugin_preference_value(root, 'SSH settings[entry]:SSH user name :') + + if login_vmware_vcenter_soap_api: + login_specified = login_vmware_vcenter_soap_api + elif login_database: + login_specified = login_database + elif login_smb: + domain_smb_domain = plugin_preference_value(root, 'Login configurations[entry]:SMB domain (optional) :') + if domain_smb_domain: + login_specified = domain_smb_domain + '\\' + login_smb + else: + login_specified = login_smb + elif login_ssh: + login_specified = login_ssh + else: + login_specified = None + + return login_specified + + +def list_of_target_hosts_raw(root): + """ + Function returns list of target hosts specified in scan. + :param root: root element of scan file tree + :return: list of targets + """ + target_hosts = root[0].find("Preferences/ServerPreferences/preference/[name='TARGET']/value") + if target_hosts is not None: + target_hosts = target_hosts.text + target_hosts_splitted = target_hosts.split(',') + target_hosts_final_list = [element.lower() for element in target_hosts_splitted] + else: + target_hosts_final_list = None + return target_hosts_final_list + + +def list_of_target_hosts(root): + """ + Function returns list of target hosts specified in scan. + If nessus files comes from Tenable.sc and has [IP] in target it's removed + If nessus files comes from Tenable.sc and has IP range in target it's resolved to particular IP addresses + :param root: root element of scan file tree + :return: list of targets + """ + target_hosts = root[0].find("Preferences/ServerPreferences/preference/[name='TARGET']/value") + target_hosts_final_list = [] + if target_hosts is not None: + target_hosts = target_hosts.text + target_hosts_splitted = target_hosts.split(',') + target_hosts_splitted_lower = [element.lower() for element in target_hosts_splitted] + # if nessus file comes from Tenable.sc remove '[ip]' from target + target_hosts_splitted_lower_clear = [element.split('[', 1)[0] for element in target_hosts_splitted_lower] + # if nessus file comes from Tenable.sc convert IP ranges in target into separate IP addresses + for target in target_hosts_splitted_lower_clear: + if re.match('\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}-\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}', target): + address_range = utilities.ip_range_split(target) + for address in address_range: + target_hosts_final_list.append(str(address)) + else: + target_hosts_final_list.append(target) + else: + target_hosts_final_list = None + return target_hosts_final_list + + +def list_of_target_hosts_sc_fqdn_ip(root): + """ + Function returns list of target hosts as dictionary of fqdn and ip. Works only if nessus file comes from Tenable.sc. + :param root: root element of scan file tree + :return: dictionary of fqdn and ip + """ + target_list = [] + target_hosts = root[0].find("Preferences/ServerPreferences/preference/[name='TARGET']/value") + if target_hosts is not None: + target_hosts = target_hosts.text + target_hosts_splitted = target_hosts.split(',') + for target in target_hosts_splitted: + target_splitted = target[:-1].split('[') + if len(target_splitted) == 2: + target_list.append({'target_fqdn': target_splitted[0], 'target_ip': target_splitted[1]}) + else: + target_list = None + return target_list + + +def report_hosts(root): + """ + Function returns list of report hosts available in given file. + :param root: root element of scan file tree + :return: list report hosts + """ + hosts = root[1].findall("ReportHost") + return hosts + + +def list_of_scanned_hosts(root): + """ + Functions returns list of names of scanned hosts. + :param root: root element of scan file tree + :return: list of names of scanned hosts + """ + report_hosts_names = list() + for report_host in report_hosts(root): + report_host_name = report_host.get('name') + report_hosts_names.append(report_host_name) + return report_hosts_names + + +def list_of_not_scanned_hosts(root): + """ + Function returns list of not scanned hosts. + :param root: root element of scan file tree + :return: list of not scanned hosts + """ + target_hosts = list_of_target_hosts(root) + scanned_hosts = list_of_scanned_hosts(root) + if target_hosts: + not_scanned_hosts = set(target_hosts) - set(scanned_hosts) + else: + not_scanned_hosts = None + return not_scanned_hosts + + +def number_of_target_hosts(root): + """ + Function returns number of target hosts. + :param root: root element of scan file tree + :return: number of target hosts + """ + number_of_targets = len(list_of_target_hosts(root)) + return number_of_targets + + +def number_of_target_hosts_without_duplicates(root): + """ + Function returns number of actual target hosts (without duplicated entries). + :param root: root element of scan file tree + :return: number of actual target hosts + """ + target_hosts = list_of_target_hosts(root) + + if target_hosts: + actual_number_of_targets = len(set(target_hosts)) + else: + actual_number_of_targets = 0 + + return actual_number_of_targets + + +def number_of_scanned_hosts(root): + """ + Function returns number of scanned hosts. + :param root: root element of scan file tree + :return: number of scanned hosts + """ + number = len(list_of_scanned_hosts(root)) + return number + + +def number_of_not_scanned_hosts(root): + """ + Function returns number of not scanned hosts. + :param root: root element of scan file tree + :return: number of not scanned hosts + """ + number = len(list_of_not_scanned_hosts(root)) + return number + + +def number_of_scanned_hosts_with_credentialed_checks_yes(root): + """ + Function returns number of scanned hosts with credentialed checks yes. + :param root: root element of scan file tree + :return: number of scanned hosts with credentialed checks yes + """ + number_of_report_hosts_with_credentialed_checks = 0 + + for report_host in root[1].findall("ReportHost"): + pido_19506 = plugin.plugin_output(root, report_host, '19506') + if "No output recorded." not in pido_19506 \ + or "Check Audit Trail" not in pido_19506 \ + or "19506 not enabled." not in pido_19506: + for line in pido_19506.split('\n'): + if re.findall('Credentialed checks :', line): + if re.findall('yes', line): + number_of_report_hosts_with_credentialed_checks += 1 + + return number_of_report_hosts_with_credentialed_checks + + +def number_of_scanned_dbs_with_credentialed_checks_yes(root): + """ + Function returns number of scanned dbs with credentialed checks yes. + :param root: root element of scan file tree + :return: number of scanned dbs with credentialed checks yes + """ + number_of_scanned_dbs_with_credentialed_checks = 0 + + for report_host in root[1].findall("ReportHost"): + + # "91825: Oracle DB Login Possible" + pido_91825 = plugin.plugin_output(root, report_host, '91825') + if re.findall('Credentialed checks have been enabled for Oracle RDBMS server', pido_91825): + number_of_scanned_dbs_with_credentialed_checks += 1 + + # "91827: Oracle DB Login Possible" + pido_91827 = plugin.plugin_output(root, report_host, '91827') + if re.findall('Credentialed checks have been enabled for MSSQL server', pido_91827): + number_of_scanned_dbs_with_credentialed_checks += 1 + + return number_of_scanned_dbs_with_credentialed_checks + + +def scan_time_start(root): + """ + Function returns scan time start. + :param root: root element of scan file tree + :return: date and time when scan has been started + """ + min_date_start_check = root[1].find("ReportHost[1]/HostProperties/tag/[@name='HOST_START']") + + if min_date_start_check is not None: + min_date_start = min_date_start_check.text + min_date_start_parsed = datetime.datetime.strptime(min_date_start, "%a %b %d %H:%M:%S %Y") + + max_date_end = root[1].find("ReportHost[1]/HostProperties/tag/[@name='HOST_END']").text + max_date_end_parsed = datetime.datetime.strptime(max_date_end, "%a %b %d %H:%M:%S %Y") + + for reportHost in root[1].findall("ReportHost"): + host_end_time_find = reportHost[0].find("tag/[@name='HOST_END']") + if host_end_time_find is not None: + host_end_time = host_end_time_find.text + host_start_time = reportHost[0].find("tag/[@name='HOST_START']").text + + host_end_time_parsed = datetime.datetime.strptime(host_end_time, "%a %b %d %H:%M:%S %Y") + host_start_time_parsed = datetime.datetime.strptime(host_start_time, "%a %b %d %H:%M:%S %Y") + + if min_date_start_parsed > host_start_time_parsed: + min_date_start_parsed = host_start_time_parsed + + if max_date_end_parsed < host_end_time_parsed: + max_date_end_parsed = host_end_time_parsed + else: + min_date_start_parsed = None + return min_date_start_parsed + + +def scan_time_end(root): + """ + Function returns scan time end. + :param root: root element of scan file tree + :return: date and time when scan has been ended + """ + min_date_start_check = root[1].find("ReportHost[1]/HostProperties/tag/[@name='HOST_START']") + + if min_date_start_check is not None: + min_date_start = min_date_start_check.text + min_date_start_parsed = datetime.datetime.strptime(min_date_start, "%a %b %d %H:%M:%S %Y") + + max_date_end = root[1].find("ReportHost[1]/HostProperties/tag/[@name='HOST_END']").text + max_date_end_parsed = datetime.datetime.strptime(max_date_end, "%a %b %d %H:%M:%S %Y") + + for reportHost in root[1].findall("ReportHost"): + host_end_time_find = reportHost[0].find("tag/[@name='HOST_END']") + if host_end_time_find is not None: + host_end_time = host_end_time_find.text + host_start_time = reportHost[0].find("tag/[@name='HOST_START']").text + + host_end_time_parsed = datetime.datetime.strptime(host_end_time, "%a %b %d %H:%M:%S %Y") + host_start_time_parsed = datetime.datetime.strptime(host_start_time, "%a %b %d %H:%M:%S %Y") + + if min_date_start_parsed > host_start_time_parsed: + min_date_start_parsed = host_start_time_parsed + + if max_date_end_parsed < host_end_time_parsed: + max_date_end_parsed = host_end_time_parsed + else: + max_date_end_parsed = None + return max_date_end_parsed + + +def scan_time_elapsed(root): + """ + Function returns scan time elapsed in format HH:MM:SS + :param root: root element of scan file tree + :return: scan time elapsed in format HH:MM:SS + """ + min_date_start_check = root[1].find("ReportHost[1]/HostProperties/tag/[@name='HOST_START']") + + if min_date_start_check is not None: + min_date_start = min_date_start_check.text + min_date_start_parsed = datetime.datetime.strptime(min_date_start, "%a %b %d %H:%M:%S %Y") + max_date_end = root[1].find("ReportHost[1]/HostProperties/tag/[@name='HOST_END']").text + max_date_end_parsed = datetime.datetime.strptime(max_date_end, "%a %b %d %H:%M:%S %Y") + + for reportHost in root[1].findall("ReportHost"): + host_end_time_find = reportHost[0].find("tag/[@name='HOST_END']") + if host_end_time_find is not None: + host_end_time = host_end_time_find.text + host_start_time = reportHost[0].find("tag/[@name='HOST_START']").text + + host_end_time_parsed = datetime.datetime.strptime(host_end_time, "%a %b %d %H:%M:%S %Y") + host_start_time_parsed = datetime.datetime.strptime(host_start_time, "%a %b %d %H:%M:%S %Y") + + if min_date_start_parsed > host_start_time_parsed: + min_date_start_parsed = host_start_time_parsed + + if max_date_end_parsed < host_end_time_parsed: + max_date_end_parsed = host_end_time_parsed + + whole_scan_duration = max_date_end_parsed - min_date_start_parsed + whole_scan_duration_parsed = str(whole_scan_duration) + + else: + whole_scan_duration_parsed = None + return whole_scan_duration_parsed diff --git a/nessus_file_reader/utilities.py b/nessus_file_reader/utilities.py new file mode 100644 index 0000000..d291e13 --- /dev/null +++ b/nessus_file_reader/utilities.py @@ -0,0 +1,42 @@ +# -*- coding: utf-8 -*- +u""" +nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module +created to quickly parse nessus files containing the results of scans +performed by using Nessus by (C) Tenable, Inc. +Copyright (C) 2019 Damian Krawczyk + +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 . +""" + +import re +import ipaddress + + +def ip_range_split(ip_range): + """ + Function takes ip range and resolve it to list of particular IPs + :param ip_range: ip range + :return: list of IPs + """ + ip_addresses = [] + if re.match('\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}-\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}', ip_range): + address_part = ip_range.split('-') + first_address = ipaddress.IPv4Address(address_part[0]) + last_address = ipaddress.IPv4Address(address_part[1]) + + while first_address <= last_address: + ip_addresses.append(first_address) + first_address += 1 + + return ip_addresses diff --git a/nfr_example_script.py b/nfr_example_script.py new file mode 100644 index 0000000..c98fd57 --- /dev/null +++ b/nfr_example_script.py @@ -0,0 +1,154 @@ +# -*- coding: utf-8 -*- +u""" +nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module +created to quickly parse nessus files containing the results of scans +performed by using Nessus by (C) Tenable, Inc. +Copyright (C) 2019 Damian Krawczyk + +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 . +""" + +import nessus_file_reader as nfr +import os +import glob +import traceback +import time + + +def nfr_example_simple(): + + # Provide directory path where nessus files are placed or exact path to one nessus scan file + # default path is current directory + nessus_scan_files = '.' + + if os.path.isdir(nessus_scan_files): + os_separator = os.path.sep + extension = '*.nessus' + list_of_source_files = glob.glob(nessus_scan_files + os_separator + '**' + os_separator + extension, + recursive=True) + print(f'Source file path:\n{nessus_scan_files}\n') + print('\nList of source files:') + for source_file in list_of_source_files: + print(f' {source_file}') + else: + list_of_source_files = [nessus_scan_files] + print(f'Source file path:\n{os.path.dirname(nessus_scan_files)}') + print(f'\nList of source files:\n{nessus_scan_files}\n') + + start_time = time.time() + for row_index, nessus_scan_file in enumerate(list_of_source_files): + if os.path.isfile(nessus_scan_file): + + print(f'\n@-[{str(row_index+1)}/{str(len(list_of_source_files))}]----------------------' + f'-------------------------------------------------------------------------------') + try: + + # Use *file* functions to get details about provided file e.g. root, file name, file size. + root = nfr.file.nessus_scan_file_root_element(nessus_scan_file) + file_name = nfr.file.nessus_scan_file_name_with_path(nessus_scan_file) + file_size = nfr.file.nessus_scan_file_size_human(nessus_scan_file) + print(f'File name: {file_name}') + print(f'File size: {file_size}') + print('') + + # Use *scan* functions to get details about provided scan e.g. report name, + # number of target/scanned/credentialed hosts, scan time start/end/elapsed and more. + report_name = nfr.scan.report_name(root) + number_of_target_hosts = nfr.scan.number_of_target_hosts(root) + number_of_scanned_hosts = nfr.scan.number_of_scanned_hosts(root) + number_of_scanned_hosts_with_credentialed_checks_yes = \ + nfr.scan.number_of_scanned_hosts_with_credentialed_checks_yes(root) + scan_time_start = nfr.scan.scan_time_start(root) + scan_time_end = nfr.scan.scan_time_end(root) + scan_time_elapsed = nfr.scan.scan_time_elapsed(root) + print(f' Report name: {report_name}') + print(f' Number of target/scanned/credentialed hosts: ' + f'{number_of_target_hosts}/{number_of_scanned_hosts}/' + f'{number_of_scanned_hosts_with_credentialed_checks_yes}') + print(f' Scan time START - END (ELAPSED): {scan_time_start} - {scan_time_end} ({scan_time_elapsed})') + print('') + + # Use *host* functions to get details about hosts from provided scan e.g. report hosts names, + # operating system, hosts scan time start/end/elapsed, number of Critical/High/Medium/Low/None findings + # and more. + for report_host in nfr.scan.report_hosts(root): + report_host_name = nfr.host.report_host_name(report_host) + report_host_os = nfr.host.detected_os(report_host) + report_host_scan_time_start = nfr.host.host_time_start(report_host) + report_host_scan_time_end = nfr.host.host_time_end(report_host) + report_host_scan_time_elapsed = nfr.host.host_time_elapsed(report_host) + report_host_critical = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Critical') + report_host_high = nfr.host.number_of_plugins_per_risk_factor(report_host, 'High') + report_host_medium = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Medium') + report_host_low = nfr.host.number_of_plugins_per_risk_factor(report_host, 'Low') + report_host_none = nfr.host.number_of_plugins_per_risk_factor(report_host, 'None') + print(f' Report host name: {report_host_name}') + print(f' Report host OS: {report_host_os}') + print(f' Host scan time START - END (ELAPSED): ' + f'{report_host_scan_time_start} - {report_host_scan_time_end} ' + f'({report_host_scan_time_elapsed})') + print(f' Critical/High/Medium/Low/None findings: {report_host_critical}/{report_host_high}/' + f'{report_host_medium}/{report_host_low}/{report_host_none}') + print('') + + # Use *plugin* functions to get details about plugins reported in provided scan e.g. plugins ID, + # plugins risk factor, plugins name. + print('\tPlugin ID\t\tRisk Factor\t\t\t\tPlugin Name') + report_items_per_host = nfr.host.report_items(report_host) + for report_item in report_items_per_host: + plugin_id = int(nfr.plugin.report_item_value(report_item, 'pluginID')) + risk_factor = nfr.plugin.report_item_value(report_item, 'risk_factor') + plugin_name = nfr.plugin.report_item_value(report_item, 'pluginName') + print('\t', plugin_id, ' \t\t\t', risk_factor, ' \t\t\t', plugin_name) + + print() + # If you want to get output for interesting you plugin + # e.g. "Nessus Scan Information" use below function + pido_19506 = nfr.plugin.plugin_output(root, report_host, '19506') + print(f'Nessus Scan Information Plugin Output:\n{pido_19506}') + + # If you know that interesting you plugin occurs more than ones for particular host + # e.g. "Netstat Portscanner (SSH)" use below function + pidos_14272 = nfr.plugin.plugin_outputs(root, report_host, '14272') + print(f'All findings for Netstat Portscanner (SSH): \n{pidos_14272}') + + except Exception as e: + print(f'\nUps... ERROR occurred. \n\n {str(e)}') + traceback.print_exc() + print(f'ERROR Parsing [{str(row_index+1)}/{str(len(list_of_source_files))}] nessus files') + + else: + print(f'Ups.. {nessus_scan_file} does not exist in current directory: {os.getcwd()}') + + end_time = time.time() + elapsed_time = end_time - start_time + elapsed_time_parsed = time.strftime('%H:%M:%S', time.gmtime(elapsed_time)) + print('\n/====================================================' + '=======================================================') + print(f'[x] Parsing ended on {time.strftime("%c", time.localtime(end_time))}\n') + print(f'Elapsed time: {elapsed_time_parsed}') + + +def main(): + + app_name = nfr.__about__.__title__ + app_version = nfr.__about__.__version__ + app_version_release_date = nfr.__about__.__release_date__ + + print(f'This is example script for {app_name} {app_version} {app_version_release_date}\n') + + nfr_example_simple() + + +main() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..ab97d60 --- /dev/null +++ b/setup.py @@ -0,0 +1,25 @@ +import setuptools + +with open("README.rst", "r") as fh: + long_description = fh.read() + +setuptools.setup( + name="nessus_file_reader", + version="0.1.0", + author="Damian Krawczyk", + author_email="damian.krawczyk@limberduck.org", + description="nessus file reader by LimberDuck (pronounced *ˈlɪm.bɚ dʌk*) is a python module" + "created to quickly parse nessus files containing the results of scans" + "performed by using Nessus by (C) Tenable, Inc.", + long_description=long_description, + long_description_content_type="text/x-rst", + url="https://github.com/LimberDuck/nessus-file-reader", + packages=setuptools.find_packages(), + classifiers=[ + "Programming Language :: Python :: 3.6", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: OS Independent", + "Development Status :: 4 - Beta", + "Environment :: Console", + ], +)