├── LICENSE ├── README.md ├── go.mod ├── go.sum ├── yggquic.go └── yggquic_test.go /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # QUIC over Yggdrasil 2 | 3 | This package allows you to set up QUIC sessions natively over the 4 | Yggdrasil Network. This is in place of using a TUN adapter or IPv6 5 | and allows Yggdrasil-native applications to be built easily. 6 | 7 | See `yggquic_test.go` for example usage. 8 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/yggdrasil-network/yggquic 2 | 3 | go 1.22 4 | 5 | toolchain go1.23.0 6 | 7 | require ( 8 | github.com/Arceliar/ironwood v0.0.0-20241213013129-743fe2fccbd3 9 | github.com/quic-go/quic-go v0.48.2 10 | github.com/yggdrasil-network/yggdrasil-go v0.5.12 11 | ) 12 | 13 | require ( 14 | github.com/Arceliar/phony v0.0.0-20220903101357-530938a4b13d // indirect 15 | github.com/bits-and-blooms/bitset v1.13.0 // indirect 16 | github.com/bits-and-blooms/bloom/v3 v3.7.0 // indirect 17 | github.com/coder/websocket v1.8.12 // indirect 18 | github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 // indirect 19 | github.com/gologme/log v1.3.0 // indirect 20 | github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 // indirect 21 | github.com/hjson/hjson-go/v4 v4.4.0 // indirect 22 | github.com/onsi/ginkgo/v2 v2.9.5 // indirect 23 | go.uber.org/mock v0.4.0 // indirect 24 | golang.org/x/crypto v0.31.0 // indirect 25 | golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 // indirect 26 | golang.org/x/mod v0.19.0 // indirect 27 | golang.org/x/net v0.32.0 // indirect 28 | golang.org/x/sync v0.10.0 // indirect 29 | golang.org/x/sys v0.28.0 // indirect 30 | golang.org/x/text v0.21.0 // indirect 31 | golang.org/x/tools v0.23.0 // indirect 32 | ) 33 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/Arceliar/ironwood v0.0.0-20241213013129-743fe2fccbd3 h1:d8N0z+udAnbU5PdjpLSNPTWlqeU/nnYsQ42B6+879aw= 2 | github.com/Arceliar/ironwood v0.0.0-20241213013129-743fe2fccbd3/go.mod h1:SrrElc3FFMpYCODSr11jWbLFeOM8WsY+DbDY/l2AXF0= 3 | github.com/Arceliar/phony v0.0.0-20220903101357-530938a4b13d h1:UK9fsWbWqwIQkMCz1CP+v5pGbsGoWAw6g4AyvMpm1EM= 4 | github.com/Arceliar/phony v0.0.0-20220903101357-530938a4b13d/go.mod h1:BCnxhRf47C/dy/e/D2pmB8NkB3dQVIrkD98b220rx5Q= 5 | github.com/bits-and-blooms/bitset v1.10.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8= 6 | github.com/bits-and-blooms/bitset v1.13.0 h1:bAQ9OPNFYbGHV6Nez0tmNI0RiEu7/hxlYJRUA0wFAVE= 7 | github.com/bits-and-blooms/bitset v1.13.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8= 8 | github.com/bits-and-blooms/bloom/v3 v3.7.0 h1:VfknkqV4xI+PsaDIsoHueyxVDZrfvMn56jeWUzvzdls= 9 | github.com/bits-and-blooms/bloom/v3 v3.7.0/go.mod h1:VKlUSvp0lFIYqxJjzdnSsZEw4iHb1kOL2tfHTgyJBHg= 10 | github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= 11 | github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= 12 | github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= 13 | github.com/coder/websocket v1.8.12 h1:5bUXkEPPIbewrnkU8LTCLVaxi4N4J8ahufH2vlo4NAo= 14 | github.com/coder/websocket v1.8.12/go.mod h1:LNVeNrXQZfe5qhS9ALED3uA+l5pPqvwXg3CKoDBB2gs= 15 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 16 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 17 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 18 | github.com/go-logr/logr v1.2.4 h1:g01GSCwiDw2xSZfjJ2/T9M+S6pFdcNtFYsp+Y43HYDQ= 19 | github.com/go-logr/logr v1.2.4/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= 20 | github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 h1:tfuBGBXKqDEevZMzYi5KSi8KkcZtzBcTgAUUtapy0OI= 21 | github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572/go.mod h1:9Pwr4B2jHnOSGXyyzV8ROjYa2ojvAY6HCGYYfMoC3Ls= 22 | github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg= 23 | github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= 24 | github.com/gologme/log v1.3.0 h1:l781G4dE+pbigClDSDzSaaYKtiueHCILUa/qSDsmHAo= 25 | github.com/gologme/log v1.3.0/go.mod h1:yKT+DvIPdDdDoPtqFrFxheooyVmoqi0BAsw+erN3wA4= 26 | github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= 27 | github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= 28 | github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 h1:yAJXTCF9TqKcTiHJAE8dj7HMvPfh66eeA2JYW7eFpSE= 29 | github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= 30 | github.com/hjson/hjson-go/v4 v4.4.0 h1:D/NPvqOCH6/eisTb5/ztuIS8GUvmpHaLOcNk1Bjr298= 31 | github.com/hjson/hjson-go/v4 v4.4.0/go.mod h1:KaYt3bTw3zhBjYqnXkYywcYctk0A2nxeEFTse3rH13E= 32 | github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= 33 | github.com/onsi/ginkgo/v2 v2.9.5 h1:+6Hr4uxzP4XIUyAkg61dWBw8lb/gc4/X5luuxN/EC+Q= 34 | github.com/onsi/ginkgo/v2 v2.9.5/go.mod h1:tvAoo1QUJwNEU2ITftXTpR7R1RbCzoZUOs3RonqW57k= 35 | github.com/onsi/gomega v1.27.6 h1:ENqfyGeS5AX/rlXDd/ETokDz93u0YufY1Pgxuy/PvWE= 36 | github.com/onsi/gomega v1.27.6/go.mod h1:PIQNjfQwkP3aQAH7lf7j87O/5FiNr+ZR8+ipb+qQlhg= 37 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 38 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 39 | github.com/quic-go/quic-go v0.48.2 h1:wsKXZPeGWpMpCGSWqOcqpW2wZYic/8T3aqiOID0/KWE= 40 | github.com/quic-go/quic-go v0.48.2/go.mod h1:yBgs3rWBOADpga7F+jJsb6Ybg1LSYiQvwWlLX+/6HMs= 41 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 42 | github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 43 | github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= 44 | github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= 45 | github.com/twmb/murmur3 v1.1.6 h1:mqrRot1BRxm+Yct+vavLMou2/iJt0tNVTTC0QoIjaZg= 46 | github.com/twmb/murmur3 v1.1.6/go.mod h1:Qq/R7NUyOfr65zD+6Q5IHKsJLwP7exErjN6lyyq3OSQ= 47 | github.com/yggdrasil-network/yggdrasil-go v0.5.12 h1:SaQ8d59JP+uFy+nOWXTx1ETM5r2uCfe1Gt/d+IodHJw= 48 | github.com/yggdrasil-network/yggdrasil-go v0.5.12/go.mod h1:u4DU6dpTfWmVs8r0WjW1T3UpGyeUh9vRrS8zngvncwM= 49 | go.uber.org/mock v0.4.0 h1:VcM4ZOtdbR4f6VXfiOpwpVJDL6lCReaZ6mw31wqh7KU= 50 | go.uber.org/mock v0.4.0/go.mod h1:a6FSlNadKUHUa9IP5Vyt1zh4fC7uAwxMutEAscFbkZc= 51 | golang.org/x/crypto v0.31.0 h1:ihbySMvVjLAeSH1IbfcRTkD/iNscyz8rGzjF/E5hV6U= 52 | golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk= 53 | golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56 h1:2dVuKD2vS7b0QIHQbpyTISPd0LeHDbnYEryqj5Q1ug8= 54 | golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56/go.mod h1:M4RDyNAINzryxdtnbRXRL/OHtkFuWGRjvuhBJpk2IlY= 55 | golang.org/x/mod v0.19.0 h1:fEdghXQSo20giMthA7cd28ZC+jts4amQ3YMXiP5oMQ8= 56 | golang.org/x/mod v0.19.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= 57 | golang.org/x/net v0.32.0 h1:ZqPmj8Kzc+Y6e0+skZsuACbx+wzMgo5MQsJh9Qd6aYI= 58 | golang.org/x/net v0.32.0/go.mod h1:CwU0IoeOlnQQWJ6ioyFrfRuomB8GKF6KbYXZVyeXNfs= 59 | golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ= 60 | golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= 61 | golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 62 | golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= 63 | golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= 64 | golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo= 65 | golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= 66 | golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk= 67 | golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM= 68 | golang.org/x/tools v0.23.0 h1:SGsXPZ+2l4JsgaCKkx+FQ9YZ5XEtA1GZYuoDjenLjvg= 69 | golang.org/x/tools v0.23.0/go.mod h1:pnu6ufv6vQkll6szChhK3C3L/ruaIv5eBeztNG8wtsI= 70 | google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI= 71 | google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos= 72 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 73 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 74 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 75 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 76 | -------------------------------------------------------------------------------- /yggquic.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2023 Neil Alexander 3 | * 4 | * This Source Code Form is subject to the terms of the Mozilla Public 5 | * License, v. 2.0. If a copy of the MPL was not distributed with this 6 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. 7 | */ 8 | 9 | package yggquic 10 | 11 | import ( 12 | "context" 13 | "crypto/ed25519" 14 | "crypto/tls" 15 | "encoding/hex" 16 | "fmt" 17 | "net" 18 | "sync" 19 | "time" 20 | 21 | iwt "github.com/Arceliar/ironwood/types" 22 | "github.com/quic-go/quic-go" 23 | "github.com/yggdrasil-network/yggdrasil-go/src/core" 24 | ) 25 | 26 | type YggdrasilTransport struct { 27 | ctx context.Context 28 | cancel context.CancelFunc 29 | yggdrasil net.PacketConn 30 | listener *quic.Listener 31 | transport *quic.Transport 32 | tlsConfig *tls.Config 33 | quicConfig *quic.Config 34 | incoming chan *yggdrasilStream 35 | connections sync.Map // string -> *yggdrasilConnection 36 | dials sync.Map // string -> *yggdrasilDial 37 | } 38 | 39 | type yggdrasilConnection struct { 40 | context.Context 41 | context.CancelFunc 42 | quic.Connection 43 | } 44 | 45 | type yggdrasilStream struct { 46 | *yggdrasilConnection 47 | quic.Stream 48 | } 49 | 50 | type yggdrasilDial struct { 51 | context.Context 52 | context.CancelFunc 53 | } 54 | 55 | func New(ygg *core.Core, cert tls.Certificate, qc *quic.Config) (*YggdrasilTransport, error) { 56 | if qc == nil { 57 | qc = &quic.Config{ 58 | HandshakeIdleTimeout: time.Second * 5, 59 | MaxIdleTimeout: time.Second * 60, 60 | InitialPacketSize: uint16(ygg.MTU()), 61 | DisablePathMTUDiscovery: true, 62 | } 63 | } 64 | tr := &YggdrasilTransport{ 65 | tlsConfig: &tls.Config{ 66 | ServerName: hex.EncodeToString(ygg.PublicKey()), 67 | Certificates: []tls.Certificate{cert}, 68 | InsecureSkipVerify: true, 69 | }, 70 | quicConfig: qc, 71 | transport: &quic.Transport{ 72 | Conn: ygg, 73 | }, 74 | yggdrasil: ygg, 75 | incoming: make(chan *yggdrasilStream), 76 | } 77 | tr.ctx, tr.cancel = context.WithCancel(context.Background()) 78 | 79 | var err error 80 | if tr.listener, err = tr.transport.Listen(tr.tlsConfig, tr.quicConfig); err != nil { 81 | return nil, fmt.Errorf("quic.Listen: %w", err) 82 | } 83 | 84 | go tr.connectionAcceptLoop(tr.ctx) 85 | return tr, nil 86 | } 87 | 88 | func (t *YggdrasilTransport) connectionAcceptLoop(ctx context.Context) { 89 | for { 90 | qc, err := t.listener.Accept(ctx) 91 | if err != nil { 92 | return 93 | } 94 | 95 | // If there's already an open connection for this node then we 96 | // will want to shut down the existing one and replace it with 97 | // this one. 98 | host := qc.RemoteAddr().String() 99 | ctx, cancel := context.WithCancel(t.ctx) 100 | yc := &yggdrasilConnection{ctx, cancel, qc} 101 | if eqc, ok := t.connections.Swap(host, yc); ok { 102 | if eqc, ok := eqc.(*yggdrasilConnection); ok { 103 | eqc.CancelFunc() 104 | } 105 | } 106 | 107 | go t.streamAcceptLoop(yc) 108 | 109 | // Now if there are any in-progress dials, we can cancel those 110 | // too as we now have an open connection that we can open new 111 | // streams on. 112 | if dial, ok := t.dials.LoadAndDelete(host); ok { 113 | dial.(*yggdrasilDial).CancelFunc() 114 | } 115 | } 116 | } 117 | 118 | func (t *YggdrasilTransport) streamAcceptLoop(yc *yggdrasilConnection) { 119 | host := yc.RemoteAddr().String() 120 | defer yc.CloseWithError(0, "Timed out") // nolint:errcheck 121 | defer t.connections.Delete(host) 122 | 123 | for { 124 | qs, err := yc.AcceptStream(yc.Context) 125 | if err != nil { 126 | return 127 | } 128 | select { 129 | case t.incoming <- &yggdrasilStream{yc, qs}: 130 | // An Accept call is waiting. 131 | case <-yc.Context.Done(): 132 | // We've timed out waiting for a call to Accept 133 | // to handle the connection. 134 | return 135 | } 136 | } 137 | } 138 | 139 | func (t *YggdrasilTransport) Dial(network, host string) (net.Conn, error) { 140 | return t.DialContext(context.TODO(), network, host) 141 | } 142 | 143 | func (t *YggdrasilTransport) DialContext(ctx context.Context, network, host string) (net.Conn, error) { 144 | if network != "yggdrasil" { 145 | return nil, fmt.Errorf("network must be 'yggdrasil'") 146 | } 147 | 148 | // Check if there is already a dial to this host in progress. 149 | // If there is then we will wait for it. 150 | if dial, ok := t.dials.Load(host); ok { 151 | <-dial.(*yggdrasilDial).Done() 152 | } 153 | 154 | // We might want to retrying once if part of the dial process fails, 155 | // but keep a track of whether we're already retrying. 156 | var retrying bool 157 | retry: 158 | yc, ok := t.connections.Load(host) 159 | if !ok { 160 | // Even after a dial, there's no connection. This means we 161 | // probably failed to dial, so let's try it again. 162 | if yc, ok = t.connections.Load(host); !ok { 163 | // A cancellable context means we can cancel the dial in 164 | // progress from elsewhere if we need to. 165 | dialctx, dialcancel := context.WithTimeout(ctx, time.Second*5) 166 | t.dials.Store(host, &yggdrasilDial{dialctx, dialcancel}) 167 | defer dialcancel() 168 | defer t.dials.Delete(host) 169 | 170 | // Decode the address from hex. 171 | addr := make(iwt.Addr, ed25519.PublicKeySize) 172 | k, err := hex.DecodeString(host) 173 | if err != nil { 174 | return nil, err 175 | } 176 | copy(addr, k) 177 | 178 | // Attempt to open a QUIC session. 179 | var qc quic.Connection 180 | if qc, err = t.transport.Dial(dialctx, addr, t.tlsConfig, t.quicConfig); err != nil { 181 | return nil, err 182 | } 183 | 184 | // If we succeeded then we'll store our QUIC connection so 185 | // that the next dial can open a stream on it directly. Start 186 | // the accept loop so that streams can be accepted. 187 | { 188 | ctx, cancel := context.WithCancel(context.Background()) 189 | yc = &yggdrasilConnection{ctx, cancel, qc} 190 | t.connections.Store(host, yc) 191 | go t.streamAcceptLoop(yc.(*yggdrasilConnection)) 192 | } 193 | } 194 | } 195 | if yc, ok := yc.(*yggdrasilConnection); ok { 196 | // We've either found a session or we successfully 197 | // dialed a new one, so open a stream on it. 198 | qs, err := yc.OpenStreamSync(ctx) 199 | if err != nil { 200 | // We failed to open a stream, so if this isn't a 201 | // retry, then let's try opening a new connection. 202 | if !retrying { 203 | retrying = true 204 | goto retry 205 | } 206 | return nil, err 207 | } 208 | return &yggdrasilStream{yc, qs}, err 209 | } 210 | // We failed to open a session. 211 | return nil, net.ErrClosed 212 | } 213 | 214 | func (t *YggdrasilTransport) Accept() (net.Conn, error) { 215 | return <-t.incoming, nil 216 | } 217 | 218 | func (t *YggdrasilTransport) Addr() net.Addr { 219 | return t.listener.Addr() 220 | } 221 | 222 | func (t *YggdrasilTransport) Close() error { 223 | if err := t.listener.Close(); err != nil { 224 | return err 225 | } 226 | return t.yggdrasil.Close() 227 | } 228 | -------------------------------------------------------------------------------- /yggquic_test.go: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2023 Neil Alexander 3 | * 4 | * This Source Code Form is subject to the terms of the Mozilla Public 5 | * License, v. 2.0. If a copy of the MPL was not distributed with this 6 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. 7 | */ 8 | 9 | package yggquic 10 | 11 | import ( 12 | "encoding/hex" 13 | "io" 14 | "net" 15 | "testing" 16 | 17 | "github.com/yggdrasil-network/yggdrasil-go/src/config" 18 | "github.com/yggdrasil-network/yggdrasil-go/src/core" 19 | ) 20 | 21 | func TestQUICOverYggdrasil(t *testing.T) { 22 | cfg1 := config.GenerateConfig() 23 | cfg2 := config.GenerateConfig() 24 | 25 | // Create the Yggdrasil nodes. 26 | node1, err := core.New(cfg1.Certificate, nil) 27 | if err != nil { 28 | t.Fatal(err) 29 | } 30 | node2, err := core.New(cfg2.Certificate, nil) 31 | if err != nil { 32 | t.Fatal(err) 33 | } 34 | 35 | // Peer the Yggdrasil nodes to each other. 36 | l, r := net.Pipe() 37 | go node1.HandleConn(node2.PublicKey(), l, 0) // nolint:errcheck 38 | go node2.HandleConn(node1.PublicKey(), r, 0) // nolint:errcheck 39 | 40 | // Create QUIC over Yggdrasil endpoints. 41 | quic1, err := New(node1, *cfg1.Certificate, nil) 42 | if err != nil { 43 | t.Fatal(err) 44 | } 45 | quic2, err := New(node2, *cfg2.Certificate, nil) 46 | if err != nil { 47 | t.Fatal(err) 48 | } 49 | 50 | // Dial node 1 from node 2. 51 | t.Run("Dial", func(t *testing.T) { 52 | t.Parallel() 53 | 54 | destination := hex.EncodeToString(node1.PublicKey()) 55 | for i := 0; i < 5; i++ { 56 | c, err := quic2.Dial("yggdrasil", destination) 57 | if err != nil { 58 | t.Fatal(err) 59 | } 60 | t.Logf("Opened connection to %q", c.RemoteAddr().String()) 61 | if _, err = c.Write([]byte("Hello!")); err != nil { 62 | t.Fatal(err) 63 | } 64 | if err = c.Close(); err != nil { 65 | t.Fatal(err) 66 | } 67 | } 68 | }) 69 | 70 | t.Run("Listen", func(t *testing.T) { 71 | t.Parallel() 72 | 73 | for i := 0; i < 5; i++ { 74 | c, err := quic1.Accept() 75 | if err != nil { 76 | t.Fatal(err) 77 | } 78 | t.Logf("Accepted connection from %q", c.RemoteAddr()) 79 | 80 | b, err := io.ReadAll(c) 81 | if err != nil { 82 | t.Fatal(err) 83 | } 84 | t.Logf("Received: %s", b[:]) 85 | } 86 | }) 87 | } 88 | --------------------------------------------------------------------------------