commit 4b8dff4d24be350cb68f9875fa711b36aaa74b4c Author: Squibid Date: Wed Dec 3 14:22:10 2025 -0500 initial commit diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..0c54294 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,13 @@ +# EditorConfig is awesome: https://editorconfig.org +# top-most EditorConfig file +root = true + +[*.md] +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true + +[*.nix] +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3389c86 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.zig-cache/ +zig-out/ 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..198b366 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# FOO UpDater +Declaratively keep your stuff up to date in your nixos config. + +## Usage +```nix +{ + description = "My flake config"; + inputs.fooud.url = "https://git.squi.bid/squi.bid/fooud"; + outputs = { self, nixpkgs, fooud }: { + nixosConfigurations.my-system = nixpkgs.lib.nixosSystem { + modules = [{ + services.nginx.virtualHosts."squi.bid" = { + root = fooud.lib.gitUpdater { + git = "https://git.squi.bid/squibid/squi.bid"; # the source of the data + dest = "/var/www/squi.bid"; # where should the files live on disk + keys = [ "BECE5684D3C4005D" ]; # requires the commit to be signed by me + check = "5m"; # we may be no more than 5 minutes out of date from the source + }; + + locations."/" = { + tryFiles = "$uri $uri.html $uri/"; + index = "index.html index.htm"; + }; + }; + }]; + }; + }; +} +``` + +# TODO +- extract archives +- support copying files from other parts of the filesystem (although that's rathar impure isn't it) +- add some checks diff --git a/build.zig b/build.zig new file mode 100644 index 0000000..a5104a3 --- /dev/null +++ b/build.zig @@ -0,0 +1,42 @@ +const std = @import("std"); + +pub fn build(b: *std.Build) void { + const target = b.standardTargetOptions(.{}); + const optimize = b.standardOptimizeOption(.{}); + + const mod = b.addModule("fooud", .{ + .root_source_file = b.path("src/main.zig"), + .target = target, + }); + + const exe = b.addExecutable(.{ + .name = "fooud", + .root_module = b.createModule(.{ + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + .imports = &.{ + .{ .name = "fooud", .module = mod }, + }, + }), + }); + + const dep_curl = b.dependency("curl", .{}); + + exe.root_module.addImport("curl", dep_curl.module("curl")); + exe.root_module.linkSystemLibrary("git2", .{}); + exe.root_module.linkSystemLibrary("gpgme", .{}); + exe.root_module.addIncludePath(b.path("src/util")); + exe.root_module.addCSourceFile(.{ .file = b.path("src/util/gpg_helper.c") }); + exe.linkLibC(); + + b.installArtifact(exe); + + const run_step = b.step("run", "Run the app"); + const run_cmd = b.addRunArtifact(exe); + run_step.dependOn(&run_cmd.step); + run_cmd.step.dependOn(b.getInstallStep()); + if (b.args) |args| { + run_cmd.addArgs(args); + } +} diff --git a/build.zig.zon b/build.zig.zon new file mode 100644 index 0000000..babc251 --- /dev/null +++ b/build.zig.zon @@ -0,0 +1,20 @@ +.{ + .name = .fooud, + .version = "1.0.0", + .fingerprint = 0xe809364a41c00a2b, // Changing this has security and trust implications. + .minimum_zig_version = "0.15.2", + .dependencies = .{ + .curl = .{ + .url = "https://github.com/jiacai2050/zig-curl/archive/refs/tags/v0.3.2.zip", + .hash = "curl-0.3.2-P4tT4SXPAACuV6f5eyh4jG_1SspjWwMm_vRJfoKrQep5", + }, + }, + .paths = .{ + "build.zig", + "build.zig.zon", + "src", + // For example... + //"LICENSE", + //"README.md", + }, +} diff --git a/build.zig.zon.nix b/build.zig.zon.nix new file mode 100644 index 0000000..5ce3c9a --- /dev/null +++ b/build.zig.zon.nix @@ -0,0 +1,34 @@ +# generated by zon2nix (https://github.com/nix-community/zon2nix) + +{ linkFarm, fetchzip, fetchgit }: + +linkFarm "zig-packages" [ + { + name = "N-V-__8AAFrtpQI1j9eOv7aN3lt3eH1TJfH4npAdRIrg2gGH"; + path = fetchzip { + url = "https://github.com/Mbed-TLS/mbedtls/archive/refs/tags/v3.6.0.tar.gz"; + hash = "sha256-yzGBkrqh+T/5GS66xL5zJstCmvcfG09TfxqA3F8UPJg="; + }; + } + { + name = "N-V-__8AAHipPQF9UuLPiaV1CtJzZIxvTN61tMGdFx8LGjIV"; + path = fetchzip { + url = "https://github.com/curl/curl/releases/download/curl-8_8_0/curl-8.8.0.tar.gz"; + hash = "sha256-Gqfe8iiC8aCBiuUVO6VYqW5DmqgSv5oS4XvMfQgbwFw="; + }; + } + { + name = "N-V-__8AAJj_QgDBhU17TCtcvdjOZZPDfkvxrEAyZkc14VN8"; + path = fetchzip { + url = "https://github.com/madler/zlib/releases/download/v1.3.1/zlib-1.3.1.tar.gz"; + hash = "sha256-acY8yFzIRYbrZ2CGODoxLnZuppsP6KZy19I9Yy77pfc="; + }; + } + { + name = "curl-0.3.2-P4tT4SXPAACuV6f5eyh4jG_1SspjWwMm_vRJfoKrQep5"; + path = fetchzip { + url = "https://github.com/jiacai2050/zig-curl/archive/refs/tags/v0.3.2.zip"; + hash = "sha256-1FjYirex2Q/zs5GLNtCGgClyV5/SW0GhxFHA1Hm+e4o="; + }; + } +] diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..4e7cf41 --- /dev/null +++ b/flake.lock @@ -0,0 +1,27 @@ +{ + "nodes": { + "nixpkgs": { + "locked": { + "lastModified": 1764733908, + "narHash": "sha256-QJiih52NU+nm7XQWCj+K8SwUdIEayDQ1FQgjkYISt4I=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "cadcc8de247676e4751c9d4a935acb2c0b059113", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixpkgs-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "nixpkgs": "nixpkgs" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..01f9a85 --- /dev/null +++ b/flake.nix @@ -0,0 +1,18 @@ +{ + description = "Declaratively update your data."; + inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; + outputs = { nixpkgs, ... }: { + lib = builtins.import ./lib.nix { pkgs = nixpkgs; }; + overlays.default = final: prev: { + fooud = prev.stdenv.mkDerivation rec { + pname = "fooud"; + version = "1.0"; + + src = ./.; + deps = prev.callPackage ./build.zig.zon.nix {}; + nativeBuildInputs = [ nixpkgs.zig.hook ]; + zigBuildFlags = [ "--system" "${deps}" ]; + }; + }; + }; +} diff --git a/lib.nix b/lib.nix new file mode 100644 index 0000000..a0052a2 --- /dev/null +++ b/lib.nix @@ -0,0 +1,55 @@ +{ pkgs, ... }: +let + lib = pkgs.lib; + defaultUpdater = { git ? null, url ? null, path ? null, keys ? null, dest, check }: + let + config.systemd.services."fooud-${dest}" = { + serviceConfig = { + Type = "oneshot"; + User = "root"; + Group = "root"; + ExecStart = let + dest = lib.assertMsg dest "dest must be set"; + remote = + if git then "--git " + git + else if url then "--url " + url + else if path then "--path " + path + else builtins.throw "one of git, url or path must be set"; + keys_str = if git then + lib.strings.concatStrings builtins.map (x: "--key ${x} ") keys + else throw "cannot use keys with git"; + + in pkgs.writeShellScript "fooud-${dest}-wrapper" '' + ${pkgs.fooud}/bin/fooud ${keys_str} ${remote} ${dest} + ''; + }; + }; + + config.systemd.timers.${dest} = { + wantedBy = [ "timers.target" ]; + timerConfig = { + OnActiveSec = "0s"; + OnUnitActiveSec = check; + Unit = "fooud-${dest}.service"; + Persistent = true; + }; + }; + in + dest; +in +let + gitUpdater = { git, keys, dest, check }: + defaultUpdater { git = git; keys = keys; dest = dest; check = check; }; + fsUpdater = { path, dest, check }: + defaultUpdater { path = path; dest = dest; check = check; }; + urlUpdater = { url, dest, check }: + defaultUpdater { url = url; dest = dest; check = check; }; + + lib = { + inherit + gitUpdater + fsUpdater + urlUpdater; + }; + in +lib diff --git a/src/NixStore.zig b/src/NixStore.zig new file mode 100644 index 0000000..fbbaed4 --- /dev/null +++ b/src/NixStore.zig @@ -0,0 +1,44 @@ +const NixStore = @This(); + +const std = @import("std"); + +const gpa = std.heap.page_allocator; + +const NixStoreError = error{ + Failure, +}; + +pub fn add(path: []const u8) NixStoreError![]const u8 { + const res = std.process.Child.run(.{ + .allocator = gpa, + .argv = &[_][]const u8{ "nix", "store", "add", path }, + }) catch return NixStoreError.Failure; + + return res.stdout[0 .. res.stdout.len - 1]; // to chop off the \n +} + +pub fn realize(store_path: []const u8) NixStoreError!void { + _ = std.process.Child.run(.{ + .allocator = gpa, + .argv = &[_][]const u8{ "nix-store", "--realize", store_path }, + }) catch return NixStoreError.Failure; + return; +} + +pub fn root(store_path: []const u8, root_path: []const u8) NixStoreError!void { + _ = std.process.Child.run(.{ + .allocator = gpa, + .argv = &[_][]const u8{ "nix-store", "--add-root", root_path, "--indirect", store_path }, + }) catch return NixStoreError.Failure; + return; +} + +pub fn delete(store_path: []const u8) NixStoreError!void { + _ = std.process.Child.run(.{ + .allocator = gpa, + .argv = &[_][]const u8{ "nix", "store", "delete", store_path }, + }) catch { + return NixStoreError.Failure; + }; + return; +} diff --git a/src/extractor.zig b/src/extractor.zig new file mode 100644 index 0000000..9995341 --- /dev/null +++ b/src/extractor.zig @@ -0,0 +1,3 @@ +const Extractor = @This(); + +// TODO: impl diff --git a/src/main.zig b/src/main.zig new file mode 100644 index 0000000..55423a5 --- /dev/null +++ b/src/main.zig @@ -0,0 +1,153 @@ +const std = @import("std"); + +const NixStore = @import("NixStore.zig"); +const Git = @import("remotes/Git.zig"); +const Curl = @import("remotes/Curl.zig"); +const Fs = @import("remotes/Fs.zig"); + +const gpa = std.heap.page_allocator; +const Options = enum { + git, + url, + path, + dest, + key, + extract, +}; + +const Config = struct { + const Remote = union(enum) { + git: []const u8, + url: []const u8, + path: []const u8, + none, + }; + remote: Remote, + dest: ?[]const u8, + keys: std.ArrayList([]const u8), + extract: bool, +}; + +pub fn main() !void { + var config: Config = .{ + .remote = .none, + .dest = null, + .keys = .empty, + .extract = false, + }; + + try check_args(&config); + + const tmp_dest = try std.fmt.allocPrint(gpa, "/tmp/{s}", .{config.dest.?}); + defer gpa.free(tmp_dest); + + // we're gonna delete the temp file(s) if they exist because we don't want + // to deal with them + var exists = true; + std.fs.cwd().access(tmp_dest, .{}) catch { + exists = false; + }; + if (exists) try std.fs.cwd().deleteTree(tmp_dest); + + const res = try switch (config.remote) { + .git => Git.get(config.remote.git, tmp_dest, try config.keys.toOwnedSlice(gpa)), + .url => Curl.get(config.remote.url, tmp_dest), + .path => Fs.get(config.remote.path, tmp_dest), + else => unreachable, + }; + defer std.fs.cwd().deleteTree(tmp_dest) catch {}; + + if (!res) { + std.log.err("failed to obtain the remote file(s)", .{}); + std.process.exit(1); + } + + if (config.extract) { + // TODO: impl + } + + // Now that we've gotten all our files it's time to add it to the nix store + const store_path = try NixStore.add(tmp_dest); + try NixStore.realize(store_path); + std.log.info("new store path: {s}", .{store_path}); + + // link the dest to the new nix store path + var dest_old_store_path: ?[]u8 = null; + while (true) { + std.fs.cwd().symLink(store_path, config.dest.?, .{}) catch |err| switch (err) { + error.PathAlreadyExists => { + // get the old nix store path + const buf: [1024]u8 = undefined; + dest_old_store_path = try std.fs.cwd().readLink(config.dest.?, @constCast(buf[0..])); + std.log.info("old store path: {s}", .{dest_old_store_path.?}); + + // if the old store path and the current store path are the + // same then don't do anything, nothing will change + if (std.mem.eql(u8, dest_old_store_path.?, store_path)) return; + + try std.fs.cwd().deleteFile(config.dest.?); + continue; + }, + else => { + if (dest_old_store_path) |path| { + try std.fs.cwd().symLink(path, config.dest.?, .{}); + } + return err; + }, + }; + try NixStore.root(store_path, config.dest.?); + break; + } + + // delete the old nix store path + if (dest_old_store_path) |path| { + std.log.info("deleting old store path: {s}", .{path}); + NixStore.delete(path) catch |err| if (err == error.Failure) return err; + } +} + +fn check_args(config: *Config) !void { + const iter = @constCast(&std.process.args()); + while (iter.next()) |arg| if (std.mem.eql(u8, arg[0..2], "--")) { + const t = std.meta.stringToEnum(Options, arg[2..]) orelse { + std.log.err("{s} is not a valid option", .{arg}); + std.process.exit(1); + }; + if (t == .extract) { // this option doesn't require arguments + config.extract = true; + continue; + } + const val = iter.next() orelse return error.Invalid; + switch (t) { + .git => config.remote = Config.Remote{ .git = val }, + .url => config.remote = Config.Remote{ .url = val }, + .path => config.remote = Config.Remote{ .path = val }, + .key => try config.keys.append(gpa, val), + .dest => config.dest = val, + else => unreachable, + } + }; + + var err = false; + if (config.remote == .none) { + std.log.err("you must set one of --git, --url, or --path", .{}); + err = true; + } + + if (config.dest == null) { + std.log.err("you must set a --dest", .{}); + err = true; + } + + if (config.keys.items.len > 0 and config.remote != .git) { + std.log.err("you can only check keys on a git repository", .{}); + err = true; + } + + if (config.extract and config.remote == .git) { + std.log.err("you cannot extract a git repository", .{}); + err = true; + } + + if (err) std.process.exit(1); +} diff --git a/src/remotes/Curl.zig b/src/remotes/Curl.zig new file mode 100644 index 0000000..fd9f986 --- /dev/null +++ b/src/remotes/Curl.zig @@ -0,0 +1,33 @@ +const Curl = @This(); + +const std = @import("std"); +const curl = @import("curl"); + +const gpa = std.heap.page_allocator; + +pub fn get(url: []const u8, dest: []const u8) !bool { + const ca_bundle = try curl.allocCABundle(gpa); + defer ca_bundle.deinit(); + const easy = try curl.Easy.init(.{ .ca_bundle = ca_bundle }); + defer easy.deinit(); + + // let's get that dest file opened up + const fp = try std.fs.cwd().createFile(dest, .{}); + defer fp.close(); + const buffer: [1024]u8 = undefined; + const writer = fp.writer(@constCast(&buffer)); + + var tmp_url = try gpa.alloc(u8, url.len + 1); + defer gpa.free(tmp_url); + @memcpy(tmp_url[0..url.len], url); + tmp_url[url.len] = 0; + + // download it + try easy.setUrl(@ptrCast(tmp_url)); + try easy.setWriter(@constCast(&writer.interface)); + const response = try easy.perform(); + if (response.status_code != 200) return false; + + try @constCast(&writer.interface).flush(); + return true; +} diff --git a/src/remotes/Fs.zig b/src/remotes/Fs.zig new file mode 100644 index 0000000..301414e --- /dev/null +++ b/src/remotes/Fs.zig @@ -0,0 +1,11 @@ +const Fs = @This(); + +const std = @import("std"); + +pub fn get(src: []const u8, dest: []const u8) !bool { + _ = src; + _ = dest; + + // TODO: impl + return false; +} diff --git a/src/remotes/Git.zig b/src/remotes/Git.zig new file mode 100644 index 0000000..f82f0b4 --- /dev/null +++ b/src/remotes/Git.zig @@ -0,0 +1,117 @@ +const Git = @This(); + +const std = @import("std"); +pub const c = @cImport({ + @cInclude("git2.h"); + @cInclude("gpgme.h"); + @cInclude("gpg_helper.h"); +}); + +pub const GitError = error{ + InitFailed, + OpenFailed, + NotFound, + InvalidObject, + InvalidReference, + OutOfMemory, + Unknown, +}; + +pub fn get(url: []const u8, dest: []const u8, keys: []const []const u8) !bool { + if (c.git_libgit2_init() < 0) return GitError.InitFailed; + defer _ = c.git_libgit2_shutdown(); + + var exists = true; + std.fs.cwd().access(dest, .{}) catch { + exists = false; + }; + + var repo: ?*c.git_repository = null; + if (!exists) repo = clone(url, dest) catch return false; + defer if (repo) |r| c.git_repository_free(r); + + if (keys.len <= 0) return repo != null; + return try check_signing_key(repo, keys); +} + +fn clone(url: []const u8, dest: []const u8) !?*c.git_repository { + var clone_opts: c.git_clone_options = undefined; + _ = c.git_clone_options_init(&clone_opts, c.GIT_CLONE_OPTIONS_VERSION); + var repo: ?*c.git_repository = null; + + const err = c.git_clone(&repo, url.ptr, dest.ptr, &clone_opts); + if (err != 0) { + const git_err = c.git_error_last(); + if (git_err != null and git_err.*.message != null) { + std.log.err("Clone error {d}: {s}", .{ err, git_err.*.message }); + } else { + std.log.err("Clone error {d}: ", .{err}); + } + return null; + } + + return repo; +} + +fn check_signing_key(repo: ?*c.git_repository, keys: []const []const u8) !bool { + var head_ref: ?*c.git_reference = null; + if (c.git_repository_head(&head_ref, repo) != 0) { + std.log.err("Failed to get HEAD", .{}); + return false; + } + defer c.git_reference_free(head_ref); + + const oid_ptr = c.git_reference_target(head_ref); + if (oid_ptr == null) { + std.log.err("HEAD is not pointing to a commit", .{}); + return false; + } + + var signature = c.git_buf{}; + var signed_data = c.git_buf{}; + if (c.git_commit_extract_signature(&signature, &signed_data, repo, @constCast(oid_ptr), null) != 0) { + std.log.err("HEAD commit is not signed", .{}); + return false; + } + defer c.git_buf_dispose(&signature); + defer c.git_buf_dispose(&signed_data); + + // gpg me + + _ = c.gpgme_check_version(null); + var ctx: c.gpgme_ctx_t = null; + _ = c.gpgme_new(&ctx); + defer _ = c.gpgme_release(ctx); + + var sig_data: c.gpgme_data_t = null; + var signed_text_data: c.gpgme_data_t = null; + _ = c.gpgme_data_new_from_mem(&sig_data, signature.ptr, signature.size, 0); + defer _ = c.gpgme_data_release(sig_data); + _ = c.gpgme_data_new_from_mem(&signed_text_data, signed_data.ptr, signed_data.size, 0); + defer _ = c.gpgme_data_release(signed_text_data); + + if (c.gpgme_op_verify(ctx, sig_data, signed_text_data, null) != 0) { + std.log.err("Failed to verify signature", .{}); + return false; + } + + const result = c.gpgme_op_verify_result(ctx); + if (result == null) { + std.log.err("No signature found in verification result", .{}); + return false; + } + + const fpr = c.first_signature_fpr(ctx); + if (fpr == null) { + std.log.err("No signature found", .{}); + return false; + } + + for (keys) |key| { + if (std.mem.eql(u8, std.mem.span(fpr + 24), key)) { + return true; + } + } + + return false; +} diff --git a/src/util/gpg_helper.c b/src/util/gpg_helper.c new file mode 100644 index 0000000..9cc5b88 --- /dev/null +++ b/src/util/gpg_helper.c @@ -0,0 +1,7 @@ +#include "gpg_helper.h" + +const char* first_signature_fpr(gpgme_ctx_t ctx) { + gpgme_verify_result_t result = gpgme_op_verify_result(ctx); + if (!result || !result->signatures) return NULL; + return result->signatures->fpr; +} diff --git a/src/util/gpg_helper.h b/src/util/gpg_helper.h new file mode 100644 index 0000000..3cfcda4 --- /dev/null +++ b/src/util/gpg_helper.h @@ -0,0 +1,3 @@ +#include + +const char* first_signature_fpr(gpgme_ctx_t ctx);