gemcap (empty) → 0.1.0
raw patch · 13 files changed
+1749/−0 lines, 13 filesdep +basedep +bytestringdep +gemcapsetup-changed
Dependencies added: base, bytestring, gemcap, hspec, io-streams, network, tcp-streams, text, tls, transformers, x509
Files
- ChangeLog.md +3/−0
- LICENSE +661/−0
- README.md +30/−0
- Setup.hs +2/−0
- gemcap.cabal +72/−0
- src/Network/Gemini/Capsule.hs +100/−0
- src/Network/Gemini/Capsule/Encoding.hs +168/−0
- src/Network/Gemini/Capsule/Internal.hs +151/−0
- src/Network/Gemini/Capsule/Types.hs +137/−0
- test/Network/Gemini/Capsule/EncodingSpec.hs +157/−0
- test/Network/Gemini/Capsule/InternalSpec.hs +202/−0
- test/Network/Gemini/CapsuleSpec.hs +35/−0
- test/Spec.hs +31/−0
+ ChangeLog.md view
@@ -0,0 +1,3 @@+# Changelog for gemcap++## 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. <https://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU 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 <https://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+<https://www.gnu.org/licenses/>.
+ README.md view
@@ -0,0 +1,30 @@+# gemcap++Cooyright (C) Jonathan Lamothe <jonathan@jlamothe.net>++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+<https://www.gnu.org/licenses/>.++## Important Note++This project is not yet ready for release. Everything within it should+be considered unstable and subject to change at any time.++## Executive Summary++This library is inspired very heavily by the+[gemini-server](https://hackage.haskell.org/package/gemini-server)+package, but does not need to be linked against OpenSSL. Instead, it+uses [tcp-streams](https://hackage.haskell.org/package/tcp-streams) to+provide TLS functionality.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ gemcap.cabal view
@@ -0,0 +1,72 @@+cabal-version: 2.2++-- This file has been generated from package.yaml by hpack version 0.34.4.+--+-- see: https://github.com/sol/hpack++name: gemcap+version: 0.1.0+synopsis: a simple Gemini capsule (server)+description: a simple Gemini capsule (server) - see README.md for details+category: Gemini+homepage: https://codeberg.org/jlamothe/gemcap+bug-reports: https://codeberg.org/jlamothe/gemcap/issues+author: Jonathan Lamothe+maintainer: jonathan@jlamothe.net+copyright: 2021 Jonathan Lamothe+license: AGPL-3.0-or-later+license-file: LICENSE+build-type: Simple+extra-source-files:+ README.md+ ChangeLog.md++library+ exposed-modules:+ Network.Gemini.Capsule+ Network.Gemini.Capsule.Encoding+ Network.Gemini.Capsule.Internal+ Network.Gemini.Capsule.Types+ other-modules:+ Paths_gemcap+ hs-source-dirs:+ src+ ghc-options: -Wall+ build-depends:+ base >=4.7 && <5+ , bytestring >=0.10.12.0 && <0.11+ , io-streams+ , network+ , tcp-streams >=1.0.1.1 && <1.1+ , text >=1.2.4.1 && <1.3+ , tls+ , transformers+ , x509+ default-language: Haskell2010+ autogen-modules: Paths_gemcap++test-suite gemcap-test+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ other-modules:+ Network.Gemini.Capsule.EncodingSpec+ Network.Gemini.Capsule.InternalSpec+ Network.Gemini.CapsuleSpec+ Paths_gemcap+ hs-source-dirs:+ test+ ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N+ build-depends:+ base >=4.7 && <5+ , bytestring >=0.10.12.0 && <0.11+ , gemcap+ , hspec >=2.7.10 && <2.8+ , io-streams+ , network+ , tcp-streams >=1.0.1.1 && <1.1+ , text >=1.2.4.1 && <1.3+ , tls+ , transformers+ , x509+ default-language: Haskell2010+ autogen-modules: Paths_gemcap
+ src/Network/Gemini/Capsule.hs view
@@ -0,0 +1,100 @@+{-|++Module : Network.Gemini.Capsule+Description : Gemini capsule stuff+Copyright : (C) Jonathan Lamothe+License : AGPL-3.0-or-later+Maintainer : jonathan@jlamothe.net+Stability : experimental+Portability : POSIX++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+<https://www.gnu.org/licenses/>.++-}++{-# LANGUAGE LambdaCase, ScopedTypeVariables #-}++module Network.Gemini.Capsule (+ runGemCapsule+) where++import Control.Concurrent (forkIO)+import Control.Exception (IOException, try)+import Control.Exception.Base (bracket, finally)+import Control.Monad (void)+import qualified Data.Connection as C+import Data.IORef (IORef, newIORef, readIORef, writeIORef)+import Data.TLSSetting (makeServerParams)+import Data.X509 (Certificate, CertificateChain (..), getSigned, signedObject)+import qualified Network.Socket as S+import Network.TLS (ServerParams, onClientCertificate, serverHooks)+import System.IO.Streams.TCP (bindAndListen)+import System.IO.Streams.TLS (accept)++import Network.Gemini.Capsule.Internal+import Network.Gemini.Capsule.Types++-- | Builds and runs a Gemini capsule+runGemCapsule+ :: GemCapSettings+ -- ^ The capsule settings+ -> GemHandler+ -- ^ The handler+ -> IO a+runGemCapsule settings handler = bracket+ ( bindAndListen+ (capConnections settings)+ (fromIntegral $ capPort settings)+ )+ S.close+ ( \sock -> do+ params <- makeServerParams+ (capCert settings)+ (capCertChain settings)+ (capKey settings)+ listenLoop sock params handler+ )++listenLoop :: S.Socket -> ServerParams -> GemHandler -> IO a+listenLoop sock params handler = do+ certRef <- newIORef Nothing+ let params' = adjustServerParams certRef params+ try (accept params' sock) >>= \case+ Left (_::IOException) -> return ()+ Right conn -> void $ forkIO $ finally+ (readIORef certRef >>= runConnection conn handler)+ (C.close conn)+ listenLoop sock params handler++adjustServerParams+ :: IORef (Maybe Certificate)+ -> ServerParams+ -> ServerParams+adjustServerParams certRef params = let+ hooks = serverHooks params+ certHook = onClientCertificate hooks++ certHook' chain = do+ case chain of+ CertificateChain [] -> return ()+ CertificateChain (se:_) -> do+ let cert = signedObject $ getSigned se+ writeIORef certRef (Just cert)+ certHook chain++ hooks' = hooks { onClientCertificate = certHook' }+ in params { serverHooks = hooks' }++--jl
+ src/Network/Gemini/Capsule/Encoding.hs view
@@ -0,0 +1,168 @@+{-|++Module : Network.Gemini.Capsule.Encoding+Description : funcitons to encode/decode our data types+Copyright : (C) Jonathan Lamothe+License : AGPL-3.0-or-later+Maintainer : jonathan@jlamothe.net+Stability : experimental+Portability : POSIX++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+<https://www.gnu.org/licenses/>.++-}++{-# LANGUAGE LambdaCase, OverloadedStrings, RecordWildCards #-}++module Network.Gemini.Capsule.Encoding (+ encodeGemURL,+ decodeGemURL,+ escapeString,+ unescapeString,+ encodeGemResponse+) where++import qualified Data.ByteString as BS+import Data.ByteString.Builder (+ charUtf8,+ lazyByteString,+ stringUtf8,+ toLazyByteString,+ word8Dec)+import qualified Data.ByteString.Lazy as BSL+import Data.Char (chr, ord, toLower)+import Data.List (find, intercalate)+import Data.Maybe (fromJust, fromMaybe)+import qualified Data.Text as T+import Data.Text.Encoding (decodeUtf8')++import Network.Gemini.Capsule.Types++-- | Encodes a 'GemURL' into a 'String'+encodeGemURL :: GemURL -> String+encodeGemURL url =+ "gemini://" ++ authority ++ "/" ++ path ++ query+ where+ authority = gemHost url ++ case gemPort url of+ Just port -> ':' : show port+ Nothing -> ""+ path = intercalate "/" $ map escapeString $ gemPath url+ query = case gemQuery url of+ Nothing -> ""+ Just q -> '?' : escapeString q++-- | Decodes a 'GemURL' from a 'String' (if possible)+decodeGemURL :: String -> Maybe GemURL+decodeGemURL str = do+ let txt = T.pack str++ noProt <- case T.splitOn "://" txt of+ [prot, rest] -> if T.toLower prot == "gemini"+ then Just rest+ else Nothing+ _ -> Nothing++ noFrag <- case T.splitOn "#" noProt of+ [x, _] -> Just x+ [x] -> Just x+ _ -> Nothing++ (noQuery, query) <- case T.splitOn "?" noFrag of+ [nq, q] -> Just (nq, Just q)+ [nq] -> Just (nq, Nothing)+ _ -> Nothing++ gemQuery <- case query of+ Just q -> Just <$> unescapeString (T.unpack q)+ Nothing -> Just Nothing++ (auth, path) <- case T.splitOn "/" noQuery of+ [a] -> Just (a, [])+ [a, ""] -> Just (a, [])+ a:ps -> Just (a, ps)+ _ -> Nothing++ gemPath <- mapM (unescapeString . T.unpack) path++ (host, gemPort) <- case T.splitOn ":" auth of+ [h, p] -> case reads $ T.unpack p of+ [(n, "")] -> Just (h, Just n)+ _ -> Nothing+ [h] -> Just (h, Nothing)+ _ -> Nothing++ let gemHost = T.unpack host+ Just GemURL {..}++-- | add required escape sequences to a string+escapeString :: String -> String+escapeString = concatMap+ ( \n -> let ch = chr $ fromIntegral n in+ if ch `elem` unescaped+ then [ch]+ else '%' : toHex n+ ) . BSL.unpack . toLazyByteString . stringUtf8+ where+ unescaped = ['0'..'9'] ++ ['A'..'Z'] ++ ['a'..'z'] ++ "~-_."+ toHex =+ ( \n -> let+ high = n `div` 16+ low = n `mod` 16+ in [hexDigits !! high, hexDigits !! low]+ ) . fromIntegral++-- | decode an escaped string back to its original value+unescapeString :: String -> Maybe String+unescapeString str = case decodeUtf8' $ BS.pack $ toBytes str of+ Right t -> Just $ T.unpack t+ _ -> Nothing+ where+ toBytes = \case+ "" -> []+ '%':h:l:sub -> let+ h' = toLower h+ l' = toLower l+ in if h' `elem` hexDigits && l' `elem` hexDigits+ then toByte h' l' : toBytes sub+ else fromIntegral (ord '%') : toBytes (h : l : sub)+ ch:sub ->+ BSL.unpack (toLazyByteString $ charUtf8 ch) ++ toBytes sub+ toByte h l = toNum h * 16 + toNum l+ toNum ch = fst $ fromJust $+ find (\x -> snd x == ch) $ zip [0..] hexDigits++-- | encodes a 'GemResponse' into a lazy ByteString+encodeGemResponse :: GemResponse -> BSL.ByteString+encodeGemResponse resp = let+ code = respStatus resp+ high = code `div` 10+ low = code `mod` 10+ meta = respMeta resp+ body = fromMaybe "" $ respBody resp++ builder+ = word8Dec high+ <> word8Dec low+ <> charUtf8 ' '+ <> stringUtf8 meta+ <> stringUtf8 "\r\n"+ <> lazyByteString body++ in toLazyByteString builder++hexDigits :: String+hexDigits = ['0'..'9'] ++ ['a'..'f']++--jl
+ src/Network/Gemini/Capsule/Internal.hs view
@@ -0,0 +1,151 @@+{-|++Module : Network.Gemini.Capsule.Internal+Description : internal functions (do not use)+Copyright : (C) Jonathan Lamothe+License : AGPL-3.0-or-later+Maintainer : jonathan@jlamothe.net+Stability : experimental+Portability : POSIX++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+<https://www.gnu.org/licenses/>.++= Important Note++This is an internal module. It is not intended to be accessed by+outside packages, and should be considered subject to change at any+time.++-}++{-# LANGUAGE LambdaCase #-}++module Network.Gemini.Capsule.Internal (+ runConnection,+ readURL,+ strFromConn,+ readMax,+ stripCRLF+) where++import Control.Monad (when)+import Control.Monad.Trans.Class (lift)+import Control.Monad.Trans.Maybe (MaybeT (..))+import qualified Data.ByteString as BS+import Data.ByteString.Builder (Builder, byteString, toLazyByteString)+import qualified Data.ByteString.Lazy as BSL+import Data.Connection (Connection, send, source)+import qualified Data.Text as T+import Data.Text.Encoding (decodeUtf8')+import Data.X509 (Certificate)+import qualified System.IO.Streams as S++import Network.Gemini.Capsule.Encoding+import Network.Gemini.Capsule.Types++-- Constants++-- Maximum size to read from a conneciton+inBufSize :: Int+inBufSize = 1026++-- | process a request and return a response over a 'Connection'+runConnection+ :: Connection a+ -> GemHandler+ -> Maybe Certificate+ -> IO ()+runConnection conn handler mCert =+ ( readURL conn >>= \case+ Nothing -> return $ newGemResponse+ { respStatus = 59+ , respMeta = "bad request"+ }+ Just url -> handler (newGemRequest url) { reqCert = mCert }+ ) >>= sendResponse conn++-- | Reads a 'GemURL' from a 'Connection'+readURL+ :: Connection a+ -- ^ the connection+ -> IO (Maybe GemURL)+readURL conn =+ strFromConn inBufSize conn >>= return <$> \case+ Nothing -> Nothing+ Just str -> decodeGemURL str++-- | Reads up to a maxumum number of bytes from a 'Connection', UTF-8+-- decodes it, and returns the resulting string (if possible) without+-- the trailing CR/LF+strFromConn+ :: Int+ -- ^ The maximum number of bytes to read+ -> Connection a+ -- ^ The connection to read from+ -> IO (Maybe String)+strFromConn maxLen conn = do+ mbs <- readMax maxLen conn+ return $ do+ bs <- mbs+ txt <- case decodeUtf8' bs of+ Left _ -> Nothing+ Right s -> Just s+ stripCRLF $ T.unpack txt++-- | Reads from a connection up to a maximum number of bytes or a+-- newline character is encountered, returning 'Nothing' if the limit+-- is exceeded+readMax+ :: Int+ -- ^ the maximum number of bytes+ -> Connection a+ -- ^ the 'Connection' to read from+ -> IO (Maybe BS.ByteString)+readMax maxLen conn = do+ let src = source conn+ runMaybeT $+ BS.pack . BSL.unpack . toLazyByteString+ <$> readLoop maxLen src++-- | Strips the CR/LF characters from the end of a string, retuning+-- Nothing if they are not present+stripCRLF :: String -> Maybe String+stripCRLF = \case+ "" -> Nothing+ "\r\n" -> Just ""+ c:str -> (c:) <$> stripCRLF str++readLoop :: Int -> S.InputStream BS.ByteString -> MaybeT IO Builder+readLoop maxLen src = lift (S.read src) >>= \case+ Nothing -> return mempty+ Just bs -> do+ let+ len = BS.length bs+ b = byteString bs+ when (len > maxLen) $+ fail "maximum length exceeded"+ if BS.any (== 0xa) bs+ then return b+ else (b <>) <$> readLoop (maxLen - len) src++sendResponse+ :: Connection a+ -- ^ the connection+ -> GemResponse+ -- ^ the response being sent+ -> IO ()+sendResponse conn resp = send conn $ encodeGemResponse resp++--jl
+ src/Network/Gemini/Capsule/Types.hs view
@@ -0,0 +1,137 @@+{-|++Module : Network.Gemini.Capsule.Types+Description : Gemini capsule types+Copyright : (C) Jonathan Lamothe+License : AGPL-3.0-or-later+Maintainer : jonathan@jlamothe.net+Stability : experimental+Portability : POSIX++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+<https://www.gnu.org/licenses/>.++-}++module Network.Gemini.Capsule.Types (+ -- * Types+ GemURL (..),+ GemRequest (..),+ GemResponse (..),+ GemHandler,+ GemCapSettings (..),+ -- * Constructors+ newGemURL,+ newGemRequest,+ newGemResponse,+ newGemCapSettings+) where++import qualified Data.ByteString.Lazy as BSL+import Data.Word (Word8, Word16, Word32)+import Data.X509 (Certificate)++-- | Gemini URL+data GemURL = GemURL+ { gemHost :: String+ -- ^ The host part of the authority section, e.g.: "example.com"+ , gemPort :: Maybe Word32+ -- ^ The port number (if supplied)+ , gemPath :: [String]+ -- ^ The decoded path segments+ , gemQuery :: Maybe String+ -- ^ The decoded request query (if supplied)+ } deriving (Eq, Show)++-- | Describes a Gemini request+data GemRequest = GemRequest+ { reqURL :: GemURL+ -- ^ The URL being requested+ , reqCert :: Maybe Certificate+ -- ^ The client certificate (if available)+ } deriving (Eq, Show)++-- | Describes a response to a Gemini request+data GemResponse = GemResponse+ { respStatus :: Word8+ -- ^ The response status code+ , respMeta :: String+ -- ^ The response metadata+ , respBody :: Maybe BSL.ByteString+ -- ^ The response body+ } deriving (Eq, Show)++-- | Handles a 'GemRequest' to produce a 'GemResponse'+type GemHandler = GemRequest -> IO GemResponse++-- | The settings required to set up a Gemini capsule+data GemCapSettings = GemCapSettings+ { capConnections :: Int+ -- ^ Number of simultaneous connections allowed+ , capPort :: Word16+ -- ^ The capsule port number+ , capCert :: FilePath+ -- ^ The path to the TLS certificate+ , capCertChain :: [FilePath]+ -- ^ The paths to the chain certificates+ , capKey :: FilePath+ -- ^ The path to the private key+ } deriving (Eq, Show)++-- | Builds a new 'GemURL'+newGemURL+ :: String+ -- ^ The hostname+ -> GemURL+newGemURL host = GemURL+ { gemHost = host+ , gemPort = Nothing+ , gemPath = []+ , gemQuery = Nothing+ }++-- | Builds a 'GemRequest'+newGemRequest+ :: GemURL+ -- ^ The request URL+ -> GemRequest+newGemRequest url = GemRequest+ { reqURL = url+ , reqCert = Nothing+ }++-- | Builds a 'GemResponse'+newGemResponse :: GemResponse+newGemResponse = GemResponse+ { respStatus = 20+ , respMeta = "text/gemini"+ , respBody = Nothing+ }++-- | Builds a reasonable set of server settings.+newGemCapSettings+ :: FilePath+ -- ^ Path to the server certificate+ -> FilePath+ -- ^ Path to the private key+ -> GemCapSettings+newGemCapSettings cert key = GemCapSettings+ { capConnections = 100+ , capPort = 1965+ , capCert = cert+ , capCertChain = []+ , capKey = key+ }++--jl
+ test/Network/Gemini/Capsule/EncodingSpec.hs view
@@ -0,0 +1,157 @@+{-++gemcap++Cooyright (C) Jonathan Lamothe <jonathan@jlamothe.net>++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+<https://www.gnu.org/licenses/>.++-}++{-# LANGUAGE OverloadedStrings #-}++module Network.Gemini.Capsule.EncodingSpec (spec) where++import Test.Hspec (Spec, context, describe, it, shouldBe)++import Network.Gemini.Capsule.Encoding+import Network.Gemini.Capsule.Types++spec :: Spec+spec = describe "Encoding" $ do+ encodeGemURLSpec+ decodeGemURLSpec+ escapeStringSpec+ unescapeStringSpec+ encodeGemResponseSpec++encodeGemURLSpec :: Spec+encodeGemURLSpec = describe "encodeGemURL" $ mapM_+ ( \(desc, req, expected) -> context desc $+ it ("should be " ++ show expected) $+ encodeGemURL req `shouldBe` expected+ )++ -- description, request, expected+ [ ( "simple", simpleURL, simpleExp )+ , ( "with port", withPortURL, withPortExp )+ , ( "with path", withPathURL, withPathExp )+ , ( "with query", withQueryURL, withQueryExp )+ , ( "blank query", blankQueryURL, blankQueryExp )+ , ( "with escape", withEscapeURL, withEscapeExp )+ ]++ where+ simpleURL = newGemURL "example.com"+ simpleExp = "gemini://example.com/"+ withPortURL = simpleURL { gemPort = Just 1965 }+ withPortExp = "gemini://example.com:1965/"+ withPathURL = simpleURL { gemPath = ["foo", "bar"] }+ withPathExp = "gemini://example.com/foo/bar"+ withQueryURL = simpleURL { gemQuery = Just "foo" }+ withQueryExp = "gemini://example.com/?foo"+ blankQueryURL = simpleURL { gemQuery = Just "" }+ blankQueryExp = "gemini://example.com/?"++ withEscapeURL = simpleURL+ { gemPath = ["foo bar"]+ , gemQuery = Just "baz quux"+ }++ withEscapeExp = "gemini://example.com/foo%20bar?baz%20quux"++decodeGemURLSpec :: Spec+decodeGemURLSpec = describe "decodeGemURL" $ mapM_+ ( \(str, expected) -> context (show str) $+ it ("should be " ++ show expected) $+ decodeGemURL str `shouldBe` expected+ )++ -- URL string, expected+ [ ( simpleStr, Just simpleURL )+ , ( withSlashStr, Just simpleURL )+ , ( withPathStr, Just withPathURL )+ , ( withQueryStr, Just withQueryURL )+ , ( pathQueryStr, Just pathQueryURL )+ , ( blankQueryStr, Just blankQueryURL )+ , ( withFragmentStr, Just simpleURL )+ , ( escapedStr, Just escapedURL )+ , ( httpStr, Nothing )+ , ( malformed, Nothing )+ , ( "", Nothing )+ ]++ where+ simpleStr = "gemini://example.com"+ simpleURL = newGemURL "example.com"+ withSlashStr = simpleStr ++ "/"+ withPathStr = simpleStr ++ "/foo/bar"+ withPathURL = simpleURL { gemPath = ["foo", "bar"] }+ withQueryStr = simpleStr ++ "?foo"+ withQueryURL = simpleURL { gemQuery = Just "foo" }+ pathQueryStr = withPathStr ++ "?baz"+ pathQueryURL = withPathURL { gemQuery = Just "baz" }+ blankQueryStr = simpleStr ++"?"+ blankQueryURL = simpleURL { gemQuery = Just "" }+ withFragmentStr = simpleStr ++ "#foo"+ escapedStr = simpleStr ++ "/foo%20bar/baz?quux%20stuff"++ escapedURL = simpleURL+ { gemPath = ["foo bar", "baz"]+ , gemQuery = Just "quux stuff"+ }++ httpStr = "http://example.com"+ malformed = "foo"++escapeStringSpec :: Spec+escapeStringSpec = describe "escapeString" $ mapM_+ ( \(input, expected) -> context (show input) $+ it ("should be " ++ show expected) $+ escapeString input `shouldBe` expected+ )++ -- input, expected+ [ ( "~foo-bar_baz.quux", "~foo-bar_baz.quux" )+ , ( "foo:/?=&#%", "foo%3a%2f%3f%3d%26%23%25" )+ , ( "foo\xe9", "foo%c3%a9" )+ ]++unescapeStringSpec :: Spec+unescapeStringSpec = describe "unescapeString" $ mapM_+ ( \(input, expected) -> context (show input) $+ it ("should be " ++ show expected) $+ unescapeString input `shouldBe` expected+ )++ -- input, expected+ [ ( "foo", Just "foo" )+ , ( "foo%20bar", Just "foo bar" )+ , ( "foo%7x", Just "foo%7x" )+ , ( "foo%a", Just "foo%a" )+ , ( "foo%", Just "foo%" )+ , ( "foo%c3%a9", Just "foo\xe9" )+ , ( "foo%ff", Nothing )+ ]++encodeGemResponseSpec :: Spec+encodeGemResponseSpec = describe "encodeGemResponse" $+ it ("should be " ++ show expect) $+ encodeGemResponse resp `shouldBe` expect+ where+ resp = newGemResponse { respBody = Just "Success!\r\n" }+ expect = "20 text/gemini\r\nSuccess!\r\n"++--jl
+ test/Network/Gemini/Capsule/InternalSpec.hs view
@@ -0,0 +1,202 @@+{-++gemcap++Cooyright (C) Jonathan Lamothe <jonathan@jlamothe.net>++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+<https://www.gnu.org/licenses/>.++-}++{-# LANGUAGE OverloadedStrings, RecordWildCards #-}++module Network.Gemini.Capsule.InternalSpec (spec) where++import qualified Data.ByteString as BS+import qualified Data.ByteString.Lazy as BSL+import Data.Char (ord)+import Data.Connection (Connection (..))+import Data.IORef (IORef, modifyIORef', newIORef, readIORef)+import Data.X509 (Certificate (..))+import System.IO.Streams (nullInput, unRead)+import Test.Hspec (+ Spec,+ context,+ describe,+ it,+ shouldBe,+ shouldReturn)++import Network.Gemini.Capsule.Types+import Network.Gemini.Capsule.Internal++spec :: Spec+spec = describe "Internal" $ do+ runConnectionSpec+ readURLSpec+ strFromConnSpec+ readMaxSpec+ stripCRLFSpec++runConnectionSpec :: Spec+runConnectionSpec = describe "runConnection" $ mapM_+ ( \(desc, ioConnRef, handler, mCert, expect) -> context desc $+ it ("should return " ++ show expect) $ do+ (conn, outRef) <- ioConnRef+ runConnection conn handler mCert+ readIORef outRef `shouldReturn` expect+ )++ -- description, connection, handler, certificate, expectation+ [ ( "basic connection", basicConn, basicH, Nothing, basicExp )+ , ( "no certificate", basicConn, certH, Nothing, noCertExp )+ , ( "with certificate", basicConn, certH, Just sampleCert, basicExp )+ , ( "gibberish with CR/LF", gibConnCRLF, basicH, Nothing, gibExp )+ , ( "gibberish w/o CR/LF", gibConn, basicH, Nothing, gibExp )+ ]++ where+ basicConn = mkIOConn ["gemini://example.com/\r\n"]+ gibConnCRLF = mkIOConn ["aosidjgfoeribjeworifj\r\n"]+ gibConn = mkIOConn ["sodifjboije"]+ basicH _ = return newGemResponse { respBody = Just success }++ certH req = return $ case reqCert req of+ Nothing -> newGemResponse+ { respStatus = 60+ , respMeta = "certificate required"+ }+ Just _ -> newGemResponse { respBody = Just success }++ basicExp = ["20 text/gemini\r\nSuccess!\r\n"]+ noCertExp = ["60 certificate required\r\n"]+ gibExp = ["59 bad request\r\n"]+ success = "Success!\r\n"++readURLSpec :: Spec+readURLSpec = describe "readURL" $ mapM_+ ( \(desc, ioConn, expect) -> context desc $+ it ("should return " ++ show expect) $+ do+ conn <- ioConn+ readURL conn `shouldReturn` expect+ )++ -- description, connection, expected result+ [ ( "valid URL", validConn, Just validExp )+ , ( "long URL", longConn, Just longExp )+ , ( "too long URL", tooLongConn, Nothing )+ , ( "gibberish input", gibConn, Nothing )+ ]++ where+ validConn = mkInConn ["gemini://example.com/\r\n"]+ longConn = mkInConn [longBS]+ tooLongConn = mkInConn [tooLongBS]+ gibConn = mkInConn ["aosidjfwoeinboijwefr"]+ longBS = BS.pack (take 1024 bytes) <> "\r\n"+ tooLongBS = BS.pack (take 1025 bytes) <> "\r\n"+ bytes = BS.unpack prefix ++ repeat (fromIntegral $ ord 'A')+ validExp = newGemURL "example.com"+ longExp = validExp { gemPath = [longDir] }+ longDir = replicate (1024 - BS.length prefix) 'A'+ prefix = "gemini://example.com/"++strFromConnSpec :: Spec+strFromConnSpec = describe "strFromConn" $ mapM_+ ( \(desc, maxLen, ioConn, expect) -> context desc $+ it ("should return " ++ show expect) $ do+ conn <- ioConn+ strFromConn maxLen conn `shouldReturn` expect+ )++ -- description, max size, connection, expected+ [ ( "valid string", 100, mkInConn ["foo\r\n"], Just "foo" )+ , ( "long string", 5, mkInConn ["too long\r\n"], Nothing )+ , ( "no CR/LF", 100, mkInConn ["foo"], Nothing )+ , ( "bad UTF-8", 100, mkInConn ["foo\xff\r\n"], Nothing )+ , ( "non-ASCII", 100, mkInConn ["\xc3\xa9\r\n"], Just "\xe9" )+ ]++readMaxSpec :: Spec+readMaxSpec = describe "readMax" $ mapM_+ ( \(desc, maxLen, ioConn, expect) -> context desc $+ it ("should return " ++ show expect) $ do+ conn <- ioConn+ readMax maxLen conn `shouldReturn` expect+ )++ -- description, max length, connection, expected+ [ ( "single input", 1024, singleConn, Just singleBS )+ , ( "multi input", 1024, multiConn, Just multiBS )+ , ( "long input", longLen, longConn, Just longBS )+ , ( "too long", pred longLen, longConn, Nothing )+ , ( "empty input", 1024, mkInConn [], Just "" )+ ]++ where+ singleConn = mkInConn ["foo"]+ multiConn = mkInConn ["foo", "bar", "baz"]+ longConn = mkInConn [longBS]+ longLen = BS.length longBS+ singleBS = "foo"+ multiBS = "foobarbaz"+ longBS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"++stripCRLFSpec :: Spec+stripCRLFSpec = describe "stripCRLF" $ mapM_+ ( \(input, expected) -> context (show input) $+ it ("should be" ++ show expected) $+ stripCRLF input `shouldBe` expected+ )++ -- input, expectation+ [ ( "foo\r\n", Just "foo" )+ , ( "foo\n", Nothing )+ , ( "foo", Nothing )+ , ( "\r\n", Just "" )+ ]++mkIOConn :: [BS.ByteString] -> IO (Connection (), IORef [BSL.ByteString])+mkIOConn input = do+ ref <- newIORef []+ conn <-+ ( \c -> c { send = \bs -> modifyIORef' ref (++[bs]) }+ ) <$> mkInConn input+ return (conn, ref)++mkInConn :: [BS.ByteString] -> IO (Connection ())+mkInConn bss = do+ source <- nullInput+ mapM_ (`unRead` source) (reverse bss)+ let+ send = const $ return ()+ close = return ()+ connExtraInfo = ()+ return Connection {..}++sampleCert :: Certificate+sampleCert = Certificate+ { certVersion = undefined+ , certSerial = undefined+ , certSignatureAlg = undefined+ , certIssuerDN = undefined+ , certValidity = undefined+ , certSubjectDN = undefined+ , certPubKey = undefined+ , certExtensions = undefined+ }++--jl
+ test/Network/Gemini/CapsuleSpec.hs view
@@ -0,0 +1,35 @@+{-++gemcap++Cooyright (C) Jonathan Lamothe <jonathan@jlamothe.net>++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+<https://www.gnu.org/licenses/>.++-}++module Network.Gemini.CapsuleSpec (spec) where++import Test.Hspec (Spec, describe)++import qualified Network.Gemini.Capsule.EncodingSpec as Encoding+import qualified Network.Gemini.Capsule.InternalSpec as Internal++spec :: Spec+spec = describe "Network.Gemini.Capsule" $ do+ Encoding.spec+ Internal.spec++--jl
+ test/Spec.hs view
@@ -0,0 +1,31 @@+{-++gemcap++Cooyright (C) Jonathan Lamothe <jonathan@jlamothe.net>++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+<https://www.gnu.org/licenses/>.++-}++module Main (main) where++import Test.Hspec (hspec)+import qualified Network.Gemini.CapsuleSpec as GemCap++main :: IO ()+main = hspec GemCap.spec++--jl