libtelnet (empty) → 0.1.0.0
raw patch · 11 files changed
+1880/−0 lines, 11 filesdep +basedep +bytestringdep +libtelnetsetup-changed
Dependencies added: base, bytestring, libtelnet, monad-loops, network-simple
Files
- COPYING +674/−0
- ChangeLog.md +3/−0
- README.md +45/−0
- Setup.hs +2/−0
- example/Main.hs +43/−0
- libtelnet.cabal +62/−0
- src/Network/Telnet/LibTelnet.hs +388/−0
- src/Network/Telnet/LibTelnet/Ffi.hsc +166/−0
- src/Network/Telnet/LibTelnet/Iac.hsc +59/−0
- src/Network/Telnet/LibTelnet/Options.hsc +107/−0
- src/Network/Telnet/LibTelnet/Types.hsc +331/−0
+ COPYING 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>.
+ ChangeLog.md view
@@ -0,0 +1,3 @@+# 0.1.0.0++* Initial release.
+ README.md view
@@ -0,0 +1,45 @@+# Bindings to libtelnet++This is a wrapper around+[libtelnet](https://github.com/seanmiddleditch/libtelnet), a C library+for handling Telnet streams, including option negotiation, &c. As a+cleartext protocol, Telnet is thorougly unsuitable for use on the open+internet, but you might have a niche where it makes sense:++* [MU*](https://en.wikipedia.org/wiki/MU*) games still use it, and so+ the clients people want to use only speak Telnet,+* You might be speaking Telnet inside a+ [stunnel](https://www.stunnel.org/), or+* You might have some ancient hardware that can't be updated, and+ doesn't have ssh, but you want to talk to it using Haskell.++This library hews closely to the interface provided by the C+libtelnet, so reading the [excellent C+documentation](https://github.com/seanmiddleditch/libtelnet#ii-api)+will help you. The short version goes something like this:++1. Define an _event handler_ of type+ `Network.Telnet.LibTelnet.EventHandler`. This function receives+ callbacks that tell you what received data should be propagated to+ the application, and what bytes need to be sent out over the+ socket.++2. Pass your event handler (and some other flags) to+ `Network.Telnet.LibTelnet.telnetInit`, which will give you access+ to a `Telnet`, a garbage-collected _state tracker_.++3. Tell the state tracker that data has arrived on the socket, or that+ you want to send data to the socket, by passing it to the library's+ other functions.++## Other Resources++* A simple server example exists in+ [`example/Main.hs`](https://git.sr.ht/~jack/libtelnet-haskell/tree/master/example/Main.hs).++* Questions should go to the+ [libtelnet-haskell-discuss](https://lists.sr.ht/~jack/libtelnet-haskell-discuss)+ mailing list.++* Bug reports should go to the+ [bug tracker](https://todo.sr.ht/~jack/libtelnet-haskell).
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ example/Main.hs view
@@ -0,0 +1,43 @@+{-++This is a minimal telnet server that echoes its input back to the+client:++* All data that arrives on the socket is logged to stdout with a+ "Socket: " prefix and then fed to the state tracker.++* When the event handler is called with a 'Telnet.Received' event, it+ prints the received data to stdout with an "R: " prefix, and sends it+ to the same state tracker.++* This triggers a 'Telnet.Send' event - "you should send this+ over the wire" - so we log it to stdout with an "S: " prefix and+ send it back over the socket.++* All other telnet features (IAC sequences, option negotiation, etc.)+ are ignored.++-}++module Main where++import Control.Monad.Loops (whileJust_)+import qualified Data.ByteString.Char8 as B8+import Network.Simple.TCP (HostPreference(..), Socket, recv, send, serve)+import qualified Network.Telnet.LibTelnet as Telnet++telnetH :: Socket -> Telnet.EventHandler+telnetH _ t (Telnet.Received b)+ = putStr "R: " *> B8.putStrLn b *> Telnet.telnetSend t b+telnetH s _ (Telnet.Send b)+ = putStr "S: " *> send s b+telnetH _ _ _ = pure ()++main :: IO ()+main = serve HostAny "4000" (\(s, _) -> handle s) where+ handle s = do+ telnet <- Telnet.telnetInit [] [] (telnetH s)+ whileJust_ (recv s 4096) $ \bs -> do+ putStr "Socket: "+ B8.putStrLn bs+ Telnet.telnetRecv telnet bs
+ libtelnet.cabal view
@@ -0,0 +1,62 @@+cabal-version: 2.2+name: libtelnet+version: 0.1.0.0+synopsis: Bindings to libtelnet+description: Binds https://github.com/seanmiddleditch/libtelnet , a C+ library for writing telnet clients and+ servers. See @README.md@ or+ "Network.Telnet.LibTelnet" to get started.+homepage: https://git.sr.ht/~jack/libtelnet-haskell+bug-reports: https://todo.sr.ht/~jack/libtelnet-haskell+license: GPL-3.0-or-later+license-file: COPYING+author: Jack Kelly+maintainer: jack@jackkelly.name+copyright: (c) 2017-2019 Jack Kelly+category: Network+build-type: Simple+extra-source-files: COPYING, ChangeLog.md, README.md+tested-with: GHC == 8.6.3+ , GHC == 8.6.1+ , GHC == 8.4.4+ , GHC == 8.4.3+ , GHC == 8.4.2+ , GHC == 8.2.2+ , GHC == 8.0.2++flag example+ description: Build the example program+ default: False+ manual: True++library+ hs-source-dirs: src+ exposed-modules: Network.Telnet.LibTelnet+ , Network.Telnet.LibTelnet.Ffi+ , Network.Telnet.LibTelnet.Iac+ , Network.Telnet.LibTelnet.Options+ , Network.Telnet.LibTelnet.Types+ ghc-options: -Wall+ build-depends: base >= 4.7 && < 5+ , bytestring >= 0.10.6.0 && < 0.11+ pkgconfig-depends: libtelnet+ default-language: Haskell2010++executable example+ hs-source-dirs: example+ main-is: Main.hs+ ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N+ if flag(example)+ buildable: True+ build-depends: base+ , libtelnet+ , bytestring >= 0.10.6.0 && < 0.11+ , network-simple >= 0.4 && < 0.5+ , monad-loops >= 0.4.3 && < 0.5+ else+ buildable: False+ default-language: Haskell2010++source-repository head+ type: git+ location: https://git.sr.ht/~jack/libtelnet-haskell
+ src/Network/Telnet/LibTelnet.hs view
@@ -0,0 +1,388 @@+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE MultiWayIf #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE TypeSynonymInstances #-}++-- | Getting Started:+--+-- 1. Skim+-- <https://github.com/seanmiddleditch/libtelnet the libtelnet documentation>,+-- as these bindings follow the C library's conventions quite closely.+--+-- 2. Write an event-handling function, of type 'EventHandler'.+--+-- 3. When you accept a new connection, create a 'Telnet' state+-- tracker for it using 'telnetInit'. Options and flags are defined in+-- the same way as the C library; option constants are exported from+-- "Network.Telnet.LibTelnet.Options".+--+-- 4. When you receive data (probably on a socket), tell 'Telnet'+-- about it using 'telnetRecv'.+--+-- 5. To send data, negotiate options, &c., use 'telnetSend',+-- 'telnetIac', &c.+--+-- 6. IAC (Interpret-As-Command) codes are exported from+-- "Network.Telnet.LibTelnet.Iac".++module Network.Telnet.LibTelnet+ ( telnetInit+ , OptionSpec(..)+ , T.Flag+ , T.flagProxy++ -- * Telnet pointers+ , Telnet+ , TelnetPtr+ , HasTelnetPtr(..)++ -- * Event handling+ , EventHandler+ , Event(..)+ , Err(..)+ , IsInfo(..)+ , Var(..)++ -- * Simple operations+ , telnetRecv+ , telnetSend++ -- * Generic telnet option negotiation+ , telnetIac+ , telnetNegotiate+ , telnetSubnegotiation++ -- * Compression <http://www.gammon.com.au/mccp/protocol.html (MCCP2)>+ , telnetBeginCompress2++ -- * @NEW-ENVIRON@ functions <http://www.faqs.org/rfcs/rfc1572.html (RFC 1572)>+ , telnetNewEnvironSend+ , telnetNewEnviron++ -- * @TERMINAL-TYPE@ functions <http://www.faqs.org/rfcs/rfc1091.html (RFC 1091)>+ , telnetTTypeSend+ , telnetTTypeIs++ -- * ZMP <http://discworld.starturtle.net/external/protocols/zmp.html (Zenith Mud Protocol)>+ , telnetSendZmp++ -- * MSSP <http://tintin.sourceforge.net/mssp/ (Mud Server Status Protocol)>+ , telnetSendMssp++ -- * Exceptions+ , T.TelnetException(..)+ ) where++import qualified Network.Telnet.LibTelnet.Ffi as F+import qualified Network.Telnet.LibTelnet.Iac as I+import Network.Telnet.LibTelnet.Options (Option(..), optMSSP)+import qualified Network.Telnet.LibTelnet.Types as T++import Control.Exception (throw, throwIO)+import Data.ByteString (ByteString)+import qualified Data.ByteString.Char8 as B8+import Data.Foldable (traverse_)+import Data.Function (on)+import Data.List (groupBy)+import Data.Monoid ((<>))+import Data.Typeable (Typeable)+import Foreign (ForeignPtr, Ptr, peek, peekArray, withForeignPtr)+import Foreign.C.String (castCUCharToChar)+import GHC.Generics (Generic)++-- | Create a @libtelnet@ state tracker.+telnetInit :: [OptionSpec] -> [T.Flag] -> EventHandler -> IO Telnet+telnetInit options flags handler =+ F.telnetInit options' (convertEventHandler handler) flags+ where+ options' = map f options+ f (OptionSpec opt us him) =+ let us' = if us then I.iacWill else I.iacWont+ him' = if him then I.iacDo else I.iacDont+ in T.TelnetTeloptT (fromIntegral $ unOption opt) us' him'++-- | Configures which options you want to support. The triple's+-- elements are: option code, support on our end (corresponds to+-- @WILL/WONT@), support on their end (corresponds to @DO/DONT@).+data OptionSpec = OptionSpec+ { _code :: Option -- ^ Option code+ , _us :: Bool -- ^ Supported on our end? (@WILL@/@WONT@)+ , _him :: Bool -- ^ Can other end use it with us? (@DO@/@DONT@)+ } deriving (Eq, Generic, Show, Typeable)++-- | Garbage-collected pointer to the @libtelnet@ state tracker. Your+-- program should hang on to this.+type Telnet = ForeignPtr T.TelnetT++-- | Raw pointer to the @libtelnet@ state tracker. This is passed to+-- the event handlers and you shouldn't see it elsewhere.+type TelnetPtr = Ptr T.TelnetT++-- | The pointer you get back from 'telnetInit' is a 'ForeignPtr'+-- because it carries around its finalizers, but the pointer that gets+-- passed into your 'EventHandler' is a bare 'Ptr' because it's being+-- passed in from C. This class lets us generalise across both types.+class HasTelnetPtr t where+ withTelnetPtr :: t -> (TelnetPtr -> IO a) -> IO a++-- | Unwrap with 'withForeignPtr'.+instance HasTelnetPtr Telnet where+ withTelnetPtr = withForeignPtr++-- | No unwrapping needed.+instance HasTelnetPtr TelnetPtr where+ withTelnetPtr t f = f t++-- | Type of the event handler callback.+type EventHandler = TelnetPtr -> Event -> IO ()++-- | Structure provided to the event handler.+data Event+ = Received ByteString+ -- ^ Data received; you should pass it to the application.+ | Send ByteString+ -- ^ Data you need to send out to the socket.+ | Warning Err+ -- ^ Something has gone wrong inside of libtelnet but+ -- recovery is (likely) possible.+ | Error Err+ -- ^ Something has gone wrong. The application should+ -- immediately close the connection.+ | Iac I.Iac -- ^ Telnet interpret-as-command.+ | Will Option -- ^ Other end offers an option.+ | Wont Option -- ^ Other end cannot support option.+ | Do Option -- ^ Other end asked you to support option.+ | Dont Option -- ^ Other end asked you to stop using option.+ | Subnegotiation Option ByteString+ -- ^ Subnegotiation received for some option.+ | Zmp [ByteString]+ -- ^ <http://discworld.starturtle.net/external/protocols/zmp.html Zenith Mud Protocol>+ -- message+ | TerminalTypeSend+ -- ^ @TERMINAL-TYPE SEND@ message+ -- <http://www.faqs.org/rfcs/rfc1091.html (RFC 1091)>.+ -- The server wants to know about your terminal-type.+ | TerminalTypeIs ByteString+ -- ^ @TERMINAL-TYPE IS@ message+ -- <http://www.faqs.org/rfcs/rfc1091.html (RFC 1091)>.+ -- The client has told us a terminal-type.+ | Compress Bool+ -- ^ Would the client like+ -- <http://www.gammon.com.au/mccp/protocol.html MCCP Version 2>?+ | EnvironSend [(Var, ByteString)]+ -- ^ Request to send the following environment variables, per+ -- <http://www.faqs.org/rfcs/rfc1408.html (RFC 1408)> and+ -- <http://www.faqs.org/rfcs/rfc1572.html (RFC 1572)>.+ | Environ IsInfo [(Var, ByteString, ByteString)]+ -- ^ @ENVIRON@/@NEW-ENVIRON@ options, per+ -- <http://www.faqs.org/rfcs/rfc1408.html (RFC 1408)> and+ -- <http://www.faqs.org/rfcs/rfc1572.html (RFC 1572)>.+ -- Keys come before values in the tuples.+ | Mssp [(ByteString, [ByteString])]+ -- ^ <http://tintin.sourceforge.net/mssp/ Mud Server Status Protocol>+ -- List is @(key, values)@.+ deriving (Eq, Generic, Show, Typeable)++-- | Error message from @libtelnet@.+data Err = Err+ { _file :: ByteString+ , _func :: ByteString+ , _msg :: ByteString+ , _line :: Int+ , _errcode :: T.TelnetErrorT+ }+ deriving (Eq, Generic, Show, Typeable)++-- | Were the 'Environ' fields sent as part of a @NEW-ENVIRON IS@+-- message, or part of a @NEW-ENVIRON INFO@ message?+data IsInfo = Is | Info deriving (Eq, Show)++-- | In an 'Environ' message, are the vars being sent as @VAR@s or @USERVAR@s?+data Var = Var | UserVar deriving (Eq, Show)++-- | Tell the state tracker about received data.+telnetRecv :: HasTelnetPtr t => t -> ByteString -> IO ()+telnetRecv t bs = withTelnetPtr t $ \telnetP -> F.telnetRecv telnetP bs++-- | Send non-command data.+telnetSend :: HasTelnetPtr t => t -> ByteString -> IO ()+telnetSend t bs = withTelnetPtr t $ \telnetP -> F.telnetSend telnetP bs++-- | Send a telnet command.+telnetIac :: HasTelnetPtr t => t -> I.Iac -> IO ()+telnetIac t c = withTelnetPtr t $ \telnetP -> F.cTelnetIac telnetP c++-- | Send a negotiation command.+telnetNegotiate :: HasTelnetPtr t => t -> I.Iac -> Option -> IO ()+telnetNegotiate t cmd opt = withTelnetPtr t $+ \telnetP -> F.cTelnetNegotiate telnetP cmd opt++-- | Send a subnegotiation.+telnetSubnegotiation :: HasTelnetPtr t => t -> Option -> ByteString -> IO ()+telnetSubnegotiation t opt bs = withTelnetPtr t $+ \telnetP -> F.telnetSubnegotiation telnetP opt bs++-- | Begin sending compressed data, using the @COMPRESS2@ option. The+-- server should call this command in response to a @'Compress' True@+-- event.+telnetBeginCompress2 :: HasTelnetPtr t => t -> IO ()+telnetBeginCompress2 t = withTelnetPtr t $+ \telnetP -> F.cTelnetBeginCompress2 telnetP++-- | Ask the client to send us these environment variables.+telnetNewEnvironSend :: HasTelnetPtr t => t -> [(Var, ByteString)] -> IO ()+telnetNewEnvironSend t vars = withTelnetPtr t $+ \telnetP -> do+ let sendVar (var, str) = B8.useAsCString str (sendVal $ varToEvar var)+ sendVal = F.cTelnetNewEnvironValue telnetP++ F.cTelnetBeginNewEnviron telnetP T.eCmdSend+ traverse_ sendVar vars+ F.cTelnetIac telnetP I.iacSE++-- | Tell the server about our environment variables.+telnetNewEnviron+ :: HasTelnetPtr t => t -> IsInfo -> [(Var, ByteString, ByteString)] -> IO ()+telnetNewEnviron t isInfo vars = withTelnetPtr t $+ \telnetP -> do+ let isInfo' = case isInfo of+ Is -> T.eCmdIs+ Info -> T.eCmdInfo++ sendVar (var, name, value) =+ B8.useAsCString name (sendVal $ varToEvar var) *>+ B8.useAsCString value (sendVal T.eValue)++ sendVal = F.cTelnetNewEnvironValue telnetP++ F.cTelnetBeginNewEnviron telnetP isInfo'+ traverse_ sendVar vars+ F.cTelnetIac telnetP I.iacSE++-- | Ask the client to give us a terminal type.+telnetTTypeSend :: HasTelnetPtr t => t -> IO ()+telnetTTypeSend t = withTelnetPtr t F.cTelnetTTypeSend++-- | Tell the server a terminal type.+telnetTTypeIs :: HasTelnetPtr t => t -> ByteString -> IO ()+telnetTTypeIs t bs = withTelnetPtr t $+ \telnetP -> B8.useAsCString bs (F.cTelnetTTypeIs telnetP)++-- | Send a ZMP command.+telnetSendZmp :: HasTelnetPtr t => t -> [ByteString] -> IO ()+telnetSendZmp t cmd = withTelnetPtr t $+ \telnetP -> F.telnetSendZmp telnetP cmd++-- | Send an MSSP status.+telnetSendMssp :: HasTelnetPtr t => t -> [(ByteString, [ByteString])] -> IO ()+telnetSendMssp t stats = telnetSubnegotiation t optMSSP stats' where+ stats' = foldMap pack stats+ pack (var, vals) = msspVar <> var <> foldMap (msspVal <>) vals++ msspVar = B8.singleton . castCUCharToChar . T.unMsspVar $ T.msspVar+ msspVal = B8.singleton . castCUCharToChar . T.unMsspVar $ T.msspVal++-- | Convert the event structure from the FFI into something nicer.+convertEventT :: T.EventT -> IO Event+convertEventT (T.Data (str, len)) =+ Received <$> B8.packCStringLen (str, fromIntegral len)++convertEventT (T.Send (str, len)) =+ Send <$> B8.packCStringLen (str, fromIntegral len)++convertEventT (T.Warning e) = Warning <$> packErrorT e++convertEventT (T.Error e) = Error <$> packErrorT e++convertEventT (T.Command cmd) = pure $ Iac cmd++convertEventT (T.Will opt) = pure $ Will opt++convertEventT (T.Wont opt) = pure $ Wont opt++convertEventT (T.Do opt) = pure $ Do opt++convertEventT (T.Dont opt) = pure $ Dont opt++convertEventT (T.Subnegotiation opt (str, len)) =+ Subnegotiation opt <$> B8.packCStringLen (str, fromIntegral len)++convertEventT (T.Zmp (argv, argc)) =+ Zmp <$> (traverse B8.packCString =<< peekArray (fromIntegral argc) argv)++convertEventT (T.TerminalType cmd name)+ | cmd == T.tCmdIs = TerminalTypeIs <$> B8.packCString name+ | cmd == T.tCmdSend = pure TerminalTypeSend+ | otherwise = throwIO $ T.UnexpectedTerminalTypeCmd cmd++convertEventT (T.Compress ok) = pure . Compress $ ok == 1++convertEventT (T.Environ cmd (values, size)) = do+ environs <- peekArray (fromIntegral size) values+ if | cmd == T.eCmdSend -> do+ vars <- traverse packVar environs+ pure $ EnvironSend vars+ | cmd `elem` [T.eCmdIs, T.eCmdInfo] -> do+ isInfo <- if | cmd == T.eCmdIs -> pure Is+ | cmd == T.eCmdInfo -> pure Info+ | otherwise -> throwIO $ T.UnexpectedEnvironCmd cmd+ vars <- traverse packVarVal environs+ pure $ Environ isInfo vars+ | otherwise -> throwIO $ T.UnexpectedEnvironCmd cmd++convertEventT (T.Mssp (values, size)) = do+ environs <- peekArray (fromIntegral size) values+ packed <- traverse packVarVal' environs++ let grouped = groupBy ((==) `on` fst) packed++ extract [] = error "Grouping should have made lists nonempty!"+ extract ((var, val):vals) = (var, val : map snd vals)++ pure . Mssp $ map extract grouped++varToEvar :: Var -> T.EVar+varToEvar Var = T.eVar+varToEvar UserVar = T.eUserVar++eVarToVar :: T.EVar -> Var+eVarToVar var+ | var == T.eVar = Var+ | var == T.eUserVar = UserVar+ | otherwise = throw $ T.UnexpectedEnvironVar var++-- | Convert 'T.ErrorT' into managed strings.+packErrorT :: T.ErrorT -> IO Err+packErrorT T.ErrorT{..} = do+ file <- B8.packCString _file+ func <- B8.packCString _func+ msg <- B8.packCString _msg+ pure $ Err file func msg (fromIntegral _line) _errcode++-- | Convert 'T.TelnetEnvironT' representing a request for an+-- environment var.+packVar :: T.TelnetEnvironT -> IO (Var, ByteString)+packVar T.TelnetEnvironT{..} = do+ var <- B8.packCString _var+ pure (eVarToVar _type, var)++-- | Convert 'T.TelnetEnvironT' representing a message about an+-- environment var's value.+packVarVal :: T.TelnetEnvironT -> IO (Var, ByteString, ByteString)+packVarVal T.TelnetEnvironT{..} = do+ var <- B8.packCString _var+ value <- B8.packCString _value+ pure (eVarToVar _type, var, value)++-- | Convert 'T.TelnetEnvironT' representing an MSSP message (i.e.,+-- type is undefined).+packVarVal' :: T.TelnetEnvironT -> IO (ByteString, ByteString)+packVarVal' T.TelnetEnvironT{..} =+ (,) <$> B8.packCString _var <*> B8.packCString _value++-- | Turn your event handler into one that the FFI can handle.+convertEventHandler :: EventHandler -> F.TelnetEventHandlerT+convertEventHandler f telnetP eventP _ =+ peek eventP >>= convertEventT >>= f telnetP
+ src/Network/Telnet/LibTelnet/Ffi.hsc view
@@ -0,0 +1,166 @@+-- | FFI binding to @libtelnet@.++module Network.Telnet.LibTelnet.Ffi where++import Network.Telnet.LibTelnet.Iac (Iac(..), iacNull)+import Network.Telnet.LibTelnet.Options (Option(..))+import qualified Network.Telnet.LibTelnet.Types as T++import Control.Exception (throwIO)+import Control.Monad (when)+import Data.ByteString (ByteString)+import qualified Data.ByteString as B+import Data.List (genericLength)+import Foreign hiding (newForeignPtr)+import Foreign.C (CSize(..), CString, CUChar(..))+import Foreign.Concurrent (newForeignPtr)++#include <libtelnet.h>++-- | Wrap 'cTelnetInit'.+telnetInit+ :: [T.TelnetTeloptT]+ -> TelnetEventHandlerT+ -> [T.Flag]+ -> IO (ForeignPtr T.TelnetT)+telnetInit options handler flags = do+ optionsA <- newArray0 (T.TelnetTeloptT (-1) iacNull iacNull) options+ handlerP <- wrapEventHandler handler+ let flagsC = foldr ((.|.) . T.unFlag) 0 flags+ telnet <- cTelnetInit optionsA handlerP flagsC nullPtr+ when (telnet == nullPtr) $ throwIO T.NullTelnetPtr++ newForeignPtr telnet $ do+ cTelnetFree telnet+ freeHaskellFunPtr handlerP+ free optionsA++-- | C function @telnet_init@.+foreign import ccall "libtelnet.h telnet_init"+ cTelnetInit+ :: Ptr T.TelnetTeloptT -- ^ @const telnet_telopt_t *telopts@+ -> FunPtr TelnetEventHandlerT -- ^ @telnet_event_handler_t eh@+ -> CUChar -- ^ @unsigned char flags@+ -> Ptr () -- ^ @void *user_data@+ -> IO (Ptr T.TelnetT)++-- | C function @telnet_free@.+foreign import ccall "libtelnet.h telnet_free"+ cTelnetFree :: Ptr T.TelnetT -> IO ()++-- | Represents @telnet_event_handler_t@.+type TelnetEventHandlerT = Ptr T.TelnetT -> Ptr T.EventT -> Ptr () -> IO ()++-- | Wrap an 'TelnetEventHandlerT' to pass to C code.+foreign import ccall "wrapper"+ wrapEventHandler :: TelnetEventHandlerT -> IO (FunPtr TelnetEventHandlerT)++-- | Wrap 'cTelnetRecv'.+telnetRecv :: Ptr T.TelnetT -> ByteString -> IO ()+telnetRecv telnetP bs = B.useAsCStringLen bs $+ \(buffer, size) -> cTelnetRecv telnetP buffer $ fromIntegral size++-- | C function @telnet_recv@.+foreign import ccall "libtelnet.h telnet_recv"+ cTelnetRecv+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> CString -- ^ @const char *buffer@+ -> CSize -- ^ @size_t size@+ -> IO ()++-- | C function @telnet_iac@.+foreign import ccall "libtelnet.h telnet_iac"+ cTelnetIac+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> Iac -- ^ @unsigned char cmd@+ -> IO ()++-- | C function @telnet_negotiate@.+foreign import ccall "libtelnet.h telnet_negotiate"+ cTelnetNegotiate+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> Iac -- ^ unsigned char cmd+ -> Option -- ^ unsigned char opt+ -> IO ()++-- | Wrap 'cTelnetSend'.+telnetSend :: Ptr T.TelnetT -> ByteString -> IO ()+telnetSend telnetP bs = B.useAsCStringLen bs $+ \(buffer, size) -> cTelnetSend telnetP buffer $ fromIntegral size++-- | C function @telnet_send@.+foreign import ccall "libtelnet.h telnet_send"+ cTelnetSend+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> CString -- ^ @const char *buffer@+ -> CSize -- ^ @size_t size@+ -> IO ()++-- | Wrap 'cTelnetSubnegotiation'.+telnetSubnegotiation :: Ptr T.TelnetT -> Option -> ByteString -> IO ()+telnetSubnegotiation telnetP opt bs = B.useAsCStringLen bs $+ \(buffer, size) ->+ cTelnetSubnegotiation telnetP opt buffer $ fromIntegral size++-- | C function @telnet_subnegotiation@.+foreign import ccall "libtelnet.h telnet_subnegotiation"+ cTelnetSubnegotiation+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> Option -- ^ @unsigned char telopt@+ -> CString -- ^ @const char *buffer@+ -> CSize -- ^ @size_t size@+ -> IO ()++-- | C function @telnet_begin_compress2@.+foreign import ccall "libtelnet.h telnet_begin_compress2"+ cTelnetBeginCompress2+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> IO ()++-- | C function @telnet_begin_newenviron@.+foreign import ccall "libtelnet.h telnet_begin_newenviron"+ cTelnetBeginNewEnviron+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> T.ECmd -- ^ @unsigned char type@+ -> IO ()++-- | C function @telnet_newenviron_value@.+foreign import ccall "libtelnet.h telnet_newenviron_value"+ cTelnetNewEnvironValue+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> T.EVar -- ^ @unsigned char type@+ -> CString -- ^ @const char *string@+ -> IO ()++-- | C function @telnet_ttype_send@.+foreign import ccall "libtelnet.h telnet_ttype_send"+ cTelnetTTypeSend+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> IO ()++-- | C function @telnet_ttype_is@.+foreign import ccall "libtelnet.h telnet_ttype_is"+ cTelnetTTypeIs+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> CString -- ^ @const char *ttype@+ -> IO ()++-- | Wrap 'cTelnetSendZmp'.+telnetSendZmp :: Ptr T.TelnetT -> [ByteString] -> IO ()+telnetSendZmp telnetP cmd = useAsCStrings cmd $+ \cCmd -> cTelnetSendZmp telnetP (genericLength cmd) cCmd++-- | C function @telnet_send_zmp@.+foreign import ccall "libtelnet.h telnet_send_zmp"+ cTelnetSendZmp+ :: Ptr T.TelnetT -- ^ @telnet_t *telnet@+ -> CSize -- ^ @size_t argc@+ -> Ptr CString -- ^ @const char **argv@+ -> IO ()++-- | Collect '[ByteString]' into a temporary array of strings in a+-- 'Ptr CString', to passing to C functions.+useAsCStrings :: [ByteString] -> (Ptr CString -> IO a) -> IO a+useAsCStrings list f = go list [] where+ go [] css = withArray (reverse css) f+ go (bs:bss) css = B.useAsCString bs $ \cs -> go bss (cs:css)
+ src/Network/Telnet/LibTelnet/Iac.hsc view
@@ -0,0 +1,59 @@+{-# LANGUAGE GeneralizedNewtypeDeriving #-}++-- | Telnet interpret-as-command (IAC) codes.++module Network.Telnet.LibTelnet.Iac+ ( Iac(..)+ , iacNull+ , iacIac+ , iacDont+ , iacDo+ , iacWont+ , iacWill+ , iacSB+ , iacGA+ , iacEL+ , iacEC+ , iacAYT+ , iacAO+ , iacIP+ , iacBreak+ , iacDM+ , iacNOP+ , iacSE+ , iacEOR+ , iacAbort+ , iacSusp+ , iacEOF+ ) where++import Foreign (Storable)+import Foreign.C (CUChar)++#include <libtelnet.h>++-- | Wrapper for telnet commands and special values.+newtype Iac = Iac { unIac :: CUChar } deriving (Eq, Show, Storable)+#{enum Iac, Iac+ , iacNull = 0+ , iacIac = TELNET_IAC+ , iacDont = TELNET_DONT+ , iacDo = TELNET_DO+ , iacWont = TELNET_WONT+ , iacWill = TELNET_WILL+ , iacSB = TELNET_SB+ , iacGA = TELNET_GA+ , iacEL = TELNET_EL+ , iacEC = TELNET_EC+ , iacAYT = TELNET_AYT+ , iacAO = TELNET_AO+ , iacIP = TELNET_IP+ , iacBreak = TELNET_BREAK+ , iacDM = TELNET_DM+ , iacNOP = TELNET_NOP+ , iacSE = TELNET_SE+ , iacEOR = TELNET_EOR+ , iacAbort = TELNET_ABORT+ , iacSusp = TELNET_SUSP+ , iacEOF = TELNET_EOF+ }
+ src/Network/Telnet/LibTelnet/Options.hsc view
@@ -0,0 +1,107 @@+{-# LANGUAGE GeneralizedNewtypeDeriving #-}++-- | Telnet option codes.++module Network.Telnet.LibTelnet.Options+ ( Option(..)+ , optBinary+ , optEcho+ , optRCP+ , optSGA+ , optNAMS+ , optStatus+ , optTM+ , optRCTE+ , optNAOL+ , optNAOP+ , optNAOCRD+ , optNAOHTS+ , optNAOHTD+ , optNAOFFD+ , optNAOVTS+ , optNAOVTD+ , optNAOLFD+ , optXASCII+ , optLogout+ , optBM+ , optDET+ , optSUPDUP+ , optSUPDUPOutput+ , optSNDLOC+ , optTType+ , optEOR+ , optTUID+ , optOUTMRK+ , optTTYLOC+ , opt3270Regime+ , optX3Pad+ , optNAWS+ , optTSpeed+ , optLFlow+ , optLineMode+ , optXDISPLOC+ , optEnviron+ , optAuthentication+ , optEncrypt+ , optNewEnviron+ , optMSSP+ , optCompress2+ , optZMP+ , optEXOPL+ , optMCCP2+ ) where++import Foreign (Storable)+import Foreign.C (CUChar)++#include <libtelnet.h>++-- | Wrapper for telnet option codes.+newtype Option = Option { unOption :: CUChar } deriving (Eq, Show, Storable)+#{enum Option, Option+ , optBinary = TELNET_TELOPT_BINARY+ , optEcho = TELNET_TELOPT_ECHO+ , optRCP = TELNET_TELOPT_RCP+ , optSGA = TELNET_TELOPT_SGA+ , optNAMS = TELNET_TELOPT_NAMS+ , optStatus = TELNET_TELOPT_STATUS+ , optTM = TELNET_TELOPT_TM+ , optRCTE = TELNET_TELOPT_RCTE+ , optNAOL = TELNET_TELOPT_NAOL+ , optNAOP = TELNET_TELOPT_NAOP+ , optNAOCRD = TELNET_TELOPT_NAOCRD+ , optNAOHTS = TELNET_TELOPT_NAOHTS+ , optNAOHTD = TELNET_TELOPT_NAOHTD+ , optNAOFFD = TELNET_TELOPT_NAOFFD+ , optNAOVTS = TELNET_TELOPT_NAOVTS+ , optNAOVTD = TELNET_TELOPT_NAOVTD+ , optNAOLFD = TELNET_TELOPT_NAOLFD+ , optXASCII = TELNET_TELOPT_XASCII+ , optLogout = TELNET_TELOPT_LOGOUT+ , optBM = TELNET_TELOPT_BM+ , optDET = TELNET_TELOPT_DET+ , optSUPDUP = TELNET_TELOPT_SUPDUP+ , optSUPDUPOutput = TELNET_TELOPT_SUPDUPOUTPUT+ , optSNDLOC = TELNET_TELOPT_SNDLOC+ , optTType = TELNET_TELOPT_TTYPE+ , optEOR = TELNET_TELOPT_EOR+ , optTUID = TELNET_TELOPT_TUID+ , optOUTMRK = TELNET_TELOPT_OUTMRK+ , optTTYLOC = TELNET_TELOPT_TTYLOC+ , opt3270Regime = TELNET_TELOPT_3270REGIME+ , optX3Pad = TELNET_TELOPT_X3PAD+ , optNAWS = TELNET_TELOPT_NAWS+ , optTSpeed = TELNET_TELOPT_TSPEED+ , optLFlow = TELNET_TELOPT_LFLOW+ , optLineMode = TELNET_TELOPT_LINEMODE+ , optXDISPLOC = TELNET_TELOPT_XDISPLOC+ , optEnviron = TELNET_TELOPT_ENVIRON+ , optAuthentication = TELNET_TELOPT_AUTHENTICATION+ , optEncrypt = TELNET_TELOPT_ENCRYPT+ , optNewEnviron = TELNET_TELOPT_NEW_ENVIRON+ , optMSSP = TELNET_TELOPT_MSSP+ , optCompress2 = TELNET_TELOPT_COMPRESS2+ , optZMP = TELNET_TELOPT_ZMP+ , optEXOPL = TELNET_TELOPT_EXOPL+ , optMCCP2 = TELNET_TELOPT_MCCP2+ }
+ src/Network/Telnet/LibTelnet/Types.hsc view
@@ -0,0 +1,331 @@+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE MultiWayIf #-}+{-# LANGUAGE RecordWildCards #-}++-- | Wrapping of @libtelnet@ types.++module Network.Telnet.LibTelnet.Types where++import Network.Telnet.LibTelnet.Iac+import Network.Telnet.LibTelnet.Options++import Control.Exception (Exception, throwIO)+import Data.Typeable (Typeable)+import Foreign+import Foreign.C+import GHC.Generics (Generic)++#include <libtelnet.h>++-- | Uninhabited type for pointer safety (@telnet_t@).+data TelnetT++-- | Exceptions thrown by the binding, for when something has gone+-- seriously wrong. Errors detected by @libtelnet@ are not thrown but+-- instead are passed to the event handler.+data TelnetException+ = NullTelnetPtr+ | UnexpectedEventType TelnetEventTypeT+ | UnexpectedEnvironCmd ECmd+ | UnexpectedEnvironVar EVar+ | UnexpectedTerminalTypeCmd TCmd+ deriving (Eq, Generic, Show, Typeable)++instance Exception TelnetException++-- | Flags for @telnet_init@.+newtype Flag = Flag { unFlag :: CUChar }+#{enum Flag, Flag+ , flagProxy = TELNET_FLAG_PROXY+ }++-- | Wraps @telnet_telopt_t@.+data TelnetTeloptT = TelnetTeloptT+ { _telopt :: CShort -- ^ option value+ , _us :: Iac -- ^ option supported on server+ , _him :: Iac -- ^ allow clients to use the option?+ }++instance Storable TelnetTeloptT where+ sizeOf _ = (#size telnet_telopt_t)+ alignment _ = (#alignment telnet_telopt_t)++ peek p = do+ telopt <- (#peek telnet_telopt_t, telopt) p+ us <- (#peek telnet_telopt_t, us) p+ him <- (#peek telnet_telopt_t, him) p++ pure $ TelnetTeloptT telopt us him++ poke p TelnetTeloptT{..} = do+ (#poke telnet_telopt_t, telopt) p _telopt+ (#poke telnet_telopt_t, us) p _us+ (#poke telnet_telopt_t, him) p _him++-- | Wraps @telnet_event_t@.+data EventT+ = Data (CString, CSize) -- ^ 'eventData'+ | Send (CString, CSize) -- ^ 'eventSend'+ | Warning ErrorT -- ^ 'eventWarning'+ | Error ErrorT -- ^ 'eventError'+ | Command Iac -- ^ 'eventIac'+ | Will Option -- ^ 'eventWill'+ | Wont Option -- ^ 'eventWont'+ | Do Option -- ^ 'eventDo'+ | Dont Option -- ^ 'eventDont'+ | Subnegotiation Option (CString, CSize) -- ^ 'eventSubnegotiation'+ | Zmp (Ptr CString, CSize) -- ^ 'eventZmp'+ | TerminalType TCmd CString -- ^ 'eventTType'+ | Compress CUChar -- ^ 'eventCompress'+ | Environ ECmd (Ptr TelnetEnvironT, CSize) -- ^ 'eventEnviron'+ | Mssp (Ptr TelnetEnvironT, CSize) -- ^ 'eventMssp'++instance Storable EventT where+ sizeOf _ = (#size telnet_event_t)+ alignment _ = (#alignment telnet_event_t)++ peek p = do+ eType <- (#peek telnet_event_t, type) p+ if | eType `elem` [eventData, eventSend] -> do+ ctor <- if | eType == eventData -> pure Data+ | eType == eventSend -> pure Send+ | otherwise -> throwIO $ UnexpectedEventType eType+ buffer <- (#peek telnet_event_t, data.buffer) p+ size <- (#peek telnet_event_t, data.size) p+ pure $ ctor (buffer, size)++ | eType `elem` [eventWarning, eventError] -> do+ ctor <- if | eType == eventWarning -> pure Warning+ | eType == eventError -> pure Error+ | otherwise -> throwIO $ UnexpectedEventType eType+ file <- (#peek telnet_event_t, error.file) p+ func <- (#peek telnet_event_t, error.func) p+ msg <- (#peek telnet_event_t, error.msg) p+ line <- (#peek telnet_event_t, error.line) p+ errcode <- (#peek telnet_event_t, error.errcode) p++ pure . ctor $ ErrorT file func msg line errcode++ | eType == eventIac ->+ Command <$> (#peek telnet_event_t, iac.cmd) p++ | eType `elem` [eventWill, eventWont, eventDo, eventDont] -> do+ ctor <- if | eType == eventWill -> pure Will+ | eType == eventWont -> pure Wont+ | eType == eventDo -> pure Do+ | eType == eventDont -> pure Dont+ | otherwise -> throwIO $ UnexpectedEventType eType+ ctor <$> (#peek telnet_event_t, neg.telopt) p++ | eType == eventSubnegotiation -> do+ telopt <- (#peek telnet_event_t, sub.telopt) p+ buffer <- (#peek telnet_event_t, sub.buffer) p+ size <- (#peek telnet_event_t, sub.size) p++ pure $ Subnegotiation telopt (buffer, size)++ | eType == eventZmp -> do+ argc <- (#peek telnet_event_t, zmp.argc) p+ argv <- (#peek telnet_event_t, zmp.argv) p++ pure $ Zmp (argv, argc)++ | eType == eventTType -> do+ cmd <- (#peek telnet_event_t, ttype.cmd) p+ name <- (#peek telnet_event_t, ttype.name) p++ pure $ TerminalType cmd name++ | eType == eventCompress ->+ Compress <$> (#peek telnet_event_t, compress.state) p++ | eType == eventEnviron -> do+ cmd <- (#peek telnet_event_t, environ.cmd) p+ values <- (#peek telnet_event_t, environ.values) p+ size <- (#peek telnet_event_t, environ.size) p++ pure $ Environ cmd (values, size)++ | eType == eventMssp -> do+ values <- (#peek telnet_event_t, mssp.values) p+ size <- (#peek telnet_event_t, mssp.size) p++ pure $ Mssp (values, size)++ | otherwise -> throwIO $ UnexpectedEventType eType++ poke p (Data (buffer, size)) = do+ (#poke telnet_event_t, type) p eventData+ (#poke telnet_event_t, data.buffer) p buffer+ (#poke telnet_event_t, data.size) p size++ poke p (Send (buffer, size)) = do+ (#poke telnet_event_t, type) p eventSend+ (#poke telnet_event_t, data.buffer) p buffer+ (#poke telnet_event_t, data.size) p size++ poke p (Warning ErrorT{..}) = do+ (#poke telnet_event_t, type) p eventWarning+ (#poke telnet_event_t, error.file) p _file+ (#poke telnet_event_t, error.func) p _func+ (#poke telnet_event_t, error.msg) p _msg+ (#poke telnet_event_t, error.line) p _line+ (#poke telnet_event_t, error.errcode) p _errcode++ poke p (Error ErrorT{..}) = do+ (#poke telnet_event_t, type) p eventError+ (#poke telnet_event_t, error.file) p _file+ (#poke telnet_event_t, error.func) p _func+ (#poke telnet_event_t, error.msg) p _msg+ (#poke telnet_event_t, error.line) p _line+ (#poke telnet_event_t, error.errcode) p _errcode++ poke p (Command cmd) = do+ (#poke telnet_event_t, type) p eventIac+ (#poke telnet_event_t, iac.cmd) p cmd++ poke p (Will opt) = do+ (#poke telnet_event_t, type) p eventWill+ (#poke telnet_event_t, neg.telopt) p opt++ poke p (Wont opt) = do+ (#poke telnet_event_t, type) p eventWont+ (#poke telnet_event_t, neg.telopt) p opt++ poke p (Do opt) = do+ (#poke telnet_event_t, type) p eventDo+ (#poke telnet_event_t, neg.telopt) p opt++ poke p (Dont opt) = do+ (#poke telnet_event_t, type) p eventDont+ (#poke telnet_event_t, neg.telopt) p opt++ poke p (Subnegotiation opt (buffer, size)) = do+ (#poke telnet_event_t, type) p eventSubnegotiation+ (#poke telnet_event_t, sub.telopt) p opt+ (#poke telnet_event_t, sub.buffer) p buffer+ (#poke telnet_event_t, sub.size) p size++ poke p (Zmp (argv, argc)) = do+ (#poke telnet_event_t, type) p eventZmp+ (#poke telnet_event_t, zmp.argv) p argv+ (#poke telnet_event_t, zmp.argc) p argc++ poke p (TerminalType cmd name) = do+ (#poke telnet_event_t, type) p eventTType+ (#poke telnet_event_t, ttype.cmd) p cmd+ (#poke telnet_event_t, ttype.name) p name++ poke p (Compress state) = do+ (#poke telnet_event_t, type) p eventCompress+ (#poke telnet_event_t, compress.state) p state++ poke p (Environ cmd (values, size)) = do+ (#poke telnet_event_t, type) p eventEnviron+ (#poke telnet_event_t, environ.cmd) p cmd+ (#poke telnet_event_t, environ.values) p values+ (#poke telnet_event_t, environ.size) p size++ poke p (Mssp (values, size)) = do+ (#poke telnet_event_t, type) p eventMssp+ (#poke telnet_event_t, mssp.values) p values+ (#poke telnet_event_t, mssp.size) p size++-- | Constants from @telnet_event_type_t@.+newtype TelnetEventTypeT = TelnetEventTypeT { unTelnetEventTypeT :: CInt }+ deriving (Eq, Show, Storable)+#{enum TelnetEventTypeT, TelnetEventTypeT+ , eventData = TELNET_EV_DATA+ , eventSend = TELNET_EV_SEND+ , eventIac = TELNET_EV_IAC+ , eventWill = TELNET_EV_WILL+ , eventWont = TELNET_EV_WONT+ , eventDo = TELNET_EV_DO+ , eventDont = TELNET_EV_DONT+ , eventSubnegotiation = TELNET_EV_SUBNEGOTIATION+ , eventCompress = TELNET_EV_COMPRESS+ , eventZmp = TELNET_EV_ZMP+ , eventTType = TELNET_EV_TTYPE+ , eventEnviron = TELNET_EV_ENVIRON+ , eventMssp = TELNET_EV_MSSP+ , eventWarning = TELNET_EV_WARNING+ , eventError = TELNET_EV_ERROR+ }++-- | Data in 'Warning' and 'Error' events, modeled after @struct+-- error_t@ inside @telnet_event_t@.+data ErrorT = ErrorT+ { _file :: CString+ , _func :: CString+ , _msg :: CString+ , _line :: CInt+ , _errcode :: TelnetErrorT+ }++-- | Constants from @telnet_error_t@.+newtype TelnetErrorT = TelnetErrorT { unTelnetErrorT :: CInt }+ deriving (Eq, Show, Storable)+#{enum TelnetErrorT, TelnetErrorT+ , errOK = TELNET_EOK+ , errBadVal = TELNET_EBADVAL+ , errNoMem = TELNET_ENOMEM+ , errOverflow = TELNET_EOVERFLOW+ , errProtocol = TELNET_EPROTOCOL+ , errCompress = TELNET_ECOMPRESS+ }++-- | Constants for @TERMINAL-TYPE@ commands.+newtype TCmd = TCmd { unTCmd :: CUChar } deriving (Eq, Show, Storable)+#{enum TCmd, TCmd+ , tCmdIs = TELNET_TTYPE_IS+ , tCmdSend = TELNET_TTYPE_SEND+ }++-- | Constants for @ENVIRON@/@NEW-ENVIRON@ commands.+newtype ECmd = ECmd { unECmd :: CUChar } deriving (Eq, Show, Storable)+#{enum ECmd, ECmd+ , eCmdIs = TELNET_ENVIRON_IS+ , eCmdSend = TELNET_ENVIRON_SEND+ , eCmdInfo = TELNET_ENVIRON_INFO+ }++-- | Constants for @ENVIRON@/@NEW-ENVIRON@ variables.+newtype EVar = EVar { unEvar :: CUChar } deriving (Eq, Show, Storable)+#{enum EVar, EVar+ , eVar = TELNET_ENVIRON_VAR+ , eValue = TELNET_ENVIRON_VALUE+ , eUserVar = TELNET_ENVIRON_USERVAR+ }++-- | Constants for MSSP.+newtype MsspVar = MsspVar { unMsspVar :: CUChar } deriving (Eq, Show, Storable)+#{enum MsspVar, MsspVar+ , msspVar = TELNET_MSSP_VAR+ , msspVal = TELNET_MSSP_VAL+ }++-- | @ENVIRONMENT@\/@NEW-ENVIRONMENT@\/@MSSP@ messages, wrapping+-- @telnet_environ_t@.+data TelnetEnvironT = TelnetEnvironT+ { _type :: EVar -- ^ @unsigned char type@+ , _var :: CString -- ^ @char *var@+ , _value :: CString -- ^ @char *value@+ }++instance Storable TelnetEnvironT where+ sizeOf _ = (#size struct telnet_environ_t)+ alignment _ = (#alignment struct telnet_environ_t)++ peek p = do+ type_ <- (#peek struct telnet_environ_t, type) p+ var <- (#peek struct telnet_environ_t, var) p+ value <- (#peek struct telnet_environ_t, value) p++ pure $ TelnetEnvironT type_ var value++ poke p TelnetEnvironT{..} = do+ (#poke struct telnet_environ_t, type) p _type+ (#poke struct telnet_environ_t, var) p _var+ (#poke struct telnet_environ_t, value) p _value