├── .github └── workflows │ ├── Publish.yml │ └── Registry.yml ├── .gitignore ├── LICENSE ├── README.md ├── pom.xml ├── settings.xml └── src └── main ├── java └── org │ └── nethergames │ └── proxytransport │ ├── ProxyTransport.java │ ├── compression │ ├── FrameIdCodec.java │ ├── ProxyTransportAlgorithm.java │ ├── ProxyTransportCompressionCodec.java │ └── ZstdCompression.java │ ├── impl │ ├── TransportChannelInitializer.java │ └── TransportClientConnection.java │ ├── integration │ ├── CustomClientEventHandler.java │ ├── QuicTransportServerInfo.java │ └── TcpTransportServerInfo.java │ └── utils │ └── CodecUpdater.java └── resources └── plugin.yml /.github/workflows/Publish.yml: -------------------------------------------------------------------------------- 1 | name: ProxyTransport Release 2 | on: 3 | push: 4 | tags: 5 | - 'v*' 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Startup 11 | uses: actions/checkout@v2 12 | - name: Set up Java 17 13 | uses: actions/setup-java@v3 14 | with: 15 | java-version: 17 16 | distribution: microsoft 17 | - name: Build ProxyTransport 18 | run: mvn -B install -q --file pom.xml 19 | - name: Create Release 20 | uses: "marvinpinto/action-automatic-releases@latest" 21 | with: 22 | repo_token: "${{ secrets.GITHUB_TOKEN }}" 23 | prerelease: false 24 | title: "ProxyTransport ${{ github.ref_name }}" 25 | files: | 26 | target/ProxyTransport.jar 27 | -------------------------------------------------------------------------------- /.github/workflows/Registry.yml: -------------------------------------------------------------------------------- 1 | name: Publish package 2 | on: push 3 | 4 | jobs: 5 | publish: 6 | runs-on: ubuntu-latest 7 | steps: 8 | - name: Setup Maven Action 9 | uses: s4u/setup-maven-action@v1.5.0 10 | with: 11 | java-version: '17' 12 | java-distribution: 'adopt' 13 | - name: Publish and package client 14 | run: mvn -T 4 --batch-mode deploy package -q -s settings.xml 15 | env: 16 | REPO_USERNAME: github-deploy 17 | REPO_PASSWORD: ${{ secrets.DEPLOY_TOKEN }} 18 | - name: Upload Artifacts 19 | uses: actions/upload-artifact@v3 20 | with: 21 | name: ProxyTransport 22 | path: target/ProxyTransport.jar -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ./target 2 | ./target/* 3 | ./.idea 4 | .idea/* 5 | target/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Proxy Transport 2 | 3 | Proxy Transport is a TCP & QUIC transport protocol implementation to replace the inefficient RakNet protocol implementation 4 | between proxies and downstream servers. 5 | 6 | ## Format 7 | 8 | Packet frames have the following format: 9 | 10 | - frameLength: int 11 | - buffer: ByteBuf (the packets are formatted in the MCPE batch packet format with compression type byte in front of it) 12 | 13 | ## Compression 14 | 15 | ProxyTransport leverages different compression algorithms to improve bandwidth usage and CPU Usage. 16 | Three compression algorithms are supported: Zlib, Snappy, and Zstd. 17 | 18 | The compression byte has been extended with type `254` to support ZSTD as compression algorithm. 19 | 20 | #### General rule 21 | Packets are bi-directional. A packet can be sent from the client (or proxy) to the downstream server (Serverbound) or from the downstream server to the client (Clientbound). 22 | 23 | Since the 1.19.30 update, the client can use both the Zlib and the Snappy compression, the proxy can dictate which one to use. 24 | For clients < 1.19.30, zlib is the only option. 25 | 26 | The following rules apply: 27 | 28 | - Serverbound: 29 | - **Unrewritten** packet batches are unchanged. They use the compression that the proxy dictated to the client and may be recompressed if the compressions differ. 30 | - **Rewritten** packet batches are re-compressed using Zstd. 31 | - Clientbound: 32 | - Packets have to be sent in the compression of the client from the downstream server, otherwise every packet batch will have to be recompressed. 33 | That is possible, however not desired since it will cause notable overhead. 34 | 35 | The proxy receives and matches the NetworkSettingsPacket from the Downstream server to decide whether recompression is necessary. 36 | 37 | For every session two values are maintained: the clientNativeCompressionAlgo and the serverNativeCompressionAlgo. 38 | 39 | The clientNative algorithm is the algorithm that the client uses to send packets to the server. The server native algorithm is what the server uses to send to the client. -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | org.nethergames.proxytransport 8 | proxy-transport 9 | 2.0.7-SNAPSHOT 10 | 11 | 12 | UTF-8 13 | 14 | 17 15 | 17 16 | 17 | 18 | 19 | 20 | nethergamesmc 21 | NetherGames target repository 22 | https://repo.nethergames.org/repository/NetherGamesMC/ 23 | 24 | 25 | 26 | 27 | 28 | waterdog-snapshots 29 | https://repo.waterdog.dev/snapshots 30 | 31 | 32 | 33 | 34 | 35 | com.github.luben 36 | zstd-jni 37 | 1.5.5-4 38 | 39 | 40 | dev.waterdog.waterdogpe 41 | waterdog 42 | 2.0.3-20240423.203337-2 43 | provided 44 | 45 | 46 | io.netty.incubator 47 | netty-incubator-codec-native-quic 48 | 0.0.62.Final 49 | linux-x86_64 50 | 51 | 52 | 53 | 54 | ProxyTransport 55 | 56 | 57 | org.apache.maven.plugins 58 | maven-compiler-plugin 59 | 3.8.1 60 | 61 | ${maven.compiler.source} 62 | ${maven.compiler.target} 63 | ${project.build.sourceEncoding} 64 | 65 | 66 | 67 | org.apache.maven.plugins 68 | maven-shade-plugin 69 | 3.2.1 70 | 71 | 72 | package 73 | 74 | shade 75 | 76 | 77 | false 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | src/main/resources 86 | true 87 | 88 | 89 | 90 | 91 | -------------------------------------------------------------------------------- /settings.xml: -------------------------------------------------------------------------------- 1 | 5 | 6 | 7 | 8 | nethergamesmc 9 | ${env.REPO_USERNAME} 10 | ${env.REPO_PASSWORD} 11 | 12 | 13 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/ProxyTransport.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport; 2 | 3 | import dev.waterdog.waterdogpe.network.protocol.ProtocolCodecs; 4 | import dev.waterdog.waterdogpe.plugin.Plugin; 5 | import org.nethergames.proxytransport.integration.QuicTransportServerInfo; 6 | import org.nethergames.proxytransport.integration.TcpTransportServerInfo; 7 | import org.nethergames.proxytransport.utils.CodecUpdater; 8 | 9 | public class ProxyTransport extends Plugin { 10 | 11 | @Override 12 | public void onStartup() { 13 | ProtocolCodecs.addUpdater(new CodecUpdater()); 14 | 15 | getLogger().info("ProxyTransport was started."); 16 | getLogger().info("Registered type with name {}", QuicTransportServerInfo.TYPE.getIdentifier()); 17 | getLogger().info("Registered type with name {}", TcpTransportServerInfo.TYPE.getIdentifier()); 18 | } 19 | 20 | @Override 21 | public void onEnable() { 22 | getLogger().info("ProxyTransport was enabled."); 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/compression/FrameIdCodec.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.compression; 2 | 3 | import io.netty.buffer.ByteBuf; 4 | import io.netty.channel.ChannelHandlerContext; 5 | import io.netty.handler.codec.MessageToMessageCodec; 6 | import org.cloudburstmc.protocol.bedrock.netty.BedrockBatchWrapper; 7 | 8 | import java.util.List; 9 | 10 | public class FrameIdCodec extends MessageToMessageCodec { 11 | public static final String NAME = "frame-id-codec"; 12 | 13 | @Override 14 | protected void encode(ChannelHandlerContext ctx, BedrockBatchWrapper msg, List out) throws Exception { 15 | out.add(msg.getCompressed().retain()); 16 | } 17 | 18 | @Override 19 | protected void decode(ChannelHandlerContext ctx, ByteBuf msg, List out) throws Exception { 20 | out.add(BedrockBatchWrapper.newInstance(msg.readRetainedSlice(msg.readableBytes()), null)); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/compression/ProxyTransportAlgorithm.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.compression; 2 | 3 | import org.cloudburstmc.protocol.bedrock.data.CompressionAlgorithm; 4 | 5 | public enum ProxyTransportAlgorithm implements CompressionAlgorithm { 6 | ZSTD; 7 | 8 | private ProxyTransportAlgorithm() { 9 | 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/compression/ProxyTransportCompressionCodec.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.compression; 2 | 3 | import dev.waterdog.waterdogpe.network.connection.codec.compression.ProxiedCompressionCodec; 4 | import io.netty.buffer.ByteBuf; 5 | import io.netty.buffer.CompositeByteBuf; 6 | import io.netty.channel.ChannelHandlerContext; 7 | import org.cloudburstmc.protocol.bedrock.data.CompressionAlgorithm; 8 | import org.cloudburstmc.protocol.bedrock.data.PacketCompressionAlgorithm; 9 | import org.cloudburstmc.protocol.bedrock.netty.BedrockBatchWrapper; 10 | import org.cloudburstmc.protocol.bedrock.netty.codec.compression.BatchCompression; 11 | import org.cloudburstmc.protocol.bedrock.netty.codec.compression.CompressionStrategy; 12 | 13 | import java.util.List; 14 | 15 | public class ProxyTransportCompressionCodec extends ProxiedCompressionCodec { 16 | private final boolean prefixed; 17 | private final ZstdCompression zstdCompression = new ZstdCompression(); 18 | 19 | public ProxyTransportCompressionCodec(CompressionStrategy strategy, boolean prefixed) { 20 | super(strategy, prefixed); 21 | this.prefixed = prefixed; 22 | } 23 | 24 | protected void encode(ChannelHandlerContext ctx, BedrockBatchWrapper msg, List out) throws Exception { 25 | if (msg.getCompressed() == null && msg.getUncompressed() == null) { 26 | throw new IllegalStateException("Batch was not encoded before"); 27 | } else if (msg.getCompressed() != null && !msg.isModified()) { // already compressed 28 | if (!this.prefixed) { // we need to prefix the compressed data 29 | CompositeByteBuf buf = ctx.alloc().compositeDirectBuffer(2); 30 | buf.addComponent(true, ctx.alloc().ioBuffer(1).writeByte(getCompressionHeader(msg.getAlgorithm()))); 31 | buf.addComponent(true, msg.getCompressed().retainedSlice()); 32 | msg.setCompressed(buf, msg.getAlgorithm()); 33 | } 34 | 35 | this.onPassedThrough(ctx, msg); 36 | out.add(msg.retain()); 37 | } else { 38 | BatchCompression compression = this.getStrategy().getCompression(msg); 39 | if (!compression.getAlgorithm().equals(PacketCompressionAlgorithm.NONE)) { 40 | compression = this.zstdCompression; 41 | } 42 | 43 | ByteBuf compressed = compression.encode(ctx, msg.getUncompressed()); 44 | 45 | try { 46 | ByteBuf outBuf; 47 | 48 | outBuf = ctx.alloc().ioBuffer(1 + compressed.readableBytes()); 49 | outBuf.writeByte(this.getCompressionHeader(compression.getAlgorithm())); 50 | outBuf.writeBytes(compressed); 51 | 52 | msg.setCompressed(outBuf, compression.getAlgorithm()); 53 | } finally { 54 | compressed.release(); 55 | } 56 | 57 | this.onCompressed(ctx, msg); 58 | out.add(msg.retain()); 59 | } 60 | } 61 | 62 | protected byte getCompressionHeader0(CompressionAlgorithm algorithm) { 63 | if (algorithm instanceof ProxyTransportAlgorithm) { 64 | return -2; 65 | } 66 | 67 | return super.getCompressionHeader0(algorithm); 68 | } 69 | 70 | protected CompressionAlgorithm getCompressionAlgorithm0(byte header) { 71 | if (header == -2) { 72 | return ProxyTransportAlgorithm.ZSTD; 73 | } 74 | 75 | return super.getCompressionAlgorithm0(header); 76 | } 77 | } 78 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/compression/ZstdCompression.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.compression; 2 | 3 | import com.github.luben.zstd.Zstd; 4 | import io.netty.buffer.ByteBuf; 5 | import io.netty.buffer.CompositeByteBuf; 6 | import io.netty.channel.ChannelHandlerContext; 7 | import io.netty.util.ReferenceCountUtil; 8 | import org.cloudburstmc.protocol.bedrock.data.CompressionAlgorithm; 9 | import org.cloudburstmc.protocol.bedrock.netty.codec.compression.BatchCompression; 10 | 11 | import java.nio.ByteBuffer; 12 | 13 | public class ZstdCompression implements BatchCompression { 14 | private int level = -1; 15 | 16 | public ByteBuf encode(ChannelHandlerContext ctx, ByteBuf msg) throws Exception { 17 | ByteBuf direct; 18 | if (!msg.isDirect() || msg instanceof CompositeByteBuf) { 19 | direct = ctx.alloc().ioBuffer(msg.readableBytes()); 20 | direct.writeBytes(msg); 21 | } else { 22 | direct = msg; 23 | } 24 | 25 | ByteBuf output = ctx.alloc().directBuffer(); 26 | try { 27 | int uncompressedLength = direct.readableBytes(); 28 | int maxLength = (int) Zstd.compressBound(uncompressedLength); 29 | 30 | output.ensureWritable(maxLength); 31 | 32 | int compressedLength; 33 | if (direct.hasMemoryAddress()) { 34 | compressedLength = (int) Zstd.compressUnsafe(output.memoryAddress(), maxLength, direct.memoryAddress() + direct.readerIndex(), uncompressedLength, this.level); 35 | } else { 36 | ByteBuffer sourceNio = direct.nioBuffer(direct.readerIndex(), direct.readableBytes()); 37 | ByteBuffer targetNio = output.nioBuffer(0, maxLength); 38 | 39 | compressedLength = Zstd.compress(targetNio, sourceNio, this.level); 40 | } 41 | 42 | output.writerIndex(compressedLength); 43 | return output.retain(); 44 | } finally { 45 | ReferenceCountUtil.release(output); 46 | if (direct != msg) { 47 | ReferenceCountUtil.release(direct); 48 | } 49 | } 50 | } 51 | 52 | public ByteBuf decode(ChannelHandlerContext channelHandlerContext, ByteBuf byteBuf) throws Exception { 53 | throw new UnsupportedOperationException("Zstd is not supported"); 54 | } 55 | 56 | public CompressionAlgorithm getAlgorithm() { 57 | return ProxyTransportAlgorithm.ZSTD; 58 | } 59 | 60 | public void setLevel(int level) { 61 | this.level = level; 62 | } 63 | 64 | public int getLevel() { 65 | return level; 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/impl/TransportChannelInitializer.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.impl; 2 | 3 | import dev.waterdog.waterdogpe.network.NetworkMetrics; 4 | import dev.waterdog.waterdogpe.network.connection.client.ClientConnection; 5 | import dev.waterdog.waterdogpe.network.connection.codec.batch.BedrockBatchDecoder; 6 | import dev.waterdog.waterdogpe.network.connection.codec.batch.BedrockBatchEncoder; 7 | import dev.waterdog.waterdogpe.network.connection.codec.client.ClientPacketQueue; 8 | import dev.waterdog.waterdogpe.network.connection.codec.compression.CompressionType; 9 | import dev.waterdog.waterdogpe.network.connection.codec.packet.BedrockPacketCodec; 10 | import dev.waterdog.waterdogpe.network.serverinfo.ServerInfo; 11 | import dev.waterdog.waterdogpe.player.ProxiedPlayer; 12 | import io.netty.channel.*; 13 | import io.netty.handler.codec.LengthFieldBasedFrameDecoder; 14 | import io.netty.handler.codec.LengthFieldPrepender; 15 | import io.netty.util.concurrent.Promise; 16 | import lombok.RequiredArgsConstructor; 17 | import org.cloudburstmc.netty.channel.raknet.RakChannel; 18 | import org.cloudburstmc.netty.channel.raknet.config.RakChannelMetrics; 19 | import org.cloudburstmc.netty.channel.raknet.config.RakChannelOption; 20 | import org.cloudburstmc.protocol.bedrock.PacketDirection; 21 | import org.cloudburstmc.protocol.bedrock.netty.codec.compression.CompressionCodec; 22 | import org.nethergames.proxytransport.compression.FrameIdCodec; 23 | import org.nethergames.proxytransport.compression.ProxyTransportCompressionCodec; 24 | import org.nethergames.proxytransport.integration.CustomClientEventHandler; 25 | 26 | import static dev.waterdog.waterdogpe.network.connection.codec.initializer.ProxiedSessionInitializer.*; 27 | 28 | public class TransportChannelInitializer extends ChannelInitializer { 29 | 30 | private final ProxiedPlayer player; 31 | private final ServerInfo serverInfo; 32 | private final Promise promise; 33 | private static final String FRAME_DECODER = "frame-decoder"; 34 | private static final String FRAME_ENCODER = "frame-encoder"; 35 | 36 | public TransportChannelInitializer(ProxiedPlayer player, ServerInfo serverInfo, Promise promise) { 37 | this.player = player; 38 | this.serverInfo = serverInfo; 39 | this.promise = promise; 40 | } 41 | 42 | @Override 43 | protected void initChannel(Channel channel) { 44 | int rakVersion = this.player.getProtocol().getRaknetVersion(); 45 | CompressionType compression = this.player.getProxy().getConfiguration().getCompression(); 46 | 47 | channel.attr(PacketDirection.ATTRIBUTE).set(PacketDirection.SERVER_BOUND); 48 | 49 | NetworkMetrics metrics = this.player.getProxy().getNetworkMetrics(); 50 | if (metrics != null) { 51 | channel.attr(NetworkMetrics.ATTRIBUTE).set(metrics); 52 | } 53 | 54 | if (metrics instanceof RakChannelMetrics rakMetrics && channel instanceof RakChannel) { 55 | channel.config().setOption(RakChannelOption.RAK_METRICS, rakMetrics); 56 | } 57 | 58 | channel.pipeline() 59 | .addLast(FRAME_DECODER, new LengthFieldBasedFrameDecoder(Integer.MAX_VALUE, 0, 4, 0, 4)) 60 | .addLast(FRAME_ENCODER, new LengthFieldPrepender(4)); 61 | 62 | channel.pipeline() 63 | .addLast(FrameIdCodec.NAME, new FrameIdCodec()) 64 | .addLast(CompressionCodec.NAME, new ProxyTransportCompressionCodec(getCompressionStrategy(compression, rakVersion, true), false)) 65 | .addLast(BedrockBatchDecoder.NAME, BATCH_DECODER) 66 | .addLast(BedrockBatchEncoder.NAME, new BedrockBatchEncoder()) 67 | .addLast(BedrockPacketCodec.NAME, getPacketCodec(rakVersion)) 68 | .addLast(ClientPacketQueue.NAME, new ClientPacketQueue()); 69 | 70 | ClientConnection connection = this.createConnection(channel); 71 | if (connection instanceof ChannelHandler handler) { // For reference: This will take care of the packets received being handled. 72 | channel.pipeline().addLast(ClientConnection.NAME, handler); 73 | } 74 | 75 | if (connection.getPacketDirection() != PacketDirection.SERVER_BOUND) { 76 | throw new IllegalStateException("Client connection must have a server-bound packet direction"); 77 | } 78 | 79 | channel.pipeline() 80 | .addLast(CustomClientEventHandler.NAME, new CustomClientEventHandler(this.player, connection)) 81 | .addLast(new TransportChannelInitializer.ChannelActiveHandler(connection, this.promise)); 82 | } 83 | 84 | protected ClientConnection createConnection(Channel channel) { 85 | return new TransportClientConnection(player, serverInfo, channel); 86 | } 87 | 88 | @RequiredArgsConstructor 89 | private static class ChannelActiveHandler extends ChannelInboundHandlerAdapter { 90 | private final ClientConnection connection; 91 | private final Promise promise; 92 | 93 | @Override 94 | public void channelActive(ChannelHandlerContext ctx) { 95 | this.promise.trySuccess(this.connection); 96 | ctx.channel().pipeline().remove(this); 97 | } 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/impl/TransportClientConnection.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.impl; 2 | 3 | import dev.waterdog.waterdogpe.network.connection.client.BedrockClientConnection; 4 | import dev.waterdog.waterdogpe.network.connection.codec.packet.BedrockPacketCodec; 5 | import dev.waterdog.waterdogpe.network.protocol.ProtocolVersion; 6 | import dev.waterdog.waterdogpe.network.protocol.handler.ProxyBatchBridge; 7 | import dev.waterdog.waterdogpe.network.serverinfo.ServerInfo; 8 | import dev.waterdog.waterdogpe.player.ProxiedPlayer; 9 | import io.netty.buffer.ByteBuf; 10 | import io.netty.channel.Channel; 11 | import io.netty.channel.ChannelHandler; 12 | import io.netty.channel.ChannelHandlerContext; 13 | import io.netty.incubator.codec.quic.QuicConnectionPathStats; 14 | import io.netty.incubator.codec.quic.QuicStreamChannel; 15 | import io.netty.util.concurrent.Future; 16 | import lombok.Getter; 17 | import lombok.NonNull; 18 | import lombok.extern.log4j.Log4j2; 19 | import org.cloudburstmc.protocol.bedrock.codec.BedrockCodec; 20 | import org.cloudburstmc.protocol.bedrock.codec.BedrockCodecHelper; 21 | import org.cloudburstmc.protocol.bedrock.netty.BedrockBatchWrapper; 22 | import org.cloudburstmc.protocol.bedrock.netty.BedrockPacketWrapper; 23 | import org.cloudburstmc.protocol.bedrock.netty.codec.compression.CompressionCodec; 24 | import org.cloudburstmc.protocol.bedrock.netty.codec.compression.CompressionStrategy; 25 | import org.cloudburstmc.protocol.bedrock.packet.BedrockPacket; 26 | import org.cloudburstmc.protocol.bedrock.packet.NetworkStackLatencyPacket; 27 | import org.cloudburstmc.protocol.bedrock.packet.TickSyncPacket; 28 | import org.nethergames.proxytransport.compression.FrameIdCodec; 29 | import org.nethergames.proxytransport.compression.ProxyTransportCompressionCodec; 30 | 31 | import javax.crypto.SecretKey; 32 | import java.util.ArrayList; 33 | import java.util.Iterator; 34 | import java.util.List; 35 | import java.util.ListIterator; 36 | import java.util.concurrent.ScheduledFuture; 37 | import java.util.concurrent.TimeUnit; 38 | import java.util.concurrent.atomic.AtomicBoolean; 39 | import java.util.concurrent.atomic.AtomicInteger; 40 | 41 | @Log4j2(topic = "ClientConnection") 42 | public class TransportClientConnection extends BedrockClientConnection { 43 | 44 | private static final int PING_CYCLE_TIME = 2; // 2 seconds 45 | private static final long MAX_UPSTREAM_PACKETS = 750; 46 | 47 | private final AtomicBoolean activeChannelLock = new AtomicBoolean(false); 48 | private final AtomicInteger packetSendingLimit = new AtomicInteger(0); 49 | private final AtomicBoolean packetSendingLock = new AtomicBoolean(false); // Lock packets from being sent to downstream servers. 50 | 51 | private final Channel channel; 52 | private long lastPingTimestamp = -1; 53 | private long latency = 0; // Latency in microseconds 54 | 55 | private long lastSentPackets = 0; 56 | private long lastLostPackets = 0; 57 | /** 58 | * Get the lost percentage of packets sent to the server as a 3 decimal integer. 59 | */ 60 | @Getter 61 | private Integer lostPercentage = null; 62 | 63 | private final List> scheduledTasks = new ArrayList<>(); 64 | 65 | public TransportClientConnection(ProxiedPlayer player, ServerInfo serverInfo, Channel channel) { 66 | super(player, serverInfo, channel); 67 | 68 | this.channel = channel; 69 | this.channel.closeFuture().addListener(future -> cleanActiveChannels()); 70 | 71 | scheduledTasks.add(channel.eventLoop().scheduleAtFixedRate(this::collectStats, PING_CYCLE_TIME, PING_CYCLE_TIME, TimeUnit.SECONDS)); 72 | scheduledTasks.add(channel.eventLoop().scheduleAtFixedRate(() -> packetSendingLimit.set(0), 1, 1, TimeUnit.SECONDS)); 73 | } 74 | 75 | @Override 76 | public void channelInactive(ChannelHandlerContext ctx) throws Exception { 77 | scheduledTasks.forEach(task -> cleanActiveChannels()); 78 | 79 | super.channelInactive(ctx); 80 | } 81 | 82 | public void cleanActiveChannels() { 83 | if (!activeChannelLock.compareAndSet(false, true)) { 84 | return; 85 | } 86 | 87 | for (Iterator> iterator = scheduledTasks.iterator(); iterator.hasNext(); ) { 88 | iterator.next().cancel(false); 89 | iterator.remove(); 90 | } 91 | } 92 | 93 | @Override 94 | protected void channelRead0(ChannelHandlerContext ctx, BedrockBatchWrapper batch) { 95 | if (getPacketHandler() instanceof ProxyBatchBridge) { 96 | onBedrockBatch(batch); 97 | } 98 | 99 | super.channelRead0(ctx, batch); 100 | } 101 | 102 | private void onBedrockBatch(@NonNull BedrockBatchWrapper batch) { 103 | ListIterator iterator = batch.getPackets().listIterator(); 104 | while (iterator.hasNext()) { 105 | BedrockPacketWrapper wrapper = iterator.next(); 106 | if (wrapper.getPacket() == null) { 107 | this.decodePacket(wrapper); 108 | } 109 | 110 | if (wrapper.getPacket() instanceof NetworkStackLatencyPacket packet && packet.getTimestamp() == 0) { 111 | iterator.remove(); // remove from batch 112 | wrapper.release(); // release 113 | batch.modify(); 114 | 115 | if (this.lastPingTimestamp != -1) { 116 | this.latency = (System.nanoTime() - this.lastPingTimestamp) / 1000; 117 | this.broadcastPing(); 118 | } 119 | } 120 | } 121 | } 122 | 123 | private boolean increaseRateLimit(int value) { 124 | packetSendingLimit.set(this.packetSendingLimit.get() + value); 125 | 126 | if (packetSendingLimit.get() >= MAX_UPSTREAM_PACKETS) { 127 | if (packetSendingLock.compareAndSet(false, true)) { 128 | getPlayer().getLogger().warning(getPlayer().getName() + " sent too many packets (" + packetSendingLimit.get() + "/s), disconnecting."); 129 | getPlayer().getConnection().disconnect("§cToo many packets!"); 130 | } 131 | } else return !packetSendingLock.get(); 132 | 133 | return false; 134 | } 135 | 136 | @Override 137 | public void sendPacket(BedrockPacket packet) { 138 | if (this.increaseRateLimit(1)) { 139 | super.sendPacket(packet); 140 | } 141 | } 142 | 143 | @Override 144 | public void sendPacketImmediately(BedrockPacket packet) { 145 | if (this.increaseRateLimit(1)) { 146 | super.sendPacketImmediately(packet); 147 | } 148 | } 149 | 150 | @Override 151 | public void sendPacket(BedrockBatchWrapper wrapper) { 152 | if (this.increaseRateLimit(wrapper.getPackets().size())) { 153 | super.sendPacket(wrapper); 154 | return; 155 | } 156 | 157 | wrapper.release(); 158 | } 159 | 160 | @Override 161 | public void setCompressionStrategy(CompressionStrategy strategy) { 162 | super.setCompressionStrategy(strategy); 163 | 164 | boolean needsPrefix = this.getPlayer().getProtocol().isAfterOrEqual(ProtocolVersion.MINECRAFT_PE_1_20_60); 165 | ChannelHandler handler = this.channel.pipeline().get(CompressionCodec.NAME); 166 | if (handler == null) { 167 | this.channel.pipeline().addAfter(FrameIdCodec.NAME, CompressionCodec.NAME, new ProxyTransportCompressionCodec(strategy, needsPrefix)); 168 | } else { 169 | this.channel.pipeline().replace(CompressionCodec.NAME, CompressionCodec.NAME, new ProxyTransportCompressionCodec(strategy, needsPrefix)); 170 | } 171 | } 172 | 173 | @Override 174 | public void enableEncryption(SecretKey secretKey) { 175 | // Encryption is generally not good in server-to-server scenarios 176 | } 177 | 178 | @Override 179 | public long getPing() { 180 | return this.latency / 1000; 181 | } 182 | 183 | public long getMicroSecondsPing() { 184 | return this.latency; 185 | } 186 | 187 | private void setLostPercentage(long lostPackets, long sentPackets) { 188 | long lost = lostPackets - this.lastLostPackets; 189 | long sent = sentPackets - this.lastSentPackets; 190 | this.lastLostPackets = lostPackets; 191 | this.lastSentPackets = sentPackets; 192 | 193 | if (sent == 0) { 194 | this.lostPercentage = 0; 195 | return; 196 | } 197 | 198 | long lostPercentage = Math.round(((double) (lost * 100) / sent) * 1000); 199 | 200 | if (lostPercentage > 65535) { 201 | this.lostPercentage = 65535; 202 | return; 203 | } 204 | 205 | this.lostPercentage = (int) lostPercentage; 206 | } 207 | 208 | public void collectStats() { 209 | var connection = getPlayer().getDownstreamConnection(); 210 | if (connection instanceof TransportClientConnection && connection.getServerInfo().getServerName().equalsIgnoreCase(getServerInfo().getServerName())) { 211 | if (this.channel instanceof QuicStreamChannel quicChannel) { 212 | quicChannel.parent().collectPathStats(0).addListener((Future quicChannelFuture) -> { 213 | if (quicChannelFuture.isSuccess()) { 214 | QuicConnectionPathStats quicStats = quicChannelFuture.getNow(); 215 | 216 | this.latency = quicStats.rtt() / 1000; // convert to nanoseconds to microsecond 217 | this.setLostPercentage(quicStats.lost(), quicStats.sent()); 218 | this.broadcastPing(); 219 | } 220 | }); 221 | } else { 222 | NetworkStackLatencyPacket packet = new NetworkStackLatencyPacket(); 223 | packet.setTimestamp(0L); 224 | packet.setFromServer(true); 225 | 226 | sendPacket(packet); 227 | 228 | this.lastPingTimestamp = System.nanoTime(); 229 | } 230 | } 231 | } 232 | 233 | private void broadcastPing() { 234 | TickSyncPacket latencyPacket = new TickSyncPacket(); 235 | latencyPacket.setRequestTimestamp(getPlayer().getPing()); 236 | latencyPacket.setResponseTimestamp(this.getPing()); 237 | 238 | sendPacket(latencyPacket); 239 | } 240 | 241 | private void decodePacket(BedrockPacketWrapper wrapper) { 242 | BedrockCodec codec = channel.pipeline().get(BedrockPacketCodec.class).getCodec(); 243 | BedrockCodecHelper helper = channel.pipeline().get(BedrockPacketCodec.class).getHelper(); 244 | 245 | ByteBuf msg = wrapper.getPacketBuffer().retainedSlice(); 246 | try { 247 | msg.skipBytes(wrapper.getHeaderLength()); // skip header 248 | wrapper.setPacket(codec.tryDecode(helper, msg, wrapper.getPacketId())); 249 | } catch (Throwable t) { 250 | log.warn("Failed to decode packet", t); 251 | throw t; 252 | } finally { 253 | msg.release(); 254 | } 255 | } 256 | } 257 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/integration/CustomClientEventHandler.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.integration; 2 | 3 | import dev.waterdog.waterdogpe.network.connection.client.ClientConnection; 4 | import dev.waterdog.waterdogpe.network.connection.handler.ReconnectReason; 5 | import dev.waterdog.waterdogpe.player.ProxiedPlayer; 6 | import dev.waterdog.waterdogpe.utils.types.TranslationContainer; 7 | import io.netty.channel.ChannelHandlerContext; 8 | import io.netty.channel.ChannelInboundHandlerAdapter; 9 | 10 | public class CustomClientEventHandler extends ChannelInboundHandlerAdapter { 11 | public static final String NAME = "client-event-handler"; 12 | 13 | private final ProxiedPlayer player; 14 | private final ClientConnection connection; 15 | 16 | public CustomClientEventHandler(ProxiedPlayer player, ClientConnection connection) { 17 | this.player = player; 18 | this.connection = connection; 19 | } 20 | 21 | @Override 22 | public void channelInactive(ChannelHandlerContext ctx) throws Exception { 23 | this.player.onDownstreamDisconnected(this.connection); 24 | } 25 | 26 | @Override 27 | public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception { 28 | if (!ctx.channel().isActive()) { 29 | return; 30 | } 31 | 32 | this.player.getLogger().warning("[" + connection.getSocketAddress() + "|" + this.player.getName() + "] - exception caught", cause); 33 | this.connection.disconnect(); 34 | 35 | TranslationContainer msg = new TranslationContainer("waterdog.downstream.down", this.connection.getServerInfo().getServerName(), cause.getMessage()); 36 | if (this.player.sendToFallback(this.connection.getServerInfo(), ReconnectReason.EXCEPTION, cause.getMessage())) { 37 | this.player.sendMessage(msg); 38 | } else { 39 | this.player.disconnect(msg); 40 | } 41 | } 42 | } -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/integration/QuicTransportServerInfo.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.integration; 2 | 3 | import dev.waterdog.waterdogpe.logger.MainLogger; 4 | import dev.waterdog.waterdogpe.network.connection.client.ClientConnection; 5 | import dev.waterdog.waterdogpe.network.serverinfo.ServerInfo; 6 | import dev.waterdog.waterdogpe.network.serverinfo.ServerInfoType; 7 | import dev.waterdog.waterdogpe.player.ProxiedPlayer; 8 | import io.netty.bootstrap.Bootstrap; 9 | import io.netty.channel.*; 10 | import io.netty.channel.epoll.Epoll; 11 | import io.netty.channel.epoll.EpollDatagramChannel; 12 | import io.netty.channel.epoll.EpollEventLoopGroup; 13 | import io.netty.channel.nio.NioEventLoopGroup; 14 | import io.netty.channel.socket.DatagramChannel; 15 | import io.netty.channel.socket.nio.NioDatagramChannel; 16 | import io.netty.handler.ssl.util.InsecureTrustManagerFactory; 17 | import io.netty.incubator.codec.quic.*; 18 | import io.netty.util.concurrent.Future; 19 | import io.netty.util.concurrent.Promise; 20 | import net.jodah.expiringmap.internal.NamedThreadFactory; 21 | import org.nethergames.proxytransport.impl.TransportChannelInitializer; 22 | 23 | import java.net.InetSocketAddress; 24 | import java.util.concurrent.ConcurrentHashMap; 25 | import java.util.concurrent.ThreadFactory; 26 | import java.util.concurrent.TimeUnit; 27 | 28 | public class QuicTransportServerInfo extends ServerInfo { 29 | public static final int availableCPU = Runtime.getRuntime().availableProcessors(); 30 | public static final ThreadFactory downstreamThreadFactory = new NamedThreadFactory("QUIC-Downstream %s"); 31 | public static final EventLoopGroup downstreamLoopGroup = Epoll.isAvailable() ? new EpollEventLoopGroup(availableCPU, downstreamThreadFactory) : new NioEventLoopGroup(availableCPU, downstreamThreadFactory); 32 | 33 | public static final String TYPE_IDENT = "quic"; 34 | public static final ServerInfoType TYPE = ServerInfoType.builder() 35 | .identifier(TYPE_IDENT) 36 | .serverInfoFactory(QuicTransportServerInfo::new) 37 | .register(); 38 | 39 | private final ConcurrentHashMap> serverConnections = new ConcurrentHashMap<>(); 40 | 41 | public QuicTransportServerInfo(String serverName, InetSocketAddress address, InetSocketAddress publicAddress) { 42 | super(serverName, address, publicAddress); 43 | } 44 | 45 | @Override 46 | public ServerInfoType getServerType() { 47 | return TYPE; 48 | } 49 | 50 | @Override 51 | public Future createConnection(ProxiedPlayer proxiedPlayer) { 52 | EventLoop eventLoop = proxiedPlayer.getProxy().getWorkerEventLoopGroup().next(); 53 | Promise promise = eventLoop.newPromise(); 54 | 55 | this.createServerConnection(eventLoop, proxiedPlayer.getLogger(), this.getAddress()).addListener((Future future) -> { 56 | if (future.isSuccess()) { 57 | proxiedPlayer.getLogger().debug("Creating stream for " + this.getServerName() + " server"); 58 | QuicChannel quicChannel = future.getNow(); 59 | 60 | quicChannel.createStream(QuicStreamType.BIDIRECTIONAL, new TransportChannelInitializer(proxiedPlayer, this, promise)).addListener((Future streamFuture) -> { 61 | if (!streamFuture.isSuccess()) { 62 | promise.tryFailure(streamFuture.cause()); 63 | quicChannel.close(); 64 | } 65 | }); 66 | } else { 67 | promise.tryFailure(future.cause()); 68 | } 69 | }); 70 | 71 | return promise; 72 | } 73 | 74 | private Future createServerConnection(EventLoopGroup eventLoopGroup, MainLogger logger, InetSocketAddress address) { 75 | EventLoop eventLoop = eventLoopGroup.next(); 76 | 77 | if (this.serverConnections.containsKey(address)) { 78 | logger.info("Reusing connection to " + address + " for " + this.getServerName() + " server"); 79 | return this.serverConnections.get(address); 80 | } 81 | 82 | logger.info("Creating connection to " + address + " for " + this.getServerName() + " server"); 83 | Promise promise = eventLoop.newPromise(); 84 | this.serverConnections.put(address, promise); 85 | 86 | QuicSslContext sslContext = QuicSslContextBuilder.forClient().trustManager(InsecureTrustManagerFactory.INSTANCE).applicationProtocols("ng").build(); 87 | ChannelHandler codec = new QuicClientCodecBuilder() 88 | .sslContext(sslContext) 89 | .maxIdleTimeout(2000, TimeUnit.MILLISECONDS) 90 | .initialMaxData(10000000) 91 | .initialMaxStreamDataBidirectionalLocal(1000000) 92 | .maxRecvUdpPayloadSize(1350) 93 | .maxSendUdpPayloadSize(1350) 94 | .activeMigration(false) 95 | .build(); 96 | 97 | new Bootstrap() 98 | .group(downstreamLoopGroup) 99 | .handler(codec) 100 | .channel(getProperSocketChannel()) 101 | .bind(0).addListener((ChannelFuture channelFuture) -> { 102 | if (channelFuture.isSuccess()) { 103 | QuicChannel.newBootstrap(channelFuture.channel()) 104 | .streamHandler(new ChannelInboundHandlerAdapter() { 105 | @Override 106 | public void channelActive(ChannelHandlerContext ctx) throws Exception { 107 | ctx.close(); 108 | } 109 | }) 110 | .remoteAddress(address) 111 | .connect().addListener((Future quicChannelFuture) -> { 112 | if (quicChannelFuture.isSuccess()) { 113 | logger.debug("Connection to " + address + " for " + this.getServerName() + " server established"); 114 | 115 | QuicChannel quicChannel = quicChannelFuture.getNow(); 116 | quicChannel.closeFuture().addListener(f -> { 117 | logger.debug("Connection to " + address + " for " + this.getServerName() + " server closed"); 118 | channelFuture.channel().close(); 119 | this.serverConnections.remove(address); 120 | }); 121 | 122 | promise.trySuccess(quicChannel); 123 | } else { 124 | logger.warning("Connection to " + address + " for " + this.getServerName() + " server failed"); 125 | 126 | promise.tryFailure(quicChannelFuture.cause()); 127 | channelFuture.channel().close(); 128 | this.serverConnections.remove(address); 129 | } 130 | }); 131 | } else { 132 | promise.tryFailure(channelFuture.cause()); 133 | channelFuture.channel().close(); 134 | this.serverConnections.remove(address); 135 | } 136 | }); 137 | 138 | return promise; 139 | } 140 | 141 | public Class getProperSocketChannel() { 142 | return Epoll.isAvailable() ? EpollDatagramChannel.class : NioDatagramChannel.class; 143 | } 144 | } 145 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/integration/TcpTransportServerInfo.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.integration; 2 | 3 | import dev.waterdog.waterdogpe.network.connection.client.ClientConnection; 4 | import dev.waterdog.waterdogpe.network.serverinfo.ServerInfo; 5 | import dev.waterdog.waterdogpe.network.serverinfo.ServerInfoType; 6 | import dev.waterdog.waterdogpe.player.ProxiedPlayer; 7 | import io.netty.bootstrap.Bootstrap; 8 | import io.netty.channel.ChannelFuture; 9 | import io.netty.channel.EventLoop; 10 | import io.netty.channel.EventLoopGroup; 11 | import io.netty.channel.epoll.Epoll; 12 | import io.netty.channel.epoll.EpollEventLoopGroup; 13 | import io.netty.channel.epoll.EpollSocketChannel; 14 | import io.netty.channel.nio.NioEventLoopGroup; 15 | import io.netty.channel.socket.SocketChannel; 16 | import io.netty.channel.socket.nio.NioSocketChannel; 17 | import io.netty.util.concurrent.Future; 18 | import io.netty.util.concurrent.Promise; 19 | import net.jodah.expiringmap.internal.NamedThreadFactory; 20 | import org.nethergames.proxytransport.impl.TransportChannelInitializer; 21 | 22 | import java.net.InetSocketAddress; 23 | import java.util.concurrent.ThreadFactory; 24 | 25 | public class TcpTransportServerInfo extends ServerInfo { 26 | public static final int availableCPU = Runtime.getRuntime().availableProcessors(); 27 | public static final ThreadFactory downstreamThreadFactory = new NamedThreadFactory("TCP-Downstream %s"); 28 | public static final EventLoopGroup downstreamLoopGroup = Epoll.isAvailable() ? new EpollEventLoopGroup(availableCPU, downstreamThreadFactory) : new NioEventLoopGroup(availableCPU, downstreamThreadFactory); 29 | 30 | public static final String TYPE_IDENT = "tcp"; 31 | public static final ServerInfoType TYPE = ServerInfoType.builder() 32 | .identifier(TYPE_IDENT) 33 | .serverInfoFactory(TcpTransportServerInfo::new) 34 | .register(); 35 | 36 | public TcpTransportServerInfo(String serverName, InetSocketAddress address, InetSocketAddress publicAddress) { 37 | super(serverName, address, publicAddress); 38 | } 39 | 40 | @Override 41 | public ServerInfoType getServerType() { 42 | return TYPE; 43 | } 44 | 45 | @Override 46 | public Future createConnection(ProxiedPlayer proxiedPlayer) { 47 | EventLoop eventLoop = proxiedPlayer.getProxy().getWorkerEventLoopGroup().next(); 48 | Promise promise = eventLoop.newPromise(); 49 | 50 | new Bootstrap() 51 | .group(downstreamLoopGroup) 52 | .handler(new TransportChannelInitializer(proxiedPlayer, this, promise)) 53 | .localAddress(new InetSocketAddress("0.0.0.0", 0)) 54 | .channel(getProperSocketChannel()) 55 | .remoteAddress(this.getAddress()) 56 | .connect().addListener((ChannelFuture future) -> { 57 | if (!future.isSuccess()) { 58 | promise.tryFailure(future.cause()); 59 | future.channel().close(); 60 | } 61 | }); 62 | 63 | return promise; 64 | } 65 | 66 | public Class getProperSocketChannel() { 67 | return Epoll.isAvailable() ? EpollSocketChannel.class : NioSocketChannel.class; 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /src/main/java/org/nethergames/proxytransport/utils/CodecUpdater.java: -------------------------------------------------------------------------------- 1 | package org.nethergames.proxytransport.utils; 2 | 3 | import dev.waterdog.waterdogpe.network.protocol.updaters.ProtocolCodecUpdater; 4 | import org.cloudburstmc.protocol.bedrock.codec.BedrockCodec; 5 | import org.cloudburstmc.protocol.bedrock.codec.v388.serializer.TickSyncSerializer_v388; 6 | import org.cloudburstmc.protocol.bedrock.data.PacketRecipient; 7 | import org.cloudburstmc.protocol.bedrock.packet.TickSyncPacket; 8 | 9 | public class CodecUpdater implements ProtocolCodecUpdater { 10 | 11 | @Override 12 | public BedrockCodec.Builder updateCodec(BedrockCodec.Builder builder, BedrockCodec baseCodec) { 13 | builder.registerPacket(TickSyncPacket::new, TickSyncSerializer_v388.INSTANCE, 23, PacketRecipient.SERVER); 14 | return builder; 15 | } 16 | 17 | @Override 18 | public int getRequiredVersion() { 19 | return -1; 20 | } 21 | } -------------------------------------------------------------------------------- /src/main/resources/plugin.yml: -------------------------------------------------------------------------------- 1 | name: ProxyTransport 2 | author: "NetherGamesMC - Tobias Grether" 3 | version: ${project.version} 4 | main: org.nethergames.proxytransport.ProxyTransport --------------------------------------------------------------------------------