Commit `217d893956`

217d893956c0f1d4f155da392546e50f6dd5cc14

Verified · cmc

cmc <hello@cleberg.net> · 2026-08-06 07:11 UTC

feat: control-mapped evidence reports from audit-tools packages

audit-report reads an audit-tools CSV evidence package, applies declarative
rulesets, maps each result to SOC 2 / ISO 27001 / NIST controls, and renders
Markdown, self-contained HTML, and JSON reports.

- loader: detect platform/subject from the package dir, load CSV tables
- rules: tiny condition language (all/any/not + leaf ops) and 4 check types
- engine: per-rule findings plus worst-wins control coverage rollup
- reporters: markdown, printable HTML, machine-readable json
- cli: format selection, --out, and --fail-on severity gating for CI
- bundled AWS and GitHub rulesets grounded in real audit-tools schemas
- 37 tests, ruff clean

Layout: unified · split

.gitignore added +18

		@@ -0,0 +1,18 @@
	1	.venv
	2	venv
	3
	4	# Python
	5	__pycache__/
	6	**/__pycache__/
	7	*.py[cod]
	8	*.egg-info/
	9	.pytest_cache/
	10	.ruff_cache/
	11	build/
	12	dist/
	13
	14	# Generated reports
	15	/report/
	16	report.md
	17	report.html
	18	report.json

CODEOWNERS added +1

		@@ -0,0 +1 @@
	1	* @ccleberg @ekraai2

LICENSE added +674

		@@ -0,0 +1,674 @@
	1	GNU GENERAL PUBLIC LICENSE
	2	Version 3, 29 June 2007
	3
	4	Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
	5	Everyone is permitted to copy and distribute verbatim copies
	6	of this license document, but changing it is not allowed.
	7
	8	Preamble
	9
	10	The GNU General Public License is a free, copyleft license for
	11	software and other kinds of works.
	12
	13	The licenses for most software and other practical works are designed
	14	to take away your freedom to share and change the works. By contrast,
	15	the GNU General Public License is intended to guarantee your freedom to
	16	share and change all versions of a program--to make sure it remains free
	17	software for all its users. We, the Free Software Foundation, use the
	18	GNU General Public License for most of our software; it applies also to
	19	any other work released this way by its authors. You can apply it to
	20	your programs, too.
	21
	22	When we speak of free software, we are referring to freedom, not
	23	price. Our General Public Licenses are designed to make sure that you
	24	have the freedom to distribute copies of free software (and charge for
	25	them if you wish), that you receive source code or can get it if you
	26	want it, that you can change the software or use pieces of it in new
	27	free programs, and that you know you can do these things.
	28
	29	To protect your rights, we need to prevent others from denying you
	30	these rights or asking you to surrender the rights. Therefore, you have
	31	certain responsibilities if you distribute copies of the software, or if
	32	you modify it: responsibilities to respect the freedom of others.
	33
	34	For example, if you distribute copies of such a program, whether
	35	gratis or for a fee, you must pass on to the recipients the same
	36	freedoms that you received. You must make sure that they, too, receive
	37	or can get the source code. And you must show them these terms so they
	38	know their rights.
	39
	40	Developers that use the GNU GPL protect your rights with two steps:
	41	(1) assert copyright on the software, and (2) offer you this License
	42	giving you legal permission to copy, distribute and/or modify it.
	43
	44	For the developers' and authors' protection, the GPL clearly explains
	45	that there is no warranty for this free software. For both users' and
	46	authors' sake, the GPL requires that modified versions be marked as
	47	changed, so that their problems will not be attributed erroneously to
	48	authors of previous versions.
	49
	50	Some devices are designed to deny users access to install or run
	51	modified versions of the software inside them, although the manufacturer
	52	can do so. This is fundamentally incompatible with the aim of
	53	protecting users' freedom to change the software. The systematic
	54	pattern of such abuse occurs in the area of products for individuals to
	55	use, which is precisely where it is most unacceptable. Therefore, we
	56	have designed this version of the GPL to prohibit the practice for those
	57	products. If such problems arise substantially in other domains, we
	58	stand ready to extend this provision to those domains in future versions
	59	of the GPL, as needed to protect the freedom of users.
	60
	61	Finally, every program is threatened constantly by software patents.
	62	States should not allow patents to restrict development and use of
	63	software on general-purpose computers, but in those that do, we wish to
	64	avoid the special danger that patents applied to a free program could
	65	make it effectively proprietary. To prevent this, the GPL assures that
	66	patents cannot be used to render the program non-free.
	67
	68	The precise terms and conditions for copying, distribution and
	69	modification follow.
	70
	71	TERMS AND CONDITIONS
	72
	73	0. Definitions.
	74
	75	"This License" refers to version 3 of the GNU General Public License.
	76
	77	"Copyright" also means copyright-like laws that apply to other kinds of
	78	works, such as semiconductor masks.
	79
	80	"The Program" refers to any copyrightable work licensed under this
	81	License. Each licensee is addressed as "you". "Licensees" and
	82	"recipients" may be individuals or organizations.
	83
	84	To "modify" a work means to copy from or adapt all or part of the work
	85	in a fashion requiring copyright permission, other than the making of an
	86	exact copy. The resulting work is called a "modified version" of the
	87	earlier work or a work "based on" the earlier work.
	88
	89	A "covered work" means either the unmodified Program or a work based
	90	on the Program.
	91
	92	To "propagate" a work means to do anything with it that, without
	93	permission, would make you directly or secondarily liable for
	94	infringement under applicable copyright law, except executing it on a
	95	computer or modifying a private copy. Propagation includes copying,
	96	distribution (with or without modification), making available to the
	97	public, and in some countries other activities as well.
	98
	99	To "convey" a work means any kind of propagation that enables other
	100	parties to make or receive copies. Mere interaction with a user through
	101	a computer network, with no transfer of a copy, is not conveying.
	102
	103	An interactive user interface displays "Appropriate Legal Notices"
	104	to the extent that it includes a convenient and prominently visible
	105	feature that (1) displays an appropriate copyright notice, and (2)
	106	tells the user that there is no warranty for the work (except to the
	107	extent that warranties are provided), that licensees may convey the
	108	work under this License, and how to view a copy of this License. If
	109	the interface presents a list of user commands or options, such as a
	110	menu, a prominent item in the list meets this criterion.
	111
	112	1. Source Code.
	113
	114	The "source code" for a work means the preferred form of the work
	115	for making modifications to it. "Object code" means any non-source
	116	form of a work.
	117
	118	A "Standard Interface" means an interface that either is an official
	119	standard defined by a recognized standards body, or, in the case of
	120	interfaces specified for a particular programming language, one that
	121	is widely used among developers working in that language.
	122
	123	The "System Libraries" of an executable work include anything, other
	124	than the work as a whole, that (a) is included in the normal form of
	125	packaging a Major Component, but which is not part of that Major
	126	Component, and (b) serves only to enable use of the work with that
	127	Major Component, or to implement a Standard Interface for which an
	128	implementation is available to the public in source code form. A
	129	"Major Component", in this context, means a major essential component
	130	(kernel, window system, and so on) of the specific operating system
	131	(if any) on which the executable work runs, or a compiler used to
	132	produce the work, or an object code interpreter used to run it.
	133
	134	The "Corresponding Source" for a work in object code form means all
	135	the source code needed to generate, install, and (for an executable
	136	work) run the object code and to modify the work, including scripts to
	137	control those activities. However, it does not include the work's
	138	System Libraries, or general-purpose tools or generally available free
	139	programs which are used unmodified in performing those activities but
	140	which are not part of the work. For example, Corresponding Source
	141	includes interface definition files associated with source files for
	142	the work, and the source code for shared libraries and dynamically
	143	linked subprograms that the work is specifically designed to require,
	144	such as by intimate data communication or control flow between those
	145	subprograms and other parts of the work.
	146
	147	The Corresponding Source need not include anything that users
	148	can regenerate automatically from other parts of the Corresponding
	149	Source.
	150
	151	The Corresponding Source for a work in source code form is that
	152	same work.
	153
	154	2. Basic Permissions.
	155
	156	All rights granted under this License are granted for the term of
	157	copyright on the Program, and are irrevocable provided the stated
	158	conditions are met. This License explicitly affirms your unlimited
	159	permission to run the unmodified Program. The output from running a
	160	covered work is covered by this License only if the output, given its
	161	content, constitutes a covered work. This License acknowledges your
	162	rights of fair use or other equivalent, as provided by copyright law.
	163
	164	You may make, run and propagate covered works that you do not
	165	convey, without conditions so long as your license otherwise remains
	166	in force. You may convey covered works to others for the sole purpose
	167	of having them make modifications exclusively for you, or provide you
	168	with facilities for running those works, provided that you comply with
	169	the terms of this License in conveying all material for which you do
	170	not control copyright. Those thus making or running the covered works
	171	for you must do so exclusively on your behalf, under your direction
	172	and control, on terms that prohibit them from making any copies of
	173	your copyrighted material outside their relationship with you.
	174
	175	Conveying under any other circumstances is permitted solely under
	176	the conditions stated below. Sublicensing is not allowed; section 10
	177	makes it unnecessary.
	178
	179	3. Protecting Users' Legal Rights From Anti-Circumvention Law.
	180
	181	No covered work shall be deemed part of an effective technological
	182	measure under any applicable law fulfilling obligations under article
	183	11 of the WIPO copyright treaty adopted on 20 December 1996, or
	184	similar laws prohibiting or restricting circumvention of such
	185	measures.
	186
	187	When you convey a covered work, you waive any legal power to forbid
	188	circumvention of technological measures to the extent such circumvention
	189	is effected by exercising rights under this License with respect to
	190	the covered work, and you disclaim any intention to limit operation or
	191	modification of the work as a means of enforcing, against the work's
	192	users, your or third parties' legal rights to forbid circumvention of
	193	technological measures.
	194
	195	4. Conveying Verbatim Copies.
	196
	197	You may convey verbatim copies of the Program's source code as you
	198	receive it, in any medium, provided that you conspicuously and
	199	appropriately publish on each copy an appropriate copyright notice;
	200	keep intact all notices stating that this License and any
	201	non-permissive terms added in accord with section 7 apply to the code;
	202	keep intact all notices of the absence of any warranty; and give all
	203	recipients a copy of this License along with the Program.
	204
	205	You may charge any price or no price for each copy that you convey,
	206	and you may offer support or warranty protection for a fee.
	207
	208	5. Conveying Modified Source Versions.
	209
	210	You may convey a work based on the Program, or the modifications to
	211	produce it from the Program, in the form of source code under the
	212	terms of section 4, provided that you also meet all of these conditions:
	213
	214	a) The work must carry prominent notices stating that you modified
	215	it, and giving a relevant date.
	216
	217	b) The work must carry prominent notices stating that it is
	218	released under this License and any conditions added under section
	219	7. This requirement modifies the requirement in section 4 to
	220	"keep intact all notices".
	221
	222	c) You must license the entire work, as a whole, under this
	223	License to anyone who comes into possession of a copy. This
	224	License will therefore apply, along with any applicable section 7
	225	additional terms, to the whole of the work, and all its parts,
	226	regardless of how they are packaged. This License gives no
	227	permission to license the work in any other way, but it does not
	228	invalidate such permission if you have separately received it.
	229
	230	d) If the work has interactive user interfaces, each must display
	231	Appropriate Legal Notices; however, if the Program has interactive
	232	interfaces that do not display Appropriate Legal Notices, your
	233	work need not make them do so.
	234
	235	A compilation of a covered work with other separate and independent
	236	works, which are not by their nature extensions of the covered work,
	237	and which are not combined with it such as to form a larger program,
	238	in or on a volume of a storage or distribution medium, is called an
	239	"aggregate" if the compilation and its resulting copyright are not
	240	used to limit the access or legal rights of the compilation's users
	241	beyond what the individual works permit. Inclusion of a covered work
	242	in an aggregate does not cause this License to apply to the other
	243	parts of the aggregate.
	244
	245	6. Conveying Non-Source Forms.
	246
	247	You may convey a covered work in object code form under the terms
	248	of sections 4 and 5, provided that you also convey the
	249	machine-readable Corresponding Source under the terms of this License,
	250	in one of these ways:
	251
	252	a) Convey the object code in, or embodied in, a physical product
	253	(including a physical distribution medium), accompanied by the
	254	Corresponding Source fixed on a durable physical medium
	255	customarily used for software interchange.
	256
	257	b) Convey the object code in, or embodied in, a physical product
	258	(including a physical distribution medium), accompanied by a
	259	written offer, valid for at least three years and valid for as
	260	long as you offer spare parts or customer support for that product
	261	model, to give anyone who possesses the object code either (1) a
	262	copy of the Corresponding Source for all the software in the
	263	product that is covered by this License, on a durable physical
	264	medium customarily used for software interchange, for a price no
	265	more than your reasonable cost of physically performing this
	266	conveying of source, or (2) access to copy the
	267	Corresponding Source from a network server at no charge.
	268
	269	c) Convey individual copies of the object code with a copy of the
	270	written offer to provide the Corresponding Source. This
	271	alternative is allowed only occasionally and noncommercially, and
	272	only if you received the object code with such an offer, in accord
	273	with subsection 6b.
	274
	275	d) Convey the object code by offering access from a designated
	276	place (gratis or for a charge), and offer equivalent access to the
	277	Corresponding Source in the same way through the same place at no
	278	further charge. You need not require recipients to copy the
	279	Corresponding Source along with the object code. If the place to
	280	copy the object code is a network server, the Corresponding Source
	281	may be on a different server (operated by you or a third party)
	282	that supports equivalent copying facilities, provided you maintain
	283	clear directions next to the object code saying where to find the
	284	Corresponding Source. Regardless of what server hosts the
	285	Corresponding Source, you remain obligated to ensure that it is
	286	available for as long as needed to satisfy these requirements.
	287
	288	e) Convey the object code using peer-to-peer transmission, provided
	289	you inform other peers where the object code and Corresponding
	290	Source of the work are being offered to the general public at no
	291	charge under subsection 6d.
	292
	293	A separable portion of the object code, whose source code is excluded
	294	from the Corresponding Source as a System Library, need not be
	295	included in conveying the object code work.
	296
	297	A "User Product" is either (1) a "consumer product", which means any
	298	tangible personal property which is normally used for personal, family,
	299	or household purposes, or (2) anything designed or sold for incorporation
	300	into a dwelling. In determining whether a product is a consumer product,
	301	doubtful cases shall be resolved in favor of coverage. For a particular
	302	product received by a particular user, "normally used" refers to a
	303	typical or common use of that class of product, regardless of the status
	304	of the particular user or of the way in which the particular user
	305	actually uses, or expects or is expected to use, the product. A product
	306	is a consumer product regardless of whether the product has substantial
	307	commercial, industrial or non-consumer uses, unless such uses represent
	308	the only significant mode of use of the product.
	309
	310	"Installation Information" for a User Product means any methods,
	311	procedures, authorization keys, or other information required to install
	312	and execute modified versions of a covered work in that User Product from
	313	a modified version of its Corresponding Source. The information must
	314	suffice to ensure that the continued functioning of the modified object
	315	code is in no case prevented or interfered with solely because
	316	modification has been made.
	317
	318	If you convey an object code work under this section in, or with, or
	319	specifically for use in, a User Product, and the conveying occurs as
	320	part of a transaction in which the right of possession and use of the
	321	User Product is transferred to the recipient in perpetuity or for a
	322	fixed term (regardless of how the transaction is characterized), the
	323	Corresponding Source conveyed under this section must be accompanied
	324	by the Installation Information. But this requirement does not apply
	325	if neither you nor any third party retains the ability to install
	326	modified object code on the User Product (for example, the work has
	327	been installed in ROM).
	328
	329	The requirement to provide Installation Information does not include a
	330	requirement to continue to provide support service, warranty, or updates
	331	for a work that has been modified or installed by the recipient, or for
	332	the User Product in which it has been modified or installed. Access to a
	333	network may be denied when the modification itself materially and
	334	adversely affects the operation of the network or violates the rules and
	335	protocols for communication across the network.
	336
	337	Corresponding Source conveyed, and Installation Information provided,
	338	in accord with this section must be in a format that is publicly
	339	documented (and with an implementation available to the public in
	340	source code form), and must require no special password or key for
	341	unpacking, reading or copying.
	342
	343	7. Additional Terms.
	344
	345	"Additional permissions" are terms that supplement the terms of this
	346	License by making exceptions from one or more of its conditions.
	347	Additional permissions that are applicable to the entire Program shall
	348	be treated as though they were included in this License, to the extent
	349	that they are valid under applicable law. If additional permissions
	350	apply only to part of the Program, that part may be used separately
	351	under those permissions, but the entire Program remains governed by
	352	this License without regard to the additional permissions.
	353
	354	When you convey a copy of a covered work, you may at your option
	355	remove any additional permissions from that copy, or from any part of
	356	it. (Additional permissions may be written to require their own
	357	removal in certain cases when you modify the work.) You may place
	358	additional permissions on material, added by you to a covered work,
	359	for which you have or can give appropriate copyright permission.
	360
	361	Notwithstanding any other provision of this License, for material you
	362	add to a covered work, you may (if authorized by the copyright holders of
	363	that material) supplement the terms of this License with terms:
	364
	365	a) Disclaiming warranty or limiting liability differently from the
	366	terms of sections 15 and 16 of this License; or
	367
	368	b) Requiring preservation of specified reasonable legal notices or
	369	author attributions in that material or in the Appropriate Legal
	370	Notices displayed by works containing it; or
	371
	372	c) Prohibiting misrepresentation of the origin of that material, or
	373	requiring that modified versions of such material be marked in
	374	reasonable ways as different from the original version; or
	375
	376	d) Limiting the use for publicity purposes of names of licensors or
	377	authors of the material; or
	378
	379	e) Declining to grant rights under trademark law for use of some
	380	trade names, trademarks, or service marks; or
	381
	382	f) Requiring indemnification of licensors and authors of that
	383	material by anyone who conveys the material (or modified versions of
	384	it) with contractual assumptions of liability to the recipient, for
	385	any liability that these contractual assumptions directly impose on
	386	those licensors and authors.
	387
	388	All other non-permissive additional terms are considered "further
	389	restrictions" within the meaning of section 10. If the Program as you
	390	received it, or any part of it, contains a notice stating that it is
	391	governed by this License along with a term that is a further
	392	restriction, you may remove that term. If a license document contains
	393	a further restriction but permits relicensing or conveying under this
	394	License, you may add to a covered work material governed by the terms
	395	of that license document, provided that the further restriction does
	396	not survive such relicensing or conveying.
	397
	398	If you add terms to a covered work in accord with this section, you
	399	must place, in the relevant source files, a statement of the
	400	additional terms that apply to those files, or a notice indicating
	401	where to find the applicable terms.
	402
	403	Additional terms, permissive or non-permissive, may be stated in the
	404	form of a separately written license, or stated as exceptions;
	405	the above requirements apply either way.
	406
	407	8. Termination.
	408
	409	You may not propagate or modify a covered work except as expressly
	410	provided under this License. Any attempt otherwise to propagate or
	411	modify it is void, and will automatically terminate your rights under
	412	this License (including any patent licenses granted under the third
	413	paragraph of section 11).
	414
	415	However, if you cease all violation of this License, then your
	416	license from a particular copyright holder is reinstated (a)
	417	provisionally, unless and until the copyright holder explicitly and
	418	finally terminates your license, and (b) permanently, if the copyright
	419	holder fails to notify you of the violation by some reasonable means
	420	prior to 60 days after the cessation.
	421
	422	Moreover, your license from a particular copyright holder is
	423	reinstated permanently if the copyright holder notifies you of the
	424	violation by some reasonable means, this is the first time you have
	425	received notice of violation of this License (for any work) from that
	426	copyright holder, and you cure the violation prior to 30 days after
	427	your receipt of the notice.
	428
	429	Termination of your rights under this section does not terminate the
	430	licenses of parties who have received copies or rights from you under
	431	this License. If your rights have been terminated and not permanently
	432	reinstated, you do not qualify to receive new licenses for the same
	433	material under section 10.
	434
	435	9. Acceptance Not Required for Having Copies.
	436
	437	You are not required to accept this License in order to receive or
	438	run a copy of the Program. Ancillary propagation of a covered work
	439	occurring solely as a consequence of using peer-to-peer transmission
	440	to receive a copy likewise does not require acceptance. However,
	441	nothing other than this License grants you permission to propagate or
	442	modify any covered work. These actions infringe copyright if you do
	443	not accept this License. Therefore, by modifying or propagating a
	444	covered work, you indicate your acceptance of this License to do so.
	445
	446	10. Automatic Licensing of Downstream Recipients.
	447
	448	Each time you convey a covered work, the recipient automatically
	449	receives a license from the original licensors, to run, modify and
	450	propagate that work, subject to this License. You are not responsible
	451	for enforcing compliance by third parties with this License.
	452
	453	An "entity transaction" is a transaction transferring control of an
	454	organization, or substantially all assets of one, or subdividing an
	455	organization, or merging organizations. If propagation of a covered
	456	work results from an entity transaction, each party to that
	457	transaction who receives a copy of the work also receives whatever
	458	licenses to the work the party's predecessor in interest had or could
	459	give under the previous paragraph, plus a right to possession of the
	460	Corresponding Source of the work from the predecessor in interest, if
	461	the predecessor has it or can get it with reasonable efforts.
	462
	463	You may not impose any further restrictions on the exercise of the
	464	rights granted or affirmed under this License. For example, you may
	465	not impose a license fee, royalty, or other charge for exercise of
	466	rights granted under this License, and you may not initiate litigation
	467	(including a cross-claim or counterclaim in a lawsuit) alleging that
	468	any patent claim is infringed by making, using, selling, offering for
	469	sale, or importing the Program or any portion of it.
	470
	471	11. Patents.
	472
	473	A "contributor" is a copyright holder who authorizes use under this
	474	License of the Program or a work on which the Program is based. The
	475	work thus licensed is called the contributor's "contributor version".
	476
	477	A contributor's "essential patent claims" are all patent claims
	478	owned or controlled by the contributor, whether already acquired or
	479	hereafter acquired, that would be infringed by some manner, permitted
	480	by this License, of making, using, or selling its contributor version,
	481	but do not include claims that would be infringed only as a
	482	consequence of further modification of the contributor version. For
	483	purposes of this definition, "control" includes the right to grant
	484	patent sublicenses in a manner consistent with the requirements of
	485	this License.
	486
	487	Each contributor grants you a non-exclusive, worldwide, royalty-free
	488	patent license under the contributor's essential patent claims, to
	489	make, use, sell, offer for sale, import and otherwise run, modify and
	490	propagate the contents of its contributor version.
	491
	492	In the following three paragraphs, a "patent license" is any express
	493	agreement or commitment, however denominated, not to enforce a patent
	494	(such as an express permission to practice a patent or covenant not to
	495	sue for patent infringement). To "grant" such a patent license to a
	496	party means to make such an agreement or commitment not to enforce a
	497	patent against the party.
	498
	499	If you convey a covered work, knowingly relying on a patent license,
	500	and the Corresponding Source of the work is not available for anyone
	501	to copy, free of charge and under the terms of this License, through a
	502	publicly available network server or other readily accessible means,
	503	then you must either (1) cause the Corresponding Source to be so
	504	available, or (2) arrange to deprive yourself of the benefit of the
	505	patent license for this particular work, or (3) arrange, in a manner
	506	consistent with the requirements of this License, to extend the patent
	507	license to downstream recipients. "Knowingly relying" means you have
	508	actual knowledge that, but for the patent license, your conveying the
	509	covered work in a country, or your recipient's use of the covered work
	510	in a country, would infringe one or more identifiable patents in that
	511	country that you have reason to believe are valid.
	512
	513	If, pursuant to or in connection with a single transaction or
	514	arrangement, you convey, or propagate by procuring conveyance of, a
	515	covered work, and grant a patent license to some of the parties
	516	receiving the covered work authorizing them to use, propagate, modify
	517	or convey a specific copy of the covered work, then the patent license
	518	you grant is automatically extended to all recipients of the covered
	519	work and works based on it.
	520
	521	A patent license is "discriminatory" if it does not include within
	522	the scope of its coverage, prohibits the exercise of, or is
	523	conditioned on the non-exercise of one or more of the rights that are
	524	specifically granted under this License. You may not convey a covered
	525	work if you are a party to an arrangement with a third party that is
	526	in the business of distributing software, under which you make payment
	527	to the third party based on the extent of your activity of conveying
	528	the work, and under which the third party grants, to any of the
	529	parties who would receive the covered work from you, a discriminatory
	530	patent license (a) in connection with copies of the covered work
	531	conveyed by you (or copies made from those copies), or (b) primarily
	532	for and in connection with specific products or compilations that
	533	contain the covered work, unless you entered into that arrangement,
	534	or that patent license was granted, prior to 28 March 2007.
	535
	536	Nothing in this License shall be construed as excluding or limiting
	537	any implied license or other defenses to infringement that may
	538	otherwise be available to you under applicable patent law.
	539
	540	12. No Surrender of Others' Freedom.
	541
	542	If conditions are imposed on you (whether by court order, agreement or
	543	otherwise) that contradict the conditions of this License, they do not
	544	excuse you from the conditions of this License. If you cannot convey a
	545	covered work so as to satisfy simultaneously your obligations under this
	546	License and any other pertinent obligations, then as a consequence you may
	547	not convey it at all. For example, if you agree to terms that obligate you
	548	to collect a royalty for further conveying from those to whom you convey
	549	the Program, the only way you could satisfy both those terms and this
	550	License would be to refrain entirely from conveying the Program.
	551
	552	13. Use with the GNU Affero General Public License.
	553
	554	Notwithstanding any other provision of this License, you have
	555	permission to link or combine any covered work with a work licensed
	556	under version 3 of the GNU Affero General Public License into a single
	557	combined work, and to convey the resulting work. The terms of this
	558	License will continue to apply to the part which is the covered work,
	559	but the special requirements of the GNU Affero General Public License,
	560	section 13, concerning interaction through a network will apply to the
	561	combination as such.
	562
	563	14. Revised Versions of this License.
	564
	565	The Free Software Foundation may publish revised and/or new versions of
	566	the GNU General Public License from time to time. Such new versions will
	567	be similar in spirit to the present version, but may differ in detail to
	568	address new problems or concerns.
	569
	570	Each version is given a distinguishing version number. If the
	571	Program specifies that a certain numbered version of the GNU General
	572	Public License "or any later version" applies to it, you have the
	573	option of following the terms and conditions either of that numbered
	574	version or of any later version published by the Free Software
	575	Foundation. If the Program does not specify a version number of the
	576	GNU General Public License, you may choose any version ever published
	577	by the Free Software Foundation.
	578
	579	If the Program specifies that a proxy can decide which future
	580	versions of the GNU General Public License can be used, that proxy's
	581	public statement of acceptance of a version permanently authorizes you
	582	to choose that version for the Program.
	583
	584	Later license versions may give you additional or different
	585	permissions. However, no additional obligations are imposed on any
	586	author or copyright holder as a result of your choosing to follow a
	587	later version.
	588
	589	15. Disclaimer of Warranty.
	590
	591	THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
	592	APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
	593	HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
	594	OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
	595	THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	596	PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
	597	IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
	598	ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
	599
	600	16. Limitation of Liability.
	601
	602	IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
	603	WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
	604	THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
	605	GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
	606	USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
	607	DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
	608	PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
	609	EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
	610	SUCH DAMAGES.
	611
	612	17. Interpretation of Sections 15 and 16.
	613
	614	If the disclaimer of warranty and limitation of liability provided
	615	above cannot be given local legal effect according to their terms,
	616	reviewing courts shall apply local law that most closely approximates
	617	an absolute waiver of all civil liability in connection with the
	618	Program, unless a warranty or assumption of liability accompanies a
	619	copy of the Program in return for a fee.
	620
	621	END OF TERMS AND CONDITIONS
	622
	623	How to Apply These Terms to Your New Programs
	624
	625	If you develop a new program, and you want it to be of the greatest
	626	possible use to the public, the best way to achieve this is to make it
	627	free software which everyone can redistribute and change under these terms.
	628
	629	To do so, attach the following notices to the program. It is safest
	630	to attach them to the start of each source file to most effectively
	631	state the exclusion of warranty; and each file should have at least
	632	the "copyright" line and a pointer to where the full notice is found.
	633
	634	<one line to give the program's name and a brief idea of what it does.>
	635	Copyright (C) <year> <name of author>
	636
	637	This program is free software: you can redistribute it and/or modify
	638	it under the terms of the GNU General Public License as published by
	639	the Free Software Foundation, either version 3 of the License, or
	640	(at your option) any later version.
	641
	642	This program is distributed in the hope that it will be useful,
	643	but WITHOUT ANY WARRANTY; without even the implied warranty of
	644	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	645	GNU General Public License for more details.
	646
	647	You should have received a copy of the GNU General Public License
	648	along with this program. If not, see <https://www.gnu.org/licenses/>.
	649
	650	Also add information on how to contact you by electronic and paper mail.
	651
	652	If the program does terminal interaction, make it output a short
	653	notice like this when it starts in an interactive mode:
	654
	655	<program> Copyright (C) <year> <name of author>
	656	This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
	657	This is free software, and you are welcome to redistribute it
	658	under certain conditions; type `show c' for details.
	659
	660	The hypothetical commands `show w' and `show c' should show the appropriate
	661	parts of the General Public License. Of course, your program's commands
	662	might be different; for a GUI interface, you would use an "about box".
	663
	664	You should also get your employer (if you work as a programmer) or school,
	665	if any, to sign a "copyright disclaimer" for the program, if necessary.
	666	For more information on this, and how to apply and follow the GNU GPL, see
	667	<https://www.gnu.org/licenses/>.
	668
	669	The GNU General Public License does not permit incorporating your program
	670	into proprietary programs. If your program is a subroutine library, you
	671	may consider it more useful to permit linking proprietary applications with
	672	the library. If this is what you want to do, use the GNU Lesser General
	673	Public License instead of this License. But first, please read
	674	<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md added +124

		@@ -0,0 +1,124 @@
	1	# audit-report
	2
	3	[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
	4	[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)]()
	5
	6	Turns an [audit-tools](https://github.com/audit-labs/audit-tools) evidence
	7	package into a control-mapped, auditor-ready report — Markdown, self-contained
	8	HTML, or JSON — driven by declarative rulesets.
	9
	10	`audit-tools` collects raw CSVs (IAM users, branch protections, security
	11	groups…). `audit-report` reads that package, applies pass/fail rules, maps each
	12	result to SOC 2, ISO 27001, and NIST SP 800-53 controls, and produces a
	13	report you can hand to an auditor or gate a pipeline on.
	14
	15	> Like [gh-attest](https://github.com/audit-labs/gh-attest), this tool produces
	16	> evidence, not a compliance verdict. A failing row means a setting is in a
	17	> state that does not support a control; the final judgment belongs to the
	18	> organization and its auditor.
	19
	20	## Install
	21
	22	```bash
	23	git clone https://github.com/audit-labs/audit-report
	24	cd audit-report
	25	python -m venv .venv && source .venv/bin/activate
	26	pip install -e .
	27	```
	28
	29	## Usage
	30
	31	Point it at a package directory produced by `audit-tools`:
	32
	33	```bash
	34	# Markdown report to stdout (platform + ruleset auto-detected from the dir name)
	35	audit-report ./output/aws_audit_default_2026-07-29
	36
	37	# All three formats into ./report/
	38	audit-report ./output/github_audit_acme_2026-07-29 --format md,html,json --out report/
	39
	40	# Gate CI: exit non-zero if any high-severity check fails
	41	audit-report ./output/aws_audit_prod_2026-07-29 --fail-on high --out report/
	42	```
	43
	44	You can also run it without installing:
	45
	46	```bash
	47	python -m audit_report ./output/aws_audit_default_2026-07-29
	48	```
	49
	50	### Options
	51
	52	\| Flag \| Description \|
	53	\| --- \| --- \|
	54	\| `--ruleset PATH` \| Use a specific ruleset instead of the bundled one for the detected platform. \|
	55	\| `--format md,html,json` \| One or more output formats (default: `md`). \|
	56	\| `--out DIR` \| Write `report.<ext>` files into `DIR`. Without it, the first format prints to stdout. \|
	57	\| `--fail-on low\\|medium\\|high\\|none` \| Exit non-zero when a failing finding meets this severity (default: `none`). \|
	58
	59	## What a report contains
	60
	61	- Summary — failing / passing / not-applicable counts.
	62	- Control coverage matrix — every cited control, its framework, and a
	63	worst-wins status rolled up from the rules that reference it. One failing rule
	64	marks the control as not fully evidenced.
	65	- Findings — failures first, then by severity, each with the reason, why it
	66	matters, remediation, and the exact evidence rows that failed.
	67
	68	## Bundled rulesets
	69
	70	\| Platform \| Package prefix \| Checks include \|
	71	\| --- \| --- \| --- \|
	72	\| AWS \| `aws_audit_*` \| Console-user MFA, access-key rotation, root MFA & keys, password policy, open SSH, public S3, CloudTrail logging \|
	73	\| GitHub \| `github_audit_*` \| Org 2FA, base permission, secret-scanning push protection, default-branch protection, required reviews \|
	74
	75	## Writing your own rules
	76
	77	A ruleset is a YAML file: a `platform` and a list of `rules`. Each rule names a
	78	CSV table, a check, the controls it maps to, and human-readable text. Point at
	79	one with `--ruleset`.
	80
	81	```yaml
	82	platform: aws
	83	rules:
	84	- id: aws.iam.console-mfa
	85	title: Console users have MFA enabled
	86	table: iam_users # <table>.csv inside the package
	87	severity: high # high \| medium \| low
	88	controls: [SOC2:CC6.1, ISO:A.5.17, NIST:IA-2]
	89	rationale: A console user without a second factor is one stolen password from access.
	90	remediation: Enforce MFA for all console users, or remove their console password.
	91	check:
	92	type: fail_rows_where # every matching row is a failure
	93	when:
	94	all:
	95	- {column: console_password, op: is_true}
	96	- {column: mfa_enabled, op: is_false}
	97	```
	98
	99	Check types
	100
	101	\| Type \| Meaning \|
	102	\| --- \| --- \|
	103	\| `fail_rows_where` \| Each row matching `when` is a failing finding. \|
	104	\| `fail_if_any_rows` \| The presence of any row (optionally filtered by `when`) is a failure. \|
	105	\| `require_any_row` \| Passes only if at least one row satisfies `when`. \|
	106	\| `assert_row` \| Checks each condition in `require` against the first row of a single-row config table. \|
	107
	108	Condition language — a condition is a leaf `{column, op, value}`, or one of
	109	`{all: [...]}`, `{any: [...]}`, `{not: ...}`. Operators: `equals`, `not_equals`,
	110	`is_true`, `is_false`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`, `empty`,
	111	`not_empty`. Control codes referenced by a rule must exist in
	112	[`audit_report/catalog.py`](audit_report/catalog.py).
	113
	114	## Development
	115
	116	```bash
	117	pip install -e ".[dev]"
	118	pytest # run from the project root
	119	ruff check .
	120	```
	121
	122	## License
	123
	124	GPL-3.0-or-later. See [LICENSE](LICENSE).

audit_report/__init__.py added +3

		@@ -0,0 +1,3 @@
	1	"""audit-report — turn audit-tools evidence packages into control-mapped reports."""
	2
	3	__version__ = "0.1.0"

audit_report/__main__.py added +6

		@@ -0,0 +1,6 @@
	1	"""Enable ``python -m audit_report``."""
	2
	3	from .cli import main
	4
	5	if __name__ == "__main__":
	6	raise SystemExit(main())

audit_report/catalog.py added +58

		@@ -0,0 +1,58 @@
	1	"""Control catalog.
	2
	3	A small, plain-language reference for every control code a ruleset may cite.
	4	Control codes are written as ``FRAMEWORK:CODE`` (for example ``SOC2:CC6.1``).
	5	The catalog is deliberately not exhaustive — it covers the codes the bundled
	6	rulesets actually reference. Adding a framework means adding its codes here and
	7	citing them from a ruleset.
	8
	9	Like gh-attest, this tool produces evidence, not a compliance verdict: a
	10	mapping says a signal is relevant to a control, not that the control is met.
	11	"""
	12
	13	# framework code -> human-readable name
	14	FRAMEWORKS = {
	15	"SOC2": "SOC 2 (Trust Services Criteria)",
	16	"ISO": "ISO/IEC 27001:2022 Annex A",
	17	"NIST": "NIST SP 800-53 Rev. 5",
	18	}
	19
	20	# "FRAMEWORK:CODE" -> one-line description of the control
	21	CONTROLS = {
	22	# SOC 2 Trust Services Criteria
	23	"SOC2:CC6.1": "Logical access security — restrict access to protected information assets.",
	24	"SOC2:CC6.2": "Register and authorize new users before granting access.",
	25	"SOC2:CC6.3": "Manage access rights based on roles and least privilege.",
	26	"SOC2:CC6.6": "Restrict access from outside the system boundary.",
	27	"SOC2:CC6.7": "Restrict the transmission and movement of information.",
	28	"SOC2:CC7.1": "Detect and monitor for new vulnerabilities and misconfigurations.",
	29	"SOC2:CC7.2": "Monitor system components for anomalies and security events.",
	30	"SOC2:CC8.1": "Authorize, design, and track changes to infrastructure and software.",
	31	# ISO/IEC 27001:2022 Annex A
	32	"ISO:A.5.15": "Access control — rules based on business and security requirements.",
	33	"ISO:A.5.17": "Authentication information — management of secrets and MFA.",
	34	"ISO:A.5.18": "Access rights — provisioning, review, and removal.",
	35	"ISO:A.8.2": "Privileged access rights — restricted and managed.",
	36	"ISO:A.8.9": "Configuration management — secure baseline configuration.",
	37	"ISO:A.8.15": "Logging — record events for monitoring and investigation.",
	38	"ISO:A.8.20": "Network security — securing networks and network services.",
	39	"ISO:A.8.32": "Change management — control changes to information systems.",
	40	# NIST SP 800-53 Rev. 5
	41	"NIST:AC-2": "Account management — establish, review, and disable accounts.",
	42	"NIST:AC-6": "Least privilege — authorize the minimum access necessary.",
	43	"NIST:AU-2": "Event logging — determine and record auditable events.",
	44	"NIST:CM-6": "Configuration settings — establish and enforce secure settings.",
	45	"NIST:IA-2": "Identification and authentication — multifactor for accounts.",
	46	"NIST:IA-5": "Authenticator management — password strength and lifecycle.",
	47	"NIST:SC-7": "Boundary protection — control communications at boundaries.",
	48	}
	49
	50
	51	def describe(control: str) -> str:
	52	"""Return the description for a control code, or a placeholder if unknown."""
	53	return CONTROLS.get(control, "(no description on file)")
	54
	55
	56	def framework_of(control: str) -> str:
	57	"""Return the framework short code for a control code (text before ':')."""
	58	return control.split(":", 1)[0]

audit_report/cli.py added +110

		@@ -0,0 +1,110 @@
	1	"""Command-line entry point for audit-report."""
	2
	3	from __future__ import annotations
	4
	5	import argparse
	6	import sys
	7	from pathlib import Path
	8
	9	from . import __version__, reporters
	10	from .engine import FAIL, evaluate
	11	from .loader import load_package
	12	from .rules import load_ruleset
	13
	14	# Bundled rulesets ship inside the package, one per platform.
	15	_RULESET_DIR = Path(__file__).resolve().parent / "rulesets"
	16
	17	_SEVERITY_ORDER = {"low": 0, "medium": 1, "high": 2}
	18
	19
	20	def _default_ruleset(platform: str) -> Path:
	21	candidate = _RULESET_DIR / f"{platform}.yaml"
	22	if not candidate.exists():
	23	raise SystemExit(
	24	f"error: no bundled ruleset for platform '{platform}'. "
	25	f"Pass one with --ruleset. Available: "
	26	f"{', '.join(p.stem for p in sorted(_RULESET_DIR.glob('*.yaml'))) or 'none'}"
	27	)
	28	return candidate
	29
	30
	31	def _parse_args(argv: list[str]) -> argparse.Namespace:
	32	parser = argparse.ArgumentParser(
	33	prog="audit-report",
	34	description="Turn an audit-tools evidence package into a control-mapped report.",
	35	)
	36	parser.add_argument("package", help="path to an audit-tools output package directory")
	37	parser.add_argument(
	38	"--ruleset",
	39	help="path to a ruleset YAML (default: bundled ruleset for the detected platform)",
	40	)
	41	parser.add_argument(
	42	"--format",
	43	default="md",
	44	help="comma-separated output formats: md, html, json (default: md)",
	45	)
	46	parser.add_argument(
	47	"--out",
	48	help="directory to write report files into (default: print Markdown to stdout)",
	49	)
	50	parser.add_argument(
	51	"--fail-on",
	52	choices=["low", "medium", "high", "none"],
	53	default="none",
	54	help="exit non-zero if any finding fails at or above this severity (default: none)",
	55	)
	56	parser.add_argument("--version", action="version", version=f"audit-report {__version__}")
	57	return parser.parse_args(argv)
	58
	59
	60	def _exit_code(findings, threshold: str) -> int:
	61	if threshold == "none":
	62	return 0
	63	floor = _SEVERITY_ORDER[threshold]
	64	breached = any(
	65	f.status == FAIL and _SEVERITY_ORDER.get(f.rule.severity, 1) >= floor
	66	for f in findings
	67	)
	68	return 1 if breached else 0
	69
	70
	71	def main(argv: list[str] \| None = None) -> int:
	72	args = _parse_args(argv if argv is not None else sys.argv[1:])
	73
	74	try:
	75	package = load_package(args.package)
	76	except (FileNotFoundError, ValueError) as exc:
	77	print(f"error: {exc}", file=sys.stderr)
	78	return 2
	79
	80	ruleset_path = Path(args.ruleset) if args.ruleset else _default_ruleset(package.platform)
	81	ruleset = load_ruleset(ruleset_path)
	82
	83	findings = evaluate(package, ruleset)
	84	report = reporters.build_report(package, findings)
	85	formats = [f.strip() for f in args.format.split(",") if f.strip()]
	86
	87	if args.out:
	88	out_dir = Path(args.out)
	89	out_dir.mkdir(parents=True, exist_ok=True)
	90	for fmt in formats:
	91	content = reporters.render(report, fmt)
	92	dest = out_dir / f"report.{reporters.EXTENSIONS[fmt]}"
	93	dest.write_text(content, encoding="utf-8")
	94	print(f"wrote {dest}", file=sys.stderr)
	95	else:
	96	# No --out: emit the first requested format to stdout.
	97	print(reporters.render(report, formats[0]), end="")
	98
	99	counts = report.counts
	100	print(
	101	f"{package.platform}/{package.subject}: "
	102	f"{counts[FAIL]} failing, {counts['pass']} passing, "
	103	f"{counts['not_applicable']} n/a",
	104	file=sys.stderr,
	105	)
	106	return _exit_code(findings, args.fail_on)
	107
	108
	109	if __name__ == "__main__":
	110	raise SystemExit(main())

audit_report/engine.py added +119

		@@ -0,0 +1,119 @@
	1	"""Evaluate a ruleset against a loaded package to produce findings."""
	2
	3	from __future__ import annotations
	4
	5	from dataclasses import dataclass, field
	6
	7	from .loader import Package, Row
	8	from .rules import Rule, Ruleset, match
	9
	10	PASS = "pass"
	11	FAIL = "fail"
	12	NOT_APPLICABLE = "not_applicable"
	13
	14
	15	@dataclass
	16	class Finding:
	17	"""The outcome of evaluating one rule against one package."""
	18
	19	rule: Rule
	20	status: str
	21	reason: str
	22	evidence: list[Row] = field(default_factory=list)
	23
	24	@property
	25	def controls(self) -> list[str]:
	26	return self.rule.controls
	27
	28
	29	def _evaluate_rule(rule: Rule, package: Package) -> Finding:
	30	if not package.has(rule.table):
	31	return Finding(rule, NOT_APPLICABLE, f"table '{rule.table}' not in package")
	32
	33	rows = package.table(rule.table)
	34	check = rule.check
	35	ctype = check["type"]
	36
	37	if ctype == "assert_row":
	38	return _assert_row(rule, rows)
	39
	40	if ctype == "require_any_row":
	41	return _require_any_row(rule, rows)
	42
	43	# fail_rows_where / fail_if_any_rows both scan rows for failures.
	44	condition = check.get("when")
	45	if ctype == "fail_if_any_rows" and condition is None:
	46	failing = list(rows)
	47	else:
	48	# fail_rows_where requires a condition; fail_if_any_rows may filter too.
	49	if condition is None:
	50	raise ValueError(f"{rule.id}: check needs a 'when' condition")
	51	failing = [r for r in rows if match(condition, r)]
	52
	53	if failing:
	54	noun = "row" if len(failing) == 1 else "rows"
	55	return Finding(rule, FAIL, f"{len(failing)} {noun} failed the check", failing)
	56
	57	# A present-but-empty table means the scan found nothing to fault — the
	58	# absence of bad rows is a pass (e.g. no publicly readable buckets).
	59	if not rows:
	60	return Finding(rule, PASS, "no rows present — no violations found")
	61	return Finding(rule, PASS, f"all {len(rows)} rows passed the check")
	62
	63
	64	def _assert_row(rule: Rule, rows: list[Row]) -> Finding:
	65	"""Assert conditions against a single-row configuration table."""
	66	if not rows:
	67	return Finding(rule, NOT_APPLICABLE, f"table '{rule.table}' is empty")
	68
	69	row = rows[0]
	70	failed = [req for req in rule.check.get("require", []) if not match(req, row)]
	71	if failed:
	72	columns = ", ".join(req.get("column", "?") for req in failed)
	73	return Finding(rule, FAIL, f"configuration failed on: {columns}", [row])
	74	return Finding(rule, PASS, "configuration meets all requirements")
	75
	76
	77	def _require_any_row(rule: Rule, rows: list[Row]) -> Finding:
	78	"""Pass if at least one row satisfies the condition; fail otherwise."""
	79	condition = rule.check.get("when")
	80	if condition is None:
	81	raise ValueError(f"{rule.id}: require_any_row needs a 'when' condition")
	82	if any(match(condition, row) for row in rows):
	83	return Finding(rule, PASS, "at least one row satisfies the requirement")
	84	reason = "no row satisfies the requirement" if rows else f"table '{rule.table}' is empty"
	85	return Finding(rule, FAIL, reason, rows)
	86
	87
	88	def evaluate(package: Package, ruleset: Ruleset) -> list[Finding]:
	89	"""Run every rule in ruleset against package."""
	90	return [_evaluate_rule(rule, package) for rule in ruleset.rules]
	91
	92
	93	def summarize(findings: list[Finding]) -> dict[str, int]:
	94	"""Count findings by status."""
	95	counts = {PASS: 0, FAIL: 0, NOT_APPLICABLE: 0}
	96	for finding in findings:
	97	counts[finding.status] += 1
	98	return counts
	99
	100
	101	# Worst-wins ordering when rolling several findings up to one control.
	102	_STATUS_RANK = {FAIL: 2, PASS: 1, NOT_APPLICABLE: 0}
	103
	104
	105	def control_coverage(findings: list[Finding]) -> dict[str, dict]:
	106	"""Roll findings up to a per-control view.
	107
	108	Returns ``{control: {"status": ..., "rules": [rule_id, ...]}}`` where a
	109	control's status is the worst status among the rules that cite it — one
	110	failing rule means the control is not fully evidenced.
	111	"""
	112	coverage: dict[str, dict] = {}
	113	for finding in findings:
	114	for control in finding.controls:
	115	entry = coverage.setdefault(control, {"status": NOT_APPLICABLE, "rules": []})
	116	entry["rules"].append(finding.rule.id)
	117	if _STATUS_RANK[finding.status] > _STATUS_RANK[entry["status"]]:
	118	entry["status"] = finding.status
	119	return dict(sorted(coverage.items()))

audit_report/loader.py added +83

		@@ -0,0 +1,83 @@
	1	"""Load an audit-tools evidence package from disk.
	2
	3	An evidence package is a directory of CSV files produced by audit-tools, named
	4	like ``github_audit_<org>_<date>/`` or ``aws_audit_<profile>_<date>/``. Each CSV
	5	becomes a table keyed by its filename stem (``iam_users.csv`` -> ``iam_users``).
	6	"""
	7
	8	from __future__ import annotations
	9
	10	import csv
	11	from dataclasses import dataclass, field
	12	from pathlib import Path
	13
	14	# Directory-name prefixes audit-tools uses, mapped to a platform key.
	15	_PLATFORM_PREFIXES = {
	16	"aws_audit_": "aws",
	17	"github_audit_": "github",
	18	"gitlab_audit_": "gitlab",
	19	}
	20
	21	Row = dict[str, str]
	22	Table = list[Row]
	23
	24
	25	@dataclass
	26	class Package:
	27	"""A loaded evidence package."""
	28
	29	path: Path
	30	platform: str
	31	subject: str # the org / profile the audit was run against
	32	tables: dict[str, Table] = field(default_factory=dict)
	33
	34	def table(self, name: str) -> Table:
	35	"""Return a table by name, or an empty list if it is absent."""
	36	return self.tables.get(name, [])
	37
	38	def has(self, name: str) -> bool:
	39	"""True if the named CSV was present in the package."""
	40	return name in self.tables
	41
	42
	43	def detect_platform(dir_name: str) -> tuple[str, str]:
	44	"""Infer ``(platform, subject)`` from a package directory name.
	45
	46	``github_audit_audit-labs_2026-07-29`` -> ``("github", "audit-labs")``.
	47	Falls back to ``("unknown", <dir_name>)`` when no prefix matches.
	48	"""
	49	for prefix, platform in _PLATFORM_PREFIXES.items():
	50	if dir_name.startswith(prefix):
	51	rest = dir_name[len(prefix) :]
	52	# Strip a trailing ISO date (…_YYYY-MM-DD) to recover the subject.
	53	parts = rest.rsplit("_", 1)
	54	subject = parts[0] if len(parts) == 2 and _looks_like_date(parts[1]) else rest
	55	return platform, subject or "unknown"
	56	return "unknown", dir_name
	57
	58
	59	def _looks_like_date(token: str) -> bool:
	60	bits = token.split("-")
	61	return len(bits) == 3 and all(b.isdigit() for b in bits)
	62
	63
	64	def load_package(path: str \| Path) -> Package:
	65	"""Load every ``.csv`` in path* into a :class:`Package`.
	66
	67	Raises ``FileNotFoundError`` if the directory does not exist and
	68	``ValueError`` if it contains no CSV files.
	69	"""
	70	directory = Path(path)
	71	if not directory.is_dir():
	72	raise FileNotFoundError(f"not a directory: {directory}")
	73
	74	platform, subject = detect_platform(directory.name)
	75	tables: dict[str, Table] = {}
	76	for csv_path in sorted(directory.glob("*.csv")):
	77	with csv_path.open(newline="", encoding="utf-8") as handle:
	78	tables[csv_path.stem] = list(csv.DictReader(handle))
	79
	80	if not tables:
	81	raise ValueError(f"no CSV files found in {directory}")
	82
	83	return Package(path=directory, platform=platform, subject=subject, tables=tables)

audit_report/reporters/__init__.py added +53

		@@ -0,0 +1,53 @@
	1	"""Report renderers. Each takes a :class:`Report` and returns a string."""
	2
	3	from __future__ import annotations
	4
	5	from dataclasses import dataclass
	6	from datetime import datetime, timezone
	7
	8	from ..engine import Finding, control_coverage, summarize
	9	from ..loader import Package
	10	from . import html as _html
	11	from . import json as _json
	12	from . import markdown as _markdown
	13
	14
	15	@dataclass
	16	class Report:
	17	"""Everything a renderer needs: the package, findings, and rollups."""
	18
	19	package: Package
	20	findings: list[Finding]
	21	generated_at: str
	22
	23	@property
	24	def counts(self) -> dict[str, int]:
	25	return summarize(self.findings)
	26
	27	@property
	28	def coverage(self) -> dict[str, dict]:
	29	return control_coverage(self.findings)
	30
	31
	32	def build_report(package: Package, findings: list[Finding]) -> Report:
	33	"""Assemble a :class:`Report` with a UTC generation timestamp."""
	34	stamp = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M UTC")
	35	return Report(package=package, findings=findings, generated_at=stamp)
	36
	37
	38	RENDERERS = {
	39	"md": _markdown.render,
	40	"html": _html.render,
	41	"json": _json.render,
	42	}
	43
	44	# File extension per format (md and markdown both write .md).
	45	EXTENSIONS = {"md": "md", "html": "html", "json": "json"}
	46
	47
	48	def render(report: Report, fmt: str) -> str:
	49	"""Render report in the named format ('md', 'html', or 'json')."""
	50	try:
	51	return RENDERERS[fmt](report)
	52	except KeyError:
	53	raise ValueError(f"unknown format: {fmt!r}") from None

audit_report/reporters/html.py added +165

		@@ -0,0 +1,165 @@
	1	"""HTML renderer — a self-contained, printable evidence report.
	2
	3	No external assets: all CSS is inlined so the file can be attached to an audit
	4	workpaper and opened anywhere, including offline.
	5	"""
	6
	7	from __future__ import annotations
	8
	9	from html import escape
	10	from typing import TYPE_CHECKING
	11
	12	from .. import catalog
	13	from ..engine import FAIL, NOT_APPLICABLE, PASS
	14
	15	if TYPE_CHECKING:
	16	from . import Report
	17
	18	_STATUS_LABEL = {PASS: "PASS", FAIL: "FAIL", NOT_APPLICABLE: "N/A"}
	19	_STATUS_CLASS = {PASS: "pass", FAIL: "fail", NOT_APPLICABLE: "na"}
	20	_SEVERITY_ORDER = {"high": 0, "medium": 1, "low": 2}
	21
	22	_CSS = """
	23	:root { color-scheme: light dark; }
	24	* { box-sizing: border-box; }
	25	body { font-family: -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif;
	26	margin: 0; padding: 2rem; line-height: 1.5; color: #1a1a1a; background: #fff; }
	27	main { max-width: 60rem; margin: 0 auto; }
	28	h1 { margin: 0 0 .25rem; font-size: 1.6rem; }
	29	h2 { margin: 2rem 0 .75rem; font-size: 1.25rem; border-bottom: 2px solid #e5e5e5; padding-bottom: .25rem; }
	30	.meta { color: #555; font-size: .9rem; margin: 0 0 1rem; }
	31	.meta code { background: #f2f2f2; padding: .05rem .3rem; border-radius: 3px; }
	32	.note { background: #f7f7f9; border-left: 3px solid #b9b9c6; padding: .6rem .9rem;
	33	font-size: .9rem; color: #444; border-radius: 0 4px 4px 0; }
	34	table { border-collapse: collapse; width: 100%; font-size: .85rem; margin: .5rem 0; }
	35	th, td { border: 1px solid #e0e0e0; padding: .35rem .5rem; text-align: left; vertical-align: top; }
	36	th { background: #f5f5f7; }
	37	.badge { display: inline-block; font-weight: 700; font-size: .72rem; letter-spacing: .03em;
	38	padding: .12rem .5rem; border-radius: 999px; }
	39	.badge.pass { background: #e5f6ea; color: #1a7f37; }
	40	.badge.fail { background: #fdeaea; color: #c1272d; }
	41	.badge.na { background: #eee; color: #666; }
	42	.finding { border: 1px solid #e5e5e5; border-radius: 6px; padding: 1rem 1.1rem; margin: .8rem 0; }
	43	.finding.fail { border-left: 4px solid #c1272d; }
	44	.finding.pass { border-left: 4px solid #1a7f37; }
	45	.finding.na { border-left: 4px solid #bbb; }
	46	.finding h3 { margin: 0 0 .5rem; font-size: 1.05rem; display: flex; gap: .5rem; align-items: center; }
	47	.finding dl { display: grid; grid-template-columns: max-content 1fr; gap: .2rem .8rem; margin: .4rem 0 0; font-size: .9rem; }
	48	.finding dt { color: #666; font-weight: 600; }
	49	.finding dd { margin: 0; }
	50	.summary-pills span { display: inline-block; margin-right: .5rem; font-weight: 600; }
	51	footer { margin-top: 3rem; font-size: .8rem; color: #888; border-top: 1px solid #eee; padding-top: .75rem; }
	52	@media (prefers-color-scheme: dark) {
	53	body { color: #e6e6e6; background: #16171a; }
	54	h2 { border-color: #333; }
	55	.meta { color: #aaa; } .meta code { background: #26272b; }
	56	.note { background: #1e1f24; border-color: #444; color: #bbb; }
	57	th, td { border-color: #333; } th { background: #202126; }
	58	.finding { border-color: #2d2e33; }
	59	.badge.pass { background: #12321d; color: #4ac36a; }
	60	.badge.fail { background: #3a1416; color: #ff6b70; }
	61	.badge.na { background: #26272b; color: #999; }
	62	footer { border-color: #2a2b30; }
	63	}
	64	"""
	65
	66
	67	def _badge(status: str) -> str:
	68	return f'<span class="badge {_STATUS_CLASS[status]}">{_STATUS_LABEL[status]}</span>'
	69
	70
	71	def _evidence_table(rows: list[dict[str, str]]) -> str:
	72	shown = rows[:10]
	73	headers = list(shown[0].keys())
	74	head = "".join(f"<th>{escape(h)}</th>" for h in headers)
	75	body = "".join(
	76	"<tr>" + "".join(f"<td>{escape(str(r.get(h, '')))}</td>" for h in headers) + "</tr>"
	77	for r in shown
	78	)
	79	extra = (
	80	f"<p class='meta'>+{len(rows) - len(shown)} more row(s) omitted.</p>"
	81	if len(rows) > len(shown)
	82	else ""
	83	)
	84	return f"<table><thead><tr>{head}</tr></thead><tbody>{body}</tbody></table>{extra}"
	85
	86
	87	def render(report: Report) -> str:
	88	pkg = report.package
	89	counts = report.counts
	90	parts: list[str] = []
	91
	92	parts.append(f"<h1>Evidence Report — {escape(pkg.subject)}</h1>")
	93	parts.append(
	94	f"<p class='meta'>Platform <code>{escape(pkg.platform)}</code> · "
	95	f"Source <code>{escape(pkg.path.name)}</code> · "
	96	f"Generated {escape(report.generated_at)}</p>"
	97	)
	98	parts.append(
	99	"<p class='summary-pills'>"
	100	f"<span>{_badge(FAIL)} {counts[FAIL]} failing</span>"
	101	f"<span>{_badge(PASS)} {counts[PASS]} passing</span>"
	102	f"<span>{_badge(NOT_APPLICABLE)} {counts[NOT_APPLICABLE]} not applicable</span>"
	103	"</p>"
	104	)
	105	parts.append(
	106	"<p class='note'>This report presents <strong>evidence</strong>, not a "
	107	"compliance verdict. A failing row means a setting is in a state that does "
	108	"not support a control; the final judgment belongs to the organization and "
	109	"its auditor.</p>"
	110	)
	111
	112	# Coverage matrix.
	113	parts.append("<h2>Control coverage</h2>")
	114	cov_rows = "".join(
	115	f"<tr><td>{escape(control)}</td><td>{escape(catalog.framework_of(control))}</td>"
	116	f"<td>{_badge(entry['status'])}</td>"
	117	f"<td><code>{escape(', '.join(entry['rules']))}</code></td>"
	118	f"<td>{escape(catalog.describe(control))}</td></tr>"
	119	for control, entry in report.coverage.items()
	120	)
	121	parts.append(
	122	"<table><thead><tr><th>Control</th><th>Framework</th><th>Status</th>"
	123	f"<th>Checked by</th><th>Description</th></tr></thead><tbody>{cov_rows}</tbody></table>"
	124	)
	125
	126	# Findings.
	127	parts.append("<h2>Findings</h2>")
	128	ordered = sorted(
	129	report.findings,
	130	key=lambda f: (f.status != FAIL, _SEVERITY_ORDER.get(f.rule.severity, 1)),
	131	)
	132	for finding in ordered:
	133	rule = finding.rule
	134	rows = [
	135	f"<dt>Rule</dt><dd><code>{escape(rule.id)}</code> · {escape(rule.severity)}</dd>",
	136	f"<dt>Controls</dt><dd>{escape(', '.join(rule.controls) or '—')}</dd>",
	137	f"<dt>Result</dt><dd>{escape(finding.reason)}</dd>",
	138	]
	139	if rule.rationale:
	140	rows.append(f"<dt>Why it matters</dt><dd>{escape(rule.rationale.strip())}</dd>")
	141	if finding.status == FAIL and rule.remediation:
	142	rows.append(f"<dt>Remediation</dt><dd>{escape(rule.remediation.strip())}</dd>")
	143	evidence = (
	144	_evidence_table(finding.evidence)
	145	if finding.status == FAIL and finding.evidence
	146	else ""
	147	)
	148	parts.append(
	149	f"<div class='finding {_STATUS_CLASS[finding.status]}'>"
	150	f"<h3>{_badge(finding.status)} {escape(rule.title)}</h3>"
	151	f"<dl>{''.join(rows)}</dl>{evidence}</div>"
	152	)
	153
	154	parts.append(
	155	"<footer>Generated by audit-report · Audit Labs · "
	156	"evidence, not a verdict.</footer>"
	157	)
	158
	159	body = "\n".join(parts)
	160	return (
	161	"<!doctype html><html lang='en'><head><meta charset='utf-8'>"
	162	"<meta name='viewport' content='width=device-width, initial-scale=1'>"
	163	f"<title>Evidence Report — {escape(pkg.subject)}</title>"
	164	f"<style>{_CSS}</style></head><body><main>{body}</main></body></html>\n"
	165	)

audit_report/reporters/json.py added +42

		@@ -0,0 +1,42 @@
	1	"""JSON renderer — a machine-readable record of the same findings.
	2
	3	Useful for feeding results into a dashboard, a ticket pipeline, or a diff
	4	between two audit runs.
	5	"""
	6
	7	from __future__ import annotations
	8
	9	import json as _json
	10	from typing import TYPE_CHECKING
	11
	12	if TYPE_CHECKING:
	13	from . import Report
	14
	15
	16	def to_dict(report: Report) -> dict:
	17	"""Serialize a report to a plain dict (stable key order for diffing)."""
	18	pkg = report.package
	19	return {
	20	"subject": pkg.subject,
	21	"platform": pkg.platform,
	22	"source_package": pkg.path.name,
	23	"generated_at": report.generated_at,
	24	"summary": report.counts,
	25	"coverage": report.coverage,
	26	"findings": [
	27	{
	28	"id": f.rule.id,
	29	"title": f.rule.title,
	30	"status": f.status,
	31	"severity": f.rule.severity,
	32	"controls": f.rule.controls,
	33	"reason": f.reason,
	34	"evidence": f.evidence,
	35	}
	36	for f in report.findings
	37	],
	38	}
	39
	40
	41	def render(report: Report) -> str:
	42	return _json.dumps(to_dict(report), indent=2, sort_keys=False) + "\n"

audit_report/reporters/markdown.py added +95

		@@ -0,0 +1,95 @@
	1	"""Markdown renderer — the auditor-facing evidence report."""
	2
	3	from __future__ import annotations
	4
	5	from typing import TYPE_CHECKING
	6
	7	from .. import catalog
	8	from ..engine import FAIL, NOT_APPLICABLE, PASS
	9
	10	if TYPE_CHECKING:
	11	from . import Report
	12
	13	_STATUS_LABEL = {PASS: "PASS", FAIL: "FAIL", NOT_APPLICABLE: "N/A"}
	14	_SEVERITY_ORDER = {"high": 0, "medium": 1, "low": 2}
	15
	16
	17	def _evidence_table(rows: list[dict[str, str]]) -> list[str]:
	18	"""Render up to a handful of evidence rows as a Markdown table."""
	19	if not rows:
	20	return []
	21	shown = rows[:10]
	22	headers = list(shown[0].keys())
	23	lines = [
	24	"\| " + " \| ".join(headers) + " \|",
	25	"\| " + " \| ".join("---" for _ in headers) + " \|",
	26	]
	27	for row in shown:
	28	lines.append("\| " + " \| ".join(str(row.get(h, "")) for h in headers) + " \|")
	29	if len(rows) > len(shown):
	30	lines.append(f"\n_+{len(rows) - len(shown)} more row(s) omitted._")
	31	return lines
	32
	33
	34	def render(report: Report) -> str:
	35	pkg = report.package
	36	counts = report.counts
	37	out: list[str] = []
	38
	39	out.append(f"# Evidence Report — {pkg.subject}")
	40	out.append("")
	41	out.append(f"- Platform: {pkg.platform}")
	42	out.append(f"- Subject: {pkg.subject}")
	43	out.append(f"- Source package: `{pkg.path.name}`")
	44	out.append(f"- Generated: {report.generated_at}")
	45	out.append(
	46	f"- Result: {counts[FAIL]} failing · {counts[PASS]} passing · "
	47	f"{counts[NOT_APPLICABLE]} not applicable"
	48	)
	49	out.append("")
	50	out.append(
	51	"> This report presents evidence, not a compliance verdict. A failing "
	52	"row means a setting is in a state that does not support a control; the "
	53	"final judgment belongs to the organization and its auditor."
	54	)
	55	out.append("")
	56
	57	# Control coverage matrix.
	58	out.append("## Control coverage")
	59	out.append("")
	60	out.append("\| Control \| Framework \| Status \| Checked by \| Description \|")
	61	out.append("\| --- \| --- \| --- \| --- \| --- \|")
	62	for control, entry in report.coverage.items():
	63	out.append(
	64	f"\| {control} \| {catalog.framework_of(control)} \| "
	65	f"{_STATUS_LABEL[entry['status']]} \| {', '.join(entry['rules'])} \| "
	66	f"{catalog.describe(control)} \|"
	67	)
	68	out.append("")
	69
	70	# Findings, failures first then by severity.
	71	out.append("## Findings")
	72	out.append("")
	73	ordered = sorted(
	74	report.findings,
	75	key=lambda f: (f.status != FAIL, _SEVERITY_ORDER.get(f.rule.severity, 1)),
	76	)
	77	for finding in ordered:
	78	rule = finding.rule
	79	out.append(f"### {_STATUS_LABEL[finding.status]} · {rule.title}")
	80	out.append("")
	81	out.append(f"- Rule: `{rule.id}` · Severity: {rule.severity}")
	82	out.append(f"- Controls: {', '.join(rule.controls) or '—'}")
	83	out.append(f"- Result: {finding.reason}")
	84	if rule.rationale:
	85	out.append(f"- Why it matters: {rule.rationale.strip()}")
	86	if finding.status == FAIL and rule.remediation:
	87	out.append(f"- Remediation: {rule.remediation.strip()}")
	88	out.append("")
	89	if finding.status == FAIL and finding.evidence:
	90	out.append("Evidence:")
	91	out.append("")
	92	out.extend(_evidence_table(finding.evidence))
	93	out.append("")
	94
	95	return "\n".join(out).rstrip() + "\n"

audit_report/rules.py added +140

		@@ -0,0 +1,140 @@
	1	"""Rule model and the small condition language rulesets are written in.
	2
	3	A ruleset is a YAML file: a platform name plus a list of rules. Each rule
	4	names a table, a check, the controls it maps to, and human text. Checks are
	5	evaluated by :mod:`audit_report.engine`.
	6
	7	The condition language is intentionally tiny. A condition is one of:
	8
	9	* a leaf ``{column, op, value}`` — test one column of a row
	10	* ``{all: [cond, ...]}`` — every sub-condition holds
	11	* ``{any: [cond, ...]}`` — at least one holds
	12	* ``{not: cond}`` — the sub-condition does not hold
	13
	14	Operators (``op``): ``equals``, ``not_equals``, ``is_true``, ``is_false``,
	15	``in``, ``not_in``, ``gt``, ``gte``, ``lt``, ``lte``, ``empty``, ``not_empty``.
	16	"""
	17
	18	from __future__ import annotations
	19
	20	from dataclasses import dataclass, field
	21	from pathlib import Path
	22
	23	import yaml
	24
	25	_TRUTHY = {"true", "yes", "1", "y", "t", "enabled", "on"}
	26	_FALSY = {"false", "no", "0", "n", "f", "disabled", "off", ""}
	27
	28	VALID_CHECK_TYPES = {
	29	"fail_rows_where",
	30	"fail_if_any_rows",
	31	"assert_row",
	32	"require_any_row",
	33	}
	34
	35
	36	@dataclass
	37	class Rule:
	38	"""A single control check declared in a ruleset."""
	39
	40	id: str
	41	title: str
	42	table: str
	43	check: dict
	44	severity: str = "medium"
	45	controls: list[str] = field(default_factory=list)
	46	rationale: str = ""
	47	remediation: str = ""
	48
	49
	50	@dataclass
	51	class Ruleset:
	52	"""A named collection of rules for one platform."""
	53
	54	platform: str
	55	rules: list[Rule]
	56
	57
	58	def _as_number(value: str) -> float \| None:
	59	try:
	60	return float(value)
	61	except (TypeError, ValueError):
	62	return None
	63
	64
	65	def match(condition: dict, row: dict[str, str]) -> bool:
	66	"""Return True if condition holds for row.
	67
	68	Raises ``ValueError`` on a malformed condition so ruleset bugs surface
	69	loudly rather than silently evaluating to False.
	70	"""
	71	if "all" in condition:
	72	return all(match(c, row) for c in condition["all"])
	73	if "any" in condition:
	74	return any(match(c, row) for c in condition["any"])
	75	if "not" in condition:
	76	return not match(condition["not"], row)
	77
	78	column = condition.get("column")
	79	op = condition.get("op")
	80	if column is None or op is None:
	81	raise ValueError(f"malformed condition: {condition!r}")
	82
	83	raw = row.get(column, "")
	84	value = condition.get("value")
	85	norm = raw.strip().lower()
	86
	87	if op == "equals":
	88	return norm == str(value).strip().lower()
	89	if op == "not_equals":
	90	return norm != str(value).strip().lower()
	91	if op == "is_true":
	92	return norm in _TRUTHY
	93	if op == "is_false":
	94	return norm in _FALSY
	95	if op == "empty":
	96	return raw.strip() == ""
	97	if op == "not_empty":
	98	return raw.strip() != ""
	99	if op in ("in", "not_in"):
	100	choices = {str(v).strip().lower() for v in (value or [])}
	101	return (norm in choices) if op == "in" else (norm not in choices)
	102	if op in ("gt", "gte", "lt", "lte"):
	103	left, right = _as_number(raw), _as_number(str(value))
	104	if left is None or right is None:
	105	return False
	106	return {
	107	"gt": left > right,
	108	"gte": left >= right,
	109	"lt": left < right,
	110	"lte": left <= right,
	111	}[op]
	112
	113	raise ValueError(f"unknown operator: {op!r}")
	114
	115
	116	def load_ruleset(path: str \| Path) -> Ruleset:
	117	"""Parse a ruleset YAML file into a :class:`Ruleset`, validating each rule."""
	118	data = yaml.safe_load(Path(path).read_text(encoding="utf-8")) or {}
	119	platform = data.get("platform")
	120	if not platform:
	121	raise ValueError(f"{path}: ruleset is missing a 'platform'")
	122
	123	rules: list[Rule] = []
	124	for entry in data.get("rules", []):
	125	rule = Rule(
	126	id=entry["id"],
	127	title=entry["title"],
	128	table=entry["table"],
	129	check=entry["check"],
	130	severity=entry.get("severity", "medium"),
	131	controls=entry.get("controls", []),
	132	rationale=entry.get("rationale", ""),
	133	remediation=entry.get("remediation", ""),
	134	)
	135	check_type = rule.check.get("type")
	136	if check_type not in VALID_CHECK_TYPES:
	137	raise ValueError(f"{rule.id}: unknown check type {check_type!r}")
	138	rules.append(rule)
	139
	140	return Ruleset(platform=platform, rules=rules)

audit_report/rulesets/aws.yaml added +130

		@@ -0,0 +1,130 @@
	1	# Ruleset: AWS
	2	#
	3	# Evaluated against an audit-tools AWS evidence package
	4	# (aws_audit_<profile>_<date>/). Each rule names a CSV table, a check, and the
	5	# controls the signal is offered as evidence for. A "fail" means a setting is in
	6	# a state that does NOT support the control — an auditor still owns the verdict.
	7	platform: aws
	8
	9	rules:
	10	- id: aws.iam.console-mfa
	11	title: Console users have MFA enabled
	12	table: iam_users
	13	severity: high
	14	controls: [SOC2:CC6.1, ISO:A.5.17, NIST:IA-2]
	15	rationale: >
	16	A user who can sign in to the console without a second factor is a single
	17	stolen password away from account access. MFA is the baseline control for
	18	interactive human access.
	19	remediation: Enforce MFA for all IAM users with console access, or remove their console password.
	20	check:
	21	type: fail_rows_where
	22	when:
	23	all:
	24	- {column: console_password, op: is_true}
	25	- {column: mfa_enabled, op: is_false}
	26
	27	- id: aws.iam.key-rotation
	28	title: Access keys are rotated within 90 days
	29	table: iam_users
	30	severity: medium
	31	controls: [ISO:A.5.17, NIST:IA-5]
	32	rationale: >
	33	Long-lived access keys widen the window in which a leaked credential is
	34	useful. Rotating keys bounds that exposure.
	35	remediation: Rotate or delete access keys older than 90 days.
	36	check:
	37	type: fail_rows_where
	38	when: {column: oldest_key_age_days, op: gt, value: 90}
	39
	40	- id: aws.root.mfa
	41	title: Root account has MFA enabled
	42	table: account_security
	43	severity: high
	44	controls: [SOC2:CC6.1, ISO:A.8.2, NIST:IA-2]
	45	rationale: >
	46	The root account can perform every action in the account and cannot be
	47	restricted by IAM policy. MFA on root is a foundational control.
	48	remediation: Enable a hardware or virtual MFA device on the root user.
	49	check:
	50	type: assert_row
	51	require:
	52	- {column: root_mfa_enabled, op: is_true}
	53
	54	- id: aws.root.no-access-keys
	55	title: Root account has no access keys
	56	table: account_security
	57	severity: high
	58	controls: [SOC2:CC6.1, ISO:A.8.2, NIST:AC-6]
	59	rationale: >
	60	Programmatic root access keys are unnecessary and dangerous — anything
	61	root can do should be done through named, least-privilege identities.
	62	remediation: Delete all access keys on the root user.
	63	check:
	64	type: assert_row
	65	require:
	66	- {column: root_access_keys_present, op: is_false}
	67
	68	- id: aws.iam.password-policy
	69	title: Account password policy meets baseline strength
	70	table: password_policy
	71	severity: medium
	72	controls: [ISO:A.5.17, NIST:IA-5]
	73	rationale: >
	74	A weak password policy undermines every password-based control. The
	75	baseline here — length, complexity, and rotation — reflects common
	76	hardening guidance.
	77	remediation: Set a minimum length of 14, require symbols and numbers, and cap password age at 90 days.
	78	check:
	79	type: assert_row
	80	require:
	81	- {column: minimum_length, op: gte, value: 14}
	82	- {column: require_symbols, op: is_true}
	83	- {column: require_numbers, op: is_true}
	84	- {column: max_age_days, op: lte, value: 90}
	85
	86	- id: aws.network.no-open-ssh
	87	title: No security group exposes SSH to the internet
	88	table: open_security_groups
	89	severity: high
	90	controls: [SOC2:CC6.6, ISO:A.8.20, NIST:SC-7]
	91	rationale: >
	92	SSH (port 22) reachable from 0.0.0.0/0 invites credential-stuffing and
	93	exploitation of the host directly from the public internet.
	94	remediation: Restrict inbound SSH to known CIDR ranges or a bastion, or use SSM Session Manager.
	95	check:
	96	type: fail_rows_where
	97	when:
	98	all:
	99	- {column: open_to, op: equals, value: 0.0.0.0/0}
	100	- {column: from_port, op: lte, value: 22}
	101	- {column: to_port, op: gte, value: 22}
	102
	103	- id: aws.s3.no-public-access
	104	title: No S3 bucket allows public access
	105	table: s3_public_access
	106	severity: high
	107	controls: [SOC2:CC6.6, ISO:A.8.20, NIST:SC-7]
	108	rationale: >
	109	Publicly readable or writable buckets are a leading cause of data
	110	exposure. audit-tools lists only buckets that permit public access, so any
	111	row here is a finding.
	112	remediation: Enable Block Public Access at the account and bucket level; remove public bucket policies and ACLs.
	113	check:
	114	type: fail_if_any_rows
	115
	116	- id: aws.cloudtrail.logging
	117	title: A multi-region CloudTrail is actively logging
	118	table: cloudtrail
	119	severity: high
	120	controls: [SOC2:CC7.2, ISO:A.8.15, NIST:AU-2]
	121	rationale: >
	122	Without an active trail there is no reliable record of account activity —
	123	the evidence auditors and responders rely on simply does not exist.
	124	remediation: Enable a multi-region CloudTrail with log file validation and confirm it is logging.
	125	check:
	126	type: require_any_row
	127	when:
	128	all:
	129	- {column: is_logging, op: is_true}
	130	- {column: multi_region, op: is_true}

audit_report/rulesets/github.yaml added +79

		@@ -0,0 +1,79 @@
	1	# Ruleset: GitHub
	2	#
	3	# Evaluated against an audit-tools GitHub evidence package
	4	# (github_audit_<org>_<date>/). Complements gh-attest: same spirit of mapping
	5	# GitHub signals to controls, applied offline to a captured CSV package.
	6	platform: github
	7
	8	rules:
	9	- id: github.org.require-2fa
	10	title: Organization requires two-factor authentication
	11	table: org_security
	12	severity: high
	13	controls: [SOC2:CC6.1, ISO:A.5.17, NIST:IA-2]
	14	rationale: >
	15	Org-enforced 2FA raises the floor for every member at once. Without it, a
	16	single member with a weak or reused password is an org-wide risk.
	17	remediation: Enable "Require two-factor authentication" in the organization security settings.
	18	check:
	19	type: assert_row
	20	require:
	21	- {column: two_factor_required, op: is_true}
	22
	23	- id: github.org.default-permission
	24	title: Base repository permission is read or less
	25	table: org_security
	26	severity: medium
	27	controls: [SOC2:CC6.3, ISO:A.5.15, NIST:AC-6]
	28	rationale: >
	29	A permissive base permission (write/admin for all members) violates least
	30	privilege by granting broad access that should be explicit.
	31	remediation: Set the organization base permission to "read" or "none" and grant write/admin per team.
	32	check:
	33	type: assert_row
	34	require:
	35	- {column: default_repo_permission, op: in, value: [read, none]}
	36
	37	- id: github.org.secret-scanning
	38	title: Secret scanning push protection is on for new repos
	39	table: org_security
	40	severity: medium
	41	controls: [SOC2:CC7.1, ISO:A.5.17, NIST:CM-6]
	42	rationale: >
	43	Push protection stops secrets from entering history in the first place,
	44	which is far cheaper than rotating a leaked credential after the fact.
	45	remediation: Enable secret scanning and push protection for new repositories at the org level.
	46	check:
	47	type: assert_row
	48	require:
	49	- {column: secret_scanning_push_protection_for_new_repos, op: is_true}
	50
	51	- id: github.branch.default-protected
	52	title: Default branches are protected
	53	table: branch_protections
	54	severity: high
	55	controls: [SOC2:CC8.1, ISO:A.8.32, NIST:CM-6]
	56	rationale: >
	57	An unprotected default branch can be force-pushed or have its history
	58	rewritten with no review — the change-management trail auditors expect is
	59	absent.
	60	remediation: Add a branch protection rule or ruleset covering the default branch of each repository.
	61	check:
	62	type: fail_rows_where
	63	when: {column: protected, op: is_false}
	64
	65	- id: github.branch.require-reviews
	66	title: Protected branches require at least one review
	67	table: branch_protections
	68	severity: medium
	69	controls: [SOC2:CC8.1, ISO:A.8.32, NIST:CM-6]
	70	rationale: >
	71	Required review is the core segregation-of-duties control in the SDLC: no
	72	change reaches the default branch without a second person approving it.
	73	remediation: Require at least one approving review on the default branch.
	74	check:
	75	type: fail_rows_where
	76	when:
	77	all:
	78	- {column: protected, op: is_true}
	79	- {column: required_reviews, op: lt, value: 1}

conftest.py added +11

		@@ -0,0 +1,11 @@
	1	"""Ensure the project root is importable and tests run from it.
	2
	3	Tests reference the bundled rulesets by the relative path
	4	``audit_report/rulesets``, so pytest must be invoked from the project root.
	5	This file's location pins that root for import resolution.
	6	"""
	7
	8	import sys
	9	from pathlib import Path
	10
	11	sys.path.insert(0, str(Path(__file__).parent))

pyproject.toml added +31

		@@ -0,0 +1,31 @@
	1	[build-system]
	2	requires = ["setuptools>=68"]
	3	build-backend = "setuptools.build_meta"
	4
	5	[project]
	6	name = "audit-report"
	7	version = "0.1.0"
	8	description = "Turn audit-tools evidence packages into control-mapped, auditor-ready reports."
	9	readme = "README.md"
	10	requires-python = ">=3.10"
	11	license = { text = "GPL-3.0-or-later" }
	12	authors = [{ name = "Audit Labs" }]
	13	dependencies = ["PyYAML>=6.0"]
	14
	15	[project.optional-dependencies]
	16	dev = ["pytest>=8.0", "ruff>=0.5"]
	17
	18	[project.scripts]
	19	audit-report = "audit_report.cli:main"
	20
	21	[project.urls]
	22	Homepage = "https://audit-labs.dev"
	23	Repository = "https://github.com/audit-labs/audit-report"
	24
	25	[tool.setuptools]
	26	packages = ["audit_report", "audit_report.reporters"]
	27	include-package-data = true
	28
	29	[tool.setuptools.package-data]
	30	# Ship the bundled rulesets inside the wheel so the CLI works after install.
	31	"audit_report" = ["rulesets/*.yaml"]

requirements-dev.txt added +3

		@@ -0,0 +1,3 @@
	1	PyYAML>=6.0
	2	pytest>=8.0
	3	ruff>=0.5

requirements.txt added +1

		@@ -0,0 +1 @@
	1	PyYAML>=6.0

ruff.toml added +14

		@@ -0,0 +1,14 @@
	1	# Ruff configuration for audit-tools.
	2	#
	3	# A few lint rules are disabled because they flag patterns this project uses
	4	# deliberately:
	5	#
	6	# BLE001 - The audit collectors and their CLI wrappers intentionally catch
	7	# broad exceptions so that one failing check never aborts a whole
	8	# audit run. The error is reported and collection continues.
	9	# DTZ011 - date.today() is used to build human-facing, date-stamped output
	10	# folder names, where the local date is the intended value.
	11	# S112 - try/except/continue is used to skip resources that are unavailable
	12	# during collection (e.g. a repo without the requested branch).
	13	[lint]
	14	ignore = ["BLE001", "DTZ011", "S112"]

tests/fixtures/aws_audit_acme_2026-01-01/account_security.csv added +2

		@@ -0,0 +1,2 @@
	1	root_mfa_enabled,root_access_keys_present,root_signing_certs_present,mfa_devices,users,groups,roles,policies
	2	True,False,False,2,2,0,5,0

tests/fixtures/aws_audit_acme_2026-01-01/cloudtrail.csv added +2

		@@ -0,0 +1,2 @@
	1	name,home_region,multi_region,log_file_validation,is_logging,s3_bucket
	2	main,us-east-1,True,True,True,acme-logs

tests/fixtures/aws_audit_acme_2026-01-01/iam_users.csv added +3

		@@ -0,0 +1,3 @@
	1	user,mfa_enabled,access_keys,oldest_key_age_days,console_password,password_last_used,created
	2	alice,True,1,30,True,2025-12-01T00:00:00+00:00,2025-01-01T00:00:00+00:00
	3	bob,False,1,400,True,2025-11-01T00:00:00+00:00,2025-02-01T00:00:00+00:00

tests/fixtures/aws_audit_acme_2026-01-01/open_security_groups.csv added +3

		@@ -0,0 +1,3 @@
	1	region,group_id,group_name,protocol,from_port,to_port,open_to
	2	us-east-1,sg-1,web,tcp,22,22,0.0.0.0/0
	3	us-east-1,sg-2,db,tcp,443,443,10.0.0.0/8

tests/fixtures/aws_audit_acme_2026-01-01/password_policy.csv added +2

		@@ -0,0 +1,2 @@
	1	minimum_length,require_symbols,require_numbers,require_uppercase,require_lowercase,allow_users_to_change,max_age_days,reuse_prevention,hard_expiry
	2	8,True,True,True,True,True,90,4,False

tests/fixtures/aws_audit_acme_2026-01-01/s3_public_access.csv added

tests/fixtures/github_audit_acme_2026-01-01/branch_protections.csv added +3

		@@ -0,0 +1,3 @@
	1	repo,branch,protected,protection_source,required_reviews,dismiss_stale_reviews,require_code_owner_reviews,required_status_checks,enforce_admins,restrictions
	2	app,main,True,ruleset,1,True,False,,,
	3	site,main,False,,,,,,,

tests/fixtures/github_audit_acme_2026-01-01/org_security.csv added +2

		@@ -0,0 +1,2 @@
	1	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
	2	acme,True,read,True,True,True,False,True,True,True

tests/test_engine.py added +95

		@@ -0,0 +1,95 @@
	1	"""Tests for rule evaluation against fixture packages, using bundled rulesets."""
	2
	3	from pathlib import Path
	4
	5	from audit_report.engine import (
	6	FAIL,
	7	NOT_APPLICABLE,
	8	PASS,
	9	control_coverage,
	10	evaluate,
	11	summarize,
	12	)
	13	from audit_report.loader import load_package
	14	from audit_report.rules import load_ruleset
	15
	16	FIXTURES = Path(__file__).parent / "fixtures"
	17	RULESETS = Path("audit_report/rulesets")
	18
	19
	20	def _run(pkg_name, ruleset_name):
	21	pkg = load_package(FIXTURES / pkg_name)
	22	ruleset = load_ruleset(RULESETS / ruleset_name)
	23	findings = evaluate(pkg, ruleset)
	24	return {f.rule.id: f for f in findings}
	25
	26
	27	def test_aws_fixture_findings():
	28	findings = _run("aws_audit_acme_2026-01-01", "aws.yaml")
	29
	30	# bob has a console password and no MFA -> one failing row.
	31	mfa = findings["aws.iam.console-mfa"]
	32	assert mfa.status == FAIL
	33	assert len(mfa.evidence) == 1
	34	assert mfa.evidence[0]["user"] == "bob"
	35
	36	# bob's key is 400 days old.
	37	assert findings["aws.iam.key-rotation"].status == FAIL
	38
	39	# Root is healthy in the fixture.
	40	assert findings["aws.root.mfa"].status == PASS
	41	assert findings["aws.root.no-access-keys"].status == PASS
	42
	43	# min length 8 < 14 -> policy fails.
	44	assert findings["aws.iam.password-policy"].status == FAIL
	45
	46	# Only the port-22 group is open to the world.
	47	ssh = findings["aws.network.no-open-ssh"]
	48	assert ssh.status == FAIL
	49	assert len(ssh.evidence) == 1
	50	assert ssh.evidence[0]["group_name"] == "web"
	51
	52	# Empty s3_public_access table means no public buckets -> pass.
	53	assert findings["aws.s3.no-public-access"].status == PASS
	54
	55	# A healthy multi-region trail exists.
	56	assert findings["aws.cloudtrail.logging"].status == PASS
	57
	58
	59	def test_github_fixture_findings():
	60	findings = _run("github_audit_acme_2026-01-01", "github.yaml")
	61	assert findings["github.org.require-2fa"].status == PASS
	62	assert findings["github.org.default-permission"].status == PASS
	63	assert findings["github.org.secret-scanning"].status == PASS
	64	# 'site' repo default branch is unprotected.
	65	branch = findings["github.branch.default-protected"]
	66	assert branch.status == FAIL
	67	assert branch.evidence[0]["repo"] == "site"
	68	# 'app' has 1 review, 'site' is unprotected -> require-reviews passes
	69	# (only counts protected branches with < 1 review).
	70	assert findings["github.branch.require-reviews"].status == PASS
	71
	72
	73	def test_not_applicable_when_table_absent(tmp_path):
	74	(tmp_path / "aws_audit_x_2026-01-01").mkdir()
	75	pkg_dir = tmp_path / "aws_audit_x_2026-01-01"
	76	(pkg_dir / "iam_users.csv").write_text(
	77	"user,mfa_enabled,console_password,oldest_key_age_days\n", encoding="utf-8"
	78	)
	79	pkg = load_package(pkg_dir)
	80	findings = {f.rule.id: f for f in evaluate(pkg, load_ruleset(RULESETS / "aws.yaml"))}
	81	# Tables that were never collected are reported as not applicable.
	82	assert findings["aws.root.mfa"].status == NOT_APPLICABLE
	83
	84
	85	def test_summary_and_coverage():
	86	pkg = load_package(FIXTURES / "aws_audit_acme_2026-01-01")
	87	findings = evaluate(pkg, load_ruleset(RULESETS / "aws.yaml"))
	88	counts = summarize(findings)
	89	assert counts[FAIL] + counts[PASS] + counts[NOT_APPLICABLE] == len(findings)
	90
	91	coverage = control_coverage(findings)
	92	# SC-7 is cited by the open-SSH rule (fails), so the control rolls up to fail.
	93	assert coverage["NIST:SC-7"]["status"] == FAIL
	94	# A control cited only by passing rules (both root checks) rolls up to pass.
	95	assert coverage["ISO:A.8.2"]["status"] == PASS

tests/test_loader.py added +47

		@@ -0,0 +1,47 @@
	1	"""Tests for package loading and platform detection."""
	2
	3	from pathlib import Path
	4
	5	import pytest
	6
	7	from audit_report.loader import detect_platform, load_package
	8
	9	FIXTURES = Path(__file__).parent / "fixtures"
	10
	11
	12	@pytest.mark.parametrize(
	13	("dir_name", "platform", "subject"),
	14	[
	15	("aws_audit_default_2026-07-29", "aws", "default"),
	16	("github_audit_audit-labs_2026-07-29", "github", "audit-labs"),
	17	("gitlab_audit_my_group_2026-01-01", "gitlab", "my_group"),
	18	("something_else", "unknown", "something_else"),
	19	],
	20	)
	21	def test_detect_platform(dir_name, platform, subject):
	22	assert detect_platform(dir_name) == (platform, subject)
	23
	24
	25	def test_load_package_reads_tables():
	26	pkg = load_package(FIXTURES / "aws_audit_acme_2026-01-01")
	27	assert pkg.platform == "aws"
	28	assert pkg.subject == "acme"
	29	assert pkg.has("iam_users")
	30	assert len(pkg.table("iam_users")) == 2
	31	assert pkg.table("iam_users")[0]["user"] == "alice"
	32	# Present-but-empty CSV is a known-empty table, not an absent one.
	33	assert pkg.has("s3_public_access")
	34	assert pkg.table("s3_public_access") == []
	35	# Absent table returns empty list, reports as not present.
	36	assert not pkg.has("nonexistent")
	37	assert pkg.table("nonexistent") == []
	38
	39
	40	def test_load_missing_directory_raises():
	41	with pytest.raises(FileNotFoundError):
	42	load_package(FIXTURES / "does-not-exist")
	43
	44
	45	def test_load_directory_without_csvs_raises(tmp_path):
	46	with pytest.raises(ValueError, match="no CSV files"):
	47	load_package(tmp_path)

tests/test_reporters.py added +97

		@@ -0,0 +1,97 @@
	1	"""Tests for the report renderers and the CLI entry point."""
	2
	3	import json
	4	from pathlib import Path
	5
	6	import pytest
	7
	8	from audit_report import reporters
	9	from audit_report.cli import main
	10	from audit_report.engine import evaluate
	11	from audit_report.loader import load_package
	12	from audit_report.rules import load_ruleset
	13
	14	FIXTURES = Path(__file__).parent / "fixtures"
	15	RULESETS = Path("audit_report/rulesets")
	16
	17
	18	def _report(pkg_name="aws_audit_acme_2026-01-01", ruleset="aws.yaml"):
	19	pkg = load_package(FIXTURES / pkg_name)
	20	findings = evaluate(pkg, load_ruleset(RULESETS / ruleset))
	21	return reporters.build_report(pkg, findings)
	22
	23
	24	def test_markdown_render_contains_sections():
	25	md = reporters.render(_report(), "md")
	26	assert "# Evidence Report — acme" in md
	27	assert "## Control coverage" in md
	28	assert "## Findings" in md
	29	assert "aws.network.no-open-ssh" in md
	30
	31
	32	def test_html_render_is_self_contained():
	33	html = reporters.render(_report(), "html")
	34	assert html.startswith("<!doctype html>")
	35	assert "<style>" in html
	36	# No external resource references.
	37	assert "http://" not in html and "https://" not in html
	38	assert "src=" not in html
	39
	40
	41	def test_json_render_roundtrips():
	42	data = json.loads(reporters.render(_report(), "json"))
	43	assert data["platform"] == "aws"
	44	assert data["subject"] == "acme"
	45	ids = {f["id"]: f["status"] for f in data["findings"]}
	46	assert ids["aws.iam.console-mfa"] == "fail"
	47
	48
	49	def test_html_escapes_evidence(tmp_path):
	50	pkg_dir = tmp_path / "aws_audit_x_2026-01-01"
	51	pkg_dir.mkdir()
	52	(pkg_dir / "open_security_groups.csv").write_text(
	53	"region,group_id,group_name,protocol,from_port,to_port,open_to\n"
	54	"us-east-1,sg-1,<script>x</script>,tcp,22,22,0.0.0.0/0\n",
	55	encoding="utf-8",
	56	)
	57	pkg = load_package(pkg_dir)
	58	report = reporters.build_report(pkg, evaluate(pkg, load_ruleset(RULESETS / "aws.yaml")))
	59	html = reporters.render(report, "html")
	60	assert "<script>x</script>" not in html
	61	assert "<script>" in html
	62
	63
	64	def test_unknown_format_raises():
	65	with pytest.raises(ValueError, match="unknown format"):
	66	reporters.render(_report(), "pdf")
	67
	68
	69	def test_cli_writes_files_and_exit_code(tmp_path):
	70	out = tmp_path / "out"
	71	code = main(
	72	[
	73	str(FIXTURES / "aws_audit_acme_2026-01-01"),
	74	"--format",
	75	"md,html,json",
	76	"--out",
	77	str(out),
	78	"--fail-on",
	79	"high",
	80	]
	81	)
	82	assert (out / "report.md").exists()
	83	assert (out / "report.html").exists()
	84	assert (out / "report.json").exists()
	85	# The AWS fixture has high-severity failures (open SSH), so exit is non-zero.
	86	assert code == 1
	87
	88
	89	def test_cli_fail_on_none_is_zero(tmp_path):
	90	code = main(
	91	[str(FIXTURES / "aws_audit_acme_2026-01-01"), "--format", "json", "--out", str(tmp_path)]
	92	)
	93	assert code == 0
	94
	95
	96	def test_cli_missing_package_returns_2():
	97	assert main([str(FIXTURES / "nope")]) == 2

tests/test_rules.py added +52

		@@ -0,0 +1,52 @@
	1	"""Unit tests for the condition language in audit_report.rules."""
	2
	3	import pytest
	4
	5	from audit_report.rules import match
	6
	7
	8	@pytest.mark.parametrize(
	9	("condition", "row", "expected"),
	10	[
	11	({"column": "x", "op": "equals", "value": "read"}, {"x": "read"}, True),
	12	({"column": "x", "op": "equals", "value": "Read"}, {"x": "read"}, True), # case-insensitive
	13	({"column": "x", "op": "not_equals", "value": "read"}, {"x": "write"}, True),
	14	({"column": "x", "op": "is_true"}, {"x": "True"}, True),
	15	({"column": "x", "op": "is_true"}, {"x": "yes"}, True),
	16	({"column": "x", "op": "is_false"}, {"x": "False"}, True),
	17	({"column": "x", "op": "is_false"}, {"x": ""}, True), # empty reads as false
	18	({"column": "x", "op": "gt", "value": 90}, {"x": "404"}, True),
	19	({"column": "x", "op": "gt", "value": 90}, {"x": "30"}, False),
	20	({"column": "x", "op": "lte", "value": 90}, {"x": "90"}, True),
	21	({"column": "x", "op": "gt", "value": 90}, {"x": ""}, False), # non-numeric -> False
	22	({"column": "x", "op": "in", "value": ["read", "none"]}, {"x": "none"}, True),
	23	({"column": "x", "op": "not_in", "value": ["read", "none"]}, {"x": "admin"}, True),
	24	({"column": "x", "op": "empty"}, {"x": " "}, True),
	25	({"column": "x", "op": "not_empty"}, {"x": "v"}, True),
	26	],
	27	)
	28	def test_leaf_conditions(condition, row, expected):
	29	assert match(condition, row) is expected
	30
	31
	32	def test_boolean_combinators():
	33	row = {"console_password": "True", "mfa_enabled": "False"}
	34	cond = {
	35	"all": [
	36	{"column": "console_password", "op": "is_true"},
	37	{"column": "mfa_enabled", "op": "is_false"},
	38	]
	39	}
	40	assert match(cond, row) is True
	41	assert match({"any": [{"column": "mfa_enabled", "op": "is_true"}]}, row) is False
	42	assert match({"not": {"column": "mfa_enabled", "op": "is_true"}}, row) is True
	43
	44
	45	def test_malformed_condition_raises():
	46	with pytest.raises(ValueError, match="malformed condition"):
	47	match({"value": "x"}, {"x": "y"})
	48
	49
	50	def test_unknown_operator_raises():
	51	with pytest.raises(ValueError, match="unknown operator"):
	52	match({"column": "x", "op": "wat"}, {"x": "y"})

Commit 217d893956

Commit `217d893956`