commit 5398ad123ceccaec07236cacc41c73d4c3946ece Author: Miguel Jacq Date: Sun Dec 14 20:53:22 2025 +1100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..07c956d --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +*.swp +*.pyc +__pycache__ +.pytest_cache +dist +.coverage +*.db +*.pdf +*.csv +*.html diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff6f353 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Enroll + +**enroll** inspects a Linux machine (currently Debian-only) and generates Ansible roles for things it finds running on the machine. + +It aims to be **optimistic and noninteractive**: +- Detects packages that have been installed +- Detects Debian package ownership of `/etc` files using dpkg’s local database. +- Captures config that has **changed from packaged defaults** (dpkg conffile hashes + package md5sums when available). +- Also captures **service-relevant custom/unowned files** under `/etc//...` (e.g. drop-in config includes). +- Defensively excludes likely secrets (path denylist + content sniff + size caps). +- Captures non-system users that exist on the system, and their SSH public keys + +## Install (Poetry) + +```bash +poetry install +poetry run enroll --help +``` + +## Usage + +On the host (root recommended): + +### 1. Generate a bundle of state/information about the host + +```bash +sudo poetry run enroll harvest --out /tmp/enroll-bundle +``` + +### 2. Generate Ansible manifests (roles/playbook) from that bundle + +```bash +sudo poetry run enroll manifest --bundle /tmp/enroll-bundle --out /tmp/enroll-ansible +``` + +### Alternatively, do both steps in one shot: + +```bash +sudo poetry run enroll export --bundle /tmp/enroll-bundle --out /tmp/enroll-ansible +``` + +Then run: + +```bash +ansible-playbook -i "localhost," -c local /tmp/enroll-ansible/playbook.yml +``` + + +## Notes / Safety + +- enroll **skips** common sensitive locations like `/etc/ssl/private/*`, `/etc/ssh/ssh_host_*`, and files that look like private keys/tokens. +- It also skips symlinks, binary-ish files, and large files by default. +- Review each generated role’s README before committing it anywhere. +- It only stores the raw config files. If you want to turn these into Jinja2 templates with dynamic inventory, see my other tool https://git.mig5.net/mig5/jinjaturtle . + + +## Troubleshooting + +- Run as root for the most complete harvest (`sudo ...`). diff --git a/enroll/__init__.py b/enroll/__init__.py new file mode 100644 index 0000000..a9a2c5b --- /dev/null +++ b/enroll/__init__.py @@ -0,0 +1 @@ +__all__ = [] diff --git a/enroll/__main__.py b/enroll/__main__.py new file mode 100644 index 0000000..9ae637f --- /dev/null +++ b/enroll/__main__.py @@ -0,0 +1,4 @@ +from .cli import main + +if __name__ == "__main__": + main() diff --git a/enroll/accounts.py b/enroll/accounts.py new file mode 100644 index 0000000..f47c0e4 --- /dev/null +++ b/enroll/accounts.py @@ -0,0 +1,145 @@ +from __future__ import annotations + +import os +from dataclasses import dataclass +from typing import Dict, List, Optional, Set, Tuple + + +@dataclass +class UserRecord: + name: str + uid: int + gid: int + gecos: str + home: str + shell: str + primary_group: str + supplementary_groups: List[str] + ssh_files: List[str] + + +def parse_login_defs(path: str = "/etc/login.defs") -> Dict[str, int]: + vals: Dict[str, int] = {} + try: + with open(path, "r", encoding="utf-8", errors="replace") as f: + for line in f: + line = line.strip() + if not line or line.startswith("#"): + continue + parts = line.split() + if len(parts) >= 2 and parts[0] in {"UID_MIN", "UID_MAX", "SYS_UID_MIN", "SYS_UID_MAX"}: + try: + vals[parts[0]] = int(parts[1]) + except ValueError: + continue + except FileNotFoundError: + pass + return vals + + +def parse_passwd(path: str = "/etc/passwd") -> List[Tuple[str, int, int, str, str, str]]: + rows: List[Tuple[str, int, int, str, str, str]] = [] + with open(path, "r", encoding="utf-8", errors="replace") as f: + for line in f: + line = line.rstrip("\n") + if not line or line.startswith("#"): + continue + parts = line.split(":") + if len(parts) < 7: + continue + name = parts[0] + try: + uid = int(parts[2]) + gid = int(parts[3]) + except ValueError: + continue + gecos = parts[4] + home = parts[5] + shell = parts[6] + rows.append((name, uid, gid, gecos, home, shell)) + return rows + + +def parse_group(path: str = "/etc/group") -> Tuple[Dict[int, str], Dict[str, int], Dict[str, Set[str]]]: + gid_to_name: Dict[int, str] = {} + name_to_gid: Dict[str, int] = {} + members: Dict[str, Set[str]] = {} + with open(path, "r", encoding="utf-8", errors="replace") as f: + for line in f: + line = line.rstrip("\n") + if not line or line.startswith("#"): + continue + parts = line.split(":") + if len(parts) < 4: + continue + name = parts[0] + try: + gid = int(parts[2]) + except ValueError: + continue + mem = set([m for m in parts[3].split(",") if m]) + gid_to_name[gid] = name + name_to_gid[name] = gid + members[name] = mem + return gid_to_name, name_to_gid, members + + +def is_human_user(uid: int, shell: str, uid_min: int) -> bool: + if uid < uid_min: + return False + shell = (shell or "").strip() + if shell in {"/usr/sbin/nologin", "/usr/bin/nologin", "/bin/false"}: + return False + return True + + +def find_user_ssh_files(home: str) -> List[str]: + sshdir = os.path.join(home, ".ssh") + out: List[str] = [] + if not os.path.isdir(sshdir): + return out + + ak = os.path.join(sshdir, "authorized_keys") + if os.path.isfile(ak) and not os.path.islink(ak): + out.append(ak) + + return sorted(set(out)) + + +def collect_non_system_users() -> List[UserRecord]: + defs = parse_login_defs() + uid_min = defs.get("UID_MIN", 1000) + + passwd_rows = parse_passwd() + gid_to_name, _, group_members = parse_group() + + users: List[UserRecord] = [] + for name, uid, gid, gecos, home, shell in passwd_rows: + if name in {"root", "nobody"}: + continue + if not is_human_user(uid, shell, uid_min): + continue + + primary_group = gid_to_name.get(gid, str(gid)) + + supp: List[str] = [] + for gname, mem in group_members.items(): + if name in mem and gname != primary_group: + supp.append(gname) + supp = sorted(set(supp)) + + ssh_files = find_user_ssh_files(home) if home and home.startswith("/") else [] + + users.append(UserRecord( + name=name, + uid=uid, + gid=gid, + gecos=gecos, + home=home, + shell=shell, + primary_group=primary_group, + supplementary_groups=supp, + ssh_files=ssh_files, + )) + + return users diff --git a/enroll/cli.py b/enroll/cli.py new file mode 100644 index 0000000..abdc01f --- /dev/null +++ b/enroll/cli.py @@ -0,0 +1,32 @@ +from __future__ import annotations + +import argparse +from .harvest import harvest +from .manifest import manifest + + +def main() -> None: + ap = argparse.ArgumentParser(prog="enroll") + sub = ap.add_subparsers(dest="cmd", required=True) + + h = sub.add_parser("harvest", help="Harvest service/package/config state into a bundle") + h.add_argument("--out", required=True, help="Bundle output directory") + + r = sub.add_parser("manifest", help="Render Ansible roles from a harvested bundle") + r.add_argument("--bundle", required=True, help="Path to the bundle directory created by the harvest command") + r.add_argument("--out", required=True, help="Output directory for generated roles/playbook Ansible manifest") + + e = sub.add_parser("export", help="Harvest then manifest in one shot") + e.add_argument("--bundle", required=True, help="Path to the directory to place the bundle in") + e.add_argument("--out", required=True, help="Output directory for generated roles/playbook Ansible manifest") + + args = ap.parse_args() + + if args.cmd == "harvest": + path = harvest(args.out) + print(path) + elif args.cmd == "manifest": + manifest(args.bundle, args.out) + elif args.cmd == "export": + harvest(args.bundle) + manifest(args.bundle, args.out) diff --git a/enroll/debian.py b/enroll/debian.py new file mode 100644 index 0000000..2874403 --- /dev/null +++ b/enroll/debian.py @@ -0,0 +1,175 @@ +from __future__ import annotations + +import glob +import hashlib +import os +import subprocess +from typing import Dict, List, Optional, Set, Tuple + + +def _run(cmd: list[str]) -> str: + p = subprocess.run(cmd, check=False, text=True, capture_output=True) + if p.returncode != 0: + raise RuntimeError(f"Command failed: {cmd}\n{p.stderr}") + return p.stdout + + +def dpkg_owner(path: str) -> Optional[str]: + p = subprocess.run(["dpkg", "-S", path], text=True, capture_output=True) + if p.returncode != 0: + return None + left = p.stdout.split(":", 1)[0].strip() + pkg = left.split(":", 1)[0].strip() + return pkg or None + + + +def list_manual_packages() -> List[str]: + """Return packages marked as manually installed (apt-mark showmanual).""" + p = subprocess.run(["apt-mark", "showmanual"], text=True, capture_output=True) + if p.returncode != 0: + return [] + pkgs: List[str] = [] + for line in (p.stdout or "").splitlines(): + line = line.strip() + if not line or line.startswith("#"): + continue + pkgs.append(line) + return sorted(set(pkgs)) + +def build_dpkg_etc_index( + info_dir: str = "/var/lib/dpkg/info", +) -> Tuple[Set[str], Dict[str, str], Dict[str, Set[str]], Dict[str, List[str]]]: + """ + Returns: + owned_etc_paths: set of /etc paths owned by dpkg + etc_owner_map: /etc/path -> pkg + topdir_to_pkgs: "nginx" -> {"nginx-common", ...} based on /etc//... + pkg_to_etc_paths: pkg -> list of /etc paths it installs + """ + owned: Set[str] = set() + owner: Dict[str, str] = {} + topdir_to_pkgs: Dict[str, Set[str]] = {} + pkg_to_etc: Dict[str, List[str]] = {} + + for list_path in glob.glob(os.path.join(info_dir, "*.list")): + pkg_raw = os.path.basename(list_path)[:-5] # strip ".list" + pkg = pkg_raw.split(":", 1)[0] # drop arch suffix if present + + etc_paths: List[str] = [] + try: + with open(list_path, "r", encoding="utf-8", errors="replace") as f: + for line in f: + p = line.rstrip("\n") + if not p.startswith("/etc/"): + continue + owned.add(p) + owner.setdefault(p, pkg) + etc_paths.append(p) + + parts = p.split("/", 3) + if len(parts) >= 3 and parts[2]: + top = parts[2] + topdir_to_pkgs.setdefault(top, set()).add(pkg) + except FileNotFoundError: + continue + + if etc_paths: + pkg_to_etc.setdefault(pkg, []).extend(etc_paths) + + for k, v in list(pkg_to_etc.items()): + pkg_to_etc[k] = sorted(set(v)) + + return owned, owner, topdir_to_pkgs, pkg_to_etc + + +def parse_status_conffiles(status_path: str = "/var/lib/dpkg/status") -> Dict[str, Dict[str, str]]: + """ + pkg -> { "/etc/foo": md5hex, ... } based on dpkg status "Conffiles" field. + This md5 is the packaged baseline for the conffile. + """ + out: Dict[str, Dict[str, str]] = {} + + cur: Dict[str, str] = {} + key: Optional[str] = None + + def flush() -> None: + pkg = cur.get("Package") + if not pkg: + return + raw = cur.get("Conffiles") + if not raw: + return + m: Dict[str, str] = {} + for line in raw.splitlines(): + line = line.strip() + if not line: + continue + parts = line.split() + if len(parts) >= 2 and parts[0].startswith("/"): + m[parts[0]] = parts[1] + if m: + out[pkg] = m + + with open(status_path, "r", encoding="utf-8", errors="replace") as f: + for line in f: + if line.strip() == "": + if cur: + flush() + cur = {} + key = None + continue + if line[0].isspace() and key: + cur[key] += line + else: + if ":" in line: + k, v = line.split(":", 1) + key = k + cur[key] = v.lstrip() + + if cur: + flush() + return out + + +def read_pkg_md5sums(pkg: str) -> Dict[str, str]: + """ + relpath -> md5hex from /var/lib/dpkg/info/.md5sums + relpath has no leading slash, e.g. 'etc/nginx/nginx.conf' + """ + path = f"/var/lib/dpkg/info/{pkg}.md5sums" + if not os.path.exists(path): + return {} + m: Dict[str, str] = {} + with open(path, "r", encoding="utf-8", errors="replace") as f: + for line in f: + line = line.strip() + if not line: + continue + md5, rel = line.split(None, 1) + m[rel.strip()] = md5.strip() + return m + + +def file_md5(path: str) -> str: + h = hashlib.md5() + with open(path, "rb") as f: + for chunk in iter(lambda: f.read(1024 * 1024), b""): + h.update(chunk) + return h.hexdigest() + + +def stat_triplet(path: str) -> Tuple[str, str, str]: + st = os.stat(path, follow_symlinks=True) + mode = oct(st.st_mode & 0o777)[2:].zfill(4) + + import pwd, grp + try: + owner = pwd.getpwuid(st.st_uid).pw_name + except KeyError: + owner = str(st.st_uid) + try: + group = grp.getgrgid(st.st_gid).gr_name + except KeyError: + group = str(st.st_gid) + return owner, group, mode diff --git a/enroll/harvest.py b/enroll/harvest.py new file mode 100644 index 0000000..437cd66 --- /dev/null +++ b/enroll/harvest.py @@ -0,0 +1,474 @@ +from __future__ import annotations + +import glob +import json +import os +import shutil +from dataclasses import dataclass, asdict +from typing import Dict, List, Optional, Set + +from .systemd import list_enabled_services, get_unit_info, UnitQueryError +from .debian import ( + build_dpkg_etc_index, + dpkg_owner, + file_md5, + list_manual_packages, + parse_status_conffiles, + read_pkg_md5sums, + stat_triplet, +) +from .secrets import SecretPolicy +from .accounts import collect_non_system_users, UserRecord + + + +@dataclass +class ManagedFile: + path: str + src_rel: str + owner: str + group: str + mode: str + reason: str + + +@dataclass +class ExcludedFile: + path: str + reason: str + + +@dataclass +class ServiceSnapshot: + unit: str + role_name: str + packages: List[str] + managed_files: List[ManagedFile] + excluded: List[ExcludedFile] + notes: List[str] + + +@dataclass +class PackageSnapshot: + package: str + role_name: str + managed_files: List[ManagedFile] + excluded: List[ExcludedFile] + notes: List[str] + + +@dataclass +class UsersSnapshot: + role_name: str + users: List[dict] + managed_files: List[ManagedFile] + excluded: List[ExcludedFile] + notes: List[str] + + +ALLOWED_UNOWNED_EXTS = { + ".conf", ".cfg", ".ini", ".cnf", ".yaml", ".yml", ".json", ".toml", + ".rules", ".service", ".socket", ".timer", ".target", ".path", ".mount", + ".network", ".netdev", ".link", + "", # allow extensionless (common in /etc/default and /etc/init.d) +} + +MAX_UNOWNED_FILES_PER_ROLE = 400 + + +def _safe_name(s: str) -> str: + out: List[str] = [] + for ch in s: + out.append(ch if ch.isalnum() or ch in ("_", "-") else "_") + return "".join(out).replace("-", "_") + + +def _role_name_from_unit(unit: str) -> str: + base = unit.removesuffix(".service") + return _safe_name(base) + + +def _role_name_from_pkg(pkg: str) -> str: + return "pkg_" + _safe_name(pkg) + + +def _copy_into_bundle(bundle_dir: str, role_name: str, abs_path: str, src_rel: str) -> None: + dst = os.path.join(bundle_dir, "artifacts", role_name, src_rel) + os.makedirs(os.path.dirname(dst), exist_ok=True) + shutil.copy2(abs_path, dst) + + +def _is_confish(path: str) -> bool: + base = os.path.basename(path) + _, ext = os.path.splitext(base) + return ext in ALLOWED_UNOWNED_EXTS + + +def _hint_names(unit: str, pkgs: Set[str]) -> Set[str]: + base = unit.removesuffix(".service") + hints = {base} + if "@" in base: + hints.add(base.split("@", 1)[0]) + hints |= set(pkgs) + hints |= {h.split(".", 1)[0] for h in list(hints) if "." in h} + return {h for h in hints if h} + + +def _add_pkgs_from_etc_topdirs(hints: Set[str], topdir_to_pkgs: Dict[str, Set[str]], pkgs: Set[str]) -> None: + for h in hints: + for p in topdir_to_pkgs.get(h, set()): + pkgs.add(p) + + +def _maybe_add_specific_paths(hints: Set[str]) -> List[str]: + paths: List[str] = [] + for h in hints: + paths.extend([ + f"/etc/default/{h}", + f"/etc/init.d/{h}", + f"/etc/sysctl.d/{h}.conf", + f"/etc/logrotate.d/{h}", + ]) + return paths + + +def _scan_unowned_under_roots(roots: List[str], owned_etc: Set[str], limit: int = MAX_UNOWNED_FILES_PER_ROLE) -> List[str]: + found: List[str] = [] + for root in roots: + if not os.path.isdir(root): + continue + for dirpath, _, filenames in os.walk(root): + if len(found) >= limit: + return found + for fn in filenames: + if len(found) >= limit: + return found + p = os.path.join(dirpath, fn) + if not p.startswith("/etc/"): + continue + if p in owned_etc: + continue + if not os.path.isfile(p) or os.path.islink(p): + continue + if not _is_confish(p): + continue + found.append(p) + return found + + +def _topdirs_for_package(pkg: str, pkg_to_etc_paths: Dict[str, List[str]]) -> Set[str]: + topdirs: Set[str] = set() + for path in pkg_to_etc_paths.get(pkg, []): + parts = path.split("/", 3) + if len(parts) >= 3 and parts[1] == "etc" and parts[2]: + topdirs.add(parts[2]) + return topdirs + + +def harvest(bundle_dir: str, policy: Optional[SecretPolicy] = None) -> str: + policy = policy or SecretPolicy() + os.makedirs(bundle_dir, exist_ok=True) + + if hasattr(os, "geteuid") and os.geteuid() != 0: + print("Warning: not running as root; harvest may miss files or metadata.", flush=True) + + owned_etc, etc_owner_map, topdir_to_pkgs, pkg_to_etc_paths = build_dpkg_etc_index() + conffiles_by_pkg = parse_status_conffiles() + + # ------------------------- + # Service roles + # ------------------------- + service_snaps: List[ServiceSnapshot] = [] + for unit in list_enabled_services(): + role = _role_name_from_unit(unit) + + try: + ui = get_unit_info(unit) + except UnitQueryError as e: + service_snaps.append(ServiceSnapshot( + unit=unit, + role_name=role, + packages=[], + managed_files=[], + excluded=[], + notes=[str(e)], + )) + continue + + pkgs: Set[str] = set() + notes: List[str] = [] + excluded: List[ExcludedFile] = [] + managed: List[ManagedFile] = [] + candidates: Dict[str, str] = {} + + if ui.fragment_path: + p = dpkg_owner(ui.fragment_path) + if p: + pkgs.add(p) + + for exe in ui.exec_paths: + p = dpkg_owner(exe) + if p: + pkgs.add(p) + + for pth in ui.dropin_paths: + if pth.startswith("/etc/"): + candidates[pth] = "systemd_dropin" + + for ef in ui.env_files: + ef = ef.lstrip("-") + if any(ch in ef for ch in "*?["): + for g in glob.glob(ef): + if g.startswith("/etc/") and os.path.isfile(g): + candidates[g] = "systemd_envfile" + else: + if ef.startswith("/etc/") and os.path.isfile(ef): + candidates[ef] = "systemd_envfile" + + hints = _hint_names(unit, pkgs) + _add_pkgs_from_etc_topdirs(hints, topdir_to_pkgs, pkgs) + + for sp in _maybe_add_specific_paths(hints): + if not os.path.exists(sp): + continue + if sp in etc_owner_map: + pkgs.add(etc_owner_map[sp]) + else: + candidates.setdefault(sp, "custom_specific_path") + + for pkg in sorted(pkgs): + conff = conffiles_by_pkg.get(pkg, {}) + md5sums = read_pkg_md5sums(pkg) + for path in pkg_to_etc_paths.get(pkg, []): + if not os.path.isfile(path) or os.path.islink(path): + continue + if path in conff: + try: + current = file_md5(path) + except OSError: + continue + if current != conff[path]: + candidates.setdefault(path, "modified_conffile") + continue + rel = path.lstrip("/") + baseline = md5sums.get(rel) + if baseline: + try: + current = file_md5(path) + except OSError: + continue + if current != baseline: + candidates.setdefault(path, "modified_packaged_file") + + roots: List[str] = [] + for h in hints: + roots.extend([f"/etc/{h}", f"/etc/{h}.d"]) + for pth in _scan_unowned_under_roots(roots, owned_etc): + candidates.setdefault(pth, "custom_unowned") + + if not pkgs and not candidates: + notes.append("No packages or /etc candidates detected (unexpected for enabled service).") + + for path, reason in sorted(candidates.items()): + deny = policy.deny_reason(path) + if deny: + excluded.append(ExcludedFile(path=path, reason=deny)) + continue + try: + owner, group, mode = stat_triplet(path) + except OSError: + excluded.append(ExcludedFile(path=path, reason="unreadable")) + continue + src_rel = path.lstrip("/") + try: + _copy_into_bundle(bundle_dir, role, path, src_rel) + except OSError: + excluded.append(ExcludedFile(path=path, reason="unreadable")) + continue + managed.append(ManagedFile( + path=path, + src_rel=src_rel, + owner=owner, + group=group, + mode=mode, + reason=reason, + )) + + service_snaps.append(ServiceSnapshot( + unit=unit, + role_name=role, + packages=sorted(pkgs), + managed_files=managed, + excluded=excluded, + notes=notes, + )) + + # ------------------------- + # Manual package roles + # ------------------------- + manual_pkgs = list_manual_packages() + pkg_snaps: List[PackageSnapshot] = [] + + for pkg in manual_pkgs: + role = _role_name_from_pkg(pkg) + notes: List[str] = [] + excluded: List[ExcludedFile] = [] + managed: List[ManagedFile] = [] + candidates: Dict[str, str] = {} + + conff = conffiles_by_pkg.get(pkg, {}) + md5sums = read_pkg_md5sums(pkg) + + for path in pkg_to_etc_paths.get(pkg, []): + if not os.path.isfile(path) or os.path.islink(path): + continue + if path in conff: + try: + current = file_md5(path) + except OSError: + continue + if current != conff[path]: + candidates.setdefault(path, "modified_conffile") + continue + rel = path.lstrip("/") + baseline = md5sums.get(rel) + if baseline: + try: + current = file_md5(path) + except OSError: + continue + if current != baseline: + candidates.setdefault(path, "modified_packaged_file") + + topdirs = _topdirs_for_package(pkg, pkg_to_etc_paths) + roots: List[str] = [] + for td in sorted(topdirs): + roots.extend([f"/etc/{td}", f"/etc/{td}.d"]) + roots.extend([f"/etc/default/{td}"]) + roots.extend([f"/etc/init.d/{td}"]) + roots.extend([f"/etc/logrotate.d/{td}"]) + roots.extend([f"/etc/sysctl.d/{td}.conf"]) + + for pth in _scan_unowned_under_roots([r for r in roots if os.path.isdir(r)], owned_etc): + candidates.setdefault(pth, "custom_unowned") + + for r in roots: + if os.path.isfile(r) and not os.path.islink(r): + if r not in owned_etc and _is_confish(r): + candidates.setdefault(r, "custom_specific_path") + + for path, reason in sorted(candidates.items()): + deny = policy.deny_reason(path) + if deny: + excluded.append(ExcludedFile(path=path, reason=deny)) + continue + try: + owner, group, mode = stat_triplet(path) + except OSError: + excluded.append(ExcludedFile(path=path, reason="unreadable")) + continue + src_rel = path.lstrip("/") + try: + _copy_into_bundle(bundle_dir, role, path, src_rel) + except OSError: + excluded.append(ExcludedFile(path=path, reason="unreadable")) + continue + managed.append(ManagedFile( + path=path, + src_rel=src_rel, + owner=owner, + group=group, + mode=mode, + reason=reason, + )) + + if not pkg_to_etc_paths.get(pkg, []) and not managed: + notes.append("No /etc files detected for this package (may be a meta package).") + + pkg_snaps.append(PackageSnapshot( + package=pkg, + role_name=role, + managed_files=managed, + excluded=excluded, + notes=notes, + )) + + # ------------------------- + # Users role (non-system users) + # ------------------------- + users_notes: List[str] = [] + users_excluded: List[ExcludedFile] = [] + users_managed: List[ManagedFile] = [] + users_list: List[dict] = [] + + try: + us + except Exception as e: + user_records = [] + users_notes.append(f"Failed to enumerate users: {e!r}") + + users_role_name = "users" + + for u in user_records: + users_list.append({ + "name": u.name, + "uid": u.uid, + "gid": u.gid, + "gecos": u.gecos, + "home": u.home, + "shell": u.shell, + "primary_group": u.primary_group, + "supplementary_groups": u.supplementary_groups, + }) + + # Copy authorized_keys + for sf in u.ssh_files: + deny = policy.deny_reason(sf) + if deny: + users_excluded.append(ExcludedFile(path=sf, reason=deny)) + continue + + # Force safe modes; still record current owner/group for reference. + try: + owner, group, mode = stat_triplet(sf) + except OSError: + users_excluded.append(ExcludedFile(path=sf, reason="unreadable")) + continue + + src_rel = sf.lstrip("/") + try: + _copy_into_bundle(bundle_dir, users_role_name, sf, src_rel) + except OSError: + users_excluded.append(ExcludedFile(path=sf, reason="unreadable")) + continue + + reason = "authorized_keys" if sf.endswith("/authorized_keys") else "ssh_public_key" + users_managed.append(ManagedFile( + path=sf, + src_rel=src_rel, + owner=owner, + group=group, + mode=mode, + reason=reason, + )) + + users_snapshot = UsersSnapshot( + role_name=users_role_name, + users=users_list, + managed_files=users_managed, + excluded=users_excluded, + notes=users_notes, + ) + + state = { + "host": {"hostname": os.uname().nodename, "os": "debian"}, + "users": asdict(users_snapshot), + "services": [asdict(s) for s in service_snaps], + "manual_packages": manual_pkgs, + "package_roles": [asdict(p) for p in pkg_snaps], + } + + state_path = os.path.join(bundle_dir, "state.json") + with open(state_path, "w", encoding="utf-8") as f: + json.dump(state, f, indent=2, sort_keys=True) + return state_path diff --git a/enroll/manifest.py b/enroll/manifest.py new file mode 100644 index 0000000..b502abb --- /dev/null +++ b/enroll/manifest.py @@ -0,0 +1,392 @@ +from __future__ import annotations + +import json +import os +import shutil +from typing import Any, Dict, List + + +def _yaml_list(items: List[str], indent: int = 2) -> str: + pad = " " * indent + if not items: + return f"{pad}[]" + return "\n".join(f"{pad}- {x}" for x in items) + + +def _copy_artifacts(bundle_dir: str, role: str, role_dir: str) -> None: + artifacts_dir = os.path.join(bundle_dir, "artifacts", role) + if not os.path.isdir(artifacts_dir): + return + for root, _, files in os.walk(artifacts_dir): + for fn in files: + src = os.path.join(root, fn) + rel = os.path.relpath(src, artifacts_dir) + dst = os.path.join(role_dir, "files", rel) + os.makedirs(os.path.dirname(dst), exist_ok=True) + shutil.copy2(src, dst) + + +def _write_role_scaffold(role_dir: str) -> None: + os.makedirs(os.path.join(role_dir, "tasks"), exist_ok=True) + os.makedirs(os.path.join(role_dir, "handlers"), exist_ok=True) + os.makedirs(os.path.join(role_dir, "defaults"), exist_ok=True) + os.makedirs(os.path.join(role_dir, "meta"), exist_ok=True) + os.makedirs(os.path.join(role_dir, "files"), exist_ok=True) + + +def _write_playbook(path: str, roles: List[str]) -> None: + pb_lines = ["---", "- hosts: all", " become: true", " roles:"] + for r in roles: + pb_lines.append(f" - {r}") + with open(path, "w", encoding="utf-8") as f: + f.write("\n".join(pb_lines) + "\n") + + +def manifest(bundle_dir: str, out_dir: str) -> None: + state_path = os.path.join(bundle_dir, "state.json") + with open(state_path, "r", encoding="utf-8") as f: + state = json.load(f) + + services: List[Dict[str, Any]] = state.get("services", []) + package_roles: List[Dict[str, Any]] = state.get("package_roles", []) + users_snapshot: Dict[str, Any] = state.get("users", {}) + + os.makedirs(out_dir, exist_ok=True) + roles_root = os.path.join(out_dir, "roles") + os.makedirs(roles_root, exist_ok=True) + + manifested_users_roles: List[str] = [] + manifested_service_roles: List[str] = [] + manifested_pkg_roles: List[str] = [] + + # ------------------------- + # Users role (non-system users) + # ------------------------- + if users_snapshot and users_snapshot.get("users"): + role = users_snapshot.get("role_name", "users") + role_dir = os.path.join(roles_root, role) + _write_role_scaffold(role_dir) + _copy_artifacts(bundle_dir, role, role_dir) + + users = users_snapshot.get("users", []) + managed_files = users_snapshot.get("managed_files", []) + excluded = users_snapshot.get("excluded", []) + notes = users_snapshot.get("notes", []) + + # Build group set from users + group_names = set() + for u in users: + pg = u.get("primary_group") + if pg: + group_names.add(pg) + for g in u.get("supplementary_groups", []) or []: + group_names.add(g) + group_names = sorted(group_names) + + # defaults: store users list (handy for later), but tasks are explicit for readability + defaults = """--- +users_accounts: +""" + ("\n".join([f" - name: {u.get('name')}" for u in users]) + "\n") + with open(os.path.join(role_dir, "defaults", "main.yml"), "w", encoding="utf-8") as f: + f.write(defaults) + + with open(os.path.join(role_dir, "meta", "main.yml"), "w", encoding="utf-8") as f: + f.write("---\ndependencies: []\n") + + # tasks + lines: List[str] = ["---"] + # groups first (idempotent; safe even if already present) + for g in group_names: + lines.append(f"- name: Ensure group {g} exists") + lines.append(" ansible.builtin.group:") + lines.append(f" name: {g}") + lines.append(" state: present") + + # users + for u in users: + name = u["name"] + lines.append(f"- name: Ensure user {name} exists") + lines.append(" ansible.builtin.user:") + lines.append(f" name: {name}") + lines.append(f" uid: {u.get('uid')}") + lines.append(f" group: {u.get('primary_group')}") + supp = u.get("supplementary_groups") or [] + if supp: + lines.append(" groups: " + ",".join(supp)) + lines.append(" append: true") + lines.append(f" home: {u.get('home')}") + lines.append(" create_home: true") + if u.get("shell"): + lines.append(f" shell: {u.get('shell')}") + if u.get("gecos"): + # quote to avoid YAML surprises + gec = u.get("gecos").replace('"', '\"') + lines.append(f' comment: "{gec}"') + lines.append(" password_lock: true") + lines.append(" state: present") + + # Ensure ~/.ssh + home = u.get("home") or f"/home/{name}" + sshdir = home.rstrip("/") + "/.ssh" + lines.append(f"- name: Ensure {name} .ssh directory exists") + lines.append(" ansible.builtin.file:") + lines.append(f" path: {sshdir}") + lines.append(" state: directory") + lines.append(f" owner: {name}") + lines.append(f" group: {u.get('primary_group')}") + lines.append(" mode: '0700'") + + # Copy harvested SSH public material (authorized_keys + *.pub) + for mf in managed_files: + dest = mf["path"] + src = mf["src_rel"] + # Determine file owner from dest path: /home//... + owner = None + for u in users: + if dest.startswith((u.get("home") or "").rstrip("/") + "/"): + owner = u["name"] + group = u.get("primary_group") + break + if owner is None: + # fallback: try /home// + parts = dest.split("/") + owner = parts[2] if len(parts) > 2 and parts[1] == "home" else "root" + group = owner + + mode = "0600" if mf.get("reason") == "authorized_keys" else "0644" + lines.append(f"- name: Deploy {dest}") + lines.append(" ansible.builtin.copy:") + lines.append(f" src: {src}") + lines.append(f" dest: {dest}") + lines.append(f" owner: {owner}") + lines.append(f" group: {group}") + lines.append(f" mode: '{mode}'") + + tasks = "\n".join(lines).rstrip() + "\n" + with open(os.path.join(role_dir, "tasks", "main.yml"), "w", encoding="utf-8") as f: + f.write(tasks) + + # handlers (none needed) + with open(os.path.join(role_dir, "handlers", "main.yml"), "w", encoding="utf-8") as f: + f.write("---\n") + + readme = """# users + +Generated non-system user accounts and SSH public material. + +## Users +""" + ("\n".join([f"- {u.get('name')} (uid {u.get('uid')})" for u in users]) or "- (none)") + """\n +## Included SSH files +""" + ("\n".join([f"- {mf.get('path')} ({mf.get('reason')})" for mf in managed_files]) or "- (none)") + """\n +## Excluded +""" + ("\n".join([f"- {e.get('path')} ({e.get('reason')})" for e in excluded]) or "- (none)") + """\n +## Notes +""" + ("\n".join([f"- {n}" for n in notes]) or "- (none)") + """\n""" + with open(os.path.join(role_dir, "README.md"), "w", encoding="utf-8") as f: + f.write(readme) + + manifested_users_roles.append(role) + + # ------------------------- + # Service roles + # ------------------------- + for svc in services: + role = svc["role_name"] + unit = svc["unit"] + pkgs = svc["packages"] + managed_files = svc["managed_files"] + + role_dir = os.path.join(roles_root, role) + _write_role_scaffold(role_dir) + _copy_artifacts(bundle_dir, role, role_dir) + + var_prefix = role + + defaults = f"""--- +{var_prefix}_packages: +{_yaml_list(pkgs, indent=2)} +""" + with open(os.path.join(role_dir, "defaults", "main.yml"), "w", encoding="utf-8") as f: + f.write(defaults) + + handlers = """--- +- name: systemd daemon-reload + ansible.builtin.systemd: + daemon_reload: true + +- name: Restart service + ansible.builtin.service: + name: "{{ unit_name }}" + state: restarted +""" + with open(os.path.join(role_dir, "handlers", "main.yml"), "w", encoding="utf-8") as f: + f.write(handlers) + + systemd_files = [mf for mf in managed_files if mf["path"].startswith("/etc/systemd/system/")] + other_files = [mf for mf in managed_files if mf not in systemd_files] + + def copy_task(mf: Dict[str, Any], notify: str | None) -> str: + notify_line = f" notify: {notify}\n" if notify else "" + return f"""- name: Deploy {mf["path"]} + ansible.builtin.copy: + src: "{mf["src_rel"]}" + dest: "{mf["path"]}" + owner: "{mf["owner"]}" + group: "{mf["group"]}" + mode: "{mf["mode"]}" +{notify_line}""" + + task_parts: List[str] = [] + task_parts.append(f"""--- +- name: Set unit name + ansible.builtin.set_fact: + unit_name: "{unit}" + +- name: Install packages for {role} + ansible.builtin.apt: + name: "{{{{ {var_prefix}_packages }}}}" + state: present + update_cache: true + when: {var_prefix}_packages | length > 0 +""") + + if systemd_files: + for mf in systemd_files: + task_parts.append(copy_task(mf, "[systemd daemon-reload]")) + task_parts.append("""- name: Reload systemd to pick up unit changes + ansible.builtin.meta: flush_handlers +""") + + for mf in other_files: + task_parts.append(copy_task(mf, "[Restart service]")) + + task_parts.append(f"""- name: Ensure {unit} is enabled and running + ansible.builtin.service: + name: "{{{{ unit_name }}}}" + enabled: true + state: started +""") + + tasks = "\n".join(task_parts).rstrip() + "\n" + with open(os.path.join(role_dir, "tasks", "main.yml"), "w", encoding="utf-8") as f: + f.write(tasks) + + with open(os.path.join(role_dir, "meta", "main.yml"), "w", encoding="utf-8") as f: + f.write("---\ndependencies: []\n") + + excluded = svc.get("excluded", []) + notes = svc.get("notes", []) + readme = f"""# {role} + +Generated from `{unit}`. + +## Packages +{os.linesep.join("- " + p for p in pkgs) or "- (none detected)"} + +## Managed files +{os.linesep.join("- " + mf["path"] + " (" + mf["reason"] + ")" for mf in managed_files) or "- (none)"} + +## Excluded (possible secrets / unsafe) +{os.linesep.join("- " + e["path"] + " (" + e["reason"] + ")" for e in excluded) or "- (none)"} + +## Notes +{os.linesep.join("- " + n for n in notes) or "- (none)"} +""" + with open(os.path.join(role_dir, "README.md"), "w", encoding="utf-8") as f: + f.write(readme) + + manifested_service_roles.append(role) + + # ------------------------- + # Manual package roles + # ------------------------- + for pr in package_roles: + role = pr["role_name"] + pkg = pr["package"] + managed_files = pr["managed_files"] + + role_dir = os.path.join(roles_root, role) + _write_role_scaffold(role_dir) + _copy_artifacts(bundle_dir, role, role_dir) + + var_prefix = role + + defaults = f"""--- +{var_prefix}_packages: + - {pkg} +""" + with open(os.path.join(role_dir, "defaults", "main.yml"), "w", encoding="utf-8") as f: + f.write(defaults) + + handlers = """--- +- name: systemd daemon-reload + ansible.builtin.systemd: + daemon_reload: true +""" + with open(os.path.join(role_dir, "handlers", "main.yml"), "w", encoding="utf-8") as f: + f.write(handlers) + + systemd_files = [mf for mf in managed_files if mf["path"].startswith("/etc/systemd/system/")] + other_files = [mf for mf in managed_files if mf not in systemd_files] + + def copy_task(mf: Dict[str, Any], notify: str | None) -> str: + notify_line = f" notify: {notify}\n" if notify else "" + return f"""- name: Deploy {mf["path"]} + ansible.builtin.copy: + src: "{mf["src_rel"]}" + dest: "{mf["path"]}" + owner: "{mf["owner"]}" + group: "{mf["group"]}" + mode: "{mf["mode"]}" +{notify_line}""" + + task_parts: List[str] = [] + task_parts.append(f"""--- +- name: Install manual package {pkg} + ansible.builtin.apt: + name: "{{{{ {var_prefix}_packages }}}}" + state: present + update_cache: true +""") + + if systemd_files: + for mf in systemd_files: + task_parts.append(copy_task(mf, "[systemd daemon-reload]")) + task_parts.append("""- name: Reload systemd to pick up unit changes + ansible.builtin.meta: flush_handlers +""") + + for mf in other_files: + task_parts.append(copy_task(mf, None)) + + tasks = "\n".join(task_parts).rstrip() + "\n" + with open(os.path.join(role_dir, "tasks", "main.yml"), "w", encoding="utf-8") as f: + f.write(tasks) + + with open(os.path.join(role_dir, "meta", "main.yml"), "w", encoding="utf-8") as f: + f.write("---\ndependencies: []\n") + + excluded = pr.get("excluded", []) + notes = pr.get("notes", []) + readme = f"""# {role} + +Generated for manual package `{pkg}`. + +## Managed files +{os.linesep.join("- " + mf["path"] + " (" + mf["reason"] + ")" for mf in managed_files) or "- (none)"} + +## Excluded (possible secrets / unsafe) +{os.linesep.join("- " + e["path"] + " (" + e["reason"] + ")" for e in excluded) or "- (none)"} + +## Notes +{os.linesep.join("- " + n for n in notes) or "- (none)"} + +> Note: package roles do not attempt to restart or enable services automatically. +""" + with open(os.path.join(role_dir, "README.md"), "w", encoding="utf-8") as f: + f.write(readme) + + manifested_pkg_roles.append(role) + + # Playbooks + _write_playbook(os.path.join(out_dir, "playbook.yml"), manifested_users_roles + manifested_pkg_roles + manifested_service_roles) diff --git a/enroll/secrets.py b/enroll/secrets.py new file mode 100644 index 0000000..9797e61 --- /dev/null +++ b/enroll/secrets.py @@ -0,0 +1,65 @@ +from __future__ import annotations + +import fnmatch +import os +import re +from dataclasses import dataclass +from typing import Optional + + +DEFAULT_DENY_GLOBS = [ + "/etc/ssl/private/*", + "/etc/ssh/ssh_host_*", + "/etc/shadow", + "/etc/gshadow", + "/etc/*shadow", + "/etc/letsencrypt/*", +] + +SENSITIVE_CONTENT_PATTERNS = [ + re.compile(br"-----BEGIN (RSA |EC |OPENSSH |)PRIVATE KEY-----"), + re.compile(br"(?i)\bpassword\s*="), + re.compile(br"(?i)\b(pass|passwd|token|secret|api[_-]?key)\b"), +] + + +@dataclass +class SecretPolicy: + deny_globs: list[str] = None + max_file_bytes: int = 256_000 + sample_bytes: int = 64_000 + + def __post_init__(self) -> None: + if self.deny_globs is None: + self.deny_globs = list(DEFAULT_DENY_GLOBS) + + def deny_reason(self, path: str) -> Optional[str]: + for g in self.deny_globs: + if fnmatch.fnmatch(path, g): + return "denied_path" + + try: + st = os.stat(path, follow_symlinks=True) + except OSError: + return "unreadable" + + if st.st_size > self.max_file_bytes: + return "too_large" + + if not os.path.isfile(path) or os.path.islink(path): + return "not_regular_file" + + try: + with open(path, "rb") as f: + data = f.read(min(self.sample_bytes, st.st_size)) + except OSError: + return "unreadable" + + if b"\x00" in data: + return "binary_like" + + for pat in SENSITIVE_CONTENT_PATTERNS: + if pat.search(data): + return "sensitive_content" + + return None diff --git a/enroll/systemd.py b/enroll/systemd.py new file mode 100644 index 0000000..0cfbed0 --- /dev/null +++ b/enroll/systemd.py @@ -0,0 +1,90 @@ +from __future__ import annotations + +import re +import subprocess +from dataclasses import dataclass +from typing import List, Optional + + +@dataclass +class UnitInfo: + name: str + fragment_path: Optional[str] + dropin_paths: List[str] + env_files: List[str] + exec_paths: List[str] # binaries from ExecStart "path=" parts + + +class UnitQueryError(RuntimeError): + def __init__(self, unit: str, stderr: str): + self.unit = unit + self.stderr = (stderr or "").strip() + super().__init__(f"systemctl show failed for {unit}: {self.stderr}") + + +def _run(cmd: list[str]) -> str: + p = subprocess.run(cmd, check=False, text=True, capture_output=True) + if p.returncode != 0: + raise RuntimeError(f"Command failed: {cmd}\n{p.stderr}") + return p.stdout + + +def list_enabled_services() -> List[str]: + out = _run(["systemctl", "list-unit-files", "--type=service", "--state=enabled", "--no-legend"]) + units: List[str] = [] + for line in out.splitlines(): + parts = line.split() + if not parts: + continue + unit = parts[0].strip() + if not unit.endswith(".service"): + continue + # Skip template units like "getty@.service" which are enabled but not valid for systemctl show + if unit.endswith("@.service") or "@.service" in unit: + continue + units.append(unit) + return sorted(set(units)) + + +def get_unit_info(unit: str) -> UnitInfo: + p = subprocess.run( + [ + "systemctl", "show", unit, + "-p", "FragmentPath", + "-p", "DropInPaths", + "-p", "EnvironmentFiles", + "-p", "ExecStart", + "--no-page", + ], + check=False, + text=True, + capture_output=True, + ) + if p.returncode != 0: + raise UnitQueryError(unit, p.stderr) + + kv: dict[str, str] = {} + for line in (p.stdout or "").splitlines(): + if "=" in line: + k, v = line.split("=", 1) + kv[k] = v.strip() + + fragment = kv.get("FragmentPath") or None + + dropins = [pp for pp in (kv.get("DropInPaths", "") or "").split() if pp] + + env_files: List[str] = [] + for token in (kv.get("EnvironmentFiles", "") or "").split(): + token = token.lstrip("-") + if token: + env_files.append(token) + + exec_paths = re.findall(r"path=([^ ;}]+)", kv.get("ExecStart", "") or "") + + return UnitInfo( + name=unit, + fragment_path=fragment, + dropin_paths=sorted(set(dropins)), + env_files=sorted(set(env_files)), + exec_paths=sorted(set(exec_paths)), + ) diff --git a/poetry.lock b/poetry.lock new file mode 100644 index 0000000..a9b0222 --- /dev/null +++ b/poetry.lock @@ -0,0 +1,7 @@ +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. +package = [] + +[metadata] +lock-version = "2.0" +python-versions = "^3.10" +content-hash = "53f2eabc9c26446fbcc00d348c47878e118afc2054778c3c803a0a8028af27d9" diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..43c9c90 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,19 @@ +[tool.poetry] +name = "enroll" +version = "0.0.1" +description = "Enroll a server's running state retrospectively into Ansible" +authors = ["Miguel Jacq "] +license = "GPL-3.0-or-later" +readme = "README.md" +packages = [{ include = "enroll" }] +repository = "https://git.mig5.net/mig5/enroll" + +[tool.poetry.dependencies] +python = "^3.10" + +[tool.poetry.scripts] +enroll = "enroll.cli:main" + +[build-system] +requires = ["poetry-core>=1.8.0"] +build-backend = "poetry.core.masonry.api"