diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/COPYING.LESSER b/COPYING.LESSER new file mode 100644 --- /dev/null +++ b/COPYING.LESSER @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/QC.hs b/QC.hs new file mode 100644 --- /dev/null +++ b/QC.hs @@ -0,0 +1,107 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +module Main + where + +import Data.Maybe +import Data.Word +import Test.QuickCheck + +import qualified Codec.Binary.Uu as Uu +import qualified Codec.Binary.Base64 as Base64 +import qualified Codec.Binary.Base64Url as Base64Url +import qualified Codec.Binary.Base32 as Base32 +import qualified Codec.Binary.Base32Hex as Base32Hex +import qualified Codec.Binary.Base16 as Base16 + +-- {{{1 Arbitrary instances +instance Arbitrary Char where + arbitrary = do + n <- choose ((fromEnum (minBound::Char))::Int, + (fromEnum (maxBound::Char))::Int) + return $ toEnum n + +instance Arbitrary Word8 where + arbitrary = do + n <- choose ((fromIntegral (minBound::Word8))::Int, + (fromIntegral (maxBound::Word8))::Int) + return $ fromIntegral n + +-- {{{1 uuencode properties +prop_uuEncode ws = ws == (fromJust . Uu.decode . Uu.encode) ws + where types = ws::[Word8] + +prop_uuChop s = properLength s ==> s == (Uu.unchop . Uu.chop 45) s + where + types = s::String + properLength s = length s `mod` 4 /= 1 -- property of uuencode guarantees this + +prop_uuCombined ws = ws == (fromJust $ Uu.decode $ Uu.unchop $ Uu.chop 45 $ Uu.encode ws) + where types = ws::[Word8] + +-- {{{1 base64 properties +prop_base64Encode ws = ws == (fromJust $ Base64.decode $ Base64.encode ws) + where types = ws::[Word8] + +prop_base64Chop s = s == (Base64.unchop $ Base64.chop 64 s) + where types = s::String + +-- {{{1 base64url properties +prop_base64UrlEncode ws = ws == (fromJust $ Base64Url.decode $ Base64Url.encode ws) + where types = ws::[Word8] + +prop_base64UrlChop s = s == (Base64Url.unchop $ Base64Url.chop 64 s) + where types = s::String + +-- {{{1 base32 +prop_base32Encode ws = ws == (fromJust $ Base32.decode $ Base32.encode ws) + where types = ws::[Word8] + +prop_base32Chop s = s == (Base32.unchop $ Base32.chop 64 s) + where types = s::String + +-- {{{1 base32hex +prop_base32HexEncode ws = ws == (fromJust $ Base32Hex.decode $ Base32Hex.encode ws) + where types = ws::[Word8] + +prop_base32HexChop s = s == (Base32Hex.unchop $ Base32Hex.chop 64 s) + where types = s::String + +-- {{{1 base16 +prop_base16Encode ws = ws == (fromJust $ Base16.decode $ Base16.encode ws) + where types = ws::[Word8] + +prop_base16Chop s = s == (Base16.unchop $ Base16.chop 16 s) + where types = s::String + +-- {{{1 main +main = do + quickCheck prop_uuEncode + quickCheck prop_uuChop + quickCheck prop_uuCombined + quickCheck prop_base64Encode + quickCheck prop_base64Chop + quickCheck prop_base64UrlEncode + quickCheck prop_base64UrlChop + quickCheck prop_base32Encode + quickCheck prop_base32Chop + quickCheck prop_base32HexEncode + quickCheck prop_base32HexChop + quickCheck prop_base16Encode + quickCheck prop_base16Chop diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,22 @@ +#! /usr/bin/env runhaskell + +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +import Distribution.Simple +main = defaultMain diff --git a/UT.hs b/UT.hs new file mode 100644 --- /dev/null +++ b/UT.hs @@ -0,0 +1,121 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +module Main + where + +import Test.HUnit +import Control.Monad +import System.Exit +import Data.Maybe + +import qualified Codec.Binary.Uu as Uu +import qualified Codec.Binary.Base64 as Base64 +import qualified Codec.Binary.Base64Url as Base64Url +import qualified Codec.Binary.Base32 as Base32 +import qualified Codec.Binary.Base32Hex as Base32Hex +import qualified Codec.Binary.Base16 as Base16 + +-- {{{1 buildTestList +-- builds a list of successful tests based on a tuple (suite, description, +-- encoded data, decoded data, encoding function, decoding function) +buildTestList td = TestList $ concat + [ [TestLabel (suite ++ " encode " ++ desc) (enc ~=? (fenc dec)), TestLabel (suite ++ " decode " ++ desc) (dec ~=? (fromJust $ fdec enc))] + | (suite, desc, enc, dec, fenc, fdec) <- td ] + +-- {{{1 uuencode tests +uuTestData = + [ ("uu", "empty", "", [], Uu.encode, Uu.decode) + , ("uu", "\0", "``", [0], Uu.encode, Uu.decode) + , ("uu", "\255", "_P", [255], Uu.encode, Uu.decode) + , ("uu", "Example", "17AA;7!L90", [69,120,97,109,112,108,101], Uu.encode, Uu.decode) + ] +uuTests = buildTestList uuTestData + +uuTestData2 = + [("uu test5", "chop . encode Example", ["'17AA;7!L90"], [69,120,97,109,112,108,101], (Uu.chop 61 . Uu.encode), (Uu.decode . Uu.unchop)) + ] +uuTests2 = buildTestList uuTestData2 + +-- {{{1 base64 tests +base64TestData = + [ ("base64", "empty", "", [], Base64.encode, Base64.decode) + , ("base64", "f", "Zg==", [102], Base64.encode, Base64.decode) + , ("base64", "fo", "Zm8=", [102,111], Base64.encode, Base64.decode) + , ("base64", "foo", "Zm9v", [102,111,111], Base64.encode, Base64.decode) + , ("base64", "foob", "Zm9vYg==", [102,111,111,98], Base64.encode, Base64.decode) + , ("base64", "fooba", "Zm9vYmE=", [102,111,111,98,97], Base64.encode, Base64.decode) + , ("base64", "foobar", "Zm9vYmFy", [102,111,111,98,97,114], Base64.encode, Base64.decode) + , ("base64url", "\0", "AA==", [0], Base64.encode, Base64.decode) + , ("base64url", "\255", "/w==", [255], Base64.encode, Base64.decode) + , ("base64", "Example", "RXhhbXBsZQ==", [69,120,97,109,112,108,101], Base64.encode, Base64.decode) + ] +base64Tests = buildTestList base64TestData + +-- {{{1 base64url tests +base64UrlTestData = + [ ("base64url", "empty", "", [], Base64Url.encode, Base64Url.decode) + , ("base64url", "\0", "AA==", [0], Base64Url.encode, Base64Url.decode) + , ("base64url", "\255", "_w==", [255], Base64Url.encode, Base64Url.decode) + , ("base64url", "Example", "RXhhbXBsZQ==", [69,120,97,109,112,108,101], Base64Url.encode, Base64Url.decode) + ] +base64UrlTests = buildTestList base64UrlTestData + +-- {{{1 base32 tests +base32TestData = + [ ("base32", "empty", "", [], Base32.encode, Base32.decode) + , ("base32", "f", "MY======", [102], Base32.encode, Base32.decode) + , ("base32", "fo", "MZXQ====", [102,111], Base32.encode, Base32.decode) + , ("base32", "foo", "MZXW6===", [102,111,111], Base32.encode, Base32.decode) + , ("base32", "foob", "MZXW6YQ=", [102,111,111,98], Base32.encode, Base32.decode) + , ("base32", "fooba", "MZXW6YTB", [102,111,111,98,97], Base32.encode, Base32.decode) + , ("base32", "foobar", "MZXW6YTBOI======", [102,111,111,98,97,114], Base32.encode, Base32.decode) + ] +base32Tests = buildTestList base32TestData + +-- {{{1 base32hex tests +base32HexTestData = + [ ("base32hex", "empty", "", [], Base32Hex.encode, Base32Hex.decode) + , ("base32hex", "f", "CO======", [102], Base32Hex.encode, Base32Hex.decode) + , ("base32hex", "fo", "CPNG====", [102,111], Base32Hex.encode, Base32Hex.decode) + , ("base32hex", "foo", "CPNMU===", [102,111,111], Base32Hex.encode, Base32Hex.decode) + , ("base32hex", "foob", "CPNMUOG=", [102,111,111,98], Base32Hex.encode, Base32Hex.decode) + , ("base32hex", "fooba", "CPNMUOJ1", [102,111,111,98,97], Base32Hex.encode, Base32Hex.decode) + , ("base32hex", "foobar", "CPNMUOJ1E8======", [102,111,111,98,97,114], Base32Hex.encode, Base32Hex.decode) + ] +base32HexTests = buildTestList base32HexTestData + +-- {{{1 base16 (hex) +base16TestData = + [ ("base16", "empty", "", [], Base16.encode, Base16.decode) + , ("base16", "f", "66", [102], Base16.encode, Base16.decode) + , ("base16", "fo", "666F", [102,111], Base16.encode, Base16.decode) + , ("base16", "foo", "666F6F", [102,111,111], Base16.encode, Base16.decode) + , ("base16", "foob", "666F6F62", [102,111,111,98], Base16.encode, Base16.decode) + , ("base16", "fooba", "666F6F6261", [102,111,111,98,97], Base16.encode, Base16.decode) + , ("base16", "foobar", "666F6F626172", [102,111,111,98,97,114], Base16.encode, Base16.decode) + ] +base16Tests = buildTestList base16TestData + +-- {{{1 test list and main +testList = TestList [uuTests, uuTests2, base64Tests, base64UrlTests, base32Tests, base32HexTests, base16Tests ] + +main :: IO () +main = do + counts <- runTestTT testList + when ((errors counts, failures counts) /= (0, 0)) $ exitWith (ExitFailure 1) diff --git a/dataenc.cabal b/dataenc.cabal new file mode 100644 --- /dev/null +++ b/dataenc.cabal @@ -0,0 +1,20 @@ +name: dataenc +version: 0.9 +license: LGPL +license-file: COPYING.LESSER +author: Magnus Therning +maintainer: magnus@therning.org +copyright: Magnus Therning, 2007 +synopsis: Data encoding library currently providing Uuencode, Base64, + Base64Url, Base32, Base32Hex, and Base16. +hs-source-dirs: src +extra-source-files: UT.hs QC.hs COPYING +build-depends: base +exposed-modules: + Codec.Binary.DataEncoding + Codec.Binary.Base16 + Codec.Binary.Base32Hex + Codec.Binary.Base32 + Codec.Binary.Uu + Codec.Binary.Base64Url + Codec.Binary.Base64 diff --git a/src/Codec/Binary/Base16.hs b/src/Codec/Binary/Base16.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Binary/Base16.hs @@ -0,0 +1,90 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +-- | Base16 module. +-- +-- Implemented as specified in RFC 4648 +-- (). +module Codec.Binary.Base16 + ( encode + , decode + , chop + , unchop + ) where + +import Control.Monad +import Data.Array +import Data.Bits +import Data.Maybe +import Data.Word +import qualified Data.Map as M + +-- {{{1 encodeArray +encodeArray :: Array Word8 Char +encodeArray = array (0, 64) [ + (0, '0'), (1, '1'), (2, '2'), (3, '3'), (4, '4'), + (5, '5'), (6, '6'), (7, '7'), (8, '8'), (9, '9'), + (10, 'A'), (11, 'B'), (12, 'C'), (13, 'D'), (14, 'E'), + (15, 'F') ] + +-- {{{1 decodeMap +decodeMap :: M.Map Char Word8 +decodeMap = M.fromList [ + ('0', 0), ('1', 1), ('2', 2), ('3', 3), ('4', 4), + ('5', 5), ('6', 6), ('7', 7), ('8', 8), ('9', 9), + ('A', 10), ('B', 11), ('C', 12), ('D', 13), ('E', 14), + ('F', 15) ] + +-- {{{1 encode +-- | Encode data. +encode :: [Word8] + -> String +encode os = let + splitOctet o = [ o `shiftR` 4, o .&. 0xf ] + in map (encodeArray !) $ foldr (\ o l -> (splitOctet o) ++ l) [] os + +-- {{{1 decode +-- | Decode data. +decode :: String + -> Maybe [Word8] +decode s = let + dec [] = [] + dec (o1:o2:os) = + (o1 `shiftL` 4 .|. o2) : dec os + in + if (length s `mod` 2 == 0) + then liftM dec $ sequence $ map (flip M.lookup decodeMap) s + else Nothing + +-- {{{1 chop +-- | Chop up a string in parts. +-- +-- The length given is rounded down to the nearest multiple of 2. +chop :: Int -- ^ length of individual lines + -> String + -> [String] +chop n "" = [] +chop n s = let + enc_len = n `div` 2 * 2 + in (take enc_len s) : chop n (drop enc_len s) + +-- {{{1 unchop +-- | Concatenate the strings into one long string. +unchop :: [String] + -> String +unchop = foldr (++) "" diff --git a/src/Codec/Binary/Base32.hs b/src/Codec/Binary/Base32.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Binary/Base32.hs @@ -0,0 +1,151 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +-- | Base32 module. +-- +-- Implemented as specified in RFC 4648 +-- (). +module Codec.Binary.Base32 + ( encode + , decode + , chop + , unchop + ) where + +import Control.Monad +import Data.Array +import Data.Bits +import Data.Maybe +import Data.Word +import qualified Data.Map as M + +-- {{{1 encodeArray +encodeArray :: Array Word8 Char +encodeArray = array (0, 32) [ + (0, 'A'), (1, 'B'), (2, 'C'), (3, 'D'), (4, 'E'), + (5, 'F'), (6, 'G'), (7, 'H'), (8, 'I'), (9, 'J'), + (10, 'K'), (11, 'L'), (12, 'M'), (13, 'N'), (14, 'O'), + (15, 'P'), (16, 'Q'), (17, 'R'), (18, 'S'), (19, 'T'), + (20, 'U'), (21, 'V'), (22, 'W'), (23, 'X'), (24, 'Y'), + (25, 'Z'), (26, '2'), (27, '3'), (28, '4'), (29, '5'), + (30, '6'), (31, '7') ] + +-- {{{1 decodeMap +decodeMap :: M.Map Char Word8 +decodeMap = M.fromList [ + ('A', 0), ('B', 1), ('C', 2), ('D', 3), ('E', 4), + ('F', 5), ('G', 6), ('H', 7), ('I', 8), ('J', 9), + ('K', 10), ('L', 11), ('M', 12), ('N', 13), ('O', 14), + ('P', 15), ('Q', 16), ('R', 17), ('S', 18), ('T', 19), + ('U', 20), ('V', 21), ('W', 22), ('X', 23), ('Y', 24), + ('Z', 25), ('2', 26), ('3', 27), ('4', 28), ('5', 29), + ('6', 30), ('7', 31) ] + +-- {{{1 encode +-- | Encode data. +encode :: [Word8] + -> String +encode [] = "" +encode [o] = let + i1 = o `shiftR` 3 + i2 = o `shiftL` 2 .&. 0x1f + in (encodeArray ! i1) : (encodeArray ! i2) : "======" +encode [o1, o2] = let + i1 = o1 `shiftR` 3 + i2 = (o1 `shiftL` 2 .|. o2 `shiftR` 6) .&. 0x1f + i3 = o2 `shiftR` 1 .&. 0x1f + i4 = o2 `shiftL` 4 .&. 0x1f + in foldr (\ i s -> (encodeArray ! i) : s) "====" [i1, i2, i3, i4] +encode [o1, o2, o3] = let + i1 = o1 `shiftR` 3 + i2 = (o1 `shiftL` 2 .|. o2 `shiftR` 6) .&. 0x1f + i3 = o2 `shiftR` 1 .&. 0x1f + i4 = (o2 `shiftL` 4 .|. o3 `shiftR` 4) .&. 0x1f + i5 = o3 `shiftL` 1 .&. 0x1f + in foldr (\ i s -> (encodeArray ! i) : s) "===" [i1, i2, i3, i4, i5] +encode [o1, o2, o3, o4] = let + i1 = o1 `shiftR` 3 + i2 = (o1 `shiftL` 2 .|. o2 `shiftR` 6) .&. 0x1f + i3 = o2 `shiftR` 1 .&. 0x1f + i4 = (o2 `shiftL` 4 .|. o3 `shiftR` 4) .&. 0x1f + i5 = (o3 `shiftL` 1 .|. o4 `shiftR` 7) .&. 0x1f + i6 = o4 `shiftR` 2 .&. 0x1f + i7 = o4 `shiftL` 3 .&. 0x1f + in foldr (\ i s -> (encodeArray ! i) : s) "=" [i1, i2, i3, i4, i5, i6, i7] +encode (o1:o2:o3:o4:o5:os) = let + i1 = o1 `shiftR` 3 + i2 = (o1 `shiftL` 2 .|. o2 `shiftR` 6) .&. 0x1f + i3 = o2 `shiftR` 1 .&. 0x1f + i4 = (o2 `shiftL` 4 .|. o3 `shiftR` 4) .&. 0x1f + i5 = (o3 `shiftL` 1 .|. o4 `shiftR` 7) .&. 0x1f + i6 = o4 `shiftR` 2 .&. 0x1f + i7 = (o4 `shiftL` 3 .|. o5 `shiftR` 5) .&. 0x1f + i8 = o5 .&. 0x1f + in (foldr (\ i s -> (encodeArray ! i) : s) "" [i1, i2, i3, i4, i5, i6, i7, i8]) ++ (encode os) + +-- {{{1 decode +-- | Decode data. +decode :: String + -> Maybe [Word8] +decode s = let + dec [] = [] + dec [eo1, eo2] = [eo1 `shiftL` 3 .|. eo2 `shiftR` 2] + dec [eo1, eo2, eo3, eo4] = let + o1 = eo1 `shiftL` 3 .|. eo2 `shiftR` 2 + o2 = eo2 `shiftL` 6 .|. eo3 `shiftL` 1 .|. eo4 `shiftR` 4 + in [o1, o2] + dec [eo1, eo2, eo3, eo4, eo5] = let + o1 = eo1 `shiftL` 3 .|. eo2 `shiftR` 2 + o2 = eo2 `shiftL` 6 .|. eo3 `shiftL` 1 .|. eo4 `shiftR` 4 + o3 = eo4 `shiftL` 4 .|. eo5 `shiftR` 1 + in [o1, o2, o3] + dec [eo1, eo2, eo3, eo4, eo5, eo6, eo7] = let + o1 = eo1 `shiftL` 3 .|. eo2 `shiftR` 2 + o2 = eo2 `shiftL` 6 .|. eo3 `shiftL` 1 .|. eo4 `shiftR` 4 + o3 = eo4 `shiftL` 4 .|. eo5 `shiftR` 1 + o4 = eo5 `shiftL` 7 .|. eo6 `shiftL` 2 .|. eo7 `shiftR` 3 + in [o1, o2, o3, o4] + dec (eo1:eo2:eo3:eo4:eo5:eo6:eo7:eo8:eos) = let + o1 = eo1 `shiftL` 3 .|. eo2 `shiftR` 2 + o2 = eo2 `shiftL` 6 .|. eo3 `shiftL` 1 .|. eo4 `shiftR` 4 + o3 = eo4 `shiftL` 4 .|. eo5 `shiftR` 1 + o4 = eo5 `shiftL` 7 .|. eo6 `shiftL` 2 .|. eo7 `shiftR` 3 + o5 = eo7 `shiftL` 5 .|. eo8 + in o1:o2:o3:o4:o5:(dec eos) + in + if (length s `mod` 8 == 0) + then liftM dec $ sequence $ map (flip M.lookup decodeMap) (filter (/= '=') s) + else Nothing + +-- {{{1 chop +-- | Chop up a string in parts. +-- +-- The length given is rounded down to the nearest multiple of 8. +chop :: Int -- ^ length of individual lines + -> String + -> [String] +chop n "" = [] +chop n s = let + enc_len = n `div` 8 * 8 + in (take enc_len s) : chop n (drop enc_len s) + +-- {{{1 unchop +-- | Concatenate the strings into one long string. +unchop :: [String] + -> String +unchop = foldr (++) "" diff --git a/src/Codec/Binary/Base32Hex.hs b/src/Codec/Binary/Base32Hex.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Binary/Base32Hex.hs @@ -0,0 +1,153 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +-- | Base32Hex module. +-- +-- Implemented as specified in RFC 4648 +-- (). +module Codec.Binary.Base32Hex + ( encode + , decode + , chop + , unchop + ) where + +import Control.Monad +import Data.Array +import Data.Bits +import Data.Maybe +import Data.Word +import qualified Data.Map as M + +import qualified Codec.Binary.Base32 as Base32 + +-- {{{1 encodeArray +encodeArray :: Array Word8 Char +encodeArray = array (0, 32) [ + (0, '0'), (1, '1'), (2, '2'), (3, '3'), (4, '4'), + (5, '5'), (6, '6'), (7, '7'), (8, '8'), (9, '9'), + (10, 'A'), (11, 'B'), (12, 'C'), (13, 'D'), (14, 'E'), + (15, 'F'), (16, 'G'), (17, 'H'), (18, 'I'), (19, 'J'), + (20, 'K'), (21, 'L'), (22, 'M'), (23, 'N'), (24, 'O'), + (25, 'P'), (26, 'Q'), (27, 'R'), (28, 'S'), (29, 'T'), + (30, 'U'), (31, 'V') ] + +-- {{{1 decodeMap +decodeMap :: M.Map Char Word8 +decodeMap = M.fromList [ + ('0', 0), ('1', 1), ('2', 2), ('3', 3), ('4', 4), + ('5', 5), ('6', 6), ('7', 7), ('8', 8), ('9', 9), + ('A', 10), ('B', 11), ('C', 12), ('D', 13), ('E', 14), + ('F', 15), ('G', 16), ('H', 17), ('I', 18), ('J', 19), + ('K', 20), ('L', 21), ('M', 22), ('N', 23), ('O', 24), + ('P', 25), ('Q', 26), ('R', 27), ('S', 28), ('T', 29), + ('U', 30), ('V', 31) + ] + +-- {{{1 encode +-- | Encode data. +encode :: [Word8] + -> String +encode [] = "" +encode [o] = let + i1 = o `shiftR` 3 + i2 = o `shiftL` 2 .&. 0x1f + in (encodeArray ! i1) : (encodeArray ! i2) : "======" +encode [o1, o2] = let + i1 = o1 `shiftR` 3 + i2 = (o1 `shiftL` 2 .|. o2 `shiftR` 6) .&. 0x1f + i3 = o2 `shiftR` 1 .&. 0x1f + i4 = o2 `shiftL` 4 .&. 0x1f + in foldr (\ i s -> (encodeArray ! i) : s) "====" [i1, i2, i3, i4] +encode [o1, o2, o3] = let + i1 = o1 `shiftR` 3 + i2 = (o1 `shiftL` 2 .|. o2 `shiftR` 6) .&. 0x1f + i3 = o2 `shiftR` 1 .&. 0x1f + i4 = (o2 `shiftL` 4 .|. o3 `shiftR` 4) .&. 0x1f + i5 = o3 `shiftL` 1 .&. 0x1f + in foldr (\ i s -> (encodeArray ! i) : s) "===" [i1, i2, i3, i4, i5] +encode [o1, o2, o3, o4] = let + i1 = o1 `shiftR` 3 + i2 = (o1 `shiftL` 2 .|. o2 `shiftR` 6) .&. 0x1f + i3 = o2 `shiftR` 1 .&. 0x1f + i4 = (o2 `shiftL` 4 .|. o3 `shiftR` 4) .&. 0x1f + i5 = (o3 `shiftL` 1 .|. o4 `shiftR` 7) .&. 0x1f + i6 = o4 `shiftR` 2 .&. 0x1f + i7 = o4 `shiftL` 3 .&. 0x1f + in foldr (\ i s -> (encodeArray ! i) : s) "=" [i1, i2, i3, i4, i5, i6, i7] +encode (o1:o2:o3:o4:o5:os) = let + i1 = o1 `shiftR` 3 + i2 = (o1 `shiftL` 2 .|. o2 `shiftR` 6) .&. 0x1f + i3 = o2 `shiftR` 1 .&. 0x1f + i4 = (o2 `shiftL` 4 .|. o3 `shiftR` 4) .&. 0x1f + i5 = (o3 `shiftL` 1 .|. o4 `shiftR` 7) .&. 0x1f + i6 = o4 `shiftR` 2 .&. 0x1f + i7 = (o4 `shiftL` 3 .|. o5 `shiftR` 5) .&. 0x1f + i8 = o5 .&. 0x1f + in (foldr (\ i s -> (encodeArray ! i) : s) "" [i1, i2, i3, i4, i5, i6, i7, i8]) ++ (encode os) + +-- {{{1 decode +-- | Decode data. +decode :: String + -> Maybe [Word8] +decode s = let + dec [] = [] + dec [eo1, eo2] = [eo1 `shiftL` 3 .|. eo2 `shiftR` 2] + dec [eo1, eo2, eo3, eo4] = let + o1 = eo1 `shiftL` 3 .|. eo2 `shiftR` 2 + o2 = eo2 `shiftL` 6 .|. eo3 `shiftL` 1 .|. eo4 `shiftR` 4 + in [o1, o2] + dec [eo1, eo2, eo3, eo4, eo5] = let + o1 = eo1 `shiftL` 3 .|. eo2 `shiftR` 2 + o2 = eo2 `shiftL` 6 .|. eo3 `shiftL` 1 .|. eo4 `shiftR` 4 + o3 = eo4 `shiftL` 4 .|. eo5 `shiftR` 1 + in [o1, o2, o3] + dec [eo1, eo2, eo3, eo4, eo5, eo6, eo7] = let + o1 = eo1 `shiftL` 3 .|. eo2 `shiftR` 2 + o2 = eo2 `shiftL` 6 .|. eo3 `shiftL` 1 .|. eo4 `shiftR` 4 + o3 = eo4 `shiftL` 4 .|. eo5 `shiftR` 1 + o4 = eo5 `shiftL` 7 .|. eo6 `shiftL` 2 .|. eo7 `shiftR` 3 + in [o1, o2, o3, o4] + dec (eo1:eo2:eo3:eo4:eo5:eo6:eo7:eo8:eos) = let + o1 = eo1 `shiftL` 3 .|. eo2 `shiftR` 2 + o2 = eo2 `shiftL` 6 .|. eo3 `shiftL` 1 .|. eo4 `shiftR` 4 + o3 = eo4 `shiftL` 4 .|. eo5 `shiftR` 1 + o4 = eo5 `shiftL` 7 .|. eo6 `shiftL` 2 .|. eo7 `shiftR` 3 + o5 = eo7 `shiftL` 5 .|. eo8 + in o1:o2:o3:o4:o5:(dec eos) + in + if (length s `mod` 8 == 0) + then liftM dec $ sequence $ map (flip M.lookup decodeMap) (filter (/= '=') s) + else Nothing + +-- {{{1 chop +-- | Chop up a string in parts. +-- +-- See 'Base32.chop' in "Base32" for more details. +chop :: Int -- ^ length of individual lines + -> String + -> [String] +chop = Base32.chop + +-- {{{1 unchop +-- | Concatenate the strings into one long string. +-- +-- See 'Base32.unchop' in "Codec.Binary.Base32" for more details. +unchop :: [String] + -> String +unchop = Base32.unchop diff --git a/src/Codec/Binary/Base64.hs b/src/Codec/Binary/Base64.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Binary/Base64.hs @@ -0,0 +1,135 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +-- | Base64 module. +-- +-- Implemented as specified in RFC 4648 +-- (). +module Codec.Binary.Base64 + ( encode + , decode + , chop + , unchop + ) where + +import Control.Monad +import Data.Array +import Data.Bits +import Data.Maybe +import Data.Word +import qualified Data.Map as M + +-- {{{1 encodeArray +encodeArray :: Array Word8 Char +encodeArray = array (0, 64) [ + (0, 'A'), (1, 'B'), (2, 'C'), (3, 'D'), (4, 'E'), + (5, 'F') , (6, 'G'), (7, 'H'), (8, 'I'), (9, 'J'), + (10, 'K'), (11, 'L'), (12, 'M'), (13, 'N'), (14, 'O'), + (15, 'P'), (16, 'Q'), (17, 'R'), (18, 'S'), (19, 'T'), + (20, 'U'), (21, 'V'), (22, 'W'), (23, 'X'), (24, 'Y'), + (25, 'Z'), (26, 'a'), (27, 'b'), (28, 'c'), (29, 'd'), + (30, 'e'), (31, 'f'), (32, 'g'), (33, 'h'), (34, 'i'), + (35, 'j'), (36, 'k'), (37, 'l'), (38, 'm'), (39, 'n'), + (40, 'o'), (41, 'p'), (42, 'q'), (43, 'r'), (44, 's'), + (45, 't'), (46, 'u'), (47, 'v'), (48, 'w'), (49, 'x'), + (50, 'y'), (51, 'z'), (52, '0'), (53, '1'), (54, '2'), + (55, '3'), (56, '4'), (57, '5'), (58, '6'), (59, '7'), + (60, '8'), (61, '9'), (62, '+'), (63, '/') ] + +-- {{{1 decodeMap +decodeMap :: M.Map Char Word8 +decodeMap = M.fromList [ + ('A', 0), ('B', 1), ('C', 2), ('D', 3), ('E', 4), + ('F', 5), ('G', 6), ('H', 7), ('I', 8), ('J', 9), + ('K', 10), ('L', 11), ('M', 12), ('N', 13), ('O', 14), + ('P', 15), ('Q', 16), ('R', 17), ('S', 18), ('T', 19), + ('U', 20), ('V', 21), ('W', 22), ('X', 23), ('Y', 24), + ('Z', 25), ('a', 26), ('b', 27), ('c', 28), ('d', 29), + ('e', 30), ('f', 31), ('g', 32), ('h', 33), ('i', 34), + ('j', 35), ('k', 36), ('l', 37), ('m', 38), ('n', 39), + ('o', 40), ('p', 41), ('q', 42), ('r', 43), ('s', 44), + ('t', 45), ('u', 46), ('v', 47), ('w', 48), ('x', 49), + ('y', 50), ('z', 51), ('0', 52), ('1', 53), ('2', 54), + ('3', 55), ('4', 56), ('5', 57), ('6', 58), ('7', 59), + ('8', 60), ('9', 61), ('+', 62), ('/', 63) ] + +-- {{{1 encode +-- | Encode data. +encode :: [Word8] + -> String +encode [] = "" +encode [o] = let + i1 = o `shiftR` 2 + i2 = o `shiftL` 4 .&. 0x3f + in (encodeArray ! i1) : (encodeArray ! i2) : "==" +encode [o1, o2] = let + i1 = o1 `shiftR` 2 + i2 = (o1 `shiftL` 4 .|. o2 `shiftR` 4) .&. 0x3f + i3 = o2 `shiftL` 2 .&. 0x3f + in foldr (\ i s-> (encodeArray ! i) : s) "=" [i1, i2, i3] +encode (o1:o2:o3:os) = let + i1 = o1 `shiftR` 2 + i2 = (o1 `shiftL` 4 .|. o2 `shiftR` 4) .&. 0x3f + i3 = (o2 `shiftL` 2 .|. o3 `shiftR` 6) .&. 0x3f + i4 = o3 .&. 0x3f + in (foldr (\ i s -> (encodeArray ! i) : s) "" [i1, i2, i3, i4]) ++ encode os + +-- {{{1 decode +-- | Decode data. +decode :: String + -> Maybe [Word8] +decode s = let + dec [] = [] + dec [eo1, eo2] = [eo1 `shiftL` 2 .|. eo2 `shiftR` 4] + dec [eo1, eo2, eo3] = let + o1 = eo1 `shiftL` 2 .|. eo2 `shiftR` 4 + o2 = eo2 `shiftL` 4 .|. eo3 `shiftR` 2 + in [o1, o2] + dec (eo1:eo2:eo3:eo4:eos) = let + o1 = eo1 `shiftL` 2 .|. eo2 `shiftR` 4 + o2 = eo2 `shiftL` 4 .|. eo3 `shiftR` 2 + o3 = eo3 `shiftL` 6 .|. eo4 + in o1:o2:o3:(dec eos) + in + if (length s `mod` 4 == 0) + then liftM dec $ sequence $ map (flip M.lookup decodeMap) (filter (/= '=') s) + else Nothing + +-- {{{1 chop +-- | Chop up a string in parts. +-- +-- The length given is rounded down to the nearest multiple of 4. +-- +-- /Notes:/ +-- +-- * PEM requires lines that are 64 characters long. +-- +-- * MIME requires lines that are at most 76 characters long. +chop :: Int -- ^ length of individual lines + -> String + -> [String] +chop n "" = [] +chop n s = let + enc_len = n `div` 4 * 4 + in (take enc_len s) : chop n (drop enc_len s) + +-- {{{1 unchop +-- | Concatenate the strings into one long string. +unchop :: [String] + -> String +unchop = foldr (++) "" diff --git a/src/Codec/Binary/Base64Url.hs b/src/Codec/Binary/Base64Url.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Binary/Base64Url.hs @@ -0,0 +1,72 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +-- | Base64Url module. +-- +-- Implemented as specified in RFC 4648 +-- (). +module Codec.Binary.Base64Url + ( encode + , decode + , chop + , unchop + ) where + +import Data.Maybe +import Data.Word + +import qualified Codec.Binary.Base64 as Base64 + +-- {{{1 encode +-- | Encode data. +encode :: [Word8] + -> String +encode os = let + swapUrlChar c = case c of + '+' -> '-' + '/' -> '_' + _ -> c + in map swapUrlChar $ Base64.encode os + +-- {{{1 decode +-- | Decode data. +decode :: String + -> Maybe [Word8] +decode cs = let + unSwapUrlChar c = case c of + '-' -> '+' + '_' -> '/' + _ -> c + in Base64.decode $ map unSwapUrlChar cs + +-- {{{1 chop +-- | Chop up a string in parts. +-- +-- See 'Base64.chop' in "Base64" for more details. +chop :: Int -- ^ length of individual lines + -> String + -> [String] +chop = Base64.chop + +-- {{{1 unchop +-- | Concatenate the strings into one long string. +-- +-- See 'Base64.unchop' in "Codec.Binary.Base64" for more details. +unchop :: [String] + -> String +unchop = Base64.unchop diff --git a/src/Codec/Binary/DataEncoding.hs b/src/Codec/Binary/DataEncoding.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Binary/DataEncoding.hs @@ -0,0 +1,121 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +-- | Data encoding module. +-- +-- It exposes several instances of 'DataCoded', one for each data encoding +-- implemented in the library without causing the name clashing that would +-- result from importing the individual encoding modules. +-- +module Codec.Binary.DataEncoding + ( encode + , decode + , chop + , unchop + , base16 + , base32 + , base32Hex + , base64 + , base64Url + , uu + ) + where + +import Data.Word + +import qualified Codec.Binary.Base16 as Base16 +import qualified Codec.Binary.Base32 as Base32 +import qualified Codec.Binary.Base32Hex as Base32Hex +import qualified Codec.Binary.Base64 as Base64 +import qualified Codec.Binary.Base64Url as Base64Url +import qualified Codec.Binary.Uu as Uu + +-- {{{1 DataCodec +-- | Used to group a specific data encoding's functions. +data DataCodec = DataCodec { + encode :: [Word8] -> String, + decode :: String -> Maybe [Word8], + chop :: Int -> String -> [String], + unchop :: [String] -> String +} + +-- {{{1 base16 +-- | Base16 encoding, see "Codec.Binary.Base16" for more details on +-- the individual functions. +base16 :: DataCodec +base16 = DataCodec { + encode=Base16.encode, + decode=Base16.decode, + chop=Base16.chop, + unchop=Base16.unchop +} + +-- {{{1 base32 +-- | Base32 encoding, see "Codec.Binary.Base32" for more details on +-- the individual functions. +base32 :: DataCodec +base32 = DataCodec { + encode=Base32.encode, + decode=Base32.decode, + chop=Base32.chop, + unchop=Base32.unchop +} + +-- {{{1 base32Hex +-- | Base32Hex encoding, see "Codec.Binary.Base32Hex" for more details +-- on the individual functions. +base32Hex :: DataCodec +base32Hex = DataCodec { + encode=Base32Hex.encode, + decode=Base32Hex.decode, + chop=Base32Hex.chop, + unchop=Base32Hex.unchop +} + +-- {{{1 base64 +-- | Base64 encoding, see "Codec.Binary.Base64" for more details on +-- the individual functions. +base64 :: DataCodec +base64 = DataCodec { + encode=Base64.encode, + decode=Base64.decode, + chop=Base64.chop, + unchop=Base64.unchop +} + +-- {{{1 base64Url +-- | Base64Url encoding, see "Codec.Binary.Base64Url" for more details +-- on the individual functions. +base64Url :: DataCodec +base64Url = DataCodec { + encode=Base64Url.encode, + decode=Base64Url.decode, + chop=Base64Url.chop, + unchop=Base64Url.unchop +} + +-- {{{1 uu +-- | Uuencoding, see "Codec.Binary.Uu" for more details on the +-- individual functions. +uu :: DataCodec +uu = DataCodec { + encode=Uu.encode, + decode=Uu.decode, + chop=Uu.chop, + unchop=Uu.unchop +} diff --git a/src/Codec/Binary/Uu.hs b/src/Codec/Binary/Uu.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Binary/Uu.hs @@ -0,0 +1,153 @@ +{- Copyright © 2007 Magnus Therning + - + - This file is part of dataenc. + - + - Dataenc is free software: you can redistribute it and/or modify it under + - the terms of the GNU Lesser General Public License as published by the + - Free Software Foundation, either version 3 of the License, or (at your + - option) any later version. + - + - Dataenc 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 Lesser General Public + - License for more details. + - + - You should have received a copy of the GNU Lesser General Public License + - along with dataenc. If not, see + -} + +-- | Uuencoding module. +-- +-- Uuencoding is notoriously badly specified. This implementation is +-- compatible with the GNU Sharutils +-- (). +module Codec.Binary.Uu + ( encode + , decode + , chop + , unchop + ) where + +import Control.Monad +import Data.Array +import Data.Bits +import Data.Maybe +import Data.Word +import qualified Data.Map as M + +-- {{{1 encodeArray +encodeArray :: Array Word8 Char +encodeArray = array (0, 64) [ + (0, '`'), (1, '!'), (2, '"'), (3, '#'), (4, '$'), + (5, '%'), (6, '&'), (7, '\''), (8, '('), (9, ')'), + (10, '*'), (11, '+'), (12, ','), (13, '-'), (14, '.'), + (15, '/'), (16, '0'), (17, '1'), (18, '2'), (19, '3'), + (20, '4'), (21, '5'), (22, '6'), (23, '7'), (24, '8'), + (25, '9'), (26, ':'), (27, ';'), (28, '<'), (29, '='), + (30, '>'), (31, '?'), (32, '@'), (33, 'A'), (34, 'B'), + (35, 'C'), (36, 'D'), (37, 'E'), (38, 'F'), (39, 'G'), + (40, 'H'), (41, 'I'), (42, 'J'), (43, 'K'), (44, 'L'), + (45, 'M'), (46, 'N'), (47, 'O'), (48, 'P'), (49, 'Q'), + (50, 'R'), (51, 'S'), (52, 'T'), (53, 'U') ,(54, 'V'), + (55, 'W'), (56, 'X'), (57, 'Y'), (58, 'Z'), (59, '['), + (60, '\\'), (61, ']'), (62, '^'), (63, '_') ] + +-- {{{1 decodeMap +decodeMap :: M.Map Char Word8 +decodeMap = M.fromList [ + ('`', 0), ('!', 1), ('"', 2), ('#', 3), ('$', 4), + ('%', 5), ('&', 6), ('\'', 7), ('(', 8), (')', 9), + ('*', 10), ('+', 11), (',', 12), ('-', 13), ('.', 14), + ('/', 15), ('0', 16), ('1', 17), ('2', 18), ('3', 19), + ('4', 20), ('5', 21), ('6', 22), ('7', 23), ('8', 24), + ('9', 25), (':', 26), (';', 27), ('<', 28), ('=', 29), + ('>', 30), ('?', 31), ('@', 32), ('A', 33), ('B', 34), + ('C', 35), ('D', 36), ('E', 37), ('F', 38), ('G', 39), + ('H', 40), ('I', 41), ('J', 42), ('K', 43), ('L', 44), + ('M', 45), ('N', 46), ('O', 47), ('P', 48), ('Q', 49), + ('R', 50), ('S', 51), ('T', 52), ('U', 53), ('V', 54), + ('W', 55), ('X', 56), ('Y', 57), ('Z', 58), ('[', 59), + ('\\', 60), (']', 61), ('^', 62), ('_', 63) ] + +-- {{{1 encode +-- | Encode data. +encode :: [Word8] + -> String +encode [] = "" +encode [o] = let + i1 = o `shiftR` 2 + i2 = o `shiftL` 4 .&. 0x3f + in (encodeArray ! i1) : (encodeArray ! i2) : "" +encode [o1, o2] = let + i1 = o1 `shiftR` 2 + i2 = (o1 `shiftL` 4 .|. o2 `shiftR` 4) .&. 0x3f + i3 = o2 `shiftL` 2 .&. 0x3f + in foldr (\ i s-> (encodeArray ! i) : s) "" [i1, i2, i3] +encode (o1:o2:o3:os) = let + i1 = o1 `shiftR` 2 + i2 = (o1 `shiftL` 4 .|. o2 `shiftR` 4) .&. 0x3f + i3 = (o2 `shiftL` 2 .|. o3 `shiftR` 6) .&. 0x3f + i4 = o3 .&. 0x3f + in (foldr (\ i s -> (encodeArray ! i) : s) "" [i1, i2, i3, i4]) ++ encode os + +-- {{{1 decode +-- | Decode data. +decode :: String + -> Maybe [Word8] +decode s = let + dec [] = [] + dec [eo1, eo2] = [eo1 `shiftL` 2 .|. eo2 `shiftR` 4] + dec [eo1, eo2, eo3] = let + o1 = eo1 `shiftL` 2 .|. eo2 `shiftR` 4 + o2 = eo2 `shiftL` 4 .|. eo3 `shiftR` 2 + in [o1, o2] + dec (eo1:eo2:eo3:eo4:eos) = let + o1 = eo1 `shiftL` 2 .|. eo2 `shiftR` 4 + o2 = eo2 `shiftL` 4 .|. eo3 `shiftR` 2 + o3 = eo3 `shiftL` 6 .|. eo4 + in o1:o2:o3:(dec eos) + in + if (length s `mod` 4 /= 1) + then liftM dec $ sequence $ map (flip M.lookup decodeMap) s + else Nothing + +-- {{{1 chop +-- | Chop up a string in parts. Each string in the resulting list is prepended +-- with the length according to the uuencode \"specificiation\". +-- +-- /Notes:/ +-- +-- * The length of the strings in the result will be @(n -1) `div` 4 * 4@. +-- The @-1@ comes from the need to prepend the length. Keeping it to a +-- multiple of 4 means that strings returned from 'encode' can be chopped +-- without requiring any changes. +-- +-- * The length of lines in GNU's sharutils is 61. +chop :: Int -- ^ length (@1 < n <= 65@, not checked) + -> String + -> [String] +chop n "" = [] +chop n s = let + enc_len = (n - 1) `div` 4 * 4 + enc_line = take enc_len s + act_len = fromIntegral $ case (length enc_line `divMod` 4) of + (l, 0) -> l * 3 + (l, 2) -> l * 3 + 1 + (l, 3) -> l * 3 + 2 + len = (encodeArray ! act_len) + in (len : enc_line) : chop n (drop enc_len s) + +-- {{{1 unchop +-- | Concatenate the strings into one long string. Each string is assumed to +-- be prepended with the length according to the uuencode specification. +unchop :: [String] + -> String +unchop ss = let + singleUnchop (l:cs) = let + act_len = fromIntegral $ decodeMap M.! l + enc_len = case (act_len `divMod` 3) of + (n, 0) -> n * 4 + (n, 1) -> n * 4 + 2 + (n, 2) -> n * 4 + 3 + in take enc_len cs + in foldr (\ s res -> (singleUnchop s) ++ res) "" ss