audit-labs/audit-report
Turn audit-tools evidence packages into control-mapped, auditor-ready reports.
clone: git clone https://gitbay.org/audit-labs/audit-report.git
217d893956c0f1d4f155da392546e50f6dd5cc14
verified · cmc
author: Christian Cleberg <hello@cleberg.net> · 2026-08-06T07:11:06Z
.gitignore | 18 + CODEOWNERS | 1 + LICENSE | 674 +++++++++++++++++++++ README.md | 124 ++++ audit_report/__init__.py | 3 + audit_report/__main__.py | 6 + audit_report/catalog.py | 58 ++ audit_report/cli.py | 110 ++++ audit_report/engine.py | 119 ++++ audit_report/loader.py | 83 +++ audit_report/reporters/__init__.py | 53 ++ audit_report/reporters/html.py | 165 +++++ audit_report/reporters/json.py | 42 ++ audit_report/reporters/markdown.py | 95 +++ audit_report/rules.py | 140 +++++ audit_report/rulesets/aws.yaml | 130 ++++ audit_report/rulesets/github.yaml | 79 +++ conftest.py | 11 + pyproject.toml | 31 + requirements-dev.txt | 3 + requirements.txt | 1 + ruff.toml | 14 + .../aws_audit_acme_2026-01-01/account_security.csv | 2 + .../aws_audit_acme_2026-01-01/cloudtrail.csv | 2 + .../aws_audit_acme_2026-01-01/iam_users.csv | 3 + .../open_security_groups.csv | 3 + .../aws_audit_acme_2026-01-01/password_policy.csv | 2 + .../aws_audit_acme_2026-01-01/s3_public_access.csv | 0 .../branch_protections.csv | 3 + .../github_audit_acme_2026-01-01/org_security.csv | 2 + tests/test_engine.py | 95 +++ tests/test_loader.py | 47 ++ tests/test_reporters.py | 97 +++ tests/test_rules.py | 52 ++ 34 files changed, 2268 insertions(+) new file mode 100644 @@ -0,0 +1,18 @@ +.venv +venv + +# Python +__pycache__/ +**/__pycache__/ +*.py[cod] +*.egg-info/ +.pytest_cache/ +.ruff_cache/ +build/ +dist/ + +# Generated reports +/report/ +report.md +report.html +report.json new file mode 100644 @@ -0,0 +1 @@ +* @ccleberg @ekraai2 new file mode 100644 @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<https://www.gnu.org/licenses/>. + + 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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. new file mode 100644 @@ -0,0 +1,124 @@ +# audit-report + +[](LICENSE) +[]() + +Turns an [audit-tools](https://github.com/audit-labs/audit-tools) evidence +package into a control-mapped, auditor-ready report — Markdown, self-contained +HTML, or JSON — driven by declarative rulesets. + +`audit-tools` collects raw CSVs (IAM users, branch protections, security +groups…). `audit-report` reads that package, applies pass/fail rules, maps each +result to **SOC 2, ISO 27001, and NIST SP 800-53** controls, and produces a +report you can hand to an auditor or gate a pipeline on. + +> Like [gh-attest](https://github.com/audit-labs/gh-attest), this tool produces +> *evidence*, not a compliance verdict. A failing row means a setting is in a +> state that does not support a control; the final judgment belongs to the +> organization and its auditor. + +## Install + +```bash +git clone https://github.com/audit-labs/audit-report +cd audit-report +python -m venv .venv && source .venv/bin/activate +pip install -e . +``` + +## Usage + +Point it at a package directory produced by `audit-tools`: + +```bash +# Markdown report to stdout (platform + ruleset auto-detected from the dir name) +audit-report ./output/aws_audit_default_2026-07-29 + +# All three formats into ./report/ +audit-report ./output/github_audit_acme_2026-07-29 --format md,html,json --out report/ + +# Gate CI: exit non-zero if any high-severity check fails +audit-report ./output/aws_audit_prod_2026-07-29 --fail-on high --out report/ +``` + +You can also run it without installing: + +```bash +python -m audit_report ./output/aws_audit_default_2026-07-29 +``` + +### Options + +| Flag | Description | +| --- | --- | +| `--ruleset PATH` | Use a specific ruleset instead of the bundled one for the detected platform. | +| `--format md,html,json` | One or more output formats (default: `md`). | +| `--out DIR` | Write `report.<ext>` files into `DIR`. Without it, the first format prints to stdout. | +| `--fail-on low\|medium\|high\|none` | Exit non-zero when a failing finding meets this severity (default: `none`). | + +## What a report contains + +- **Summary** — failing / passing / not-applicable counts. +- **Control coverage matrix** — every cited control, its framework, and a + worst-wins status rolled up from the rules that reference it. One failing rule + marks the control as not fully evidenced. +- **Findings** — failures first, then by severity, each with the reason, why it + matters, remediation, and the exact evidence rows that failed. + +## Bundled rulesets + +| Platform | Package prefix | Checks include | +| --- | --- | --- | +| AWS | `aws_audit_*` | Console-user MFA, access-key rotation, root MFA & keys, password policy, open SSH, public S3, CloudTrail logging | +| GitHub | `github_audit_*` | Org 2FA, base permission, secret-scanning push protection, default-branch protection, required reviews | + +## Writing your own rules + +A ruleset is a YAML file: a `platform` and a list of `rules`. Each rule names a +CSV table, a check, the controls it maps to, and human-readable text. Point at +one with `--ruleset`. + +```yaml +platform: aws +rules: + - id: aws.iam.console-mfa + title: Console users have MFA enabled + table: iam_users # <table>.csv inside the package + severity: high # high | medium | low + controls: [SOC2:CC6.1, ISO:A.5.17, NIST:IA-2] + rationale: A console user without a second factor is one stolen password from access. + remediation: Enforce MFA for all console users, or remove their console password. + check: + type: fail_rows_where # every matching row is a failure + when: + all: + - {column: console_password, op: is_true} + - {column: mfa_enabled, op: is_false} +``` + +**Check types** + +| Type | Meaning | +| --- | --- | +| `fail_rows_where` | Each row matching `when` is a failing finding. | +| `fail_if_any_rows` | The presence of any row (optionally filtered by `when`) is a failure. | +| `require_any_row` | Passes only if at least one row satisfies `when`. | +| `assert_row` | Checks each condition in `require` against the first row of a single-row config table. | + +**Condition language** — a condition is a leaf `{column, op, value}`, or one of +`{all: [...]}`, `{any: [...]}`, `{not: ...}`. Operators: `equals`, `not_equals`, +`is_true`, `is_false`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `empty`, +`not_empty`. Control codes referenced by a rule must exist in +[`audit_report/catalog.py`](audit_report/catalog.py). + +## Development + +```bash +pip install -e ".[dev]" +pytest # run from the project root +ruff check . +``` + +## License + +GPL-3.0-or-later. See [LICENSE](LICENSE). new file mode 100644 @@ -0,0 +1,3 @@ +"""audit-report — turn audit-tools evidence packages into control-mapped reports.""" + +__version__ = "0.1.0" new file mode 100644 @@ -0,0 +1,6 @@ +"""Enable ``python -m audit_report``.""" + +from .cli import main + +if __name__ == "__main__": + raise SystemExit(main()) new file mode 100644 @@ -0,0 +1,58 @@ +"""Control catalog. + +A small, plain-language reference for every control code a ruleset may cite. +Control codes are written as ``FRAMEWORK:CODE`` (for example ``SOC2:CC6.1``). +The catalog is deliberately not exhaustive — it covers the codes the bundled +rulesets actually reference. Adding a framework means adding its codes here and +citing them from a ruleset. + +Like gh-attest, this tool produces *evidence*, not a compliance verdict: a +mapping says a signal is relevant to a control, not that the control is met. +""" + +# framework code -> human-readable name +FRAMEWORKS = { + "SOC2": "SOC 2 (Trust Services Criteria)", + "ISO": "ISO/IEC 27001:2022 Annex A", + "NIST": "NIST SP 800-53 Rev. 5", +} + +# "FRAMEWORK:CODE" -> one-line description of the control +CONTROLS = { + # SOC 2 Trust Services Criteria + "SOC2:CC6.1": "Logical access security — restrict access to protected information assets.", + "SOC2:CC6.2": "Register and authorize new users before granting access.", + "SOC2:CC6.3": "Manage access rights based on roles and least privilege.", + "SOC2:CC6.6": "Restrict access from outside the system boundary.", + "SOC2:CC6.7": "Restrict the transmission and movement of information.", + "SOC2:CC7.1": "Detect and monitor for new vulnerabilities and misconfigurations.", + "SOC2:CC7.2": "Monitor system components for anomalies and security events.", + "SOC2:CC8.1": "Authorize, design, and track changes to infrastructure and software.", + # ISO/IEC 27001:2022 Annex A + "ISO:A.5.15": "Access control — rules based on business and security requirements.", + "ISO:A.5.17": "Authentication information — management of secrets and MFA.", + "ISO:A.5.18": "Access rights — provisioning, review, and removal.", + "ISO:A.8.2": "Privileged access rights — restricted and managed.", + "ISO:A.8.9": "Configuration management — secure baseline configuration.", + "ISO:A.8.15": "Logging — record events for monitoring and investigation.", + "ISO:A.8.20": "Network security — securing networks and network services.", + "ISO:A.8.32": "Change management — control changes to information systems.", + # NIST SP 800-53 Rev. 5 + "NIST:AC-2": "Account management — establish, review, and disable accounts.", + "NIST:AC-6": "Least privilege — authorize the minimum access necessary.", + "NIST:AU-2": "Event logging — determine and record auditable events.", + "NIST:CM-6": "Configuration settings — establish and enforce secure settings.", + "NIST:IA-2": "Identification and authentication — multifactor for accounts.", + "NIST:IA-5": "Authenticator management — password strength and lifecycle.", + "NIST:SC-7": "Boundary protection — control communications at boundaries.", +} + + +def describe(control: str) -> str: + """Return the description for a control code, or a placeholder if unknown.""" + return CONTROLS.get(control, "(no description on file)") + + +def framework_of(control: str) -> str: + """Return the framework short code for a control code (text before ':').""" + return control.split(":", 1)[0] new file mode 100644 @@ -0,0 +1,110 @@ +"""Command-line entry point for audit-report.""" + +from __future__ import annotations + +import argparse +import sys +from pathlib import Path + +from . import __version__, reporters +from .engine import FAIL, evaluate +from .loader import load_package +from .rules import load_ruleset + +# Bundled rulesets ship inside the package, one per platform. +_RULESET_DIR = Path(__file__).resolve().parent / "rulesets" + +_SEVERITY_ORDER = {"low": 0, "medium": 1, "high": 2} + + +def _default_ruleset(platform: str) -> Path: + candidate = _RULESET_DIR / f"{platform}.yaml" + if not candidate.exists(): + raise SystemExit( + f"error: no bundled ruleset for platform '{platform}'. " + f"Pass one with --ruleset. Available: " + f"{', '.join(p.stem for p in sorted(_RULESET_DIR.glob('*.yaml'))) or 'none'}" + ) + return candidate + + +def _parse_args(argv: list[str]) -> argparse.Namespace: + parser = argparse.ArgumentParser( + prog="audit-report", + description="Turn an audit-tools evidence package into a control-mapped report.", + ) + parser.add_argument("package", help="path to an audit-tools output package directory") + parser.add_argument( + "--ruleset", + help="path to a ruleset YAML (default: bundled ruleset for the detected platform)", + ) + parser.add_argument( + "--format", + default="md", + help="comma-separated output formats: md, html, json (default: md)", + ) + parser.add_argument( + "--out", + help="directory to write report files into (default: print Markdown to stdout)", + ) + parser.add_argument( + "--fail-on", + choices=["low", "medium", "high", "none"], + default="none", + help="exit non-zero if any finding fails at or above this severity (default: none)", + ) + parser.add_argument("--version", action="version", version=f"audit-report {__version__}") + return parser.parse_args(argv) + + +def _exit_code(findings, threshold: str) -> int: + if threshold == "none": + return 0 + floor = _SEVERITY_ORDER[threshold] + breached = any( + f.status == FAIL and _SEVERITY_ORDER.get(f.rule.severity, 1) >= floor + for f in findings + ) + return 1 if breached else 0 + + +def main(argv: list[str] | None = None) -> int: + args = _parse_args(argv if argv is not None else sys.argv[1:]) + + try: + package = load_package(args.package) + except (FileNotFoundError, ValueError) as exc: + print(f"error: {exc}", file=sys.stderr) + return 2 + + ruleset_path = Path(args.ruleset) if args.ruleset else _default_ruleset(package.platform) + ruleset = load_ruleset(ruleset_path) + + findings = evaluate(package, ruleset) + report = reporters.build_report(package, findings) + formats = [f.strip() for f in args.format.split(",") if f.strip()] + + if args.out: + out_dir = Path(args.out) + out_dir.mkdir(parents=True, exist_ok=True) + for fmt in formats: + content = reporters.render(report, fmt) + dest = out_dir / f"report.{reporters.EXTENSIONS[fmt]}" + dest.write_text(content, encoding="utf-8") + print(f"wrote {dest}", file=sys.stderr) + else: + # No --out: emit the first requested format to stdout. + print(reporters.render(report, formats[0]), end="") + + counts = report.counts + print( + f"{package.platform}/{package.subject}: " + f"{counts[FAIL]} failing, {counts['pass']} passing, " + f"{counts['not_applicable']} n/a", + file=sys.stderr, + ) + return _exit_code(findings, args.fail_on) + + +if __name__ == "__main__": + raise SystemExit(main()) new file mode 100644 @@ -0,0 +1,119 @@ +"""Evaluate a ruleset against a loaded package to produce findings.""" + +from __future__ import annotations + +from dataclasses import dataclass, field + +from .loader import Package, Row +from .rules import Rule, Ruleset, match + +PASS = "pass" +FAIL = "fail" +NOT_APPLICABLE = "not_applicable" + + +@dataclass +class Finding: + """The outcome of evaluating one rule against one package.""" + + rule: Rule + status: str + reason: str + evidence: list[Row] = field(default_factory=list) + + @property + def controls(self) -> list[str]: + return self.rule.controls + + +def _evaluate_rule(rule: Rule, package: Package) -> Finding: + if not package.has(rule.table): + return Finding(rule, NOT_APPLICABLE, f"table '{rule.table}' not in package") + + rows = package.table(rule.table) + check = rule.check + ctype = check["type"] + + if ctype == "assert_row": + return _assert_row(rule, rows) + + if ctype == "require_any_row": + return _require_any_row(rule, rows) + + # fail_rows_where / fail_if_any_rows both scan rows for failures. + condition = check.get("when") + if ctype == "fail_if_any_rows" and condition is None: + failing = list(rows) + else: + # fail_rows_where requires a condition; fail_if_any_rows may filter too. + if condition is None: + raise ValueError(f"{rule.id}: check needs a 'when' condition") + failing = [r for r in rows if match(condition, r)] + + if failing: + noun = "row" if len(failing) == 1 else "rows" + return Finding(rule, FAIL, f"{len(failing)} {noun} failed the check", failing) + + # A present-but-empty table means the scan found nothing to fault — the + # absence of bad rows is a pass (e.g. no publicly readable buckets). + if not rows: + return Finding(rule, PASS, "no rows present — no violations found") + return Finding(rule, PASS, f"all {len(rows)} rows passed the check") + + +def _assert_row(rule: Rule, rows: list[Row]) -> Finding: + """Assert conditions against a single-row configuration table.""" + if not rows: + return Finding(rule, NOT_APPLICABLE, f"table '{rule.table}' is empty") + + row = rows[0] + failed = [req for req in rule.check.get("require", []) if not match(req, row)] + if failed: + columns = ", ".join(req.get("column", "?") for req in failed) + return Finding(rule, FAIL, f"configuration failed on: {columns}", [row]) + return Finding(rule, PASS, "configuration meets all requirements") + + +def _require_any_row(rule: Rule, rows: list[Row]) -> Finding: + """Pass if at least one row satisfies the condition; fail otherwise.""" + condition = rule.check.get("when") + if condition is None: + raise ValueError(f"{rule.id}: require_any_row needs a 'when' condition") + if any(match(condition, row) for row in rows): + return Finding(rule, PASS, "at least one row satisfies the requirement") + reason = "no row satisfies the requirement" if rows else f"table '{rule.table}' is empty" + return Finding(rule, FAIL, reason, rows) + + +def evaluate(package: Package, ruleset: Ruleset) -> list[Finding]: + """Run every rule in *ruleset* against *package*.""" + return [_evaluate_rule(rule, package) for rule in ruleset.rules] + + +def summarize(findings: list[Finding]) -> dict[str, int]: + """Count findings by status.""" + counts = {PASS: 0, FAIL: 0, NOT_APPLICABLE: 0} + for finding in findings: + counts[finding.status] += 1 + return counts + + +# Worst-wins ordering when rolling several findings up to one control. +_STATUS_RANK = {FAIL: 2, PASS: 1, NOT_APPLICABLE: 0} + + +def control_coverage(findings: list[Finding]) -> dict[str, dict]: + """Roll findings up to a per-control view. + + Returns ``{control: {"status": ..., "rules": [rule_id, ...]}}`` where a + control's status is the worst status among the rules that cite it — one + failing rule means the control is not fully evidenced. + """ + coverage: dict[str, dict] = {} + for finding in findings: + for control in finding.controls: + entry = coverage.setdefault(control, {"status": NOT_APPLICABLE, "rules": []}) + entry["rules"].append(finding.rule.id) + if _STATUS_RANK[finding.status] > _STATUS_RANK[entry["status"]]: + entry["status"] = finding.status + return dict(sorted(coverage.items())) new file mode 100644 @@ -0,0 +1,83 @@ +"""Load an audit-tools evidence package from disk. + +An evidence package is a directory of CSV files produced by audit-tools, named +like ``github_audit_<org>_<date>/`` or ``aws_audit_<profile>_<date>/``. Each CSV +becomes a *table* keyed by its filename stem (``iam_users.csv`` -> ``iam_users``). +""" + +from __future__ import annotations + +import csv +from dataclasses import dataclass, field +from pathlib import Path + +# Directory-name prefixes audit-tools uses, mapped to a platform key. +_PLATFORM_PREFIXES = { + "aws_audit_": "aws", + "github_audit_": "github", + "gitlab_audit_": "gitlab", +} + +Row = dict[str, str] +Table = list[Row] + + +@dataclass +class Package: + """A loaded evidence package.""" + + path: Path + platform: str + subject: str # the org / profile the audit was run against + tables: dict[str, Table] = field(default_factory=dict) + + def table(self, name: str) -> Table: + """Return a table by name, or an empty list if it is absent.""" + return self.tables.get(name, []) + + def has(self, name: str) -> bool: + """True if the named CSV was present in the package.""" + return name in self.tables + + +def detect_platform(dir_name: str) -> tuple[str, str]: + """Infer ``(platform, subject)`` from a package directory name. + + ``github_audit_audit-labs_2026-07-29`` -> ``("github", "audit-labs")``. + Falls back to ``("unknown", <dir_name>)`` when no prefix matches. + """ + for prefix, platform in _PLATFORM_PREFIXES.items(): + if dir_name.startswith(prefix): + rest = dir_name[len(prefix) :] + # Strip a trailing ISO date (…_YYYY-MM-DD) to recover the subject. + parts = rest.rsplit("_", 1) + subject = parts[0] if len(parts) == 2 and _looks_like_date(parts[1]) else rest + return platform, subject or "unknown" + return "unknown", dir_name + + +def _looks_like_date(token: str) -> bool: + bits = token.split("-") + return len(bits) == 3 and all(b.isdigit() for b in bits) + + +def load_package(path: str | Path) -> Package: + """Load every ``*.csv`` in *path* into a :class:`Package`. + + Raises ``FileNotFoundError`` if the directory does not exist and + ``ValueError`` if it contains no CSV files. + """ + directory = Path(path) + if not directory.is_dir(): + raise FileNotFoundError(f"not a directory: {directory}") + + platform, subject = detect_platform(directory.name) + tables: dict[str, Table] = {} + for csv_path in sorted(directory.glob("*.csv")): + with csv_path.open(newline="", encoding="utf-8") as handle: + tables[csv_path.stem] = list(csv.DictReader(handle)) + + if not tables: + raise ValueError(f"no CSV files found in {directory}") + + return Package(path=directory, platform=platform, subject=subject, tables=tables) new file mode 100644 @@ -0,0 +1,53 @@ +"""Report renderers. Each takes a :class:`Report` and returns a string.""" + +from __future__ import annotations + +from dataclasses import dataclass +from datetime import datetime, timezone + +from ..engine import Finding, control_coverage, summarize +from ..loader import Package +from . import html as _html +from . import json as _json +from . import markdown as _markdown + + +@dataclass +class Report: + """Everything a renderer needs: the package, findings, and rollups.""" + + package: Package + findings: list[Finding] + generated_at: str + + @property + def counts(self) -> dict[str, int]: + return summarize(self.findings) + + @property + def coverage(self) -> dict[str, dict]: + return control_coverage(self.findings) + + +def build_report(package: Package, findings: list[Finding]) -> Report: + """Assemble a :class:`Report` with a UTC generation timestamp.""" + stamp = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M UTC") + return Report(package=package, findings=findings, generated_at=stamp) + + +RENDERERS = { + "md": _markdown.render, + "html": _html.render, + "json": _json.render, +} + +# File extension per format (md and markdown both write .md). +EXTENSIONS = {"md": "md", "html": "html", "json": "json"} + + +def render(report: Report, fmt: str) -> str: + """Render *report* in the named format ('md', 'html', or 'json').""" + try: + return RENDERERS[fmt](report) + except KeyError: + raise ValueError(f"unknown format: {fmt!r}") from None new file mode 100644 @@ -0,0 +1,165 @@ +"""HTML renderer — a self-contained, printable evidence report. + +No external assets: all CSS is inlined so the file can be attached to an audit +workpaper and opened anywhere, including offline. +""" + +from __future__ import annotations + +from html import escape +from typing import TYPE_CHECKING + +from .. import catalog +from ..engine import FAIL, NOT_APPLICABLE, PASS + +if TYPE_CHECKING: + from . import Report + +_STATUS_LABEL = {PASS: "PASS", FAIL: "FAIL", NOT_APPLICABLE: "N/A"} +_STATUS_CLASS = {PASS: "pass", FAIL: "fail", NOT_APPLICABLE: "na"} +_SEVERITY_ORDER = {"high": 0, "medium": 1, "low": 2} + +_CSS = """ +:root { color-scheme: light dark; } +* { box-sizing: border-box; } +body { font-family: -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif; + margin: 0; padding: 2rem; line-height: 1.5; color: #1a1a1a; background: #fff; } +main { max-width: 60rem; margin: 0 auto; } +h1 { margin: 0 0 .25rem; font-size: 1.6rem; } +h2 { margin: 2rem 0 .75rem; font-size: 1.25rem; border-bottom: 2px solid #e5e5e5; padding-bottom: .25rem; } +.meta { color: #555; font-size: .9rem; margin: 0 0 1rem; } +.meta code { background: #f2f2f2; padding: .05rem .3rem; border-radius: 3px; } +.note { background: #f7f7f9; border-left: 3px solid #b9b9c6; padding: .6rem .9rem; + font-size: .9rem; color: #444; border-radius: 0 4px 4px 0; } +table { border-collapse: collapse; width: 100%; font-size: .85rem; margin: .5rem 0; } +th, td { border: 1px solid #e0e0e0; padding: .35rem .5rem; text-align: left; vertical-align: top; } +th { background: #f5f5f7; } +.badge { display: inline-block; font-weight: 700; font-size: .72rem; letter-spacing: .03em; + padding: .12rem .5rem; border-radius: 999px; } +.badge.pass { background: #e5f6ea; color: #1a7f37; } +.badge.fail { background: #fdeaea; color: #c1272d; } +.badge.na { background: #eee; color: #666; } +.finding { border: 1px solid #e5e5e5; border-radius: 6px; padding: 1rem 1.1rem; margin: .8rem 0; } +.finding.fail { border-left: 4px solid #c1272d; } +.finding.pass { border-left: 4px solid #1a7f37; } +.finding.na { border-left: 4px solid #bbb; } +.finding h3 { margin: 0 0 .5rem; font-size: 1.05rem; display: flex; gap: .5rem; align-items: center; } +.finding dl { display: grid; grid-template-columns: max-content 1fr; gap: .2rem .8rem; margin: .4rem 0 0; font-size: .9rem; } +.finding dt { color: #666; font-weight: 600; } +.finding dd { margin: 0; } +.summary-pills span { display: inline-block; margin-right: .5rem; font-weight: 600; } +footer { margin-top: 3rem; font-size: .8rem; color: #888; border-top: 1px solid #eee; padding-top: .75rem; } +@media (prefers-color-scheme: dark) { + body { color: #e6e6e6; background: #16171a; } + h2 { border-color: #333; } + .meta { color: #aaa; } .meta code { background: #26272b; } + .note { background: #1e1f24; border-color: #444; color: #bbb; } + th, td { border-color: #333; } th { background: #202126; } + .finding { border-color: #2d2e33; } + .badge.pass { background: #12321d; color: #4ac36a; } + .badge.fail { background: #3a1416; color: #ff6b70; } + .badge.na { background: #26272b; color: #999; } + footer { border-color: #2a2b30; } +} +""" + + +def _badge(status: str) -> str: + return f'<span class="badge {_STATUS_CLASS[status]}">{_STATUS_LABEL[status]}</span>' + + +def _evidence_table(rows: list[dict[str, str]]) -> str: + shown = rows[:10] + headers = list(shown[0].keys()) + head = "".join(f"<th>{escape(h)}</th>" for h in headers) + body = "".join( + "<tr>" + "".join(f"<td>{escape(str(r.get(h, '')))}</td>" for h in headers) + "</tr>" + for r in shown + ) + extra = ( + f"<p class='meta'>+{len(rows) - len(shown)} more row(s) omitted.</p>" + if len(rows) > len(shown) + else "" + ) + return f"<table><thead><tr>{head}</tr></thead><tbody>{body}</tbody></table>{extra}" + + +def render(report: Report) -> str: + pkg = report.package + counts = report.counts + parts: list[str] = [] + + parts.append(f"<h1>Evidence Report — {escape(pkg.subject)}</h1>") + parts.append( + f"<p class='meta'>Platform <code>{escape(pkg.platform)}</code> · " + f"Source <code>{escape(pkg.path.name)}</code> · " + f"Generated {escape(report.generated_at)}</p>" + ) + parts.append( + "<p class='summary-pills'>" + f"<span>{_badge(FAIL)} {counts[FAIL]} failing</span>" + f"<span>{_badge(PASS)} {counts[PASS]} passing</span>" + f"<span>{_badge(NOT_APPLICABLE)} {counts[NOT_APPLICABLE]} not applicable</span>" + "</p>" + ) + parts.append( + "<p class='note'>This report presents <strong>evidence</strong>, not a " + "compliance verdict. A failing row means a setting is in a state that does " + "not support a control; the final judgment belongs to the organization and " + "its auditor.</p>" + ) + + # Coverage matrix. + parts.append("<h2>Control coverage</h2>") + cov_rows = "".join( + f"<tr><td>{escape(control)}</td><td>{escape(catalog.framework_of(control))}</td>" + f"<td>{_badge(entry['status'])}</td>" + f"<td><code>{escape(', '.join(entry['rules']))}</code></td>" + f"<td>{escape(catalog.describe(control))}</td></tr>" + for control, entry in report.coverage.items() + ) + parts.append( + "<table><thead><tr><th>Control</th><th>Framework</th><th>Status</th>" + f"<th>Checked by</th><th>Description</th></tr></thead><tbody>{cov_rows}</tbody></table>" + ) + + # Findings. + parts.append("<h2>Findings</h2>") + ordered = sorted( + report.findings, + key=lambda f: (f.status != FAIL, _SEVERITY_ORDER.get(f.rule.severity, 1)), + ) + for finding in ordered: + rule = finding.rule + rows = [ + f"<dt>Rule</dt><dd><code>{escape(rule.id)}</code> · {escape(rule.severity)}</dd>", + f"<dt>Controls</dt><dd>{escape(', '.join(rule.controls) or '—')}</dd>", + f"<dt>Result</dt><dd>{escape(finding.reason)}</dd>", + ] + if rule.rationale: + rows.append(f"<dt>Why it matters</dt><dd>{escape(rule.rationale.strip())}</dd>") + if finding.status == FAIL and rule.remediation: + rows.append(f"<dt>Remediation</dt><dd>{escape(rule.remediation.strip())}</dd>") + evidence = ( + _evidence_table(finding.evidence) + if finding.status == FAIL and finding.evidence + else "" + ) + parts.append( + f"<div class='finding {_STATUS_CLASS[finding.status]}'>" + f"<h3>{_badge(finding.status)} {escape(rule.title)}</h3>" + f"<dl>{''.join(rows)}</dl>{evidence}</div>" + ) + + parts.append( + "<footer>Generated by audit-report · Audit Labs · " + "evidence, not a verdict.</footer>" + ) + + body = "\n".join(parts) + return ( + "<!doctype html><html lang='en'><head><meta charset='utf-8'>" + "<meta name='viewport' content='width=device-width, initial-scale=1'>" + f"<title>Evidence Report — {escape(pkg.subject)}</title>" + f"<style>{_CSS}</style></head><body><main>{body}</main></body></html>\n" + ) new file mode 100644 @@ -0,0 +1,42 @@ +"""JSON renderer — a machine-readable record of the same findings. + +Useful for feeding results into a dashboard, a ticket pipeline, or a diff +between two audit runs. +""" + +from __future__ import annotations + +import json as _json +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from . import Report + + +def to_dict(report: Report) -> dict: + """Serialize a report to a plain dict (stable key order for diffing).""" + pkg = report.package + return { + "subject": pkg.subject, + "platform": pkg.platform, + "source_package": pkg.path.name, + "generated_at": report.generated_at, + "summary": report.counts, + "coverage": report.coverage, + "findings": [ + { + "id": f.rule.id, + "title": f.rule.title, + "status": f.status, + "severity": f.rule.severity, + "controls": f.rule.controls, + "reason": f.reason, + "evidence": f.evidence, + } + for f in report.findings + ], + } + + +def render(report: Report) -> str: + return _json.dumps(to_dict(report), indent=2, sort_keys=False) + "\n" new file mode 100644 @@ -0,0 +1,95 @@ +"""Markdown renderer — the auditor-facing evidence report.""" + +from __future__ import annotations + +from typing import TYPE_CHECKING + +from .. import catalog +from ..engine import FAIL, NOT_APPLICABLE, PASS + +if TYPE_CHECKING: + from . import Report + +_STATUS_LABEL = {PASS: "PASS", FAIL: "FAIL", NOT_APPLICABLE: "N/A"} +_SEVERITY_ORDER = {"high": 0, "medium": 1, "low": 2} + + +def _evidence_table(rows: list[dict[str, str]]) -> list[str]: + """Render up to a handful of evidence rows as a Markdown table.""" + if not rows: + return [] + shown = rows[:10] + headers = list(shown[0].keys()) + lines = [ + "| " + " | ".join(headers) + " |", + "| " + " | ".join("---" for _ in headers) + " |", + ] + for row in shown: + lines.append("| " + " | ".join(str(row.get(h, "")) for h in headers) + " |") + if len(rows) > len(shown): + lines.append(f"\n_+{len(rows) - len(shown)} more row(s) omitted._") + return lines + + +def render(report: Report) -> str: + pkg = report.package + counts = report.counts + out: list[str] = [] + + out.append(f"# Evidence Report — {pkg.subject}") + out.append("") + out.append(f"- **Platform:** {pkg.platform}") + out.append(f"- **Subject:** {pkg.subject}") + out.append(f"- **Source package:** `{pkg.path.name}`") + out.append(f"- **Generated:** {report.generated_at}") + out.append( + f"- **Result:** {counts[FAIL]} failing · {counts[PASS]} passing · " + f"{counts[NOT_APPLICABLE]} not applicable" + ) + out.append("") + out.append( + "> This report presents *evidence*, not a compliance verdict. A failing " + "row means a setting is in a state that does not support a control; the " + "final judgment belongs to the organization and its auditor." + ) + out.append("") + + # Control coverage matrix. + out.append("## Control coverage") + out.append("") + out.append("| Control | Framework | Status | Checked by | Description |") + out.append("| --- | --- | --- | --- | --- |") + for control, entry in report.coverage.items(): + out.append( + f"| {control} | {catalog.framework_of(control)} | " + f"{_STATUS_LABEL[entry['status']]} | {', '.join(entry['rules'])} | " + f"{catalog.describe(control)} |" + ) + out.append("") + + # Findings, failures first then by severity. + out.append("## Findings") + out.append("") + ordered = sorted( + report.findings, + key=lambda f: (f.status != FAIL, _SEVERITY_ORDER.get(f.rule.severity, 1)), + ) + for finding in ordered: + rule = finding.rule + out.append(f"### {_STATUS_LABEL[finding.status]} · {rule.title}") + out.append("") + out.append(f"- **Rule:** `{rule.id}` · **Severity:** {rule.severity}") + out.append(f"- **Controls:** {', '.join(rule.controls) or '—'}") + out.append(f"- **Result:** {finding.reason}") + if rule.rationale: + out.append(f"- **Why it matters:** {rule.rationale.strip()}") + if finding.status == FAIL and rule.remediation: + out.append(f"- **Remediation:** {rule.remediation.strip()}") + out.append("") + if finding.status == FAIL and finding.evidence: + out.append("**Evidence:**") + out.append("") + out.extend(_evidence_table(finding.evidence)) + out.append("") + + return "\n".join(out).rstrip() + "\n" new file mode 100644 @@ -0,0 +1,140 @@ +"""Rule model and the small condition language rulesets are written in. + +A **ruleset** is a YAML file: a platform name plus a list of rules. Each rule +names a table, a check, the controls it maps to, and human text. Checks are +evaluated by :mod:`audit_report.engine`. + +The condition language is intentionally tiny. A *condition* is one of: + +* a leaf ``{column, op, value}`` — test one column of a row +* ``{all: [cond, ...]}`` — every sub-condition holds +* ``{any: [cond, ...]}`` — at least one holds +* ``{not: cond}`` — the sub-condition does not hold + +Operators (``op``): ``equals``, ``not_equals``, ``is_true``, ``is_false``, +``in``, ``not_in``, ``gt``, ``gte``, ``lt``, ``lte``, ``empty``, ``not_empty``. +""" + +from __future__ import annotations + +from dataclasses import dataclass, field +from pathlib import Path + +import yaml + +_TRUTHY = {"true", "yes", "1", "y", "t", "enabled", "on"} +_FALSY = {"false", "no", "0", "n", "f", "disabled", "off", ""} + +VALID_CHECK_TYPES = { + "fail_rows_where", + "fail_if_any_rows", + "assert_row", + "require_any_row", +} + + +@dataclass +class Rule: + """A single control check declared in a ruleset.""" + + id: str + title: str + table: str + check: dict + severity: str = "medium" + controls: list[str] = field(default_factory=list) + rationale: str = "" + remediation: str = "" + + +@dataclass +class Ruleset: + """A named collection of rules for one platform.""" + + platform: str + rules: list[Rule] + + +def _as_number(value: str) -> float | None: + try: + return float(value) + except (TypeError, ValueError): + return None + + +def match(condition: dict, row: dict[str, str]) -> bool: + """Return True if *condition* holds for *row*. + + Raises ``ValueError`` on a malformed condition so ruleset bugs surface + loudly rather than silently evaluating to False. + """ + if "all" in condition: + return all(match(c, row) for c in condition["all"]) + if "any" in condition: + return any(match(c, row) for c in condition["any"]) + if "not" in condition: + return not match(condition["not"], row) + + column = condition.get("column") + op = condition.get("op") + if column is None or op is None: + raise ValueError(f"malformed condition: {condition!r}") + + raw = row.get(column, "") + value = condition.get("value") + norm = raw.strip().lower() + + if op == "equals": + return norm == str(value).strip().lower() + if op == "not_equals": + return norm != str(value).strip().lower() + if op == "is_true": + return norm in _TRUTHY + if op == "is_false": + return norm in _FALSY + if op == "empty": + return raw.strip() == "" + if op == "not_empty": + return raw.strip() != "" + if op in ("in", "not_in"): + choices = {str(v).strip().lower() for v in (value or [])} + return (norm in choices) if op == "in" else (norm not in choices) + if op in ("gt", "gte", "lt", "lte"): + left, right = _as_number(raw), _as_number(str(value)) + if left is None or right is None: + return False + return { + "gt": left > right, + "gte": left >= right, + "lt": left < right, + "lte": left <= right, + }[op] + + raise ValueError(f"unknown operator: {op!r}") + + +def load_ruleset(path: str | Path) -> Ruleset: + """Parse a ruleset YAML file into a :class:`Ruleset`, validating each rule.""" + data = yaml.safe_load(Path(path).read_text(encoding="utf-8")) or {} + platform = data.get("platform") + if not platform: + raise ValueError(f"{path}: ruleset is missing a 'platform'") + + rules: list[Rule] = [] + for entry in data.get("rules", []): + rule = Rule( + id=entry["id"], + title=entry["title"], + table=entry["table"], + check=entry["check"], + severity=entry.get("severity", "medium"), + controls=entry.get("controls", []), + rationale=entry.get("rationale", ""), + remediation=entry.get("remediation", ""), + ) + check_type = rule.check.get("type") + if check_type not in VALID_CHECK_TYPES: + raise ValueError(f"{rule.id}: unknown check type {check_type!r}") + rules.append(rule) + + return Ruleset(platform=platform, rules=rules) new file mode 100644 @@ -0,0 +1,130 @@ +# Ruleset: AWS +# +# Evaluated against an audit-tools AWS evidence package +# (aws_audit_<profile>_<date>/). Each rule names a CSV table, a check, and the +# controls the signal is offered as evidence for. A "fail" means a setting is in +# a state that does NOT support the control — an auditor still owns the verdict. +platform: aws + +rules: + - id: aws.iam.console-mfa + title: Console users have MFA enabled + table: iam_users + severity: high + controls: [SOC2:CC6.1, ISO:A.5.17, NIST:IA-2] + rationale: > + A user who can sign in to the console without a second factor is a single + stolen password away from account access. MFA is the baseline control for + interactive human access. + remediation: Enforce MFA for all IAM users with console access, or remove their console password. + check: + type: fail_rows_where + when: + all: + - {column: console_password, op: is_true} + - {column: mfa_enabled, op: is_false} + + - id: aws.iam.key-rotation + title: Access keys are rotated within 90 days + table: iam_users + severity: medium + controls: [ISO:A.5.17, NIST:IA-5] + rationale: > + Long-lived access keys widen the window in which a leaked credential is + useful. Rotating keys bounds that exposure. + remediation: Rotate or delete access keys older than 90 days. + check: + type: fail_rows_where + when: {column: oldest_key_age_days, op: gt, value: 90} + + - id: aws.root.mfa + title: Root account has MFA enabled + table: account_security + severity: high + controls: [SOC2:CC6.1, ISO:A.8.2, NIST:IA-2] + rationale: > + The root account can perform every action in the account and cannot be + restricted by IAM policy. MFA on root is a foundational control. + remediation: Enable a hardware or virtual MFA device on the root user. + check: + type: assert_row + require: + - {column: root_mfa_enabled, op: is_true} + + - id: aws.root.no-access-keys + title: Root account has no access keys + table: account_security + severity: high + controls: [SOC2:CC6.1, ISO:A.8.2, NIST:AC-6] + rationale: > + Programmatic root access keys are unnecessary and dangerous — anything + root can do should be done through named, least-privilege identities. + remediation: Delete all access keys on the root user. + check: + type: assert_row + require: + - {column: root_access_keys_present, op: is_false} + + - id: aws.iam.password-policy + title: Account password policy meets baseline strength + table: password_policy + severity: medium + controls: [ISO:A.5.17, NIST:IA-5] + rationale: > + A weak password policy undermines every password-based control. The + baseline here — length, complexity, and rotation — reflects common + hardening guidance. + remediation: Set a minimum length of 14, require symbols and numbers, and cap password age at 90 days. + check: + type: assert_row + require: + - {column: minimum_length, op: gte, value: 14} + - {column: require_symbols, op: is_true} + - {column: require_numbers, op: is_true} + - {column: max_age_days, op: lte, value: 90} + + - id: aws.network.no-open-ssh + title: No security group exposes SSH to the internet + table: open_security_groups + severity: high + controls: [SOC2:CC6.6, ISO:A.8.20, NIST:SC-7] + rationale: > + SSH (port 22) reachable from 0.0.0.0/0 invites credential-stuffing and + exploitation of the host directly from the public internet. + remediation: Restrict inbound SSH to known CIDR ranges or a bastion, or use SSM Session Manager. + check: + type: fail_rows_where + when: + all: + - {column: open_to, op: equals, value: 0.0.0.0/0} + - {column: from_port, op: lte, value: 22} + - {column: to_port, op: gte, value: 22} + + - id: aws.s3.no-public-access + title: No S3 bucket allows public access + table: s3_public_access + severity: high + controls: [SOC2:CC6.6, ISO:A.8.20, NIST:SC-7] + rationale: > + Publicly readable or writable buckets are a leading cause of data + exposure. audit-tools lists only buckets that permit public access, so any + row here is a finding. + remediation: Enable Block Public Access at the account and bucket level; remove public bucket policies and ACLs. + check: + type: fail_if_any_rows + + - id: aws.cloudtrail.logging + title: A multi-region CloudTrail is actively logging + table: cloudtrail + severity: high + controls: [SOC2:CC7.2, ISO:A.8.15, NIST:AU-2] + rationale: > + Without an active trail there is no reliable record of account activity — + the evidence auditors and responders rely on simply does not exist. + remediation: Enable a multi-region CloudTrail with log file validation and confirm it is logging. + check: + type: require_any_row + when: + all: + - {column: is_logging, op: is_true} + - {column: multi_region, op: is_true} new file mode 100644 @@ -0,0 +1,79 @@ +# Ruleset: GitHub +# +# Evaluated against an audit-tools GitHub evidence package +# (github_audit_<org>_<date>/). Complements gh-attest: same spirit of mapping +# GitHub signals to controls, applied offline to a captured CSV package. +platform: github + +rules: + - id: github.org.require-2fa + title: Organization requires two-factor authentication + table: org_security + severity: high + controls: [SOC2:CC6.1, ISO:A.5.17, NIST:IA-2] + rationale: > + Org-enforced 2FA raises the floor for every member at once. Without it, a + single member with a weak or reused password is an org-wide risk. + remediation: Enable "Require two-factor authentication" in the organization security settings. + check: + type: assert_row + require: + - {column: two_factor_required, op: is_true} + + - id: github.org.default-permission + title: Base repository permission is read or less + table: org_security + severity: medium + controls: [SOC2:CC6.3, ISO:A.5.15, NIST:AC-6] + rationale: > + A permissive base permission (write/admin for all members) violates least + privilege by granting broad access that should be explicit. + remediation: Set the organization base permission to "read" or "none" and grant write/admin per team. + check: + type: assert_row + require: + - {column: default_repo_permission, op: in, value: [read, none]} + + - id: github.org.secret-scanning + title: Secret scanning push protection is on for new repos + table: org_security + severity: medium + controls: [SOC2:CC7.1, ISO:A.5.17, NIST:CM-6] + rationale: > + Push protection stops secrets from entering history in the first place, + which is far cheaper than rotating a leaked credential after the fact. + remediation: Enable secret scanning and push protection for new repositories at the org level. + check: + type: assert_row + require: + - {column: secret_scanning_push_protection_for_new_repos, op: is_true} + + - id: github.branch.default-protected + title: Default branches are protected + table: branch_protections + severity: high + controls: [SOC2:CC8.1, ISO:A.8.32, NIST:CM-6] + rationale: > + An unprotected default branch can be force-pushed or have its history + rewritten with no review — the change-management trail auditors expect is + absent. + remediation: Add a branch protection rule or ruleset covering the default branch of each repository. + check: + type: fail_rows_where + when: {column: protected, op: is_false} + + - id: github.branch.require-reviews + title: Protected branches require at least one review + table: branch_protections + severity: medium + controls: [SOC2:CC8.1, ISO:A.8.32, NIST:CM-6] + rationale: > + Required review is the core segregation-of-duties control in the SDLC: no + change reaches the default branch without a second person approving it. + remediation: Require at least one approving review on the default branch. + check: + type: fail_rows_where + when: + all: + - {column: protected, op: is_true} + - {column: required_reviews, op: lt, value: 1} new file mode 100644 @@ -0,0 +1,11 @@ +"""Ensure the project root is importable and tests run from it. + +Tests reference the bundled rulesets by the relative path +``audit_report/rulesets``, so pytest must be invoked from the project root. +This file's location pins that root for import resolution. +""" + +import sys +from pathlib import Path + +sys.path.insert(0, str(Path(__file__).parent)) new file mode 100644 @@ -0,0 +1,31 @@ +[build-system] +requires = ["setuptools>=68"] +build-backend = "setuptools.build_meta" + +[project] +name = "audit-report" +version = "0.1.0" +description = "Turn audit-tools evidence packages into control-mapped, auditor-ready reports." +readme = "README.md" +requires-python = ">=3.10" +license = { text = "GPL-3.0-or-later" } +authors = [{ name = "Audit Labs" }] +dependencies = ["PyYAML>=6.0"] + +[project.optional-dependencies] +dev = ["pytest>=8.0", "ruff>=0.5"] + +[project.scripts] +audit-report = "audit_report.cli:main" + +[project.urls] +Homepage = "https://audit-labs.dev" +Repository = "https://github.com/audit-labs/audit-report" + +[tool.setuptools] +packages = ["audit_report", "audit_report.reporters"] +include-package-data = true + +[tool.setuptools.package-data] +# Ship the bundled rulesets inside the wheel so the CLI works after install. +"audit_report" = ["rulesets/*.yaml"] new file mode 100644 @@ -0,0 +1,3 @@ +PyYAML>=6.0 +pytest>=8.0 +ruff>=0.5 new file mode 100644 @@ -0,0 +1 @@ +PyYAML>=6.0 new file mode 100644 @@ -0,0 +1,14 @@ +# Ruff configuration for audit-tools. +# +# A few lint rules are disabled because they flag patterns this project uses +# deliberately: +# +# BLE001 - The audit collectors and their CLI wrappers intentionally catch +# broad exceptions so that one failing check never aborts a whole +# audit run. The error is reported and collection continues. +# DTZ011 - date.today() is used to build human-facing, date-stamped output +# folder names, where the local date is the intended value. +# S112 - try/except/continue is used to skip resources that are unavailable +# during collection (e.g. a repo without the requested branch). +[lint] +ignore = ["BLE001", "DTZ011", "S112"] new file mode 100644 @@ -0,0 +1,2 @@ +root_mfa_enabled,root_access_keys_present,root_signing_certs_present,mfa_devices,users,groups,roles,policies +True,False,False,2,2,0,5,0 new file mode 100644 @@ -0,0 +1,2 @@ +name,home_region,multi_region,log_file_validation,is_logging,s3_bucket +main,us-east-1,True,True,True,acme-logs new file mode 100644 @@ -0,0 +1,3 @@ +user,mfa_enabled,access_keys,oldest_key_age_days,console_password,password_last_used,created +alice,True,1,30,True,2025-12-01T00:00:00+00:00,2025-01-01T00:00:00+00:00 +bob,False,1,400,True,2025-11-01T00:00:00+00:00,2025-02-01T00:00:00+00:00 new file mode 100644 @@ -0,0 +1,3 @@ +region,group_id,group_name,protocol,from_port,to_port,open_to +us-east-1,sg-1,web,tcp,22,22,0.0.0.0/0 +us-east-1,sg-2,db,tcp,443,443,10.0.0.0/8 new file mode 100644 @@ -0,0 +1,2 @@ +minimum_length,require_symbols,require_numbers,require_uppercase,require_lowercase,allow_users_to_change,max_age_days,reuse_prevention,hard_expiry +8,True,True,True,True,True,90,4,False new file mode 100644 new file mode 100644 @@ -0,0 +1,3 @@ +repo,branch,protected,protection_source,required_reviews,dismiss_stale_reviews,require_code_owner_reviews,required_status_checks,enforce_admins,restrictions +app,main,True,ruleset,1,True,False,,, +site,main,False,,,,,,, new file mode 100644 @@ -0,0 +1,2 @@ +org,two_factor_required,default_repo_permission,members_can_create_repos,members_can_create_public_repos,members_can_create_pages,web_commit_signoff_required,advanced_security_for_new_repos,secret_scanning_for_new_repos,secret_scanning_push_protection_for_new_repos +acme,True,read,True,True,True,False,True,True,True new file mode 100644 @@ -0,0 +1,95 @@ +"""Tests for rule evaluation against fixture packages, using bundled rulesets.""" + +from pathlib import Path + +from audit_report.engine import ( + FAIL, + NOT_APPLICABLE, + PASS, + control_coverage, + evaluate, + summarize, +) +from audit_report.loader import load_package +from audit_report.rules import load_ruleset + +FIXTURES = Path(__file__).parent / "fixtures" +RULESETS = Path("audit_report/rulesets") + + +def _run(pkg_name, ruleset_name): + pkg = load_package(FIXTURES / pkg_name) + ruleset = load_ruleset(RULESETS / ruleset_name) + findings = evaluate(pkg, ruleset) + return {f.rule.id: f for f in findings} + + +def test_aws_fixture_findings(): + findings = _run("aws_audit_acme_2026-01-01", "aws.yaml") + + # bob has a console password and no MFA -> one failing row. + mfa = findings["aws.iam.console-mfa"] + assert mfa.status == FAIL + assert len(mfa.evidence) == 1 + assert mfa.evidence[0]["user"] == "bob" + + # bob's key is 400 days old. + assert findings["aws.iam.key-rotation"].status == FAIL + + # Root is healthy in the fixture. + assert findings["aws.root.mfa"].status == PASS + assert findings["aws.root.no-access-keys"].status == PASS + + # min length 8 < 14 -> policy fails. + assert findings["aws.iam.password-policy"].status == FAIL + + # Only the port-22 group is open to the world. + ssh = findings["aws.network.no-open-ssh"] + assert ssh.status == FAIL + assert len(ssh.evidence) == 1 + assert ssh.evidence[0]["group_name"] == "web" + + # Empty s3_public_access table means no public buckets -> pass. + assert findings["aws.s3.no-public-access"].status == PASS + + # A healthy multi-region trail exists. + assert findings["aws.cloudtrail.logging"].status == PASS + + +def test_github_fixture_findings(): + findings = _run("github_audit_acme_2026-01-01", "github.yaml") + assert findings["github.org.require-2fa"].status == PASS + assert findings["github.org.default-permission"].status == PASS + assert findings["github.org.secret-scanning"].status == PASS + # 'site' repo default branch is unprotected. + branch = findings["github.branch.default-protected"] + assert branch.status == FAIL + assert branch.evidence[0]["repo"] == "site" + # 'app' has 1 review, 'site' is unprotected -> require-reviews passes + # (only counts protected branches with < 1 review). + assert findings["github.branch.require-reviews"].status == PASS + + +def test_not_applicable_when_table_absent(tmp_path): + (tmp_path / "aws_audit_x_2026-01-01").mkdir() + pkg_dir = tmp_path / "aws_audit_x_2026-01-01" + (pkg_dir / "iam_users.csv").write_text( + "user,mfa_enabled,console_password,oldest_key_age_days\n", encoding="utf-8" + ) + pkg = load_package(pkg_dir) + findings = {f.rule.id: f for f in evaluate(pkg, load_ruleset(RULESETS / "aws.yaml"))} + # Tables that were never collected are reported as not applicable. + assert findings["aws.root.mfa"].status == NOT_APPLICABLE + + +def test_summary_and_coverage(): + pkg = load_package(FIXTURES / "aws_audit_acme_2026-01-01") + findings = evaluate(pkg, load_ruleset(RULESETS / "aws.yaml")) + counts = summarize(findings) + assert counts[FAIL] + counts[PASS] + counts[NOT_APPLICABLE] == len(findings) + + coverage = control_coverage(findings) + # SC-7 is cited by the open-SSH rule (fails), so the control rolls up to fail. + assert coverage["NIST:SC-7"]["status"] == FAIL + # A control cited only by passing rules (both root checks) rolls up to pass. + assert coverage["ISO:A.8.2"]["status"] == PASS new file mode 100644 @@ -0,0 +1,47 @@ +"""Tests for package loading and platform detection.""" + +from pathlib import Path + +import pytest + +from audit_report.loader import detect_platform, load_package + +FIXTURES = Path(__file__).parent / "fixtures" + + +@pytest.mark.parametrize( + ("dir_name", "platform", "subject"), + [ + ("aws_audit_default_2026-07-29", "aws", "default"), + ("github_audit_audit-labs_2026-07-29", "github", "audit-labs"), + ("gitlab_audit_my_group_2026-01-01", "gitlab", "my_group"), + ("something_else", "unknown", "something_else"), + ], +) +def test_detect_platform(dir_name, platform, subject): + assert detect_platform(dir_name) == (platform, subject) + + +def test_load_package_reads_tables(): + pkg = load_package(FIXTURES / "aws_audit_acme_2026-01-01") + assert pkg.platform == "aws" + assert pkg.subject == "acme" + assert pkg.has("iam_users") + assert len(pkg.table("iam_users")) == 2 + assert pkg.table("iam_users")[0]["user"] == "alice" + # Present-but-empty CSV is a known-empty table, not an absent one. + assert pkg.has("s3_public_access") + assert pkg.table("s3_public_access") == [] + # Absent table returns empty list, reports as not present. + assert not pkg.has("nonexistent") + assert pkg.table("nonexistent") == [] + + +def test_load_missing_directory_raises(): + with pytest.raises(FileNotFoundError): + load_package(FIXTURES / "does-not-exist") + + +def test_load_directory_without_csvs_raises(tmp_path): + with pytest.raises(ValueError, match="no CSV files"): + load_package(tmp_path) new file mode 100644 @@ -0,0 +1,97 @@ +"""Tests for the report renderers and the CLI entry point.""" + +import json +from pathlib import Path + +import pytest + +from audit_report import reporters +from audit_report.cli import main +from audit_report.engine import evaluate +from audit_report.loader import load_package +from audit_report.rules import load_ruleset + +FIXTURES = Path(__file__).parent / "fixtures" +RULESETS = Path("audit_report/rulesets") + + +def _report(pkg_name="aws_audit_acme_2026-01-01", ruleset="aws.yaml"): + pkg = load_package(FIXTURES / pkg_name) + findings = evaluate(pkg, load_ruleset(RULESETS / ruleset)) + return reporters.build_report(pkg, findings) + + +def test_markdown_render_contains_sections(): + md = reporters.render(_report(), "md") + assert "# Evidence Report — acme" in md + assert "## Control coverage" in md + assert "## Findings" in md + assert "aws.network.no-open-ssh" in md + + +def test_html_render_is_self_contained(): + html = reporters.render(_report(), "html") + assert html.startswith("<!doctype html>") + assert "<style>" in html + # No external resource references. + assert "http://" not in html and "https://" not in html + assert "src=" not in html + + +def test_json_render_roundtrips(): + data = json.loads(reporters.render(_report(), "json")) + assert data["platform"] == "aws" + assert data["subject"] == "acme" + ids = {f["id"]: f["status"] for f in data["findings"]} + assert ids["aws.iam.console-mfa"] == "fail" + + +def test_html_escapes_evidence(tmp_path): + pkg_dir = tmp_path / "aws_audit_x_2026-01-01" + pkg_dir.mkdir() + (pkg_dir / "open_security_groups.csv").write_text( + "region,group_id,group_name,protocol,from_port,to_port,open_to\n" + "us-east-1,sg-1,<script>x</script>,tcp,22,22,0.0.0.0/0\n", + encoding="utf-8", + ) + pkg = load_package(pkg_dir) + report = reporters.build_report(pkg, evaluate(pkg, load_ruleset(RULESETS / "aws.yaml"))) + html = reporters.render(report, "html") + assert "<script>x</script>" not in html + assert "<script>" in html + + +def test_unknown_format_raises(): + with pytest.raises(ValueError, match="unknown format"): + reporters.render(_report(), "pdf") + + +def test_cli_writes_files_and_exit_code(tmp_path): + out = tmp_path / "out" + code = main( + [ + str(FIXTURES / "aws_audit_acme_2026-01-01"), + "--format", + "md,html,json", + "--out", + str(out), + "--fail-on", + "high", + ] + ) + assert (out / "report.md").exists() + assert (out / "report.html").exists() + assert (out / "report.json").exists() + # The AWS fixture has high-severity failures (open SSH), so exit is non-zero. + assert code == 1 + + +def test_cli_fail_on_none_is_zero(tmp_path): + code = main( + [str(FIXTURES / "aws_audit_acme_2026-01-01"), "--format", "json", "--out", str(tmp_path)] + ) + assert code == 0 + + +def test_cli_missing_package_returns_2(): + assert main([str(FIXTURES / "nope")]) == 2 new file mode 100644 @@ -0,0 +1,52 @@ +"""Unit tests for the condition language in audit_report.rules.""" + +import pytest + +from audit_report.rules import match + + +@pytest.mark.parametrize( + ("condition", "row", "expected"), + [ + ({"column": "x", "op": "equals", "value": "read"}, {"x": "read"}, True), + ({"column": "x", "op": "equals", "value": "Read"}, {"x": "read"}, True), # case-insensitive + ({"column": "x", "op": "not_equals", "value": "read"}, {"x": "write"}, True), + ({"column": "x", "op": "is_true"}, {"x": "True"}, True), + ({"column": "x", "op": "is_true"}, {"x": "yes"}, True), + ({"column": "x", "op": "is_false"}, {"x": "False"}, True), + ({"column": "x", "op": "is_false"}, {"x": ""}, True), # empty reads as false + ({"column": "x", "op": "gt", "value": 90}, {"x": "404"}, True), + ({"column": "x", "op": "gt", "value": 90}, {"x": "30"}, False), + ({"column": "x", "op": "lte", "value": 90}, {"x": "90"}, True), + ({"column": "x", "op": "gt", "value": 90}, {"x": ""}, False), # non-numeric -> False + ({"column": "x", "op": "in", "value": ["read", "none"]}, {"x": "none"}, True), + ({"column": "x", "op": "not_in", "value": ["read", "none"]}, {"x": "admin"}, True), + ({"column": "x", "op": "empty"}, {"x": " "}, True), + ({"column": "x", "op": "not_empty"}, {"x": "v"}, True), + ], +) +def test_leaf_conditions(condition, row, expected): + assert match(condition, row) is expected + + +def test_boolean_combinators(): + row = {"console_password": "True", "mfa_enabled": "False"} + cond = { + "all": [ + {"column": "console_password", "op": "is_true"}, + {"column": "mfa_enabled", "op": "is_false"}, + ] + } + assert match(cond, row) is True + assert match({"any": [{"column": "mfa_enabled", "op": "is_true"}]}, row) is False + assert match({"not": {"column": "mfa_enabled", "op": "is_true"}}, row) is True + + +def test_malformed_condition_raises(): + with pytest.raises(ValueError, match="malformed condition"): + match({"value": "x"}, {"x": "y"}) + + +def test_unknown_operator_raises(): + with pytest.raises(ValueError, match="unknown operator"): + match({"column": "x", "op": "wat"}, {"x": "y"})