diff --git a/DERIVATIVE-LICENSE.txt b/DERIVATIVE-LICENSE.txt new file mode 100644 index 0000000..29ebfa5 --- /dev/null +++ b/DERIVATIVE-LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. \ No newline at end of file diff --git a/dnx-netfilterqueue.pxd b/dnx-netfilterqueue.pxd new file mode 100644 index 0000000..11dca6f --- /dev/null +++ b/dnx-netfilterqueue.pxd @@ -0,0 +1,219 @@ +cdef extern from "sys/types.h": + ctypedef unsigned char u_int8_t + ctypedef unsigned short int u_int16_t + ctypedef unsigned int u_int32_t + +cdef extern from "": + int errno + +# dummy defines from asm-generic/errno.h: +cdef enum: + EAGAIN = 11 # Try again + EWOULDBLOCK = EAGAIN + ENOBUFS = 105 # No buffer space available + +cdef extern from "netinet/ip.h": + struct ip_header: + u_int8_t tos + u_int16_t tot_len + u_int16_t id + u_int16_t frag_off + u_int8_t ttl + u_int8_t protocol + u_int16_t check + u_int32_t saddr + u_int32_t daddr + +# Dummy defines from netinet/in.h: +cdef enum: + IPPROTO_IP = 0 # Dummy protocol for TCP. + IPPROTO_HOPOPTS = 0 # IPv6 Hop-by-Hop options. + IPPROTO_ICMP = 1 # Internet Control Message Protocol. + IPPROTO_IGMP = 2 # Internet Group Management Protocol. */ + IPPROTO_IPIP = 4 # IPIP tunnels (older KA9Q tunnels use 94). + IPPROTO_TCP = 6 # Transmission Control Protocol. + IPPROTO_EGP = 8 # Exterior Gateway Protocol. + IPPROTO_PUP = 12 # PUP protocol. + IPPROTO_UDP = 17 # User Datagram Protocol. + IPPROTO_IDP = 22 # XNS IDP protocol. + IPPROTO_TP = 29 # SO Transport Protocol Class 4. + IPPROTO_IPV6 = 41 # IPv6 header. + IPPROTO_ROUTING = 43 # IPv6 routing header. + IPPROTO_FRAGMENT = 44 # IPv6 fragmentation header. + IPPROTO_RSVP = 46 # Reservation Protocol. + IPPROTO_GRE = 47 # General Routing Encapsulation. + IPPROTO_ESP = 50 # encapsulating security payload. + IPPROTO_AH = 51 # authentication header. + IPPROTO_ICMPV6 = 58 # ICMPv6. + IPPROTO_NONE = 59 # IPv6 no next header. + IPPROTO_DSTOPTS = 60 # IPv6 destination options. + IPPROTO_MTP = 92 # Multicast Transport Protocol. + IPPROTO_ENCAP = 98 # Encapsulation Header. + IPPROTO_PIM = 103 # Protocol Independent Multicast. + IPPROTO_COMP = 108 # Compression Header Protocol. + IPPROTO_SCTP = 132 # Stream Control Transmission Protocol. + IPPROTO_RAW = 255 # Raw IP packets. + IPPROTO_MAX + +cdef extern from "Python.h": + object PyBytes_FromStringAndSize(char *s, Py_ssize_t len) + object PyString_FromStringAndSize(char *s, Py_ssize_t len) + +cdef extern from "sys/time.h": + ctypedef long time_t + struct timeval: + time_t tv_sec + time_t tv_usec + struct timezone: + pass + +cdef extern from "netinet/in.h": + u_int32_t ntohl (u_int32_t __netlong) nogil + u_int16_t ntohs (u_int16_t __netshort) nogil + u_int32_t htonl (u_int32_t __hostlong) nogil + u_int16_t htons (u_int16_t __hostshort) nogil + +cdef extern from "libnfnetlink/linux_nfnetlink.h": + struct nfgenmsg: + u_int8_t nfgen_family + u_int8_t version + u_int16_t res_id + +cdef extern from "libnfnetlink/libnfnetlink.h": + struct nfnl_handle: + pass + unsigned int nfnl_rcvbufsiz(nfnl_handle *h, unsigned int size) + +cdef extern from "libnetfilter_queue/linux_nfnetlink_queue.h": + enum nfqnl_config_mode: + NFQNL_COPY_NONE + NFQNL_COPY_META + NFQNL_COPY_PACKET + struct nfqnl_msg_packet_hdr: + u_int32_t packet_id + u_int16_t hw_protocol + u_int8_t hook + +cdef extern from "libnetfilter_queue/libnetfilter_queue.h": + struct nfq_handle: + pass + struct nfq_q_handle: + pass + struct nfq_data: + pass + struct nfqnl_msg_packet_hw: + u_int8_t hw_addr[8] + + nfq_handle *nfq_open() + int nfq_close(nfq_handle *h) + + int nfq_bind_pf(nfq_handle *h, u_int16_t pf) + int nfq_unbind_pf(nfq_handle *h, u_int16_t pf) + ctypedef int *nfq_callback(nfq_q_handle *gh, nfgenmsg *nfmsg, + nfq_data *nfad, void *data) + nfq_q_handle *nfq_create_queue(nfq_handle *h, + u_int16_t num, + nfq_callback *cb, + void *data) + int nfq_destroy_queue(nfq_q_handle *qh) + + int nfq_handle_packet(nfq_handle *h, char *buf, int len) + + int nfq_set_mode(nfq_q_handle *qh, + u_int8_t mode, unsigned int len) + + q_set_queue_maxlen(nfq_q_handle *qh, + u_int32_t queuelen) + + int nfq_set_verdict(nfq_q_handle *qh, + u_int32_t id, + u_int32_t verdict, + u_int32_t data_len, + unsigned char *buf) nogil + + int nfq_set_verdict2(nfq_q_handle *qh, + u_int32_t id, + u_int32_t verdict, + u_int32_t mark, + u_int32_t datalen, + unsigned char *buf) nogil + int nfq_set_queue_maxlen(nfq_q_handle *qh, u_int32_t queuelen) + + int nfq_fd(nfq_handle *h) + nfqnl_msg_packet_hdr *nfq_get_msg_packet_hdr(nfq_data *nfad) + int nfq_get_payload(nfq_data *nfad, unsigned char **data) + int nfq_get_timestamp(nfq_data *nfad, timeval *tv) + nfqnl_msg_packet_hw *nfq_get_packet_hw(nfq_data *nfad) + int nfq_get_nfmark (nfq_data *nfad) + u_int8_t nfq_get_indev(nfq_data *nfad) + u_int8_t nfq_get_outdev(nfq_data *nfad) + nfnl_handle *nfq_nfnlh(nfq_handle *h) + +# Dummy defines from linux/socket.h: +cdef enum: # Protocol families, same as address families. + PF_INET = 2 + PF_INET6 = 10 + +cdef extern from "sys/socket.h": + ssize_t recv(int __fd, void *__buf, size_t __n, int __flags) nogil + int MSG_DONTWAIT + +# Dummy defines from linux/netfilter.h +cdef enum: + NF_DROP + NF_ACCEPT + NF_STOLEN + NF_QUEUE + NF_REPEAT + NF_STOP + NF_MAX_VERDICT = NF_STOP + +cdef class Packet: + cdef nfq_q_handle *_qh + cdef nfq_data *_nfa + cdef nfqnl_msg_packet_hdr *_hdr + cdef nfqnl_msg_packet_hw *_hw + cdef bint _verdict_is_set # True if verdict has been issued, otherwise false + cdef u_int32_t _mark # Mark given to packet + cdef bytes _given_payload # New payload of packet, or null + + # From NFQ packet header: + cdef readonly u_int32_t id + cdef readonly u_int16_t hw_protocol + cdef readonly u_int8_t hook + cdef readonly u_int32_t mark + + # Packet details: + cdef Py_ssize_t payload_len + cdef readonly unsigned char *payload + cdef timeval timestamp + cdef u_int8_t hw_addr[8] + + # TODO: implement these | likely not using in this manner. + #cdef u_int8_t hw_addr[8] # A eui64-formatted address? + #cdef readonly u_int32_t nfmark + #cdef readonly u_int32_t indev + #cdef readonly u_int32_t physindev + #cdef readonly u_int32_t outdev + #cdef readonly u_int32_t physoutdev + + cdef set_nfq_data(self, nfq_q_handle *qh, nfq_data *nfa) + cdef void verdict(self, u_int32_t verdict) + cpdef get_inint(self, bint name=*) + cpdef get_outint(self, bint name=*) + cpdef update_mark(self, u_int32_t mark) + cpdef Py_ssize_t get_payload_len(self) + cpdef double get_timestamp(self) + cpdef set_payload(self, bytes payload) + cpdef accept(self) + cpdef drop(self) + cpdef forward(self, u_int16_t queue_num) + cpdef repeat(self) + +cdef class NetfilterQueue: + cdef object user_callback # User callback + cdef nfq_handle *h # Handle to NFQueue library + cdef nfq_q_handle *qh # A handle to the queue + cdef u_int16_t af # Address family + cdef packet_copy_size # Amount of packet metadata + data copied to buffer + diff --git a/dnx-netfilterqueue.pyx b/dnx-netfilterqueue.pyx new file mode 100644 index 0000000..065b1ee --- /dev/null +++ b/dnx-netfilterqueue.pyx @@ -0,0 +1,481 @@ +#!/usr/bin/env python3 + +''' +Bind to a Linux netfilter queue. Send packets to a user-specified callback +function. + +Copyright: (c) 2011, Kerkhoff Technologies Inc. +License: MIT; see SOURCE-LICENSE.txt +''' + +''' +Expanded features + general refactor to be used with DNXFIREWALL. + - DOWRIGHT @ Wright Network Solutions, LLC. +''' + +import socket + +# Constants for module users +cdef int COPY_NONE = 0 +cdef int COPY_META = 1 +cdef int COPY_PACKET = 2 + +cdef u_int16_t DEFAULT_MAX_QUEUELEN = 1024 +cdef u_int16_t MaxPacketSize = 0xFFFF + +# buffer size - metadata size +cdef u_int16_t MaxCopySize = 4096 - 80 + +# Socket queue should hold max number of packets of copy size bytes +# formula: DEF_MAX_QUEUELEN * (MaxCopySize+SockOverhead) / 2 +cdef u_int32_t SockRcvSize = 1024 * 4796 // 2 + +cdef int global_callback(nfq_q_handle * qh, nfgenmsg * nfmsg, nfq_data * nfa, void * data) with gil: + '''Create a Packet and pass it to appropriate callback.''' + + cdef NetfilterQueue nfqueue = < NetfilterQueue > data + cdef object user_callback = < object > nfqueue.user_callback + + packet = Packet() + packet.set_nfq_data(qh, nfa) + + user_callback(packet) + + return 1 + +cdef class Packet: + '''A packet received from NetfilterQueue.''' + + def __cinit__(self): + self._verdict_is_set = False + self._mark = 0 + self._given_payload = None + + def __str__(self): + cdef ip_header * hdr = < ip_header * > self.payload + protocol = PROTOCOLS.get(hdr.protocol, "Unknown protocol") + + return "%s packet, %s bytes" % (protocol, self.payload_len) + + cdef set_nfq_data(self, nfq_q_handle * qh, nfq_data * nfa): + '''Assign a packet from NFQ to this object. Parse the header and load local values.''' + + self._qh = qh + self._nfa = nfa + self._hdr = nfq_get_msg_packet_hdr(nfa) + + self.id = ntohl(self._hdr.packet_id) + self.hw_protocol = ntohs(self._hdr.hw_protocol) + self.hook = self._hdr.hook + + self.payload_len = nfq_get_payload(self._nfa, &self.payload) + if self.payload_len < 0: + raise OSError("Failed to get payload of packet.") + + self._payload + + # timestamp gets assigned via pointer/struct -> time_val: (t_sec, t_usec). + nfq_get_timestamp(self._nfa, &self.timestamp) + + cdef u_int32_t mark = nfq_get_nfmark(nfa) + + cdef void verdict(self, u_int32_t verdict): + '''Call appropriate set_verdict... function on packet.''' + + if self._verdict_is_set: + raise RuntimeWarning("Verdict already given for this packet.") + + cdef u_int32_t modified_payload_len = 0 + cdef unsigned char * modified_payload = NULL + + # rewriting payload data/len + if self._given_payload: + modified_payload_len = len(self._given_payload) + modified_payload = self._given_payload + + if self._modified_mark: + nfq_set_verdict2( + self._qh, self.id, verdict, self._modified_mark, modified_payload_len, modified_payload + ) + + else: + nfq_set_verdict( + self._qh, self.id, verdict, modified_payload_len, modified_payload + ) + + self._verdict_is_set = True + + cpdef get_inint(self, bint name=False): + '''Returns index of inbound interface of packet. If the packet sourced from localhost or the input + interface is not known, 0 will be returned. + + if name=True, socket.if_indextoname() will be returned. + ''' + + cdef object in_interface_name + + in_interface = nfq_get_indev(self._nfa) + if not name: + return in_interface + + try: + in_interface_name = socket.if_indextoname(in_interface) + except OSError: + in_interface_name = 'unknown' + + return in_interface_name + + # NOTE: keeping these funtions separate instead of making an argument option to adjust which interface to return. + # this will keep it explicit for which interface is returning to minimize chance of confusion/bugs. + cpdef get_outint(self, bint name=False): + '''Returns index of outbound interface of packet. If the packet is destined for localhost or the output + interface is not yet known, 0 will be returned. + + if name=True, socket.if_indextoname() will be returned. + ''' + + cdef object out_interface_name + + out_interface = nfq_get_outdev(self._nfa) + if not name: + return out_interface + + try: + out_interface_name = socket.if_indextoname(out_interface) + except OSError: + out_interface_name = 'unknown' + + return out_interface_name + + def get_mark(self): + '''Return mark set at first receipt of packet.''' + + return self._mark + + cpdef update_mark(self, u_int32_t mark): + '''Modifies the running mark of the packet. This will not override the initial mark received, but any + subsequent update will override the previous.''' + + self._modified_mark = mark + + def get_hw(self): + '''Return the source mac address of the packet.''' + + cdef object mac_addr + + self._hw = nfq_get_packet_hw(self._nfa) + if self._hw == NULL: + # nfq_get_packet_hw doesn't work on OUTPUT and PREROUTING chains + # NOTE: making this a quick fail scenario since this would likely cause problems later in the packet + # parsing process and forcing error handling will ensure it is dealt with [properly]. + raise OSError('MAC address not available in OUTPUT and PREROUTING chains') + + # NOTE: can this not just be directly referenced below? + self.hw_addr = self._hw.hw_addr + + mac_addr = PyBytes_FromStringAndSize( < char * > self.hw_addr, 8) + + return mac_addr + + def get_payload(self): + '''Return payload as Python string.''' + + cdef object payload + + payload = self.payload[:self.payload_len] + + return payload + + cpdef set_payload(self, bytes payload): + '''Set the new payload of this packet.''' + + self._given_payload = payload + + cpdef Py_ssize_t get_payload_len(self): + + return self.payload_len + + cpdef double get_timestamp(self): + + return self.timestamp.tv_sec + (self.timestamp.tv_usec / 1000000.0) + + cpdef accept(self): + '''Accept the packet.''' + + self.verdict(NF_ACCEPT) + + cpdef drop(self): + '''Drop the packet.''' + + self.verdict(NF_DROP) + + cpdef forward(self, u_int16_t queue_num): + '''Send the packet to a different queue.''' + + cdef u_int32_t forward_to_queue + + forward_to_queue = queue_num << 16 | NF_QUEUE + + self.verdict(forward_to_queue) + + cpdef repeat(self): + '''Repeat the packet.''' + + self.verdict(NF_REPEAT) + + +cdef class NetfilterQueue: + '''Handle a single numbered queue.''' + + def __cinit__(self, *args, **kwargs): + self.af = kwargs.get('af', PF_INET) + + self.h = nfq_open() + if self.h == NULL: + raise OSError('Failed to open NFQueue.') + + # This does NOT kick out previous running queues + nfq_unbind_pf(self.h, self.af) + + if nfq_bind_pf(self.h, self.af) < 0: + raise OSError('Failed to bind family %s. Are you root?' % self.af) + + def __dealloc__(self): + if self.qh != NULL: + nfq_destroy_queue(self.qh) + + # Don't call nfq_unbind_pf unless you want to disconnect any other + # processes using this libnetfilter_queue on this protocol family! + nfq_close(self.h) + + def bind(self, int queue_num, object user_callback, u_int16_t max_len=DEFAULT_MAX_QUEUELEN, + u_int8_t mode=NFQNL_COPY_PACKET, u_int16_t range=MaxPacketSize, u_int32_t sock_len=SockRcvSize): + '''Create and bind to a new queue.''' + + cdef unsigned int newsiz + + self.user_callback = user_callback + self.qh = nfq_create_queue(self.h, queue_num, < nfq_callback * > global_callback, < void * > self) + if self.qh == NULL: + raise OSError(f'Failed to create queue {queue_num}') + + if range > MaxCopySize: + range = MaxCopySize + + if nfq_set_mode(self.qh, mode, range) < 0: + raise OSError("Failed to set packet copy mode.") + + nfq_set_queue_maxlen(self.qh, max_len) + + newsiz = nfnl_rcvbufsiz(nfq_nfnlh(self.h), sock_len) + if newsiz != sock_len * 2: + raise RuntimeWarning("Socket rcvbuf limit is now %d, requested %d." % (newsiz, sock_len)) + + def unbind(self): + '''Destroy the queue.''' + + if self.qh != NULL: + nfq_destroy_queue(self.qh) + + self.qh = NULL + # See warning about nfq _unbind_pf in __dealloc__ above. + + def get_fd(self): + '''Get the file descriptor of the queue handler.''' + + return nfq_fd(self.h) + + def run(self, bint block=True): + '''Accept packets using recv.''' + + cdef int fd = self.get_fd() + cdef char buf[4096] + cdef int rv + cdef int recv_flags + + recv_flags = 0 + + while True: + with nogil: + rv = recv(fd, buf, sizeof(buf), recv_flags) + + print(rv) + + if (rv >= 0): + nfq_handle_packet(self.h, buf, rv) + + else: + if errno != ENOBUFS: + break + + def run_socket(self, s): + '''Accept packets using socket.recv so that, for example, gevent can monkeypatch it.''' + + while True: + try: + buf = s.recv(4096) + except socket.error as e: + err = e.args[0] + if err == ENOBUFS: + continue + + elif err == EAGAIN or err == EWOULDBLOCK: + # This should only happen with a non-blocking socket, and the + # app should call run_socket again when more data is available. + break + + else: + # This is bad. Let the caller handle it. + raise e + + else: + rv = len(buf) + if rv >= 0: + nfq_handle_packet(self.h, buf, rv) + else: + break + +PROTOCOLS = { + 0: "HOPOPT", + 1: "ICMP", + 2: "IGMP", + 3: "GGP", + 4: "IP", + 5: "ST", + 6: "TCP", + 7: "CBT", + 8: "EGP", + 9: "IGP", + 10: "BBN-RCC-MON", + 11: "NVP-II", + 12: "PUP", + 13: "ARGUS", + 14: "EMCON", + 15: "XNET", + 16: "CHAOS", + 17: "UDP", + 18: "MUX", + 19: "DCN-MEAS", + 20: "HMP", + 21: "PRM", + 22: "XNS-IDP", + 23: "TRUNK-1", + 24: "TRUNK-2", + 25: "LEAF-1", + 26: "LEAF-2", + 27: "RDP", + 28: "IRTP", + 29: "ISO-TP4", + 30: "NETBLT", + 31: "MFE-NSP", + 32: "MERIT-INP", + 33: "DCCP", + 34: "3PC", + 35: "IDPR", + 36: "XTP", + 37: "DDP", + 38: "IDPR-CMTP", + 39: "TP++", + 40: "IL", + 41: "IPv6", + 42: "SDRP", + 43: "IPv6-Route", + 44: "IPv6-Frag", + 45: "IDRP", + 46: "RSVP", + 47: "GRE", + 48: "DSR", + 49: "BNA", + 50: "ESP", + 51: "AH", + 52: "I-NLSP", + 53: "SWIPE", + 54: "NARP", + 55: "MOBILE", + 56: "TLSP", + 57: "SKIP", + 58: "IPv6-ICMP", + 59: "IPv6-NoNxt", + 60: "IPv6-Opts", + 61: "any host internal protocol", + 62: "CFTP", + 63: "any local network", + 64: "SAT-EXPAK", + 65: "KRYPTOLAN", + 66: "RVD", + 67: "IPPC", + 68: "any distributed file system", + 69: "SAT-MON", + 70: "VISA", + 71: "IPCV", + 72: "CPNX", + 73: "CPHB", + 74: "WSN", + 75: "PVP", + 76: "BR-SAT-MON", + 77: "SUN-ND", + 78: "WB-MON", + 79: "WB-EXPAK", + 80: "ISO-IP", + 81: "VMTP", + 82: "SECURE-VMTP", + 83: "VINES", + 84: "TTP", + 85: "NSFNET-IGP", + 86: "DGP", + 87: "TCF", + 88: "EIGRP", + 89: "OSPFIGP", + 90: "Sprite-RPC", + 91: "LARP", + 92: "MTP", + 93: "AX.25", + 94: "IPIP", + 95: "MICP", + 96: "SCC-SP", + 97: "ETHERIP", + 98: "ENCAP", + 99: "any private encryption scheme", + 100: "GMTP", + 101: "IFMP", + 102: "PNNI", + 103: "PIM", + 104: "ARIS", + 105: "SCPS", + 106: "QNX", + 107: "A/N", + 108: "IPComp", + 109: "SNP", + 110: "Compaq-Peer", + 111: "IPX-in-IP", + 112: "VRRP", + 113: "PGM", + 114: "any 0-hop protocol", + 115: "L2TP", + 116: "DDX", + 117: "IATP", + 118: "STP", + 119: "SRP", + 120: "UTI", + 121: "SMP", + 122: "SM", + 123: "PTP", + 124: "ISIS", + 125: "FIRE", + 126: "CRTP", + 127: "CRUDP", + 128: "SSCOPMCE", + 129: "IPLT", + 130: "SPS", + 131: "PIPE", + 132: "SCTP", + 133: "FC", + 134: "RSVP-E2E-IGNORE", + 135: "Mobility", + 136: "UDPLite", + 137: "MPLS-in-IP", + 138: "manet", + 139: "HIP", + 140: "Shim6", + 255: "Reserved", +} diff --git a/netfilterqueue/_impl.pxd b/netfilterqueue/_impl.pxd index 54c2fa3..ecf2f21 100644 --- a/netfilterqueue/_impl.pxd +++ b/netfilterqueue/_impl.pxd @@ -1,77 +1,74 @@ -cdef extern from "": +cdef extern from "sys/types.h": ctypedef unsigned char u_int8_t ctypedef unsigned short int u_int16_t ctypedef unsigned int u_int32_t -cdef extern from "": - int dup2(int oldfd, int newfd) - cdef extern from "": int errno +cdef extern from "time.h" nogil: + ctypedef long time_t + time_t time(time_t*) + + struct timeval: + time_t tv_sec + time_t tv_usec + + struct timezone: + pass + # dummy defines from asm-generic/errno.h: cdef enum: - EINTR = 4 EAGAIN = 11 # Try again EWOULDBLOCK = EAGAIN ENOBUFS = 105 # No buffer space available -cdef extern from "": - struct iphdr: - u_int8_t tos - u_int16_t tot_len - u_int16_t id - u_int16_t frag_off - u_int8_t ttl - u_int8_t protocol - u_int16_t check - u_int32_t saddr - u_int32_t daddr - -# Dummy defines from netinet/in.h: +# cython define +cdef struct iphdr: + u_int8_t ver_ihl + u_int8_t tos + u_int16_t tot_len + u_int16_t id + u_int16_t frag_off + u_int8_t ttl + u_int8_t protocol + u_int16_t check + u_int32_t saddr + u_int32_t daddr + +# cython define +cdef struct tcphdr: + u_int16_t th_sport + u_int16_t th_dport + u_int32_t th_seq + u_int32_t th_ack + + u_int8_t th_off + + u_int8_t th_flags + u_int16_t th_win + u_int16_t th_sum + u_int16_t th_urp + +# cython define +cdef struct udphdr: + u_int16_t uh_sport + u_int16_t uh_dport + u_int16_t uh_ulen + u_int16_t uh_sum + +cdef struct icmphdr: + u_int8_t type + u_int8_t code + +# from netinet/in.h: cdef enum: IPPROTO_IP = 0 # Dummy protocol for TCP. - IPPROTO_HOPOPTS = 0 # IPv6 Hop-by-Hop options. IPPROTO_ICMP = 1 # Internet Control Message Protocol. - IPPROTO_IGMP = 2 # Internet Group Management Protocol. */ - IPPROTO_IPIP = 4 # IPIP tunnels (older KA9Q tunnels use 94). IPPROTO_TCP = 6 # Transmission Control Protocol. - IPPROTO_EGP = 8 # Exterior Gateway Protocol. - IPPROTO_PUP = 12 # PUP protocol. IPPROTO_UDP = 17 # User Datagram Protocol. - IPPROTO_IDP = 22 # XNS IDP protocol. - IPPROTO_TP = 29 # SO Transport Protocol Class 4. - IPPROTO_IPV6 = 41 # IPv6 header. - IPPROTO_ROUTING = 43 # IPv6 routing header. - IPPROTO_FRAGMENT = 44 # IPv6 fragmentation header. - IPPROTO_RSVP = 46 # Reservation Protocol. - IPPROTO_GRE = 47 # General Routing Encapsulation. - IPPROTO_ESP = 50 # encapsulating security payload. - IPPROTO_AH = 51 # authentication header. - IPPROTO_ICMPV6 = 58 # ICMPv6. - IPPROTO_NONE = 59 # IPv6 no next header. - IPPROTO_DSTOPTS = 60 # IPv6 destination options. - IPPROTO_MTP = 92 # Multicast Transport Protocol. - IPPROTO_ENCAP = 98 # Encapsulation Header. - IPPROTO_PIM = 103 # Protocol Independent Multicast. - IPPROTO_COMP = 108 # Compression Header Protocol. - IPPROTO_SCTP = 132 # Stream Control Transmission Protocol. - IPPROTO_RAW = 255 # Raw IP packets. - IPPROTO_MAX - -cdef extern from "Python.h": - object PyBytes_FromStringAndSize(char *s, Py_ssize_t len) - object PyString_FromStringAndSize(char *s, Py_ssize_t len) - -cdef extern from "": - ctypedef long time_t - struct timeval: - time_t tv_sec - time_t tv_usec - struct timezone: - pass -cdef extern from "": +cdef extern from "netinet/in.h": u_int32_t ntohl (u_int32_t __netlong) nogil u_int16_t ntohs (u_int16_t __netshort) nogil u_int32_t htonl (u_int32_t __hostlong) nogil @@ -86,9 +83,7 @@ cdef extern from "libnfnetlink/linux_nfnetlink.h": cdef extern from "libnfnetlink/libnfnetlink.h": struct nfnl_handle: pass - nfnl_handle *nfnl_open() - void nfnl_close(nfnl_handle *h) - int nfnl_fd(nfnl_handle *h) + unsigned int nfnl_rcvbufsiz(nfnl_handle *h, unsigned int size) cdef extern from "libnetfilter_queue/linux_nfnetlink_queue.h": @@ -96,6 +91,7 @@ cdef extern from "libnetfilter_queue/linux_nfnetlink_queue.h": NFQNL_COPY_NONE NFQNL_COPY_META NFQNL_COPY_PACKET + struct nfqnl_msg_packet_hdr: u_int32_t packet_id u_int16_t hw_protocol @@ -104,65 +100,47 @@ cdef extern from "libnetfilter_queue/linux_nfnetlink_queue.h": cdef extern from "libnetfilter_queue/libnetfilter_queue.h": struct nfq_handle: pass + struct nfq_q_handle: pass + struct nfq_data: pass + struct nfqnl_msg_packet_hw: u_int8_t hw_addr[8] nfq_handle *nfq_open() - nfq_handle *nfq_open_nfnl(nfnl_handle *h) int nfq_close(nfq_handle *h) - int nfq_bind_pf(nfq_handle *h, u_int16_t pf) int nfq_unbind_pf(nfq_handle *h, u_int16_t pf) - ctypedef int *nfq_callback(nfq_q_handle *gh, nfgenmsg *nfmsg, - nfq_data *nfad, void *data) - nfq_q_handle *nfq_create_queue(nfq_handle *h, - u_int16_t num, - nfq_callback *cb, - void *data) - - # Any function that parses Netlink replies might invoke the user - # callback and thus might need to propagate a Python exception. - # This includes nfq_handle_packet but is not limited to that -- - # other functions might send a query, read until they get the reply, - # and find a packet notification before the reply which they then - # must deal with. - int nfq_destroy_queue(nfq_q_handle *qh) except? -1 - int nfq_handle_packet(nfq_handle *h, char *buf, int len) except? -1 - int nfq_set_mode(nfq_q_handle *qh, u_int8_t mode, unsigned int len) except? -1 - int nfq_set_queue_maxlen(nfq_q_handle *qh, u_int32_t queuelen) except? -1 - - int nfq_set_verdict(nfq_q_handle *qh, - u_int32_t id, - u_int32_t verdict, - u_int32_t data_len, - unsigned char *buf) nogil - - int nfq_set_verdict2(nfq_q_handle *qh, - u_int32_t id, - u_int32_t verdict, - u_int32_t mark, - u_int32_t datalen, - unsigned char *buf) nogil - + ctypedef int *nfq_callback(nfq_q_handle *gh, nfgenmsg *nfmsg, nfq_data *nfad, void *data) + nfq_q_handle *nfq_create_queue(nfq_handle *h, u_int16_t num, nfq_callback *cb, void *data) + int nfq_destroy_queue(nfq_q_handle *qh) + int nfq_handle_packet(nfq_handle *h, char *buf, int len) + int nfq_set_mode(nfq_q_handle *qh, u_int8_t mode, unsigned int len) + q_set_queue_maxlen(nfq_q_handle *qh, u_int32_t queuelen) + int nfq_set_verdict(nfq_q_handle *qh, u_int32_t id, u_int32_t verdict, u_int32_t data_len, unsigned char *buf) nogil + int nfq_set_verdict2(nfq_q_handle *qh, u_int32_t id, u_int32_t verdict, u_int32_t mark, + u_int32_t datalen, unsigned char *buf) nogil + + int nfq_set_queue_maxlen(nfq_q_handle *qh, u_int32_t queuelen) int nfq_fd(nfq_handle *h) - nfqnl_msg_packet_hdr *nfq_get_msg_packet_hdr(nfq_data *nfad) - int nfq_get_payload(nfq_data *nfad, unsigned char **data) - int nfq_get_timestamp(nfq_data *nfad, timeval *tv) + nfqnl_msg_packet_hdr *nfq_get_msg_packet_hdr(nfq_data *nfad) nogil + int nfq_get_payload(nfq_data *nfad, unsigned char **data) nogil + int nfq_get_timestamp(nfq_data *nfad, timeval *tv) nogil nfqnl_msg_packet_hw *nfq_get_packet_hw(nfq_data *nfad) - int nfq_get_nfmark (nfq_data *nfad) + int nfq_get_nfmark (nfq_data *nfad) nogil + u_int8_t nfq_get_indev(nfq_data *nfad) + u_int8_t nfq_get_outdev(nfq_data *nfad) nfnl_handle *nfq_nfnlh(nfq_handle *h) # Dummy defines from linux/socket.h: cdef enum: # Protocol families, same as address families. PF_INET = 2 PF_INET6 = 10 - PF_NETLINK = 16 -cdef extern from "": +cdef extern from "sys/socket.h": ssize_t recv(int __fd, void *__buf, size_t __n, int __flags) nogil int MSG_DONTWAIT @@ -176,52 +154,41 @@ cdef enum: NF_STOP NF_MAX_VERDICT = NF_STOP -cdef class NetfilterQueue: - cdef object __weakref__ - cdef object user_callback # User callback - cdef nfq_handle *h # Handle to NFQueue library - cdef nfq_q_handle *qh # A handle to the queue -cdef class Packet: - cdef NetfilterQueue _queue - cdef bint _verdict_is_set # True if verdict has been issued, - # false otherwise - cdef bint _mark_is_set # True if a mark has been given, false otherwise - cdef bint _hwaddr_is_set - cdef bint _timestamp_is_set - cdef u_int32_t _given_mark # Mark given to packet - cdef bytes _given_payload # New payload of packet, or null - cdef bytes _owned_payload - - # From NFQ packet header: - cdef readonly u_int32_t id - cdef readonly u_int16_t hw_protocol - cdef readonly u_int8_t hook - cdef readonly u_int32_t mark - - # Packet details: - cdef Py_ssize_t payload_len - cdef unsigned char *payload - cdef timeval timestamp - cdef u_int8_t hw_addr[8] - - # TODO: implement these - #cdef readonly u_int32_t nfmark - #cdef readonly u_int32_t indev - #cdef readonly u_int32_t physindev - #cdef readonly u_int32_t outdev - #cdef readonly u_int32_t physoutdev - - cdef set_nfq_data(self, NetfilterQueue queue, nfq_data *nfa) - cdef drop_refs(self) - cdef int verdict(self, u_int8_t verdict) except -1 - cpdef Py_ssize_t get_payload_len(self) - cpdef double get_timestamp(self) - cpdef bytes get_payload(self) - cpdef set_payload(self, bytes payload) - cpdef set_mark(self, u_int32_t mark) - cpdef get_mark(self) - cpdef retain(self) +cdef class CPacket: + cdef nfq_q_handle *_qh + cdef nfq_data *_nfa + cdef nfqnl_msg_packet_hdr *_hdr + cdef nfqnl_msg_packet_hw *_hw + cdef u_int32_t _id + + # protocol headers + cdef iphdr *ip_header + cdef tcphdr *tcp_header + cdef udphdr *udp_header + cdef icmphdr *icmp_header + + cdef bint _verdict + cdef u_int32_t _mark + + # Packet details + cdef int _data_len + cdef u_int8_t _cmbhdr_len + cdef readonly unsigned char *data + cdef readonly unsigned char *payload + cdef time_t _timestamp + + cdef u_int32_t parse(self, nfq_q_handle *qh, nfq_data *nfa) nogil + cdef void _parse(self) nogil + cdef void verdict(self, u_int32_t verdict) + cpdef update_mark(self, u_int32_t mark) cpdef accept(self) cpdef drop(self) + cpdef forward(self, u_int16_t queue_num) cpdef repeat(self) + +cdef class NetfilterQueue: + cdef nfq_handle *h # Handle to NFQueue library + cdef nfq_q_handle *qh # A handle to the queue + cdef u_int16_t af # Address family + cdef packet_copy_size # Amount of packet metadata + data copied to buffer diff --git a/netfilterqueue/_impl.pyx b/netfilterqueue/_impl.pyx index d656d5b..a2dee2e 100644 --- a/netfilterqueue/_impl.pyx +++ b/netfilterqueue/_impl.pyx @@ -4,9 +4,16 @@ function. Copyright: (c) 2011, Kerkhoff Technologies Inc. License: MIT; see LICENSE.txt + +Expanded features and performance improvements from downstream development +of DNXFIREWALL. + - DOWRIGHT @ Wright Network Solutions, LLC. """ # Constants for module users +import Cython +import socket + COPY_NONE = 0 COPY_META = 1 COPY_PACKET = 2 @@ -41,7 +48,7 @@ cdef int global_callback(nfq_q_handle *qh, nfgenmsg *nfmsg, # so just ignore the packet. The kernel will drop it once we # unbind. return 1 - packet = Packet() + packet = Packet.__new__(Packet) packet.set_nfq_data(nfqueue, nfa) try: user_callback(packet) @@ -49,6 +56,7 @@ cdef int global_callback(nfq_q_handle *qh, nfgenmsg *nfmsg, packet.drop_refs() return 1 +@Cython.freelist(8) cdef class Packet: """A packet received from NetfilterQueue.""" def __cinit__(self): @@ -69,6 +77,8 @@ cdef class Packet: cdef nfqnl_msg_packet_hw *hw cdef nfqnl_msg_packet_hdr *hdr + self._nfa = nfa + hdr = nfq_get_msg_packet_hdr(nfa) self._queue = queue self.id = ntohl(hdr.packet_id) @@ -129,6 +139,46 @@ cdef class Packet: self._verdict_is_set = True + cpdef get_inint(self, bint name=False): + """Returns the index of the inbound interface of the packet. If the packet + sourced from localhost or the input interface is not known, 0/unknown will + be returned respectively. + + if name=True, socket.if_indextoname() will be returned. + """ + cdef object in_interface_name + + in_interface = nfq_get_indev(self._nfa) + if not name: + return in_interface + + try: + in_interface_name = socket.if_indextoname(in_interface) + except OSError: + in_interface_name = 'unknown' + + return in_interface_name + + cpdef get_outint(self, bint name=False): + """Returns the index of the outbound interface of the packet. If the packet + sourced from localhost or the input interface is not known, 0/unknown will + be returned respectively. + + if name=True, socket.if_indextoname() will be returned. + """ + cdef object out_interface_name + + out_interface = nfq_get_outdev(self._nfa) + if not name: + return out_interface + + try: + out_interface_name = socket.if_indextoname(out_interface) + except OSError: + out_interface_name = 'unknown' + + return out_interface_name + def get_hw(self): """Return the packet's source MAC address as a Python bytestring, or None if it's not available. diff --git a/nfq_test.py b/nfq_test.py new file mode 100644 index 0000000..4efb9f4 --- /dev/null +++ b/nfq_test.py @@ -0,0 +1,156 @@ +#!/usr/bin/env python3 + +import threading + +from time import perf_counter_ns +from ipaddress import IPv4Address +from struct import Struct + +from new_packet import set_user_callback, NetfilterQueue # pylint: disable=import-error + +short_unpack = Struct('!H').unpack + +TEST_FORWARD = 0 + +def print_and_accept(pkt, pkt_mark): + print('+'*30) + + start = perf_counter_ns() + +# print(pkt_mark) + + hw_info = pkt.get_hw() + print('[rcvd] hw info') + + # print(hw_info) + +# print(hw_info[2].hex()) + + # print('-'*30) + + data = pkt.get_raw_packet() + + print('[rcvd] RAW PACKET') + +# print(data[0], (data[0] & 15) * 4) + + # print('-'*30) + + ip_header = pkt.get_ip_header() + if ip_header[6] == 6: + print('[rcvd] ip header') + +# print(ip_header) + print(ip_header[6], IPv4Address(ip_header[8]), IPv4Address(ip_header[9])) + +# print('-'*30) + + proto_header = pkt.get_proto_header() + + if ip_header[6] == 6: + print('[rcvd] proto header') + print(f'th_off={proto_header[4]}', proto_header) + + print('-'*30) + + if ip_header[6] == 6: + + + payload = pkt.get_payload() + print(payload) + +# t, s, d = pkt.get_ip_header() + +# print(array('i', pkt.get_ip_header())) +# print(pkt, pkt.get_timestamp()) + +# print(f'[IN] {pkt.get_inint()} {pkt.get_inint(name=True)}') +# print(f'[OUT] {pkt.get_outint()} {pkt.get_outint(name=True)}') + +# pkt.update_mark(69) + +# print(f'[MARK] {pkt.get_initial_mark()} {pkt.get_modified_mark()} ') + +# print(pkt.payload_test) + + total = perf_counter_ns() - start + + pkt.accept() + + print(f'GRABBED IN: {total} ns') + + print('='*30) + +def q_one(pkt): + print('+'*30) + + print('[Q1/rcvd]') +# print(f'[IN] {pkt.get_inint()} {pkt.get_inint(name=True)}') +# print(f'[OUT] {pkt.get_outint()} {pkt.get_outint(name=True)}') + +# pkt.update_mark(69) + +# print(f'[MARK] {pkt.get_initial_mark()} {pkt.get_modified_mark()}') + +# pkt.forward(2) +# print('[Q1/forward] > 2') + + print('-'*30) + +def q_two(pkt): + print('+'*30) + + print('[Q2/rcvd]') + print(f'[IN] {pkt.get_inint()} {pkt.get_inint(name=True)}') + print(f'[OUT] {pkt.get_outint()} {pkt.get_outint(name=True)}') + + pkt.update_mark(70) + + print(f'[MARK] {pkt.get_initial_mark()} {pkt.get_modified_mark()}') + + pkt.accept() + + print('[Q2/accept]') + + print('-'*30) + +def queue(callback, queue_num): + set_user_callback(callback) + + nfqueue = NetfilterQueue() + nfqueue.bind(queue_num) + + print(f'[START] QUEUE-{queue_num}') + + try: + nfqueue.run() + except KeyboardInterrupt: + print('') + + finally: + nfqueue.unbind() + +def tcp_test(packet, mark): + print('+'*30) + + start = perf_counter_ns() + ip_header = packet.get_ip_header() + if ip_header[6] == 6: + proto_header = packet.get_proto_header() + print(f'{IPv4Address(ip_header[8])}:{proto_header[0]} > {IPv4Address(ip_header[9])}:{proto_header[1]}') + print(packet.get_ip_header_raw()) + print(packet.get_proto_header_raw()) + print(packet.get_raw_packet()) + + print('='*30) + +if __name__ == '__main__': + + CALLBACK = tcp_test + + if (TEST_FORWARD): + threading.Thread(target=queue, args=(q_one, 1)).start() + threading.Thread(target=queue, args=(q_two, 2)).start() + + else: + queue(CALLBACK, 1)