diff --git a/.github/workflows/pull_requests.yml b/.github/workflows/pull_requests.yml new file mode 100644 index 0000000..91151e0 --- /dev/null +++ b/.github/workflows/pull_requests.yml @@ -0,0 +1,43 @@ +name: Pull Request +on: + pull_request: + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: ci-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + name: Build and Test (Java ${{ matrix.java }}) + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + java: [ '17', '21' ] + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Java + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: ${{ matrix.java }} + cache: maven + + - name: Build and test + run: | + mvn -B -e -DskipITs=true -DskipIT=true -DskipITsTests=true -DskipIntegrationTests=true -DskipDocker=true -DskipNative=true -DskipExamples=true --fail-at-end clean verify + + - name: Upload test reports + if: always() + uses: actions/upload-artifact@v4 + with: + name: test-reports-java-${{ matrix.java }} + path: | + ./**/target/surefire-reports/** + ./**/target/failsafe-reports/** diff --git a/LICENSE b/LICENSE index f288702..54ee4f7 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - 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 -. +MIT License + +Copyright (c) 2025 Semtech + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 9325cb3..356a6a5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,65 @@ -# proxy-socket-java -Java Library to handle ProxyProtocol v2 on standard java sockets +Proxy Socket Java (UDP + TCP, Java 17) +======================================= + +Overview +-------- +Library providing HAProxy Proxy Protocol v2 support for UDP and TCP. Multi-module layout: + +- proxy-socket-core: zero dependencies, parser, models, interfaces +- proxy-socket-udp: DatagramSocket wrapper +- proxy-socket-tcp: ServerSocket/Socket wrappers +- proxy-socket-guava: optional Guava-based cache +- proxy-socket-examples: runnable samples + +Reference: [HAProxy Proxy Protocol Specifications](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) + +Quick start (UDP) +----------------- +```java +var socket = new net.airvantage.proxysocket.udp.ProxyDatagramSocket.Builder() + .maxEntries(10_000) + .ttl(java.time.Duration.ofMinutes(5)) + .metrics(new MyMetrics()) + .build(); +socket.bind(new java.net.InetSocketAddress(9999)); +var buf = new byte[2048]; +var packet = new java.net.DatagramPacket(buf, buf.length); +socket.receive(packet); // header stripped, source set to real client +socket.send(packet); // destination rewritten to LB if cached +``` + +Quick start (TCP) +----------------- +```java +try (var server = new net.airvantage.proxysocket.tcp.ProxyServerSocket(9998)) { + for (;;) { + var s = (net.airvantage.proxysocket.tcp.ProxySocket) server.accept(); + var header = s.getHeader(); + // header.getSourceAddress() is the real client address + } +} +``` + +License +------- +MIT License © 2025 Semtech. See `LICENSE`. + +Metrics hook +------------ +Implement `net.airvantage.proxysocket.core.ProxySocketMetricsListener` and pass it via UDP builder or TCP server ctor. + +Thread safety +------------- +- UDP/TCP wrappers follow JDK `DatagramSocket`/`ServerSocket`/`Socket` thread-safety; caches and listeners must be thread-safe. +- Core parser is stateless and thread-safe. + +Configuration +------------- +- UDP cache defaults: 10k entries, 5 min TTL if Guava present; otherwise concurrent map (no TTL). +- TCP: blocking header read on accept with configurable timeout. + +Examples +-------- +See `proxy-socket-examples` module: `UdpEchoWithProxyProtocol`, `TcpEchoWithProxyProtocol`. + + diff --git a/pom.xml b/pom.xml new file mode 100755 index 0000000..dfe14d6 --- /dev/null +++ b/pom.xml @@ -0,0 +1,99 @@ + + + + 4.0.0 + + net.airvantage + proxysocket-java + 1.0.0-SNAPSHOT + pom + + ProxyProtocol Java implementation. + + + + + 5.10.3 + 33.3.1-jre + + + + + proxy-socket-core + proxy-socket-udp + + + + + + + org.testcontainers + testcontainers-bom + 2.0.1 + pom + import + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.11.0 + + UTF-8 + 17 + + + + + org.apache.maven.plugins + maven-surefire-plugin + 3.2.5 + + false + + + + + org.apache.maven.plugins + maven-resources-plugin + 3.3.1 + + UTF-8 + + + + + org.apache.maven.plugins + maven-eclipse-plugin + 2.10 + + true + true + + + + + org.apache.maven.plugins + maven-source-plugin + 3.3.0 + + + attach-sources + + jar + + + + + + + + diff --git a/proxy-socket-core/pom.xml b/proxy-socket-core/pom.xml new file mode 100644 index 0000000..de118de --- /dev/null +++ b/proxy-socket-core/pom.xml @@ -0,0 +1,31 @@ + + + 4.0.0 + + net.airvantage + proxysocket-java + 1.0.0-SNAPSHOT + + proxy-socket-core + Proxy Protocol - Core + jar + + + 17 + + + + + + org.junit.jupiter + junit-jupiter + ${junit.version} + test + + + + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyAddressCache.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyAddressCache.java new file mode 100644 index 0000000..cfa6149 --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyAddressCache.java @@ -0,0 +1,20 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core; + +import java.net.InetSocketAddress; + +/** + * Thread-safe cache abstraction mapping real client addresses to proxy/load-balancer addresses. + */ +public interface ProxyAddressCache { + void put(InetSocketAddress clientAddr, InetSocketAddress proxyAddr); + InetSocketAddress get(InetSocketAddress clientAddr); + void invalidate(InetSocketAddress clientAddr); + void clear(); +} + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolException.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolException.java new file mode 100644 index 0000000..a23d246 --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolException.java @@ -0,0 +1,17 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core; + +public class ProxyProtocolException extends Exception { + public ProxyProtocolException(String message) { + super(message); + } + public ProxyProtocolException(String message, Throwable cause) { + super(message, cause); + } +} + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolMetricsListener.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolMetricsListener.java new file mode 100644 index 0000000..6ff4225 --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolMetricsListener.java @@ -0,0 +1,19 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core; + +import net.airvantage.proxysocket.core.v2.ProxyHeader; +import java.net.InetSocketAddress; + +/** + * Metrics/observability callbacks for Proxy Protocol processing. + * Implementations must be thread-safe. + */ +public interface ProxyProtocolMetricsListener { + default void onHeaderParsed(ProxyHeader header) {} + default void onParseError(Exception e) {} + default void onCacheHit(InetSocketAddress client) {} + default void onCacheMiss(InetSocketAddress client) {} +} \ No newline at end of file diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolParseException.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolParseException.java new file mode 100644 index 0000000..1faee06 --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/ProxyProtocolParseException.java @@ -0,0 +1,17 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core; + +public final class ProxyProtocolParseException extends ProxyProtocolException { + public ProxyProtocolParseException(String message) { + super(message); + } + public ProxyProtocolParseException(String message, Throwable cause) { + super(message, cause); + } +} + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/cache/ConcurrentMapProxyAddressCache.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/cache/ConcurrentMapProxyAddressCache.java new file mode 100644 index 0000000..918353d --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/cache/ConcurrentMapProxyAddressCache.java @@ -0,0 +1,49 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core.cache; + +import net.airvantage.proxysocket.core.ProxyAddressCache; +import java.net.InetSocketAddress; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentMap; + +/** + * Simple thread-safe cache backed by {@link ConcurrentHashMap}. + */ +public final class ConcurrentMapProxyAddressCache implements ProxyAddressCache { + private final ConcurrentMap map = new ConcurrentHashMap<>(); + + @Override + public void put(InetSocketAddress clientAddr, InetSocketAddress proxyAddr) { + if (clientAddr == null || proxyAddr == null) { + return; + } + map.put(clientAddr, proxyAddr); + } + + @Override + public InetSocketAddress get(InetSocketAddress clientAddr) { + if (clientAddr == null) { + return null; + } + return map.get(clientAddr); + } + + @Override + public void invalidate(InetSocketAddress clientAddr) { + if (clientAddr == null) { + return; + } + map.remove(clientAddr); + } + + @Override + public void clear() { + map.clear(); + } +} + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/cache/NoOpProxyAddressCache.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/cache/NoOpProxyAddressCache.java new file mode 100644 index 0000000..9a5e504 --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/cache/NoOpProxyAddressCache.java @@ -0,0 +1,28 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core.cache; + +import net.airvantage.proxysocket.core.ProxyAddressCache; +import java.net.InetSocketAddress; + +/** + * No-op implementation useful when state should not be retained. + */ +public final class NoOpProxyAddressCache implements ProxyAddressCache { + @Override + public void put(InetSocketAddress clientAddr, InetSocketAddress proxyAddr) { } + + @Override + public InetSocketAddress get(InetSocketAddress clientAddr) { return null; } + + @Override + public void invalidate(InetSocketAddress clientAddr) { } + + @Override + public void clear() { } +} + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyHeader.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyHeader.java new file mode 100644 index 0000000..8efcabf --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyHeader.java @@ -0,0 +1,53 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core.v2; + +import java.net.InetSocketAddress; +import java.util.Collections; +import java.util.List; + +public final class ProxyHeader { + public enum Command { LOCAL, PROXY } + public enum AddressFamily { INET4, INET6, UNIX, UNSPEC } + public enum TransportProtocol { STREAM, DGRAM, UNSPEC } + + private final Command command; + private final AddressFamily family; + private final TransportProtocol socket; + private final InetSocketAddress sourceAddress; + private final InetSocketAddress destinationAddress; + private final List tlvs; + private final int headerLength; + + public ProxyHeader(Command command, + AddressFamily family, + TransportProtocol socket, + InetSocketAddress sourceAddress, + InetSocketAddress destinationAddress, + List tlvs, + int headerLength) { + this.command = command; + this.family = family; + this.socket = socket; + this.sourceAddress = sourceAddress; + this.destinationAddress = destinationAddress; + this.tlvs = tlvs == null ? List.of() : List.copyOf(tlvs); + this.headerLength = headerLength; + } + + public Command getCommand() { return command; } + public AddressFamily getFamily() { return family; } + public TransportProtocol getProtocol() { return socket; } + public InetSocketAddress getSourceAddress() { return sourceAddress; } + public InetSocketAddress getDestinationAddress() { return destinationAddress; } + public List getTlvs() { return Collections.unmodifiableList(tlvs); } + public int getHeaderLength() { return headerLength; } + + public boolean isLocal() { return command == Command.LOCAL; } + public boolean isProxy() { return command == Command.PROXY; } +} + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Decoder.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Decoder.java new file mode 100644 index 0000000..485a8a6 --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Decoder.java @@ -0,0 +1,150 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core.v2; + +import net.airvantage.proxysocket.core.ProxyProtocolParseException; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.net.UnknownHostException; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.List; + +/** + * Dependency-free Proxy Protocol v2 utilities (validate/parse/build). + */ +public final class ProxyProtocolV2Decoder { + private ProxyProtocolV2Decoder() {} + + private static final byte[] SIG = "\r\n\r\n\0\r\nQUIT\n".getBytes(StandardCharsets.ISO_8859_1); + private static final int IPV4_ADDR_LEN = 4; + private static final int IPV6_ADDR_LEN = 16; + private static final int UNIX_ADDR_LEN = 216; + private static final int PORT_LEN = 2; + private static final int TLV_HEADER_LEN = 3; + + public static ProxyHeader parse(byte[] data, int offset, int length) throws ProxyProtocolParseException { + if (data == null || offset < 0 || length < 0) throw new ProxyProtocolParseException("Null data"); + if ((length+offset) > data.length) throw new ProxyProtocolParseException("Invalid offset/length"); + + int end = offset + length; + if (SIG.length + 4 > length) throw new ProxyProtocolParseException("Insufficient data for header"); + + for (int i = 0; i < SIG.length; i++) { + if (data[offset + i] != SIG[i]) { + throw new ProxyProtocolParseException("Invalid signature"); + } + } + + int pos = offset + SIG.length; + + int verCmd = data[pos++] & 0xFF; // version/command + int version = (verCmd >> 4) & 0x0F; + if (version != 2) throw new ProxyProtocolParseException("Invalid version"); + int cmd = verCmd & 0x0F; + ProxyHeader.Command command = cmd == 0x00 ? ProxyHeader.Command.LOCAL : ProxyHeader.Command.PROXY; + + int famProto = data[pos++] & 0xFF; + int fam = famProto & 0xF0; + int proto = famProto & 0x0F; + + ProxyHeader.AddressFamily af = switch (fam) { + case 0x10 -> ProxyHeader.AddressFamily.INET4; + case 0x20 -> ProxyHeader.AddressFamily.INET6; + case 0x30 -> ProxyHeader.AddressFamily.UNIX; + default -> ProxyHeader.AddressFamily.UNSPEC; + }; + ProxyHeader.TransportProtocol tp = switch (proto) { + case 0x01 -> ProxyHeader.TransportProtocol.STREAM; // TCP + case 0x02 -> ProxyHeader.TransportProtocol.DGRAM; // UDP + default -> ProxyHeader.TransportProtocol.UNSPEC; + }; + + int variableLength = ((data[pos++] & 0xFF) << 8) | (data[pos++] & 0xFF); + + int headerLen = SIG.length + 4 + variableLength; + if (headerLen > length) throw new ProxyProtocolParseException("Insufficient data for header"); + + int addrStart = pos; + InetSocketAddress src = null; + InetSocketAddress dst = null; + + if (command == ProxyHeader.Command.PROXY) { + if (af == ProxyHeader.AddressFamily.INET4 && tp != ProxyHeader.TransportProtocol.UNSPEC) { + if (variableLength < 2*(IPV4_ADDR_LEN + PORT_LEN)) { + throw new ProxyProtocolParseException("Truncated IPv4 address block in header"); + } + + // Extract source and destination addresses + InetAddress s; + InetAddress d; + try { + s = InetAddress.getByAddress(new byte[]{data[pos++], data[pos++], data[pos++], data[pos++]}); + d = InetAddress.getByAddress(new byte[]{data[pos++], data[pos++], data[pos++], data[pos++]}); + } catch (UnknownHostException e) { + throw new ProxyProtocolParseException("Invalid IPv4 address in header", e); + } + // Extract source and destination ports + int sp = ((data[pos++] & 0xFF) << 8) | (data[pos++] & 0xFF); + int dp = ((data[pos++] & 0xFF) << 8) | (data[pos++] & 0xFF); + src = new InetSocketAddress(s, sp); + dst = new InetSocketAddress(d, dp); + + } else if (af == ProxyHeader.AddressFamily.INET6 && tp != ProxyHeader.TransportProtocol.UNSPEC) { + if (variableLength < 2*(IPV6_ADDR_LEN + PORT_LEN)) { + throw new ProxyProtocolParseException("Truncated IPv6 address block in header"); + } + + // Extract source and destination addresses + InetAddress s; + InetAddress d; + byte[] sb = new byte[16]; + byte[] db = new byte[16]; + System.arraycopy(data, pos, sb, 0, IPV6_ADDR_LEN); + System.arraycopy(data, pos+IPV6_ADDR_LEN, db, 0, IPV6_ADDR_LEN); + try { + s = InetAddress.getByAddress(sb); + d = InetAddress.getByAddress(db); + } catch (UnknownHostException e) { + throw new ProxyProtocolParseException("Invalid IPv6 address in header", e); + } + + pos += 2*IPV6_ADDR_LEN; + // Extract source and destination ports + int sp = ((data[pos++] & 0xFF) << 8) | (data[pos++] & 0xFF); + int dp = ((data[pos++] & 0xFF) << 8) | (data[pos++] & 0xFF); + src = new InetSocketAddress(s, sp); + dst = new InetSocketAddress(d, dp); + + } else if (af == ProxyHeader.AddressFamily.UNIX) { + // 108 + 108 bytes path + if (variableLength < 2*UNIX_ADDR_LEN) { + throw new ProxyProtocolParseException("Truncated UNIX address block in header"); + } + pos += 2*UNIX_ADDR_LEN; + throw new ProxyProtocolParseException("UNIX Address Processing not implemented"); + } + } + + int consumed = pos - addrStart; + int tlvLen = Math.max(0, variableLength - consumed); + List tlvs = new ArrayList<>(); + int tlvPos = pos; + int tlvEnd = tlvPos + tlvLen; + while (tlvPos + TLV_HEADER_LEN <= tlvEnd) { + int type = data[tlvPos++] & 0xFF; + int len = ((data[tlvPos++] & 0xFF) << 8) | (data[tlvPos++] & 0xFF); + + if (tlvPos + len > tlvEnd) break; + tlvs.add(new Tlv(type, data, tlvPos, len)); + tlvPos += len; + } + + return new ProxyHeader(command, af, tp, src, dst, tlvs, headerLen); + } +} + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Encoder.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Encoder.java new file mode 100644 index 0000000..f19eb12 --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Encoder.java @@ -0,0 +1,122 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core.v2; + +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.List; + +/** + * Minimal builder for generating Proxy Protocol v2 headers for tests. + */ +public final class ProxyProtocolV2Encoder { + private static final byte[] SIG = "\r\n\r\n\0\r\nQUIT\n".getBytes(StandardCharsets.ISO_8859_1); + + private ProxyHeader.Command command = ProxyHeader.Command.PROXY; + private ProxyHeader.AddressFamily family = ProxyHeader.AddressFamily.INET4; + private ProxyHeader.TransportProtocol socket = ProxyHeader.TransportProtocol.STREAM; + private InetSocketAddress source; + private InetSocketAddress destination; + private final List tlvs = new ArrayList<>(); + + public ProxyProtocolV2Encoder command(ProxyHeader.Command c) { this.command = c; return this; } + public ProxyProtocolV2Encoder family(ProxyHeader.AddressFamily f) { this.family = f; return this; } + public ProxyProtocolV2Encoder socket(ProxyHeader.TransportProtocol p) { this.socket = p; return this; } + public ProxyProtocolV2Encoder source(InetSocketAddress s) { this.source = s; return this; } + public ProxyProtocolV2Encoder destination(InetSocketAddress d) { this.destination = d; return this; } + public ProxyProtocolV2Encoder addTlv(int type, byte[] value) { this.tlvs.add(new Tlv(type, value, 0, value.length)); return this; } + + public byte[] build() { + byte verCmd = (byte) ((2 << 4) | (command == ProxyHeader.Command.PROXY ? 0x01 : 0x00)); + int fam = switch (family) { case INET4 -> 0x10; case INET6 -> 0x20; case UNIX -> 0x30; default -> 0x00; }; + int proto = switch (socket) { case STREAM -> 0x01; case DGRAM -> 0x02; default -> 0x00; }; + byte famProto = (byte) (fam | proto); + + byte[] addr = buildAddr(); + byte[] tlvBytes = buildTlvs(); + int addrLen = addr.length + tlvBytes.length; + byte[] out = new byte[16 + addrLen]; + int p = 0; + System.arraycopy(SIG, 0, out, p, SIG.length); p += SIG.length; + out[p++] = verCmd; + out[p++] = famProto; + out[p++] = (byte) ((addrLen >>> 8) & 0xFF); + out[p++] = (byte) (addrLen & 0xFF); + System.arraycopy(addr, 0, out, p, addr.length); p += addr.length; + System.arraycopy(tlvBytes, 0, out, p, tlvBytes.length); + return out; + } + + private byte[] buildAddr() { + if (command == ProxyHeader.Command.LOCAL) return new byte[0]; + if (family == ProxyHeader.AddressFamily.INET4 && (socket == ProxyHeader.TransportProtocol.STREAM || socket == ProxyHeader.TransportProtocol.DGRAM)) { + byte[] b = new byte[12]; + writeIPv4PortPair(b); + return b; + } + if (family == ProxyHeader.AddressFamily.INET6 && (socket == ProxyHeader.TransportProtocol.STREAM || socket == ProxyHeader.TransportProtocol.DGRAM)) { + byte[] b = new byte[36]; + writeIPv6PortPair(b); + return b; + } + return new byte[0]; + } + + private void writeIPv4PortPair(byte[] b) { + byte[] src = source == null ? new byte[4] : source.getAddress().getAddress(); + byte[] dst = destination == null ? new byte[4] : destination.getAddress().getAddress(); + System.arraycopy(src, 0, b, 0, 4); + System.arraycopy(dst, 0, b, 4, 4); + int sp = source == null ? 0 : source.getPort(); + int dp = destination == null ? 0 : destination.getPort(); + b[8] = (byte) ((sp >>> 8) & 0xFF); b[9] = (byte) (sp & 0xFF); + b[10] = (byte) ((dp >>> 8) & 0xFF); b[11] = (byte) (dp & 0xFF); + } + + private void writeIPv6PortPair(byte[] b) { + byte[] src = source == null ? new byte[16] : toIPv6Bytes(source.getAddress()); + byte[] dst = destination == null ? new byte[16] : toIPv6Bytes(destination.getAddress()); + System.arraycopy(src, 0, b, 0, 16); + System.arraycopy(dst, 0, b, 16, 16); + int sp = source == null ? 0 : source.getPort(); + int dp = destination == null ? 0 : destination.getPort(); + b[32] = (byte) ((sp >>> 8) & 0xFF); b[33] = (byte) (sp & 0xFF); + b[34] = (byte) ((dp >>> 8) & 0xFF); b[35] = (byte) (dp & 0xFF); + } + + private static byte[] toIPv6Bytes(InetAddress addr) { + byte[] a = addr.getAddress(); + if (a.length == 16) return a; + // IPv4-mapped IPv6 ::ffff:a.b.c.d + byte[] v6 = new byte[16]; + v6[10] = (byte) 0xFF; v6[11] = (byte) 0xFF; + System.arraycopy(a, 0, v6, 12, 4); + return v6; + } + + private byte[] buildTlvs() { + int total = 0; + for (Tlv t : tlvs) total += 3 + (t.getValue() == null ? 0 : t.getValue().length); + byte[] buf = new byte[total]; + int p = 0; + for (Tlv t : tlvs) { + byte[] v = t.getValue(); + int len = v == null ? 0 : v.length; + buf[p++] = (byte) (t.getType() & 0xFF); + buf[p++] = (byte) ((len >>> 8) & 0xFF); + buf[p++] = (byte) (len & 0xFF); + if (len > 0) { + System.arraycopy(v, 0, buf, p, len); + p += len; + } + } + return buf; + } +} + + + diff --git a/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/Tlv.java b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/Tlv.java new file mode 100644 index 0000000..e072a4f --- /dev/null +++ b/proxy-socket-core/src/main/java/net/airvantage/proxysocket/core/v2/Tlv.java @@ -0,0 +1,30 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.core.v2; + +import java.util.Arrays; + +public final class Tlv { + private final int type; + private final byte[] value; + + public Tlv(int type, byte[] data, int offset, int length) { + this.type = type; + this.value = Arrays.copyOfRange(data, offset, offset + length); + } + + public int getType() { return type; } + public byte[] getValue() { return value.clone(); } + + @Override + public String toString() { + int show = Math.min(value.length, 16); + byte[] head = Arrays.copyOf(value, show); + return "Tlv{" + "type=" + type + ", len=" + value.length + ", head=" + Arrays.toString(head) + (value.length > show ? ", ..." : "") + '}'; + } +} + + + diff --git a/proxy-socket-core/src/test/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2DecoderTest.java b/proxy-socket-core/src/test/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2DecoderTest.java new file mode 100644 index 0000000..0a25710 --- /dev/null +++ b/proxy-socket-core/src/test/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2DecoderTest.java @@ -0,0 +1,139 @@ +package net.airvantage.proxysocket.core.v2; + +import net.airvantage.proxysocket.core.ProxyProtocolParseException; +import org.junit.jupiter.api.Test; + +import java.nio.charset.StandardCharsets; + +import static org.junit.jupiter.api.Assertions.*; + +class ProxyProtocolV2DecoderTest { + private static final byte[] SIG = "\r\n\r\n\0\r\nQUIT\n".getBytes(StandardCharsets.ISO_8859_1); + + @Test + void validateRejectsNonHeader() { + byte[] data = "hello".getBytes(StandardCharsets.UTF_8); + assertThrows(ProxyProtocolParseException.class, () -> ProxyProtocolV2Decoder.parse(data, 0, data.length)); + } + + @Test + void decodeIPv4Tcp() throws Exception { + byte verCmd = (byte) 0x21; // v2, PROXY + byte famProto = (byte) 0x11; // INET4 + STREAM + byte[] payload = new byte[]{ + // len = 12 + 0x00, 0x0C, + // src 127.0.0.1 + 0x7F, 0x00, 0x00, 0x01, + // dst 127.0.0.2 + 0x7F, 0x00, 0x00, 0x02, + // sport 12345 (0x3039) + 0x30, 0x39, + // dport 443 (0x01BB) + 0x01, (byte) 0xBB + }; + byte[] h = new byte[SIG.length + 4 + 12]; + int p = 0; System.arraycopy(SIG, 0, h, p, SIG.length); p += SIG.length; + h[p++] = verCmd; h[p++] = famProto; + System.arraycopy(payload, 0, h, p, payload.length); + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(h, 0, h.length); + assertEquals(ProxyHeader.Command.PROXY, parsed.getCommand()); + assertEquals(ProxyHeader.AddressFamily.INET4, parsed.getFamily()); + assertEquals(ProxyHeader.TransportProtocol.STREAM, parsed.getProtocol()); + assertEquals(12345, parsed.getSourceAddress().getPort()); + assertEquals(443, parsed.getDestinationAddress().getPort()); + assertEquals(h.length, parsed.getHeaderLength()); + } + + @Test + void decodeIPv6Udp() throws Exception { + byte verCmd = (byte) 0x21; // v2, PROXY + byte famProto = (byte) 0x22; // INET6 + DGRAM + + byte[] addr = new byte[2 + 36]; + // len = 36 + addr[0] = 0x00; addr[1] = 0x24; + int q = 2; + // src ::1 + for (int i = 0; i < 15; i++) addr[q + i] = 0x00; addr[q + 15] = 0x01; q += 16; + // dst ::2 + for (int i = 0; i < 15; i++) addr[q + i] = 0x00; addr[q + 15] = 0x02; q += 16; + // sport 1000 (0x03E8) + addr[q++] = 0x03; addr[q++] = (byte) 0xE8; + // dport 2000 (0x07D0) + addr[q++] = 0x07; addr[q++] = (byte) 0xD0; + + byte[] h = new byte[SIG.length + 4 + 36]; + int p = 0; System.arraycopy(SIG, 0, h, p, SIG.length); p += SIG.length; + h[p++] = verCmd; h[p++] = famProto; + System.arraycopy(addr, 0, h, p, addr.length); + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(h, 0, h.length); + assertEquals(ProxyHeader.AddressFamily.INET6, parsed.getFamily()); + assertEquals(ProxyHeader.TransportProtocol.DGRAM, parsed.getProtocol()); + assertEquals(1000, parsed.getSourceAddress().getPort()); + assertEquals(2000, parsed.getDestinationAddress().getPort()); + assertEquals(h.length, parsed.getHeaderLength()); + } + + @Test + void decodeLocal() throws Exception { + byte verCmd = (byte) 0x20; // v2, LOCAL + byte famProto = (byte) 0x00; // UNSPEC + byte[] h = new byte[SIG.length + 4]; + int p = 0; System.arraycopy(SIG, 0, h, p, SIG.length); p += SIG.length; + h[p++] = verCmd; h[p++] = famProto; h[p++] = 0x00; h[p++] = 0x00; + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(h, 0, h.length); + assertTrue(parsed.isLocal()); + assertNull(parsed.getSourceAddress()); + assertEquals(16, parsed.getHeaderLength()); + } + + @Test + void decodeUnspecWithTlvOnly() throws Exception { + byte verCmd = (byte) 0x21; // v2, PROXY + byte famProto = (byte) 0x00; // UNSPEC + UNSPEC + + // TLV: type=0xEE, len=3, value=10 20 30 + byte[] tlv = new byte[]{ (byte) 0xEE, 0x00, 0x03, 0x10, 0x20, 0x30 }; + // variable length = 0 (addr) + TLV len (6) + byte[] h = new byte[SIG.length + 4 + tlv.length]; + int p = 0; System.arraycopy(SIG, 0, h, p, SIG.length); p += SIG.length; + h[p++] = verCmd; h[p++] = famProto; + h[p++] = 0x00; h[p++] = (byte) tlv.length; + System.arraycopy(tlv, 0, h, p, tlv.length); + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(h, 0, h.length); + assertEquals(ProxyHeader.AddressFamily.UNSPEC, parsed.getFamily()); + assertNotNull(parsed.getTlvs()); + assertEquals(1, parsed.getTlvs().size()); + assertArrayEquals(new byte[]{0x10, 0x20, 0x30}, parsed.getTlvs().get(0).getValue()); + } + + @Test + void invalidSignature() throws Exception { + byte[] h = new byte[SIG.length + 4]; + int p = 0; System.arraycopy(SIG, 0, h, p, SIG.length); p += SIG.length; + h[0] ^= 0x01; // corrupt + h[p++] = 0x20; h[p++] = 0x00; h[p++] = 0x00; h[p++] = 0x00; + assertThrows(ProxyProtocolParseException.class, () -> ProxyProtocolV2Decoder.parse(h, 0, h.length)); + } + + + @Test + void invalidVersion() throws Exception { + byte verCmd = (byte) 0x31; // v3, LOCAL + byte famProto = (byte) 0x00; // UNSPEC + UNSPEC + byte[] h = new byte[SIG.length + 4]; + int p = 0; System.arraycopy(SIG, 0, h, p, SIG.length); p += SIG.length; + h[p++] = verCmd; h[p++] = famProto; + h[p++] = 0x00; h[p++] = 0x00; + + assertThrows(ProxyProtocolParseException.class, () -> ProxyProtocolV2Decoder.parse(h, 0, h.length)); + } + +} + + diff --git a/proxy-socket-core/src/test/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Test.java b/proxy-socket-core/src/test/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Test.java new file mode 100644 index 0000000..4d820fa --- /dev/null +++ b/proxy-socket-core/src/test/java/net/airvantage/proxysocket/core/v2/ProxyProtocolV2Test.java @@ -0,0 +1,127 @@ +package net.airvantage.proxysocket.core.v2; + +import net.airvantage.proxysocket.core.ProxyProtocolParseException; +import org.junit.jupiter.api.Test; + +import java.net.InetSocketAddress; +import java.nio.charset.StandardCharsets; + +import static org.junit.jupiter.api.Assertions.*; + +class ProxyProtocolV2Test { + @Test + void parseIPv4Tcp() throws Exception { + var header = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.STREAM) + .source(new InetSocketAddress("127.0.0.1", 12345)) + .destination(new InetSocketAddress("127.0.0.2", 443)) + .build(); + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(header, 0, header.length); + assertEquals(ProxyHeader.Command.PROXY, parsed.getCommand()); + assertEquals(ProxyHeader.AddressFamily.INET4, parsed.getFamily()); + assertEquals(ProxyHeader.TransportProtocol.STREAM, parsed.getProtocol()); + assertEquals(12345, parsed.getSourceAddress().getPort()); + assertEquals(443, parsed.getDestinationAddress().getPort()); + } + + @Test + void parseIPv6UdpWithTlv() throws Exception { + var header = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET6) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(new InetSocketAddress("::1", 1000)) + .destination(new InetSocketAddress("::2", 2000)) + .addTlv(0x01, new byte[]{0x41, 0x42}) + .build(); + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(header, 0, header.length); + assertEquals(ProxyHeader.AddressFamily.INET6, parsed.getFamily()); + assertEquals(ProxyHeader.TransportProtocol.DGRAM, parsed.getProtocol()); + assertEquals(1, parsed.getTlvs().size()); + assertArrayEquals(new byte[]{0x41, 0x42}, parsed.getTlvs().get(0).getValue()); + } + + @Test + void parseLocal() throws Exception { + var header = new ProxyProtocolV2Encoder() + .command(ProxyHeader.Command.LOCAL) + .build(); + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(header, 0, header.length); + assertTrue(parsed.isLocal()); + assertNull(parsed.getSourceAddress()); + } + + + @Test + void tlvLengthOverrunIgnored() throws Exception { + // Build header then break TLV length to exceed buffer; parser should stop TLV loop gracefully + var builder = new ProxyProtocolV2Encoder() + .addTlv(0x01, new byte[]{0x01}); + byte[] h = builder.build(); + // Set TLV length to something large + int tlvStart = h.length - 3 - 1; // type(1) + len(2) + value(1) + h[tlvStart + 1] = (byte) 0x7F; + h[tlvStart + 2] = (byte) 0x7F; + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(h, 0, h.length); + assertNotNull(parsed); + } + + @Test + void parseIPv4Udp() throws Exception { + var header = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(new InetSocketAddress("127.0.0.1", 1111)) + .destination(new InetSocketAddress("127.0.0.2", 2222)) + .build(); + + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(header, 0, header.length); + assertEquals(ProxyHeader.TransportProtocol.DGRAM, parsed.getProtocol()); + assertEquals(1111, parsed.getSourceAddress().getPort()); + assertEquals(2222, parsed.getDestinationAddress().getPort()); + } + + @Test + void localHeaderHasLength16() throws Exception { + var header = new ProxyProtocolV2Encoder() + .command(ProxyHeader.Command.LOCAL) + .build(); + assertEquals(16, header.length); + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(header, 0, header.length); + assertEquals(16, parsed.getHeaderLength()); + } + + + + @Test + void addressLengthBeyondBufferInvalid() { + byte[] h = new ProxyProtocolV2Encoder().build(); + // Bump declared length by one without providing data + int lenPos = 14; + int len = ((h[lenPos] & 0xFF) << 8) | (h[lenPos + 1] & 0xFF); + len += 1; + h[lenPos] = (byte) ((len >>> 8) & 0xFF); + h[lenPos + 1] = (byte) (len & 0xFF); + assertThrows(ProxyProtocolParseException.class, () -> ProxyProtocolV2Decoder.parse(h, 0, h.length)); + } + + @Test + void proxyUnspecWithTlvOnly() throws Exception { + var header = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.UNSPEC) + .socket(ProxyHeader.TransportProtocol.UNSPEC) + .addTlv(0xEE, new byte[]{0x10, 0x20, 0x30}) + .build(); + + ProxyHeader parsed = ProxyProtocolV2Decoder.parse(header, 0, header.length); + assertEquals(ProxyHeader.AddressFamily.UNSPEC, parsed.getFamily()); + assertEquals(1, parsed.getTlvs().size()); + assertArrayEquals(new byte[]{0x10, 0x20, 0x30}, parsed.getTlvs().get(0).getValue()); + } +} + + diff --git a/proxy-socket-udp/BENCHMARK_RESULTS.md b/proxy-socket-udp/BENCHMARK_RESULTS.md new file mode 100644 index 0000000..d9d0c1f --- /dev/null +++ b/proxy-socket-udp/BENCHMARK_RESULTS.md @@ -0,0 +1,315 @@ +# ProxyDatagramSocket Benchmark Results + +## Overview + +This document presents a performance comparison between three implementations of Proxy Protocol v2 parsing for UDP datagrams: + +1. **Custom Implementation** (`ProxyDatagramSocket.java`) - Custom-built parser using direct byte array manipulation +2. **AWS Implementation** (`ProxyDatagramSocketAWS.java`) - Using the AWS ProProt library (com.amazonaws.proprot:proprot:1.0) +3. **Netty Implementation** (`ProxyDatagramSocketNetty.java`) - Using Netty's HAProxy codec (io.netty:netty-codec-haproxy:4.1.100.Final) + +## Benchmark Methodology + +### Test Configuration + +- **Hardware**: Localhost loopback (eliminates network variability) +- **Java Version**: Java 17 +- **Warmup**: 5,000 iterations per test +- **Measurement**: 50,000 iterations per test +- **Packet Sizes**: 64 bytes, 512 bytes, 1500 bytes (small, medium, large) + +### Test Scenarios + +The benchmark focused on **parsing-only performance** to isolate the core difference between implementations: +- Parse Proxy Protocol v2 header from byte array +- Extract source/destination addresses and ports +- Skip past header to application data + +## Results + +### Performance Summary + +| Implementation | Packet Size | Avg Latency (ns/op) | Throughput (ops/sec) | +|----------------|-------------|---------------------|----------------------| +| **Custom** | 64B | **167.03** | **5,987,098** | +| AWS ProProt | 64B | 353.39 | 2,829,748 | +| Netty HAProxy | 64B | 955.03 | 1,047,085 | +| **Custom** | 512B | **48.18** | **20,756,577** | +| AWS ProProt | 512B | 130.26 | 7,677,149 | +| Netty HAProxy | 512B | 401.12 | 2,493,046 | +| **Custom** | 1500B | **41.80** | **23,924,876** | +| AWS ProProt | 1500B | 145.00 | 6,896,354 | +| Netty HAProxy | 1500B | 399.94 | 2,500,401 | + +### Relative Performance + +| Packet Size | AWS vs Custom | Netty vs Custom | +|-------------|---------------|-----------------| +| 64B | **2.12x SLOWER** | **5.72x SLOWER** | +| 512B | **2.70x SLOWER** | **8.33x SLOWER** | +| 1500B | **3.47x SLOWER** | **9.57x SLOWER** | + +### Visual Comparison + +``` +Throughput (ops/sec) at 1500B packets: +Custom: ████████████████████████ 23.9M ops/sec +AWS: ███████ 6.9M ops/sec +Netty: ██ 2.5M ops/sec +``` + +## Analysis + +### Key Findings + +1. **Custom Implementation Dominates Across All Tests** + - 2-3.5x faster than AWS + - 5.7-9.6x faster than Netty + - Consistently lowest latency: 42-167 ns + +2. **AWS ProProt: Middle Ground** + - 2-3.5x slower than Custom + - 2-3x faster than Netty + - Moderate latency: 130-353 ns + - More consistent performance across packet sizes + +3. **Netty HAProxy: Slowest** + - 5.7-9.6x slower than Custom + - 2-3x slower than AWS + - Highest latency: 400-955 ns + - Performance degradation with larger packets + +4. **Packet Size Impact** + - Custom: Best performance on medium/large packets (42-48 ns) + - AWS: Shows improvement with larger packets (145-353 ns) + - Netty: Consistently high overhead (~400-955 ns) + +### Why Custom Implementation is Fastest + +1. **Direct Byte Array Access** + - No intermediate stream wrappers or buffer allocations + - Minimal memory copies + - Cache-friendly sequential reads + +2. **Minimal Object Allocation** + - Reuses parser state + - No temporary objects per parse + - Reduced GC pressure + +3. **Specialized for Use Case** + - Optimized specifically for UDP datagram parsing + - No generic channel handling overhead + - Tight, focused code paths + +4. **JVM Optimization** + - Hot path code fully inlined by JIT compiler + - Predictable branches optimize well + - Simple loops over byte arrays + +### AWS ProProt Library Characteristics + +**Strengths:** +- Stream-based API with `InputStream` abstraction +- Complete specification support (TLV, SSL, checksums) +- Battle-tested in AWS production environments +- Better performance than Netty + +**Weaknesses:** +- Additional indirection layer (ByteArrayInputStream) +- More object allocation per parse +- 2-3.5x slower than custom implementation + +**Performance Profile:** +- Moderate overhead: 130-353 ns/op +- Throughput: 2.8-7.7M ops/sec +- Better suited for moderate throughput scenarios + +### Netty HAProxy Codec Characteristics + +**Strengths:** +- Complete HAProxy protocol implementation +- Widely used in production (Netty ecosystem) +- Supports both v1 and v2 protocols +- Rich feature set + +**Weaknesses:** +- Heaviest performance overhead (5.7-9.6x slower) +- Channel abstraction adds significant cost +- Creates new decoder instance per parse (stateful decoder) +- ByteBuf wrapping and lifecycle management overhead +- Designed for stream/channel I/O, not direct datagram parsing + +**Performance Profile:** +- High overhead: 400-955 ns/op +- Throughput: 1-2.5M ops/sec +- Significant penalty from channelpipeline abstractions + +**Why Netty is Slower:** +1. **Channel Pipeline Overhead**: Designed for Netty's channel abstraction +2. **State Management**: Decoder instances are stateful +3. **ByteBuf Operations**: More complex buffer management +4. **Object Allocation**: Creates more temporary objects +5. **Abstraction Layers**: Multiple layers of indirection + +## Recommendations + +### Use Custom Implementation When: + +- **Performance is critical** (high-throughput applications) +- **Latency sensitive** (real-time systems, gaming, IoT) +- **Simple proxy protocol** requirements (basic address/port mapping) +- **High packet rates** (millions of packets/second) +- **Cost optimization** (lower CPU usage = lower cloud costs) + +### Use AWS ProProt When: + +- **Full specification support** needed (TLV extensions, SSL info) +- **Code maintainability** prioritized over raw performance +- **AWS integration** is important +- **Moderate throughput** requirements (< 1M packets/second) +- **Standards compliance** verification needed +- **Balance** between features and performance + +### Use Netty HAProxy When: + +- **Already using Netty** for other I/O operations +- **Code reuse** with existing Netty pipelines +- **HAProxy v1 support** needed +- **Low throughput** requirements (< 100K packets/second) +- **Not performance critical** applications +- **Full Netty ecosystem** integration desired + +## Memory Overhead Comparison + +### Custom Implementation +- Minimal allocation per parse +- Reuses shared parser state +- Direct field extraction +- **Memory efficiency: ★★★★★** + +### AWS ProProt +- ByteArrayInputStream per parse +- Internal buffer structures +- Header objects with metadata +- **Memory efficiency: ★★★☆☆** + +### Netty HAProxy +- New decoder instance per parse (stateful) +- ByteBuf allocation and wrapping +- Channel context overhead +- HAProxyMessage object allocation +- **Memory efficiency: ★★☆☆☆** + +## Scalability Considerations + +### Custom Implementation + +**Strengths:** +- Linear scaling with CPU cores +- Cache-friendly memory access +- Predictable performance +- Low CPU utilization + +**Limitations:** +- Limited TLV support +- Less comprehensive validation + +**Best for:** Ultra-high throughput (10M+ ops/sec) + +### AWS ProProt + +**Strengths:** +- Complete specification +- Proven in production +- Good balance of features/performance + +**Limitations:** +- Performance ceiling ~7M ops/sec +- Higher memory allocation rate + +**Best for:** High throughput (1-10M ops/sec) + +### Netty HAProxy + +**Strengths:** +- Rich feature set +- HAProxy v1/v2 support +- Netty ecosystem integration + +**Limitations:** +- Performance ceiling ~2.5M ops/sec +- Highest resource consumption +- Not optimized for datagram use case + +**Best for:** Moderate throughput (< 1M ops/sec) + +## Production Considerations + +### Performance Tiers + +**Tier 1: Ultra-Performance** (> 5M ops/sec) +- **Choose**: Custom Implementation +- **Use case**: Real-time gaming, IoT gateways, high-frequency trading +- **Tradeoff**: Minimal features, maximum speed + +**Tier 2: High-Performance** (1-5M ops/sec) +- **Choose**: AWS ProProt +- **Use case**: API gateways, microservices, data streaming +- **Tradeoff**: Good balance of features and performance + +**Tier 3: Standard Performance** (< 1M ops/sec) +- **Choose**: Netty HAProxy +- **Use case**: Web applications, admin interfaces, monitoring +- **Tradeoff**: Maximum features, acceptable performance + +### Cost Analysis + +At 10M packets/second: + +| Implementation | CPU Efficiency | Relative Cost | +|----------------|----------------|---------------| +| Custom | Baseline | 1.0x | +| AWS ProProt | 2.7x more CPU | 2.7x | +| Netty HAProxy | 8.0x more CPU | 8.0x | + +**Cloud cost impact**: Netty could require 8x more compute resources than Custom for the same throughput. + +## Conclusions + +The custom `ProxyDatagramSocket` implementation provides **substantially better performance** than both AWS ProProt and Netty HAProxy for UDP proxy protocol parsing: + +### Performance Ranking +1. **🥇 Custom**: 42-167 ns, 6-24M ops/sec +2. **🥈 AWS ProProt**: 130-353 ns, 2.8-7.7M ops/sec +3. **🥉 Netty HAProxy**: 400-955 ns, 1-2.5M ops/sec + +### When to Use Each + +- **Custom** → Performance-critical, high-throughput systems +- **AWS** → Feature-complete with good performance balance +- **Netty** → Netty ecosystem integration, moderate loads + +### Final Recommendation + +For most production UDP proxy protocol use cases, the **custom implementation** is the clear winner, offering 2-10x better performance than alternatives. Only choose AWS or Netty if you specifically need their additional features or ecosystem integration, and can accept the performance penalty. + +## Test Reproduction + +To reproduce these benchmarks: + +```bash +cd proxy-socket-udp +mvn test-compile exec:java \ + -Dexec.mainClass="net.airvantage.proxysocket.udp.SimpleBenchmark" \ + -Dexec.classpathScope=test +``` + +## Environment + +- **OS**: macOS (darwin 25.0.0) +- **JVM**: OpenJDK 17 +- **Maven**: 3.x +- **Libraries**: + - AWS ProProt: 1.0 + - Netty HAProxy: 4.1.100.Final +- **Test Date**: November 3, 2025 diff --git a/proxy-socket-udp/pom.xml b/proxy-socket-udp/pom.xml new file mode 100644 index 0000000..0e817c9 --- /dev/null +++ b/proxy-socket-udp/pom.xml @@ -0,0 +1,93 @@ + + + 4.0.0 + + net.airvantage + proxysocket-java + 1.0.0-SNAPSHOT + + proxy-socket-udp + Proxy Protocol - UDP + jar + + + + net.airvantage + proxy-socket-core + ${project.version} + + + + com.amazonaws.proprot + proprot + 1.0 + + + + io.netty + netty-codec-haproxy + 4.1.100.Final + + + + org.slf4j + slf4j-api + 2.0.16 + true + + + + org.junit.jupiter + junit-jupiter + ${junit.version} + test + + + org.testcontainers + testcontainers-junit-jupiter + test + + + org.testcontainers + testcontainers + test + + + org.testcontainers + testcontainers-nginx + test + + + + org.slf4j + slf4j-simple + 2.0.16 + test + + + + org.mockito + mockito-core + 5.5.0 + test + + + + org.openjdk.jmh + jmh-core + 1.37 + test + + + org.openjdk.jmh + jmh-generator-annprocess + 1.37 + test + + + + + + diff --git a/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocket.java b/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocket.java new file mode 100644 index 0000000..385688d --- /dev/null +++ b/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocket.java @@ -0,0 +1,102 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import net.airvantage.proxysocket.core.ProxyAddressCache; +import net.airvantage.proxysocket.core.ProxyProtocolMetricsListener; +import net.airvantage.proxysocket.core.cache.ConcurrentMapProxyAddressCache; +import net.airvantage.proxysocket.core.v2.ProxyHeader; +import net.airvantage.proxysocket.core.v2.ProxyProtocolV2Decoder; + +import java.io.IOException; +import java.net.DatagramPacket; +import java.net.DatagramSocket; +import java.net.InetSocketAddress; +import java.net.SocketAddress; +import java.net.SocketException; +import java.util.Objects; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.function.Predicate; + +/** + * DatagramSocket that strips Proxy Protocol v2 headers and exposes real client address. + * + * Thread-safety: This class is thread-safe to the extent that {@link DatagramSocket} + * is documented as thread-safe for concurrent send/receive by the JDK. The internal + * cache and metrics listener are expected to be thread-safe. The implementation does + * not mutate shared state beyond those collaborators. + */ +public class ProxyDatagramSocket extends DatagramSocket { + private static final Logger LOG = Logger.getLogger(ProxyDatagramSocket.class.getName()); + + private ProxyAddressCache addressCache; + private ProxyProtocolMetricsListener metrics; + private Predicate trustedProxyPredicate; + + public ProxyDatagramSocket() throws SocketException { + super(); + } + + public ProxyDatagramSocket(SocketAddress bindaddr) throws SocketException { + super(bindaddr); + } + + public ProxyDatagramSocket(int port) throws SocketException { + super(port); + } + + public ProxyDatagramSocket(int port, java.net.InetAddress laddr) throws SocketException { + super(port, laddr); + } + + public ProxyDatagramSocket setCache(ProxyAddressCache cache) { this.addressCache = cache; return this; } + public ProxyDatagramSocket setMetrics(ProxyProtocolMetricsListener metrics) { this.metrics = metrics; return this; } + public ProxyDatagramSocket setTrustedProxy(Predicate predicate) { this.trustedProxyPredicate = predicate; return this; } + + @Override + public void receive(DatagramPacket packet) throws IOException { + super.receive(packet); + try { + InetSocketAddress lbAddress = (InetSocketAddress) packet.getSocketAddress(); + if (trustedProxyPredicate != null && !trustedProxyPredicate.test(lbAddress)) { + // Untrusted source: do not parse, deliver original packet + return; + } + + ProxyHeader header = ProxyProtocolV2Decoder.parse(packet.getData(), packet.getOffset(), packet.getLength()); + if (metrics != null) metrics.onHeaderParsed(header); + if (header.isLocal()) { + // LOCAL: not proxied + } else if (header.isProxy() && header.getProtocol() == ProxyHeader.TransportProtocol.DGRAM) { + InetSocketAddress realClient = header.getSourceAddress(); + if (realClient != null && lbAddress != null) { + if (addressCache != null) addressCache.put(realClient, lbAddress); + packet.setSocketAddress(realClient); + } + } + int headerLen = header.getHeaderLength(); + packet.setData(packet.getData(), packet.getOffset() + headerLen, packet.getLength() - headerLen); + } catch (Exception e) { + LOG.log(Level.WARNING, "Proxy socket parse error; delivering original packet.", e); + if (metrics != null) metrics.onParseError(e); + } + } + + @Override + public void send(DatagramPacket packet) throws IOException { + InetSocketAddress client = (InetSocketAddress) packet.getSocketAddress(); + InetSocketAddress lb = addressCache != null ? addressCache.get(client) : null; + if (lb != null) { + packet.setSocketAddress(lb); + if (metrics != null) metrics.onCacheHit(client); + } else { + if (metrics != null) metrics.onCacheMiss(client); + } + super.send(packet); + } +} + + diff --git a/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketAWS.java b/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketAWS.java new file mode 100644 index 0000000..3f891f7 --- /dev/null +++ b/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketAWS.java @@ -0,0 +1,139 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import com.amazonaws.proprot.Header; +import com.amazonaws.proprot.ProxyProtocol; +import com.amazonaws.proprot.ProxyProtocolSpec; +import net.airvantage.proxysocket.core.ProxyAddressCache; +import net.airvantage.proxysocket.core.ProxyProtocolMetricsListener; +import net.airvantage.proxysocket.core.cache.ConcurrentMapProxyAddressCache; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.net.DatagramPacket; +import java.net.DatagramSocket; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.net.SocketAddress; +import java.net.SocketException; +import java.util.Objects; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.function.Predicate; + +/** + * DatagramSocket implementation using AWS ProProt library for Proxy Protocol v2 parsing. + * + * Thread-safety: This class is thread-safe to the extent that {@link DatagramSocket} + * is documented as thread-safe for concurrent send/receive by the JDK. The internal + * cache and metrics listener are expected to be thread-safe. The implementation does + * not mutate shared state beyond those collaborators. + */ +public class ProxyDatagramSocketAWS extends DatagramSocket { + private static final Logger LOG = Logger.getLogger(ProxyDatagramSocketAWS.class.getName()); + + private ProxyAddressCache addressCache; + private ProxyProtocolMetricsListener metrics; + private Predicate trustedProxyPredicate; + private final ProxyProtocol proxyProtocol; + + public ProxyDatagramSocketAWS() throws SocketException { + super(); + this.proxyProtocol = new ProxyProtocol(); + this.proxyProtocol.setEnforceChecksum(false); // Disable checksum enforcement + } + + public ProxyDatagramSocketAWS(SocketAddress bindaddr) throws SocketException { + super(bindaddr); + this.proxyProtocol = new ProxyProtocol(); + this.proxyProtocol.setEnforceChecksum(false); // Disable checksum enforcement + } + + public ProxyDatagramSocketAWS(int port) throws SocketException { + super(port); + this.proxyProtocol = new ProxyProtocol(); + this.proxyProtocol.setEnforceChecksum(false); // Disable checksum enforcement + } + + public ProxyDatagramSocketAWS(int port, java.net.InetAddress laddr) throws SocketException { + super(port, laddr); + this.proxyProtocol = new ProxyProtocol(); + this.proxyProtocol.setEnforceChecksum(false); // Disable checksum enforcement + } + + public ProxyDatagramSocketAWS setCache(ProxyAddressCache cache) { + this.addressCache = cache; + return this; + } + + public ProxyDatagramSocketAWS setMetrics(ProxyProtocolMetricsListener metrics) { + this.metrics = metrics; + return this; + } + + public ProxyDatagramSocketAWS setTrustedProxy(Predicate predicate) { + this.trustedProxyPredicate = predicate; + return this; + } + + @Override + public void receive(DatagramPacket packet) throws IOException { + super.receive(packet); + try { + InetSocketAddress lbAddress = (InetSocketAddress) packet.getSocketAddress(); + if (trustedProxyPredicate != null && !trustedProxyPredicate.test(lbAddress)) { + // Untrusted source: do not parse, deliver original packet + return; + } + + // Parse using AWS ProProt library + ByteArrayInputStream inputStream = new ByteArrayInputStream( + packet.getData(), packet.getOffset(), packet.getLength() + ); + Header header = proxyProtocol.read(inputStream); + + if (metrics != null) { + // Note: AWS library doesn't expose the same metrics interface + // We'll just mark successful parse + } + + if (header.getCommand() == ProxyProtocolSpec.Command.LOCAL) { + // LOCAL: not proxied + } else if (header.getCommand() == ProxyProtocolSpec.Command.PROXY + && header.getTransportProtocol() == ProxyProtocolSpec.TransportProtocol.DGRAM) { + byte[] srcAddrBytes = header.getSrcAddress(); + int srcPort = header.getSrcPort(); + if (srcAddrBytes != null && lbAddress != null) { + InetAddress srcAddr = InetAddress.getByAddress(srcAddrBytes); + InetSocketAddress realClient = new InetSocketAddress(srcAddr, srcPort); + if (addressCache != null) addressCache.put(realClient, lbAddress); + packet.setSocketAddress(realClient); + } + } + + // Calculate how many bytes were read from the stream + int bytesRead = packet.getLength() - inputStream.available(); + packet.setData(packet.getData(), packet.getOffset() + bytesRead, packet.getLength() - bytesRead); + } catch (Exception e) { + LOG.log(Level.WARNING, "Proxy socket parse error; delivering original packet.", e); + if (metrics != null) metrics.onParseError(e); + } + } + + @Override + public void send(DatagramPacket packet) throws IOException { + InetSocketAddress client = (InetSocketAddress) packet.getSocketAddress(); + InetSocketAddress lb = addressCache != null ? addressCache.get(client) : null; + if (lb != null) { + packet.setSocketAddress(lb); + if (metrics != null) metrics.onCacheHit(client); + } else { + if (metrics != null) metrics.onCacheMiss(client); + } + super.send(packet); + } +} + diff --git a/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketNetty.java b/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketNetty.java new file mode 100644 index 0000000..cd562c0 --- /dev/null +++ b/proxy-socket-udp/src/main/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketNetty.java @@ -0,0 +1,209 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import io.netty.handler.codec.haproxy.HAProxyMessage; +import io.netty.handler.codec.haproxy.HAProxyMessageDecoder; +import net.airvantage.proxysocket.core.ProxyAddressCache; +import net.airvantage.proxysocket.core.ProxyProtocolMetricsListener; + +import java.io.IOException; +import java.net.DatagramPacket; +import java.net.DatagramSocket; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.net.SocketAddress; +import java.net.SocketException; +import java.util.ArrayList; +import java.util.List; +import java.util.function.Predicate; +import java.util.logging.Level; +import java.util.logging.Logger; + +/** + * DatagramSocket implementation using Netty HAProxy codec for Proxy Protocol v2 parsing. + * + * Thread-safety: This class is thread-safe to the extent that {@link DatagramSocket} + * is documented as thread-safe for concurrent send/receive by the JDK. The internal + * cache and metrics listener are expected to be thread-safe. Note that HAProxyMessageDecoder + * is stateful and not thread-safe, so we create a new instance per parse. + */ +public class ProxyDatagramSocketNetty extends DatagramSocket { + private static final Logger LOG = Logger.getLogger(ProxyDatagramSocketNetty.class.getName()); + + private ProxyAddressCache addressCache; + private ProxyProtocolMetricsListener metrics; + private Predicate trustedProxyPredicate; + + public ProxyDatagramSocketNetty() throws SocketException { + super(); + } + + public ProxyDatagramSocketNetty(SocketAddress bindaddr) throws SocketException { + super(bindaddr); + } + + public ProxyDatagramSocketNetty(int port) throws SocketException { + super(port); + } + + public ProxyDatagramSocketNetty(int port, java.net.InetAddress laddr) throws SocketException { + super(port, laddr); + } + + public ProxyDatagramSocketNetty setCache(ProxyAddressCache cache) { + this.addressCache = cache; + return this; + } + + public ProxyDatagramSocketNetty setMetrics(ProxyProtocolMetricsListener metrics) { + this.metrics = metrics; + return this; + } + + public ProxyDatagramSocketNetty setTrustedProxy(Predicate predicate) { + this.trustedProxyPredicate = predicate; + return this; + } + + @Override + public void receive(DatagramPacket packet) throws IOException { + super.receive(packet); + try { + InetSocketAddress lbAddress = (InetSocketAddress) packet.getSocketAddress(); + if (trustedProxyPredicate != null && !trustedProxyPredicate.test(lbAddress)) { + // Untrusted source: do not parse, deliver original packet + return; + } + + // Parse using Netty HAProxy decoder + ByteBuf buffer = Unpooled.wrappedBuffer(packet.getData(), packet.getOffset(), packet.getLength()); + + // Create decoder instance (not thread-safe, so create per-parse) + ProxyDecoder decoder = new ProxyDecoder(); + List out = new ArrayList<>(); + + try { + decoder.decodePublic(new NoOpChannelHandlerContext(), buffer, out); + } catch (Exception e) { + // Not a proxy protocol packet or parsing error, deliver as-is + LOG.log(Level.FINE, "No proxy header detected", e); + buffer.release(); + return; + } + + if (out.isEmpty()) { + buffer.release(); + return; + } + + HAProxyMessage proxyMsg = (HAProxyMessage) out.get(0); + + try { + if (metrics != null) { + // Mark successful parse + } + + // Only process PROXY command (not LOCAL) + if (proxyMsg.command() == io.netty.handler.codec.haproxy.HAProxyCommand.PROXY) { + String srcAddrStr = proxyMsg.sourceAddress(); + int srcPort = proxyMsg.sourcePort(); + + if (srcAddrStr != null && lbAddress != null) { + InetAddress srcAddr = InetAddress.getByName(srcAddrStr); + InetSocketAddress realClient = new InetSocketAddress(srcAddr, srcPort); + if (addressCache != null) addressCache.put(realClient, lbAddress); + packet.setSocketAddress(realClient); + } + } + + // Extract payload after header + byte[] payload = new byte[buffer.readableBytes()]; + buffer.readBytes(payload); + packet.setData(payload, 0, payload.length); + + } finally { + proxyMsg.release(); + buffer.release(); + } + + } catch (Exception e) { + LOG.log(Level.WARNING, "Proxy socket parse error; delivering original packet.", e); + if (metrics != null) metrics.onParseError(e); + } + } + + @Override + public void send(DatagramPacket packet) throws IOException { + InetSocketAddress client = (InetSocketAddress) packet.getSocketAddress(); + InetSocketAddress lb = addressCache != null ? addressCache.get(client) : null; + if (lb != null) { + packet.setSocketAddress(lb); + if (metrics != null) metrics.onCacheHit(client); + } else { + if (metrics != null) metrics.onCacheMiss(client); + } + super.send(packet); + } + + /** + * Wrapper for HAProxyMessageDecoder that exposes the decode method. + */ + private static class ProxyDecoder extends HAProxyMessageDecoder { + public void decodePublic(io.netty.channel.ChannelHandlerContext ctx, ByteBuf in, List out) throws Exception { + decode(ctx, in, out); + } + } + + /** + * Minimal no-op implementation of ChannelHandlerContext for Netty decoder. + */ + public static class NoOpChannelHandlerContext implements io.netty.channel.ChannelHandlerContext { + @Override public io.netty.channel.Channel channel() { return null; } + @Override public io.netty.util.concurrent.EventExecutor executor() { return null; } + @Override public String name() { return null; } + @Override public io.netty.channel.ChannelHandler handler() { return null; } + @Override public boolean isRemoved() { return false; } + @Override public io.netty.channel.ChannelHandlerContext fireChannelRegistered() { return this; } + @Override public io.netty.channel.ChannelHandlerContext fireChannelUnregistered() { return this; } + @Override public io.netty.channel.ChannelHandlerContext fireChannelActive() { return this; } + @Override public io.netty.channel.ChannelHandlerContext fireChannelInactive() { return this; } + @Override public io.netty.channel.ChannelHandlerContext fireExceptionCaught(Throwable cause) { return this; } + @Override public io.netty.channel.ChannelHandlerContext fireUserEventTriggered(Object evt) { return this; } + @Override public io.netty.channel.ChannelHandlerContext fireChannelRead(Object msg) { return this; } + @Override public io.netty.channel.ChannelHandlerContext fireChannelReadComplete() { return this; } + @Override public io.netty.channel.ChannelHandlerContext fireChannelWritabilityChanged() { return this; } + @Override public io.netty.channel.ChannelFuture bind(SocketAddress localAddress) { return null; } + @Override public io.netty.channel.ChannelFuture connect(SocketAddress remoteAddress) { return null; } + @Override public io.netty.channel.ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress) { return null; } + @Override public io.netty.channel.ChannelFuture disconnect() { return null; } + @Override public io.netty.channel.ChannelFuture close() { return null; } + @Override public io.netty.channel.ChannelFuture deregister() { return null; } + @Override public io.netty.channel.ChannelFuture bind(SocketAddress localAddress, io.netty.channel.ChannelPromise promise) { return null; } + @Override public io.netty.channel.ChannelFuture connect(SocketAddress remoteAddress, io.netty.channel.ChannelPromise promise) { return null; } + @Override public io.netty.channel.ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress, io.netty.channel.ChannelPromise promise) { return null; } + @Override public io.netty.channel.ChannelFuture disconnect(io.netty.channel.ChannelPromise promise) { return null; } + @Override public io.netty.channel.ChannelFuture close(io.netty.channel.ChannelPromise promise) { return null; } + @Override public io.netty.channel.ChannelFuture deregister(io.netty.channel.ChannelPromise promise) { return null; } + @Override public io.netty.channel.ChannelHandlerContext read() { return this; } + @Override public io.netty.channel.ChannelFuture write(Object msg) { return null; } + @Override public io.netty.channel.ChannelFuture write(Object msg, io.netty.channel.ChannelPromise promise) { return null; } + @Override public io.netty.channel.ChannelHandlerContext flush() { return this; } + @Override public io.netty.channel.ChannelFuture writeAndFlush(Object msg, io.netty.channel.ChannelPromise promise) { return null; } + @Override public io.netty.channel.ChannelFuture writeAndFlush(Object msg) { return null; } + @Override public io.netty.channel.ChannelPipeline pipeline() { return null; } + @Override public io.netty.buffer.ByteBufAllocator alloc() { return null; } + @Override public io.netty.channel.ChannelPromise newPromise() { return null; } + @Override public io.netty.channel.ChannelProgressivePromise newProgressivePromise() { return null; } + @Override public io.netty.channel.ChannelFuture newSucceededFuture() { return null; } + @Override public io.netty.channel.ChannelFuture newFailedFuture(Throwable cause) { return null; } + @Override public io.netty.channel.ChannelPromise voidPromise() { return null; } + @Override public io.netty.util.Attribute attr(io.netty.util.AttributeKey key) { return null; } + @Override public boolean hasAttr(io.netty.util.AttributeKey key) { return false; } + } +} + diff --git a/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/BenchmarkProxyDatagramSocket.java b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/BenchmarkProxyDatagramSocket.java new file mode 100644 index 0000000..cc12251 --- /dev/null +++ b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/BenchmarkProxyDatagramSocket.java @@ -0,0 +1,238 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import net.airvantage.proxysocket.core.ProxyAddressCache; +import net.airvantage.proxysocket.core.cache.ConcurrentMapProxyAddressCache; +import net.airvantage.proxysocket.core.v2.ProxyHeader; +import net.airvantage.proxysocket.core.v2.ProxyProtocolV2Encoder; +import org.openjdk.jmh.annotations.*; +import org.openjdk.jmh.infra.Blackhole; + +import java.net.DatagramPacket; +import java.net.DatagramSocket; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.util.concurrent.TimeUnit; + +/** + * JMH Benchmarks comparing ProxyDatagramSocket vs ProxyDatagramSocketAWS. + * + * Measures latency for: + * - Single packet send/receive roundtrip + * - Burst of 1000 packets + * - Different packet sizes (64B, 512B, 1500B) + */ +@BenchmarkMode(Mode.AverageTime) +@OutputTimeUnit(TimeUnit.NANOSECONDS) +@State(Scope.Thread) +@Warmup(iterations = 5, time = 1, timeUnit = TimeUnit.SECONDS) +@Measurement(iterations = 10, time = 1, timeUnit = TimeUnit.SECONDS) +@Fork(value = 1, jvmArgs = {"-Xms2G", "-Xmx2G"}) +public class BenchmarkProxyDatagramSocket { + + @State(Scope.Thread) + public static class SocketState { + ProxyDatagramSocket customSocket; + ProxyDatagramSocketAWS awsSocket; + DatagramSocket senderSocket; + + InetAddress localhost; + int customPort; + int awsPort; + int senderPort; + + ProxyAddressCache cache; + + @Param({"64", "512", "1500"}) + int packetSize; + + byte[] customPayload; + byte[] awsPayload; + byte[] sendBuffer; + + @Setup(Level.Trial) + public void setup() throws Exception { + localhost = InetAddress.getLoopbackAddress(); + cache = new ConcurrentMapProxyAddressCache(); + + // Create sockets + customSocket = new ProxyDatagramSocket(0, localhost); + customPort = customSocket.getLocalPort(); + customSocket.setCache(cache); + customSocket.setTrustedProxy(addr -> true); // Trust all for benchmark + + awsSocket = new ProxyDatagramSocketAWS(0, localhost); + awsPort = awsSocket.getLocalPort(); + awsSocket.setCache(cache); + awsSocket.setTrustedProxy(addr -> true); // Trust all for benchmark + + senderSocket = new DatagramSocket(0, localhost); + senderPort = senderSocket.getLocalPort(); + + // Prepare payloads with proxy protocol header + byte[] applicationData = new byte[packetSize]; + for (int i = 0; i < applicationData.length; i++) { + applicationData[i] = (byte) (i % 256); + } + + // Create proxy header + InetSocketAddress srcAddr = new InetSocketAddress(localhost, 12345); + InetSocketAddress dstAddr = new InetSocketAddress(localhost, customPort); + + // Encode proxy protocol header + payload + byte[] proxyHeader = new ProxyProtocolV2Encoder() + .command(ProxyHeader.Command.PROXY) + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(srcAddr) + .destination(dstAddr) + .build(); + + customPayload = new byte[proxyHeader.length + applicationData.length]; + System.arraycopy(proxyHeader, 0, customPayload, 0, proxyHeader.length); + System.arraycopy(applicationData, 0, customPayload, proxyHeader.length, applicationData.length); + + awsPayload = new byte[proxyHeader.length + applicationData.length]; + System.arraycopy(proxyHeader, 0, awsPayload, 0, proxyHeader.length); + System.arraycopy(applicationData, 0, awsPayload, proxyHeader.length, applicationData.length); + + sendBuffer = new byte[Math.max(customPayload.length, awsPayload.length) + 100]; + } + + @TearDown(Level.Trial) + public void teardown() { + if (customSocket != null && !customSocket.isClosed()) customSocket.close(); + if (awsSocket != null && !awsSocket.isClosed()) awsSocket.close(); + if (senderSocket != null && !senderSocket.isClosed()) senderSocket.close(); + } + } + + /** + * Benchmark: Single packet roundtrip with custom implementation + */ + @Benchmark + public void singlePacketCustom(SocketState state, Blackhole bh) throws Exception { + // Send packet with proxy protocol header + DatagramPacket sendPacket = new DatagramPacket( + state.customPayload, 0, state.customPayload.length, + state.localhost, state.customPort + ); + state.senderSocket.send(sendPacket); + + // Receive and parse + DatagramPacket receivePacket = new DatagramPacket(state.sendBuffer, state.sendBuffer.length); + state.customSocket.setSoTimeout(1000); + state.customSocket.receive(receivePacket); + + // Consume results + bh.consume(receivePacket.getLength()); + bh.consume(receivePacket.getSocketAddress()); + } + + /** + * Benchmark: Single packet roundtrip with AWS implementation + */ + @Benchmark + public void singlePacketAWS(SocketState state, Blackhole bh) throws Exception { + // Send packet with proxy protocol header + DatagramPacket sendPacket = new DatagramPacket( + state.awsPayload, 0, state.awsPayload.length, + state.localhost, state.awsPort + ); + state.senderSocket.send(sendPacket); + + // Receive and parse + DatagramPacket receivePacket = new DatagramPacket(state.sendBuffer, state.sendBuffer.length); + state.awsSocket.setSoTimeout(1000); + state.awsSocket.receive(receivePacket); + + // Consume results + bh.consume(receivePacket.getLength()); + bh.consume(receivePacket.getSocketAddress()); + } + + /** + * Benchmark: Burst of 1000 packets with custom implementation + */ + @Benchmark + @BenchmarkMode(Mode.SingleShotTime) + @Warmup(iterations = 3, batchSize = 1000) + @Measurement(iterations = 10, batchSize = 1000) + public void burstCustom(SocketState state, Blackhole bh) throws Exception { + DatagramPacket sendPacket = new DatagramPacket( + state.customPayload, 0, state.customPayload.length, + state.localhost, state.customPort + ); + + DatagramPacket receivePacket = new DatagramPacket(state.sendBuffer, state.sendBuffer.length); + state.customSocket.setSoTimeout(5000); + + for (int i = 0; i < 1000; i++) { + state.senderSocket.send(sendPacket); + receivePacket.setLength(state.sendBuffer.length); + state.customSocket.receive(receivePacket); + bh.consume(receivePacket.getLength()); + } + } + + /** + * Benchmark: Burst of 1000 packets with AWS implementation + */ + @Benchmark + @BenchmarkMode(Mode.SingleShotTime) + @Warmup(iterations = 3, batchSize = 1000) + @Measurement(iterations = 10, batchSize = 1000) + public void burstAWS(SocketState state, Blackhole bh) throws Exception { + DatagramPacket sendPacket = new DatagramPacket( + state.awsPayload, 0, state.awsPayload.length, + state.localhost, state.awsPort + ); + + DatagramPacket receivePacket = new DatagramPacket(state.sendBuffer, state.sendBuffer.length); + state.awsSocket.setSoTimeout(5000); + + for (int i = 0; i < 1000; i++) { + state.senderSocket.send(sendPacket); + receivePacket.setLength(state.sendBuffer.length); + state.awsSocket.receive(receivePacket); + bh.consume(receivePacket.getLength()); + } + } + + /** + * Benchmark: Parse-only performance for custom implementation + */ + @Benchmark + public void parseOnlyCustom(SocketState state, Blackhole bh) throws Exception { + DatagramPacket receivePacket = new DatagramPacket( + state.customPayload, 0, state.customPayload.length + ); + receivePacket.setSocketAddress(new InetSocketAddress(state.localhost, state.senderPort)); + + // Simulate the parsing logic + net.airvantage.proxysocket.core.v2.ProxyHeader header = + net.airvantage.proxysocket.core.v2.ProxyProtocolV2Decoder.parse( + receivePacket.getData(), + receivePacket.getOffset(), + receivePacket.getLength() + ); + + bh.consume(header); + } + + /** + * Benchmark: Parse-only performance for AWS implementation + */ + @Benchmark + public void parseOnlyAWS(SocketState state, Blackhole bh) throws Exception { + java.io.ByteArrayInputStream inputStream = new java.io.ByteArrayInputStream(state.awsPayload); + com.amazonaws.proprot.ProxyProtocol proxyProtocol = new com.amazonaws.proprot.ProxyProtocol(); + com.amazonaws.proprot.Header header = proxyProtocol.read(inputStream); + + bh.consume(header); + } +} + diff --git a/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/BenchmarkRunner.java b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/BenchmarkRunner.java new file mode 100644 index 0000000..49c601c --- /dev/null +++ b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/BenchmarkRunner.java @@ -0,0 +1,24 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import org.openjdk.jmh.runner.Runner; +import org.openjdk.jmh.runner.options.Options; +import org.openjdk.jmh.runner.options.OptionsBuilder; + +/** + * Simple runner for JMH benchmarks. + */ +public class BenchmarkRunner { + public static void main(String[] args) throws Exception { + Options opt = new OptionsBuilder() + .include(BenchmarkProxyDatagramSocket.class.getSimpleName()) + .forks(1) + .build(); + + new Runner(opt).run(); + } +} + diff --git a/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketIPMappingTest.java b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketIPMappingTest.java new file mode 100644 index 0000000..90ac7d2 --- /dev/null +++ b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketIPMappingTest.java @@ -0,0 +1,279 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import net.airvantage.proxysocket.core.ProxyAddressCache; +import net.airvantage.proxysocket.core.ProxyProtocolMetricsListener; +import net.airvantage.proxysocket.core.v2.ProxyHeader; +import net.airvantage.proxysocket.core.v2.ProxyProtocolV2Encoder; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; + +import java.net.DatagramPacket; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.nio.charset.StandardCharsets; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Unit tests for ProxyDatagramSocket IP address mapping and cache behavior. + */ +class ProxyDatagramSocketIPMappingTest { + + private ProxyDatagramSocket socket; + private ProxyAddressCache mockCache; + private ProxyProtocolMetricsListener mockMetrics; + private int localPort; + + @BeforeEach + void setUp() throws Exception { + mockCache = mock(ProxyAddressCache.class); + mockMetrics = mock(ProxyProtocolMetricsListener.class); + + socket = new ProxyDatagramSocket(new InetSocketAddress(InetAddress.getLoopbackAddress(), 0)) + .setCache(mockCache) + .setMetrics(mockMetrics) + .setTrustedProxy(addr -> true); // Trust all for these tests + + localPort = socket.getLocalPort(); + } + + @AfterEach + void tearDown() { + if (socket != null && !socket.isClosed()) { + socket.close(); + } + } + + @Test + void receive_withValidProxyHeader_populatesCache() throws Exception { + // Arrange + InetSocketAddress realClient = new InetSocketAddress("10.1.2.3", 12345); + InetSocketAddress lbAddress = new InetSocketAddress("127.0.0.1", 54321); + byte[] payload = "test-data".getBytes(StandardCharsets.UTF_8); + + byte[] proxyHeader = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(realClient) + .destination(new InetSocketAddress("127.0.0.1", localPort)) + .build(); + + byte[] packet = new byte[proxyHeader.length + payload.length]; + System.arraycopy(proxyHeader, 0, packet, 0, proxyHeader.length); + System.arraycopy(payload, 0, packet, proxyHeader.length, payload.length); + + // Create a loopback socket to send from + try (java.net.DatagramSocket sender = new java.net.DatagramSocket(lbAddress)) { + sender.send(new DatagramPacket(packet, packet.length, + new InetSocketAddress("127.0.0.1", localPort))); + } + + // Act + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + socket.receive(receivePacket); + + // Assert - cache should be populated with realClient -> lbAddress mapping + ArgumentCaptor clientCaptor = ArgumentCaptor.forClass(InetSocketAddress.class); + ArgumentCaptor lbCaptor = ArgumentCaptor.forClass(InetSocketAddress.class); + verify(mockCache).put(clientCaptor.capture(), lbCaptor.capture()); + + assertEquals(realClient, clientCaptor.getValue()); + assertEquals(lbAddress.getAddress(), lbCaptor.getValue().getAddress()); + assertEquals(lbAddress.getPort(), lbCaptor.getValue().getPort()); + + // Verify packet was modified to show real client address + assertEquals(realClient, receivePacket.getSocketAddress()); + + // Verify payload was stripped of proxy header + assertEquals(payload.length, receivePacket.getLength()); + assertArrayEquals(payload, + java.util.Arrays.copyOfRange(receivePacket.getData(), + receivePacket.getOffset(), + receivePacket.getOffset() + receivePacket.getLength())); + } + + @Test + void send_withCacheHit_usesLoadBalancerAddress() throws Exception { + // Arrange + InetSocketAddress realClient = new InetSocketAddress("10.1.2.3", 12345); + InetSocketAddress lbAddress = new InetSocketAddress("127.0.0.1", 54321); + byte[] payload = "response".getBytes(StandardCharsets.UTF_8); + + // Mock cache to return lb address + when(mockCache.get(realClient)).thenReturn(lbAddress); + + // Create a receiver to verify the packet destination + java.net.DatagramSocket receiver = new java.net.DatagramSocket(lbAddress); + receiver.setSoTimeout(1000); + + try { + // Act - send to real client, should be redirected to LB + DatagramPacket sendPacket = new DatagramPacket(payload, payload.length, realClient); + socket.send(sendPacket); + + // Verify packet was sent to LB address + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + receiver.receive(receivePacket); + + // Assert + assertArrayEquals(payload, + java.util.Arrays.copyOfRange(receivePacket.getData(), 0, receivePacket.getLength())); + + // Verify cache was queried + verify(mockCache).get(realClient); + + // Verify metrics - cache hit + verify(mockMetrics).onCacheHit(realClient); + verify(mockMetrics, never()).onCacheMiss(any()); + } finally { + receiver.close(); + } + } + + @Test + void send_withCacheMiss_usesOriginalAddress() throws Exception { + // Arrange + InetSocketAddress clientAddress = new InetSocketAddress("127.0.0.1", 55555); + byte[] payload = "response".getBytes(StandardCharsets.UTF_8); + + // Mock cache to return null (cache miss) + when(mockCache.get(clientAddress)).thenReturn(null); + + // Create a receiver at the client address + java.net.DatagramSocket receiver = new java.net.DatagramSocket(clientAddress); + receiver.setSoTimeout(1000); + + try { + // Act - send to client address + DatagramPacket sendPacket = new DatagramPacket(payload, payload.length, clientAddress); + socket.send(sendPacket); + + // Verify packet was sent to original address + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + receiver.receive(receivePacket); + + // Assert + assertArrayEquals(payload, + java.util.Arrays.copyOfRange(receivePacket.getData(), 0, receivePacket.getLength())); + + // Verify cache was queried + verify(mockCache).get(clientAddress); + + // Verify metrics - cache miss + verify(mockMetrics).onCacheMiss(clientAddress); + verify(mockMetrics, never()).onCacheHit(any()); + } finally { + receiver.close(); + } + } + + @Test + void receive_withUntrustedProxy_skipsProcessing() throws Exception { + // Arrange - configure to reject all sources + socket.setTrustedProxy(addr -> false); + + byte[] payload = "test".getBytes(StandardCharsets.UTF_8); + byte[] proxyHeader = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(new InetSocketAddress("10.1.2.3", 12345)) + .destination(new InetSocketAddress("127.0.0.1", localPort)) + .build(); + + byte[] packet = new byte[proxyHeader.length + payload.length]; + System.arraycopy(proxyHeader, 0, packet, 0, proxyHeader.length); + System.arraycopy(payload, 0, packet, proxyHeader.length, payload.length); + + try (java.net.DatagramSocket sender = new java.net.DatagramSocket()) { + sender.send(new DatagramPacket(packet, packet.length, + new InetSocketAddress("127.0.0.1", localPort))); + } + + // Act + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + socket.receive(receivePacket); + + // Assert - packet should be delivered unchanged, no parsing + verify(mockMetrics, never()).onHeaderParsed(any()); + verify(mockCache, never()).put(any(), any()); + + // Packet length should include proxy header (not stripped) + assertEquals(packet.length, receivePacket.getLength()); + } + + @Test + void receive_withLocalCommand_doesNotPopulateCache() throws Exception { + // Arrange - create LOCAL command (not proxied) + byte[] payload = "local".getBytes(StandardCharsets.UTF_8); + byte[] proxyHeader = new ProxyProtocolV2Encoder() + .command(ProxyHeader.Command.LOCAL) + .build(); + + byte[] packet = new byte[proxyHeader.length + payload.length]; + System.arraycopy(proxyHeader, 0, packet, 0, proxyHeader.length); + System.arraycopy(payload, 0, packet, proxyHeader.length, payload.length); + + try (java.net.DatagramSocket sender = new java.net.DatagramSocket()) { + sender.send(new DatagramPacket(packet, packet.length, + new InetSocketAddress("127.0.0.1", localPort))); + } + + // Act + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + socket.receive(receivePacket); + + // Assert - cache should NOT be populated for LOCAL commands + verify(mockCache, never()).put(any(), any()); + + // But metrics should still be called + verify(mockMetrics).onHeaderParsed(any()); + + // Payload should be stripped of header + assertEquals(payload.length, receivePacket.getLength()); + } + + @Test + void receive_withTcpProtocol_doesNotPopulateCache() throws Exception { + // Arrange - create header with TCP (not DGRAM) protocol + byte[] payload = "tcp".getBytes(StandardCharsets.UTF_8); + byte[] proxyHeader = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.STREAM) // TCP, not UDP + .source(new InetSocketAddress("10.1.2.3", 12345)) + .destination(new InetSocketAddress("127.0.0.1", localPort)) + .build(); + + byte[] packet = new byte[proxyHeader.length + payload.length]; + System.arraycopy(proxyHeader, 0, packet, 0, proxyHeader.length); + System.arraycopy(payload, 0, packet, proxyHeader.length, payload.length); + + try (java.net.DatagramSocket sender = new java.net.DatagramSocket()) { + sender.send(new DatagramPacket(packet, packet.length, + new InetSocketAddress("127.0.0.1", localPort))); + } + + // Act + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + socket.receive(receivePacket); + + // Assert - cache should NOT be populated for non-DGRAM protocols + verify(mockCache, never()).put(any(), any()); + + // Metrics should still be called + verify(mockMetrics).onHeaderParsed(any()); + } +} + diff --git a/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketIntegrationTest.java b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketIntegrationTest.java new file mode 100644 index 0000000..8fce996 --- /dev/null +++ b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketIntegrationTest.java @@ -0,0 +1,279 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import net.airvantage.proxysocket.core.ProxyProtocolMetricsListener; +import net.airvantage.proxysocket.core.cache.ConcurrentMapProxyAddressCache; +import net.airvantage.proxysocket.core.v2.ProxyHeader; +import net.airvantage.proxysocket.core.v2.ProxyProtocolV2Encoder; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.testcontainers.Testcontainers; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.nginx.NginxContainer; +import org.testcontainers.containers.output.Slf4jLogConsumer; +import org.testcontainers.containers.output.OutputFrame; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testcontainers.utility.DockerImageName; +import org.testcontainers.images.builder.Transferable; +import com.github.dockerjava.api.model.ExposedPort; +import com.github.dockerjava.api.model.InternetProtocol; +import com.github.dockerjava.api.model.Ports; +import com.github.dockerjava.api.model.Ports.Binding; + +import java.net.*; +import java.nio.charset.StandardCharsets; +import java.time.Duration; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.ArrayBlockingQueue; +import java.util.concurrent.BlockingQueue; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; + +import static org.junit.jupiter.api.Assertions.*; + + +/** + * End-to-end UDP integration using an in-process Proxy Protocol v2 injector. + * The injector emulates a UDP-aware LB (e.g., NGINX/Envoy) that prepends PPv2 + * and forwards datagrams to the backend echo server built on ProxyDatagramSocket. + */ +public class ProxyDatagramSocketIntegrationTest { + + private static final byte[] PAYLOAD = "hello".getBytes(StandardCharsets.UTF_8); + private static final Logger LOG = LoggerFactory.getLogger(ProxyDatagramSocketIntegrationTest.class); + + private DatagramSocket client; + private ProxyDatagramSocket backend; + private DatagramSocket injector; + private int backendPort; + private int injectorPort; + + private java.util.concurrent.ExecutorService executor; + private Future backendLoop; + + @BeforeEach + void setUp() throws Exception { + client = new DatagramSocket(); + client.setSoTimeout(3000); + + ConcurrentMapProxyAddressCache cache = new ConcurrentMapProxyAddressCache(); + backend = new ProxyDatagramSocket((new InetSocketAddress(InetAddress.getLoopbackAddress(), 0))) + .setCache(cache) + .setMetrics(new NoopMetrics()); + backendPort = backend.getLocalPort(); + LOG.info("Backend listening on 127.0.0.1:{}", backendPort); + +// injector = new DatagramSocket(new InetSocketAddress("127.0.0.1", 0)); +// injectorPort = injector.getLocalPort(); + + // Start backend echo loop + executor = Executors.newSingleThreadExecutor(); + backendLoop = executor.submit(() -> { + try { + byte[] buf = new byte[2048]; + DatagramPacket p = new DatagramPacket(buf, buf.length); + while (!Thread.currentThread().isInterrupted()) { + backend.receive(p); + + LOG.info("Received {} bytes request from {} original address {}", p.getLength(), p.getSocketAddress(), cache.get((InetSocketAddress)p.getSocketAddress())); + + // Echo back exactly what was after proxy header + byte[] echo = new byte[p.getLength()]; + System.arraycopy(p.getData(), p.getOffset(), echo, 0, p.getLength()); + p.setData(echo); + backend.send(p); + p.setData(buf); + } + } catch (SocketException ignore) { + // socket closed during shutdown + } catch (Exception e) { + // Allow exceptions to fail the test + throw new RuntimeException(e); + } + }); + } + + @AfterEach + void tearDown() throws Exception { + if (backendLoop != null) backendLoop.cancel(true); + if (executor != null) executor.shutdownNow(); + if (backend != null) backend.close(); + // if (injector != null) injector.close(); + if (client != null) client.close(); + } + + /* + @Test + void udpEndToEnd_withProxyProtocolV2Header() throws Exception { + // Source perceived by the LB (injector) is client.getLocalAddress():client.getLocalPort() + InetSocketAddress src = new InetSocketAddress(InetAddress.getByName("127.0.0.1"), client.getLocalPort()); + InetSocketAddress dst = new InetSocketAddress(InetAddress.getByName("127.0.0.1"), backendPort); + + byte[] header = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(src) + .destination(dst) + .build(); + + byte[] out = new byte[header.length + PAYLOAD.length]; + System.arraycopy(header, 0, out, 0, header.length); + System.arraycopy(PAYLOAD, 0, out, header.length, PAYLOAD.length); + + // Send to injector; injector forwards to backend and back to client + DatagramPacket toInjector = new DatagramPacket(out, out.length, new InetSocketAddress("127.0.0.1", injectorPort)); + // Set up injector forwarder (bi-directional for the test) + BlockingQueue forwardQueue = new ArrayBlockingQueue<>(1); + Executors.newSingleThreadExecutor().execute(() -> { + try { + byte[] buf = new byte[4096]; + DatagramPacket p = new DatagramPacket(buf, buf.length); + // Receive from client + injector.receive(p); + InetSocketAddress clientAddr = (InetSocketAddress) p.getSocketAddress(); + byte[] recv = new byte[p.getLength()]; + System.arraycopy(p.getData(), p.getOffset(), recv, 0, p.getLength()); + forwardQueue.add(recv); + + // Forward to backend + DatagramPacket toBackend = new DatagramPacket(recv, recv.length, new InetSocketAddress("127.0.0.1", backendPort)); + injector.send(toBackend); + + // Await response from backend + DatagramPacket fromBackend = new DatagramPacket(new byte[4096], 4096); + injector.receive(fromBackend); + byte[] backendResp = new byte[fromBackend.getLength()]; + System.arraycopy(fromBackend.getData(), fromBackend.getOffset(), backendResp, 0, fromBackend.getLength()); + + // Forward back to original client + DatagramPacket backToClient = new DatagramPacket(backendResp, backendResp.length, clientAddr); + injector.send(backToClient); + } catch (Exception e) { + throw new RuntimeException(e); + } + }); + + client.send(toInjector); + + // Receive echo back through backend -> injector -> client + DatagramPacket resp = new DatagramPacket(new byte[4096], 4096); + resp.setLength(4096); + client.receive(resp); + + String respStr = new String(resp.getData(), resp.getOffset(), resp.getLength(), StandardCharsets.UTF_8); + assertEquals("hello", respStr); + + // Sanity: ensure injector forwarded the PROXY header + payload to backend + byte[] forwarded = forwardQueue.poll(2, java.util.concurrent.TimeUnit.SECONDS); + assertNotNull(forwarded); + assertTrue(forwarded.length >= header.length + PAYLOAD.length); + } */ + + /** + * Attempt to test udp end-to-end with a third party proxy container. + * Doesn't work: + * * haproxy has no generic UDP support https://github.com/haproxy/haproxy/issues/62 + * * nginx has UDP+proxy protocol support but v1 only + * * envoy has UDP but no proxy protocol support + * + @Test + void udpEndToEnd_viaContainer_proxyProtocolV2() throws Exception { + // Expose the host backend port to containers using Testcontainers' gateway helper + Testcontainers.exposeHostPorts(backendPort); + + int envoyInternalPort = 5684; // container internal UDP listen port + String envoyConfig = "static_resources:\n" + + " listeners:\n" + + " - name: udp_listener\n" + + " address:\n" + + " socket_address:\n" + + " address: 0.0.0.0\n" + + " port_value: " + envoyInternalPort + "\n" + + " protocol: UDP\n" + + " listener_filters:\n" + + " - name: envoy.filters.udp_listener.udp_proxy\n" + + " typed_config:\n" + + " \"@type\": type.googleapis.com/envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig\n" + + " stat_prefix: udp_proxy\n" + + " cluster: backend_cluster\n" + + " upstream_socket_config:\n" + + " proxy_protocol_options:\n" + + " version: V2\n" + + " clusters:\n" + + " - name: backend_cluster\n" + + " connect_timeout: 5s\n" + + " type: STATIC\n" + + " load_assignment:\n" + + " cluster_name: backend_cluster\n" + + " endpoints:\n" + + " - lb_endpoints:\n" + + " - endpoint:\n" + + " address:\n" + + " socket_address:\n" + + " address: host.docker.internal\n" + + " port_value: " + backendPort + "\n"; + + ExposedPort udp = new ExposedPort(envoyInternalPort, InternetProtocol.UDP); + + GenericContainer envoy = new GenericContainer<>(DockerImageName.parse("envoyproxy/envoy:v1.28-latest")) + .withCopyToContainer(Transferable.of(envoyConfig.getBytes(StandardCharsets.UTF_8)), "/etc/envoy/envoy.yaml") + .withCommand("envoy", "-c", "/etc/envoy/envoy.yaml") + .withCreateContainerCmdModifier(cmd -> { + List exposedPorts = new ArrayList<>(); + for (ExposedPort p : cmd.getExposedPorts()) { + exposedPorts.add(p); + } + exposedPorts.add(udp); + cmd.withExposedPorts(exposedPorts); + + //Add previous port bindings and UDP port binding + Ports ports = cmd.getPortBindings(); + ports.bind(udp, Ports.Binding.bindIp("0.0.0.0")); + cmd.withPortBindings(ports); + }) + .withLogConsumer(new Slf4jLogConsumer(LOG).withSeparateOutputStreams()); + envoy.start(); + + String containerIpAddress = envoy.getHost(); + Ports.Binding[] bindings = envoy.getContainerInfo().getNetworkSettings().getPorts().getBindings().get(udp); + int containerPort = Integer.parseInt(bindings[0].getHostPortSpec()); + LOG.info("NGINX container host: {}, mapped UDP port: {} -> {}:{}", containerIpAddress, envoyInternalPort, containerIpAddress, containerPort); + + try { + // Java client sends to mapped host UDP port and expects echo + DatagramSocket sock = new DatagramSocket(); + sock.setSoTimeout(300000); + byte[] data = PAYLOAD; + DatagramPacket toEnvoy = new DatagramPacket(data, data.length, new InetSocketAddress(containerIpAddress, containerPort)); + LOG.info("Sending {} bytes to {}:{}", data.length, containerIpAddress, containerPort); + sock.send(toEnvoy); + + DatagramPacket resp = new DatagramPacket(new byte[4096], 4096); + sock.receive(resp); + String respStr = new String(resp.getData(), resp.getOffset(), resp.getLength(), StandardCharsets.UTF_8); + LOG.info("Received {} bytes response: '{}'", resp.getLength(), respStr); + assertEquals("hello", respStr); + sock.close(); + } finally { + try { envoy.stop(); } catch (Throwable ignore) {} + } + } + */ + + static class NoopMetrics implements ProxyProtocolMetricsListener { + @Override public void onHeaderParsed(ProxyHeader header) { } + @Override public void onParseError(Exception e) { } + @Override public void onCacheHit(InetSocketAddress client) { } + @Override public void onCacheMiss(InetSocketAddress client) { } + } +} + + diff --git a/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketMetricsTest.java b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketMetricsTest.java new file mode 100644 index 0000000..4de9c03 --- /dev/null +++ b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/ProxyDatagramSocketMetricsTest.java @@ -0,0 +1,209 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import net.airvantage.proxysocket.core.ProxyAddressCache; +import net.airvantage.proxysocket.core.ProxyProtocolMetricsListener; +import net.airvantage.proxysocket.core.v2.ProxyHeader; +import net.airvantage.proxysocket.core.v2.ProxyProtocolV2Encoder; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; + +import java.net.DatagramPacket; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.nio.charset.StandardCharsets; + +import static org.junit.jupiter.api.Assertions.*; +import static org.mockito.Mockito.*; + +/** + * Unit tests for ProxyDatagramSocket metrics tracking behavior. + */ +class ProxyDatagramSocketMetricsTest { + + private ProxyDatagramSocket socket; + private ProxyAddressCache mockCache; + private ProxyProtocolMetricsListener mockMetrics; + private int localPort; + + @BeforeEach + void setUp() throws Exception { + mockCache = mock(ProxyAddressCache.class); + mockMetrics = mock(ProxyProtocolMetricsListener.class); + + socket = new ProxyDatagramSocket(new InetSocketAddress(InetAddress.getLoopbackAddress(), 0)) + .setCache(mockCache) + .setMetrics(mockMetrics) + .setTrustedProxy(addr -> true); // Trust all for these tests + + localPort = socket.getLocalPort(); + } + + @AfterEach + void tearDown() { + if (socket != null && !socket.isClosed()) { + socket.close(); + } + } + + @Test + void receive_withValidProxyHeader_callsMetricsOnHeaderParsed() throws Exception { + // Arrange + InetSocketAddress realClient = new InetSocketAddress("10.1.2.3", 12345); + byte[] payload = "test".getBytes(StandardCharsets.UTF_8); + + byte[] proxyHeader = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(realClient) + .destination(new InetSocketAddress("127.0.0.1", localPort)) + .build(); + + byte[] packet = new byte[proxyHeader.length + payload.length]; + System.arraycopy(proxyHeader, 0, packet, 0, proxyHeader.length); + System.arraycopy(payload, 0, packet, proxyHeader.length, payload.length); + + // Send packet + try (java.net.DatagramSocket sender = new java.net.DatagramSocket()) { + sender.send(new DatagramPacket(packet, packet.length, + new InetSocketAddress("127.0.0.1", localPort))); + } + + // Act + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + socket.receive(receivePacket); + + // Assert - onHeaderParsed should be called + ArgumentCaptor headerCaptor = ArgumentCaptor.forClass(ProxyHeader.class); + verify(mockMetrics).onHeaderParsed(headerCaptor.capture()); + + ProxyHeader capturedHeader = headerCaptor.getValue(); + assertNotNull(capturedHeader); + assertEquals(ProxyHeader.TransportProtocol.DGRAM, capturedHeader.getProtocol()); + assertEquals(realClient, capturedHeader.getSourceAddress()); + } + + @Test + void receive_withInvalidData_callsMetricsOnParseError() throws Exception { + // Arrange - send garbage data + byte[] garbage = "not-a-proxy-header".getBytes(StandardCharsets.UTF_8); + + try (java.net.DatagramSocket sender = new java.net.DatagramSocket()) { + sender.send(new DatagramPacket(garbage, garbage.length, + new InetSocketAddress("127.0.0.1", localPort))); + } + + // Act + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + socket.receive(receivePacket); + + // Assert - onParseError should be called + verify(mockMetrics).onParseError(any(Exception.class)); + + // Original packet should be delivered unchanged + assertEquals(garbage.length, receivePacket.getLength()); + } + + @Test + void send_withCacheHit_callsMetricsOnCacheHit() throws Exception { + // Arrange + InetSocketAddress realClient = new InetSocketAddress("10.1.2.3", 12345); + InetSocketAddress lbAddress = new InetSocketAddress("127.0.0.1", 54321); + byte[] payload = "response".getBytes(StandardCharsets.UTF_8); + + // Mock cache to return lb address + when(mockCache.get(realClient)).thenReturn(lbAddress); + + // Create a receiver to verify the packet destination + java.net.DatagramSocket receiver = new java.net.DatagramSocket(lbAddress); + receiver.setSoTimeout(1000); + + try { + // Act - send to real client, should be redirected to LB + DatagramPacket sendPacket = new DatagramPacket(payload, payload.length, realClient); + socket.send(sendPacket); + + // Receive the packet (to avoid timeout) + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + receiver.receive(receivePacket); + + // Assert - onCacheHit should be called + verify(mockMetrics).onCacheHit(realClient); + verify(mockMetrics, never()).onCacheMiss(any()); + } finally { + receiver.close(); + } + } + + @Test + void send_withCacheMiss_callsMetricsOnCacheMiss() throws Exception { + // Arrange + InetSocketAddress clientAddress = new InetSocketAddress("127.0.0.1", 55555); + byte[] payload = "response".getBytes(StandardCharsets.UTF_8); + + // Mock cache to return null (cache miss) + when(mockCache.get(clientAddress)).thenReturn(null); + + // Create a receiver at the client address + java.net.DatagramSocket receiver = new java.net.DatagramSocket(clientAddress); + receiver.setSoTimeout(1000); + + try { + // Act - send to client address + DatagramPacket sendPacket = new DatagramPacket(payload, payload.length, clientAddress); + socket.send(sendPacket); + + // Receive the packet (to avoid timeout) + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + receiver.receive(receivePacket); + + // Assert - onCacheMiss should be called + verify(mockMetrics).onCacheMiss(clientAddress); + verify(mockMetrics, never()).onCacheHit(any()); + } finally { + receiver.close(); + } + } + + @Test + void receive_withUntrustedProxy_doesNotCallMetrics() throws Exception { + // Arrange - configure to reject all sources + socket.setTrustedProxy(addr -> false); + + byte[] payload = "test".getBytes(StandardCharsets.UTF_8); + byte[] proxyHeader = new ProxyProtocolV2Encoder() + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(new InetSocketAddress("10.1.2.3", 12345)) + .destination(new InetSocketAddress("127.0.0.1", localPort)) + .build(); + + byte[] packet = new byte[proxyHeader.length + payload.length]; + System.arraycopy(proxyHeader, 0, packet, 0, proxyHeader.length); + System.arraycopy(payload, 0, packet, proxyHeader.length, payload.length); + + try (java.net.DatagramSocket sender = new java.net.DatagramSocket()) { + sender.send(new DatagramPacket(packet, packet.length, + new InetSocketAddress("127.0.0.1", localPort))); + } + + // Act + byte[] receiveBuf = new byte[2048]; + DatagramPacket receivePacket = new DatagramPacket(receiveBuf, receiveBuf.length); + socket.receive(receivePacket); + + // Assert - no metrics should be called for untrusted sources + verify(mockMetrics, never()).onHeaderParsed(any()); + verify(mockMetrics, never()).onParseError(any()); + } +} + diff --git a/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/SimpleBenchmark.java b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/SimpleBenchmark.java new file mode 100644 index 0000000..79728c5 --- /dev/null +++ b/proxy-socket-udp/src/test/java/net/airvantage/proxysocket/udp/SimpleBenchmark.java @@ -0,0 +1,273 @@ +/* + * MIT License + * Copyright (c) 2025 Semtech + */ +package net.airvantage.proxysocket.udp; + +import com.amazonaws.proprot.ProxyProtocol; +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import io.netty.handler.codec.haproxy.HAProxyMessageDecoder; +import net.airvantage.proxysocket.core.v2.ProxyHeader; +import net.airvantage.proxysocket.core.v2.ProxyProtocolV2Decoder; +import net.airvantage.proxysocket.core.v2.ProxyProtocolV2Encoder; + +import java.io.ByteArrayInputStream; +import java.net.InetAddress; +import java.net.InetSocketAddress; +import java.util.ArrayList; +import java.util.List; + +/** + * Simple benchmark to compare Custom vs AWS ProProt vs Netty HAProxy implementations. + */ +public class SimpleBenchmark { + + private static class BenchmarkResult { + String name; + int packetSize; + long iterations; + long totalTimeNs; + double avgTimeNs; + double throughputOpsPerSec; + + @Override + public String toString() { + return String.format("%s [%dB]: %.2f ns/op, %.0f ops/sec", + name, packetSize, avgTimeNs, throughputOpsPerSec); + } + } + + public static void main(String[] args) throws Exception { + System.out.println("=".repeat(80)); + System.out.println("ProxyDatagramSocket Benchmark - Custom vs AWS ProProt vs Netty"); + System.out.println("=".repeat(80)); + System.out.println(); + + int[] packetSizes = {64, 512, 1500}; + int warmupIterations = 5000; + int measurementIterations = 50000; + + List results = new ArrayList<>(); + + for (int packetSize : packetSizes) { + System.out.println("Testing packet size: " + packetSize + " bytes"); + System.out.println("-".repeat(80)); + + // Prepare test data + byte[] appData = new byte[packetSize]; + for (int i = 0; i < appData.length; i++) { + appData[i] = (byte) (i % 256); + } + + InetAddress localhost = InetAddress.getLoopbackAddress(); + InetSocketAddress srcAddr = new InetSocketAddress(localhost, 12345); + InetSocketAddress dstAddr = new InetSocketAddress(localhost, 8080); + + // Create proxy protocol header + payload + byte[] proxyHeader = new ProxyProtocolV2Encoder() + .command(ProxyHeader.Command.PROXY) + .family(ProxyHeader.AddressFamily.INET4) + .socket(ProxyHeader.TransportProtocol.DGRAM) + .source(srcAddr) + .destination(dstAddr) + .build(); + + byte[] payload = new byte[proxyHeader.length + appData.length]; + System.arraycopy(proxyHeader, 0, payload, 0, proxyHeader.length); + System.arraycopy(appData, 0, payload, proxyHeader.length, appData.length); + + // Benchmark Custom Implementation + results.add(benchmarkCustom(payload, packetSize, warmupIterations, measurementIterations)); + + // Benchmark AWS Implementation + results.add(benchmarkAWS(payload, packetSize, warmupIterations, measurementIterations)); + + // Benchmark Netty Implementation + results.add(benchmarkNetty(payload, packetSize, warmupIterations, measurementIterations)); + + System.out.println(); + } + + // Print summary + System.out.println("=".repeat(80)); + System.out.println("SUMMARY"); + System.out.println("=".repeat(80)); + for (BenchmarkResult result : results) { + System.out.println(result); + } + + // Calculate speedup/slowdown + System.out.println(); + System.out.println("=".repeat(80)); + System.out.println("RELATIVE PERFORMANCE (Custom as baseline)"); + System.out.println("=".repeat(80)); + for (int i = 0; i < results.size(); i += 3) { + BenchmarkResult custom = results.get(i); + BenchmarkResult aws = results.get(i + 1); + BenchmarkResult netty = results.get(i + 2); + + double awsRatio = aws.avgTimeNs / custom.avgTimeNs; + String awsComparison = awsRatio > 1.0 ? + String.format("AWS is %.2fx SLOWER", awsRatio) : + String.format("AWS is %.2fx FASTER", 1.0 / awsRatio); + + double nettyRatio = netty.avgTimeNs / custom.avgTimeNs; + String nettyComparison = nettyRatio > 1.0 ? + String.format("Netty is %.2fx SLOWER", nettyRatio) : + String.format("Netty is %.2fx FASTER", 1.0 / nettyRatio); + + System.out.println(String.format("[%dB] %s | %s", custom.packetSize, awsComparison, nettyComparison)); + } + } + + private static BenchmarkResult benchmarkCustom(byte[] payload, int packetSize, + int warmup, int iterations) throws Exception { + System.out.print(" Custom Implementation: warming up..."); + + // Warmup + for (int i = 0; i < warmup; i++) { + ProxyProtocolV2Decoder.parse(payload, 0, payload.length); + } + + System.out.print(" measuring..."); + + // Measurement + long startTime = System.nanoTime(); + for (int i = 0; i < iterations; i++) { + ProxyProtocolV2Decoder.parse(payload, 0, payload.length); + } + long endTime = System.nanoTime(); + + long totalTime = endTime - startTime; + double avgTime = (double) totalTime / iterations; + double throughput = 1_000_000_000.0 / avgTime; + + System.out.println(" done!"); + System.out.println(String.format(" Average: %.2f ns/op", avgTime)); + System.out.println(String.format(" Throughput: %.0f ops/sec", throughput)); + + BenchmarkResult result = new BenchmarkResult(); + result.name = "Custom"; + result.packetSize = packetSize; + result.iterations = iterations; + result.totalTimeNs = totalTime; + result.avgTimeNs = avgTime; + result.throughputOpsPerSec = throughput; + + return result; + } + + private static BenchmarkResult benchmarkAWS(byte[] payload, int packetSize, + int warmup, int iterations) throws Exception { + System.out.print(" AWS ProProt: warming up..."); + + ProxyProtocol parser = new ProxyProtocol(); + parser.setEnforceChecksum(false); // Disable checksum enforcement for benchmark + + // Warmup + for (int i = 0; i < warmup; i++) { + ByteArrayInputStream is = new ByteArrayInputStream(payload); + parser.read(is); + } + + System.out.print(" measuring..."); + + // Measurement + long startTime = System.nanoTime(); + for (int i = 0; i < iterations; i++) { + ByteArrayInputStream is = new ByteArrayInputStream(payload); + parser.read(is); + } + long endTime = System.nanoTime(); + + long totalTime = endTime - startTime; + double avgTime = (double) totalTime / iterations; + double throughput = 1_000_000_000.0 / avgTime; + + System.out.println(" done!"); + System.out.println(String.format(" Average: %.2f ns/op", avgTime)); + System.out.println(String.format(" Throughput: %.0f ops/sec", throughput)); + + BenchmarkResult result = new BenchmarkResult(); + result.name = "AWS"; + result.packetSize = packetSize; + result.iterations = iterations; + result.totalTimeNs = totalTime; + result.avgTimeNs = avgTime; + result.throughputOpsPerSec = throughput; + + return result; + } + + private static BenchmarkResult benchmarkNetty(byte[] payload, int packetSize, + int warmup, int iterations) throws Exception { + System.out.print(" Netty HAProxy: warming up..."); + + // Warmup + for (int i = 0; i < warmup; i++) { + ByteBuf buffer = Unpooled.wrappedBuffer(payload); + NettyDecoder decoder = new NettyDecoder(); + List out = new ArrayList<>(); + try { + decoder.decodePublic(new ProxyDatagramSocketNetty.NoOpChannelHandlerContext(), buffer, out); + if (!out.isEmpty()) { + ((io.netty.handler.codec.haproxy.HAProxyMessage) out.get(0)).release(); + } + } catch (Exception e) { + // Expected for invalid/incomplete messages + } finally { + buffer.release(); + } + } + + System.out.print(" measuring..."); + + // Measurement + long startTime = System.nanoTime(); + for (int i = 0; i < iterations; i++) { + ByteBuf buffer = Unpooled.wrappedBuffer(payload); + NettyDecoder decoder = new NettyDecoder(); + List out = new ArrayList<>(); + try { + decoder.decodePublic(new ProxyDatagramSocketNetty.NoOpChannelHandlerContext(), buffer, out); + if (!out.isEmpty()) { + ((io.netty.handler.codec.haproxy.HAProxyMessage) out.get(0)).release(); + } + } catch (Exception e) { + // Expected for invalid/incomplete messages + } finally { + buffer.release(); + } + } + long endTime = System.nanoTime(); + + long totalTime = endTime - startTime; + double avgTime = (double) totalTime / iterations; + double throughput = 1_000_000_000.0 / avgTime; + + System.out.println(" done!"); + System.out.println(String.format(" Average: %.2f ns/op", avgTime)); + System.out.println(String.format(" Throughput: %.0f ops/sec", throughput)); + + BenchmarkResult result = new BenchmarkResult(); + result.name = "Netty"; + result.packetSize = packetSize; + result.iterations = iterations; + result.totalTimeNs = totalTime; + result.avgTimeNs = avgTime; + result.throughputOpsPerSec = throughput; + + return result; + } + + /** + * Wrapper for HAProxyMessageDecoder that exposes the decode method. + */ + private static class NettyDecoder extends HAProxyMessageDecoder { + public void decodePublic(io.netty.channel.ChannelHandlerContext ctx, ByteBuf in, List out) throws Exception { + decode(ctx, in, out); + } + } +} +