pi-hoole (empty) → 0.1.0.0
raw patch · 10 files changed
+1641/−0 lines, 10 filesdep +aesondep +basedep +base58-bytestringsetup-changed
Dependencies added: aeson, base, base58-bytestring, bytestring, containers, directory, filepath, http-types, megaparsec, optparse-generic, pi-hoole, process, regex-pcre, text, unix, wai, warp, yaml
Files
- ChangeLog.md +3/−0
- LICENSE +661/−0
- README.md +177/−0
- Setup.hs +2/−0
- app/cfg/Main.hs +135/−0
- app/shell/Main.hs +87/−0
- app/web/Main.hs +106/−0
- pi-hoole.cabal +94/−0
- src/PiHoole.hs +374/−0
- test/Spec.hs +2/−0
+ ChangeLog.md view
@@ -0,0 +1,3 @@+# Changelog for pi-hoole++## Unreleased changes
+ LICENSE view
@@ -0,0 +1,661 @@+ GNU AFFERO GENERAL PUBLIC LICENSE+ Version 3, 19 November 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU Affero General Public License is a free, copyleft license for+software and other kinds of works, specifically designed to ensure+cooperation with the community in the case of network server software.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+our General Public Licenses are 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.++ 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.++ Developers that use our General Public Licenses protect your rights+with two steps: (1) assert copyright on the software, and (2) offer+you this License which gives you legal permission to copy, distribute+and/or modify the software.++ A secondary benefit of defending all users' freedom is that+improvements made in alternate versions of the program, if they+receive widespread use, become available for other developers to+incorporate. Many developers of free software are heartened and+encouraged by the resulting cooperation. However, in the case of+software used on network servers, this result may fail to come about.+The GNU General Public License permits making a modified version and+letting the public access it on a server without ever releasing its+source code to the public.++ The GNU Affero General Public License is designed specifically to+ensure that, in such cases, the modified source code becomes available+to the community. It requires the operator of a network server to+provide the source code of the modified version running there to the+users of that server. Therefore, public use of a modified version, on+a publicly accessible server, gives the public access to the source+code of the modified version.++ An older license, called the Affero General Public License and+published by Affero, was designed to accomplish similar goals. This is+a different license, not a version of the Affero GPL, but Affero has+released a new version of the Affero GPL which permits relicensing under+this license.++ 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.++ Notwithstanding any other provision of this License, if you modify the+Program, your modified version must prominently offer all users+interacting with it remotely through a computer network (if your version+supports such interaction) an opportunity to receive the Corresponding+Source of your version by providing access to the Corresponding Source+from a network server at no charge, through some standard or customary+means of facilitating copying of software. This Corresponding Source+shall include the Corresponding Source for any work covered by version 3+of the GNU General Public License that is incorporated pursuant to the+following paragraph.++ 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 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 work with which it is combined will remain governed by version+3 of the GNU General Public License.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU Affero 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 Affero 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 Affero 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 Affero General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU Affero 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 Affero General Public License for more details.++ You should have received a copy of the GNU Affero General Public License+ along with this program. If not, see <http://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If your software can interact with users remotely through a computer+network, you should also make sure that it provides a way for users to+get its source. For example, if your program is a web application, its+interface could display a "Source" link that leads users to an archive+of the code. There are many ways you could offer source, and different+solutions will be better for different programs; see section 13 for the+specific requirements.++ 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 AGPL, see+<http://www.gnu.org/licenses/>.
+ README.md view
@@ -0,0 +1,177 @@+# pi-hoole++`pi-hoole` is a collection of tools to enforce access control for self-hosted+pijul repositories. It can be seen as a cgit-like solution, for authenticated+(public key, SSH) and anonymous accesses. You can grant read and write accesses+to a whole repository, or to a determined subset of branches.++`pi-hoole` is distributed under the terms of the AGPL v3.++## Getting Started++### Building From Source++It should not be a surprise that `pi-hoole` is versioned under `pijul`, with the+patch format introduced by `pijul-0.9`. Fair warning, use `pijul-0.10.1` and you+should be able to clone the `pi-hoole` repository.++```bash+pijul clone https://pijul.lthms.xyz/pijul/pi-hoole+```++Under the hood, `pi-hoole` is implemented in Haskell. We will need `stack` to+build it.++```bash+cd pi-hoole+stack build+```++We are using the latest lts available, but `pi-hoole` has already been built+with `lts-10` (but does not build with older ones).++This build three executables:++* `pi-hoole-cfg` generates a `.authorized_keys` file to enforce access control+ for SSH.+* `pi-hoole-shell` is called to determine if a authenticated user is allowed to+ perform a given `pijul` command.+* `pi-hoole-web` is a HTTP proxy to enforce access control for anonymous+ requests.++### Installing++In order to use `pi-hoole` on your server, the first step is to create a new,+dedicated user (*e.g.* `pijul`). You then need to make `pijul` and+`pi-hoole-shell` available to this user. Currently, we do not provide any+packaging solution to that end, but this might change in the future. Although it+is not mandatory, we consider both `pi-hoole-cfg` and `pi-hoole-web` have also+been made available for the `pijul` user.++### Configuring++`pi-hoole` executables assume the configuration files are stored at+`${XDG_CONFIG_DIRECTORY}/pi-hoole`, that is `~/.config/pi-hoole` by default.++In this directory, `pi-hoole` will scan the `keys/` directory, if it exists,+to know the list of authorized authenticated users. One user may have as many+public key as required. Keys should be saved in file with the following filename+scheme: `<user>(\.<label>)?\.pub`. Thus, `lthms.pub`, `lthms.laptop.pub` and+`lthms.work.pub` are three valid public key filenames for the `lthms` user.++To generate a `.ssh/authorized_keys`, use `pi-hoole-cfg`.++```bash+pi-hoole-cfg generate > ~/.ssh/authorized_keys+```++Resulting file will be of the forms:++ command="pi-hoole-shell \".lthms\" \"${SSH_ORIGINAL_COMMAND}\"",no-port-forwarding,no-x11-forwarding,no-agent-forwarding <ssh_keys_1>+ command="pi-hoole-shell \".lthms\" \"${SSH_ORIGINAL_COMMAND}\"",no-port-forwarding,no-x11-forwarding,no-agent-forwarding <ssh_keys_2>++To configure the authorized accesses for the users, you have to set up a valid+`pi-hoole` configuration file. The latter uses the YAML syntax, and is located+at `${XDG_CONFIG_DIRECTORY}/pi-hoole/config.yaml`. It has two root fields:+`groups` and `repositories`.++You can define groups of users, and grant certain rights to a group, effectively+granting there rights to each users who are member of the group.++Group names are prefixed by `+`, and user names are prefixed by `.`.++Then, if you want to create one group `ogma` which contains the users `lgeorget`+and `lthms`:++ groups:+ +ogma: [.lthms, .lgeorget]++You can create as many groups as you want, and one user may be added to several+groups. Currently, nested groups are not allowed (*i.e.* a group being member of+another group).++The `repositories` field allows for defining which repositories are available, and+what given users can do with these repositories. The contents of the+`repositories` is a map, where keys are `path` to the repositories (relative to+`HOME` directory), and values are maps from role to rights.++For instance, given the following configuration:++ repositories:+ my/first/repo:+ .lthms: +w+ +contrib: +r +w[master]+ anon: +r++ my/second/repo:+ .lthms: +r+ .lgeorget: +w++We declare two repositories, one located at `${HOME}/my/first/repo`, and another+at `${HOME}/my/second/repo`. The user `lthms` (identified with `.lthms`) can+read and write to this repository, to arbitrary branches. The members of the+group `contrib` can read to any branch, but can only write to the `master`+branch. Finally, the anonymous user (through HTTP), can read to any branch.++Read means being able to clone or pull. Write means being able to push.++For the second repository, `lthms` can read to any branch, when `lgeorget` can+read and write to any branch. Therefore, it is not possible to clone+`my/second/repo` through HTTP, because `anon` has not been granted any+particular rights.++### Setting Up HTTP Proxy++`pi-hoole-web` is a very simple HTTP proxy. It receives HTTP request, ideally+issued by a `pijul` client, and turns them into `pijul` commands if the `anon`+role has been granted the required rights.++Currently, `pi-hoole-web` cannot be configured, and listen the port 8080. Also,+it does not daemonify itself. The easiest way to set up a `pi-hoole-web`+instance in a reliable way is to use systemd, for instance with the following+unit:++```+[Unit]+Description=HTTP Proxy for Pijul anonymous accesses++[Service]+Type=simple+User=pijul+Group=pijul+ExecStart=/usr/bin/pi-hoole-web+Restart=of-failure+TimeoutStopSec=300++[Install]+WantedBy=multi-user.target+```++For reference, the instance of `pi-hoole-web` responsible for `pijul.lthms.xyz`+is behind a nginx server. One very straightforward nginx configuration can be:++```+server {+ listen 80;+ server_name pijul.lthms.xyz;++ access_log /var/log/nginx/pijul.lthms.xyz.access.log;+ error_log /var/log/nginx/pijul.lthms.xyz.error.log;++ location / {+ proxy_pass http://localhost:8080/;+ }+}+```++## Limitations++### Private Branches++The command `pijul patch` does not have an argument to specify the branch from+which a patch is initially fetched; as a consequence, having read access to a+repo, even for another branch where the patch is not applied, is enough. For+this reason, if a user who obtains a hash for a patch of a branch they cannot+access can fetch the patch. That is, a patch is as private as its hash. Private+branches will eventually be supported in a better manner, but for now, private+branches should mean separated repositories.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ app/cfg/Main.hs view
@@ -0,0 +1,135 @@+-- pi-hoole: lightweight access-control for pijul+-- Copyright (C) 2018 Thomas Letan <contact@thomasletan.fr>+--+-- This program is free software: you can redistribute it and/or modify+-- it under the terms of the GNU Affero 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 Affero General Public License for more details.+--+-- You should have received a copy of the GNU Affero General Public License+-- along with this program. If not, see <http://www.gnu.org/licenses/>.++{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE OverloadedStrings #-}++module Main where++import Control.Monad (filterM)+import Data.List (partition)+import Data.Map.Strict (Map)+import qualified Data.Map.Strict as M (adjustWithKey, empty, foldl, insert,+ insertWith, member, toList)+import Data.Maybe (isJust)+import Data.Set (Set)+import qualified Data.Set as S (foldl, singleton, toList, union)+import Data.Text (Text, append)+import qualified Data.Text as T (pack, strip, unpack)+import qualified Data.Text.IO as T (putStrLn, readFile)+import Data.Yaml (decodeFile)+import GHC.Generics (Generic)+import Options.Generic (ParseRecord, getRecord)+import PiHoole (Configuration, UserName (..))+import System.Directory (XdgDirectory (..), doesFileExist,+ getXdgDirectory, listDirectory)+import System.Environment (lookupEnv)+import System.FilePath (takeFileName, (</>))+import System.IO (hPutStrLn, stderr)+import Text.Regex.PCRE ((=~))++-------------------------------------------------------------------------------+data CLI = Generate (Maybe FilePath)+ | License+ deriving (Generic, Show)++instance ParseRecord CLI+-------------------------------------------------------------------------------++-------------------------------------------------------------------------------+main :: IO ()+main = getRecord "pi-hoole-cfg" >>= piHooleCfg++ where+ piHooleCfg License = putStrLn license++ piHooleCfg (Generate mdir) = do+ dir <- getKeysDir mdir+ (keys, discarded) <- splitCandidates <$> getPotentialKeys dir++ warn discarded++ generateAuthorizedKeys $ organize keys+++ warn (fp:rst) = do+ hPutStrLn stderr $ fp ++ ": not a correct key name"+ warn rst+ warn _ = pure ()+-------------------------------------------------------------------------------++-------------------------------------------------------------------------------+generateAuthorizedKeys :: Map UserName (Set FilePath) -> IO ()+generateAuthorizedKeys map = mapM_ (uncurry aux) (M.toList map)+ where+ aux user set = mapM_ (authorization user) (S.toList set)++ authorization :: UserName -> FilePath -> IO ()+ authorization (UserName user) fp = do+ key <- T.strip <$> T.readFile fp+ T.putStrLn $ cmd user `append` "," `append` options `append` " " `append` key++ options = "no-port-forwarding,no-x11-forwarding,no-agent-forwarding"+ cmd user = "command=\"pi-hoole-shell \\\"." `append` user `append` "\\\" \\\"${SSH_ORIGINAL_COMMAND}\\\"\""++organize :: [FilePath] -> Map UserName (Set FilePath)+organize = foldl aux M.empty+ where+ aux m fp =+ case keyOwner $ takeFileName fp of+ Just user -> M.insertWith S.union user (S.singleton fp) m+ _ -> m++getKeysDir :: Maybe FilePath -> IO FilePath+getKeysDir (Just dir) = pure dir+getKeysDir _ = getXdgDirectory XdgConfig "pi-hoole/keys"++isKey :: FilePath -> Bool+isKey = isJust . keyOwner . takeFileName++getPotentialKeys :: FilePath -> IO [FilePath]+getPotentialKeys dir = fmap (dir </>) <$> listDirectory dir+ >>= filterM doesFileExist++keyOwner :: FilePath -> Maybe UserName+keyOwner key = case key =~ regex of+ [[_, name, _]] -> Just (UserName $ T.pack name)+ _ -> Nothing+ where+ regex :: String+ regex = "^([a-zA-Z]*)(\\.[a-zA-Z]+)?\\.pub$"++splitCandidates :: [FilePath] -> ([FilePath], [FilePath])+splitCandidates = partition isKey++license :: String+license =+ unlines [ "Copyright (C) 2018 Thomas Letan <contact@thomasletan.fr>"+ , ""+ , "This program is free software: you can redistribute it and/or modify"+ , "it under the terms of the GNU Affero 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 Affero General Public License for more details."+ , ""+ , "You should have received a copy of the GNU Affero General Public License"+ , "along with this program. If not, see <http://www.gnu.org/licenses/>."+ ]+-------------------------------------------------------------------------------
+ app/shell/Main.hs view
@@ -0,0 +1,87 @@+-- pi-hoole: lightweight access-control for pijul+-- Copyright (C) 2018 Thomas Letan <contact@thomasletan.fr>+--+-- This program is free software: you can redistribute it and/or modify+-- it under the terms of the GNU Affero 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 Affero General Public License for more details.+--+-- You should have received a copy of the GNU Affero General Public License+-- along with this program. If not, see <http://www.gnu.org/licenses/>.++{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}++module Main where++import Data.Map.Strict (Map)+import qualified Data.Map.Strict as M (fromList)+import Data.Set (Set)+import qualified Data.Set as S (fromList)+import Data.Text (Text, append, pack, unpack)+import qualified Data.Text.IO as T (getLine)+import Data.Void (Void)+import Data.Yaml (decodeFile)+import PiHoole+import System.Directory (XdgDirectory (..), getXdgDirectory)+import System.Environment (getArgs)+import Text.Megaparsec (parseTest)++-------------------------------------------------------------------------------+main :: IO ()+main = getArgs >>= \case+ [ "--license" ] ->+ putStrLn license+ [ user, "" ] ->+ putStrLn $ "connected as " ++ user+ [ user, cmd ] ->+ getConfiguration >>= \case+ Just cfg ->+ case (parseUserName (pack user), parsePijul (pack cmd)) of+ (Just user, Just cmd) ->+ pijulProxy cfg user cmd+ (Nothing, _) ->+ putStrLn $ user ++ " is not a valid role"+ (_, Nothing) ->+ putStrLn $ cmd ++ " is not a valid pijul command"+ Nothing ->+ putStrLn "could not parse the configuration file"+ _ ->+ putStrLn "incorrect shell command"+-------------------------------------------------------------------------------++-------------------------------------------------------------------------------+getConfiguration :: IO (Maybe Configuration)+getConfiguration = getXdgDirectory XdgConfig "pi-hoole/config.yaml" >>= decodeFile++decodeLimes :: FilePath -> IO (Maybe Configuration)+decodeLimes = decodeFile++pijulProxy :: Configuration -> UserName -> Pijul -> IO ()+pijulProxy cfg user cmd+ | checkPrivilege user cmd cfg = callPijul cmd+ | otherwise = putStrLn "nah"++license :: String+license =+ unlines [ "Copyright (C) 2018 Thomas Letan <contact@thomasletan.fr>"+ , ""+ , "This program is free software: you can redistribute it and/or modify"+ , "it under the terms of the GNU Affero 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 Affero General Public License for more details."+ , ""+ , "You should have received a copy of the GNU Affero General Public License"+ , "along with this program. If not, see <http://www.gnu.org/licenses/>."+ ]+-------------------------------------------------------------------------------
+ app/web/Main.hs view
@@ -0,0 +1,106 @@+-- pi-hoole: lightweight access-control for pijul+-- Copyright (C) 2018 Thomas Letan <contact@thomasletan.fr>+--+-- This program is free software: you can redistribute it and/or modify+-- it under the terms of the GNU Affero 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 Affero General Public License for more details.+--+-- You should have received a copy of the GNU Affero General Public License+-- along with this program. If not, see <http://www.gnu.org/licenses/>.++{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}++module Main where++import Control.Applicative ((<|>))+import Data.ByteString.Base58 (bitcoinAlphabet, decodeBase58)+import Data.Map.Strict (Map, (!?))+import Data.Maybe (fromJust, maybe)+import Data.String (fromString)+import Data.Text (Text, pack, unpack)+import Data.Text.Encoding (decodeUtf8)+import Data.Yaml (decodeFile)+import Network.HTTP.Types.Method (methodGet)+import Network.HTTP.Types.Status (status200, status404)+import Network.Wai (Application, Request, pathInfo,+ requestMethod, responseLBS)+import Network.Wai.Handler.Warp (run)+import PiHoole (Action (Log, Patch), Branch (..),+ Configuration (repositories),+ Pijul (..), Privilege, Repo (..),+ Role (Anon), privilegeLe,+ recordPijul, requires)+import System.Directory (XdgDirectory (..), getXdgDirectory)+import System.FilePath (FilePath, (</>))+import Text.Regex.PCRE ((=~))++main :: IO ()+main = getConfiguration >>= \case+ Just cfg -> run 8080 (piHooleWeb $ repositories cfg)+ Nothing -> putStrLn "Could not open or parse the configuration file"++ where piHooleWeb :: Map Repo (Map Role Privilege) -> Application+ piHooleWeb cfg req respond =+ let action = requestToPijul req in+ if maybe False (pijulToPrivileges cfg) action+ then do res <- recordPijul (fromJust action)+ respond $ responseLBS status200 [] (fromString res)+ else do print req+ respond $ responseLBS status404 [] "Sorry"++pijulToPrivileges :: Map Repo (Map Role Privilege) -> Pijul -> Bool+pijulToPrivileges cfg (Pijul repo action) =+ case cfg !? repo >>= (!? Anon) of+ Just priv -> requires action `privilegeLe` priv+ _ -> False++requestToPijul :: Request -> Maybe Pijul+requestToPijul req+ | isGet req = let path = pathInfo req+ in log path <|> patch path+ | otherwise = Nothing+ where+ log :: [Text] -> Maybe Pijul+ log = logAux ""++ logAux :: FilePath -> [Text] -> Maybe Pijul+ logAux path [".pijul", branch] = Pijul (Repo path) <$> (Log <$> parseBranch branch)+ logAux path (x:rst) = logAux (path </> unpack x) rst+ logAux _ _ = Nothing++ parseBranch :: Text -> Maybe Branch+ parseBranch branch = case unpack branch =~ changesRegex of+ [[_, branch58]] -> Branch . decodeUtf8 <$> decodeBase58 bitcoinAlphabet (fromString branch58)+ _ -> Nothing++ changesRegex :: String+ changesRegex = "changes\\.(.*)$"++ patch :: [Text] -> Maybe Pijul+ patch = patchAux ""++ patchAux :: FilePath -> [Text] -> Maybe Pijul+ patchAux path [".pijul", "patches", patch] = Pijul (Repo path) <$> (Patch <$> parsePatch patch)+ patchAux path (x:rst) = patchAux (path </> unpack x) rst+ patchAux _ _ = Nothing++ parsePatch :: Text -> Maybe Text+ parsePatch patch = case unpack patch =~ patchRegex of+ [[_, patch]] -> Just $ pack patch+ _ -> Nothing++ patchRegex :: String+ patchRegex = "(.*)\\.gz"++ isGet :: Request -> Bool+ isGet = (== methodGet) . requestMethod++getConfiguration :: IO (Maybe Configuration)+getConfiguration = getXdgDirectory XdgConfig "pi-hoole/config.yaml" >>= decodeFile
+ pi-hoole.cabal view
@@ -0,0 +1,94 @@+name: pi-hoole+version: 0.1.0.0+synopsis: Lightweight access control solution for the pijul vcs+description: Please see the introductory post at <https://lthms.xyz/blog/pi-hoole>+category: Security+author: Thomas Letan+maintainer: lthms <contact@thomasletan.fr>+copyright: 2018 Thomas Letan+license: AGPL-3+license-file: LICENSE+build-type: Simple+cabal-version: >= 1.10++extra-source-files:+ ChangeLog.md+ README.md++library+ exposed-modules: PiHoole+ hs-source-dirs: src+ build-depends: aeson >=1.0 && <1.4+ , base >=4.7 && <5.0+ , containers >=0.5.9 && <0.6+ , directory >=1.2 && <1.4+ , filepath >=1.4 && <1.5+ , megaparsec >=5.0 && <6.6+ , process >=1.0 && <1.7+ , text >=1.0 && <1.3+ default-language: Haskell2010++executable pi-hoole-cfg+ main-is: Main.hs+ hs-source-dirs: app/cfg+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends: aeson >=1.0 && <1.4+ , base >=4.7 && <5+ , containers >=0.5.9 && <0.6+ , directory >=1.2 && <1.4+ , filepath >=1.4 && <1.5+ , optparse-generic >=1.0 && <1.4+ , pi-hoole+ , regex-pcre >=0.91 && <0.95+ , text >=1.0 && <1.3+ , unix >=2.0 && <2.8+ , yaml >=0.8 && <0.9+ default-language: Haskell2010++executable pi-hoole-shell+ main-is: Main.hs+ hs-source-dirs: app/shell+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends: aeson >=1.0 && <1.4+ , base >=4.7 && <5+ , containers >=0.5.9 && <0.6+ , directory >=1.2 && <1.4+ , filepath >=1.4 && <1.5+ , megaparsec >=5.0 && <6.6+ , pi-hoole+ , text >=1.0 && <1.3+ , yaml >=0.8 && <0.9+ default-language: Haskell2010++executable pi-hoole-web+ main-is: Main.hs+ hs-source-dirs: app/web+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends: aeson >=1.0 && <1.4+ , base >=4.7 && <5+ , base58-bytestring >=0.1 && <0.2+ , bytestring >=0.10 && <0.11+ , containers >=0.5.9 && <0.6+ , directory >=1.2 && <1.4+ , filepath >=1.4 && <1.5+ , http-types >=0.9 && <0.13+ , pi-hoole+ , regex-pcre >=0.91 && <0.95+ , text >=1.0 && <1.3+ , wai >=3.0 && <3.3+ , warp >=3.0 && <3.3+ , yaml >=0.8 && <0.9+ default-language: Haskell2010++test-suite pi-hoole-test+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ hs-source-dirs: test+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends: base >=4.7 && <5+ , pi-hoole+ default-language: Haskell2010++source-repository head+ type: pijul+ location: https://pijul.lthms.xyz/pijul/pi-hoole
+ src/PiHoole.hs view
@@ -0,0 +1,374 @@+-- pi-hoole: lightweight access-control for pijul+-- Copyright (C) 2018 Thomas Letan <contact@thomasletan.fr>+--+-- This program is free software: you can redistribute it and/or modify+-- it under the terms of the GNU Affero 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 Affero General Public License for more details.+--+-- You should have received a copy of the GNU Affero General Public License+-- along with this program. If not, see <http://www.gnu.org/licenses/>.++{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE OverloadedStrings #-}++module PiHoole+ ( Repo(..)+ , Branch(..)+ , Role(..)+ , UserName(..)+ , parseUserName+ , GroupName(..)+ , parseGroupName+ , Configuration(..)+ , Pijul(..)+ , Action(..)+ , parsePijul+ , Privilege(..)+ , privilegeLe+ , requires+ , checkPrivilege+ , callPijul+ , recordPijul+ ) where++import Control.Applicative ((<|>))+import Control.Monad (void)+import Data.Aeson (FromJSON (..), FromJSONKey (..),+ ToJSON (..), ToJSONKey (..), Value (..),+ decodeStrict)+import Data.Aeson.Types (FromJSONKeyFunction (..), Parser,+ toJSONKeyText)+import Data.Map.Strict (Map, (!?))+import qualified Data.Map.Strict as M (foldlWithKey)+import Data.Maybe (maybe)+import Data.Set (Set)+import qualified Data.Set as S (empty, foldl, fromList, insert,+ isSubsetOf, member, toList)+import Data.String (IsString (..))+import Data.Text (Text, append, pack, unpack)+import qualified Data.Text as T (drop, intercalate, take, uncons,+ words)+import qualified Data.Text.Encoding as T (encodeUtf8)+import Data.Void (Void)+import GHC.Generics (Generic)+import System.Directory (getHomeDirectory)+import System.FilePath (isRelative)+import System.IO (hGetContents)+import System.Process (callProcess, createPipe, runProcess)+import Text.Megaparsec (Parsec, eof, many, manyTill, parseMaybe,+ some, takeP)+import Text.Megaparsec.Char (anyChar, char, oneOf, space, space1,+ string)++newtype Branch = Branch { unBranch :: Text}+ deriving (Eq, Ord, Show, Generic, IsString, ToJSON, FromJSON)++newtype Repo = Repo FilePath+ deriving (Eq, Ord, Show, Generic, IsString, ToJSON)++textToRepo :: String -> Parser Repo+textToRepo txt = if isRelative txt+ then pure (Repo txt)+ else fail "repo path has to be relative"++instance FromJSON Repo where+ parseJSON (String txt) = textToRepo (unpack txt)++instance FromJSONKey Repo where+ fromJSONKey = FromJSONKeyTextParser (textToRepo . unpack)++newtype UserName = UserName Text+ deriving (Eq, Ord, Show, IsString)++aesonMaybe :: String -> Maybe a -> Parser a+aesonMaybe _ (Just x) = pure x+aesonMaybe error Nothing = fail error++parsePrefix :: Char -> Text -> Maybe Text+parsePrefix c txt = do+ (c', rst) <- T.uncons txt+ if c == c'+ then pure rst+ else Nothing++parseUserName :: Text -> Maybe UserName+parseUserName txt = UserName <$> parsePrefix '.' txt++instance FromJSON UserName where+ parseJSON (String txt) =+ aesonMaybe "username should be prefixed with '.'"+ (parseUserName txt)++instance ToJSON UserName where+ toJSON (UserName txt) = String $ "." `append` txt++newtype GroupName = GroupName Text+ deriving (Eq, Ord, Show, IsString)++parseGroupName :: Text -> Maybe GroupName+parseGroupName txt = GroupName <$> parsePrefix '+' txt++instance FromJSON GroupName where+ parseJSON (String txt) =+ aesonMaybe "group should be prefixed with '+'"+ (parseGroupName txt)++instance FromJSONKey GroupName where+ fromJSONKey = FromJSONKeyTextParser $ \txt -> parseJSON (String txt)++instance ToJSON GroupName where+ toJSON (GroupName txt) = String $ "+" `append` txt++data Role = User UserName+ | Group GroupName+ | Anon+ deriving (Eq, Ord, Show)++roleToText :: Role -> Text+roleToText (User (UserName name)) = "." `append` name+roleToText (Group (GroupName name)) = "+" `append` name+roleToText Anon = "anon"++textToRole :: Text -> Parser Role+textToRole "anon" = pure Anon+textToRole txt = (User <$> parseJSON (String txt))+ <|> (Group <$> parseJSON (String txt))++instance FromJSON Role where+ parseJSON (String txt) = textToRole txt++instance FromJSONKey Role where+ fromJSONKey = FromJSONKeyTextParser textToRole++instance ToJSON Role where+ toJSON = toJSON . roleToText++instance ToJSONKey Role where+ toJSONKey = toJSONKeyText roleToText++data Scope = All+ | Only (Set Branch)+ | None+ deriving (Eq, Show)++data Privilege = Privilege { read :: Scope+ , write :: Scope+ }+ deriving (Show)++readAllScope :: Parsec Void Text Scope+readAllScope = do+ char '+'+ char 'r'+ pure All++branch :: Parsec Void Text Branch+branch = Branch . pack <$> some (oneOf ['a'..'z'])++branches :: Parsec Void Text (Set Branch)+branches = do+ char '['+ fst <- branch+ rst <- many branches'+ char ']'++ pure (S.fromList (fst:rst))+ where+ branches' = do+ char ','+ space+ branch++readScope :: Parsec Void Text Scope+readScope = do+ char '+'+ char 'r'+ (Only <$> branches) <|> pure All++writeScope :: Parsec Void Text Scope+writeScope =+ (do char '-'+ char 'w'+ pure None)+ <|> (do char '+'+ char 'w'+ (Only <$> branches) <|> pure All)++scopeLe :: Scope -> Scope -> Bool+scopeLe None _ = True+scopeLe _ All = True+scopeLe (Only set1) (Only set2) = S.isSubsetOf set1 set2+scopeLe _ _ = False++privilegeLe :: Privilege -> Privilege -> Bool+privilegeLe (Privilege r1 w1) (Privilege r2 w2) =+ r1 `scopeLe` r2+ && w1 `scopeLe` w2++textToPrivilege :: Text -> Parser Privilege+textToPrivilege txt = case T.words txt of+ [p] -> case parseMaybe readScope p of+ Just x -> pure $ Privilege x None+ Nothing -> case parseMaybe writeScope p of+ Just x -> pure $ Privilege x x+ Nothing -> fail $ "Invalid privilege notation " ++ unpack p+ [p1, p2] -> case (parseMaybe readScope p1, parseMaybe writeScope p2) of+ (Just r, Just w) -> if scopeLe w r+ then pure $ Privilege r w+ else fail $ "write privilege " ++ unpack p2 ++ " is not less restrictive than read privilege " ++ unpack p1+ (_, _) -> case (parseMaybe readScope p2, parseMaybe writeScope p1) of+ (Just r, Just w) -> if scopeLe w r+ then pure $ Privilege r w+ else fail $ "write privilege " ++ unpack p1 ++ " is not less restrictive than read privilege " ++ unpack p2+ (_, _) -> fail $ "cannot parse privileges " ++ unpack txt++instance ToJSON Privilege where+ toJSON (Privilege r w) = toJSON $ priv "r" r `append` " " `append` priv "w" w+ where priv :: Text -> Scope -> Text+ priv t All = "+" `append` t+ priv t None = "-" `append` t+ priv t (Only br) = let str = T.intercalate "," (unBranch <$> S.toList br)+ in "+" `append` t `append` "[" `append` str `append` "]"++data Pijul = Pijul Repo Action+ deriving (Show)+data Action = Log Branch+ | Apply Branch+ | Patch Text+ deriving (Show)++parsePijul :: Text -> Maybe Pijul+parsePijul = parseMaybe parser+ where+ parser :: Parsec Void Text Pijul+ parser = do+ string "pijul"+ space+ (do string "log"+ space1+ (rp, br) <- repoAndBranch+ space1+ string "--hash-only"+ eof+ pure $ Pijul rp (Log br))+ <|> (do string "apply"+ space1+ (rp, br) <- repoAndBranch+ eof+ pure $ Pijul rp (Apply br))+ <|> (do string "patch"+ space1+ rp <- repo+ space+ p <- patch+ eof+ pure $ Pijul rp (Patch p))+ repo = do+ string "--repository"+ space1+ rp <- manyTill anyChar space1+ pure $ Repo rp++ branch = do+ string "--branch"+ space1+ string "\""+ br <- manyTill anyChar (char '"')+ pure $ Branch (pack br)++ repoAndBranch = do+ r <- repo+ space+ b <- branch+ pure (r, b)++ patch = do+ string "--bin"+ space1+ takeP Nothing 88++instance FromJSON Privilege where+ parseJSON (String str) = textToPrivilege str++data Configuration = Configuration { groups :: Map GroupName (Set UserName)+ , repositories :: Map Repo (Map Role Privilege)+ }+ deriving (Show, Generic)++instance FromJSON Configuration++belongsTo :: Map GroupName (Set UserName) -> UserName -> Set GroupName+belongsTo conf name = M.foldlWithKey aux S.empty conf+ where aux set group users = if name `S.member` users+ then S.insert group set+ else set++-- TODO: There is an issue here. The command `pijul patch` does not have an+-- argument to specify the branch from which a patch is initially fetched; as a+-- consequence, having read access to a repo, even for another branch where the+-- patch is not applied, is enough. For this reason, if a user who obtains a+-- hash for a patch of a branch they cannot access can fetch the patch. That is,+-- a patch is as private as its hash. Private branches will eventually be+-- supported in a better manner, but for now, private branches should mean+-- separated repositories.+requires :: Action -> Privilege+requires (Log branch) = Privilege (Only $ S.fromList [ branch ]) None+requires (Patch _) = Privilege (Only $ S.fromList []) None+requires (Apply branch) = Privilege None (Only $ S.fromList [ branch ])++checkPrivilege :: UserName -> Pijul -> Configuration -> Bool+checkPrivilege user (Pijul repo action) conf =+ maybe False+ (\rules -> check rules (User user) || S.foldl (aux rules) False grps)+ (repos !? repo)+ where+ needed = requires action+ repos = repositories conf+ grps = belongsTo (groups conf) user++ check rules role = maybe False (needed `privilegeLe`) (rules !? role)++ aux _ True _ = True+ aux rules False grp = check rules (Group grp)++callPijul :: Pijul -> IO ()+callPijul pijul = callProcess "pijul" $ pijulArgs pijul++recordPijul :: Pijul -> IO String+recordPijul pijul = do+ (rd, wd) <- createPipe+ home <- getHomeDirectory++ runProcess "pijul" (pijulArgs pijul) (Just home) Nothing Nothing (Just wd) Nothing+ hGetContents rd++pijulArgs :: Pijul -> [String]+pijulArgs (Pijul (Repo repo) action) =+ [ actionVerb action+ , "--repository"+ , repo+ ] ++ actionArgs action+ where+ actionVerb :: Action -> String+ actionVerb (Log _) = "log"+ actionVerb (Patch _) = "patch"+ actionVerb (Apply _) = "apply"++ actionArgs :: Action -> [String]+ actionArgs (Log (Branch branch)) = [ "--branch"+ , unpack branch+ , "--hash-only"+ ]+ actionArgs (Patch hash) = [ "--bin"+ , unpack hash+ ]+ actionArgs (Apply (Branch branch)) = [ "--branch"+ , unpack branch+ ]
+ test/Spec.hs view
@@ -0,0 +1,2 @@+main :: IO ()+main = putStrLn "Test suite not yet implemented"