diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..84ee8a0 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,621 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS diff --git a/README.md b/README.md deleted file mode 100644 index 4e83e57..0000000 --- a/README.md +++ /dev/null @@ -1,4 +0,0 @@ -protocol -======== - -A Simple ASCII Header Generator for Network Protocols diff --git a/README.txt b/README.txt index 4e83e57..01509fb 100644 --- a/README.txt +++ b/README.txt @@ -1,4 +1,434 @@ -protocol -======== +################################################################################ +# ____ _ _ # +# | _ \ _ __ ___ | |_ ___ ___ ___ | | # +# | |_) | '__/ _ \| __/ _ \ / __/ _ \| | # +# | __/| | | (_) | || (_) | (_| (_) | | # +# |_| |_| \___/ \__\___/ \___\___/|_| # +# # +# == A Simple ASCII Header Generator for Network Protocols == # +# # +################################################################################ +# # +# Written by: # +# # +# Luis MartinGarcia. # +# -> E-Mail: luis.mgarc@gmail.com # +# -> WWWW: http://www.luismg.com # +# -> GitHub: https://github.com/luismartingarcia # +# # +################################################################################ + + TABLE OF CONTENTS + + 0x01 Introduction............................................................. + 0x02 Installing Protocol...................................................... + 0x03 Running Protocol......................................................... + |_ 0x03.1 Displaying Existing Protocols...................................... + |_ 0x03.2 Displaying Custom Protocols........................................ + 0x04 Examples................................................................. + 0x05 Support and Bug Reporting................................................ + + + 0x01 - INTRODUCTION + + Protocol is a simple command-line tool that serves two purposes: + + - Provide a simple way for engineers to have a look at standard network + protocol headers, directly from the command-line, without having to + google for the relevant RFC or for ugly header image diagrams. + + - Provide a way for researchers and engineers to quickly generate ASCII + RFC-like header diagrams for their own custom protocols. + + 0x02 - DOWNLOADING PROTOCOL + + The latest version of protocol is available via GitHub. It can be downloaded + directly from the following website clicking on the button "Download ZIP". + + https://github.com/luismartingarcia/protocol + + Alternatively, the code can be checked out using GIT, running the following + command: + + git clone https://github.com/luismartingarcia/protocol.git + + If prompted for a username and password, don't enter any, just hit Enter. + + Documentation and extra information is always available through the following + site: + + http://www.luismg.com/protocol + + + 0x02 - INSTALLING PROTOCOL + + Protocol can be installed by running the included setup.py script as follows: + + setup.py install + + Note that in order to install Protocol, root or administrative privileges + are required. On GNU/Linux systems, it can be installed as follows: + + sudo ./setup.py install + + 0x03 - RUNNING PROTOCOL + + Once installed, Protocol can be run from the command line. The syntax is + the following: + + protocol + + or + + protocol + + The following subsections describe each approach. + + 0x03.1 Displaying Existing Protocols + + The first approach lets users print ASCII headers for existing network + protocols. In particular, the following protocols are available. + + "ethernet" : Ethernet + "8021q" : IEEE 802.1q + "dot1q" : IEEE 802.1q + "tcp" : Transmission Control Protocol (TCP) + "udp" : User Datagram Protocol (TCP) + "ip" : Internet Protocol (IP), version 4. + "ipv6" : Internet Protocol (IP), version 6. + "icmp" : Internet Control Message Protocol (ICMP) + "icmp-destination": : ICMP Destination Unreachable + "icmp-time" : ICMP Time Exceeded + "icmp-parameter" : ICMP Parameter Problem + "icmp-source" : ICMP Source Quench + "icmp-redirect" : ICMP Redirect + "icmp-echo" : ICMP Echo Request/Reply + "icmp-timestamp" : ICMP Timestamp Request/Reply + "icmp-information" : ICMP Information Request/Reply + "icmpv6" : Internet Control Message Protocol for IPv6 (ICMPv6) + "icmpv6-destination" : ICMPv6 Destination Unreachable + "icmpv6-big" : ICMPv6 Packet Too Big + "icmpv6-time" : ICMPv6 Time Exceeded + "icmpv6-parameter" : ICMPv6 Parameter Problem + "icmpv6-echo" : ICMPv6 Echo Request/Reply + "icmpv6-rsol" : ICMPv6 Router Solicitation + "icmpv6-radv" : ICMPv6 Router Advertisement + "icmpv6-nsol" : ICMPv6 Neighbor Solicitation + "icmpv6-nadv" : ICMPv6 Neighbor Advertisement + "icmpv6-redirect" : ICMPv6 Redirect + + One or more of the protocols listed above can be printed. Here are a few + examples: + + protocol tcp + protocol dot1q + protocol tcp udp + protocol ipv6 icmpv6 icmpv6-redirect + + Note that protocol names don't need to be fully specified, as long as there + is no ambiguity. For example 'protocol et' is equivalent to 'protocol + ethernet'. Whenever there is ambiguity (e.g. 'protocol icmpv6-r', a list of + possible options will be displayed. + + $ protocol icmpv6-r + Ambiguous protocol specifier 'icmpv6-r'. Did you mean any of these? + icmpv6-radv + icmpv6-redirect + icmpv6-rsol + + 0x03.1 Displaying Custom Protocols + + Apart from already existing protocols, Protocol can represent any arbitrary + protocol headers. In order to do that, instead of specifying the name of + an existing protocol, a custom protocol specification may be supplied. Such + specification must follow a simple but specific syntax: + + "[?OPTIONS]" + + Where [LIST_OF_FIELDS] is a comma-separated list of protocol field names + and lengths (expressed in bits), and [?OPTIONS] is an optional part that + allows users to specify format modifiers for the ASCII header. Note that if + any of the field names contains spaces, the protocol specification must be + enclosed in double quotes. + + 0x03.1.1 Field Lists + + The most important part of a protocol specification are field lists. This + is just a comma-separated list of name:length tuples, where name represents + the text that describes the protocol field and can contain any character, + except for '?' and length is an integer greater than zero, representing the + number of bits the field takes in the header. Here are a few examples: + + Type:8,Code:8,Checksum:16,Message Body:64 + Source Port:16,Destination Port:16,Length:16,Checksum:16 + + Note that there is no whitespace after the commas. This is a restriction + that must be respected. + + Also, note that field lengths don't need to align to the length of the + line. If a particular field is too long, Protocol will just wrap it to the + next line. Here are some examples: + + $ protocol "Source:16,TTL:8,Reserved:40" + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source | TTL | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + | Reserved | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + + $ protocol "Source:16,Reserved:40,TTL:8" + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ + | Reserved | TTL | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + $ protocol "Reserved:32,Target Address:128" + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Reserved | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + + + + | | + + Target Address + + | | + + + + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + + 0x03.1.2 Options + + Once the list of fields has been specified, users may optionally pass + formatting options to control the way the ASCII header is generated. + Options are supplied as a comma-separated list of label=value elements. + The first one is preceded by the '?' sign, which lets Protocol figure out + where the field list ends and where the list of options begins. The options + currently available are the following: + + bits= : Number of bits per line. By default it's 32, same as IETF. + This is useful for protocols that don't align perfectly to + 32-bit words, like Ethernet. + numbers= : Instructs protocol to print or avoid printing the bit + counts on top of the header. + evenchar= : Instructs protocol to use the supplied character, instead + of the default "-" as the character in even positions of + the horizontal lines. + oddchar= : Same as evenchar but for characters in odd positions of the + horizontal lines. By default it takes the value '+' + startchar= : Instructs protocol to use the supplied character instead + of the default "+" for the first position of an horizontal + line. + endchar= : Same as startchar but for the character in the last + position of the horizonal lines. + sepchar= : Instructs protocol to use the supplied character instead + of the default "|" for the field separator character. + + The following diagram shows the character modifiers described above. + + Bit counts sepchar(|) + ^ ^ | + | | | + | | | + 0 | 1 2 3 | + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | + | Source | TTL | Reserved | <-+ + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + ^ ^ ^ ^ ^ ^ ^ ^ + | | | | | | | | + startchar(+) evenchar( -) oddchar(+) endchar(+) + + |<------------------------------------------------------------->| + bits(32) + + + 0x03.3 Command-line Options + + Apart from per-protocol format specifiers, Protocol can also be configured + using command-line parameter. The following list provides a description of + each option available. + + Usage: /usr/local/bin/protocol { or } [OPTIONS] + PARAMETERS: + : Name of an existing protocol + : Field by field specification of non-existing protocol + OPTIONS: + -b, --bits : Number of bits per line + -f, --file : Read specs from a text file + -h, --help : Displays this help information + -n, --no-numbers : Do not print bit numbers on top of the header + -V, --version : Displays current version + --evenchar : Character for the even positions of horizontal lines + --oddchar : Character for the odd positions of horizontal lines + --startchar : Character that starts horizontal lines + --endchar : Character that ends horizontal lines + --sepchar : Character that separates protocol fields + + + 0x04 - EXAMPLES + + This section presents additional examples on how to run protocol. + + $ protocol tcp + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source Port | Destination Port | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Sequence Number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Acknowledgment Number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Offset| Res. | Flags | Window | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Checksum | Urgent Pointer | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Options | Padding | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + + $ protocol "Source Port:16,Destination Port:16,Sequence Number:32,\ + Acknowledgment Number:32,Offset:4,Res.:4,Flags:8,Window:16,Checksum:16,\ + Urgent Pointer:16,Options:24,Padding:8" + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source Port | Destination Port | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Sequence Number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Acknowledgment Number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Offset| Res. | Flags | Window | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Checksum | Urgent Pointer | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Options | Padding | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + + $ protocol "Field4:4,Field4:4,Field8:8,Field16:16,Field32:32,Field64:64?\ + bits=16,numbers=y,startchar=*,endchar=*,evenchar=-,oddchar=-,sepchar=|" + 0 1 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 + *-------------------------------* + | Field4| Field4| Field8 | + *-------------------------------* + | Field16 | + *-------------------------------* + | | + * Field32 * + | | + *-------------------------------* + | | + * * + | | + * Field64 * + | | + * * + | | + *-------------------------------* + + + $ protocol ip --bits 16 + 0 1 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |Version| IHL |Type of Service| + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Total Length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Identification | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |Flags| Fragment Offset | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Time to Live | Protocol | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Header Checksum | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + + Source Address + + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + + Destination Address + + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Options | + + +-+-+-+-+-+-+-+-+ + | | Padding | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + + $ protocol udp --oddchar "-" --startchar "-" --endchar "-" + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + ----------------------------------------------------------------- + | Source Port | Destination Port | + ----------------------------------------------------------------- + | Length | Checksum | + ----------------------------------------------------------------- + + + $ protocol ipv6 --no-numbers + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |Version| Traffic Class | Flow Label | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Payload Length | Next Header | Hop Limit | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + + + + | | + + Source Address + + | | + + + + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + + + + | | + + Destination Address + + | | + + + + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + + $ protocol udp icmp + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source Port | Destination Port | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Length | Checksum | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Type | Code | Checksum | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + + Message Body + + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + + 0x05 - SUPPORT AND BUG REPORTING + + For any questions, bug reports, bug fixes, feature requests, code + contributions, etc, please contact me using the e-mail address displayed on + the header of this file. Please note that Protocol's support is just like + IP transport: best-effort. I will do my best to deal with your enquiries but + no guarantees. Special support packages are available for those willing to + send me real $$$ via Paypal ;-) + -A Simple ASCII Header Generator for Network Protocols diff --git a/constants.py b/constants.py new file mode 100644 index 0000000..7deea62 --- /dev/null +++ b/constants.py @@ -0,0 +1,69 @@ +################################################################################ +# ____ _ _ # +# | _ \ _ __ ___ | |_ ___ ___ ___ | | # +# | |_) | '__/ _ \| __/ _ \ / __/ _ \| | # +# | __/| | | (_) | || (_) | (_| (_) | | # +# |_| |_| \___/ \__\___/ \___\___/|_| # +# # +# == A Simple ASCII Header Generator for Network Protocols == # +# # +################################################################################ +# # +# Written by: # +# # +# Luis MartinGarcia. # +# -> E-Mail: luis.mgarc@gmail.com # +# -> WWWW: http://www.luismg.com # +# -> GitHub: https://github.com/luismartingarcia # +# # # +################################################################################ +# # +# This file is part of Protocol. # +# # +# Copyright (C) 2014 Luis MartinGarcia (luis.mgarc@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 # +# (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 . # +# # +# Please check file LICENSE.txt for the complete version of the license, # +# as this disclaimer does not contain the full information. Also, note # +# that although Protocol is licensed under the GNU GPL v3 license, it may # +# be possible to obtain copies of it under different, less restrictive, # +# alternative licenses. Requests will be studied on a case by case basis. # +# If you wish to obtain Protocol under a different license, please contact # +# the email address mentioned above. # +# # +################################################################################ +# # +# Description: # +# # +# This file contains a few constants used throughout the rest of the source. # +# # +################################################################################ + +# Application name +APPLICATION_NAME="Protocol" + +# Current version +APPLICATION_VERSION="0.1.0" + +# Author +APPLICATION_AUTHOR="Luis MartinGarcia" + +# Author E-mail +APPLICATION_AUTHOR_EMAIL="luis.mgarc@gmail.com" + +# Operation return codes +OP_SUCCESS = 0 # Function performed operation successfully +OP_FAILURE = -1 # Error encountered while performing operation + diff --git a/protocol b/protocol new file mode 100755 index 0000000..5bfeeda --- /dev/null +++ b/protocol @@ -0,0 +1,739 @@ +#!/usr/bin/python +################################################################################ +# ____ _ _ # +# | _ \ _ __ ___ | |_ ___ ___ ___ | | # +# | |_) | '__/ _ \| __/ _ \ / __/ _ \| | # +# | __/| | | (_) | || (_) | (_| (_) | | # +# |_| |_| \___/ \__\___/ \___\___/|_| # +# # +# == A Simple ASCII Header Generator for Network Protocols == # +# # +################################################################################ +# # +# Written by: # +# # +# Luis MartinGarcia. # +# -> E-Mail: luis.mgarc@gmail.com # +# -> WWWW: http://www.luismg.com # +# -> GitHub: https://github.com/luismartingarcia # +# # +################################################################################ +# # +# This file is part of Protocol. # +# # +# Copyright (C) 2014 Luis MartinGarcia (luis.mgarc@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 # +# (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 . # +# # +# Please check file LICENSE.txt for the complete version of the license, # +# as this disclaimer does not contain the full information. Also, note # +# that although Protocol is licensed under the GNU GPL v3 license, it may # +# be possible to obtain copies of it under different, less restrictive, # +# alternative licenses. Requests will be studied on a case by case basis. # +# If you wish to obtain Protocol under a different license, please contact # +# the email address mentioned above. # +# # +################################################################################ +# # +# Description: # +# # +# Protocol is a command-line tool that provides quick access to the most # +# common network protocol headers in ASCII (RFC-like) format. It also has the # +# ability to create ASCII headers for custom protocols defined by the user # +# through a very simple syntax. # +# # +################################################################################ + +# STANDARD LIBRARY IMPORTS +import sys +from datetime import date + +# INTERNAL IMPORTS +from constants import * +import specs + + +# CLASS DEFINITIONS +class ProtocolException(Exception): + """ + This class represents exceptions raised by the Protocol class + """ + def __init__(self, errmsg): + self.errmsg=errmsg + + def __str__(self): + return str(self.errmsg) + + +class Protocol(): + """ + This class represents a network protocol header. Objects are constructed by + passing a textual protocol specification. Once that is done, instances + can be printed by converting them to a str type. + """ + + def __init__(self, spec): + """ + Class constructor. + @param spec is the textual specification that describes the protocol. + """ + self.hdr_char_start="+" # Character for start of the border line + self.hdr_char_end="+" # Character for end of the border line + self.hdr_char_fill_odd="+" # Fill character for border odd positions + self.hdr_char_fill_even="-" # Fill character for border even positions + self.hdr_char_sep="|" # Field separator character + self.bits_per_line=32 # Number of bits per line + self.do_print_top_tens=True # True: print top numbers for bit tens + self.do_print_top_units=True # True: print top numbers for bit units + self.field_list=[] # Header fields to be printed out + self.parse_spec(spec) # Parse the received spec and populate self.field_list + + + def parse_spec(self, spec): + """ + Parses a textual protocol spec and stores the relevant internal state + so such spec can be later converted to a nice ASCII diagram. + @return the list of protocol fields, as a dictionary containing + keys 'len' and 'text'. The list is returned for completeness but no + caller is expected to store or use such list. + @raise ProtocolException in case the supplied spec is not valid + """ + if "?" in spec: + parts=spec.split("?") + fields=parts[0] + opts=parts[1] + if spec.count("?")>1: + raise ProtocolException("FATAL: Character '?' may only be used as an option separator.") + else: + fields=spec + opts=None + + # Parse field spec + items=fields.split(",") + for item in items: + try: + text, bits = item.split(":") + bits=int(bits) + if bits<=0: + raise ProtocolException("FATAL: Fields must be at least one bit long (%s)" %spec) + except ProtocolException: + raise + except: + raise ProtocolException("FATAL: Invalid field_list specification (%s)" %spec) + self.field_list.append({"text":text, "len":bits}) + + # Parse options + if opts is not None: + opts=opts.split(",") + for opt in opts: + try: + var, value = opt.split("=") + if var.lower()=="bits": + self.bits_per_line=int(value) + if self.bits_per_line<=0: + raise ProtocolException("FATAL: Invalid value for 'bits' option (%s)" % value) + elif var.lower()=="numbers": + if value.lower() in ["0", "n", "no", "none", "false"]: + self.do_print_top_tens=False + self.do_print_top_units=False + elif value.lower() in ["1", "y", "yes", "none", "true"]: + self.do_print_top_tens=True + self.do_print_top_units=True + else: + raise ProtocolException("FATAL: Invalid value for 'numbers' option (%s)" % value) + elif var.lower() in ["oddchar", "evenchar", "startchar", "endchar", "sepchar"]: + if len(value)>1 or len(value)<=0: + raise ProtocolException("FATAL: Invalid value for '%s' option (%s)" % (var, value)) + else: + if var.lower()=="oddchar": + self.hdr_char_fill_odd=value + elif var.lower()=="evenchar": + self.hdr_char_fill_even=value + elif var.lower()=="startchar": + self.hdr_char_start=value + elif var.lower()=="endchar": + self.hdr_char_end=value + elif var.lower()=="sepchar": + self.hdr_char_sep=value + except ProtocolException: + raise + except: + raise ProtocolException("FATAL: Invalid options specification (%s)" % opt) + + return self.field_list + + + def _get_top_numbers(self): + """ + @return a string representing the bit units and bit tens on top of the + protocol header. Note that a proper string is only returned if one or + both self.do_print_top_tens and self.do_print_top_units is True. + The returned string is not \n terminated, but it may contain a newline + character in the middle. + """ + lines=["", ""] + if self.do_print_top_tens is True: + for i in range(0, self.bits_per_line): + if str(i)[-1:]=="0": + lines[0]+=" %s" % str(i)[0] + else: + lines[0]+=" " + lines[0]+="\n" + if self.do_print_top_units is True: + for i in range(0, self.bits_per_line): + lines[1]+=" %s" % str(i)[-1:] + #lines[1]+="\n" + result = "".join(lines) + return result if len(result)>0 else None + + + def _get_horizontal(self, width=None): + """ + @return the horizontal border line that separates field rows. + @param width controls how many field bits the line should cover. By + default, if no width is supplied, the line covers the hole length of + the header. + """ + if width is None: + width=self.bits_per_line + if width<=0: + return "" + else: + a="%s" % self.hdr_char_start + b=(self.hdr_char_fill_even+self.hdr_char_fill_odd)*(width-1) + c="%s%s" % (self.hdr_char_fill_even, self.hdr_char_end) + return a+b+c + + + def _get_separator(self, line_end=""): + """ + @return a string containing a protocol field separator. Returned string + is a single character and matches whatever is stored in self.hdr_char_sep + """ + return self.hdr_char_sep + + + def _process_field_list(self): + """ + Processes the list of protocol fields that we got from the spec and turns + it into something that we can print easily (useful for cases when we have + protocol fields that span more than one line). This is just a helper + function to make __str__()'s life easier. + """ + new_fields=[] + bits_in_line=0 + i=0 + while i < len(self.field_list): + # Extract all the info we need about the field + field=self.field_list[i] + field_text= field['text'] + field_len= field['len'] + field['MF']=False + + available_in_line = self.bits_per_line - bits_in_line + + # If we have enough space on this line to include the current field + # then just keep it as it is. + if available_in_line >= field_len: + new_fields.append(field) + bits_in_line+=field_len + i+=1 + if bits_in_line==self.bits_per_line: + bits_in_line=0 + # Otherwise, split the field into two parts, one blank and one with + # the actual field text + else: + + # Case 1: We have a field that is perfectly aligned and it + # has a length that is multiple of our line length + if bits_in_line==0 and field_len%self.bits_per_line==0: + new_fields.append(field) + i+=1 + bits_in_line=0 + + # Case 2: We weren't that lucky and the field is either not + # aligned or we can't print it using an exact number of full + # lines + else: + + # If we have more space in the current line than in the next, + # then put the field text in this one + if available_in_line >= field_len-available_in_line: + new_field = {'text':field_text, 'len':available_in_line, "MF":True} + new_fields.append(new_field) + field['text']="" + field['len']=field_len-available_in_line + field['MF']=False + else: + new_field = {'text':"", 'len':available_in_line, "MF":True} + new_fields.append(new_field) + field['text']=field_text + field['len']=field_len-available_in_line + field['MF']=False + bits_in_line=0 + continue + return new_fields + + + # Convert to string + def __str__(self): + """ + Converts the protocol specification stored in the object to a nice + ASCII diagram like the ones that appear in RFCs. Conversion supports + fields of any length, and supports field that span more than one + line in the diagram. + @return a string containing the ASCII representation of the protocol + header. + """ + + # First of all, process our field list. This does some magic to make + # the algorithm work for fields that span more than one line + proto_fields = self._process_field_list() + lines=[] + numbers=self._get_top_numbers() + if numbers is not None: + lines.append(numbers) + lines.append(self._get_horizontal()) + + # Print all protocol fields + bits_in_line=0 + current_line="" + fields_done=0 + p=-1 + while p < len(proto_fields)-1: + p+=1 + + # Extract all the info we need about the field + field = proto_fields[p] + field_text= field['text'] + field_len= field['len'] + field_mf = field['MF'] is True # Field has more fragments + + # If the field text is too long, we truncate it, and add a dot + # at the end. + if len(field_text) > (field_len*2)-1: + field_text=field_text[0:(field_len*2)-1] + if len(field_text)>1: + field_text=field_text[0:-1]+"." + + # If we have space for the whole field in the current line, go + # ahead and add it + if self.bits_per_line-bits_in_line >= field_len: + # If this is the first thing we print on a line, add the + # starting character + if bits_in_line==0: + current_line+=self._get_separator() + + # Add the whole field + current_line+=str.center(field_text, (field_len*2)-1) + + # Update counters + bits_in_line+=field_len + fields_done+=1 + + # If this is the last character in the line, store the line + if bits_in_line==self.bits_per_line: + current_line+=self._get_separator() + lines.append(current_line) + current_line="" + bits_in_line=0 + # When we have a fragmented field, we may need to suppress + # the floor of the field, so the current line connects + # with the one that follows. E.g: + # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + # | field16 | | + # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + # | field | + # +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + if field_mf is True: + if proto_fields[p+1]['len'] > self.bits_per_line - field_len: + + # Print some +-+-+ to cover the previous field + line_left=self._get_horizontal(self.bits_per_line - field_len) + if len(line_left)==0: + line_left=self.hdr_char_start + + # Now print some empty space to cover the part that + # we can join with the field below. + # Case 1: If the next field reaches the end of its + # line, then we need to print whitespace until the + # end our line + if proto_fields[p+1]['len'] >= self.bits_per_line: + line_center=" "* ((2*(field_len)-1)) + line_right=self.hdr_char_end + # Case 2: the field in the next row is not big enough + # to cover all the space we'd like to join, so we + # just print whitespace to cover as much as we can + else: + line_center=" "* ((2*((proto_fields[p+1]['len']-(self.bits_per_line-field_len))))-1) + line_right=self._get_horizontal(self.bits_per_line-proto_fields[p+1]['len']) + + lines.append(line_left+line_center+line_right) + else: + lines.append(self._get_horizontal()) + else: + lines.append(self._get_horizontal()) + + + # If this is not the last character of the line but we have no + # more fields to print, wrap up + elif fields_done==len(proto_fields): + current_line+=self._get_separator() + lines.append(current_line) + lines.append(self._get_horizontal(bits_in_line)) + else: + # Add the separator character + current_line+=self.hdr_char_sep + + # We don't have enough space for the field on this line. + else: + # Case 1: We are at the beginning of a new line and we need to + # span more than one line + if bits_in_line==0: + # Case 1a: We have a multiple of the number of bits per line + if field_len%self.bits_per_line==0: + # Compute how many lines in total we need to print for this + # big field. + lines_to_print = int(((field_len/self.bits_per_line)*2)-1) + # We print the field text in the central line + central_line=int(lines_to_print/2) + # Print all those lines + for i in range(0, lines_to_print): + + # Let's figure out which character we need to use + # to start and end the current line + if i%2==1: + start_line=self.hdr_char_start + end_line=self.hdr_char_end + else: + start_line=self.hdr_char_sep + end_line=self.hdr_char_sep + + # This is the line where we need to print the field + # text. + if i == central_line: + lines.append(start_line + str.center(field_text, (self.bits_per_line*2)-1) + end_line) + # This is a line we need to leave blank + else: + lines.append(start_line + (" " * ((self.bits_per_line*2)-1)) + end_line) + # If we just added the last line, add a horizontal separator + if i==lines_to_print-1: + lines.append(self._get_horizontal()) + + # Case 2: We are not at the beginning of the line and we need + # to print something that does not fit in the current line + else: + # This should never happen, since our _process_field_list() + # divides fields in chunks so we never have the case of + # something spanning lines in a weird manner + assert(False) + + result= "\n".join(lines) + return result + + +class Main(): + """ + This class does all the boring task of a command-line application. It parses + user input, displays usage, parses input files, etc. + """ + + def __init__(self): + """ + Class constructor. Nothing fancy. + """ + self.cmd_line_args=None # Copy of the user argv + self.protocols=[] # List of protocols to print out + self.bits_per_line=None # Number of bits per line to print + self.skip_numbers=None # True to avoid printing bit units and tens + self.hdr_char_start=None # Character for start of the border line + self.hdr_char_end=None # Character for end of the border line + self.hdr_char_fill_odd=None # Fill character for border odd positions + self.hdr_char_fill_even=None # Fill character for border even positions + self.hdr_char_sep=None # Field separator character + + + def display_help(self): + """ + Displays command-line usage help to standard output. + """ + print("") + print("%s v%s" % (APPLICATION_NAME, APPLICATION_VERSION)) + print("Copyright (C) %i, %s (%s)." % (max(2014, date.today().year), APPLICATION_AUTHOR, APPLICATION_AUTHOR_EMAIL)) + print("This software comes with ABSOLUTELY NO WARRANTY.") + print("") + self.display_usage() + print("PARAMETERS:") + print(" : Name of an existing protocol") + print(" : Field by field specification of non-existing protocol") + print("OPTIONS:") + print(" -b, --bits : Number of bits per line") + print(" -f, --file : Read specs from a text file") + print(" -h, --help : Displays this help information") + print(" -n, --no-numbers : Do not print bit numbers on top of the header") + print(" -V, --version : Displays current version") + print(" --evenchar : Character for the even positions of horizontal table borders") + print(" --oddchar : Character for the odd positions of horizontal table borders") + print(" --startchar : Character that starts horizontal table borders") + print(" --endchar : Character that ends horizontal table borders") + print(" --sepchar : Character that separates protocol fields") + + + def get_usage(self): + """ + @return a string containing application usage information + """ + return "Usage: %s { or } [OPTIONS]" % self.cmd_line_args[0] + + + def display_usage(self): + """ + Prints usage information to standard output + """ + print(self.get_usage()) + + + def parse_config_file(self, filename): + """ + This method parses the supplied configuration file and adds any protocols to our + list of protocols to print. + @return The number of protocols parsed + """ + + i=0 + # Read the contents of the whole file + try: + f = open(filename) + lines = f.readlines() + f.close() + except: + print("Error while reading file %s. Please make sure it exists and it's readable." % filename) + sys.exit(1) + + # Parse protocol specs, line by line + for line in lines: + # Sanitize the line + line=line.strip() + + # If it starts with #, or is an empty line ignore it + if line.startswith("#") or len(line)==0: + continue + + # If we have something else, treat it as a protocol spec + proto=Protocol(line) + self.protocols.append(proto) + i+=1 + + return i + + + def parse_cmd_line_args(self, argv, is_config_file=False): + """ + Parses command-line arguments and stores any relevant information + internally + """ + + # Store a reference to command line args for later use. + if is_config_file==False: + self.cmd_line_args = argv + + # Check we have received enough command-line parameters + if len(argv) == 1 and is_config_file is False: + print(self.get_usage()) + sys.exit(1) + else: + skip_arg=False + for i in range(1, len(argv)): + + # Useful for args like -c . This avoids parsing the + # filename as it if was a command-line flag. + if skip_arg==True: + skip_arg=False + continue + + # Spec file + if argv[i]=="-f" or argv[i]=="--file": + # Make sure we have an actual parameter after the flag + if (i+1)>=len(argv): + return OP_FAILURE, "Expected parameter after %s\n%s" % (argv[i], self.get_usage()) + skip_arg=True + # Parse the config file + protos = self.parse_config_file(argv[i+1]) + if protos <= 0: + return OP_FAILURE, "No protocol specifications found in the supplied file (%s)" % argv[i+1] + + # Bits per line + elif argv[i]=="-b" or argv[i]=="--bits": + # Make sure we have an actual parameter after the flag + if (i+1)>=len(argv): + return OP_FAILURE, "Expected parameter after %s\n%s" % (argv[i], self.get_usage()) + skip_arg=True + # Parse the config file + try: + self.bits_per_line=int(argv[i+1]) + if self.bits_per_line<=0: + return OP_FAILURE, "Invalid number of bits per line supplied (%s)" % argv[i+1] + except: + return OP_FAILURE, "Invalid number of bits per line supplied (%s)" % argv[i+1] + + # Avoid displaying numbers on top of the header + elif argv[i]=="-n" or argv[i]=="--no-numbers": + self.skip_numbers=True + + # Character variations + elif argv[i] in ["--oddchar", "--evenchar", "--startchar", "--endchar", "--sepchar"]: + # Make sure we have an actual parameter after the flag + if (i+1)>=len(argv): + return OP_FAILURE, "Expected parameter after %s\n%s" % (argv[i], self.get_usage()) + skip_arg=True + + # Make sure we got a single character, not more + if len(argv[i+1])!=1: + return OP_FAILURE, "A single character is expected after %s\n%s" % (argv[i], self.get_usage()) + + # Now let's store whatever character spec we got + if argv[i]=="--oddchar": + self.hdr_char_fill_odd=argv[i+1] + elif argv[i]=="--evenchar": + self.hdr_char_fill_even=argv[i+1] + elif argv[i]=="--startchar": + self.hdr_char_start=argv[i+1] + elif argv[i]=="--endchar": + self.hdr_char_end=argv[i+1] + elif argv[i]=="--sepchar": + self.hdr_char_sep=argv[i+1] + + # Display help + elif argv[i]=="-h" or argv[i]=="--help": + self.display_help() + sys.exit(0) + + # Display version + elif argv[i]=="-V" or argv[i]=="--version": + print("%s v%s" % (APPLICATION_NAME, APPLICATION_VERSION)) + sys.exit(0) + + # Incorrect option supplied + elif argv[i].startswith("-"): + print("ERROR: Invalid option supplied (%s)" % argv[i]) + sys.exit(1) + + # Protocol name or protocol spec + else: + # If it contains ":" characters, we have a protocol spec + if argv[i].count(":")>0: + spec = argv[i] + # Otherwise, the user meant to display an existing protocol + else: + # If we got an exact match, end of story + if argv[i] in specs.protocols: + spec = specs.protocols[argv[i]] + # Otherwise, we may have received a partial match so + # we need to figure out which protocol the user meant. + # If the specification is ambiguous, we will error + else: + start_with_the_same=[] + for spec in specs.protocols: + if spec.startswith(argv[i]): + start_with_the_same.append(spec) + # If we only have one entry, it means we got some + # shortened version of the protocol name but no + # ambiguity. In that case, we will use the match. + if len(start_with_the_same)==1: + spec=specs.protocols[start_with_the_same[0]] + elif len(start_with_the_same)==0: + print("ERROR: supplied protocol '%s' does not exist." % argv[i]); + sys.exit(1) + else: + print("Ambiguous protocol specifier '%s'. Did you mean any of these?" % argv[i]) + for spec in start_with_the_same: + print(" %s" % spec) + sys.exit(1) + # Finally, based on the spec, instance an actual protocol. + # Note that if the spec is incorect, the Protocol() consutrctor + # will call sys.exit() itself, so there is no need to do + # error checking here. + try: + proto = Protocol(spec) + self.protocols.append(proto) + except ProtocolException as e: + print("ERROR: %s" % str(e)) + sys.exit(1) + + if len(self.protocols)==0: + print("ERROR: Missing protocol") + sys.exit(1) + + return OP_SUCCESS, None + + + + def run(self): + """ + This is Protocol's 'core' method: parses command line argument and prints + any necessary protocol to standard output + """ + + # Parse command-line arguments + code, err = self.parse_cmd_line_args(sys.argv) + if code!=OP_SUCCESS: + print("ERROR: %s" % err) + sys.exit(1) + + # Print the appropriate protocol headers + for i in range(0, len(self.protocols)): + + # Modify the properties of the object if the user passed any + # options that require it + if self.bits_per_line is not None: + self.protocols[i].bits_per_line = self.bits_per_line + if self.skip_numbers is not None: + if self.skip_numbers is True: + self.protocols[i].do_print_top_tens=False + self.protocols[i].do_print_top_units=False + else: + self.protocols[i].do_print_top_tens=True + self.protocols[i].do_print_top_units=True + if self.hdr_char_end is not None: + self.protocols[i].hdr_char_end=self.hdr_char_end + if self.hdr_char_start is not None: + self.protocols[i].hdr_char_start=self.hdr_char_start + if self.hdr_char_fill_even is not None: + self.protocols[i].hdr_char_fill_even=self.hdr_char_fill_even + if self.hdr_char_fill_odd is not None: + self.protocols[i].hdr_char_fill_odd=self.hdr_char_fill_odd + if self.hdr_char_sep is not None: + self.protocols[i].hdr_char_sep=self.hdr_char_sep + + print(self.protocols[i]) + if len(self.protocols)>1 and i!=len(self.protocols)-1: + print("") + + +# Main function +def main(): + """ + Main function. Runs the Protocol program. + """ + + # Instance our core class + program = Main() + + # Do our magic + program.run() + + +# THIS IS THE START OF THE EXECUTION +if __name__ == "__main__": + main() diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..56e649e --- /dev/null +++ b/setup.py @@ -0,0 +1,62 @@ +#!/usr/bin/python +################################################################################ +# ____ _ _ # +# | _ \ _ __ ___ | |_ ___ ___ ___ | | # +# | |_) | '__/ _ \| __/ _ \ / __/ _ \| | # +# | __/| | | (_) | || (_) | (_| (_) | | # +# |_| |_| \___/ \__\___/ \___\___/|_| # +# # +# == A Simple ASCII Header Generator for Network Protocols == # +# # +################################################################################ +# # +# Written by: # +# # +# Luis MartinGarcia. # +# -> E-Mail: luis.mgarc@gmail.com # +# -> WWWW: http://www.luismg.com # +# -> GitHub: https://github.com/luismartingarcia # +# # +################################################################################ +# # +# This file is part of Protocol. # +# # +# Copyright (C) 2014 Luis MartinGarcia (luis.mgarc@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 # +# (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 . # +# # +# Please check file LICENSE.txt for the complete version of the license, # +# as this disclaimer does not contain the full information. Also, note # +# that although Protocol is licensed under the GNU GPL v3 license, it may # +# be possible to obtain copies of it under different, less restrictive, # +# alternative licenses. Requests will be studied on a case by case basis. # +# If you wish to obtain Protocol under a different license, please contact # +# the email address mentioned above. # +# # +################################################################################ +# # +# Description: # +# # +# This is the installer script for Protocol. This can be run from the # +# command-line as follows: # +# # +# sudo ./setup.py install # +# # +################################################################################ + +from distutils.core import setup, Extension +setup(name='protocol', + version='0.1', + scripts=['protocol', 'constants.py', 'specs.py'] + ) diff --git a/specs.py b/specs.py new file mode 100644 index 0000000..bd1332c --- /dev/null +++ b/specs.py @@ -0,0 +1,736 @@ +################################################################################ +# ____ _ _ # +# | _ \ _ __ ___ | |_ ___ ___ ___ | | # +# | |_) | '__/ _ \| __/ _ \ / __/ _ \| | # +# | __/| | | (_) | || (_) | (_| (_) | | # +# |_| |_| \___/ \__\___/ \___\___/|_| # +# # +# == A Simple ASCII Header Generator for Network Protocols == # +# # +################################################################################ +# # +# Written by: # +# # +# Luis MartinGarcia. # +# -> E-Mail: luis.mgarc@gmail.com # +# -> WWWW: http://www.luismg.com # +# -> GitHub: https://github.com/luismartingarcia # +# # +################################################################################ +# # +# This file is part of Protocol. # +# # +# Copyright (C) 2014 Luis MartinGarcia (luis.mgarc@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 # +# (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 . # +# # +# Please check file LICENSE.txt for the complete version of the license, # +# as this disclaimer does not contain the full information. Also, note # +# that although Protocol is licensed under the GNU GPL v3 license, it may # +# be possible to obtain copies of it under different, less restrictive, # +# alternative licenses. Requests will be studied on a case by case basis. # +# If you wish to obtain Protocol under a different license, please contact # +# the email address mentioned above. # +# # +################################################################################ +# # +# Description: # +# # +# This file contains popular protocol specs. # +# # +################################################################################ + +# +# 0 1 2 3 4 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Source Address | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Destination Address | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | EtherType | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + Payload + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +ethernet="Source Address:48,Destination Address:48,EtherType:16,Payload:128?bits=48" + + +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Source Address | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Destination Address | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | TPID (0x8100) | PCP |D| VLAN ID | EtherType | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + Payload + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +dot1q="Source Address:48,Destination Address:48,TPID (0x8100):16,PCP:3,D:1,\ +VLAN ID:12,EtherType:16,Payload:96?bits=48" + + +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Source Port | Destination Port | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Sequence Number | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Acknowledgment Number | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Offset| Res. | Flags | Window | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Checksum | Urgent Pointer | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Options | Padding | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | data | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +tcp="Source Port:16,Destination Port:16,Sequence Number:32,\ +Acknowledgment Number:32,Offset:4,Res.:4,Flags:8,Window:16,Checksum:16,\ +Urgent Pointer:16,Options:24,Padding:8" + + +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Source Port | Destination Port | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Length | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +udp="Source Port:16,Destination Port:16,Length:16,Checksum:16" + + +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# |Version| IHL |Type of Service| Total Length | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Identification |Flags| Fragment Offset | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Time to Live | Protocol | Header Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Source Address | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Destination Address | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Options | Padding | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +ip="Version:4,IHL:4,Type of Service:8,Total Length:16,Identification:16,\ +Flags:3,Fragment Offset:13,Time to Live:8,Protocol:8,Header Checksum:16,\ +Source Address:32,Destination Address:32,Options:24,Padding:8" + +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# |Version| Traffic Class | Flow Label | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Payload Length | Next Header | Hop Limit | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + + +# | | +# + Source Address + +# | | +# + + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + + +# | | +# + Destination Address + +# | | +# + + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +ipv6="Version:4,Traffic Class:8,Flow Label:20,Payload Length:16,Next Header:8,\ +Hop Limit:8, Source Address:128, Destination Address:128" + + +# ICMPv4 Generic Header +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + Message Body + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +icmp="Type:8,Code:8,Checksum:16,Message Body:64" + + +# ICMPv4 Destination Unreachable Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | unused | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Internet Header + 64 bits of Original Data Datagram | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +icmp_destination="Type:8,Code:8,Checksum:16,Unused:32,Internet Header + 64 bits\ + of Original Data Datagram:64" + + +# ICMPv4 Time Exceeded Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | unused | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Internet Header + 64 bits of Original Data Datagram | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +icmp_time="Type:8,Code:8,Checksum:16,Unused:32,Internet Header + 64 bits of\ + Original Data Datagram:64" + + +# ICMPv4 Parameter Problem Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Pointer | unused | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Internet Header + 64 bits of Original Data Datagram | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +icmp_parameter="Type:8,Code:8,Checksum:16,Pointer:8,Unused:24,Internet Header\ + + 64 bits of Original Data Datagram:64" + + +# ICMPv4 Source Quench Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | unused | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Internet Header + 64 bits of Original Data Datagram | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +icmp_source="Type:8,Code:8,Checksum:16,Unused:32,Internet Header + 64 bits of\ + Original Data Datagram:64" + + +# ICMPv4 Redirect Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Gateway Internet Address | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Internet Header + 64 bits of Original Data Datagram | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +icmp_redirect="Type:8,Code:8,Checksum:16,Gateway Internet Address:32,Internet\ + Header + 64 bits of Original Data Datagram:64" + + +# ICMPv4 Echo or Echo Reply Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Identifier | Sequence Number | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Data ... +# +-+-+-+-+- +icmp_echo="Type:8,Code:8,Checksum:16,Identifier:16,Sequence Number:16,Data:64" + + +# ICMPv4 Timestamp or Timestamp Reply Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Identifier | Sequence Number | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Originate Timestamp | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Receive Timestamp | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Transmit Timestamp | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +icmp_timestamp="Type:8,Code:8,Checksum:16,Identifier:16,Sequence Number:16,\ +Originate Timestamp:32,Receive Timestamp:32,Transmit Timestamp:32" + + +# ICMPv4 Information Request or Information Reply Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Identifier | Sequence Number | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +icmp_information="Type:8,Code:8,Checksum:16,Identifier:16,Sequence Number:16" + + +# ICMPv6 General Format +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + Message Body + +# | | +icmpv6="Type:8,Code:8,Checksum:16,Message Body:64" + + +# ICMPv6 Destination Unreachable Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Unused | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Invoking packet data (without exceeding minimum IPv6 MTU) | +# + as possible without the ICMPv6 packet + +# | exceeding the minimum IPv6 MTU [IPv6] | +icmpv6_destination="Type:8,Code:8,Checksum:16,Unused:32,Invoking packet data\ + (without exceeding minimum IPv6 MTU):64" + + +# ICMPv6 Packet Too Big Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | MTU | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | As much of invoking packet | +# + as possible without the ICMPv6 packet + +# | exceeding the minimum IPv6 MTU [IPv6] | +icmpv6_big="Type:8,Code:8,Checksum:16,MTU:32,Invoking packet data (without\ + exceeding minimum IPv6 MTU):64" + + +# ICMPv6 Time Exceeded Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Unused | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | As much of invoking packet | +# + as possible without the ICMPv6 packet + +# | exceeding the minimum IPv6 MTU [IPv6] | +icmpv6_time="Type:8,Code:8,Checksum:16,Unused:32,Invoking packet data (without\ + exceeding minimum IPv6 MTU):64" + + +# ICMPv6 Parameter Problem Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Pointer | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | As much of invoking packet | +# + as possible without the ICMPv6 packet + +# | exceeding the minimum IPv6 MTU [IPv6] | +icmpv6_parameter="Type:8,Code:8,Checksum:16,Pointer:32,Invoking packet data\ + (without exceeding minimum IPv6 MTU):64" + + +# ICMPv6 Echo Request and Reply Message +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Identifier | Sequence Number | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Data ... +# +-+-+-+-+- +icmpv6_echo="Type:8,Code:8,Checksum:16,Identifier:16,Sequence Number:16,Data:64" + + +# ICMPv6 Router Solicitation Message Format +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Reserved | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Options ... +# +-+-+-+-+-+-+-+-+-+-+-+- +icmpv6_rsol="Type:8,Code:8,Checksum:16,Reserved:32,Options:64" + + +# ICMPv6 Router Advertisement Message Format +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Cur Hop Limit |M|O| Reserved | Router Lifetime | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Reachable Time | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Retrans Timer | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Options ... +# +-+-+-+-+-+-+-+-+-+-+-+- +icmpv6_radv="Type:8,Code:8,Checksum:16,Cur Hop Limit:8,M:1,O:1,Reserved:6,\ +Router Lifetime:16,Reachable Time:32,Retransmission Timer:32,Options:64" + + +# ICMPv6 Neighbor Solicitation Message Format +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Reserved | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + + +# | | +# + Target Address + +# | | +# + + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Options ... +# +-+-+-+-+-+-+-+-+-+-+-+- +icmpv6_nsol="Type:8,Code:8,Checksum:16,Reserved:32,Target Address:128,\ +Options:64" + + +# ICMPv6 Neighbor Advertisement Message Format +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# |R|S|O| Reserved | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + + +# | | +# + Target Address + +# | | +# + + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Options ... +# +-+-+-+-+-+-+-+-+-+-+-+- +icmpv6_nadv="Type:8,Code:8,Checksum:16,R:1,S:1,O:1,Reserved:29,Target\ + Address:128,Options:64" + + +# ICMPv6 Redirect Message Format +# +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Type | Code | Checksum | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Reserved | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + + +# | | +# + Target Address + +# | | +# + + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | +# + + +# | | +# + Destination Address + +# | | +# + + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Options ... +# +-+-+-+-+-+-+-+-+-+-+-+- +icmpv6_redirect="Type:8,Code:8,Checksum:16,Reserved:32,Target Address:128,\ +Destination Address:128,Options:64" + + +# 0 1 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 +# *-------------------------------* +# | Field4| Field4| Field8 | +# *-------------------------------* +# | Field16 | +# *-------------------------------* +# | | +# * Field32 * +# | | +# *-------------------------------* +# | | +# * * +# | | +# * Field64 * +# | | +# * * +# | | +# *-------------------------------* +example="Field4:4,Field4:4,Field8:8,Field16:16,Field32:32,Field64:64?bits=16,\ +numbers=y,startchar=*,endchar=*,evenchar=-,oddchar=-,sepchar=|" + + +# 0 1 2 3 +# 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# |F|Field_4| Field_7 | Field_10 | Field_13 | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | Field_16 | Field_19 | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | Field_22 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Field_25 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Field_28 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Field_31 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | Field_34 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+ +# | Field_37 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +-+ +# | Field_40 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_43 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +# | Field_46 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_49 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+ +-+-+-+ +# | Field_52 | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_55 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_58 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_61 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_64 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_67 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_70 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | Field_73 | +# + +-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | Field_76 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+ + +# | Field_79 | +# + +-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | Field_82 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+ + +# | Field_85 | +# + +-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | Field_88 | +# + +-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | Field_91 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | Field_94 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | Field_97 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | Field_100 | +# + +-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | Field_103 | +# + +-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | | +# + + +# | Field_106 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+ + +# | | +# + + +# | Field_109 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | | +# + + +# | Field_112 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+ + +# | | +# + + +# | Field_115 | +# + +-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | | +# + + +# | Field_118 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+-+-+-+-+-+-+-+ + +# | | +# + + +# | | +# + + +# | Field_121 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+-+-+-+-+ + +# | | +# + + +# | | +# + + +# | Field_124 | +# + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +# | | | +# +-+ + +# | | +# + + +# | Field_127 | +# + + +# | | +# +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +test="Field_1:1,Field_4:4,Field_7:7,Field_10:10,Field_13:13,Field_16:16,\ +Field_19:19,Field_22:22,Field_25:25,Field_28:28,Field_31:31,Field_34:34,\ +Field_37:37,Field_40:40,Field_43:43,Field_46:46,Field_49:49,Field_52:52,\ +Field_55:55,Field_58:58,Field_61:61,Field_64:64,Field_67:67,Field_70:70,\ +Field_73:73,Field_76:76,Field_79:79,Field_82:82,Field_85:85,Field_88:88,\ +Field_91:91,Field_94:94,Field_97:97,Field_100:100,Field_103:103,Field_106:106,\ +Field_109:109,Field_112:112,Field_115:115,Field_118:118,Field_121:121,\ +Field_124:124,Field_127:127" + + +# Dictionary of specs +protocols={"ethernet":ethernet, + "8021q":dot1q, + "dot1q":dot1q, + "tcp":tcp, + "udp":udp, + "ip":ip, + "ipv6":ipv6, + "icmp":icmp, + "icmp-destination":icmp_destination, + "icmp-time":icmp_time, + "icmp-parameter":icmp_parameter, + "icmp-source":icmp_source, + "icmp-redirect":icmp_redirect, + "icmp-echo":icmp_echo, + "icmp-timestamp":icmp_timestamp, + "icmp-information":icmp_information, + "icmpv6":icmpv6, + "icmpv6-destination":icmpv6_destination, + "icmpv6-big":icmpv6_big, + "icmpv6-time":icmpv6_time, + "icmpv6-parameter":icmpv6_parameter, + "icmpv6-echo":icmpv6_echo, + "icmpv6-rsol":icmpv6_rsol, + "icmpv6-radv":icmpv6_radv, + "icmpv6-nsol":icmpv6_nsol, + "icmpv6-nadv":icmpv6_nadv, + "icmpv6-redirect":icmpv6_redirect, + "example":example, + "test":test + } + diff --git a/test.py b/test.py new file mode 100755 index 0000000..fc6fd51 --- /dev/null +++ b/test.py @@ -0,0 +1,321 @@ +#!/usr/bin/python +################################################################################ +# ____ _ _ # +# | _ \ _ __ ___ | |_ ___ ___ ___ | | # +# | |_) | '__/ _ \| __/ _ \ / __/ _ \| | # +# | __/| | | (_) | || (_) | (_| (_) | | # +# |_| |_| \___/ \__\___/ \___\___/|_| # +# # +# == A Simple ASCII Header Generator for Network Protocols == # +# # +################################################################################ +# # +# Written by: # +# # +# Luis MartinGarcia. # +# -> E-Mail: luis.mgarc@gmail.com # +# -> WWWW: http://www.luismg.com # +# -> GitHub: https://github.com/luismartingarcia # +# # +################################################################################ +# # +# This file is part of Protocol. # +# # +# Copyright (C) 2014 Luis MartinGarcia (luis.mgarc@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 # +# (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 . # +# # +# Please check file LICENSE.txt for the complete version of the license, # +# as this disclaimer does not contain the full information. Also, note # +# that although Protocol is licensed under the GNU GPL v3 license, it may # +# be possible to obtain copies of it under different, less restrictive, # +# alternative licenses. Requests will be studied on a case by case basis. # +# If you wish to obtain Protocol under a different license, please contact # +# the email address mentioned above. # +# # +################################################################################ +# # +# Description: # +# # +# Unit tests for the "protocol" tool # +# # +################################################################################ + +# STANDARD LIBRARY IMPORTS +import imp +import unittest + +# IMPORT PROTOCOL (need to use the imp library since "protocol" does not +# have a .py extension +protocol = imp.load_source("protocol", "protocol") + +# List of test cases. It contains tuples of the form (protocol_spec, expected_output) +validcases=[ + +("Field_32:32", +""" 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_8:8,Field_8:8,Field_8:8,Field_8:8?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_8 | Field_8 | Field_8 | Field_8 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_16:16,Field_16:16?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_16 | Field_16 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_16:16,Field_8:8,Field_8:8?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_16 | Field_8 | Field_8 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_32:32?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_16:16?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_16 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_24:24?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_24 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_31:31?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_31 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_33:33?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_33 | ++ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| | ++-+"""), + +("Field_32:32,Field_39:39?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_39 | ++ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| | ++-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_56:56?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_56 | ++ +-+-+-+-+-+-+-+-+ +| | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_16:16,Field_33:33?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_16 | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_33 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_16:16,Field_56:56?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_16 | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +| Field_56 | ++ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| | ++-+-+-+-+-+-+-+-+"""), + +("Field_32:32,Field_16:16,Field_32:32?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_16 | Field_32 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_8:8,Field_8:8,Field_8:8,Field_8:8,Field_12:12,Field_17:17,Field_22:22,Field_8:8,Field_5:5?numbers=0", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_8 | Field_8 | Field_8 | Field_8 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_12 | Field_17 | | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_22 | Field_8 | Field_5 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_16:16,Field_8:8,Field_8:8?numbers=0,bits=16", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_16 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_8 | Field_8 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_16:16,Field_32:32?numbers=0,bits=16", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_16 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| | ++ Field_32 + +| | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_64:64?numbers=0,bits=16", +"""+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| | ++ + +| | ++ Field_64 + +| | ++ + +| | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_64:64?bits=64", +""" 0 1 2 3 4 5 6 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Field_64 | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Source Port:16,Destination Port:16,Sequence Number:32,\ +Acknowledgment Number:32,Offset:4,Res.:4,Flags:8,Window:16,Checksum:16,\ +Urgent Pointer:16,Options:24,Padding:8", +""" 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Source Port | Destination Port | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Sequence Number | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Acknowledgment Number | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Offset| Res. | Flags | Window | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Checksum | Urgent Pointer | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Options | Padding | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"""), + +("Field_32:32?numbers=0,startchar=1,endchar=2,oddchar=3,evenchar=4,sepchar=5", +"""14343434343434343434343434343434343434343434343434343434343434342 +5 Field_32 5 +14343434343434343434343434343434343434343434343434343434343434342"""), + +] + + +# List of invalid test cases. It contains incorrect protocol specs. +invalidcases=[ +"Field_64:64?bits=", +"Field_64:64?bits=A", +"Field_64:64?bits=0", +"Field_64:64?bits=-1", +"Field_64:0", +"Field_64:-1", +"Field_8:8,Field_8:0", +"Field_32:32?numbers=X", +"Field_32:32?numbers=", +"Field_32:32?startchar", +"Field_32:32?startchar=", +"Field_32:32?startchar=AAA", +"Field_32:32?endchar", +"Field_32:32?endchar=", +"Field_32:32?endchar=AAA", +"Field_32:32?oddchar", +"Field_32:32?oddchar=", +"Field_32:32?oddchar=AAA", +"Field_32:32?evenchar", +"Field_32:32?evenchar=", +"Field_32:32?evenchar=AAA", +"Field_32:32?sepchar", +"Field_32:32?sepchar=", +"Field_32:32?sepchar=AAA", +"Field_32:32?unknown", +"Field_32:32?", +"Field_32:32FieldThatContains?Sign", +"Field_32:32?sepchar=A,", +"Field_32:32,Field_8?sepchar=A,", +"Field_32:32,Field_8:?sepchar=A,", +"Field_32:32,Field_8:12,?sepchar=A," +] + + +class ProtocolTests(unittest.TestCase): + + def test_regular_specs(self): + """ + This function tests correctness for a number of known specs. It + instances a Protocol() passing a particular expect and then it compares + the str() of the instance with the expected ASCII protocol header. + """ + for i in range(0, len(validcases)): + print("Testing Valid Spec '%s'" % validcases[i][0]) + p = protocol.Protocol(validcases[i][0]) + self.assertEqual(str(p), validcases[i][1]) + + def test_invalid_specs(self): + """ + This function tests the Protocol class for input validation. A number of + invalid specs are passed. The constructor of the class is expected to raise + the appropriate exceptions. + """ + for i in range(0, len(invalidcases)): + print("Testing Invalid Spec '%s'" % invalidcases[i]) + self.assertRaises(protocol.ProtocolException, protocol.Protocol, invalidcases[i]) + +if __name__ == '__main__': + # Print our fancy ASCII header + print("#########################################################################") + print("# ____ _ _ #") + print("# | _ \ _ __ ___ | |_ ___ ___ ___ | | #") + print("# | |_) | '__/ _ \| __/ _ \ / __/ _ \| | #") + print("# | __/| | | (_) | || (_) | (_| (_) | | #") + print("# |_| |_| \___/ \__\___/ \___\___/|_| #") + print("# #") + print('# == "Protocol" Test Suite == #') + print("# #") # + print("#########################################################################") + # Run the actual tests + unittest.main() + +