gsasl 0.3.2 → 0.3.3
raw patch · 7 files changed
+1691/−1674 lines, 7 filesdep ~basePVP ok
version bump matches the API change (PVP)
Dependency ranges changed: base
API changes (from Hackage documentation)
Files
- License.txt +0/−674
- Network/Protocol/SASL/GNU.hs +0/−971
- cbits/hsgsasl-shim.c +13/−0
- gsasl.cabal +24/−16
- hsgsasl-shim.c +0/−13
- lib/Network/Protocol/SASL/GNU.hs +980/−0
- license.txt +674/−0
− License.txt
@@ -1,674 +0,0 @@- GNU GENERAL PUBLIC LICENSE- Version 3, 29 June 2007-- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>- Everyone is permitted to copy and distribute verbatim copies- of this license document, but changing it is not allowed.-- Preamble-- The GNU 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.-- <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 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 <http://www.gnu.org/licenses/>.--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:-- <program> Copyright (C) <year> <name of author>- 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-<http://www.gnu.org/licenses/>.-- 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-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
− Network/Protocol/SASL/GNU.hs
@@ -1,971 +0,0 @@--- Copyright (C) 2010 John Millikin <jmillikin@gmail.com>--- --- 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--- 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 <http://www.gnu.org/licenses/>.--{-# LANGUAGE ForeignFunctionInterface #-}-{-# LANGUAGE OverloadedStrings #-}-{-# LANGUAGE DeriveDataTypeable #-}-module Network.Protocol.SASL.GNU- (- -- * Library Information- headerVersion- , libraryVersion- , checkVersion- - -- * SASL Contexts- , SASL- , runSASL- , setCallback- , runCallback- - -- * Mechanisms- , Mechanism (..)- , clientMechanisms- , clientSupports- , clientSuggestMechanism- , serverMechanisms- , serverSupports- - -- * SASL Sessions- , Session- , runClient- , runServer- , mechanismName- - -- ** Session Properties- , Property (..)- , setProperty- , getProperty- , getPropertyFast- - -- ** Session IO- , Progress (..)- , step- , step64- , encode- , decode- - -- ** Error handling- , Error (..)- , catch- , handle- , try- , throw- - -- * Bundled codecs- , toBase64- , fromBase64- , md5- , sha1- , hmacMD5- , hmacSHA1- , nonce- , random- ) where---- Imports {{{--import Prelude hiding (catch)-import qualified Control.Exception as E-import qualified Data.ByteString as B-import qualified Data.ByteString.Unsafe as B-import Data.ByteString.Char8 ()-import Data.Char (isDigit)-import Data.Typeable (Typeable)-import Data.String (IsString, fromString)-import qualified Foreign as F-import qualified Foreign.C as F-import System.IO.Unsafe (unsafePerformIO)-import Control.Monad (when, unless)-import Control.Monad.IO.Class (MonadIO, liftIO)-import qualified Control.Monad.Trans.Reader as R-import qualified Text.ParserCombinators.ReadP as P---- }}}---- Library Information {{{---- | Which version of @gsasl.h@ this module was compiled against-headerVersion :: (Integer, Integer, Integer)-headerVersion = (major, minor, patch) where- major = toInteger hsgsasl_VERSION_MAJOR- minor = toInteger hsgsasl_VERSION_MINOR- patch = toInteger hsgsasl_VERSION_PATCH---- | Which version of @libgsasl.so@ is loaded-libraryVersion :: IO (Integer, Integer, Integer)-libraryVersion = io where- parseVersion str = case P.readP_to_S parser str of- [] -> Nothing- ((parsed, _):_) -> Just parsed- parser = do- majorS <- P.munch1 isDigit- P.char '.'- minorS <- P.munch1 isDigit- P.char '.'- patchS <- P.munch1 isDigit- P.eof- return (read majorS, read minorS, read patchS)- io = do- cstr <- gsasl_check_version F.nullPtr- maybeStr <- F.maybePeek F.peekCString cstr- return $ case maybeStr >>= parseVersion of- Just version -> version- Nothing -> error $ "Invalid version string: " ++ show maybeStr---- | Whether the header and library versions are compatible-checkVersion :: IO Bool-checkVersion = fmap (== 1) hsgsasl_check_version---- }}}---- SASL Contexts {{{--newtype Context = Context (F.Ptr Context)-newtype SASL a = SASL { unSASL :: R.ReaderT Context IO a }--instance Functor SASL where- fmap f = SASL . fmap f . unSASL--instance Monad SASL where- return = SASL . return- (>>=) sasl f = SASL $ unSASL sasl >>= unSASL . f--instance MonadIO SASL where- liftIO = SASL . liftIO---- TODO: more instances--runSASL :: SASL a -> IO a-runSASL = withContext . R.runReaderT . unSASL--withContext :: (Context -> IO a) -> IO a-withContext = E.bracket newContext freeContext where- newContext = F.alloca $ \pCtxt -> do- gsasl_init pCtxt >>= checkRC- Context `fmap` F.peek pCtxt- freeContext (Context ctx) = do- hook <- gsasl_callback_hook_get ctx- gsasl_done ctx- freeCallbackHook hook--getContext :: SASL (F.Ptr Context)-getContext = SASL $ do- Context ptr <- R.ask- return ptr--bracketSASL :: (F.Ptr Context -> IO a) -> (a -> IO b) -> (a -> IO c) -> SASL c-bracketSASL before after thing = do- ctx <- getContext- liftIO $ E.bracket (before ctx) after thing---- }}}---- Mechanisms {{{--newtype Mechanism = Mechanism B.ByteString- deriving (Show, Eq)--instance IsString Mechanism where- fromString = Mechanism . fromString---- | A list of 'Mechanism's supported by the @libgsasl@ client.-clientMechanisms :: SASL [Mechanism]-clientMechanisms = bracketSASL io gsasl_free splitMechListPtr where- io ctx = F.alloca $ \pStr -> do- gsasl_client_mechlist ctx pStr >>= checkRC- F.peek pStr---- | Whether there is client-side support for a specified 'Mechanism'.-clientSupports :: Mechanism -> SASL Bool-clientSupports (Mechanism name) = do- ctx <- getContext- liftIO $ B.useAsCString name $ \pName -> do- cres <- gsasl_client_support_p ctx pName- return $ cres == 1---- | Given a list of 'Mechanism's, suggest which to use (or 'Nothing' if--- no supported 'Mechanism' is found).-clientSuggestMechanism :: [Mechanism] -> SASL (Maybe Mechanism)-clientSuggestMechanism mechs = do- let bytes = B.intercalate " " [x | Mechanism x <- mechs]- ctx <- getContext- liftIO $ B.useAsCString bytes $ \pMechlist ->- gsasl_client_suggest_mechanism ctx pMechlist >>=- F.maybePeek (fmap Mechanism . B.packCString)---- | A list of 'Mechanism's supported by the @libgsasl@ server.-serverMechanisms :: SASL [Mechanism]-serverMechanisms = bracketSASL io gsasl_free splitMechListPtr where- io ctx = F.alloca $ \pStr -> do- gsasl_server_mechlist ctx pStr >>= checkRC- F.peek pStr---- | Whether there is server-side support for a specified 'Mechanism'.-serverSupports :: Mechanism -> SASL Bool-serverSupports (Mechanism name) = do- ctx <- getContext- liftIO $ B.useAsCString name $ \pName -> do- cres <- gsasl_server_support_p ctx pName- return $ cres == 1--splitMechListPtr :: F.CString -> IO [Mechanism]-splitMechListPtr ptr = unfoldrM step' (ptr, ptr, 0, True) where- step' (_, _, _, False) = return Nothing- step' (p_0, p_i, i, _) = F.peek p_i >>= \chr -> let- p_i' = F.plusPtr p_i 1- peek continue = if i == 0- then step' (p_i', p_i', 0, continue)- else do- bytes <- B.packCStringLen (p_0, i)- return $ Just (Mechanism bytes, (p_i', p_i', 0, continue))- in case chr of- 0x00 -> peek False- 0x20 -> peek True- _ -> step' (p_0, p_i', i + 1, True)---- }}}---- SASL Sessions {{{--newtype SessionCtx = SessionCtx (F.Ptr SessionCtx)-newtype Session a = Session { unSession :: R.ReaderT SessionCtx IO a }--instance Functor Session where- fmap f = Session . fmap f . unSession--instance Monad Session where- return = Session . return- (>>=) m f = Session $ unSession m >>= unSession . f--instance MonadIO Session where- liftIO = Session . liftIO--type SessionProc = F.Ptr Context -> F.CString -> F.Ptr (F.Ptr SessionCtx) -> IO F.CInt--runSession :: SessionProc -> Mechanism -> Session a -> SASL (Either Error a)-runSession start (Mechanism mech) session = bracketSASL newSession freeSession io where- newSession ctx =- B.useAsCString mech $ \pMech ->- F.alloca $ \pSessionCtx -> E.handle noSession $ do- start ctx pMech pSessionCtx >>= checkRC- fmap (Right . SessionCtx) $ F.peek pSessionCtx- noSession (SASLException err) = return $ Left err- - freeSession (Left _) = return ()- freeSession (Right (SessionCtx ptr)) = gsasl_finish ptr- - io (Left err) = return $ Left err- io (Right sctx) = E.catch- (fmap Right $ R.runReaderT (unSession session) sctx)- (\(SASLException err) -> return $ Left err)---- | Run a session using the @libgsasl@ client.-runClient :: Mechanism -> Session a -> SASL (Either Error a)-runClient = runSession gsasl_client_start---- | Run a session using the @libgsasl@ server.-runServer :: Mechanism -> Session a -> SASL (Either Error a)-runServer = runSession gsasl_server_start--getSessionContext :: Session (F.Ptr SessionCtx)-getSessionContext = Session $ do- SessionCtx sctx <- R.ask- return sctx---- | The name of the session's SASL mechanism.-mechanismName :: Session Mechanism-mechanismName = do- sctx <- getSessionContext- liftIO $ do- cstr <- gsasl_mechanism_name sctx- Mechanism `fmap` B.packCString cstr--bracketSession :: (F.Ptr SessionCtx -> IO a) -> (a -> IO b) -> (a -> IO c) -> Session c-bracketSession before after thing = do- sctx <- getSessionContext- liftIO $ E.bracket (before sctx) after thing---- }}}---- Error handling {{{--data Error- = UnknownMechanism- | MechanismCalledTooManyTimes- | MallocError- | Base64Error- | CryptoError- | SASLPrepError- | MechanismParseError- | AuthenticationError- | IntegrityError- | NoClientCode- | NoServerCode- | NoCallback- | NoAnonymousToken- | NoAuthID- | NoAuthzID- | NoPassword- | NoPasscode- | NoPIN- | NoService- | NoHostname- - | GSSAPI_ReleaseBufferError- | GSSAPI_ImportNameError- | GSSAPI_InitSecContextError- | GSSAPI_AcceptSecContextError- | GSSAPI_UnwrapError- | GSSAPI_WrapError- | GSSAPI_AquireCredError- | GSSAPI_DisplayNameError- | GSSAPI_UnsupportedProtectionError- | GSSAPI_EncapsulateTokenError- | GSSAPI_DecapsulateTokenError- | GSSAPI_InquireMechForSASLNameError- | GSSAPI_TestOIDSetMemberError- | GSSAPI_ReleaseOIDSetError- - | KerberosV5_InitError- | KerberosV5_InternalError- - | SecurID_ServerNeedAdditionalPasscode- | SecurID_ServerNeedNewPIN--instance Show Error where- show = strError---- | Convert an error code to a human-readable string explanation for the--- particular error code.------ This string can be used to output a diagnostic message to the user.-strError :: Error -> String-strError err = unsafePerformIO $ gsasl_strerror (cFromError err) >>= F.peekCString--data SASLException = SASLException Error- deriving (Show, Typeable)--instance E.Exception SASLException--cFromError :: Error -> F.CInt-cFromError e = case e of- UnknownMechanism -> 2- MechanismCalledTooManyTimes -> 3- MallocError -> 7- Base64Error -> 8- CryptoError -> 9- SASLPrepError -> 29- MechanismParseError -> 30- AuthenticationError -> 31- IntegrityError -> 33- NoClientCode -> 35- NoServerCode -> 36- NoCallback -> 51- NoAnonymousToken -> 52- NoAuthID -> 53- NoAuthzID -> 54- NoPassword -> 55- NoPasscode -> 56- NoPIN -> 57- NoService -> 58- NoHostname -> 59- GSSAPI_ReleaseBufferError -> 37- GSSAPI_ImportNameError -> 38- GSSAPI_InitSecContextError -> 39- GSSAPI_AcceptSecContextError -> 40- GSSAPI_UnwrapError -> 41- GSSAPI_WrapError -> 42- GSSAPI_AquireCredError -> 43- GSSAPI_DisplayNameError -> 44- GSSAPI_UnsupportedProtectionError -> 45- GSSAPI_EncapsulateTokenError -> 60- GSSAPI_DecapsulateTokenError -> 61- GSSAPI_InquireMechForSASLNameError -> 62- GSSAPI_TestOIDSetMemberError -> 63- GSSAPI_ReleaseOIDSetError -> 64- KerberosV5_InitError -> 46- KerberosV5_InternalError -> 47- SecurID_ServerNeedAdditionalPasscode -> 48- SecurID_ServerNeedNewPIN -> 49--cToError :: F.CInt -> Error-cToError x = case x of- 2 -> UnknownMechanism- 3 -> MechanismCalledTooManyTimes- 7 -> MallocError- 8 -> Base64Error- 9 -> CryptoError- 29 -> SASLPrepError- 30 -> MechanismParseError- 31 -> AuthenticationError- 33 -> IntegrityError- 35 -> NoClientCode- 36 -> NoServerCode- 51 -> NoCallback- 52 -> NoAnonymousToken - 53 -> NoAuthID- 54 -> NoAuthzID- 55 -> NoPassword- 56 -> NoPasscode- 57 -> NoPIN- 58 -> NoService- 59 -> NoHostname- 37 -> GSSAPI_ReleaseBufferError- 38 -> GSSAPI_ImportNameError- 39 -> GSSAPI_InitSecContextError- 40 -> GSSAPI_AcceptSecContextError- 41 -> GSSAPI_UnwrapError- 42 -> GSSAPI_WrapError- 43 -> GSSAPI_AquireCredError- 44 -> GSSAPI_DisplayNameError- 45 -> GSSAPI_UnsupportedProtectionError- 60 -> GSSAPI_EncapsulateTokenError- 61 -> GSSAPI_DecapsulateTokenError- 62 -> GSSAPI_InquireMechForSASLNameError- 63 -> GSSAPI_TestOIDSetMemberError- 64 -> GSSAPI_ReleaseOIDSetError- 46 -> KerberosV5_InitError- 47 -> KerberosV5_InternalError- 48 -> SecurID_ServerNeedAdditionalPasscode- 49 -> SecurID_ServerNeedNewPIN- _ -> error $ "Unknown GNU SASL return code: " ++ show x--throw :: Error -> Session a-throw = liftIO . E.throwIO . SASLException--catch :: Session a -> (Error -> Session a) -> Session a-catch m f = do- sctx <- SessionCtx `fmap` getSessionContext- Session . liftIO $ E.catch- (R.runReaderT (unSession m) sctx)- (\(SASLException err) -> R.runReaderT (unSession (f err)) sctx)--handle :: (Error -> Session a) -> Session a -> Session a-handle = flip catch--try :: Session a -> Session (Either Error a)-try m = catch (fmap Right m) (return . Left)---- }}}---- Session Properties {{{--data Property- = PropertyAuthID- | PropertyAuthzID- | PropertyPassword- | PropertyAnonymousToken- | PropertyService- | PropertyHostname- | PropertyGSSAPIDisplayName- | PropertyPasscode- | PropertySuggestedPIN- | PropertyPIN- | PropertyRealm- | PropertyDigestMD5HashedPassword- | PropertyQOPS- | PropertyQOP- | PropertyScramIter- | PropertyScramSalt- | PropertyScramSaltedPassword- - | ValidateSimple- | ValidateExternal- | ValidateAnonymous- | ValidateGSSAPI- | ValidateSecurID- deriving (Show, Eq)--cFromProperty :: Property -> F.CInt-cFromProperty x = case x of- PropertyAuthID -> 1- PropertyAuthzID -> 2- PropertyPassword -> 3- PropertyAnonymousToken -> 4- PropertyService -> 5- PropertyHostname -> 6- PropertyGSSAPIDisplayName -> 7- PropertyPasscode -> 8- PropertySuggestedPIN -> 9- PropertyPIN -> 10- PropertyRealm -> 11- PropertyDigestMD5HashedPassword -> 12- PropertyQOPS -> 13- PropertyQOP -> 14- PropertyScramIter -> 15- PropertyScramSalt -> 16- PropertyScramSaltedPassword -> 17- ValidateSimple -> 500- ValidateExternal -> 501- ValidateAnonymous -> 502- ValidateGSSAPI -> 503- ValidateSecurID -> 504--cToProperty :: F.CInt -> Property-cToProperty x = case x of- 1 -> PropertyAuthID- 2 -> PropertyAuthzID- 3 -> PropertyPassword- 4 -> PropertyAnonymousToken- 5 -> PropertyService- 6 -> PropertyHostname- 7 -> PropertyGSSAPIDisplayName- 8 -> PropertyPasscode- 9 -> PropertySuggestedPIN- 10 -> PropertyPIN- 11 -> PropertyRealm- 12 -> PropertyDigestMD5HashedPassword- 13 -> PropertyQOPS- 14 -> PropertyQOP- 15 -> PropertyScramIter- 16 -> PropertyScramSalt- 17 -> PropertyScramSaltedPassword- 500 -> ValidateSimple- 501 -> ValidateExternal- 502 -> ValidateAnonymous- 503 -> ValidateGSSAPI- 504 -> ValidateSecurID- _ -> error $ "Unknown GNU SASL property code: " ++ show x---- | Store some data in the session for the given property. The data must--- be @NULL@-terminated.-setProperty :: Property -> B.ByteString -> Session ()-setProperty prop bytes = do- sctx <- getSessionContext- liftIO $- B.useAsCString bytes $- gsasl_property_set sctx (cFromProperty prop)---- | Retrieve the data stored in the session for the given property,--- possibly invoking the current callback to get the value.-getProperty :: Property -> Session (Maybe B.ByteString)-getProperty prop = do- sctx <- getSessionContext- liftIO $ do- cstr <- gsasl_property_get sctx (cFromProperty prop)- if cstr /= F.nullPtr- then fmap Just $ B.packCString cstr- else do- liftIO $ checkCallbackException sctx- return Nothing---- | Retrieve the data stored in the session for the given property,--- without invoking the current callback.-getPropertyFast :: Property -> Session (Maybe B.ByteString)-getPropertyFast prop = do- sctx <- getSessionContext- liftIO $- gsasl_property_fast sctx (cFromProperty prop) >>=- F.maybePeek B.packCString---- }}}---- Callbacks {{{--type CallbackFn = F.Ptr Context -> F.Ptr SessionCtx -> F.CInt -> IO F.CInt-data CallbackHook = CallbackHook (F.FunPtr CallbackFn) (Property -> Session Progress)--newCallbackHook :: (Property -> Session Progress) -> IO (F.Ptr CallbackHook, F.FunPtr CallbackFn)-newCallbackHook cb = E.bracketOnError- (wrapCallbackImpl (callbackImpl cb))- F.freeHaskellFunPtr- (\funPtr -> let hook = CallbackHook funPtr cb in E.bracketOnError- (F.newStablePtr hook)- F.freeStablePtr- (\stablePtr -> let- hookPtr = F.castPtr (F.castStablePtrToPtr stablePtr)- in return (hookPtr, funPtr)))--freeCallbackHook :: F.Ptr CallbackHook -> IO ()-freeCallbackHook ptr = unless (ptr == F.nullPtr) $ do- let stablePtr = F.castPtrToStablePtr $ F.castPtr ptr- hook <- F.deRefStablePtr stablePtr- F.freeStablePtr stablePtr- let (CallbackHook funPtr _) = hook- F.freeHaskellFunPtr funPtr--callbackImpl :: (Property -> Session Progress) -> CallbackFn-callbackImpl cb _ sctx cProp = let- globalIO = error "globalIO is not implemented"- - sessionIO = do- let session = cb $ cToProperty cProp- fmap cFromProgress $ R.runReaderT (unSession session) (SessionCtx sctx)- - onError :: SASLException -> IO F.CInt- onError (SASLException err) = return $ cFromError err- - onException :: E.SomeException -> IO F.CInt- onException exc = do- -- A bit ugly; session hooks aren't used anywhere else in- -- the binding, so the exception is stashed here.- stablePtr <- F.newStablePtr exc- gsasl_session_hook_set sctx $ F.castStablePtrToPtr stablePtr- - -- standard libgsasl return codes are all >= 0, so using -1- -- provides an easy way to determine later whether the- -- exception came from Haskell code.- return (-1)- - catchErrors io = E.catches io [E.Handler onError, E.Handler onException]- - in catchErrors $ if sctx == F.nullPtr then globalIO else sessionIO--foreign import ccall "wrapper"- wrapCallbackImpl :: CallbackFn -> IO (F.FunPtr CallbackFn)---- Used to check whether a callback threw an exception-checkCallbackException :: F.Ptr SessionCtx -> IO ()-checkCallbackException sctx = do- hook <- gsasl_session_hook_get sctx- when (hook /= F.nullPtr) $ do- let stable = F.castPtrToStablePtr hook- exc <- F.deRefStablePtr stable- F.freeStablePtr stable- E.throwIO (exc :: E.SomeException)---- | Set the current SASL callback. The callback will be used by mechanisms--- to discover various parameters, such as usernames and passwords.-setCallback :: (Property -> Session Progress) -> SASL ()-setCallback cb = do- ctx <- getContext- liftIO $ do- freeCallbackHook =<< gsasl_callback_hook_get ctx- (hook, cbPtr) <- newCallbackHook cb- gsasl_callback_hook_set ctx hook- gsasl_callback_set ctx cbPtr---- | Run the current callback; the property indicates what action the--- callback is expected to perform.-runCallback :: Property -> Session Progress-runCallback prop = do- -- This is a bit evil; the first field in Gsasl_session is a Gsasl context,- -- so it's safe to cast here (assuming they never change the layout).- ctx <- fmap F.castPtr getSessionContext- hookPtr <- liftIO $ gsasl_callback_hook_get ctx- when (hookPtr == F.nullPtr) $ throw NoCallback- hook <- liftIO $ F.deRefStablePtr $ F.castPtrToStablePtr hookPtr- let (CallbackHook _ cb) = hook- cb prop---- }}}---- Session IO {{{--data Progress = Complete | NeedsMore- deriving (Show, Eq)--cFromProgress :: Progress -> F.CInt-cFromProgress x = case x of- Complete -> 0- NeedsMore -> 1---- | Perform one step of SASL authentication. This reads data from the other--- end, processes it (potentially running the callback), and returns data--- to be sent back.------ Also returns 'NeedsMore' if authentication is not yet complete.-step :: B.ByteString -> Session (B.ByteString, Progress)-step input = bracketSession get free peek where- get sctx =- B.unsafeUseAsCStringLen input $ \(pInput, inputLen) ->- F.alloca $ \pOutput ->- F.alloca $ \pOutputLen -> do- rc <- gsasl_step sctx pInput (fromIntegral inputLen) pOutput pOutputLen- when (rc /= 0) $ checkCallbackException sctx- progress <- checkStepRC rc- cstr <- F.peek pOutput- cstrLen <- F.peek pOutputLen- return (cstr, cstrLen, progress)- - free (cstr, _, _) = gsasl_free cstr- peek (cstr, cstrLen, progress) = do- output <- B.packCStringLen (cstr, fromIntegral cstrLen)- return (output, progress)---- | A simple wrapper around 'step' which uses base64 to decode the input--- and encode the output.-step64 :: B.ByteString -> Session (B.ByteString, Progress)-step64 input = bracketSession get free peek where- get sctx =- B.useAsCString input $ \pInput ->- F.alloca $ \pOutput -> do- rc <- gsasl_step64 sctx pInput pOutput- when (rc /= 0) $ checkCallbackException sctx- progress <- checkStepRC rc- cstr <- F.peek pOutput- return (cstr, progress)- - free (cstr, _) = gsasl_free cstr- peek (cstr, progress) = do- output <- B.packCString cstr- return (output, progress)--checkStepRC :: F.CInt -> IO Progress-checkStepRC x = case x of- 0 -> return Complete- 1 -> return NeedsMore- _ -> E.throwIO (SASLException (cToError x))---- | Encode data according to the negotiated SASL mechanism. This might mean--- the data is integrity or privacy protected.-encode :: B.ByteString -> Session B.ByteString-encode input = do- sctx <- getSessionContext- liftIO $- B.unsafeUseAsCStringLen input $ \(cstr, cstrLen) ->- F.alloca $ \pOutput ->- F.alloca $ \pOutputLen -> do- rc <- gsasl_encode sctx cstr (fromIntegral cstrLen) pOutput pOutputLen- when (rc /= 0) $ checkCallbackException sctx- checkRC rc- output <- F.peek pOutput- outputLen <- fromIntegral `fmap` F.peek pOutputLen- outBytes <- B.packCStringLen (output, outputLen)- gsasl_free output- return outBytes---- | Decode data according to the negotiated SASL mechanism. This might mean--- the data is integrity or privacy protected.-decode :: B.ByteString -> Session B.ByteString-decode input = do- sctx <- getSessionContext- liftIO $- B.unsafeUseAsCStringLen input $ \(cstr, cstrLen) ->- F.alloca $ \pOutput ->- F.alloca $ \pOutputLen -> do- rc <- gsasl_decode sctx cstr (fromIntegral cstrLen) pOutput pOutputLen- when (rc /= 0) $ checkCallbackException sctx- checkRC rc- output <- F.peek pOutput- outputLen <- fromIntegral `fmap` F.peek pOutputLen- outputBytes <- B.packCStringLen (output, outputLen)- gsasl_free output- return outputBytes---- }}}---- Bundled codecs {{{--toBase64 :: B.ByteString -> B.ByteString-toBase64 input = unsafePerformIO $- B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->- F.alloca $ \pOut ->- F.alloca $ \pOutLen -> do- gsasl_base64_to pIn (fromIntegral inLen) pOut pOutLen >>= checkRC- outLen <- F.peek pOutLen- outPtr <- F.peek pOut- B.packCStringLen (outPtr, fromIntegral outLen)--fromBase64 :: B.ByteString -> B.ByteString-fromBase64 input = unsafePerformIO $- B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->- F.alloca $ \pOut ->- F.alloca $ \pOutLen -> do- gsasl_base64_from pIn (fromIntegral inLen) pOut pOutLen >>= checkRC- outLen <- F.peek pOutLen- outPtr <- F.peek pOut- B.packCStringLen (outPtr, fromIntegral outLen)--md5 :: B.ByteString -> B.ByteString-md5 input = unsafePerformIO $- B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->- F.alloca $ \pOut ->- F.allocaBytes 16 $ \outBuf -> do- F.poke pOut outBuf- gsasl_md5 pIn (fromIntegral inLen) pOut >>= checkRC- B.packCStringLen (outBuf, 16)--sha1 :: B.ByteString -> B.ByteString-sha1 input = unsafePerformIO $- B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->- F.alloca $ \pOut ->- F.allocaBytes 20 $ \outBuf -> do- F.poke pOut outBuf- gsasl_sha1 pIn (fromIntegral inLen) pOut >>= checkRC- B.packCStringLen (outBuf, 20)--hmacMD5 :: B.ByteString -- ^ Key- -> B.ByteString -- ^ Input data- -> B.ByteString-hmacMD5 key input = unsafePerformIO $- B.unsafeUseAsCStringLen key $ \(pKey, keyLen) ->- B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->- F.alloca $ \pOut ->- F.allocaBytes 16 $ \outBuf -> do- F.poke pOut outBuf- gsasl_hmac_md5 pKey (fromIntegral keyLen) pIn (fromIntegral inLen) pOut >>= checkRC- B.packCStringLen (outBuf, 16)--hmacSHA1 :: B.ByteString -- ^ Key- -> B.ByteString -- ^ Input data- -> B.ByteString-hmacSHA1 key input = unsafePerformIO $- B.unsafeUseAsCStringLen key $ \(pKey, keyLen) ->- B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->- F.alloca $ \pOut ->- F.allocaBytes 20 $ \outBuf -> do- F.poke pOut outBuf- gsasl_hmac_sha1 pKey (fromIntegral keyLen) pIn (fromIntegral inLen) pOut >>= checkRC- B.packCStringLen (outBuf, 20)---- | Returns unpredictable data of a given size-nonce :: Integer -> IO B.ByteString-nonce size = F.allocaBytes (fromInteger size) $ \buf -> do- gsasl_nonce buf (fromIntegral size) >>= checkRC- B.packCStringLen (buf, fromIntegral size)---- | Returns cryptographically strong random data of a given size-random :: Integer -> IO B.ByteString-random size = F.allocaBytes (fromInteger size) $ \buf -> do- gsasl_random buf (fromIntegral size) >>= checkRC- B.packCStringLen (buf, fromIntegral size)----- }}}---- Miscellaneous {{{--checkRC :: F.CInt -> IO ()-checkRC x = case x of- 0 -> return ()- _ -> E.throwIO (SASLException (cToError x))--unfoldrM :: Monad m => (b -> m (Maybe (a, b))) -> b -> m [a]-unfoldrM m b = m b >>= \x -> case x of- Just (a, new_b) -> do- as <- unfoldrM m new_b- return $ a : as- Nothing -> return []---- }}}---- FFI imports {{{--foreign import ccall "hsgsasl_VERSION_MAJOR"- hsgsasl_VERSION_MAJOR :: F.CInt--foreign import ccall "hsgsasl_VERSION_MINOR"- hsgsasl_VERSION_MINOR :: F.CInt--foreign import ccall "hsgsasl_VERSION_PATCH"- hsgsasl_VERSION_PATCH :: F.CInt--foreign import ccall "hsgsasl_check_version"- hsgsasl_check_version :: IO F.CInt--foreign import ccall "gsasl.h gsasl_init"- gsasl_init :: F.Ptr (F.Ptr Context) -> IO F.CInt--foreign import ccall "gsasl.h gsasl_done"- gsasl_done :: F.Ptr Context -> IO ()--foreign import ccall "gsasl.h gsasl_check_version"- gsasl_check_version :: F.CString -> IO F.CString--foreign import ccall "gsasl.h gsasl_callback_set"- gsasl_callback_set :: F.Ptr Context -> F.FunPtr CallbackFn -> IO ()--foreign import ccall "gsasl.h gsasl_callback_hook_get"- gsasl_callback_hook_get :: F.Ptr Context -> IO (F.Ptr a)--foreign import ccall "gsasl.h gsasl_callback_hook_set"- gsasl_callback_hook_set :: F.Ptr Context -> F.Ptr a -> IO ()--foreign import ccall "gsasl.h gsasl_session_hook_get"- gsasl_session_hook_get :: F.Ptr SessionCtx -> IO (F.Ptr a)--foreign import ccall "gsasl.h gsasl_session_hook_set"- gsasl_session_hook_set :: F.Ptr SessionCtx -> F.Ptr a -> IO ()--foreign import ccall "gsasl.h gsasl_property_set"- gsasl_property_set :: F.Ptr SessionCtx -> F.CInt -> F.CString -> IO ()--foreign import ccall safe "gsasl.h gsasl_property_get"- gsasl_property_get :: F.Ptr SessionCtx -> F.CInt -> IO F.CString--foreign import ccall "gsasl.h gsasl_property_fast"- gsasl_property_fast :: F.Ptr SessionCtx -> F.CInt -> IO F.CString--foreign import ccall "gsasl.h gsasl_client_mechlist"- gsasl_client_mechlist :: F.Ptr Context -> F.Ptr F.CString -> IO F.CInt--foreign import ccall "gsasl.h gsasl_client_support_p"- gsasl_client_support_p :: F.Ptr Context -> F.CString -> IO F.CInt--foreign import ccall "gsasl.h gsasl_client_suggest_mechanism"- gsasl_client_suggest_mechanism :: F.Ptr Context -> F.CString -> IO F.CString--foreign import ccall "gsasl.h gsasl_server_mechlist"- gsasl_server_mechlist :: F.Ptr Context -> F.Ptr F.CString -> IO F.CInt--foreign import ccall "gsasl.h gsasl_server_support_p"- gsasl_server_support_p :: F.Ptr Context -> F.CString -> IO F.CInt--foreign import ccall safe "gsasl.h gsasl_client_start"- gsasl_client_start :: SessionProc--foreign import ccall safe "gsasl.h gsasl_server_start"- gsasl_server_start :: SessionProc--foreign import ccall safe "gsasl.h gsasl_step"- gsasl_step :: F.Ptr SessionCtx -> F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt--foreign import ccall safe "gsasl.h gsasl_step64"- gsasl_step64 :: F.Ptr SessionCtx -> F.CString -> F.Ptr F.CString -> IO F.CInt--foreign import ccall safe "gsasl.h gsasl_finish"- gsasl_finish :: F.Ptr SessionCtx -> IO ()--foreign import ccall safe "gsasl.h gsasl_encode"- gsasl_encode :: F.Ptr SessionCtx -> F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt--foreign import ccall safe "gsasl.h gsasl_decode"- gsasl_decode :: F.Ptr SessionCtx -> F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt--foreign import ccall "gsasl.h gsasl_mechanism_name"- gsasl_mechanism_name :: F.Ptr SessionCtx -> IO F.CString--foreign import ccall "gsasl.h gsasl_strerror"- gsasl_strerror :: F.CInt -> IO F.CString--foreign import ccall "gsasl.h gsasl_base64_to"- gsasl_base64_to :: F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt--foreign import ccall "gsasl.h gsasl_base64_from"- gsasl_base64_from :: F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt--foreign import ccall "gsasl.h gsasl_md5"- gsasl_md5 :: F.CString -> F.CSize -> F.Ptr F.CString -> IO F.CInt--foreign import ccall "gsasl.h gsasl_sha1"- gsasl_sha1 :: F.CString -> F.CSize -> F.Ptr F.CString -> IO F.CInt--foreign import ccall "gsasl.h gsasl_hmac_md5"- gsasl_hmac_md5 :: F.CString -> F.CSize -> F.CString -> F.CSize -> F.Ptr F.CString -> IO F.CInt--foreign import ccall "gsasl.h gsasl_hmac_sha1"- gsasl_hmac_sha1 :: F.CString -> F.CSize -> F.CString -> F.CSize -> F.Ptr F.CString -> IO F.CInt--foreign import ccall "gsasl.h gsasl_nonce"- gsasl_nonce :: F.CString -> F.CSize -> IO F.CInt--foreign import ccall "gsasl.h gsasl_random"- gsasl_random :: F.CString -> F.CSize -> IO F.CInt--foreign import ccall "gsasl.h gsasl_free"- gsasl_free :: F.Ptr a -> IO ()---- }}}
+ cbits/hsgsasl-shim.c view
@@ -0,0 +1,13 @@+#include <gsasl.h>++int hsgsasl_VERSION_MAJOR()+{ return GSASL_VERSION_MAJOR; }++int hsgsasl_VERSION_MINOR()+{ return GSASL_VERSION_MINOR; }++int hsgsasl_VERSION_PATCH()+{ return GSASL_VERSION_PATCH; }++int hsgsasl_check_version ()+{ return gsasl_check_version (GSASL_VERSION) != NULL; }
gsasl.cabal view
@@ -1,30 +1,38 @@ name: gsasl-version: 0.3.2-synopsis: Bindings for GNU SASL+version: 0.3.3 license: GPL-3-license-file: License.txt-author: John Millikin-maintainer: jmillikin@gmail.com+license-file: license.txt+author: John Millikin <jmillikin@gmail.com>+maintainer: John Millikin <jmillikin@gmail.com> build-type: Simple-cabal-version: >=1.6+cabal-version: >= 1.6 category: Network-stability: unstable+stability: experimental+homepage: https://john-millikin.com/software/haskell-gsasl/ bug-reports: mailto:jmillikin@gmail.com-homepage: http://ianen.org/haskell/bindings/gsasl/-tested-with: GHC==6.12.1 +synopsis: Bindings for GNU SASL+description:+ source-repository head- type: darcs- location: http://ianen.org/haskell/bindings/gsasl/+ type: bazaar+ location: https://john-millikin.com/branches/haskell-gsasl/0.3/ +source-repository this+ type: bazaar+ location: https://john-millikin.com/branches/haskell-gsasl/0.3/+ tag: haskell-gsasl_0.3.3+ library+ ghc-options: -Wall -O2+ hs-source-dirs: lib+ c-sources: cbits/hsgsasl-shim.c+ build-depends:- base >=3 && < 5+ base >= 4.0 && < 5.0 , transformers >= 0.2 && < 0.3 , bytestring >= 0.9 && < 0.10 - exposed-modules: Network.Protocol.SASL.GNU-- ghc-options: -Wall -fno-warn-unused-do-bind pkgconfig-depends: libgsasl >= 1.1- c-sources: hsgsasl-shim.c++ exposed-modules: Network.Protocol.SASL.GNU
− hsgsasl-shim.c
@@ -1,13 +0,0 @@-#include <gsasl.h>--int hsgsasl_VERSION_MAJOR()-{ return GSASL_VERSION_MAJOR; }--int hsgsasl_VERSION_MINOR()-{ return GSASL_VERSION_MINOR; }--int hsgsasl_VERSION_PATCH()-{ return GSASL_VERSION_PATCH; }--int hsgsasl_check_version ()-{ return gsasl_check_version (GSASL_VERSION) != NULL; }
+ lib/Network/Protocol/SASL/GNU.hs view
@@ -0,0 +1,980 @@+-- Copyright (C) 2010 John Millikin <jmillikin@gmail.com>+-- +-- 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+-- 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 <http://www.gnu.org/licenses/>.++{-# LANGUAGE ForeignFunctionInterface #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE CPP #-}+module Network.Protocol.SASL.GNU+ (+ -- * Library Information+ headerVersion+ , libraryVersion+ , checkVersion+ + -- * SASL Contexts+ , SASL+ , runSASL+ , setCallback+ , runCallback+ + -- * Mechanisms+ , Mechanism (..)+ , clientMechanisms+ , clientSupports+ , clientSuggestMechanism+ , serverMechanisms+ , serverSupports+ + -- * SASL Sessions+ , Session+ , runClient+ , runServer+ , mechanismName+ + -- ** Session Properties+ , Property (..)+ , setProperty+ , getProperty+ , getPropertyFast+ + -- ** Session IO+ , Progress (..)+ , step+ , step64+ , encode+ , decode+ + -- ** Error handling+ , Error (..)+ , catch+ , handle+ , try+ , throw+ + -- * Bundled codecs+ , toBase64+ , fromBase64+ , md5+ , sha1+ , hmacMD5+ , hmacSHA1+ , nonce+ , random+ ) where++-- Imports {{{++import Prelude hiding (catch)+import qualified Control.Exception as E+import qualified Data.ByteString as B+import qualified Data.ByteString.Unsafe as B+import Data.ByteString.Char8 ()+import Data.Char (isDigit)+import Data.Typeable (Typeable)+import Data.String (IsString, fromString)+import qualified Foreign as F+import qualified Foreign.C as F+import System.IO.Unsafe (unsafePerformIO)+import Control.Monad (when, unless)+import Control.Monad.IO.Class (MonadIO, liftIO)+import qualified Control.Monad.Trans.Reader as R+import qualified Text.ParserCombinators.ReadP as P++-- }}}++-- Library Information {{{++-- | Which version of @gsasl.h@ this module was compiled against+headerVersion :: (Integer, Integer, Integer)+headerVersion = (major, minor, patch) where+ major = toInteger hsgsasl_VERSION_MAJOR+ minor = toInteger hsgsasl_VERSION_MINOR+ patch = toInteger hsgsasl_VERSION_PATCH++-- | Which version of @libgsasl.so@ is loaded+libraryVersion :: IO (Integer, Integer, Integer)+libraryVersion = io where+ parseVersion str = case P.readP_to_S parser str of+ [] -> Nothing+ ((parsed, _):_) -> Just parsed+ parser = do+ majorS <- P.munch1 isDigit+ _ <- P.char '.'+ minorS <- P.munch1 isDigit+ _ <- P.char '.'+ patchS <- P.munch1 isDigit+ eof+ return (read majorS, read minorS, read patchS)+ io = do+ cstr <- gsasl_check_version F.nullPtr+ maybeStr <- F.maybePeek F.peekCString cstr+ return $ case maybeStr >>= parseVersion of+ Just version -> version+ Nothing -> error $ "Invalid version string: " ++ show maybeStr+ +#if MIN_VERSION_base(4,2,0)+ eof = P.eof+#else+ eof = do+ s <- P.look+ unless (null s) P.pfail+#endif++-- | Whether the header and library versions are compatible+checkVersion :: IO Bool+checkVersion = fmap (== 1) hsgsasl_check_version++-- }}}++-- SASL Contexts {{{++newtype Context = Context (F.Ptr Context)+newtype SASL a = SASL { unSASL :: R.ReaderT Context IO a }++instance Functor SASL where+ fmap f = SASL . fmap f . unSASL++instance Monad SASL where+ return = SASL . return+ (>>=) sasl f = SASL $ unSASL sasl >>= unSASL . f++instance MonadIO SASL where+ liftIO = SASL . liftIO++-- TODO: more instances++runSASL :: SASL a -> IO a+runSASL = withContext . R.runReaderT . unSASL++withContext :: (Context -> IO a) -> IO a+withContext = E.bracket newContext freeContext where+ newContext = F.alloca $ \pCtxt -> do+ gsasl_init pCtxt >>= checkRC+ Context `fmap` F.peek pCtxt+ freeContext (Context ctx) = do+ hook <- gsasl_callback_hook_get ctx+ gsasl_done ctx+ freeCallbackHook hook++getContext :: SASL (F.Ptr Context)+getContext = SASL $ do+ Context ptr <- R.ask+ return ptr++bracketSASL :: (F.Ptr Context -> IO a) -> (a -> IO b) -> (a -> IO c) -> SASL c+bracketSASL before after thing = do+ ctx <- getContext+ liftIO $ E.bracket (before ctx) after thing++-- }}}++-- Mechanisms {{{++newtype Mechanism = Mechanism B.ByteString+ deriving (Show, Eq)++instance IsString Mechanism where+ fromString = Mechanism . fromString++-- | A list of 'Mechanism's supported by the @libgsasl@ client.+clientMechanisms :: SASL [Mechanism]+clientMechanisms = bracketSASL io gsasl_free splitMechListPtr where+ io ctx = F.alloca $ \pStr -> do+ gsasl_client_mechlist ctx pStr >>= checkRC+ F.peek pStr++-- | Whether there is client-side support for a specified 'Mechanism'.+clientSupports :: Mechanism -> SASL Bool+clientSupports (Mechanism name) = do+ ctx <- getContext+ liftIO $ B.useAsCString name $ \pName -> do+ cres <- gsasl_client_support_p ctx pName+ return $ cres == 1++-- | Given a list of 'Mechanism's, suggest which to use (or 'Nothing' if+-- no supported 'Mechanism' is found).+clientSuggestMechanism :: [Mechanism] -> SASL (Maybe Mechanism)+clientSuggestMechanism mechs = do+ let bytes = B.intercalate " " [x | Mechanism x <- mechs]+ ctx <- getContext+ liftIO $ B.useAsCString bytes $ \pMechlist ->+ gsasl_client_suggest_mechanism ctx pMechlist >>=+ F.maybePeek (fmap Mechanism . B.packCString)++-- | A list of 'Mechanism's supported by the @libgsasl@ server.+serverMechanisms :: SASL [Mechanism]+serverMechanisms = bracketSASL io gsasl_free splitMechListPtr where+ io ctx = F.alloca $ \pStr -> do+ gsasl_server_mechlist ctx pStr >>= checkRC+ F.peek pStr++-- | Whether there is server-side support for a specified 'Mechanism'.+serverSupports :: Mechanism -> SASL Bool+serverSupports (Mechanism name) = do+ ctx <- getContext+ liftIO $ B.useAsCString name $ \pName -> do+ cres <- gsasl_server_support_p ctx pName+ return $ cres == 1++splitMechListPtr :: F.CString -> IO [Mechanism]+splitMechListPtr ptr = unfoldrM step' (ptr, ptr, 0, True) where+ step' (_, _, _, False) = return Nothing+ step' (p_0, p_i, i, _) = F.peek p_i >>= \chr -> let+ p_i' = F.plusPtr p_i 1+ peek continue = if i == 0+ then step' (p_i', p_i', 0, continue)+ else do+ bytes <- B.packCStringLen (p_0, i)+ return $ Just (Mechanism bytes, (p_i', p_i', 0, continue))+ in case chr of+ 0x00 -> peek False+ 0x20 -> peek True+ _ -> step' (p_0, p_i', i + 1, True)++-- }}}++-- SASL Sessions {{{++newtype SessionCtx = SessionCtx (F.Ptr SessionCtx)+newtype Session a = Session { unSession :: R.ReaderT SessionCtx IO a }++instance Functor Session where+ fmap f = Session . fmap f . unSession++instance Monad Session where+ return = Session . return+ (>>=) m f = Session $ unSession m >>= unSession . f++instance MonadIO Session where+ liftIO = Session . liftIO++type SessionProc = F.Ptr Context -> F.CString -> F.Ptr (F.Ptr SessionCtx) -> IO F.CInt++runSession :: SessionProc -> Mechanism -> Session a -> SASL (Either Error a)+runSession start (Mechanism mech) session = bracketSASL newSession freeSession io where+ newSession ctx =+ B.useAsCString mech $ \pMech ->+ F.alloca $ \pSessionCtx -> E.handle noSession $ do+ start ctx pMech pSessionCtx >>= checkRC+ fmap (Right . SessionCtx) $ F.peek pSessionCtx+ noSession (SASLException err) = return $ Left err+ + freeSession (Left _) = return ()+ freeSession (Right (SessionCtx ptr)) = gsasl_finish ptr+ + io (Left err) = return $ Left err+ io (Right sctx) = E.catch+ (fmap Right $ R.runReaderT (unSession session) sctx)+ (\(SASLException err) -> return $ Left err)++-- | Run a session using the @libgsasl@ client.+runClient :: Mechanism -> Session a -> SASL (Either Error a)+runClient = runSession gsasl_client_start++-- | Run a session using the @libgsasl@ server.+runServer :: Mechanism -> Session a -> SASL (Either Error a)+runServer = runSession gsasl_server_start++getSessionContext :: Session (F.Ptr SessionCtx)+getSessionContext = Session $ do+ SessionCtx sctx <- R.ask+ return sctx++-- | The name of the session's SASL mechanism.+mechanismName :: Session Mechanism+mechanismName = do+ sctx <- getSessionContext+ liftIO $ do+ cstr <- gsasl_mechanism_name sctx+ Mechanism `fmap` B.packCString cstr++bracketSession :: (F.Ptr SessionCtx -> IO a) -> (a -> IO b) -> (a -> IO c) -> Session c+bracketSession before after thing = do+ sctx <- getSessionContext+ liftIO $ E.bracket (before sctx) after thing++-- }}}++-- Error handling {{{++data Error+ = UnknownMechanism+ | MechanismCalledTooManyTimes+ | MallocError+ | Base64Error+ | CryptoError+ | SASLPrepError+ | MechanismParseError+ | AuthenticationError+ | IntegrityError+ | NoClientCode+ | NoServerCode+ | NoCallback+ | NoAnonymousToken+ | NoAuthID+ | NoAuthzID+ | NoPassword+ | NoPasscode+ | NoPIN+ | NoService+ | NoHostname+ + | GSSAPI_ReleaseBufferError+ | GSSAPI_ImportNameError+ | GSSAPI_InitSecContextError+ | GSSAPI_AcceptSecContextError+ | GSSAPI_UnwrapError+ | GSSAPI_WrapError+ | GSSAPI_AquireCredError+ | GSSAPI_DisplayNameError+ | GSSAPI_UnsupportedProtectionError+ | GSSAPI_EncapsulateTokenError+ | GSSAPI_DecapsulateTokenError+ | GSSAPI_InquireMechForSASLNameError+ | GSSAPI_TestOIDSetMemberError+ | GSSAPI_ReleaseOIDSetError+ + | KerberosV5_InitError+ | KerberosV5_InternalError+ + | SecurID_ServerNeedAdditionalPasscode+ | SecurID_ServerNeedNewPIN++instance Show Error where+ show = strError++-- | Convert an error code to a human-readable string explanation for the+-- particular error code.+--+-- This string can be used to output a diagnostic message to the user.+strError :: Error -> String+strError err = unsafePerformIO $ gsasl_strerror (cFromError err) >>= F.peekCString++data SASLException = SASLException Error+ deriving (Show, Typeable)++instance E.Exception SASLException++cFromError :: Error -> F.CInt+cFromError e = case e of+ UnknownMechanism -> 2+ MechanismCalledTooManyTimes -> 3+ MallocError -> 7+ Base64Error -> 8+ CryptoError -> 9+ SASLPrepError -> 29+ MechanismParseError -> 30+ AuthenticationError -> 31+ IntegrityError -> 33+ NoClientCode -> 35+ NoServerCode -> 36+ NoCallback -> 51+ NoAnonymousToken -> 52+ NoAuthID -> 53+ NoAuthzID -> 54+ NoPassword -> 55+ NoPasscode -> 56+ NoPIN -> 57+ NoService -> 58+ NoHostname -> 59+ GSSAPI_ReleaseBufferError -> 37+ GSSAPI_ImportNameError -> 38+ GSSAPI_InitSecContextError -> 39+ GSSAPI_AcceptSecContextError -> 40+ GSSAPI_UnwrapError -> 41+ GSSAPI_WrapError -> 42+ GSSAPI_AquireCredError -> 43+ GSSAPI_DisplayNameError -> 44+ GSSAPI_UnsupportedProtectionError -> 45+ GSSAPI_EncapsulateTokenError -> 60+ GSSAPI_DecapsulateTokenError -> 61+ GSSAPI_InquireMechForSASLNameError -> 62+ GSSAPI_TestOIDSetMemberError -> 63+ GSSAPI_ReleaseOIDSetError -> 64+ KerberosV5_InitError -> 46+ KerberosV5_InternalError -> 47+ SecurID_ServerNeedAdditionalPasscode -> 48+ SecurID_ServerNeedNewPIN -> 49++cToError :: F.CInt -> Error+cToError x = case x of+ 2 -> UnknownMechanism+ 3 -> MechanismCalledTooManyTimes+ 7 -> MallocError+ 8 -> Base64Error+ 9 -> CryptoError+ 29 -> SASLPrepError+ 30 -> MechanismParseError+ 31 -> AuthenticationError+ 33 -> IntegrityError+ 35 -> NoClientCode+ 36 -> NoServerCode+ 51 -> NoCallback+ 52 -> NoAnonymousToken + 53 -> NoAuthID+ 54 -> NoAuthzID+ 55 -> NoPassword+ 56 -> NoPasscode+ 57 -> NoPIN+ 58 -> NoService+ 59 -> NoHostname+ 37 -> GSSAPI_ReleaseBufferError+ 38 -> GSSAPI_ImportNameError+ 39 -> GSSAPI_InitSecContextError+ 40 -> GSSAPI_AcceptSecContextError+ 41 -> GSSAPI_UnwrapError+ 42 -> GSSAPI_WrapError+ 43 -> GSSAPI_AquireCredError+ 44 -> GSSAPI_DisplayNameError+ 45 -> GSSAPI_UnsupportedProtectionError+ 60 -> GSSAPI_EncapsulateTokenError+ 61 -> GSSAPI_DecapsulateTokenError+ 62 -> GSSAPI_InquireMechForSASLNameError+ 63 -> GSSAPI_TestOIDSetMemberError+ 64 -> GSSAPI_ReleaseOIDSetError+ 46 -> KerberosV5_InitError+ 47 -> KerberosV5_InternalError+ 48 -> SecurID_ServerNeedAdditionalPasscode+ 49 -> SecurID_ServerNeedNewPIN+ _ -> error $ "Unknown GNU SASL return code: " ++ show x++throw :: Error -> Session a+throw = liftIO . E.throwIO . SASLException++catch :: Session a -> (Error -> Session a) -> Session a+catch m f = do+ sctx <- SessionCtx `fmap` getSessionContext+ Session . liftIO $ E.catch+ (R.runReaderT (unSession m) sctx)+ (\(SASLException err) -> R.runReaderT (unSession (f err)) sctx)++handle :: (Error -> Session a) -> Session a -> Session a+handle = flip catch++try :: Session a -> Session (Either Error a)+try m = catch (fmap Right m) (return . Left)++-- }}}++-- Session Properties {{{++data Property+ = PropertyAuthID+ | PropertyAuthzID+ | PropertyPassword+ | PropertyAnonymousToken+ | PropertyService+ | PropertyHostname+ | PropertyGSSAPIDisplayName+ | PropertyPasscode+ | PropertySuggestedPIN+ | PropertyPIN+ | PropertyRealm+ | PropertyDigestMD5HashedPassword+ | PropertyQOPS+ | PropertyQOP+ | PropertyScramIter+ | PropertyScramSalt+ | PropertyScramSaltedPassword+ + | ValidateSimple+ | ValidateExternal+ | ValidateAnonymous+ | ValidateGSSAPI+ | ValidateSecurID+ deriving (Show, Eq)++cFromProperty :: Property -> F.CInt+cFromProperty x = case x of+ PropertyAuthID -> 1+ PropertyAuthzID -> 2+ PropertyPassword -> 3+ PropertyAnonymousToken -> 4+ PropertyService -> 5+ PropertyHostname -> 6+ PropertyGSSAPIDisplayName -> 7+ PropertyPasscode -> 8+ PropertySuggestedPIN -> 9+ PropertyPIN -> 10+ PropertyRealm -> 11+ PropertyDigestMD5HashedPassword -> 12+ PropertyQOPS -> 13+ PropertyQOP -> 14+ PropertyScramIter -> 15+ PropertyScramSalt -> 16+ PropertyScramSaltedPassword -> 17+ ValidateSimple -> 500+ ValidateExternal -> 501+ ValidateAnonymous -> 502+ ValidateGSSAPI -> 503+ ValidateSecurID -> 504++cToProperty :: F.CInt -> Property+cToProperty x = case x of+ 1 -> PropertyAuthID+ 2 -> PropertyAuthzID+ 3 -> PropertyPassword+ 4 -> PropertyAnonymousToken+ 5 -> PropertyService+ 6 -> PropertyHostname+ 7 -> PropertyGSSAPIDisplayName+ 8 -> PropertyPasscode+ 9 -> PropertySuggestedPIN+ 10 -> PropertyPIN+ 11 -> PropertyRealm+ 12 -> PropertyDigestMD5HashedPassword+ 13 -> PropertyQOPS+ 14 -> PropertyQOP+ 15 -> PropertyScramIter+ 16 -> PropertyScramSalt+ 17 -> PropertyScramSaltedPassword+ 500 -> ValidateSimple+ 501 -> ValidateExternal+ 502 -> ValidateAnonymous+ 503 -> ValidateGSSAPI+ 504 -> ValidateSecurID+ _ -> error $ "Unknown GNU SASL property code: " ++ show x++-- | Store some data in the session for the given property. The data must+-- be @NULL@-terminated.+setProperty :: Property -> B.ByteString -> Session ()+setProperty prop bytes = do+ sctx <- getSessionContext+ liftIO $+ B.useAsCString bytes $+ gsasl_property_set sctx (cFromProperty prop)++-- | Retrieve the data stored in the session for the given property,+-- possibly invoking the current callback to get the value.+getProperty :: Property -> Session (Maybe B.ByteString)+getProperty prop = do+ sctx <- getSessionContext+ liftIO $ do+ cstr <- gsasl_property_get sctx (cFromProperty prop)+ if cstr /= F.nullPtr+ then fmap Just $ B.packCString cstr+ else do+ liftIO $ checkCallbackException sctx+ return Nothing++-- | Retrieve the data stored in the session for the given property,+-- without invoking the current callback.+getPropertyFast :: Property -> Session (Maybe B.ByteString)+getPropertyFast prop = do+ sctx <- getSessionContext+ liftIO $+ gsasl_property_fast sctx (cFromProperty prop) >>=+ F.maybePeek B.packCString++-- }}}++-- Callbacks {{{++type CallbackFn = F.Ptr Context -> F.Ptr SessionCtx -> F.CInt -> IO F.CInt+data CallbackHook = CallbackHook (F.FunPtr CallbackFn) (Property -> Session Progress)++newCallbackHook :: (Property -> Session Progress) -> IO (F.Ptr CallbackHook, F.FunPtr CallbackFn)+newCallbackHook cb = E.bracketOnError+ (wrapCallbackImpl (callbackImpl cb))+ F.freeHaskellFunPtr+ (\funPtr -> let hook = CallbackHook funPtr cb in E.bracketOnError+ (F.newStablePtr hook)+ F.freeStablePtr+ (\stablePtr -> let+ hookPtr = F.castPtr (F.castStablePtrToPtr stablePtr)+ in return (hookPtr, funPtr)))++freeCallbackHook :: F.Ptr CallbackHook -> IO ()+freeCallbackHook ptr = unless (ptr == F.nullPtr) $ do+ let stablePtr = F.castPtrToStablePtr $ F.castPtr ptr+ hook <- F.deRefStablePtr stablePtr+ F.freeStablePtr stablePtr+ let (CallbackHook funPtr _) = hook+ F.freeHaskellFunPtr funPtr++callbackImpl :: (Property -> Session Progress) -> CallbackFn+callbackImpl cb _ sctx cProp = let+ globalIO = error "globalIO is not implemented"+ + sessionIO = do+ let session = cb $ cToProperty cProp+ fmap cFromProgress $ R.runReaderT (unSession session) (SessionCtx sctx)+ + onError :: SASLException -> IO F.CInt+ onError (SASLException err) = return $ cFromError err+ + onException :: E.SomeException -> IO F.CInt+ onException exc = do+ -- A bit ugly; session hooks aren't used anywhere else in+ -- the binding, so the exception is stashed here.+ stablePtr <- F.newStablePtr exc+ gsasl_session_hook_set sctx $ F.castStablePtrToPtr stablePtr+ + -- standard libgsasl return codes are all >= 0, so using -1+ -- provides an easy way to determine later whether the+ -- exception came from Haskell code.+ return (-1)+ + catchErrors io = E.catches io [E.Handler onError, E.Handler onException]+ + in catchErrors $ if sctx == F.nullPtr then globalIO else sessionIO++foreign import ccall "wrapper"+ wrapCallbackImpl :: CallbackFn -> IO (F.FunPtr CallbackFn)++-- Used to check whether a callback threw an exception+checkCallbackException :: F.Ptr SessionCtx -> IO ()+checkCallbackException sctx = do+ hook <- gsasl_session_hook_get sctx+ when (hook /= F.nullPtr) $ do+ let stable = F.castPtrToStablePtr hook+ exc <- F.deRefStablePtr stable+ F.freeStablePtr stable+ E.throwIO (exc :: E.SomeException)++-- | Set the current SASL callback. The callback will be used by mechanisms+-- to discover various parameters, such as usernames and passwords.+setCallback :: (Property -> Session Progress) -> SASL ()+setCallback cb = do+ ctx <- getContext+ liftIO $ do+ freeCallbackHook =<< gsasl_callback_hook_get ctx+ (hook, cbPtr) <- newCallbackHook cb+ gsasl_callback_hook_set ctx hook+ gsasl_callback_set ctx cbPtr++-- | Run the current callback; the property indicates what action the+-- callback is expected to perform.+runCallback :: Property -> Session Progress+runCallback prop = do+ -- This is a bit evil; the first field in Gsasl_session is a Gsasl context,+ -- so it's safe to cast here (assuming they never change the layout).+ ctx <- fmap F.castPtr getSessionContext+ hookPtr <- liftIO $ gsasl_callback_hook_get ctx+ when (hookPtr == F.nullPtr) $ throw NoCallback+ hook <- liftIO $ F.deRefStablePtr $ F.castPtrToStablePtr hookPtr+ let (CallbackHook _ cb) = hook+ cb prop++-- }}}++-- Session IO {{{++data Progress = Complete | NeedsMore+ deriving (Show, Eq)++cFromProgress :: Progress -> F.CInt+cFromProgress x = case x of+ Complete -> 0+ NeedsMore -> 1++-- | Perform one step of SASL authentication. This reads data from the other+-- end, processes it (potentially running the callback), and returns data+-- to be sent back.+--+-- Also returns 'NeedsMore' if authentication is not yet complete.+step :: B.ByteString -> Session (B.ByteString, Progress)+step input = bracketSession get free peek where+ get sctx =+ B.unsafeUseAsCStringLen input $ \(pInput, inputLen) ->+ F.alloca $ \pOutput ->+ F.alloca $ \pOutputLen -> do+ rc <- gsasl_step sctx pInput (fromIntegral inputLen) pOutput pOutputLen+ when (rc /= 0) $ checkCallbackException sctx+ progress <- checkStepRC rc+ cstr <- F.peek pOutput+ cstrLen <- F.peek pOutputLen+ return (cstr, cstrLen, progress)+ + free (cstr, _, _) = gsasl_free cstr+ peek (cstr, cstrLen, progress) = do+ output <- B.packCStringLen (cstr, fromIntegral cstrLen)+ return (output, progress)++-- | A simple wrapper around 'step' which uses base64 to decode the input+-- and encode the output.+step64 :: B.ByteString -> Session (B.ByteString, Progress)+step64 input = bracketSession get free peek where+ get sctx =+ B.useAsCString input $ \pInput ->+ F.alloca $ \pOutput -> do+ rc <- gsasl_step64 sctx pInput pOutput+ when (rc /= 0) $ checkCallbackException sctx+ progress <- checkStepRC rc+ cstr <- F.peek pOutput+ return (cstr, progress)+ + free (cstr, _) = gsasl_free cstr+ peek (cstr, progress) = do+ output <- B.packCString cstr+ return (output, progress)++checkStepRC :: F.CInt -> IO Progress+checkStepRC x = case x of+ 0 -> return Complete+ 1 -> return NeedsMore+ _ -> E.throwIO (SASLException (cToError x))++-- | Encode data according to the negotiated SASL mechanism. This might mean+-- the data is integrity or privacy protected.+encode :: B.ByteString -> Session B.ByteString+encode input = do+ sctx <- getSessionContext+ liftIO $+ B.unsafeUseAsCStringLen input $ \(cstr, cstrLen) ->+ F.alloca $ \pOutput ->+ F.alloca $ \pOutputLen -> do+ rc <- gsasl_encode sctx cstr (fromIntegral cstrLen) pOutput pOutputLen+ when (rc /= 0) $ checkCallbackException sctx+ checkRC rc+ output <- F.peek pOutput+ outputLen <- fromIntegral `fmap` F.peek pOutputLen+ outBytes <- B.packCStringLen (output, outputLen)+ gsasl_free output+ return outBytes++-- | Decode data according to the negotiated SASL mechanism. This might mean+-- the data is integrity or privacy protected.+decode :: B.ByteString -> Session B.ByteString+decode input = do+ sctx <- getSessionContext+ liftIO $+ B.unsafeUseAsCStringLen input $ \(cstr, cstrLen) ->+ F.alloca $ \pOutput ->+ F.alloca $ \pOutputLen -> do+ rc <- gsasl_decode sctx cstr (fromIntegral cstrLen) pOutput pOutputLen+ when (rc /= 0) $ checkCallbackException sctx+ checkRC rc+ output <- F.peek pOutput+ outputLen <- fromIntegral `fmap` F.peek pOutputLen+ outputBytes <- B.packCStringLen (output, outputLen)+ gsasl_free output+ return outputBytes++-- }}}++-- Bundled codecs {{{++toBase64 :: B.ByteString -> B.ByteString+toBase64 input = unsafePerformIO $+ B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->+ F.alloca $ \pOut ->+ F.alloca $ \pOutLen -> do+ gsasl_base64_to pIn (fromIntegral inLen) pOut pOutLen >>= checkRC+ outLen <- F.peek pOutLen+ outPtr <- F.peek pOut+ B.packCStringLen (outPtr, fromIntegral outLen)++fromBase64 :: B.ByteString -> B.ByteString+fromBase64 input = unsafePerformIO $+ B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->+ F.alloca $ \pOut ->+ F.alloca $ \pOutLen -> do+ gsasl_base64_from pIn (fromIntegral inLen) pOut pOutLen >>= checkRC+ outLen <- F.peek pOutLen+ outPtr <- F.peek pOut+ B.packCStringLen (outPtr, fromIntegral outLen)++md5 :: B.ByteString -> B.ByteString+md5 input = unsafePerformIO $+ B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->+ F.alloca $ \pOut ->+ F.allocaBytes 16 $ \outBuf -> do+ F.poke pOut outBuf+ gsasl_md5 pIn (fromIntegral inLen) pOut >>= checkRC+ B.packCStringLen (outBuf, 16)++sha1 :: B.ByteString -> B.ByteString+sha1 input = unsafePerformIO $+ B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->+ F.alloca $ \pOut ->+ F.allocaBytes 20 $ \outBuf -> do+ F.poke pOut outBuf+ gsasl_sha1 pIn (fromIntegral inLen) pOut >>= checkRC+ B.packCStringLen (outBuf, 20)++hmacMD5 :: B.ByteString -- ^ Key+ -> B.ByteString -- ^ Input data+ -> B.ByteString+hmacMD5 key input = unsafePerformIO $+ B.unsafeUseAsCStringLen key $ \(pKey, keyLen) ->+ B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->+ F.alloca $ \pOut ->+ F.allocaBytes 16 $ \outBuf -> do+ F.poke pOut outBuf+ gsasl_hmac_md5 pKey (fromIntegral keyLen) pIn (fromIntegral inLen) pOut >>= checkRC+ B.packCStringLen (outBuf, 16)++hmacSHA1 :: B.ByteString -- ^ Key+ -> B.ByteString -- ^ Input data+ -> B.ByteString+hmacSHA1 key input = unsafePerformIO $+ B.unsafeUseAsCStringLen key $ \(pKey, keyLen) ->+ B.unsafeUseAsCStringLen input $ \(pIn, inLen) ->+ F.alloca $ \pOut ->+ F.allocaBytes 20 $ \outBuf -> do+ F.poke pOut outBuf+ gsasl_hmac_sha1 pKey (fromIntegral keyLen) pIn (fromIntegral inLen) pOut >>= checkRC+ B.packCStringLen (outBuf, 20)++-- | Returns unpredictable data of a given size+nonce :: Integer -> IO B.ByteString+nonce size = F.allocaBytes (fromInteger size) $ \buf -> do+ gsasl_nonce buf (fromIntegral size) >>= checkRC+ B.packCStringLen (buf, fromIntegral size)++-- | Returns cryptographically strong random data of a given size+random :: Integer -> IO B.ByteString+random size = F.allocaBytes (fromInteger size) $ \buf -> do+ gsasl_random buf (fromIntegral size) >>= checkRC+ B.packCStringLen (buf, fromIntegral size)+++-- }}}++-- Miscellaneous {{{++checkRC :: F.CInt -> IO ()+checkRC x = case x of+ 0 -> return ()+ _ -> E.throwIO (SASLException (cToError x))++unfoldrM :: Monad m => (b -> m (Maybe (a, b))) -> b -> m [a]+unfoldrM m b = m b >>= \x -> case x of+ Just (a, new_b) -> do+ as <- unfoldrM m new_b+ return $ a : as+ Nothing -> return []++-- }}}++-- FFI imports {{{++foreign import ccall "hsgsasl_VERSION_MAJOR"+ hsgsasl_VERSION_MAJOR :: F.CInt++foreign import ccall "hsgsasl_VERSION_MINOR"+ hsgsasl_VERSION_MINOR :: F.CInt++foreign import ccall "hsgsasl_VERSION_PATCH"+ hsgsasl_VERSION_PATCH :: F.CInt++foreign import ccall "hsgsasl_check_version"+ hsgsasl_check_version :: IO F.CInt++foreign import ccall "gsasl.h gsasl_init"+ gsasl_init :: F.Ptr (F.Ptr Context) -> IO F.CInt++foreign import ccall "gsasl.h gsasl_done"+ gsasl_done :: F.Ptr Context -> IO ()++foreign import ccall "gsasl.h gsasl_check_version"+ gsasl_check_version :: F.CString -> IO F.CString++foreign import ccall "gsasl.h gsasl_callback_set"+ gsasl_callback_set :: F.Ptr Context -> F.FunPtr CallbackFn -> IO ()++foreign import ccall "gsasl.h gsasl_callback_hook_get"+ gsasl_callback_hook_get :: F.Ptr Context -> IO (F.Ptr a)++foreign import ccall "gsasl.h gsasl_callback_hook_set"+ gsasl_callback_hook_set :: F.Ptr Context -> F.Ptr a -> IO ()++foreign import ccall "gsasl.h gsasl_session_hook_get"+ gsasl_session_hook_get :: F.Ptr SessionCtx -> IO (F.Ptr a)++foreign import ccall "gsasl.h gsasl_session_hook_set"+ gsasl_session_hook_set :: F.Ptr SessionCtx -> F.Ptr a -> IO ()++foreign import ccall "gsasl.h gsasl_property_set"+ gsasl_property_set :: F.Ptr SessionCtx -> F.CInt -> F.CString -> IO ()++foreign import ccall safe "gsasl.h gsasl_property_get"+ gsasl_property_get :: F.Ptr SessionCtx -> F.CInt -> IO F.CString++foreign import ccall "gsasl.h gsasl_property_fast"+ gsasl_property_fast :: F.Ptr SessionCtx -> F.CInt -> IO F.CString++foreign import ccall "gsasl.h gsasl_client_mechlist"+ gsasl_client_mechlist :: F.Ptr Context -> F.Ptr F.CString -> IO F.CInt++foreign import ccall "gsasl.h gsasl_client_support_p"+ gsasl_client_support_p :: F.Ptr Context -> F.CString -> IO F.CInt++foreign import ccall "gsasl.h gsasl_client_suggest_mechanism"+ gsasl_client_suggest_mechanism :: F.Ptr Context -> F.CString -> IO F.CString++foreign import ccall "gsasl.h gsasl_server_mechlist"+ gsasl_server_mechlist :: F.Ptr Context -> F.Ptr F.CString -> IO F.CInt++foreign import ccall "gsasl.h gsasl_server_support_p"+ gsasl_server_support_p :: F.Ptr Context -> F.CString -> IO F.CInt++foreign import ccall safe "gsasl.h gsasl_client_start"+ gsasl_client_start :: SessionProc++foreign import ccall safe "gsasl.h gsasl_server_start"+ gsasl_server_start :: SessionProc++foreign import ccall safe "gsasl.h gsasl_step"+ gsasl_step :: F.Ptr SessionCtx -> F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt++foreign import ccall safe "gsasl.h gsasl_step64"+ gsasl_step64 :: F.Ptr SessionCtx -> F.CString -> F.Ptr F.CString -> IO F.CInt++foreign import ccall safe "gsasl.h gsasl_finish"+ gsasl_finish :: F.Ptr SessionCtx -> IO ()++foreign import ccall safe "gsasl.h gsasl_encode"+ gsasl_encode :: F.Ptr SessionCtx -> F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt++foreign import ccall safe "gsasl.h gsasl_decode"+ gsasl_decode :: F.Ptr SessionCtx -> F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt++foreign import ccall "gsasl.h gsasl_mechanism_name"+ gsasl_mechanism_name :: F.Ptr SessionCtx -> IO F.CString++foreign import ccall "gsasl.h gsasl_strerror"+ gsasl_strerror :: F.CInt -> IO F.CString++foreign import ccall "gsasl.h gsasl_base64_to"+ gsasl_base64_to :: F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt++foreign import ccall "gsasl.h gsasl_base64_from"+ gsasl_base64_from :: F.CString -> F.CSize -> F.Ptr F.CString -> F.Ptr F.CSize -> IO F.CInt++foreign import ccall "gsasl.h gsasl_md5"+ gsasl_md5 :: F.CString -> F.CSize -> F.Ptr F.CString -> IO F.CInt++foreign import ccall "gsasl.h gsasl_sha1"+ gsasl_sha1 :: F.CString -> F.CSize -> F.Ptr F.CString -> IO F.CInt++foreign import ccall "gsasl.h gsasl_hmac_md5"+ gsasl_hmac_md5 :: F.CString -> F.CSize -> F.CString -> F.CSize -> F.Ptr F.CString -> IO F.CInt++foreign import ccall "gsasl.h gsasl_hmac_sha1"+ gsasl_hmac_sha1 :: F.CString -> F.CSize -> F.CString -> F.CSize -> F.Ptr F.CString -> IO F.CInt++foreign import ccall "gsasl.h gsasl_nonce"+ gsasl_nonce :: F.CString -> F.CSize -> IO F.CInt++foreign import ccall "gsasl.h gsasl_random"+ gsasl_random :: F.CString -> F.CSize -> IO F.CInt++foreign import ccall "gsasl.h gsasl_free"+ gsasl_free :: F.Ptr a -> IO ()++-- }}}
+ license.txt view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU 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.++ <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 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 <http://www.gnu.org/licenses/>.++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:++ <program> Copyright (C) <year> <name of author>+ 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+<http://www.gnu.org/licenses/>.++ 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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.