pax_global_header00006660000000000000000000000064132424420040014505gustar00rootroot0000000000000052 comment=cf6676a62a307757c2042352fab68be5523f2349 python-libtrace-master/000077500000000000000000000000001324244200400154465ustar00rootroot00000000000000python-libtrace-master/.gitignore000066400000000000000000000001321324244200400174320ustar00rootroot00000000000000build dist env *.egg-info *.pyc *.pyo *.log *~ \#*# *.out *.swp *.swo *.autosave .idea python-libtrace-master/INSTALL.md000066400000000000000000000053251324244200400171030ustar00rootroot00000000000000# INSTALL instructions for python-libtrace ## Installing python-libtrace ## Quick Start for Ubuntu 14.04/16.04 ```bash sudo apt install libtrace-dev libldns-dev git clone https://github.com/nevil-brownlee/python-libtrace.git cd python-libtrace sudo make install-py2 # for python 2 ``` ## Detailed install instructions Requirements: * python 2.7 or later, 3.4 or later * libtrace 3.0.21 or later (http://research.wand.net.nz/software/libtrace.php) * ldns, which requires an up-to-date version of openssl (libldns-dev) Check that you have the right version of libtrace, python, openssl and ldns (as listed above). For openssl, you may need to create a symbolic link in /usr/include, something like this: ``` ln -s /home/nevil/openssl-1.0.1j/include/openssl /usr/include/openssl ``` Then: ``` git clone https://github.com/nevil-brownlee/python-libtrace.git cd python-libtrace make install-py2 # for python 2 # or make install-py3 # for python 3 ``` The above series of commands will build python-libtrace and install it into the place where python expects to find extension modules on your system. python-libtrace can be built for both python 2 and 3. You'll probably need to use sudo for the make install step. The library comes with a set of test cases. You can run them to make sure the installation is complete. They are also useful, if you want to make changes to the library. In this case, they can be used to make sure your changes did not break anything in the library. Testing ------- To run the tests, go to the 'test' subdirectory and run the script 'run_test' as follows for _python 2_: ```bash export TZ=Pacific/Auckland # Get the times right for trace file packets cd test python run_test.py -d v2-test-cases/ -t ``` Similar set of test cases exists in 'v3-test-cases' subdirectory. If you use _python 3_, you can use those test cases and run them using run_test as follows: ```bash cd test python3 run_test.py -d v3-test-cases/ -t ``` This command runs all test programs and reports the results. All tests should pass to make sure the library works properly. Using python-libtrace --------------------- The best source of information on how to use libtrace and the tools that come with it is the libtrace wiki located at http://www.wand.net.nz/trac/libtrace/wiki python-libtrace is documented in a set of html pages in the doc subdirectory of the distribution. A set of example programs is included in the doc/examples subdirectory. You should install these documentation files on a suitable webserver at your site or you can view them at http://www.cs.auckland.ac.nz/~nevil/python-libtrace Nevil Brownlee Email for queries or comments: n.brownlee@auckland.ac.nz -------------------------------------------------------------- python-libtrace-master/LICENSE.md000066400000000000000000001046341324244200400170620ustar00rootroot00000000000000GNU GENERAL PUBLIC LICENSE ========================== Version 3, 29 June 2007 ========================== > Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. # Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. # TERMS AND CONDITIONS ## 0. Definitions. _"This License"_ refers to version 3 of the GNU General Public License. _"Copyright"_ also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. _"The Program"_ refers to any copyrightable work licensed under this License. Each licensee is addressed as _"you"_. _"Licensees"_ and "recipients" may be individuals or organizations. To _"modify"_ a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a _"modified version"_ of the earlier work or a work _"based on"_ the earlier work. A _"covered work"_ means either the unmodified Program or a work based on the Program. To _"propagate"_ a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To _"convey"_ a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. ## 1. Source Code. The _"source code"_ for a work means the preferred form of the work for making modifications to it. _"Object code"_ means any non-source form of a work. A _"Standard Interface"_ means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The _"System Libraries"_ of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The _"Corresponding Source"_ for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. ## 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. ## 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. ## 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. ## 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. ## 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A _"User Product"_ is either (1) a _"consumer product"_, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. _"Installation Information"_ for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. ## 7. Additional Terms. _"Additional permissions"_ are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. ## 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. ## 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. ## 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An _"entity transaction"_ is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. ## 11. Patents. A _"contributor"_ is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's _"essential patent claims"_ are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. ## 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. ## 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. ## 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. ## 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. ## 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. ## 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. # END OF TERMS AND CONDITIONS -------------------------------------------------------------------------- # How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free software, and you are welcome to redistribute it under certain conditions; type 'show c' for details. The hypothetical commands _'show w'_ and _'show c'_ should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read .python-libtrace-master/Makefile000066400000000000000000000033471324244200400171150ustar00rootroot00000000000000# 1410, Sat 15 Mar 14 (PDT) # # Main Makefile for the python-libtrace distribution. # # python-libtrace: a python module to make it easy to use libtrace # Copyright (C) 2017 by Nevil Brownlee, U Auckland | WAND # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . SHELL=/bin/sh RM=rm -rf # Don't complain if files don't exist T_MAKE= make BKFILES=build *~ \#* .*~ VERSION= .PHONY: all clean distclean install build: cd lib/ipp; python$(VERSION) ipp-setup.py build cd lib/plt; python$(VERSION) plt-setup.py build cd lib/natkit; python$(VERSION) natkit-setup.py build cd lib/pldns; python$(VERSION) pldns-setup.py build install: build cd lib/ipp; python$(VERSION) ipp-setup.py install cd lib/plt; python$(VERSION) plt-setup.py install cd lib/natkit; python$(VERSION) natkit-setup.py install cd lib/pldns; python$(VERSION) pldns-setup.py install @./verify_install.sh $(VERSION) clean: cd lib/ipp; $(RM) $(BKFILES) cd lib/plt; $(RM) $(BKFILES) cd lib/natkit; $(RM) $(BKFILES) cd lib/pldns; $(RM) $(BKFILES) distclean: clean $(RM) $(BKFILES) py2: @make VERSION=2 build py3: @make VERSION=3 build install-py2: @make VERSION=2 install install-py3: @make VERSION=3 install python-libtrace-master/README.md000066400000000000000000000025431324244200400167310ustar00rootroot00000000000000# python-libtrace A Cpython module to make the [libtrace library](http://research.wand.net.nz/software/libtrace.php) available to Python2 and/or python3 python-libtrace is not a complete set of all the libtrace routines, rather it's a somewhat simplified set, intended as an easy-to-use toolkit, and one that should be suitable for networking students. It use (more or less) the original field names within the various header decodes. For installation and usage instructions see: [INSTALL.md](INSTALL.md) Any user feedback - bug reports, suggestions for improvements, etc - is welcome. Please email Nevil Brownlee: n.brownlee@auckland.ac.nz Copyright (c) 2015, Nevil Brownlee, U Auckland | WAND This code is licensed under the GNU General Public License (GPL) version 3. Please see the included file GPL [LICENSE.md](LICENSE.md) for details of this license. This code is a set of Python bindings for libtrace, whose copyright notice appears below. --------------------------------------------------------------------------- Copyright (c) 2007-2008 The University of Waikato, Hamilton, New Zealand. All rights reserved. This code has been developed by the University of Waikato WAND research group. For further information please see http://www.wand.net.nz/. --------------------------------------------------------------------------- python-libtrace-master/copyright-update.py000066400000000000000000000023741324244200400213160ustar00rootroot00000000000000#!/usr/bin/env python # Copyright (C) 2017 by Nevil Brownlee, U Auckland | WAND import glob, re, os def find_copyright(fn): #f = open(fn+".new", "r") f = open(fn, "r") print fn for line in f: if line.find("yright") >= 0: print " %s" % line.strip() f.close() return True f.close() return False def fix_file(fn, yyyy): print fn f = open(fn, "r"); nf = open(fn+".new", "w") for line in f: if line.find("yright") >= 0: #la = line.split('2014') la = re.split("20\d\d", line) print "--- %s" % la if len(la) == 2: nf.write(la[0] + yyyy + la[1]) else: nf.write(line) #print "la = %s" % la else: nf.write(line) nf.close(); f.close() os.rename(fn+".new", fn) def checkfiles(gstr, yyyy): for fn in glob.glob(gstr): find_copyright(fn) fix_file(fn, yyyy) new_yyy = "2017" checkfiles("*.py", new_yyy) checkfiles("*.sh", new_yyy) checkfiles("Makefile", new_yyy) checkfiles("README", new_yyy) checkfiles("lib/*/*.c", new_yyy) checkfiles("lib/*/*.h", new_yyy) checkfiles("test/*/*.py", new_yyy) checkfiles("doc/examples/*.py", new_yyy) python-libtrace-master/doc/000077500000000000000000000000001324244200400162135ustar00rootroot00000000000000python-libtrace-master/doc/Error.html000066400000000000000000000042671324244200400202030ustar00rootroot00000000000000 Libtrace Errors

Handling libtrace errors

Exception plt_exc_libtrace

plt_libtrace_exc  is a subclass of Python's SystemError exception.  Python-libtrace checks for errors during operations on traces, see the Trace and OutputTrace page for further information.

For most purposes you can simply invoke the Trace and OutputTrace methods, knowing that if python-libtrace encounters an error it will throw a LibtraceError and exit, with the Python interpreter printing a diagnostic line to tell you what it thinks caused the problem.
Alternatively, you can catch the exception using a "try-except block," like this:

     try:
          f = plt.trace(ARGV[0])
     except:
          print "helpful message\n"
          sys.exc_clear()

Here, the sys.exc_clear() statement simply clears the exception history.

Nevil Brownlee
Mon, 30 Jun 14 (NZST)

python-libtrace-master/doc/Examples.html000066400000000000000000000122321324244200400206570ustar00rootroot00000000000000 python-libtrace example programs

Example Programs

Some simple programs that demonstrate how to use python-libtrace.

Notes

Source Code

Python source code for all these example programs is supplied in the distribution's doc/examples directory, together with a few example trace files that they read.  
Click on the links below to reach the sources.

Python support code for the example programs

plt_testing.py
A collection of handy functions used in these example programs for things like opening trace files and displaying the contents of python-libtrace objects.

Programs that read and display trace files

IP.py,  ip6.py,  udp.py,  tcp.py,  icmp.py,  icmp6.py.
Demonstrate libtrace's protocol header decodes.

plt-test.py.
Demonstrates packet-level attributes, e.g. ethertype and times.

layers.py
Demonstrates decoding of packets as a series of protocol layers,
and looking at the data in each layer.

arp-anon.py
Reads a trace file, changes 'source' and 'target' IP addresses in ARP records.
Demonstrates using class set methods to change  fields within a Packet

Programs that decapsulate parts of a packet

encap-pkt.py,  encap-pkt.py.
Creates new objects from various parts of IPv4/IPv6 packets, and compares those with their original forms.

Programs that write trace files

copy-first-n.py
Copies the first n records from one trace to another

arp-anon.py
Reads a trace file, changes 'source' and 'target' IP addresses in ARP records.
Demonstrates using class set methods to change  fields within a Packet

sw-filter.py
Looks through a trace for UDP records with source or destination port
53, i.e. DNS records.  Displays their UDP and UDP payload data.

bpf-filter.py
Same as sw-filter.py, but uses a bpf filter 'udp port 53'.   Also demonstrates how to get and print libtrace errors.

change-filter.py
Same as bpf-filter.py, but demonstrates how to catch plt_exc_libtrace exceptions, and how to change a Trace's bpf filter part-way through the trace. Also demonstrates working with the payload from UDP and TCP packets.


Nevil Brownlee
Thu, 15 Mar 14 (PDT) python-libtrace-master/doc/Filter.html000066400000000000000000000030141324244200400203240ustar00rootroot00000000000000 BPF Filters

BPF Filters

Class Filter

Allow you to create BPF filters.  These may be applied to a trace (so as to select a subset of that trace's packets) using trace.conf_filter(), or to an individual packet using packet.apply_filter().
Class Methods
filter()
 filter(filterString) -> aFilter

Creates a BPF filter that wil select packets using the  tcpdump-style filter experssion given in filterString.  For example,  'udp port 53' selects DNS packets.  See the tcpdump man page for the filter expression syntax.

Nevil Brownlee
Mon, 27 Jan 14 (NZDT) python-libtrace-master/doc/Hierarchy.html000066400000000000000000000137221324244200400210240ustar00rootroot00000000000000 Class Hierarchy

Class Hierarchy

libtrace is a C API, i.e.a library of functions that allow you to create Traces and Packets, to read Packets, and to extract 'decodes' for various parts of the Packets, e.g. IP (i.e. IPv4), TDP and UDP headers, etc. That means that in C, you need to keep pointers to each part of the Packet you're interested in.

python-libtrace (plt) provides Python access to libtrace objects via a set of Python classes. Each class has methods that provide access to various libtrace functions, and to fields in libtrace's 'decodes.'   Trace objects read or write libtrace python-libtrace Packets; the Trace class functions only specify details of the trace itself. From the Packet object, the classes are arranged in an inheritance hierarchy, as shown in the diagram below.


Trace



 




  Packet



 




  Layer2



 




Layer3

Internet

 




  IP IP6


 




Transport

TCP UDP ICMP, ICMP6


The important thing about this is that classes at lower levels in the Hierarchy can use all the methods in any of their predecessor classes, i.e. any that can be reached by tracing up the black lines in the diagram.

For example:

  • Packet   provides  .wire_len    (on-the-wire packet length in bytes)
  • Internet  provides  .src_prefix  (IPv4 or IPv6 source address)
  • TCP       provides  .src_port     (TCP source port)
Therefore, classes IP, IPv6, TCP, UDP and ICMP can all use .wire_len and .src_prefix.

If you are writing methods that work on a TCP object, you should use the higher-level methods within your own methods. Doing that means that you don't have to make, for example, an IP6 object within your method - which Python will later have to garbage-collect.

Nevil Brownlee
Mon,  6 Jan 14 (NZDT)

python-libtrace-master/doc/ICMP.html000066400000000000000000000063331324244200400176360ustar00rootroot00000000000000 IProtocol Decodes: ICMP

Network Layer Decodes

Class ICMP

Provides access to fields in an (IPv4) ICMP header.

Instance Variables
type icmp.type -> anInteger

ICMP message type
code icmp.code -> anInteger

ICMP message code
checksum icmp.checksum -> anInteger

ICMP checksum
dataicmp.data -> aByteArray

All the ICMP bytes, i.e. header and payload.  Use this if you need to work with some of the ICMP message types that python-libtrace doesn't decode fully
payloadicmp.payload ->anIP for types 3, 4, 5, 11 and 12, otherwise aByteArray

Most ICMP messages carry some content from the packet that triggered them;  icmp.payload returns as much as it can of the triggering packet

The content of an  (IPv4) ICMP header varies depending on its type field.  python-libtrace decodes the following types ...

Echo Request (type 8) and Echo Reply (type 0)
ident icmp.echo.ident -> anInteger

Echo identifier
sequence  icmp.echo.sequence -> anInteger

Echo sequence number

Redirect (type 5)
gateway icmp.redirect.gateway -> anIPprefix

Returns IPv4 address of the gateway

Nevil Brownlee
Sat, 22 Oct 16 (NZDT)

python-libtrace-master/doc/ICMP6.html000066400000000000000000000110651324244200400177220ustar00rootroot00000000000000 IProtocol Decodes: ICMP6

Network Layer Decodes

Class ICMP6

Provides access to fields in an (IPv6) ICMP header.

Instance Variables
type icmp.type -> anInteger

ICMP message type
code icmp.code -> anInteger

ICMP message code
checksum icmp.checksum -> anInteger

ICMP checksum
dataicmp.data -> aByteArray

All the ICMP bytes, i.e. header and payload.  Use this if you need to work with some of the ICMP message types that python-libtrace doesn't decode fully
payloadicmp.payload ->anIP6 for types 1, 2, 3 and 4, otherwise aByteArray

Some ICMP messages carry content from the packet that triggered them;  icmp6.payload returns as much as it can of the triggering packet

The content of an  (IPv6) ICMP header varies depending on its type field.  python-libtrace decodes the following types ...

Echo Request (type 128) and Echo Reply (type 129)
ident icmp6.echo.ident -> anInteger

Echo identifier
sequence  icmp6.echo.sequence -> anInteger

Echo sequence number

Packet too big (type 2)
mtu icmp6.toobig.mtu -> anInteger

MTU of link causing problem.  Used as part of the Path MTU Discovery process

Parameter problem (type 4)
pointer icmp6.param.pointer-> anInteger

Offset within the invoking packet where an error was detected

Neighbour discovery (types 135-136), Redirect (type 137)
target_prefix icmp6.neighbour.target_prefix -> anIPprefix

IPv6 address of the solicitation's target
dest-prefix icmp6.neighbour.target.dest_prefix -> anIPprefix

Source Address of the packet that triggered the redirect message

Nevil Brownlee
Sat, 22 Oct 16 (NZDT)

python-libtrace-master/doc/IP.html000066400000000000000000000131701324244200400174130ustar00rootroot00000000000000 Protocol Decodes: IP

Network Layer Decodes

Class IP

Provides access to fields in an IPv4 header.   Further, you can see any following IP Options by using  pkt.Layer3;  see the Layers Decode page.


Instance Variables
version ip.version -> anInteger

IP Version, 4 for IPv4
hdr_len ip.hdr_len -> anInteger

IP Header Length, in 4-byte units
traffic_class ip.traffic_class -> anInteger

Originally IPv4 Type-Of-Service, now used for DSCP and ECN.  (Traffic Class is its IPv6 name)
pkt_len ip.pkt_len -> anInteger

Total Length of IP packet
ident ip.iden t-> anInteger

IP Identification
has_rf ip.has_rf -> true or false

True if 'Reserved' IP flag is 1
has_df ip.has_df --> true or false

True if 'Don't Fragment' IP flag is 1
has_mf ip.has_mf -> true or false

True if 'More Fragments' IP flag is 1
frag_offset ip.frag_offset -> anInteger

Fragment Offset, in 8-byte units
ttl ip.ttl -> anInteger

IP Time to Live (TTL)
proto ip.proto -> anInteger

IP Protocol, e.g. 6 = TCP, 17 = UDP, 1 = ICMP
hdr_checksum ip.hdr_checksum -> anInteger

IP Header Checksum
src_prefix ip.src_prefix -> anIPprefix

IPv4 source address
dst_prefix ip.dst_prefix -> anIPprefix

IPv4 destination address
payload ip.payload -> aByteArray

Byte array containing the IP object's payload

A few of the fields in an IP object may be set to new values, as follows:

Class set  Methods
traffic_class= ip.traffic_class = anInteger

Sets the traffic_class value in an IP
ttl= ip.ttl = anInteger

Sets the Time to Live (TTL) in an IP
checksum= ip.checksum = anInteger

Sets Header Checksum in an IP
src_prefix= ip.src_prefix = anIPprefix

Sets the IPv4 source address in an IP
dst_prefix= ip.dst_prefix = anIPprefix

Sets the IPv4 destination address in an IP

Nevil Brownlee
Mon,  30 Jun 14 (NZST)

python-libtrace-master/doc/IP6.html000066400000000000000000000073231324244200400175040ustar00rootroot00000000000000 Protocol Decodes: IP6

Network Layer Decodes

Class IP6

Provides access to fields in an IPv6 header.

Instance Variables
version ip6.version -> anInteger

IP version, 6 for IPv6
traffic_class ip6.traffic_class -> anInteger

IPv6 Traffic Class (DSCP and ECN)
flow_label ip6.flow_label -> anInteger

IPv6 Flow Label (20 bits)
payload_len ip6.payload_len -> anInteger

IPv6 Payload Length (doesn't include the IPv6 header)
next_hdr ip6.next_hdr -> anInteger

IPv6 Next Header; selector for whatever follows the IPv6 header
hop_limit ip6.hop_limit -> anInteger

IPv6 Hop Limit
src_prefix ip6.src_address -> anIPprefix

IPv6 Source Address
dst_prefix ip6.dst_address -> anIPprefix

IPv6 Destination Address
payload ip6.payload -> aByteArray

Byte array containing the IPv6 object's payload

A few of the fields in an IP object may be set to new values, as follows:

Class set  Methods
hop_limit= ip6.hop_limit = anInteger

Sets the hop_limit value in an IP6
src_address= ip6.src_address = anIPprefix

Sets the src_address value in an IP6
dst_address= ip6.dst_address = anIPprefix

Sets the dst_address value in an IP6

Nevil Brownlee
Mon,  30 Jun 14 (NZST)

python-libtrace-master/doc/IPprefix.html000066400000000000000000000200141324244200400206240ustar00rootroot00000000000000 IPprefix

IPprefix Module

This Module (ipp) provides methods to store and use IPv4 and IPv6 addresses.

When you use python-libtrace (import plt),  IPprefix is automatically 
loaded - you don't need to import ipp as well.

Class IPprefix

Represents an IP adress or prefix.

Instance Variables
version 4 for IPv4, 6 for IPv6
addr 4- or 16-byte array containing actual address; the array bytes contain the actual bytes of the address
length Number of bits in prefix. If length is None the IPprefix represents just an IP address

Class Methods
from_s() ipp.from_s(aString)-> aNewIPprefix

Parses str to find version and address, e.g.
   p = ipp.from_s('192.168.1.1')
   p = ipp.from_s('fe80::20d:60ff:fe38:18b/64')
IPprefix -> aString

Returns a string containing a printable version of the IPprefix's address (and /width, if width is not None)
ipp will convert an IPprefix to a python string by calling its (built-in) str() function

Instance Methods
<, <=, ==, >=, >, !=
 IPprefix op OtherIPprefix -> True or False

'Rich compare' operators: comparisions use the versions, addresses and lengths of two IPprefixes.  These can be used to sort IPprefixes into ascending or descending order, IPprefixes with the same addr compare based on their lengths.
IPprefix(v, a)
 IPprefix(version,address) -> aNewIPprefix

Returns an IPprefix conatining an IP address, e.g. 192.168.0.3
   version  = 4 for IPv4, 6 for IPv6
   address = 4- or 16-byte array containing
                    actual address
IPprefix(v, a, len) IPprefix(version, address, length) -> aNewIPprefix

Returns an IPprefix containing a network prefix, e.g. 192.168.0.0/16.
   version, address - as above
   length = number of bits in prefix
version IPprefix.version -> anIinteger
addr IPprefix.addr -> aString
length IPprefix.length-> anIinteger

Read values of the instance variables.
length= IPprefix.length = anInteger -> anIinteger

Sets value for an IPprefix width.

Instance Methods for prefix testing
is_prefix IPprefix .is_prefix(OtherIPprefix) -> True or False

Returns true if this IPprefix is a prefix of OtherIPprefix, i.e. their first IPprefix.length bits are the same.
equal IPprefix.equal(OtherIPprefix) -> True or False

Two IPprefixes are equal if they have the same version and addr.
width IPprefix.width -> anInteger

Returns IPprefix.length - 1
has_bit_set IPprefix.has_bit_set(Integer) -> True or False

Returns true if the bit specified by Integer is 1.
For example, if Integer is 0, has_bit_set is true if the leftmost bit of IPprefix is 1.
first_bit_different IPprefix.first_bit_different(OtherIPprefix) -> anInteger

Returns an Integer, the (0-origin) bit position where the two IPprefixes are different.
complement IPprefix.complement -> OtherIPprefix

Returns the complement of an IPprefix, i.e. one having the same length, but all bits the ones-complement of those in IPprefix.
is_rfc1918 IPprefix.is_rfc1918 -> True or False

Returns True if the IPprefix's address is in the IPv4 range specified in RFC 1918, i.e. in one of the Private prefixes below.

Global Constants
'Private'  prefixes
 See RFC 1918 for more details

ipp.rfc1918s16 192.168.0.0/16

ipp.rfc1918s12 172.16.0.0/12

ipp.rfc1918s8 10.0.0.0/8

Nevil Brownlee
Tue, 4 Nov 14 (NZDT)

python-libtrace-master/doc/Internet.html000066400000000000000000000124041324244200400206720ustar00rootroot00000000000000 Internet

Network Layer Decodes

Class Internet

'Internet' is not a user-accessible class - you can't create an Internet object.  Rather, it's a parent for the IP, IP6, TCP, UDP, ICMP6 and ICMP classes, providing access to the fields in an IP or IP6 header, and functions for testing and setting checksums.


Instance Variables
version internet.version -> anInteger
IP version: 4 for IPv4, 6 for IPv6
proto internet.proto -> anInteger
IP Protocol, e.g. 6 = TCP, 17 = UDP, 1 = ICMP, 58 = ICMPv6
traffic_class internet.traffic_class -> anInteger
Originally IPv4 Type-Of-Service, now used for DSCP and ECN.  Traffic Class is its IPv6 name
hop_limit internet.hop_limit -> anInteger
Max number of hops IP packet can pass through. IPv4 used its 'Time to Live' (TTL) field in the same way
pkt_len internet.pkt_len -> anInteger
Total Length of IPv4 packet, Nonel for an IPv6 packet
hdr_len internet.pkt_len -> anInteger
IPv4 Header Length in 4-byte units, None for an IPv6 packet
src_prefix internet.src_prefix -> anIPprefix
IP source address (see IPprefix page for details)
dst_prefix internet.dst_prefix -> anIPprefix
IP destination address (see IPprefix page for details)


Class Functions
test_l3_cksm() internet.test_l3_cksm() -> True, False or None

Tests the IP header (layer 3) checksum for IPv4 Packets.
Returns True if the checksum is correct, False if it is incorrect, or None if the checksum could not be computed (i.e. too few bytes were captured).
set_l3_cksm() internet.set_l3_cksm() -> True or None

Computes and sets the IP header (layer 3) checksum for IPv4 Packets.
Returns True if the checksum was set, or None if the checksum could not be computed (i.e. too few bytes were captured).
test_trans_cksm() internet.test_trans_cksm() -> True, False or None

Tests the TCP, UDP, ICMP or ICMP6 (transport) checksum for IPv4 and IPv6 packets.
Returns True if the checksum is correct, False if it is incorrect, or None if the checksum could not be computed (i.e. too few bytes were captured).
set_trans_cksm() internet.tset_trans_cksm() -> True or None

Tests the TCP, UDP, ICMP or ICMP6 (transport) checksum for IPv4 and IPv6 packets.
Returns True if the checksum was set, or None if the checksum could not be computed (i.e. too few bytes were captured).

Nevil Brownlee
Tue,  3 Jun 14 (NZST)


python-libtrace-master/doc/Layers.html000066400000000000000000000143021324244200400203400ustar00rootroot00000000000000 Layers

Header Structure Decodes

Looking into each layer of a packet

libtrace's structure decodes (IP, IP6, UDP, TCP, ICMP, ICMP6) are all retrieved from a Packet by methods belonging to Packet, e.g. TCP = packet.tcp.  However, a libtrace_packet struct doesn't have a way to tell you how many bytes of the structure were actually captured.  Because of that, python-libtrace can't simply return the data bytes that belong to a structure but are in a part of it following the fixed-length part, e.g. IP and TCP options, and IP6 header extensions.

Instead, python-libtrace uses libtrace's 'get_layer' routines, so that it can return objects that know how many header bytes were actually captured.  Note that objects may be truncated because on-the-wire they extended past the SNAPLEN used when the trace was captured.

Class Layer2

Instance Variables
linktype Link Type for the trace, see below for values

Class Method
layer2 Packet.layer2 -> aNewLayer2

Returns a Layer2 object, containing it's link type and header bytes for this packet.

Global Constants
trace types See the libtrace documentation for more details

TRACE_TYPE_ETH 802.3-style Ethernet

TRACE_TYPE_ATM ATM frames

TRACE_TYPE_80211 802.11 frames

TRACE_TYPE_NONE Raw IP frames

TRACE_TYPE_LINUX_SLL Linux "null" framing

TRACE_TYPE_PFLOG FreeBSD's PFlog

TRACE_TYPE_DUCK Pseudo link layer for DUCK packets

TRACE_TYPE_80211_RADIO Radiotap + 802.11

TRACE_TYPE_LLCSNAP Raw LLC/SNAP

TRACE_TYPE_PPP PPP frames

TRACE_TYPE_METADATA WDCAP-style meta-data

Class Layer3

Instance Variables
ethertype Ethernet Type for the packet, e.g. 0x0800 = IPv4, 0x08dd = IPv6, 0x080b = ARP, etc.

Class Method
layer3 Packet.layer3 -> aNewLayer3

Returns a Layer3 object, containing it's link type and header bytes for this packet.
Class set  Method
set_checksums() Layer3.set_checksums -> True or False

Computes and sets TCP, UDP and ICMP checksums for IPv4 and IPv6 packets, and IP checksum for IPv4 packets.  This can be useful when using a Layer3 object to anonymise a packet.

Returns true if the checksums were set;  they are set only if the Layer3 object came from a complete packet, i.e. one with capture_len == wire_len.

Class Transport

stringInstance Variables
proto IP protocol number, (provided this was an IP or IP6 packet), e.g. 6 = TCP, 17 = UDP, 1 = ICMP, 58 = ICMP6

Class Method
transport Packet.transport-> aNewTransport

Returns a Transport object, containing the protocol number and header bytes for this packet.

Nevil Brownlee
Mon, 13 Apr 15 (NZST)

python-libtrace-master/doc/NewObjects.html000066400000000000000000000056571324244200400211610ustar00rootroot00000000000000 Making new objects

Making New Objects

Many of python-libtrace's classes have a new-instance function, so you can create a new object; this is most useful for handling encapsulated packets. These methods take a single argument, which may be an existing object or a byte array. In most cases the argument will be something you have unpacked from an incoming package. This allows you to work on encapsulated packets, e.g. 

  for pkt in trace:
      trans = pkt.transport
      if trans.proto != 41: # IPv6 over IPv4
          continue
      ip6 = ip6.new(trans)
      ... # Process the encapsulated IPv6 packet


Class Methods
ip()
 ip(object or byte array) -> anIP

Makes a new IP (IPv4) object
ip6()
 ip6bject or byte array) -> anIP6

 Makes a new IP6 (IPv6) object
tcp()
 tcp(object or byte array) -> aTCP

Makes a new TCP object
udp()
 udp(object or byte array) -> aUDPP

Makes a new UDP object
icmp()
 icmp(object or byte array) -> anICMP

Makes a new ICMP object
icmp6()
 icmp6(object or byte array) -> anICMP

Makes a new ICMPv6 object


Nevil Brownlee
Mon, 27 Jan 14 (NZDT) python-libtrace-master/doc/Output.html000066400000000000000000000156171324244200400204130ustar00rootroot00000000000000 Output Traces

Output Traces

An output Trace is a trace, indentified by a URI, that a python-libtrace progrm can write Packets to.  As with input traces, you must create (output_trace() ) and start (output_trace.start)()  an output trace before you can write Packets to it with output_trace.write_packet().

Class OutputTrace

Global Constants
compression types See the libtrace documentation for more details

NO_COMPRESSION Write uncompressed trace

ZLIB_COMPRESSION Write using zlib compression

BZIP2_COMPRESSION Write using bzip2 compresion

LZO_COMPRESSION Write using LZO compression

Class Methods
output_trace()
 output_trace.new(uri) -> aNewOutputTrace

Returns a libtrace OutputTrace object.  The object's name is given by a string containing its URI, e.g. pcapfile:xxx.pcap,  int:eth0, ...
conf_file_flags() output_trace.conf_file_flags(Integer)

Sets file creation flags for an OutputTrace; e.g. O_APPEND or  0iii (linux user/group/other permissions).
Throws a plt_exc_libtrace  exception if the conf  fails.
conf_compress_type()  output_trace.conf_compress_type(compression_type)

Sets the compression type that libtrace will use when writing the OutputTrace.
Throws a plt_exc_libtrace exception if the conf  fails.
conf_compress_level()  output_trace.conf_compress_level(Integer)

Sets the compression level that libtrace will use when writing the OutputTrace.  Higher levels give more compression, but lower writing speed.
Levels may be from 1 (minimum) to  9 (maximum),
the default level is 5.
Throws a plt_exc_libtrace exception if the conf  fails.
start_output() output_trace.start_output()

Starts the sending of packets (from a live inteferace), or opens  a trace file for writing.
Throws a plt_exc_libtrace exception if the start fails.
close_output() output_trace.close_output()

Shuts down a live interface, or closes a trace file.
write_packet()output_trace.write_packet(Packet)

Writes the data from a Packet to an OutputTrace.
Throws a plt_exc_libtrace exception if the write fails.

Nevil Brownlee
Thu, 17 Jul 14 (NZST)

python-libtrace-master/doc/Packet.html000066400000000000000000000204411324244200400203110ustar00rootroot00000000000000 Handling Packets

Handling Packets

Class Packet

Gives you access to fieds within (the captured part of) a packet.  You will normally work on Packets returned from  Trace.read_packet()  or a Trace iterator  (see Trace Handling), but you can create a new packet instance with  packet()  (see below).

Note that the Layer and Decode methods return None if their requested object was not present in the packet, or was not completely captured.

Class Methods
packet()
 Packet() -> aPacket

Makes a new Python Packet.  A python-libtrace packet maintains a set of pointers into a libtrace packet or a python-libtrace data object.  In a newly-created Packet, all such pointers are NULL.


Instance Methods
layer2 pkt.layer2 -> aLayer2

Gets a Layer2 object from the packet; see Layers page
layer3 pkt.layer3 -> aLayer3

Gets a Layer3 object from the packet; see Layers page
transport pkt.transport -> aTransport

Gets a Transport object from the packet; see Layers page
ip pkt.ip -> anIP

Gets an IPv4 header from the packet
ip6 pkt.ip6 -> anIP6

Gets an IPv6 header from the packet
tcp pkt.tcp-> aTCP

Gets a TCP header from the packet
tcp_payload pkt.tcp_payload -> aData

Gets a TCP payload  from the packet, or None if it wasn't TCP.
tcp_payload.data returns a ByteArray of the data
udp pkt.udp -> aUDP

Gets a UDP header from the packet
udp_payload pkt.udp_payload -> aData

Gets a UDP payload  from the packet, or None if it wasn't UDP.
udp_payload.data returns a ByteArray of the data
icmp pkt.icmp -> anICMP

Gets an ICMP header from the packet
icmp6 pkt.icmp -> anICMP

Gets an ICMP v6header from the packet


apply_filter() pkt.apply_filter(aFilter) -> result

Tests whether the current contents of the packet match aFilter.
Result is True if the filter matches, False if it doesn't, or None if the filter was invalid

Instance Variables
data pkt.data -> aByteArray

Byte array containing object's header and its following bytes.
May be used for any python-libtrace object
timepkt.time -> aTimeval

Packet Arrival Time as a Python Time
seconds pkt.seconds -> aFloat

Packet Arrival Time in Unix seconds (double)
ts_sec
 pkt.ts_sec -> anInteger

Packet Arrival Time in Unix seconds (integer)
erf_time pkt.erf_time -> anInteger

Packet Arrival Time as a DAG ERF time (64-bit)
wire_len pkt.wire_len -> anInteger

Original size of packet on the wire
capture_len pkt.capture_len -> anInteger

Number of bytes captured; may be less than wire_len
ethertype internet.ethertype -> anInteger

Ethertype for the packet that contained this object
linktype
 pkt.linktype -> anInteger

Packet's link type; see Layer2 on Layers page for linktype values
vlan_id
 pkt.vlan_id -> anInteger

VLAN ID for packets with an 802.1Q VLAN tag, zero otherwise
direction
 pkt.direction -> anInteger

'Direction' of packet, for traces from interfaces that support this,
e.g. ERF traces.  Direction values are:
TRACE_DIR_INCOMING, TRACE_DIR_INCOMING and TRACE_DIR_OTHER

Class Set  Method
data= Packet.data = aByteArray

Overwrites the data bytes in a Data object with bytes from a byte array.  The byte array  may not be longer than the original data from the packet.

Nevil Brownlee
Mon,  13 Apr 15 (NZST)

python-libtrace-master/doc/SCTP.html000066400000000000000000000071711324244200400176600ustar00rootroot00000000000000 IProtocol Decodes: SCTP

Network Layer Decodes

Class SCTP

Provides access to the header and chunks of an SCTP Packet.

Instance Variables
src_port
 sctp.src_port -> anInteger

Source Port (16-bit).
dst_port
 sctp.code -> anInteger

Destination Port (16-bit).
verification_tag
 sctp.verification_tag -> anInteger

SCTP Verification Tag (32-bit).
checksum
sctp.checksum -> anInteger

SCTP checksum (32-bit).
chunks
sctp.chunks ->aPythonList

Returns a list of SCTP Chunk objects (see below).

An SCTP Chunk object has the following attributes ...

SCTP Chunk
type
 chunk.type-> anInteger

SCTP chunk type (8-bit).
flags chunk.flags -> anInteger

SCTP chunk flags (8-bit).
length  chunk.length -> anInteger

SCTP chunk length (16-bit).
is_ok  chunk.is_ok -> True or False

True if all bytes in this chunk were captured,  may be False if some of the chunk's later bytes were not captured.
sequence  chunk.bytes -> aByteArray

Byte array containing the chunks payload bytes.

Nevil Brownlee
Tue, 30 Jan 2018 (NZDT)

python-libtrace-master/doc/TCP.html000066400000000000000000000124121324244200400175270ustar00rootroot00000000000000 Protocol Decodes: TCP

Transport Layer Decodes

Class TCP

Provides access to fields in a TCP header.

Instance Variables
src_port tcp.src_port -> anInteger

Source Port (16-bit)
dst_port tcp.dst_port -> anInteger

Destination Port (16-bit)
seq_nbr tcp.seq_nbr -> anInteger

Sequence Number (32-bit)
ack_nbr tcp.ack_nbr -> anInteger

Acknowledgement Number (32-bit)
doff tcp.doff -> anInteger

Data Offset (4-byte units); header is doff*4 bytes long
flags tcp.flags -> anInteger

12-bit integer, with the 6 flags below in its 6 low-order bits
urg_flag tcp.urg_flag -> true or false

True if 'Urgent' flag is 1
ack_flag tcp.ack_flag -> true or false

True if 'Acknowledge' flag is 1
psh_flag tcp.psh_flag -> true or false

True if 'Push' flag is 1
rst_flag tcp.rst_flag -> true or false

True if 'Reset'' flag is 1
syn_flag tcp.syn_flag -> true or false

True if 'Synchronise' flag is 1
fin_flag tcp.fin_flag -> true or false

True if 'Finish' flag is 1
window tcp.window-> anInteger

Receive Window size
checksum tcp.checksum -> anInteger

TCP Checksum
options_data
 tcp.options_data-> aByteArray | False

Bytearray containing the bytes of the TCP options part of the TCP header.  Returns False if header has no TCP options
option_numbers
 tcp.option_numbers -> aCFFIArray | False

Byterray containing the option numbers of all this header's TCP options.  Returns False if header has no TCP options
urg_ptr tcp.urgent -> anInteger

TCP Urgent Pointer 
payload tcp.payload -> aPayloadObject

None if tcp had no payload, otherwise
an object containing the packet's TCP payload


Instance Function
option(n)
 tcp.option(n) -> aByteArray | True | False

Bytearray containing option n's value bytes. 
Returns True if option n is present but has no value,
or False if option n is not present in the header

Nevil Brownlee
Mon, 17 Jan 2017 (NZDT)

python-libtrace-master/doc/Trace.html000066400000000000000000000247541324244200400201530ustar00rootroot00000000000000 Trace Management

Trace Management

What is a libtrace 'trace?'

A trace is an object, either a live interface or a trace file, identified by a URI, of the form format:name, e.g. pacpfile:sample.bpf for a pcap file,  int:eth0 for a live interface.

In a python-libtrace program you must create a Trace object using trace(), then 'start' the trace using trace.start(); after that you can read Packets from it using tfor packet in trace: or trace.read_packet().

If you need to configure a live trace, you must specify its snap length, any input Filter it should use, and whether or not it should capture in promiscuous mode, using the Trace.conf_ methods.  Furthermore, you must configure the trace before you start it.

Class Trace

Class Methods
trace()
 trace(uri) -> aNewTrace

Returns a libtrace Trace object.  The object's name is given by a string containing its URI, e.g. pcapfile:xxx.bpf,  int:eth0, ...
conf_filter() trace.conf_filter(filter) 

Specifies that the Trace will filter its packets using the  BPF filter supplied as its argument.  See the Filter page for details of how to create a filter object.
Throws a plt_exc_libtrace exception if the conf fails.
conf_snaplen() trace.conf_snaplen(integer) 

Sets snaplen for a live-interface Trace; at most the first snaplen bytes of each packet will be recorded for each packet.
Throws a plt_exc_libtrace exception if the conf fails.
conf_promisc() trace.promisc(arg)

Specifices that a live-interface Trace should capture all (if arg is true) packets, oherwise it should only capture packets intended for the Trace's interface.
Throws a plt_exc_libtrace exception if the conf fails.
conf_timeout() trace.promisc(integer)

Specifies the maximum time (in seconds) libtrace should wait for an incoming packet from this Trace.  Intended for use with interfaces, e.g. with URIs that start with int: or bsd:.
Throws a plt_exc_libtrace exception if the Trace times out; that will happen if no packets were seen, perhaps because its interface was not configured up when the trace was started.
start() trace.start ()

Starts the capture (from a live inteferace), or opens  a trace file for reading.
Throws a plt_exc_libtrace exception if the start fails.
pause()
 trace.pause() 

Pauses the capture from a live interface.
Throws a plt_exc_libtrace exception if the pause fails.
Note: if you can pause() a trace, you may change its configuration, then start() it again.
close() trace.close()

Shuts down a live interface, or closes a trace file.
read_packet() trace.read_packet(aPacket) -> True or False

Gets a packet from Trace, and returns it in a Packet.
Returns true if a packet was read, false at  End-Of-File.
Throws a plt_exc_libtrace exception if the read fails.
trace iterator
 for packet in trace:
      block

Reads Packets from trace, and passes them (in arrival order) to the indented block to be processed.
Does not return anything after the last packet.
Throws a plt_exc_libtrace exception if a read fails.
pkt_drops() Trace.packet_drops -> anInteger

Returns the number of packets Trace captured, but that were dropped because of buffer overruns.
pkt_accepts() Trace.accepted_packets -> anInteger

Returns the number of packets Trace captured, and that were successfully read from it.


Nevil Brownlee
Mon, 19 Feb 2018 (NZDT)
python-libtrace-master/doc/UDP.html000066400000000000000000000034741324244200400175410ustar00rootroot00000000000000 IProtocol Decodes: UDP

Transport Layer Decodes

Class UDP

Provides access to fields in a UDP header.


Instance Variables
src_port udp.src_port -> anInteger

Source Port (16-bit)
dst_port udp.dst_port-> anInteger

Destination Port (16-bit)
len udp.len -> anInteger

UDP length, i.e. header + payload
checksum udp.checksum -> anInteger

UDP Checksum

TCP Checksum
payload udp.payload -> aPayloadObject

None if udp had no payload,  otherwise
an object containing the packet's TCP payload

Nevil Brownlee
Sat, 15 Mar 14 (NZDT)

python-libtrace-master/doc/examples/000077500000000000000000000000001324244200400200315ustar00rootroot00000000000000python-libtrace-master/doc/examples/anon-v4.pcap000066400000000000000000000554411324244200400221710ustar00rootroot00000000000000 [òoG<< 'BBe`%O"{ME@BO/5ܲwwwgooglecom owwwl,oGJJ+Ku%OE<.,@@ȋ/G-(חhPs <oGkKK"{M%OE=@@ /O5)DwwwconnactcomoG؎JJ%O+KuE<0T!G-(/Phl_IJ( L<oG66+Ku%OE(@@/G-(חhPPwnoG`%O"{ME}@ͮO/5iNDwwwconnactcomX4ns1 connoGmUU"{M%OEG@@ /O53нwwwconnactcomcaidaorgoG`%O"{MEv@ͲO/5bSwwwconnactcomcaidaorg8@oGGKK"{M%OE=@@ /O5)ƌMwwwconnactcomoGѓ`%O"{ME~@͏O/5jGMwwwconnactcom XBpoGJJ+Ku%OEy@@/M~PȶDԶ\G < GET /~kgross/FAQ/944faq.html HoGV `%O+KuE@0`fM~/PԶȶN@c: <HTTP/1.1 200 OK Date: Fri, 28oGw BB+Ku%OE4y@@/M~PȶNԷRސ 1.0 InoG BB+Ku%OE4y@@/M~PȶNԷ ػ